[SFN] Introduce -gstatement-frontiers option, enable debug markers
[official-gcc.git] / gcc / doc / invoke.texi
blob6402a5ae1734e1c1d8f7f42ba5cdec047bee0639
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), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gstatement-frontiers  -gno-statement-frontiers @gol
350 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
351 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
352 -fno-eliminate-unused-debug-types @gol
353 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
354 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
355 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
356 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
357 -fvar-tracking  -fvar-tracking-assignments}
359 @item Optimization Options
360 @xref{Optimize Options,,Options that Control Optimization}.
361 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
362 -falign-jumps[=@var{n}] @gol
363 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
364 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
365 -fauto-inc-dec  -fbranch-probabilities @gol
366 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
367 -fbtr-bb-exclusive  -fcaller-saves @gol
368 -fcombine-stack-adjustments  -fconserve-stack @gol
369 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
370 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
371 -fcx-limited-range @gol
372 -fdata-sections  -fdce  -fdelayed-branch @gol
373 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
374 -fdevirtualize-at-ltrans  -fdse @gol
375 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
376 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
377 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
378 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
379 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
380 -fif-conversion2  -findirect-inlining @gol
381 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
382 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
383 -fipa-bit-cp -fipa-vrp @gol
384 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
385 -fira-algorithm=@var{algorithm} @gol
386 -fira-region=@var{region}  -fira-hoist-pressure @gol
387 -fira-loop-pressure  -fno-ira-share-save-slots @gol
388 -fno-ira-share-spill-slots @gol
389 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
390 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
391 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
392 -floop-block  -floop-interchange  -floop-strip-mine @gol
393 -floop-unroll-and-jam  -floop-nest-optimize @gol
394 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
395 -flto-partition=@var{alg}  -fmerge-all-constants @gol
396 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
397 -fmove-loop-invariants  -fno-branch-count-reg @gol
398 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
399 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
400 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
401 -fno-sched-spec  -fno-signed-zeros @gol
402 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
403 -fomit-frame-pointer  -foptimize-sibling-calls @gol
404 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
405 -fprefetch-loop-arrays @gol
406 -fprofile-correction @gol
407 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
408 -fprofile-reorder-functions @gol
409 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
410 -freorder-blocks-algorithm=@var{algorithm} @gol
411 -freorder-blocks-and-partition  -freorder-functions @gol
412 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
413 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
414 -fsched-spec-load  -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
419 -fschedule-fusion @gol
420 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
421 -fselective-scheduling  -fselective-scheduling2 @gol
422 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
424 -fsignaling-nans @gol
425 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
426 -fsplit-paths @gol
427 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
428 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
429 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
431 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
432 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
433 -ftree-loop-if-convert  -ftree-loop-im @gol
434 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
438 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
439 -ftree-switch-conversion  -ftree-tail-merge @gol
440 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
441 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
442 -funsafe-math-optimizations  -funswitch-loops @gol
443 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
444 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
448 @item Program Instrumentation Options
449 @xref{Instrumentation Options,,Program Instrumentation Options}.
450 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
451 -fprofile-abs-path @gol
452 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
453 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
454 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
455 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
456 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
457 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
458 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
459 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
460 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
461 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
462 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
463 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
464 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
465 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
466 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
467 -fstack-protector-explicit  -fstack-check @gol
468 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
469 -fno-stack-limit  -fsplit-stack @gol
470 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
471 -fvtv-counts  -fvtv-debug @gol
472 -finstrument-functions @gol
473 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
474 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
476 @item Preprocessor Options
477 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
478 @gccoptlist{-A@var{question}=@var{answer} @gol
479 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
480 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
481 -dD  -dI  -dM  -dN  -dU @gol
482 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
483 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
484 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
485 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
486 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
487 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
488 -H  -imacros @var{file}  -include @var{file} @gol
489 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
490 -no-integrated-cpp  -P  -pthread  -remap @gol
491 -traditional  -traditional-cpp  -trigraphs @gol
492 -U@var{macro}  -undef  @gol
493 -Wp,@var{option}  -Xpreprocessor @var{option}}
495 @item Assembler Options
496 @xref{Assembler Options,,Passing Options to the Assembler}.
497 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
499 @item Linker Options
500 @xref{Link Options,,Options for Linking}.
501 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
502 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
503 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
504 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
505 -static-libmpx  -static-libmpxwrappers @gol
506 -shared  -shared-libgcc  -symbolic @gol
507 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
508 -u @var{symbol}  -z @var{keyword}}
510 @item Directory Options
511 @xref{Directory Options,,Options for Directory Search}.
512 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
513 -idirafter @var{dir} @gol
514 -imacros @var{file}  -imultilib @var{dir} @gol
515 -iplugindir=@var{dir}  -iprefix @var{file} @gol
516 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
517 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
518 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
519 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
521 @item Code Generation Options
522 @xref{Code Gen Options,,Options for Code Generation Conventions}.
523 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
524 -ffixed-@var{reg}  -fexceptions @gol
525 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
526 -fasynchronous-unwind-tables @gol
527 -fno-gnu-unique @gol
528 -finhibit-size-directive  -fno-common  -fno-ident @gol
529 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
530 -fno-jump-tables @gol
531 -frecord-gcc-switches @gol
532 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
533 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
534 -fleading-underscore  -ftls-model=@var{model} @gol
535 -fstack-reuse=@var{reuse_level} @gol
536 -ftrampolines  -ftrapv  -fwrapv @gol
537 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
538 -fstrict-volatile-bitfields  -fsync-libcalls}
540 @item Developer Options
541 @xref{Developer Options,,GCC Developer Options}.
542 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
543 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
544 -fdbg-cnt=@var{counter-value-list} @gol
545 -fdisable-ipa-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass_name} @gol
547 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
548 -fdisable-tree-@var{pass_name} @gol
549 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
550 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
551 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
552 -fdump-final-insns@r{[}=@var{file}@r{]}
553 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
554 -fdump-lang-all @gol
555 -fdump-lang-@var{switch} @gol
556 -fdump-lang-@var{switch}-@var{options} @gol
557 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
558 -fdump-passes @gol
559 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
560 -fdump-statistics @gol
561 -fdump-tree-all @gol
562 -fdump-tree-@var{switch} @gol
563 -fdump-tree-@var{switch}-@var{options} @gol
564 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
565 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
566 -fenable-@var{kind}-@var{pass} @gol
567 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
568 -fira-verbose=@var{n} @gol
569 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
570 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
571 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
572 -fprofile-report @gol
573 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
574 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
575 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
576 -fvar-tracking-assignments-toggle  -gtoggle @gol
577 -print-file-name=@var{library}  -print-libgcc-file-name @gol
578 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
579 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
580 -print-sysroot  -print-sysroot-headers-suffix @gol
581 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
583 @item Machine-Dependent Options
584 @xref{Submodel Options,,Machine-Dependent Options}.
585 @c This list is ordered alphanumerically by subsection name.
586 @c Try and put the significant identifier (CPU or system) first,
587 @c so users have a clue at guessing where the ones they want will be.
589 @emph{AArch64 Options}
590 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
591 -mgeneral-regs-only @gol
592 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
593 -mstrict-align @gol
594 -momit-leaf-frame-pointer @gol
595 -mtls-dialect=desc  -mtls-dialect=traditional @gol
596 -mtls-size=@var{size} @gol
597 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
598 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
599 -mpc-relative-literal-loads @gol
600 -msign-return-address=@var{scope} @gol
601 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
603 @emph{Adapteva Epiphany Options}
604 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
605 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
606 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
607 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
608 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
609 -msplit-vecmove-early  -m1reg-@var{reg}}
611 @emph{ARC Options}
612 @gccoptlist{-mbarrel-shifter @gol
613 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
614 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
615 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
616 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
617 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
618 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
619 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
620 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
621 -mvolatile-cache  -mtp-regno=@var{regno} @gol
622 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
623 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
624 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
625 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
626 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
627 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
628 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
629 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
631 @emph{ARM Options}
632 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
633 -mabi=@var{name} @gol
634 -mapcs-stack-check  -mno-apcs-stack-check @gol
635 -mapcs-reentrant  -mno-apcs-reentrant @gol
636 -msched-prolog  -mno-sched-prolog @gol
637 -mlittle-endian  -mbig-endian @gol
638 -mbe8 -mbe32 @gol
639 -mfloat-abi=@var{name} @gol
640 -mfp16-format=@var{name}
641 -mthumb-interwork  -mno-thumb-interwork @gol
642 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
643 -mtune=@var{name}  -mprint-tune-info @gol
644 -mstructure-size-boundary=@var{n} @gol
645 -mabort-on-noreturn @gol
646 -mlong-calls  -mno-long-calls @gol
647 -msingle-pic-base  -mno-single-pic-base @gol
648 -mpic-register=@var{reg} @gol
649 -mnop-fun-dllimport @gol
650 -mpoke-function-name @gol
651 -mthumb  -marm @gol
652 -mtpcs-frame  -mtpcs-leaf-frame @gol
653 -mcaller-super-interworking  -mcallee-super-interworking @gol
654 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
655 -mword-relocations @gol
656 -mfix-cortex-m3-ldrd @gol
657 -munaligned-access @gol
658 -mneon-for-64bits @gol
659 -mslow-flash-data @gol
660 -masm-syntax-unified @gol
661 -mrestrict-it @gol
662 -mpure-code @gol
663 -mcmse}
665 @emph{AVR Options}
666 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
667 -mbranch-cost=@var{cost} @gol
668 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
669 -mn_flash=@var{size}  -mno-interrupts @gol
670 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
671 -mshort-calls  -nodevicelib @gol
672 -Waddr-space-convert  -Wmisspelled-isr}
674 @emph{Blackfin Options}
675 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
676 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
677 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
678 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
679 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
680 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
681 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
682 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
683 -micplb}
685 @emph{C6X Options}
686 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
687 -msim  -msdata=@var{sdata-type}}
689 @emph{CRIS Options}
690 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
691 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
692 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
693 -mstack-align  -mdata-align  -mconst-align @gol
694 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
695 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
696 -mmul-bug-workaround  -mno-mul-bug-workaround}
698 @emph{CR16 Options}
699 @gccoptlist{-mmac @gol
700 -mcr16cplus  -mcr16c @gol
701 -msim  -mint32  -mbit-ops
702 -mdata-model=@var{model}}
704 @emph{Darwin Options}
705 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
706 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
707 -client_name  -compatibility_version  -current_version @gol
708 -dead_strip @gol
709 -dependency-file  -dylib_file  -dylinker_install_name @gol
710 -dynamic  -dynamiclib  -exported_symbols_list @gol
711 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
712 -force_flat_namespace  -headerpad_max_install_names @gol
713 -iframework @gol
714 -image_base  -init  -install_name  -keep_private_externs @gol
715 -multi_module  -multiply_defined  -multiply_defined_unused @gol
716 -noall_load   -no_dead_strip_inits_and_terms @gol
717 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
718 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
719 -private_bundle  -read_only_relocs  -sectalign @gol
720 -sectobjectsymbols  -whyload  -seg1addr @gol
721 -sectcreate  -sectobjectsymbols  -sectorder @gol
722 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
723 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
724 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
725 -single_module  -static  -sub_library  -sub_umbrella @gol
726 -twolevel_namespace  -umbrella  -undefined @gol
727 -unexported_symbols_list  -weak_reference_mismatches @gol
728 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
729 -mkernel  -mone-byte-bool}
731 @emph{DEC Alpha Options}
732 @gccoptlist{-mno-fp-regs  -msoft-float @gol
733 -mieee  -mieee-with-inexact  -mieee-conformant @gol
734 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
735 -mtrap-precision=@var{mode}  -mbuild-constants @gol
736 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
737 -mbwx  -mmax  -mfix  -mcix @gol
738 -mfloat-vax  -mfloat-ieee @gol
739 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
740 -msmall-text  -mlarge-text @gol
741 -mmemory-latency=@var{time}}
743 @emph{FR30 Options}
744 @gccoptlist{-msmall-model  -mno-lsim}
746 @emph{FT32 Options}
747 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
749 @emph{FRV Options}
750 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
751 -mhard-float  -msoft-float @gol
752 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
753 -mdouble  -mno-double @gol
754 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
755 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
756 -mlinked-fp  -mlong-calls  -malign-labels @gol
757 -mlibrary-pic  -macc-4  -macc-8 @gol
758 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
759 -moptimize-membar  -mno-optimize-membar @gol
760 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
761 -mvliw-branch  -mno-vliw-branch @gol
762 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
763 -mno-nested-cond-exec  -mtomcat-stats @gol
764 -mTLS  -mtls @gol
765 -mcpu=@var{cpu}}
767 @emph{GNU/Linux Options}
768 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
769 -tno-android-cc  -tno-android-ld}
771 @emph{H8/300 Options}
772 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
774 @emph{HPPA Options}
775 @gccoptlist{-march=@var{architecture-type} @gol
776 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
777 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
778 -mfixed-range=@var{register-range} @gol
779 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
780 -mlong-load-store  -mno-disable-fpregs @gol
781 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
782 -mno-jump-in-delay  -mno-long-load-store @gol
783 -mno-portable-runtime  -mno-soft-float @gol
784 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
785 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
786 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
787 -munix=@var{unix-std}  -nolibdld  -static  -threads}
789 @emph{IA-64 Options}
790 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
791 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
792 -mconstant-gp  -mauto-pic  -mfused-madd @gol
793 -minline-float-divide-min-latency @gol
794 -minline-float-divide-max-throughput @gol
795 -mno-inline-float-divide @gol
796 -minline-int-divide-min-latency @gol
797 -minline-int-divide-max-throughput  @gol
798 -mno-inline-int-divide @gol
799 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
800 -mno-inline-sqrt @gol
801 -mdwarf2-asm  -mearly-stop-bits @gol
802 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
803 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
804 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
805 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
806 -msched-spec-ldc  -msched-spec-control-ldc @gol
807 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
808 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
809 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
810 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
812 @emph{LM32 Options}
813 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
814 -msign-extend-enabled  -muser-enabled}
816 @emph{M32R/D Options}
817 @gccoptlist{-m32r2  -m32rx  -m32r @gol
818 -mdebug @gol
819 -malign-loops  -mno-align-loops @gol
820 -missue-rate=@var{number} @gol
821 -mbranch-cost=@var{number} @gol
822 -mmodel=@var{code-size-model-type} @gol
823 -msdata=@var{sdata-type} @gol
824 -mno-flush-func  -mflush-func=@var{name} @gol
825 -mno-flush-trap  -mflush-trap=@var{number} @gol
826 -G @var{num}}
828 @emph{M32C Options}
829 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
831 @emph{M680x0 Options}
832 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
833 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
834 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
835 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
836 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
837 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
838 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
839 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
840 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
842 @emph{MCore Options}
843 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
844 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
845 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
846 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
847 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
849 @emph{MeP Options}
850 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
851 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
852 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
853 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
854 -mtiny=@var{n}}
856 @emph{MicroBlaze Options}
857 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
858 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
859 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
860 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
861 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
863 @emph{MIPS Options}
864 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
865 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
866 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
867 -mips16  -mno-mips16  -mflip-mips16 @gol
868 -minterlink-compressed  -mno-interlink-compressed @gol
869 -minterlink-mips16  -mno-interlink-mips16 @gol
870 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
871 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
872 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
873 -mno-float  -msingle-float  -mdouble-float @gol
874 -modd-spreg  -mno-odd-spreg @gol
875 -mabs=@var{mode}  -mnan=@var{encoding} @gol
876 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
877 -mmcu  -mmno-mcu @gol
878 -meva  -mno-eva @gol
879 -mvirt  -mno-virt @gol
880 -mxpa  -mno-xpa @gol
881 -mmicromips  -mno-micromips @gol
882 -mmsa  -mno-msa @gol
883 -mfpu=@var{fpu-type} @gol
884 -msmartmips  -mno-smartmips @gol
885 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
886 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
887 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
888 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
889 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
890 -membedded-data  -mno-embedded-data @gol
891 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
892 -mcode-readable=@var{setting} @gol
893 -msplit-addresses  -mno-split-addresses @gol
894 -mexplicit-relocs  -mno-explicit-relocs @gol
895 -mcheck-zero-division  -mno-check-zero-division @gol
896 -mdivide-traps  -mdivide-breaks @gol
897 -mload-store-pairs  -mno-load-store-pairs @gol
898 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
899 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
900 -mfix-24k  -mno-fix-24k @gol
901 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
902 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
903 -mfix-vr4120  -mno-fix-vr4120 @gol
904 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
905 -mflush-func=@var{func}  -mno-flush-func @gol
906 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
907 -mcompact-branches=@var{policy} @gol
908 -mfp-exceptions  -mno-fp-exceptions @gol
909 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
910 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
911 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
912 -mframe-header-opt  -mno-frame-header-opt}
914 @emph{MMIX Options}
915 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
916 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
917 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
918 -mno-base-addresses  -msingle-exit  -mno-single-exit}
920 @emph{MN10300 Options}
921 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
922 -mno-am33  -mam33  -mam33-2  -mam34 @gol
923 -mtune=@var{cpu-type} @gol
924 -mreturn-pointer-on-d0 @gol
925 -mno-crt0  -mrelax  -mliw  -msetlb}
927 @emph{Moxie Options}
928 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
930 @emph{MSP430 Options}
931 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
932 -mwarn-mcu @gol
933 -mcode-region=  -mdata-region= @gol
934 -msilicon-errata=  -msilicon-errata-warn= @gol
935 -mhwmult=  -minrt}
937 @emph{NDS32 Options}
938 @gccoptlist{-mbig-endian  -mlittle-endian @gol
939 -mreduced-regs  -mfull-regs @gol
940 -mcmov  -mno-cmov @gol
941 -mperf-ext  -mno-perf-ext @gol
942 -mv3push  -mno-v3push @gol
943 -m16bit  -mno-16bit @gol
944 -misr-vector-size=@var{num} @gol
945 -mcache-block-size=@var{num} @gol
946 -march=@var{arch} @gol
947 -mcmodel=@var{code-model} @gol
948 -mctor-dtor  -mrelax}
950 @emph{Nios II Options}
951 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
952 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
953 -mel  -meb @gol
954 -mno-bypass-cache  -mbypass-cache @gol
955 -mno-cache-volatile  -mcache-volatile @gol
956 -mno-fast-sw-div  -mfast-sw-div @gol
957 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
958 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
959 -mcustom-fpu-cfg=@var{name} @gol
960 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
961 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
963 @emph{Nvidia PTX Options}
964 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
966 @emph{PDP-11 Options}
967 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
968 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
969 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
970 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
971 -mbranch-expensive  -mbranch-cheap @gol
972 -munix-asm  -mdec-asm}
974 @emph{picoChip Options}
975 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
976 -msymbol-as-address  -mno-inefficient-warnings}
978 @emph{PowerPC Options}
979 See RS/6000 and PowerPC Options.
981 @emph{RISC-V Options}
982 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
983 -mplt  -mno-plt @gol
984 -mabi=@var{ABI-string} @gol
985 -mfdiv  -mno-fdiv @gol
986 -mdiv  -mno-div @gol
987 -march=@var{ISA-string} @gol
988 -mtune=@var{processor-string} @gol
989 -msmall-data-limit=@var{N-bytes} @gol
990 -msave-restore  -mno-save-restore @gol
991 -mstrict-align -mno-strict-align @gol
992 -mcmodel=medlow -mcmodel=medany @gol
993 -mexplicit-relocs  -mno-explicit-relocs @gol}
995 @emph{RL78 Options}
996 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
997 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
998 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1000 @emph{RS/6000 and PowerPC Options}
1001 @gccoptlist{-mcpu=@var{cpu-type} @gol
1002 -mtune=@var{cpu-type} @gol
1003 -mcmodel=@var{code-model} @gol
1004 -mpowerpc64 @gol
1005 -maltivec  -mno-altivec @gol
1006 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1007 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1008 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1009 -mfprnd  -mno-fprnd @gol
1010 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1011 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1012 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1013 -malign-power  -malign-natural @gol
1014 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1015 -msingle-float  -mdouble-float  -msimple-fpu @gol
1016 -mstring  -mno-string  -mupdate  -mno-update @gol
1017 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1018 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1019 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1020 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1021 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1022 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1023 -mprioritize-restricted-insns=@var{priority} @gol
1024 -msched-costly-dep=@var{dependence_type} @gol
1025 -minsert-sched-nops=@var{scheme} @gol
1026 -mcall-sysv  -mcall-netbsd @gol
1027 -maix-struct-return  -msvr4-struct-return @gol
1028 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1029 -mblock-move-inline-limit=@var{num} @gol
1030 -misel  -mno-isel @gol
1031 -misel=yes  -misel=no @gol
1032 -mspe  -mno-spe @gol
1033 -mspe=yes  -mspe=no @gol
1034 -mpaired @gol
1035 -mvrsave  -mno-vrsave @gol
1036 -mmulhw  -mno-mulhw @gol
1037 -mdlmzb  -mno-dlmzb @gol
1038 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1039 -mprototype  -mno-prototype @gol
1040 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1041 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1042 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1043 -mno-recip-precision @gol
1044 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1045 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1046 -msave-toc-indirect  -mno-save-toc-indirect @gol
1047 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1048 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1049 -mquad-memory  -mno-quad-memory @gol
1050 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1051 -mcompat-align-parm  -mno-compat-align-parm @gol
1052 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1053 -mgnu-attribute  -mno-gnu-attribute @gol
1054 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1055 -mstack-protector-guard-offset=@var{offset}}
1057 @emph{RX Options}
1058 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1059 -mcpu=@gol
1060 -mbig-endian-data  -mlittle-endian-data @gol
1061 -msmall-data @gol
1062 -msim  -mno-sim@gol
1063 -mas100-syntax  -mno-as100-syntax@gol
1064 -mrelax@gol
1065 -mmax-constant-size=@gol
1066 -mint-register=@gol
1067 -mpid@gol
1068 -mallow-string-insns  -mno-allow-string-insns@gol
1069 -mjsr@gol
1070 -mno-warn-multiple-fast-interrupts@gol
1071 -msave-acc-in-interrupts}
1073 @emph{S/390 and zSeries Options}
1074 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1075 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1076 -mlong-double-64  -mlong-double-128 @gol
1077 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1078 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1079 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1080 -mhtm  -mvx  -mzvector @gol
1081 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1082 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1083 -mhotpatch=@var{halfwords},@var{halfwords}}
1085 @emph{Score Options}
1086 @gccoptlist{-meb  -mel @gol
1087 -mnhwloop @gol
1088 -muls @gol
1089 -mmac @gol
1090 -mscore5  -mscore5u  -mscore7  -mscore7d}
1092 @emph{SH Options}
1093 @gccoptlist{-m1  -m2  -m2e @gol
1094 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1095 -m3  -m3e @gol
1096 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1097 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1098 -mb  -ml  -mdalign  -mrelax @gol
1099 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1100 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1101 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1102 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1103 -maccumulate-outgoing-args @gol
1104 -matomic-model=@var{atomic-model} @gol
1105 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1106 -mcbranch-force-delay-slot @gol
1107 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1108 -mpretend-cmove  -mtas}
1110 @emph{Solaris 2 Options}
1111 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1112 -pthreads}
1114 @emph{SPARC Options}
1115 @gccoptlist{-mcpu=@var{cpu-type} @gol
1116 -mtune=@var{cpu-type} @gol
1117 -mcmodel=@var{code-model} @gol
1118 -mmemory-model=@var{mem-model} @gol
1119 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1120 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1121 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1122 -mhard-quad-float  -msoft-quad-float @gol
1123 -mstack-bias  -mno-stack-bias @gol
1124 -mstd-struct-return  -mno-std-struct-return @gol
1125 -munaligned-doubles  -mno-unaligned-doubles @gol
1126 -muser-mode  -mno-user-mode @gol
1127 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1128 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1129 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1130 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1131 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1132 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1133 -mlra  -mno-lra}
1135 @emph{SPU Options}
1136 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1137 -msafe-dma  -munsafe-dma @gol
1138 -mbranch-hints @gol
1139 -msmall-mem  -mlarge-mem  -mstdmain @gol
1140 -mfixed-range=@var{register-range} @gol
1141 -mea32  -mea64 @gol
1142 -maddress-space-conversion  -mno-address-space-conversion @gol
1143 -mcache-size=@var{cache-size} @gol
1144 -matomic-updates  -mno-atomic-updates}
1146 @emph{System V Options}
1147 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1149 @emph{TILE-Gx Options}
1150 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1151 -mcmodel=@var{code-model}}
1153 @emph{TILEPro Options}
1154 @gccoptlist{-mcpu=@var{cpu}  -m32}
1156 @emph{V850 Options}
1157 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1158 -mprolog-function  -mno-prolog-function  -mspace @gol
1159 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1160 -mapp-regs  -mno-app-regs @gol
1161 -mdisable-callt  -mno-disable-callt @gol
1162 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1163 -mv850e  -mv850  -mv850e3v5 @gol
1164 -mloop @gol
1165 -mrelax @gol
1166 -mlong-jumps @gol
1167 -msoft-float @gol
1168 -mhard-float @gol
1169 -mgcc-abi @gol
1170 -mrh850-abi @gol
1171 -mbig-switch}
1173 @emph{VAX Options}
1174 @gccoptlist{-mg  -mgnu  -munix}
1176 @emph{Visium Options}
1177 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1178 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1180 @emph{VMS Options}
1181 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1182 -mpointer-size=@var{size}}
1184 @emph{VxWorks Options}
1185 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1186 -Xbind-lazy  -Xbind-now}
1188 @emph{x86 Options}
1189 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1190 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1191 -mfpmath=@var{unit} @gol
1192 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1193 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1194 -mno-wide-multiply  -mrtd  -malign-double @gol
1195 -mpreferred-stack-boundary=@var{num} @gol
1196 -mincoming-stack-boundary=@var{num} @gol
1197 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1198 -mrecip  -mrecip=@var{opt} @gol
1199 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1200 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1201 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1202 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1203 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1204 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1205 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1206 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1207 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni @gol
1208 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1209 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1210 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1211 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1212 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1213 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1214 -mregparm=@var{num}  -msseregparm @gol
1215 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1216 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1217 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1218 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1219 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1220 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1221 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1222 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1223 -mstack-protector-guard-reg=@var{reg} @gol
1224 -mstack-protector-guard-offset=@var{offset} @gol
1225 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1226 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1228 @emph{x86 Windows Options}
1229 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1230 -mnop-fun-dllimport  -mthread @gol
1231 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1233 @emph{Xstormy16 Options}
1234 @gccoptlist{-msim}
1236 @emph{Xtensa Options}
1237 @gccoptlist{-mconst16  -mno-const16 @gol
1238 -mfused-madd  -mno-fused-madd @gol
1239 -mforce-no-pic @gol
1240 -mserialize-volatile  -mno-serialize-volatile @gol
1241 -mtext-section-literals  -mno-text-section-literals @gol
1242 -mauto-litpools  -mno-auto-litpools @gol
1243 -mtarget-align  -mno-target-align @gol
1244 -mlongcalls  -mno-longcalls}
1246 @emph{zSeries Options}
1247 See S/390 and zSeries Options.
1248 @end table
1251 @node Overall Options
1252 @section Options Controlling the Kind of Output
1254 Compilation can involve up to four stages: preprocessing, compilation
1255 proper, assembly and linking, always in that order.  GCC is capable of
1256 preprocessing and compiling several files either into several
1257 assembler input files, or into one assembler input file; then each
1258 assembler input file produces an object file, and linking combines all
1259 the object files (those newly compiled, and those specified as input)
1260 into an executable file.
1262 @cindex file name suffix
1263 For any given input file, the file name suffix determines what kind of
1264 compilation is done:
1266 @table @gcctabopt
1267 @item @var{file}.c
1268 C source code that must be preprocessed.
1270 @item @var{file}.i
1271 C source code that should not be preprocessed.
1273 @item @var{file}.ii
1274 C++ source code that should not be preprocessed.
1276 @item @var{file}.m
1277 Objective-C source code.  Note that you must link with the @file{libobjc}
1278 library to make an Objective-C program work.
1280 @item @var{file}.mi
1281 Objective-C source code that should not be preprocessed.
1283 @item @var{file}.mm
1284 @itemx @var{file}.M
1285 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1286 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1287 to a literal capital M@.
1289 @item @var{file}.mii
1290 Objective-C++ source code that should not be preprocessed.
1292 @item @var{file}.h
1293 C, C++, Objective-C or Objective-C++ header file to be turned into a
1294 precompiled header (default), or C, C++ header file to be turned into an
1295 Ada spec (via the @option{-fdump-ada-spec} switch).
1297 @item @var{file}.cc
1298 @itemx @var{file}.cp
1299 @itemx @var{file}.cxx
1300 @itemx @var{file}.cpp
1301 @itemx @var{file}.CPP
1302 @itemx @var{file}.c++
1303 @itemx @var{file}.C
1304 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1305 the last two letters must both be literally @samp{x}.  Likewise,
1306 @samp{.C} refers to a literal capital C@.
1308 @item @var{file}.mm
1309 @itemx @var{file}.M
1310 Objective-C++ source code that must be preprocessed.
1312 @item @var{file}.mii
1313 Objective-C++ source code that should not be preprocessed.
1315 @item @var{file}.hh
1316 @itemx @var{file}.H
1317 @itemx @var{file}.hp
1318 @itemx @var{file}.hxx
1319 @itemx @var{file}.hpp
1320 @itemx @var{file}.HPP
1321 @itemx @var{file}.h++
1322 @itemx @var{file}.tcc
1323 C++ header file to be turned into a precompiled header or Ada spec.
1325 @item @var{file}.f
1326 @itemx @var{file}.for
1327 @itemx @var{file}.ftn
1328 Fixed form Fortran source code that should not be preprocessed.
1330 @item @var{file}.F
1331 @itemx @var{file}.FOR
1332 @itemx @var{file}.fpp
1333 @itemx @var{file}.FPP
1334 @itemx @var{file}.FTN
1335 Fixed form Fortran source code that must be preprocessed (with the traditional
1336 preprocessor).
1338 @item @var{file}.f90
1339 @itemx @var{file}.f95
1340 @itemx @var{file}.f03
1341 @itemx @var{file}.f08
1342 Free form Fortran source code that should not be preprocessed.
1344 @item @var{file}.F90
1345 @itemx @var{file}.F95
1346 @itemx @var{file}.F03
1347 @itemx @var{file}.F08
1348 Free form Fortran source code that must be preprocessed (with the
1349 traditional preprocessor).
1351 @item @var{file}.go
1352 Go source code.
1354 @item @var{file}.brig
1355 BRIG files (binary representation of HSAIL).
1357 @item @var{file}.ads
1358 Ada source code file that contains a library unit declaration (a
1359 declaration of a package, subprogram, or generic, or a generic
1360 instantiation), or a library unit renaming declaration (a package,
1361 generic, or subprogram renaming declaration).  Such files are also
1362 called @dfn{specs}.
1364 @item @var{file}.adb
1365 Ada source code file containing a library unit body (a subprogram or
1366 package body).  Such files are also called @dfn{bodies}.
1368 @c GCC also knows about some suffixes for languages not yet included:
1369 @c Pascal:
1370 @c @var{file}.p
1371 @c @var{file}.pas
1372 @c Ratfor:
1373 @c @var{file}.r
1375 @item @var{file}.s
1376 Assembler code.
1378 @item @var{file}.S
1379 @itemx @var{file}.sx
1380 Assembler code that must be preprocessed.
1382 @item @var{other}
1383 An object file to be fed straight into linking.
1384 Any file name with no recognized suffix is treated this way.
1385 @end table
1387 @opindex x
1388 You can specify the input language explicitly with the @option{-x} option:
1390 @table @gcctabopt
1391 @item -x @var{language}
1392 Specify explicitly the @var{language} for the following input files
1393 (rather than letting the compiler choose a default based on the file
1394 name suffix).  This option applies to all following input files until
1395 the next @option{-x} option.  Possible values for @var{language} are:
1396 @smallexample
1397 c  c-header  cpp-output
1398 c++  c++-header  c++-cpp-output
1399 objective-c  objective-c-header  objective-c-cpp-output
1400 objective-c++ objective-c++-header objective-c++-cpp-output
1401 assembler  assembler-with-cpp
1403 f77  f77-cpp-input f95  f95-cpp-input
1405 brig
1406 @end smallexample
1408 @item -x none
1409 Turn off any specification of a language, so that subsequent files are
1410 handled according to their file name suffixes (as they are if @option{-x}
1411 has not been used at all).
1412 @end table
1414 If you only want some of the stages of compilation, you can use
1415 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1416 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1417 @command{gcc} is to stop.  Note that some combinations (for example,
1418 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1420 @table @gcctabopt
1421 @item -c
1422 @opindex c
1423 Compile or assemble the source files, but do not link.  The linking
1424 stage simply is not done.  The ultimate output is in the form of an
1425 object file for each source file.
1427 By default, the object file name for a source file is made by replacing
1428 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1430 Unrecognized input files, not requiring compilation or assembly, are
1431 ignored.
1433 @item -S
1434 @opindex S
1435 Stop after the stage of compilation proper; do not assemble.  The output
1436 is in the form of an assembler code file for each non-assembler input
1437 file specified.
1439 By default, the assembler file name for a source file is made by
1440 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1442 Input files that don't require compilation are ignored.
1444 @item -E
1445 @opindex E
1446 Stop after the preprocessing stage; do not run the compiler proper.  The
1447 output is in the form of preprocessed source code, which is sent to the
1448 standard output.
1450 Input files that don't require preprocessing are ignored.
1452 @cindex output file option
1453 @item -o @var{file}
1454 @opindex o
1455 Place output in file @var{file}.  This applies to whatever
1456 sort of output is being produced, whether it be an executable file,
1457 an object file, an assembler file or preprocessed C code.
1459 If @option{-o} is not specified, the default is to put an executable
1460 file in @file{a.out}, the object file for
1461 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1462 assembler file in @file{@var{source}.s}, a precompiled header file in
1463 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1464 standard output.
1466 @item -v
1467 @opindex v
1468 Print (on standard error output) the commands executed to run the stages
1469 of compilation.  Also print the version number of the compiler driver
1470 program and of the preprocessor and the compiler proper.
1472 @item -###
1473 @opindex ###
1474 Like @option{-v} except the commands are not executed and arguments
1475 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1476 This is useful for shell scripts to capture the driver-generated command lines.
1478 @item --help
1479 @opindex help
1480 Print (on the standard output) a description of the command-line options
1481 understood by @command{gcc}.  If the @option{-v} option is also specified
1482 then @option{--help} is also passed on to the various processes
1483 invoked by @command{gcc}, so that they can display the command-line options
1484 they accept.  If the @option{-Wextra} option has also been specified
1485 (prior to the @option{--help} option), then command-line options that
1486 have no documentation associated with them are also displayed.
1488 @item --target-help
1489 @opindex target-help
1490 Print (on the standard output) a description of target-specific command-line
1491 options for each tool.  For some targets extra target-specific
1492 information may also be printed.
1494 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1495 Print (on the standard output) a description of the command-line
1496 options understood by the compiler that fit into all specified classes
1497 and qualifiers.  These are the supported classes:
1499 @table @asis
1500 @item @samp{optimizers}
1501 Display all of the optimization options supported by the
1502 compiler.
1504 @item @samp{warnings}
1505 Display all of the options controlling warning messages
1506 produced by the compiler.
1508 @item @samp{target}
1509 Display target-specific options.  Unlike the
1510 @option{--target-help} option however, target-specific options of the
1511 linker and assembler are not displayed.  This is because those
1512 tools do not currently support the extended @option{--help=} syntax.
1514 @item @samp{params}
1515 Display the values recognized by the @option{--param}
1516 option.
1518 @item @var{language}
1519 Display the options supported for @var{language}, where
1520 @var{language} is the name of one of the languages supported in this
1521 version of GCC@.
1523 @item @samp{common}
1524 Display the options that are common to all languages.
1525 @end table
1527 These are the supported qualifiers:
1529 @table @asis
1530 @item @samp{undocumented}
1531 Display only those options that are undocumented.
1533 @item @samp{joined}
1534 Display options taking an argument that appears after an equal
1535 sign in the same continuous piece of text, such as:
1536 @samp{--help=target}.
1538 @item @samp{separate}
1539 Display options taking an argument that appears as a separate word
1540 following the original option, such as: @samp{-o output-file}.
1541 @end table
1543 Thus for example to display all the undocumented target-specific
1544 switches supported by the compiler, use:
1546 @smallexample
1547 --help=target,undocumented
1548 @end smallexample
1550 The sense of a qualifier can be inverted by prefixing it with the
1551 @samp{^} character, so for example to display all binary warning
1552 options (i.e., ones that are either on or off and that do not take an
1553 argument) that have a description, use:
1555 @smallexample
1556 --help=warnings,^joined,^undocumented
1557 @end smallexample
1559 The argument to @option{--help=} should not consist solely of inverted
1560 qualifiers.
1562 Combining several classes is possible, although this usually
1563 restricts the output so much that there is nothing to display.  One
1564 case where it does work, however, is when one of the classes is
1565 @var{target}.  For example, to display all the target-specific
1566 optimization options, use:
1568 @smallexample
1569 --help=target,optimizers
1570 @end smallexample
1572 The @option{--help=} option can be repeated on the command line.  Each
1573 successive use displays its requested class of options, skipping
1574 those that have already been displayed.
1576 If the @option{-Q} option appears on the command line before the
1577 @option{--help=} option, then the descriptive text displayed by
1578 @option{--help=} is changed.  Instead of describing the displayed
1579 options, an indication is given as to whether the option is enabled,
1580 disabled or set to a specific value (assuming that the compiler
1581 knows this at the point where the @option{--help=} option is used).
1583 Here is a truncated example from the ARM port of @command{gcc}:
1585 @smallexample
1586   % gcc -Q -mabi=2 --help=target -c
1587   The following options are target specific:
1588   -mabi=                                2
1589   -mabort-on-noreturn                   [disabled]
1590   -mapcs                                [disabled]
1591 @end smallexample
1593 The output is sensitive to the effects of previous command-line
1594 options, so for example it is possible to find out which optimizations
1595 are enabled at @option{-O2} by using:
1597 @smallexample
1598 -Q -O2 --help=optimizers
1599 @end smallexample
1601 Alternatively you can discover which binary optimizations are enabled
1602 by @option{-O3} by using:
1604 @smallexample
1605 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1606 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1607 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1608 @end smallexample
1610 @item --version
1611 @opindex version
1612 Display the version number and copyrights of the invoked GCC@.
1614 @item -pass-exit-codes
1615 @opindex pass-exit-codes
1616 Normally the @command{gcc} program exits with the code of 1 if any
1617 phase of the compiler returns a non-success return code.  If you specify
1618 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1619 the numerically highest error produced by any phase returning an error
1620 indication.  The C, C++, and Fortran front ends return 4 if an internal
1621 compiler error is encountered.
1623 @item -pipe
1624 @opindex pipe
1625 Use pipes rather than temporary files for communication between the
1626 various stages of compilation.  This fails to work on some systems where
1627 the assembler is unable to read from a pipe; but the GNU assembler has
1628 no trouble.
1630 @item -specs=@var{file}
1631 @opindex specs
1632 Process @var{file} after the compiler reads in the standard @file{specs}
1633 file, in order to override the defaults which the @command{gcc} driver
1634 program uses when determining what switches to pass to @command{cc1},
1635 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1636 @option{-specs=@var{file}} can be specified on the command line, and they
1637 are processed in order, from left to right.  @xref{Spec Files}, for
1638 information about the format of the @var{file}.
1640 @item -wrapper
1641 @opindex wrapper
1642 Invoke all subcommands under a wrapper program.  The name of the
1643 wrapper program and its parameters are passed as a comma separated
1644 list.
1646 @smallexample
1647 gcc -c t.c -wrapper gdb,--args
1648 @end smallexample
1650 @noindent
1651 This invokes all subprograms of @command{gcc} under
1652 @samp{gdb --args}, thus the invocation of @command{cc1} is
1653 @samp{gdb --args cc1 @dots{}}.
1655 @item -fplugin=@var{name}.so
1656 @opindex fplugin
1657 Load the plugin code in file @var{name}.so, assumed to be a
1658 shared object to be dlopen'd by the compiler.  The base name of
1659 the shared object file is used to identify the plugin for the
1660 purposes of argument parsing (See
1661 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1662 Each plugin should define the callback functions specified in the
1663 Plugins API.
1665 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1666 @opindex fplugin-arg
1667 Define an argument called @var{key} with a value of @var{value}
1668 for the plugin called @var{name}.
1670 @item -fdump-ada-spec@r{[}-slim@r{]}
1671 @opindex fdump-ada-spec
1672 For C and C++ source and include files, generate corresponding Ada specs.
1673 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1674 GNAT User's Guide}, which provides detailed documentation on this feature.
1676 @item -fada-spec-parent=@var{unit}
1677 @opindex fada-spec-parent
1678 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1679 Ada specs as child units of parent @var{unit}.
1681 @item -fdump-go-spec=@var{file}
1682 @opindex fdump-go-spec
1683 For input files in any language, generate corresponding Go
1684 declarations in @var{file}.  This generates Go @code{const},
1685 @code{type}, @code{var}, and @code{func} declarations which may be a
1686 useful way to start writing a Go interface to code written in some
1687 other language.
1689 @include @value{srcdir}/../libiberty/at-file.texi
1690 @end table
1692 @node Invoking G++
1693 @section Compiling C++ Programs
1695 @cindex suffixes for C++ source
1696 @cindex C++ source file suffixes
1697 C++ source files conventionally use one of the suffixes @samp{.C},
1698 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1699 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1700 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1701 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1702 files with these names and compiles them as C++ programs even if you
1703 call the compiler the same way as for compiling C programs (usually
1704 with the name @command{gcc}).
1706 @findex g++
1707 @findex c++
1708 However, the use of @command{gcc} does not add the C++ library.
1709 @command{g++} is a program that calls GCC and automatically specifies linking
1710 against the C++ library.  It treats @samp{.c},
1711 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1712 files unless @option{-x} is used.  This program is also useful when
1713 precompiling a C header file with a @samp{.h} extension for use in C++
1714 compilations.  On many systems, @command{g++} is also installed with
1715 the name @command{c++}.
1717 @cindex invoking @command{g++}
1718 When you compile C++ programs, you may specify many of the same
1719 command-line options that you use for compiling programs in any
1720 language; or command-line options meaningful for C and related
1721 languages; or options that are meaningful only for C++ programs.
1722 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1723 explanations of options for languages related to C@.
1724 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1725 explanations of options that are meaningful only for C++ programs.
1727 @node C Dialect Options
1728 @section Options Controlling C Dialect
1729 @cindex dialect options
1730 @cindex language dialect options
1731 @cindex options, dialect
1733 The following options control the dialect of C (or languages derived
1734 from C, such as C++, Objective-C and Objective-C++) that the compiler
1735 accepts:
1737 @table @gcctabopt
1738 @cindex ANSI support
1739 @cindex ISO support
1740 @item -ansi
1741 @opindex ansi
1742 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1743 equivalent to @option{-std=c++98}.
1745 This turns off certain features of GCC that are incompatible with ISO
1746 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1747 such as the @code{asm} and @code{typeof} keywords, and
1748 predefined macros such as @code{unix} and @code{vax} that identify the
1749 type of system you are using.  It also enables the undesirable and
1750 rarely used ISO trigraph feature.  For the C compiler,
1751 it disables recognition of C++ style @samp{//} comments as well as
1752 the @code{inline} keyword.
1754 The alternate keywords @code{__asm__}, @code{__extension__},
1755 @code{__inline__} and @code{__typeof__} continue to work despite
1756 @option{-ansi}.  You would not want to use them in an ISO C program, of
1757 course, but it is useful to put them in header files that might be included
1758 in compilations done with @option{-ansi}.  Alternate predefined macros
1759 such as @code{__unix__} and @code{__vax__} are also available, with or
1760 without @option{-ansi}.
1762 The @option{-ansi} option does not cause non-ISO programs to be
1763 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1764 addition to @option{-ansi}.  @xref{Warning Options}.
1766 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1767 option is used.  Some header files may notice this macro and refrain
1768 from declaring certain functions or defining certain macros that the
1769 ISO standard doesn't call for; this is to avoid interfering with any
1770 programs that might use these names for other things.
1772 Functions that are normally built in but do not have semantics
1773 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1774 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1775 built-in functions provided by GCC}, for details of the functions
1776 affected.
1778 @item -std=
1779 @opindex std
1780 Determine the language standard. @xref{Standards,,Language Standards
1781 Supported by GCC}, for details of these standard versions.  This option
1782 is currently only supported when compiling C or C++.
1784 The compiler can accept several base standards, such as @samp{c90} or
1785 @samp{c++98}, and GNU dialects of those standards, such as
1786 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1787 compiler accepts all programs following that standard plus those
1788 using GNU extensions that do not contradict it.  For example,
1789 @option{-std=c90} turns off certain features of GCC that are
1790 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1791 keywords, but not other GNU extensions that do not have a meaning in
1792 ISO C90, such as omitting the middle term of a @code{?:}
1793 expression. On the other hand, when a GNU dialect of a standard is
1794 specified, all features supported by the compiler are enabled, even when
1795 those features change the meaning of the base standard.  As a result, some
1796 strict-conforming programs may be rejected.  The particular standard
1797 is used by @option{-Wpedantic} to identify which features are GNU
1798 extensions given that version of the standard. For example
1799 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1800 comments, while @option{-std=gnu99 -Wpedantic} does not.
1802 A value for this option must be provided; possible values are
1804 @table @samp
1805 @item c90
1806 @itemx c89
1807 @itemx iso9899:1990
1808 Support all ISO C90 programs (certain GNU extensions that conflict
1809 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1811 @item iso9899:199409
1812 ISO C90 as modified in amendment 1.
1814 @item c99
1815 @itemx c9x
1816 @itemx iso9899:1999
1817 @itemx iso9899:199x
1818 ISO C99.  This standard is substantially completely supported, modulo
1819 bugs and floating-point issues
1820 (mainly but not entirely relating to optional C99 features from
1821 Annexes F and G).  See
1822 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1823 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1825 @item c11
1826 @itemx c1x
1827 @itemx iso9899:2011
1828 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1829 substantially completely supported, modulo bugs, floating-point issues
1830 (mainly but not entirely relating to optional C11 features from
1831 Annexes F and G) and the optional Annexes K (Bounds-checking
1832 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1834 @item c17
1835 @itemx c18
1836 @itemx iso9899:2017
1837 @itemx iso9899:2018
1838 ISO C17, the 2017 revision of the ISO C standard (expected to be
1839 published in 2018).  This standard is
1840 same as C11 except for corrections of defects (all of which are also
1841 applied with @option{-std=c11}) and a new value of
1842 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1844 @item gnu90
1845 @itemx gnu89
1846 GNU dialect of ISO C90 (including some C99 features).
1848 @item gnu99
1849 @itemx gnu9x
1850 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1852 @item gnu11
1853 @itemx gnu1x
1854 GNU dialect of ISO C11.
1855 The name @samp{gnu1x} is deprecated.
1857 @item gnu17
1858 @itemx gnu18
1859 GNU dialect of ISO C17.  This is the default for C code.
1861 @item c++98
1862 @itemx c++03
1863 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1864 additional defect reports. Same as @option{-ansi} for C++ code.
1866 @item gnu++98
1867 @itemx gnu++03
1868 GNU dialect of @option{-std=c++98}.
1870 @item c++11
1871 @itemx c++0x
1872 The 2011 ISO C++ standard plus amendments.
1873 The name @samp{c++0x} is deprecated.
1875 @item gnu++11
1876 @itemx gnu++0x
1877 GNU dialect of @option{-std=c++11}.
1878 The name @samp{gnu++0x} is deprecated.
1880 @item c++14
1881 @itemx c++1y
1882 The 2014 ISO C++ standard plus amendments.
1883 The name @samp{c++1y} is deprecated.
1885 @item gnu++14
1886 @itemx gnu++1y
1887 GNU dialect of @option{-std=c++14}.
1888 This is the default for C++ code.
1889 The name @samp{gnu++1y} is deprecated.
1891 @item c++17
1892 @itemx c++1z
1893 The 2017 ISO C++ standard plus amendments.
1894 The name @samp{c++1z} is deprecated.
1896 @item gnu++17
1897 @itemx gnu++1z
1898 GNU dialect of @option{-std=c++17}.
1899 The name @samp{gnu++1z} is deprecated.
1901 @item c++2a
1902 The next revision of the ISO C++ standard, tentatively planned for
1903 2020.  Support is highly experimental, and will almost certainly
1904 change in incompatible ways in future releases.
1906 @item gnu++2a
1907 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1908 and will almost certainly change in incompatible ways in future
1909 releases.
1910 @end table
1912 @item -fgnu89-inline
1913 @opindex fgnu89-inline
1914 The option @option{-fgnu89-inline} tells GCC to use the traditional
1915 GNU semantics for @code{inline} functions when in C99 mode.
1916 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1917 Using this option is roughly equivalent to adding the
1918 @code{gnu_inline} function attribute to all inline functions
1919 (@pxref{Function Attributes}).
1921 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1922 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1923 specifies the default behavior).
1924 This option is not supported in @option{-std=c90} or
1925 @option{-std=gnu90} mode.
1927 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1928 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1929 in effect for @code{inline} functions.  @xref{Common Predefined
1930 Macros,,,cpp,The C Preprocessor}.
1932 @item -fpermitted-flt-eval-methods=@var{style}
1933 @opindex fpermitted-flt-eval-methods
1934 @opindex fpermitted-flt-eval-methods=c11
1935 @opindex fpermitted-flt-eval-methods=ts-18661-3
1936 ISO/IEC TS 18661-3 defines new permissible values for
1937 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1938 a semantic type that is an interchange or extended format should be
1939 evaluated to the precision and range of that type.  These new values are
1940 a superset of those permitted under C99/C11, which does not specify the
1941 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1942 conforming to C11 may not have been written expecting the possibility of
1943 the new values.
1945 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1946 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1947 or the extended set of values specified in ISO/IEC TS 18661-3.
1949 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1951 The default when in a standards compliant mode (@option{-std=c11} or similar)
1952 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1953 dialect (@option{-std=gnu11} or similar) is
1954 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1956 @item -aux-info @var{filename}
1957 @opindex aux-info
1958 Output to the given filename prototyped declarations for all functions
1959 declared and/or defined in a translation unit, including those in header
1960 files.  This option is silently ignored in any language other than C@.
1962 Besides declarations, the file indicates, in comments, the origin of
1963 each declaration (source file and line), whether the declaration was
1964 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1965 @samp{O} for old, respectively, in the first character after the line
1966 number and the colon), and whether it came from a declaration or a
1967 definition (@samp{C} or @samp{F}, respectively, in the following
1968 character).  In the case of function definitions, a K&R-style list of
1969 arguments followed by their declarations is also provided, inside
1970 comments, after the declaration.
1972 @item -fallow-parameterless-variadic-functions
1973 @opindex fallow-parameterless-variadic-functions
1974 Accept variadic functions without named parameters.
1976 Although it is possible to define such a function, this is not very
1977 useful as it is not possible to read the arguments.  This is only
1978 supported for C as this construct is allowed by C++.
1980 @item -fno-asm
1981 @opindex fno-asm
1982 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1983 keyword, so that code can use these words as identifiers.  You can use
1984 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1985 instead.  @option{-ansi} implies @option{-fno-asm}.
1987 In C++, this switch only affects the @code{typeof} keyword, since
1988 @code{asm} and @code{inline} are standard keywords.  You may want to
1989 use the @option{-fno-gnu-keywords} flag instead, which has the same
1990 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1991 switch only affects the @code{asm} and @code{typeof} keywords, since
1992 @code{inline} is a standard keyword in ISO C99.
1994 @item -fno-builtin
1995 @itemx -fno-builtin-@var{function}
1996 @opindex fno-builtin
1997 @cindex built-in functions
1998 Don't recognize built-in functions that do not begin with
1999 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2000 functions provided by GCC}, for details of the functions affected,
2001 including those which are not built-in functions when @option{-ansi} or
2002 @option{-std} options for strict ISO C conformance are used because they
2003 do not have an ISO standard meaning.
2005 GCC normally generates special code to handle certain built-in functions
2006 more efficiently; for instance, calls to @code{alloca} may become single
2007 instructions which adjust the stack directly, and calls to @code{memcpy}
2008 may become inline copy loops.  The resulting code is often both smaller
2009 and faster, but since the function calls no longer appear as such, you
2010 cannot set a breakpoint on those calls, nor can you change the behavior
2011 of the functions by linking with a different library.  In addition,
2012 when a function is recognized as a built-in function, GCC may use
2013 information about that function to warn about problems with calls to
2014 that function, or to generate more efficient code, even if the
2015 resulting code still contains calls to that function.  For example,
2016 warnings are given with @option{-Wformat} for bad calls to
2017 @code{printf} when @code{printf} is built in and @code{strlen} is
2018 known not to modify global memory.
2020 With the @option{-fno-builtin-@var{function}} option
2021 only the built-in function @var{function} is
2022 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2023 function is named that is not built-in in this version of GCC, this
2024 option is ignored.  There is no corresponding
2025 @option{-fbuiltin-@var{function}} option; if you wish to enable
2026 built-in functions selectively when using @option{-fno-builtin} or
2027 @option{-ffreestanding}, you may define macros such as:
2029 @smallexample
2030 #define abs(n)          __builtin_abs ((n))
2031 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2032 @end smallexample
2034 @item -fgimple
2035 @opindex fgimple
2037 Enable parsing of function definitions marked with @code{__GIMPLE}.
2038 This is an experimental feature that allows unit testing of GIMPLE
2039 passes.
2041 @item -fhosted
2042 @opindex fhosted
2043 @cindex hosted environment
2045 Assert that compilation targets a hosted environment.  This implies
2046 @option{-fbuiltin}.  A hosted environment is one in which the
2047 entire standard library is available, and in which @code{main} has a return
2048 type of @code{int}.  Examples are nearly everything except a kernel.
2049 This is equivalent to @option{-fno-freestanding}.
2051 @item -ffreestanding
2052 @opindex ffreestanding
2053 @cindex hosted environment
2055 Assert that compilation targets a freestanding environment.  This
2056 implies @option{-fno-builtin}.  A freestanding environment
2057 is one in which the standard library may not exist, and program startup may
2058 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2059 This is equivalent to @option{-fno-hosted}.
2061 @xref{Standards,,Language Standards Supported by GCC}, for details of
2062 freestanding and hosted environments.
2064 @item -fopenacc
2065 @opindex fopenacc
2066 @cindex OpenACC accelerator programming
2067 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2068 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2069 compiler generates accelerated code according to the OpenACC Application
2070 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2071 implies @option{-pthread}, and thus is only supported on targets that
2072 have support for @option{-pthread}.
2074 @item -fopenacc-dim=@var{geom}
2075 @opindex fopenacc-dim
2076 @cindex OpenACC accelerator programming
2077 Specify default compute dimensions for parallel offload regions that do
2078 not explicitly specify.  The @var{geom} value is a triple of
2079 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2080 can be omitted, to use a target-specific default value.
2082 @item -fopenmp
2083 @opindex fopenmp
2084 @cindex OpenMP parallel
2085 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2086 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2087 compiler generates parallel code according to the OpenMP Application
2088 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2089 implies @option{-pthread}, and thus is only supported on targets that
2090 have support for @option{-pthread}. @option{-fopenmp} implies
2091 @option{-fopenmp-simd}.
2093 @item -fopenmp-simd
2094 @opindex fopenmp-simd
2095 @cindex OpenMP SIMD
2096 @cindex SIMD
2097 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2098 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2099 are ignored.
2101 @item -fgnu-tm
2102 @opindex fgnu-tm
2103 When the option @option{-fgnu-tm} is specified, the compiler
2104 generates code for the Linux variant of Intel's current Transactional
2105 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2106 an experimental feature whose interface may change in future versions
2107 of GCC, as the official specification changes.  Please note that not
2108 all architectures are supported for this feature.
2110 For more information on GCC's support for transactional memory,
2111 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2112 Transactional Memory Library}.
2114 Note that the transactional memory feature is not supported with
2115 non-call exceptions (@option{-fnon-call-exceptions}).
2117 @item -fms-extensions
2118 @opindex fms-extensions
2119 Accept some non-standard constructs used in Microsoft header files.
2121 In C++ code, this allows member names in structures to be similar
2122 to previous types declarations.
2124 @smallexample
2125 typedef int UOW;
2126 struct ABC @{
2127   UOW UOW;
2129 @end smallexample
2131 Some cases of unnamed fields in structures and unions are only
2132 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2133 fields within structs/unions}, for details.
2135 Note that this option is off for all targets but x86 
2136 targets using ms-abi.
2138 @item -fplan9-extensions
2139 @opindex fplan9-extensions
2140 Accept some non-standard constructs used in Plan 9 code.
2142 This enables @option{-fms-extensions}, permits passing pointers to
2143 structures with anonymous fields to functions that expect pointers to
2144 elements of the type of the field, and permits referring to anonymous
2145 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2146 struct/union fields within structs/unions}, for details.  This is only
2147 supported for C, not C++.
2149 @item -fcond-mismatch
2150 @opindex fcond-mismatch
2151 Allow conditional expressions with mismatched types in the second and
2152 third arguments.  The value of such an expression is void.  This option
2153 is not supported for C++.
2155 @item -flax-vector-conversions
2156 @opindex flax-vector-conversions
2157 Allow implicit conversions between vectors with differing numbers of
2158 elements and/or incompatible element types.  This option should not be
2159 used for new code.
2161 @item -funsigned-char
2162 @opindex funsigned-char
2163 Let the type @code{char} be unsigned, like @code{unsigned char}.
2165 Each kind of machine has a default for what @code{char} should
2166 be.  It is either like @code{unsigned char} by default or like
2167 @code{signed char} by default.
2169 Ideally, a portable program should always use @code{signed char} or
2170 @code{unsigned char} when it depends on the signedness of an object.
2171 But many programs have been written to use plain @code{char} and
2172 expect it to be signed, or expect it to be unsigned, depending on the
2173 machines they were written for.  This option, and its inverse, let you
2174 make such a program work with the opposite default.
2176 The type @code{char} is always a distinct type from each of
2177 @code{signed char} or @code{unsigned char}, even though its behavior
2178 is always just like one of those two.
2180 @item -fsigned-char
2181 @opindex fsigned-char
2182 Let the type @code{char} be signed, like @code{signed char}.
2184 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2185 the negative form of @option{-funsigned-char}.  Likewise, the option
2186 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2188 @item -fsigned-bitfields
2189 @itemx -funsigned-bitfields
2190 @itemx -fno-signed-bitfields
2191 @itemx -fno-unsigned-bitfields
2192 @opindex fsigned-bitfields
2193 @opindex funsigned-bitfields
2194 @opindex fno-signed-bitfields
2195 @opindex fno-unsigned-bitfields
2196 These options control whether a bit-field is signed or unsigned, when the
2197 declaration does not use either @code{signed} or @code{unsigned}.  By
2198 default, such a bit-field is signed, because this is consistent: the
2199 basic integer types such as @code{int} are signed types.
2201 @item -fsso-struct=@var{endianness}
2202 @opindex fsso-struct
2203 Set the default scalar storage order of structures and unions to the
2204 specified endianness.  The accepted values are @samp{big-endian},
2205 @samp{little-endian} and @samp{native} for the native endianness of
2206 the target (the default).  This option is not supported for C++.
2208 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2209 code that is not binary compatible with code generated without it if the
2210 specified endianness is not the native endianness of the target.
2211 @end table
2213 @node C++ Dialect Options
2214 @section Options Controlling C++ Dialect
2216 @cindex compiler options, C++
2217 @cindex C++ options, command-line
2218 @cindex options, C++
2219 This section describes the command-line options that are only meaningful
2220 for C++ programs.  You can also use most of the GNU compiler options
2221 regardless of what language your program is in.  For example, you
2222 might compile a file @file{firstClass.C} like this:
2224 @smallexample
2225 g++ -g -fstrict-enums -O -c firstClass.C
2226 @end smallexample
2228 @noindent
2229 In this example, only @option{-fstrict-enums} is an option meant
2230 only for C++ programs; you can use the other options with any
2231 language supported by GCC@.
2233 Some options for compiling C programs, such as @option{-std}, are also
2234 relevant for C++ programs.
2235 @xref{C Dialect Options,,Options Controlling C Dialect}.
2237 Here is a list of options that are @emph{only} for compiling C++ programs:
2239 @table @gcctabopt
2241 @item -fabi-version=@var{n}
2242 @opindex fabi-version
2243 Use version @var{n} of the C++ ABI@.  The default is version 0.
2245 Version 0 refers to the version conforming most closely to
2246 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2247 will change in different versions of G++ as ABI bugs are fixed.
2249 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2251 Version 2 is the version of the C++ ABI that first appeared in G++
2252 3.4, and was the default through G++ 4.9.
2254 Version 3 corrects an error in mangling a constant address as a
2255 template argument.
2257 Version 4, which first appeared in G++ 4.5, implements a standard
2258 mangling for vector types.
2260 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2261 attribute const/volatile on function pointer types, decltype of a
2262 plain decl, and use of a function parameter in the declaration of
2263 another parameter.
2265 Version 6, which first appeared in G++ 4.7, corrects the promotion
2266 behavior of C++11 scoped enums and the mangling of template argument
2267 packs, const/static_cast, prefix ++ and --, and a class scope function
2268 used as a template argument.
2270 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2271 builtin type and corrects the mangling of lambdas in default argument
2272 scope.
2274 Version 8, which first appeared in G++ 4.9, corrects the substitution
2275 behavior of function types with function-cv-qualifiers.
2277 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2278 @code{nullptr_t}.
2280 Version 10, which first appeared in G++ 6.1, adds mangling of
2281 attributes that affect type identity, such as ia32 calling convention
2282 attributes (e.g. @samp{stdcall}).
2284 Version 11, which first appeared in G++ 7, corrects the mangling of
2285 sizeof... expressions and operator names.  For multiple entities with
2286 the same name within a function, that are declared in different scopes,
2287 the mangling now changes starting with the twelfth occurrence.  It also
2288 implies @option{-fnew-inheriting-ctors}.
2290 See also @option{-Wabi}.
2292 @item -fabi-compat-version=@var{n}
2293 @opindex fabi-compat-version
2294 On targets that support strong aliases, G++
2295 works around mangling changes by creating an alias with the correct
2296 mangled name when defining a symbol with an incorrect mangled name.
2297 This switch specifies which ABI version to use for the alias.
2299 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2300 compatibility).  If another ABI version is explicitly selected, this
2301 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2302 use @option{-fabi-compat-version=2}.
2304 If this option is not provided but @option{-Wabi=@var{n}} is, that
2305 version is used for compatibility aliases.  If this option is provided
2306 along with @option{-Wabi} (without the version), the version from this
2307 option is used for the warning.
2309 @item -fno-access-control
2310 @opindex fno-access-control
2311 Turn off all access checking.  This switch is mainly useful for working
2312 around bugs in the access control code.
2314 @item -faligned-new
2315 @opindex faligned-new
2316 Enable support for C++17 @code{new} of types that require more
2317 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2318 numeric argument such as @code{-faligned-new=32} can be used to
2319 specify how much alignment (in bytes) is provided by that function,
2320 but few users will need to override the default of
2321 @code{alignof(std::max_align_t)}.
2323 This flag is enabled by default for @option{-std=c++17}.
2325 @item -fcheck-new
2326 @opindex fcheck-new
2327 Check that the pointer returned by @code{operator new} is non-null
2328 before attempting to modify the storage allocated.  This check is
2329 normally unnecessary because the C++ standard specifies that
2330 @code{operator new} only returns @code{0} if it is declared
2331 @code{throw()}, in which case the compiler always checks the
2332 return value even without this option.  In all other cases, when
2333 @code{operator new} has a non-empty exception specification, memory
2334 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2335 @samp{new (nothrow)}.
2337 @item -fconcepts
2338 @opindex fconcepts
2339 Enable support for the C++ Extensions for Concepts Technical
2340 Specification, ISO 19217 (2015), which allows code like
2342 @smallexample
2343 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2344 template <Addable T> T add (T a, T b) @{ return a + b; @}
2345 @end smallexample
2347 @item -fconstexpr-depth=@var{n}
2348 @opindex fconstexpr-depth
2349 Set the maximum nested evaluation depth for C++11 constexpr functions
2350 to @var{n}.  A limit is needed to detect endless recursion during
2351 constant expression evaluation.  The minimum specified by the standard
2352 is 512.
2354 @item -fconstexpr-loop-limit=@var{n}
2355 @opindex fconstexpr-loop-limit
2356 Set the maximum number of iterations for a loop in C++14 constexpr functions
2357 to @var{n}.  A limit is needed to detect infinite loops during
2358 constant expression evaluation.  The default is 262144 (1<<18).
2360 @item -fdeduce-init-list
2361 @opindex fdeduce-init-list
2362 Enable deduction of a template type parameter as
2363 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2365 @smallexample
2366 template <class T> auto forward(T t) -> decltype (realfn (t))
2368   return realfn (t);
2371 void f()
2373   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2375 @end smallexample
2377 This deduction was implemented as a possible extension to the
2378 originally proposed semantics for the C++11 standard, but was not part
2379 of the final standard, so it is disabled by default.  This option is
2380 deprecated, and may be removed in a future version of G++.
2382 @item -ffriend-injection
2383 @opindex ffriend-injection
2384 Inject friend functions into the enclosing namespace, so that they are
2385 visible outside the scope of the class in which they are declared.
2386 Friend functions were documented to work this way in the old Annotated
2387 C++ Reference Manual.  
2388 However, in ISO C++ a friend function that is not declared
2389 in an enclosing scope can only be found using argument dependent
2390 lookup.  GCC defaults to the standard behavior.
2392 This option is for compatibility, and may be removed in a future
2393 release of G++.
2395 @item -fno-elide-constructors
2396 @opindex fno-elide-constructors
2397 The C++ standard allows an implementation to omit creating a temporary
2398 that is only used to initialize another object of the same type.
2399 Specifying this option disables that optimization, and forces G++ to
2400 call the copy constructor in all cases.  This option also causes G++
2401 to call trivial member functions which otherwise would be expanded inline.
2403 In C++17, the compiler is required to omit these temporaries, but this
2404 option still affects trivial member functions.
2406 @item -fno-enforce-eh-specs
2407 @opindex fno-enforce-eh-specs
2408 Don't generate code to check for violation of exception specifications
2409 at run time.  This option violates the C++ standard, but may be useful
2410 for reducing code size in production builds, much like defining
2411 @code{NDEBUG}.  This does not give user code permission to throw
2412 exceptions in violation of the exception specifications; the compiler
2413 still optimizes based on the specifications, so throwing an
2414 unexpected exception results in undefined behavior at run time.
2416 @item -fextern-tls-init
2417 @itemx -fno-extern-tls-init
2418 @opindex fextern-tls-init
2419 @opindex fno-extern-tls-init
2420 The C++11 and OpenMP standards allow @code{thread_local} and
2421 @code{threadprivate} variables to have dynamic (runtime)
2422 initialization.  To support this, any use of such a variable goes
2423 through a wrapper function that performs any necessary initialization.
2424 When the use and definition of the variable are in the same
2425 translation unit, this overhead can be optimized away, but when the
2426 use is in a different translation unit there is significant overhead
2427 even if the variable doesn't actually need dynamic initialization.  If
2428 the programmer can be sure that no use of the variable in a
2429 non-defining TU needs to trigger dynamic initialization (either
2430 because the variable is statically initialized, or a use of the
2431 variable in the defining TU will be executed before any uses in
2432 another TU), they can avoid this overhead with the
2433 @option{-fno-extern-tls-init} option.
2435 On targets that support symbol aliases, the default is
2436 @option{-fextern-tls-init}.  On targets that do not support symbol
2437 aliases, the default is @option{-fno-extern-tls-init}.
2439 @item -ffor-scope
2440 @itemx -fno-for-scope
2441 @opindex ffor-scope
2442 @opindex fno-for-scope
2443 If @option{-ffor-scope} is specified, the scope of variables declared in
2444 a @i{for-init-statement} is limited to the @code{for} loop itself,
2445 as specified by the C++ standard.
2446 If @option{-fno-for-scope} is specified, the scope of variables declared in
2447 a @i{for-init-statement} extends to the end of the enclosing scope,
2448 as was the case in old versions of G++, and other (traditional)
2449 implementations of C++.
2451 If neither flag is given, the default is to follow the standard,
2452 but to allow and give a warning for old-style code that would
2453 otherwise be invalid, or have different behavior.
2455 @item -fno-gnu-keywords
2456 @opindex fno-gnu-keywords
2457 Do not recognize @code{typeof} as a keyword, so that code can use this
2458 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2459 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2460 @option{-std=c++98}, @option{-std=c++11}, etc.
2462 @item -fno-implicit-templates
2463 @opindex fno-implicit-templates
2464 Never emit code for non-inline templates that are instantiated
2465 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2466 @xref{Template Instantiation}, for more information.
2468 @item -fno-implicit-inline-templates
2469 @opindex fno-implicit-inline-templates
2470 Don't emit code for implicit instantiations of inline templates, either.
2471 The default is to handle inlines differently so that compiles with and
2472 without optimization need the same set of explicit instantiations.
2474 @item -fno-implement-inlines
2475 @opindex fno-implement-inlines
2476 To save space, do not emit out-of-line copies of inline functions
2477 controlled by @code{#pragma implementation}.  This causes linker
2478 errors if these functions are not inlined everywhere they are called.
2480 @item -fms-extensions
2481 @opindex fms-extensions
2482 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2483 int and getting a pointer to member function via non-standard syntax.
2485 @item -fnew-inheriting-ctors
2486 @opindex fnew-inheriting-ctors
2487 Enable the P0136 adjustment to the semantics of C++11 constructor
2488 inheritance.  This is part of C++17 but also considered to be a Defect
2489 Report against C++11 and C++14.  This flag is enabled by default
2490 unless @option{-fabi-version=10} or lower is specified.
2492 @item -fnew-ttp-matching
2493 @opindex fnew-ttp-matching
2494 Enable the P0522 resolution to Core issue 150, template template
2495 parameters and default arguments: this allows a template with default
2496 template arguments as an argument for a template template parameter
2497 with fewer template parameters.  This flag is enabled by default for
2498 @option{-std=c++17}.
2500 @item -fno-nonansi-builtins
2501 @opindex fno-nonansi-builtins
2502 Disable built-in declarations of functions that are not mandated by
2503 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2504 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2506 @item -fnothrow-opt
2507 @opindex fnothrow-opt
2508 Treat a @code{throw()} exception specification as if it were a
2509 @code{noexcept} specification to reduce or eliminate the text size
2510 overhead relative to a function with no exception specification.  If
2511 the function has local variables of types with non-trivial
2512 destructors, the exception specification actually makes the
2513 function smaller because the EH cleanups for those variables can be
2514 optimized away.  The semantic effect is that an exception thrown out of
2515 a function with such an exception specification results in a call
2516 to @code{terminate} rather than @code{unexpected}.
2518 @item -fno-operator-names
2519 @opindex fno-operator-names
2520 Do not treat the operator name keywords @code{and}, @code{bitand},
2521 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2522 synonyms as keywords.
2524 @item -fno-optional-diags
2525 @opindex fno-optional-diags
2526 Disable diagnostics that the standard says a compiler does not need to
2527 issue.  Currently, the only such diagnostic issued by G++ is the one for
2528 a name having multiple meanings within a class.
2530 @item -fpermissive
2531 @opindex fpermissive
2532 Downgrade some diagnostics about nonconformant code from errors to
2533 warnings.  Thus, using @option{-fpermissive} allows some
2534 nonconforming code to compile.
2536 @item -fno-pretty-templates
2537 @opindex fno-pretty-templates
2538 When an error message refers to a specialization of a function
2539 template, the compiler normally prints the signature of the
2540 template followed by the template arguments and any typedefs or
2541 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2542 rather than @code{void f(int)}) so that it's clear which template is
2543 involved.  When an error message refers to a specialization of a class
2544 template, the compiler omits any template arguments that match
2545 the default template arguments for that template.  If either of these
2546 behaviors make it harder to understand the error message rather than
2547 easier, you can use @option{-fno-pretty-templates} to disable them.
2549 @item -frepo
2550 @opindex frepo
2551 Enable automatic template instantiation at link time.  This option also
2552 implies @option{-fno-implicit-templates}.  @xref{Template
2553 Instantiation}, for more information.
2555 @item -fno-rtti
2556 @opindex fno-rtti
2557 Disable generation of information about every class with virtual
2558 functions for use by the C++ run-time type identification features
2559 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2560 of the language, you can save some space by using this flag.  Note that
2561 exception handling uses the same information, but G++ generates it as
2562 needed. The @code{dynamic_cast} operator can still be used for casts that
2563 do not require run-time type information, i.e.@: casts to @code{void *} or to
2564 unambiguous base classes.
2566 @item -fsized-deallocation
2567 @opindex fsized-deallocation
2568 Enable the built-in global declarations
2569 @smallexample
2570 void operator delete (void *, std::size_t) noexcept;
2571 void operator delete[] (void *, std::size_t) noexcept;
2572 @end smallexample
2573 as introduced in C++14.  This is useful for user-defined replacement
2574 deallocation functions that, for example, use the size of the object
2575 to make deallocation faster.  Enabled by default under
2576 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2577 warns about places that might want to add a definition.
2579 @item -fstrict-enums
2580 @opindex fstrict-enums
2581 Allow the compiler to optimize using the assumption that a value of
2582 enumerated type can only be one of the values of the enumeration (as
2583 defined in the C++ standard; basically, a value that can be
2584 represented in the minimum number of bits needed to represent all the
2585 enumerators).  This assumption may not be valid if the program uses a
2586 cast to convert an arbitrary integer value to the enumerated type.
2588 @item -fstrong-eval-order
2589 @opindex fstrong-eval-order
2590 Evaluate member access, array subscripting, and shift expressions in
2591 left-to-right order, and evaluate assignment in right-to-left order,
2592 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2593 @option{-fstrong-eval-order=some} enables just the ordering of member
2594 access and shift expressions, and is the default without
2595 @option{-std=c++17}.
2597 @item -ftemplate-backtrace-limit=@var{n}
2598 @opindex ftemplate-backtrace-limit
2599 Set the maximum number of template instantiation notes for a single
2600 warning or error to @var{n}.  The default value is 10.
2602 @item -ftemplate-depth=@var{n}
2603 @opindex ftemplate-depth
2604 Set the maximum instantiation depth for template classes to @var{n}.
2605 A limit on the template instantiation depth is needed to detect
2606 endless recursions during template class instantiation.  ANSI/ISO C++
2607 conforming programs must not rely on a maximum depth greater than 17
2608 (changed to 1024 in C++11).  The default value is 900, as the compiler
2609 can run out of stack space before hitting 1024 in some situations.
2611 @item -fno-threadsafe-statics
2612 @opindex fno-threadsafe-statics
2613 Do not emit the extra code to use the routines specified in the C++
2614 ABI for thread-safe initialization of local statics.  You can use this
2615 option to reduce code size slightly in code that doesn't need to be
2616 thread-safe.
2618 @item -fuse-cxa-atexit
2619 @opindex fuse-cxa-atexit
2620 Register destructors for objects with static storage duration with the
2621 @code{__cxa_atexit} function rather than the @code{atexit} function.
2622 This option is required for fully standards-compliant handling of static
2623 destructors, but only works if your C library supports
2624 @code{__cxa_atexit}.
2626 @item -fno-use-cxa-get-exception-ptr
2627 @opindex fno-use-cxa-get-exception-ptr
2628 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2629 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2630 if the runtime routine is not available.
2632 @item -fvisibility-inlines-hidden
2633 @opindex fvisibility-inlines-hidden
2634 This switch declares that the user does not attempt to compare
2635 pointers to inline functions or methods where the addresses of the two functions
2636 are taken in different shared objects.
2638 The effect of this is that GCC may, effectively, mark inline methods with
2639 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2640 appear in the export table of a DSO and do not require a PLT indirection
2641 when used within the DSO@.  Enabling this option can have a dramatic effect
2642 on load and link times of a DSO as it massively reduces the size of the
2643 dynamic export table when the library makes heavy use of templates.
2645 The behavior of this switch is not quite the same as marking the
2646 methods as hidden directly, because it does not affect static variables
2647 local to the function or cause the compiler to deduce that
2648 the function is defined in only one shared object.
2650 You may mark a method as having a visibility explicitly to negate the
2651 effect of the switch for that method.  For example, if you do want to
2652 compare pointers to a particular inline method, you might mark it as
2653 having default visibility.  Marking the enclosing class with explicit
2654 visibility has no effect.
2656 Explicitly instantiated inline methods are unaffected by this option
2657 as their linkage might otherwise cross a shared library boundary.
2658 @xref{Template Instantiation}.
2660 @item -fvisibility-ms-compat
2661 @opindex fvisibility-ms-compat
2662 This flag attempts to use visibility settings to make GCC's C++
2663 linkage model compatible with that of Microsoft Visual Studio.
2665 The flag makes these changes to GCC's linkage model:
2667 @enumerate
2668 @item
2669 It sets the default visibility to @code{hidden}, like
2670 @option{-fvisibility=hidden}.
2672 @item
2673 Types, but not their members, are not hidden by default.
2675 @item
2676 The One Definition Rule is relaxed for types without explicit
2677 visibility specifications that are defined in more than one
2678 shared object: those declarations are permitted if they are
2679 permitted when this option is not used.
2680 @end enumerate
2682 In new code it is better to use @option{-fvisibility=hidden} and
2683 export those classes that are intended to be externally visible.
2684 Unfortunately it is possible for code to rely, perhaps accidentally,
2685 on the Visual Studio behavior.
2687 Among the consequences of these changes are that static data members
2688 of the same type with the same name but defined in different shared
2689 objects are different, so changing one does not change the other;
2690 and that pointers to function members defined in different shared
2691 objects may not compare equal.  When this flag is given, it is a
2692 violation of the ODR to define types with the same name differently.
2694 @item -fno-weak
2695 @opindex fno-weak
2696 Do not use weak symbol support, even if it is provided by the linker.
2697 By default, G++ uses weak symbols if they are available.  This
2698 option exists only for testing, and should not be used by end-users;
2699 it results in inferior code and has no benefits.  This option may
2700 be removed in a future release of G++.
2702 @item -nostdinc++
2703 @opindex nostdinc++
2704 Do not search for header files in the standard directories specific to
2705 C++, but do still search the other standard directories.  (This option
2706 is used when building the C++ library.)
2707 @end table
2709 In addition, these optimization, warning, and code generation options
2710 have meanings only for C++ programs:
2712 @table @gcctabopt
2713 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2714 @opindex Wabi
2715 @opindex Wno-abi
2716 Warn when G++ it generates code that is probably not compatible with
2717 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2718 ABI with each major release, normally @option{-Wabi} will warn only if
2719 there is a check added later in a release series for an ABI issue
2720 discovered since the initial release.  @option{-Wabi} will warn about
2721 more things if an older ABI version is selected (with
2722 @option{-fabi-version=@var{n}}).
2724 @option{-Wabi} can also be used with an explicit version number to
2725 warn about compatibility with a particular @option{-fabi-version}
2726 level, e.g. @option{-Wabi=2} to warn about changes relative to
2727 @option{-fabi-version=2}.
2729 If an explicit version number is provided and
2730 @option{-fabi-compat-version} is not specified, the version number
2731 from this option is used for compatibility aliases.  If no explicit
2732 version number is provided with this option, but
2733 @option{-fabi-compat-version} is specified, that version number is
2734 used for ABI warnings.
2736 Although an effort has been made to warn about
2737 all such cases, there are probably some cases that are not warned about,
2738 even though G++ is generating incompatible code.  There may also be
2739 cases where warnings are emitted even though the code that is generated
2740 is compatible.
2742 You should rewrite your code to avoid these warnings if you are
2743 concerned about the fact that code generated by G++ may not be binary
2744 compatible with code generated by other compilers.
2746 Known incompatibilities in @option{-fabi-version=2} (which was the
2747 default from GCC 3.4 to 4.9) include:
2749 @itemize @bullet
2751 @item
2752 A template with a non-type template parameter of reference type was
2753 mangled incorrectly:
2754 @smallexample
2755 extern int N;
2756 template <int &> struct S @{@};
2757 void n (S<N>) @{2@}
2758 @end smallexample
2760 This was fixed in @option{-fabi-version=3}.
2762 @item
2763 SIMD vector types declared using @code{__attribute ((vector_size))} were
2764 mangled in a non-standard way that does not allow for overloading of
2765 functions taking vectors of different sizes.
2767 The mangling was changed in @option{-fabi-version=4}.
2769 @item
2770 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2771 qualifiers, and @code{decltype} of a plain declaration was folded away.
2773 These mangling issues were fixed in @option{-fabi-version=5}.
2775 @item
2776 Scoped enumerators passed as arguments to a variadic function are
2777 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2778 On most targets this does not actually affect the parameter passing
2779 ABI, as there is no way to pass an argument smaller than @code{int}.
2781 Also, the ABI changed the mangling of template argument packs,
2782 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2783 a class scope function used as a template argument.
2785 These issues were corrected in @option{-fabi-version=6}.
2787 @item
2788 Lambdas in default argument scope were mangled incorrectly, and the
2789 ABI changed the mangling of @code{nullptr_t}.
2791 These issues were corrected in @option{-fabi-version=7}.
2793 @item
2794 When mangling a function type with function-cv-qualifiers, the
2795 un-qualified function type was incorrectly treated as a substitution
2796 candidate.
2798 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2800 @item
2801 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2802 unaligned accesses.  Note that this did not affect the ABI of a
2803 function with a @code{nullptr_t} parameter, as parameters have a
2804 minimum alignment.
2806 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2808 @item
2809 Target-specific attributes that affect the identity of a type, such as
2810 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2811 did not affect the mangled name, leading to name collisions when
2812 function pointers were used as template arguments.
2814 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2816 @end itemize
2818 It also warns about psABI-related changes.  The known psABI changes at this
2819 point include:
2821 @itemize @bullet
2823 @item
2824 For SysV/x86-64, unions with @code{long double} members are 
2825 passed in memory as specified in psABI.  For example:
2827 @smallexample
2828 union U @{
2829   long double ld;
2830   int i;
2832 @end smallexample
2834 @noindent
2835 @code{union U} is always passed in memory.
2837 @end itemize
2839 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2840 @opindex Wabi-tag
2841 @opindex -Wabi-tag
2842 Warn when a type with an ABI tag is used in a context that does not
2843 have that ABI tag.  See @ref{C++ Attributes} for more information
2844 about ABI tags.
2846 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2847 @opindex Wctor-dtor-privacy
2848 @opindex Wno-ctor-dtor-privacy
2849 Warn when a class seems unusable because all the constructors or
2850 destructors in that class are private, and it has neither friends nor
2851 public static member functions.  Also warn if there are no non-private
2852 methods, and there's at least one private member function that isn't
2853 a constructor or destructor.
2855 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2856 @opindex Wdelete-non-virtual-dtor
2857 @opindex Wno-delete-non-virtual-dtor
2858 Warn when @code{delete} is used to destroy an instance of a class that
2859 has virtual functions and non-virtual destructor. It is unsafe to delete
2860 an instance of a derived class through a pointer to a base class if the
2861 base class does not have a virtual destructor.  This warning is enabled
2862 by @option{-Wall}.
2864 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2865 @opindex Wliteral-suffix
2866 @opindex Wno-literal-suffix
2867 Warn when a string or character literal is followed by a ud-suffix which does
2868 not begin with an underscore.  As a conforming extension, GCC treats such
2869 suffixes as separate preprocessing tokens in order to maintain backwards
2870 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2871 For example:
2873 @smallexample
2874 #define __STDC_FORMAT_MACROS
2875 #include <inttypes.h>
2876 #include <stdio.h>
2878 int main() @{
2879   int64_t i64 = 123;
2880   printf("My int64: %" PRId64"\n", i64);
2882 @end smallexample
2884 In this case, @code{PRId64} is treated as a separate preprocessing token.
2886 Additionally, warn when a user-defined literal operator is declared with
2887 a literal suffix identifier that doesn't begin with an underscore. Literal
2888 suffix identifiers that don't begin with an underscore are reserved for
2889 future standardization.
2891 This warning is enabled by default.
2893 @item -Wlto-type-mismatch
2894 @opindex Wlto-type-mismatch
2895 @opindex Wno-lto-type-mismatch
2897 During the link-time optimization warn about type mismatches in
2898 global declarations from different compilation units.
2899 Requires @option{-flto} to be enabled.  Enabled by default.
2901 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2902 @opindex Wnarrowing
2903 @opindex Wno-narrowing
2904 For C++11 and later standards, narrowing conversions are diagnosed by default,
2905 as required by the standard.  A narrowing conversion from a constant produces
2906 an error, and a narrowing conversion from a non-constant produces a warning,
2907 but @option{-Wno-narrowing} suppresses the diagnostic.
2908 Note that this does not affect the meaning of well-formed code;
2909 narrowing conversions are still considered ill-formed in SFINAE contexts.
2911 With @option{-Wnarrowing} in C++98, warn when a narrowing
2912 conversion prohibited by C++11 occurs within
2913 @samp{@{ @}}, e.g.
2915 @smallexample
2916 int i = @{ 2.2 @}; // error: narrowing from double to int
2917 @end smallexample
2919 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2921 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2922 @opindex Wnoexcept
2923 @opindex Wno-noexcept
2924 Warn when a noexcept-expression evaluates to false because of a call
2925 to a function that does not have a non-throwing exception
2926 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2927 the compiler to never throw an exception.
2929 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2930 @opindex Wnoexcept-type
2931 @opindex Wno-noexcept-type
2932 Warn if the C++17 feature making @code{noexcept} part of a function
2933 type changes the mangled name of a symbol relative to C++14.  Enabled
2934 by @option{-Wabi} and @option{-Wc++17-compat}.
2936 @smallexample
2937 template <class T> void f(T t) @{ t(); @};
2938 void g() noexcept;
2939 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2940 @end smallexample
2942 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2943 @opindex Wclass-memaccess
2944 Warn when the destination of a call to a raw memory function such as
2945 @code{memset} or @code{memcpy} is an object of class type writing into which
2946 might bypass the class non-trivial or deleted constructor or copy assignment,
2947 violate const-correctness or encapsulation, or corrupt the virtual table.
2948 Modifying the representation of such objects may violate invariants maintained
2949 by member functions of the class.  For example, the call to @code{memset}
2950 below is undefined becase it modifies a non-trivial class object and is,
2951 therefore, diagnosed.  The safe way to either initialize or clear the storage
2952 of objects of such types is by using the appropriate constructor or assignment
2953 operator, if one is available.
2954 @smallexample
2955 std::string str = "abc";
2956 memset (&str, 0, 3);
2957 @end smallexample
2958 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2960 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2961 @opindex Wnon-virtual-dtor
2962 @opindex Wno-non-virtual-dtor
2963 Warn when a class has virtual functions and an accessible non-virtual
2964 destructor itself or in an accessible polymorphic base class, in which
2965 case it is possible but unsafe to delete an instance of a derived
2966 class through a pointer to the class itself or base class.  This
2967 warning is automatically enabled if @option{-Weffc++} is specified.
2969 @item -Wregister @r{(C++ and Objective-C++ only)}
2970 @opindex Wregister
2971 @opindex Wno-register
2972 Warn on uses of the @code{register} storage class specifier, except
2973 when it is part of the GNU @ref{Explicit Register Variables} extension.
2974 The use of the @code{register} keyword as storage class specifier has
2975 been deprecated in C++11 and removed in C++17.
2976 Enabled by default with @option{-std=c++17}.
2978 @item -Wreorder @r{(C++ and Objective-C++ only)}
2979 @opindex Wreorder
2980 @opindex Wno-reorder
2981 @cindex reordering, warning
2982 @cindex warning for reordering of member initializers
2983 Warn when the order of member initializers given in the code does not
2984 match the order in which they must be executed.  For instance:
2986 @smallexample
2987 struct A @{
2988   int i;
2989   int j;
2990   A(): j (0), i (1) @{ @}
2992 @end smallexample
2994 @noindent
2995 The compiler rearranges the member initializers for @code{i}
2996 and @code{j} to match the declaration order of the members, emitting
2997 a warning to that effect.  This warning is enabled by @option{-Wall}.
2999 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3000 @opindex fext-numeric-literals
3001 @opindex fno-ext-numeric-literals
3002 Accept imaginary, fixed-point, or machine-defined
3003 literal number suffixes as GNU extensions.
3004 When this option is turned off these suffixes are treated
3005 as C++11 user-defined literal numeric suffixes.
3006 This is on by default for all pre-C++11 dialects and all GNU dialects:
3007 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3008 @option{-std=gnu++14}.
3009 This option is off by default
3010 for ISO C++11 onwards (@option{-std=c++11}, ...).
3011 @end table
3013 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3015 @table @gcctabopt
3016 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3017 @opindex Weffc++
3018 @opindex Wno-effc++
3019 Warn about violations of the following style guidelines from Scott Meyers'
3020 @cite{Effective C++} series of books:
3022 @itemize @bullet
3023 @item
3024 Define a copy constructor and an assignment operator for classes
3025 with dynamically-allocated memory.
3027 @item
3028 Prefer initialization to assignment in constructors.
3030 @item
3031 Have @code{operator=} return a reference to @code{*this}.
3033 @item
3034 Don't try to return a reference when you must return an object.
3036 @item
3037 Distinguish between prefix and postfix forms of increment and
3038 decrement operators.
3040 @item
3041 Never overload @code{&&}, @code{||}, or @code{,}.
3043 @end itemize
3045 This option also enables @option{-Wnon-virtual-dtor}, which is also
3046 one of the effective C++ recommendations.  However, the check is
3047 extended to warn about the lack of virtual destructor in accessible
3048 non-polymorphic bases classes too.
3050 When selecting this option, be aware that the standard library
3051 headers do not obey all of these guidelines; use @samp{grep -v}
3052 to filter out those warnings.
3054 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3055 @opindex Wstrict-null-sentinel
3056 @opindex Wno-strict-null-sentinel
3057 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3058 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3059 to @code{__null}.  Although it is a null pointer constant rather than a
3060 null pointer, it is guaranteed to be of the same size as a pointer.
3061 But this use is not portable across different compilers.
3063 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3064 @opindex Wno-non-template-friend
3065 @opindex Wnon-template-friend
3066 Disable warnings when non-template friend functions are declared
3067 within a template.  In very old versions of GCC that predate implementation
3068 of the ISO standard, declarations such as 
3069 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3070 could be interpreted as a particular specialization of a template
3071 function; the warning exists to diagnose compatibility problems, 
3072 and is enabled by default.
3074 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3075 @opindex Wold-style-cast
3076 @opindex Wno-old-style-cast
3077 Warn if an old-style (C-style) cast to a non-void type is used within
3078 a C++ program.  The new-style casts (@code{dynamic_cast},
3079 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3080 less vulnerable to unintended effects and much easier to search for.
3082 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3083 @opindex Woverloaded-virtual
3084 @opindex Wno-overloaded-virtual
3085 @cindex overloaded virtual function, warning
3086 @cindex warning for overloaded virtual function
3087 Warn when a function declaration hides virtual functions from a
3088 base class.  For example, in:
3090 @smallexample
3091 struct A @{
3092   virtual void f();
3095 struct B: public A @{
3096   void f(int);
3098 @end smallexample
3100 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3101 like:
3103 @smallexample
3104 B* b;
3105 b->f();
3106 @end smallexample
3108 @noindent
3109 fails to compile.
3111 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3112 @opindex Wno-pmf-conversions
3113 @opindex Wpmf-conversions
3114 Disable the diagnostic for converting a bound pointer to member function
3115 to a plain pointer.
3117 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3118 @opindex Wsign-promo
3119 @opindex Wno-sign-promo
3120 Warn when overload resolution chooses a promotion from unsigned or
3121 enumerated type to a signed type, over a conversion to an unsigned type of
3122 the same size.  Previous versions of G++ tried to preserve
3123 unsignedness, but the standard mandates the current behavior.
3125 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3126 @opindex Wtemplates
3127 Warn when a primary template declaration is encountered.  Some coding
3128 rules disallow templates, and this may be used to enforce that rule.
3129 The warning is inactive inside a system header file, such as the STL, so
3130 one can still use the STL.  One may also instantiate or specialize
3131 templates.
3133 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3134 @opindex Wmultiple-inheritance
3135 Warn when a class is defined with multiple direct base classes.  Some
3136 coding rules disallow multiple inheritance, and this may be used to
3137 enforce that rule.  The warning is inactive inside a system header file,
3138 such as the STL, so one can still use the STL.  One may also define
3139 classes that indirectly use multiple inheritance.
3141 @item -Wvirtual-inheritance
3142 @opindex Wvirtual-inheritance
3143 Warn when a class is defined with a virtual direct base class.  Some
3144 coding rules disallow multiple inheritance, and this may be used to
3145 enforce that rule.  The warning is inactive inside a system header file,
3146 such as the STL, so one can still use the STL.  One may also define
3147 classes that indirectly use virtual inheritance.
3149 @item -Wnamespaces
3150 @opindex Wnamespaces
3151 Warn when a namespace definition is opened.  Some coding rules disallow
3152 namespaces, and this may be used to enforce that rule.  The warning is
3153 inactive inside a system header file, such as the STL, so one can still
3154 use the STL.  One may also use using directives and qualified names.
3156 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3157 @opindex Wterminate
3158 @opindex Wno-terminate
3159 Disable the warning about a throw-expression that will immediately
3160 result in a call to @code{terminate}.
3161 @end table
3163 @node Objective-C and Objective-C++ Dialect Options
3164 @section Options Controlling Objective-C and Objective-C++ Dialects
3166 @cindex compiler options, Objective-C and Objective-C++
3167 @cindex Objective-C and Objective-C++ options, command-line
3168 @cindex options, Objective-C and Objective-C++
3169 (NOTE: This manual does not describe the Objective-C and Objective-C++
3170 languages themselves.  @xref{Standards,,Language Standards
3171 Supported by GCC}, for references.)
3173 This section describes the command-line options that are only meaningful
3174 for Objective-C and Objective-C++ programs.  You can also use most of
3175 the language-independent GNU compiler options.
3176 For example, you might compile a file @file{some_class.m} like this:
3178 @smallexample
3179 gcc -g -fgnu-runtime -O -c some_class.m
3180 @end smallexample
3182 @noindent
3183 In this example, @option{-fgnu-runtime} is an option meant only for
3184 Objective-C and Objective-C++ programs; you can use the other options with
3185 any language supported by GCC@.
3187 Note that since Objective-C is an extension of the C language, Objective-C
3188 compilations may also use options specific to the C front-end (e.g.,
3189 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3190 C++-specific options (e.g., @option{-Wabi}).
3192 Here is a list of options that are @emph{only} for compiling Objective-C
3193 and Objective-C++ programs:
3195 @table @gcctabopt
3196 @item -fconstant-string-class=@var{class-name}
3197 @opindex fconstant-string-class
3198 Use @var{class-name} as the name of the class to instantiate for each
3199 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3200 class name is @code{NXConstantString} if the GNU runtime is being used, and
3201 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3202 @option{-fconstant-cfstrings} option, if also present, overrides the
3203 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3204 to be laid out as constant CoreFoundation strings.
3206 @item -fgnu-runtime
3207 @opindex fgnu-runtime
3208 Generate object code compatible with the standard GNU Objective-C
3209 runtime.  This is the default for most types of systems.
3211 @item -fnext-runtime
3212 @opindex fnext-runtime
3213 Generate output compatible with the NeXT runtime.  This is the default
3214 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3215 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3216 used.
3218 @item -fno-nil-receivers
3219 @opindex fno-nil-receivers
3220 Assume that all Objective-C message dispatches (@code{[receiver
3221 message:arg]}) in this translation unit ensure that the receiver is
3222 not @code{nil}.  This allows for more efficient entry points in the
3223 runtime to be used.  This option is only available in conjunction with
3224 the NeXT runtime and ABI version 0 or 1.
3226 @item -fobjc-abi-version=@var{n}
3227 @opindex fobjc-abi-version
3228 Use version @var{n} of the Objective-C ABI for the selected runtime.
3229 This option is currently supported only for the NeXT runtime.  In that
3230 case, Version 0 is the traditional (32-bit) ABI without support for
3231 properties and other Objective-C 2.0 additions.  Version 1 is the
3232 traditional (32-bit) ABI with support for properties and other
3233 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3234 nothing is specified, the default is Version 0 on 32-bit target
3235 machines, and Version 2 on 64-bit target machines.
3237 @item -fobjc-call-cxx-cdtors
3238 @opindex fobjc-call-cxx-cdtors
3239 For each Objective-C class, check if any of its instance variables is a
3240 C++ object with a non-trivial default constructor.  If so, synthesize a
3241 special @code{- (id) .cxx_construct} instance method which runs
3242 non-trivial default constructors on any such instance variables, in order,
3243 and then return @code{self}.  Similarly, check if any instance variable
3244 is a C++ object with a non-trivial destructor, and if so, synthesize a
3245 special @code{- (void) .cxx_destruct} method which runs
3246 all such default destructors, in reverse order.
3248 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3249 methods thusly generated only operate on instance variables
3250 declared in the current Objective-C class, and not those inherited
3251 from superclasses.  It is the responsibility of the Objective-C
3252 runtime to invoke all such methods in an object's inheritance
3253 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3254 by the runtime immediately after a new object instance is allocated;
3255 the @code{- (void) .cxx_destruct} methods are invoked immediately
3256 before the runtime deallocates an object instance.
3258 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3259 support for invoking the @code{- (id) .cxx_construct} and
3260 @code{- (void) .cxx_destruct} methods.
3262 @item -fobjc-direct-dispatch
3263 @opindex fobjc-direct-dispatch
3264 Allow fast jumps to the message dispatcher.  On Darwin this is
3265 accomplished via the comm page.
3267 @item -fobjc-exceptions
3268 @opindex fobjc-exceptions
3269 Enable syntactic support for structured exception handling in
3270 Objective-C, similar to what is offered by C++.  This option
3271 is required to use the Objective-C keywords @code{@@try},
3272 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3273 @code{@@synchronized}.  This option is available with both the GNU
3274 runtime and the NeXT runtime (but not available in conjunction with
3275 the NeXT runtime on Mac OS X 10.2 and earlier).
3277 @item -fobjc-gc
3278 @opindex fobjc-gc
3279 Enable garbage collection (GC) in Objective-C and Objective-C++
3280 programs.  This option is only available with the NeXT runtime; the
3281 GNU runtime has a different garbage collection implementation that
3282 does not require special compiler flags.
3284 @item -fobjc-nilcheck
3285 @opindex fobjc-nilcheck
3286 For the NeXT runtime with version 2 of the ABI, check for a nil
3287 receiver in method invocations before doing the actual method call.
3288 This is the default and can be disabled using
3289 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3290 checked for nil in this way no matter what this flag is set to.
3291 Currently this flag does nothing when the GNU runtime, or an older
3292 version of the NeXT runtime ABI, is used.
3294 @item -fobjc-std=objc1
3295 @opindex fobjc-std
3296 Conform to the language syntax of Objective-C 1.0, the language
3297 recognized by GCC 4.0.  This only affects the Objective-C additions to
3298 the C/C++ language; it does not affect conformance to C/C++ standards,
3299 which is controlled by the separate C/C++ dialect option flags.  When
3300 this option is used with the Objective-C or Objective-C++ compiler,
3301 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3302 This is useful if you need to make sure that your Objective-C code can
3303 be compiled with older versions of GCC@.
3305 @item -freplace-objc-classes
3306 @opindex freplace-objc-classes
3307 Emit a special marker instructing @command{ld(1)} not to statically link in
3308 the resulting object file, and allow @command{dyld(1)} to load it in at
3309 run time instead.  This is used in conjunction with the Fix-and-Continue
3310 debugging mode, where the object file in question may be recompiled and
3311 dynamically reloaded in the course of program execution, without the need
3312 to restart the program itself.  Currently, Fix-and-Continue functionality
3313 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3314 and later.
3316 @item -fzero-link
3317 @opindex fzero-link
3318 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3319 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3320 compile time) with static class references that get initialized at load time,
3321 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3322 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3323 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3324 for individual class implementations to be modified during program execution.
3325 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3326 regardless of command-line options.
3328 @item -fno-local-ivars
3329 @opindex fno-local-ivars
3330 @opindex flocal-ivars
3331 By default instance variables in Objective-C can be accessed as if
3332 they were local variables from within the methods of the class they're
3333 declared in.  This can lead to shadowing between instance variables
3334 and other variables declared either locally inside a class method or
3335 globally with the same name.  Specifying the @option{-fno-local-ivars}
3336 flag disables this behavior thus avoiding variable shadowing issues.
3338 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3339 @opindex fivar-visibility
3340 Set the default instance variable visibility to the specified option
3341 so that instance variables declared outside the scope of any access
3342 modifier directives default to the specified visibility.
3344 @item -gen-decls
3345 @opindex gen-decls
3346 Dump interface declarations for all classes seen in the source file to a
3347 file named @file{@var{sourcename}.decl}.
3349 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3350 @opindex Wassign-intercept
3351 @opindex Wno-assign-intercept
3352 Warn whenever an Objective-C assignment is being intercepted by the
3353 garbage collector.
3355 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3356 @opindex Wno-protocol
3357 @opindex Wprotocol
3358 If a class is declared to implement a protocol, a warning is issued for
3359 every method in the protocol that is not implemented by the class.  The
3360 default behavior is to issue a warning for every method not explicitly
3361 implemented in the class, even if a method implementation is inherited
3362 from the superclass.  If you use the @option{-Wno-protocol} option, then
3363 methods inherited from the superclass are considered to be implemented,
3364 and no warning is issued for them.
3366 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3367 @opindex Wselector
3368 @opindex Wno-selector
3369 Warn if multiple methods of different types for the same selector are
3370 found during compilation.  The check is performed on the list of methods
3371 in the final stage of compilation.  Additionally, a check is performed
3372 for each selector appearing in a @code{@@selector(@dots{})}
3373 expression, and a corresponding method for that selector has been found
3374 during compilation.  Because these checks scan the method table only at
3375 the end of compilation, these warnings are not produced if the final
3376 stage of compilation is not reached, for example because an error is
3377 found during compilation, or because the @option{-fsyntax-only} option is
3378 being used.
3380 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3381 @opindex Wstrict-selector-match
3382 @opindex Wno-strict-selector-match
3383 Warn if multiple methods with differing argument and/or return types are
3384 found for a given selector when attempting to send a message using this
3385 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3386 is off (which is the default behavior), the compiler omits such warnings
3387 if any differences found are confined to types that share the same size
3388 and alignment.
3390 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3391 @opindex Wundeclared-selector
3392 @opindex Wno-undeclared-selector
3393 Warn if a @code{@@selector(@dots{})} expression referring to an
3394 undeclared selector is found.  A selector is considered undeclared if no
3395 method with that name has been declared before the
3396 @code{@@selector(@dots{})} expression, either explicitly in an
3397 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3398 an @code{@@implementation} section.  This option always performs its
3399 checks as soon as a @code{@@selector(@dots{})} expression is found,
3400 while @option{-Wselector} only performs its checks in the final stage of
3401 compilation.  This also enforces the coding style convention
3402 that methods and selectors must be declared before being used.
3404 @item -print-objc-runtime-info
3405 @opindex print-objc-runtime-info
3406 Generate C header describing the largest structure that is passed by
3407 value, if any.
3409 @end table
3411 @node Diagnostic Message Formatting Options
3412 @section Options to Control Diagnostic Messages Formatting
3413 @cindex options to control diagnostics formatting
3414 @cindex diagnostic messages
3415 @cindex message formatting
3417 Traditionally, diagnostic messages have been formatted irrespective of
3418 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3419 options described below
3420 to control the formatting algorithm for diagnostic messages, 
3421 e.g.@: how many characters per line, how often source location
3422 information should be reported.  Note that some language front ends may not
3423 honor these options.
3425 @table @gcctabopt
3426 @item -fmessage-length=@var{n}
3427 @opindex fmessage-length
3428 Try to format error messages so that they fit on lines of about
3429 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3430 done; each error message appears on a single line.  This is the
3431 default for all front ends.
3433 @item -fdiagnostics-show-location=once
3434 @opindex fdiagnostics-show-location
3435 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3436 reporter to emit source location information @emph{once}; that is, in
3437 case the message is too long to fit on a single physical line and has to
3438 be wrapped, the source location won't be emitted (as prefix) again,
3439 over and over, in subsequent continuation lines.  This is the default
3440 behavior.
3442 @item -fdiagnostics-show-location=every-line
3443 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3444 messages reporter to emit the same source location information (as
3445 prefix) for physical lines that result from the process of breaking
3446 a message which is too long to fit on a single line.
3448 @item -fdiagnostics-color[=@var{WHEN}]
3449 @itemx -fno-diagnostics-color
3450 @opindex fdiagnostics-color
3451 @cindex highlight, color
3452 @vindex GCC_COLORS @r{environment variable}
3453 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3454 or @samp{auto}.  The default depends on how the compiler has been configured,
3455 it can be any of the above @var{WHEN} options or also @samp{never}
3456 if @env{GCC_COLORS} environment variable isn't present in the environment,
3457 and @samp{auto} otherwise.
3458 @samp{auto} means to use color only when the standard error is a terminal.
3459 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3460 aliases for @option{-fdiagnostics-color=always} and
3461 @option{-fdiagnostics-color=never}, respectively.
3463 The colors are defined by the environment variable @env{GCC_COLORS}.
3464 Its value is a colon-separated list of capabilities and Select Graphic
3465 Rendition (SGR) substrings. SGR commands are interpreted by the
3466 terminal or terminal emulator.  (See the section in the documentation
3467 of your text terminal for permitted values and their meanings as
3468 character attributes.)  These substring values are integers in decimal
3469 representation and can be concatenated with semicolons.
3470 Common values to concatenate include
3471 @samp{1} for bold,
3472 @samp{4} for underline,
3473 @samp{5} for blink,
3474 @samp{7} for inverse,
3475 @samp{39} for default foreground color,
3476 @samp{30} to @samp{37} for foreground colors,
3477 @samp{90} to @samp{97} for 16-color mode foreground colors,
3478 @samp{38;5;0} to @samp{38;5;255}
3479 for 88-color and 256-color modes foreground colors,
3480 @samp{49} for default background color,
3481 @samp{40} to @samp{47} for background colors,
3482 @samp{100} to @samp{107} for 16-color mode background colors,
3483 and @samp{48;5;0} to @samp{48;5;255}
3484 for 88-color and 256-color modes background colors.
3486 The default @env{GCC_COLORS} is
3487 @smallexample
3488 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3489 quote=01:fixit-insert=32:fixit-delete=31:\
3490 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3491 type-diff=01;32
3492 @end smallexample
3493 @noindent
3494 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3495 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3496 @samp{01} is bold, and @samp{31} is red.
3497 Setting @env{GCC_COLORS} to the empty string disables colors.
3498 Supported capabilities are as follows.
3500 @table @code
3501 @item error=
3502 @vindex error GCC_COLORS @r{capability}
3503 SGR substring for error: markers.
3505 @item warning=
3506 @vindex warning GCC_COLORS @r{capability}
3507 SGR substring for warning: markers.
3509 @item note=
3510 @vindex note GCC_COLORS @r{capability}
3511 SGR substring for note: markers.
3513 @item range1=
3514 @vindex range1 GCC_COLORS @r{capability}
3515 SGR substring for first additional range.
3517 @item range2=
3518 @vindex range2 GCC_COLORS @r{capability}
3519 SGR substring for second additional range.
3521 @item locus=
3522 @vindex locus GCC_COLORS @r{capability}
3523 SGR substring for location information, @samp{file:line} or
3524 @samp{file:line:column} etc.
3526 @item quote=
3527 @vindex quote GCC_COLORS @r{capability}
3528 SGR substring for information printed within quotes.
3530 @item fixit-insert=
3531 @vindex fixit-insert GCC_COLORS @r{capability}
3532 SGR substring for fix-it hints suggesting text to
3533 be inserted or replaced.
3535 @item fixit-delete=
3536 @vindex fixit-delete GCC_COLORS @r{capability}
3537 SGR substring for fix-it hints suggesting text to
3538 be deleted.
3540 @item diff-filename=
3541 @vindex diff-filename GCC_COLORS @r{capability}
3542 SGR substring for filename headers within generated patches.
3544 @item diff-hunk=
3545 @vindex diff-hunk GCC_COLORS @r{capability}
3546 SGR substring for the starts of hunks within generated patches.
3548 @item diff-delete=
3549 @vindex diff-delete GCC_COLORS @r{capability}
3550 SGR substring for deleted lines within generated patches.
3552 @item diff-insert=
3553 @vindex diff-insert GCC_COLORS @r{capability}
3554 SGR substring for inserted lines within generated patches.
3556 @item type-diff=
3557 @vindex type-diff GCC_COLORS @r{capability}
3558 SGR substring for highlighting mismatching types within template
3559 arguments in the C++ frontend.
3560 @end table
3562 @item -fno-diagnostics-show-option
3563 @opindex fno-diagnostics-show-option
3564 @opindex fdiagnostics-show-option
3565 By default, each diagnostic emitted includes text indicating the
3566 command-line option that directly controls the diagnostic (if such an
3567 option is known to the diagnostic machinery).  Specifying the
3568 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3570 @item -fno-diagnostics-show-caret
3571 @opindex fno-diagnostics-show-caret
3572 @opindex fdiagnostics-show-caret
3573 By default, each diagnostic emitted includes the original source line
3574 and a caret @samp{^} indicating the column.  This option suppresses this
3575 information.  The source line is truncated to @var{n} characters, if
3576 the @option{-fmessage-length=n} option is given.  When the output is done
3577 to the terminal, the width is limited to the width given by the
3578 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3580 @item -fdiagnostics-parseable-fixits
3581 @opindex fdiagnostics-parseable-fixits
3582 Emit fix-it hints in a machine-parseable format, suitable for consumption
3583 by IDEs.  For each fix-it, a line will be printed after the relevant
3584 diagnostic, starting with the string ``fix-it:''.  For example:
3586 @smallexample
3587 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3588 @end smallexample
3590 The location is expressed as a half-open range, expressed as a count of
3591 bytes, starting at byte 1 for the initial column.  In the above example,
3592 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3593 given string:
3595 @smallexample
3596 00000000011111111112222222222
3597 12345678901234567890123456789
3598   gtk_widget_showall (dlg);
3599   ^^^^^^^^^^^^^^^^^^
3600   gtk_widget_show_all
3601 @end smallexample
3603 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3604 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3605 (e.g. vertical tab as ``\013'').
3607 An empty replacement string indicates that the given range is to be removed.
3608 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3609 be inserted at the given position.
3611 @item -fdiagnostics-generate-patch
3612 @opindex fdiagnostics-generate-patch
3613 Print fix-it hints to stderr in unified diff format, after any diagnostics
3614 are printed.  For example:
3616 @smallexample
3617 --- test.c
3618 +++ test.c
3619 @@ -42,5 +42,5 @@
3621  void show_cb(GtkDialog *dlg)
3622  @{
3623 -  gtk_widget_showall(dlg);
3624 +  gtk_widget_show_all(dlg);
3625  @}
3627 @end smallexample
3629 The diff may or may not be colorized, following the same rules
3630 as for diagnostics (see @option{-fdiagnostics-color}).
3632 @item -fdiagnostics-show-template-tree
3633 @opindex fdiagnostics-show-template-tree
3635 In the C++ frontend, when printing diagnostics showing mismatching
3636 template types, such as:
3638 @smallexample
3639   could not convert 'std::map<int, std::vector<double> >()'
3640     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3641 @end smallexample
3643 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3644 tree-like structure showing the common and differing parts of the types,
3645 such as:
3647 @smallexample
3648   map<
3649     [...],
3650     vector<
3651       [double != float]>>
3652 @end smallexample
3654 The parts that differ are highlighted with color (``double'' and
3655 ``float'' in this case).
3657 @item -fno-elide-type
3658 @opindex fno-elide-type
3659 @opindex felide-type
3660 By default when the C++ frontend prints diagnostics showing mismatching
3661 template types, common parts of the types are printed as ``[...]'' to
3662 simplify the error message.  For example:
3664 @smallexample
3665   could not convert 'std::map<int, std::vector<double> >()'
3666     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3667 @end smallexample
3669 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3670 This flag also affects the output of the
3671 @option{-fdiagnostics-show-template-tree} flag.
3673 @item -fno-show-column
3674 @opindex fno-show-column
3675 Do not print column numbers in diagnostics.  This may be necessary if
3676 diagnostics are being scanned by a program that does not understand the
3677 column numbers, such as @command{dejagnu}.
3679 @end table
3681 @node Warning Options
3682 @section Options to Request or Suppress Warnings
3683 @cindex options to control warnings
3684 @cindex warning messages
3685 @cindex messages, warning
3686 @cindex suppressing warnings
3688 Warnings are diagnostic messages that report constructions that
3689 are not inherently erroneous but that are risky or suggest there
3690 may have been an error.
3692 The following language-independent options do not enable specific
3693 warnings but control the kinds of diagnostics produced by GCC@.
3695 @table @gcctabopt
3696 @cindex syntax checking
3697 @item -fsyntax-only
3698 @opindex fsyntax-only
3699 Check the code for syntax errors, but don't do anything beyond that.
3701 @item -fmax-errors=@var{n}
3702 @opindex fmax-errors
3703 Limits the maximum number of error messages to @var{n}, at which point
3704 GCC bails out rather than attempting to continue processing the source
3705 code.  If @var{n} is 0 (the default), there is no limit on the number
3706 of error messages produced.  If @option{-Wfatal-errors} is also
3707 specified, then @option{-Wfatal-errors} takes precedence over this
3708 option.
3710 @item -w
3711 @opindex w
3712 Inhibit all warning messages.
3714 @item -Werror
3715 @opindex Werror
3716 @opindex Wno-error
3717 Make all warnings into errors.
3719 @item -Werror=
3720 @opindex Werror=
3721 @opindex Wno-error=
3722 Make the specified warning into an error.  The specifier for a warning
3723 is appended; for example @option{-Werror=switch} turns the warnings
3724 controlled by @option{-Wswitch} into errors.  This switch takes a
3725 negative form, to be used to negate @option{-Werror} for specific
3726 warnings; for example @option{-Wno-error=switch} makes
3727 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3728 is in effect.
3730 The warning message for each controllable warning includes the
3731 option that controls the warning.  That option can then be used with
3732 @option{-Werror=} and @option{-Wno-error=} as described above.
3733 (Printing of the option in the warning message can be disabled using the
3734 @option{-fno-diagnostics-show-option} flag.)
3736 Note that specifying @option{-Werror=}@var{foo} automatically implies
3737 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3738 imply anything.
3740 @item -Wfatal-errors
3741 @opindex Wfatal-errors
3742 @opindex Wno-fatal-errors
3743 This option causes the compiler to abort compilation on the first error
3744 occurred rather than trying to keep going and printing further error
3745 messages.
3747 @end table
3749 You can request many specific warnings with options beginning with
3750 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3751 implicit declarations.  Each of these specific warning options also
3752 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3753 example, @option{-Wno-implicit}.  This manual lists only one of the
3754 two forms, whichever is not the default.  For further
3755 language-specific options also refer to @ref{C++ Dialect Options} and
3756 @ref{Objective-C and Objective-C++ Dialect Options}.
3758 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3759 options, such as @option{-Wunused}, which may turn on further options,
3760 such as @option{-Wunused-value}. The combined effect of positive and
3761 negative forms is that more specific options have priority over less
3762 specific ones, independently of their position in the command-line. For
3763 options of the same specificity, the last one takes effect. Options
3764 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3765 as if they appeared at the end of the command-line.
3767 When an unrecognized warning option is requested (e.g.,
3768 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3769 that the option is not recognized.  However, if the @option{-Wno-} form
3770 is used, the behavior is slightly different: no diagnostic is
3771 produced for @option{-Wno-unknown-warning} unless other diagnostics
3772 are being produced.  This allows the use of new @option{-Wno-} options
3773 with old compilers, but if something goes wrong, the compiler
3774 warns that an unrecognized option is present.
3776 @table @gcctabopt
3777 @item -Wpedantic
3778 @itemx -pedantic
3779 @opindex pedantic
3780 @opindex Wpedantic
3781 Issue all the warnings demanded by strict ISO C and ISO C++;
3782 reject all programs that use forbidden extensions, and some other
3783 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3784 version of the ISO C standard specified by any @option{-std} option used.
3786 Valid ISO C and ISO C++ programs should compile properly with or without
3787 this option (though a rare few require @option{-ansi} or a
3788 @option{-std} option specifying the required version of ISO C)@.  However,
3789 without this option, certain GNU extensions and traditional C and C++
3790 features are supported as well.  With this option, they are rejected.
3792 @option{-Wpedantic} does not cause warning messages for use of the
3793 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3794 warnings are also disabled in the expression that follows
3795 @code{__extension__}.  However, only system header files should use
3796 these escape routes; application programs should avoid them.
3797 @xref{Alternate Keywords}.
3799 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3800 C conformance.  They soon find that it does not do quite what they want:
3801 it finds some non-ISO practices, but not all---only those for which
3802 ISO C @emph{requires} a diagnostic, and some others for which
3803 diagnostics have been added.
3805 A feature to report any failure to conform to ISO C might be useful in
3806 some instances, but would require considerable additional work and would
3807 be quite different from @option{-Wpedantic}.  We don't have plans to
3808 support such a feature in the near future.
3810 Where the standard specified with @option{-std} represents a GNU
3811 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3812 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3813 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3814 where they are required by the base standard.  (It does not make sense
3815 for such warnings to be given only for features not in the specified GNU
3816 C dialect, since by definition the GNU dialects of C include all
3817 features the compiler supports with the given option, and there would be
3818 nothing to warn about.)
3820 @item -pedantic-errors
3821 @opindex pedantic-errors
3822 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3823 requires a diagnostic, in some cases where there is undefined behavior
3824 at compile-time and in some other cases that do not prevent compilation
3825 of programs that are valid according to the standard. This is not
3826 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3827 by this option and not enabled by the latter and vice versa.
3829 @item -Wall
3830 @opindex Wall
3831 @opindex Wno-all
3832 This enables all the warnings about constructions that some users
3833 consider questionable, and that are easy to avoid (or modify to
3834 prevent the warning), even in conjunction with macros.  This also
3835 enables some language-specific warnings described in @ref{C++ Dialect
3836 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3838 @option{-Wall} turns on the following warning flags:
3840 @gccoptlist{-Waddress   @gol
3841 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3842 -Wbool-compare  @gol
3843 -Wbool-operation  @gol
3844 -Wc++11-compat  -Wc++14-compat  @gol
3845 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3846 -Wchar-subscripts  @gol
3847 -Wcomment  @gol
3848 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3849 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3850 -Wformat   @gol
3851 -Wint-in-bool-context  @gol
3852 -Wimplicit @r{(C and Objective-C only)} @gol
3853 -Wimplicit-int @r{(C and Objective-C only)} @gol
3854 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3855 -Winit-self @r{(only for C++)} @gol
3856 -Wlogical-not-parentheses @gol
3857 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3858 -Wmaybe-uninitialized @gol
3859 -Wmemset-elt-size @gol
3860 -Wmemset-transposed-args @gol
3861 -Wmisleading-indentation @r{(only for C/C++)} @gol
3862 -Wmissing-braces @r{(only for C/ObjC)} @gol
3863 -Wmultistatement-macros  @gol
3864 -Wnarrowing @r{(only for C++)}  @gol
3865 -Wnonnull  @gol
3866 -Wnonnull-compare  @gol
3867 -Wopenmp-simd @gol
3868 -Wparentheses  @gol
3869 -Wpointer-sign  @gol
3870 -Wreorder   @gol
3871 -Wreturn-type  @gol
3872 -Wsequence-point  @gol
3873 -Wsign-compare @r{(only in C++)}  @gol
3874 -Wsizeof-pointer-div @gol
3875 -Wsizeof-pointer-memaccess @gol
3876 -Wstrict-aliasing  @gol
3877 -Wstrict-overflow=1  @gol
3878 -Wswitch  @gol
3879 -Wtautological-compare  @gol
3880 -Wtrigraphs  @gol
3881 -Wuninitialized  @gol
3882 -Wunknown-pragmas  @gol
3883 -Wunused-function  @gol
3884 -Wunused-label     @gol
3885 -Wunused-value     @gol
3886 -Wunused-variable  @gol
3887 -Wvolatile-register-var @gol
3890 Note that some warning flags are not implied by @option{-Wall}.  Some of
3891 them warn about constructions that users generally do not consider
3892 questionable, but which occasionally you might wish to check for;
3893 others warn about constructions that are necessary or hard to avoid in
3894 some cases, and there is no simple way to modify the code to suppress
3895 the warning. Some of them are enabled by @option{-Wextra} but many of
3896 them must be enabled individually.
3898 @item -Wextra
3899 @opindex W
3900 @opindex Wextra
3901 @opindex Wno-extra
3902 This enables some extra warning flags that are not enabled by
3903 @option{-Wall}. (This option used to be called @option{-W}.  The older
3904 name is still supported, but the newer name is more descriptive.)
3906 @gccoptlist{-Wclobbered  @gol
3907 -Wempty-body  @gol
3908 -Wignored-qualifiers @gol
3909 -Wimplicit-fallthrough=3 @gol
3910 -Wmissing-field-initializers  @gol
3911 -Wmissing-parameter-type @r{(C only)}  @gol
3912 -Wold-style-declaration @r{(C only)}  @gol
3913 -Woverride-init  @gol
3914 -Wsign-compare @r{(C only)} @gol
3915 -Wtype-limits  @gol
3916 -Wuninitialized  @gol
3917 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3918 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3919 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3922 The option @option{-Wextra} also prints warning messages for the
3923 following cases:
3925 @itemize @bullet
3927 @item
3928 A pointer is compared against integer zero with @code{<}, @code{<=},
3929 @code{>}, or @code{>=}.
3931 @item
3932 (C++ only) An enumerator and a non-enumerator both appear in a
3933 conditional expression.
3935 @item
3936 (C++ only) Ambiguous virtual bases.
3938 @item
3939 (C++ only) Subscripting an array that has been declared @code{register}.
3941 @item
3942 (C++ only) Taking the address of a variable that has been declared
3943 @code{register}.
3945 @item
3946 (C++ only) A base class is not initialized in the copy constructor
3947 of a derived class.
3949 @end itemize
3951 @item -Wchar-subscripts
3952 @opindex Wchar-subscripts
3953 @opindex Wno-char-subscripts
3954 Warn if an array subscript has type @code{char}.  This is a common cause
3955 of error, as programmers often forget that this type is signed on some
3956 machines.
3957 This warning is enabled by @option{-Wall}.
3959 @item -Wchkp
3960 @opindex Wchkp
3961 Warn about an invalid memory access that is found by Pointer Bounds Checker
3962 (@option{-fcheck-pointer-bounds}).
3964 @item -Wno-coverage-mismatch
3965 @opindex Wno-coverage-mismatch
3966 Warn if feedback profiles do not match when using the
3967 @option{-fprofile-use} option.
3968 If a source file is changed between compiling with @option{-fprofile-gen} and
3969 with @option{-fprofile-use}, the files with the profile feedback can fail
3970 to match the source file and GCC cannot use the profile feedback
3971 information.  By default, this warning is enabled and is treated as an
3972 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3973 warning or @option{-Wno-error=coverage-mismatch} can be used to
3974 disable the error.  Disabling the error for this warning can result in
3975 poorly optimized code and is useful only in the
3976 case of very minor changes such as bug fixes to an existing code-base.
3977 Completely disabling the warning is not recommended.
3979 @item -Wno-cpp
3980 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3982 Suppress warning messages emitted by @code{#warning} directives.
3984 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3985 @opindex Wdouble-promotion
3986 @opindex Wno-double-promotion
3987 Give a warning when a value of type @code{float} is implicitly
3988 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3989 floating-point unit implement @code{float} in hardware, but emulate
3990 @code{double} in software.  On such a machine, doing computations
3991 using @code{double} values is much more expensive because of the
3992 overhead required for software emulation.
3994 It is easy to accidentally do computations with @code{double} because
3995 floating-point literals are implicitly of type @code{double}.  For
3996 example, in:
3997 @smallexample
3998 @group
3999 float area(float radius)
4001    return 3.14159 * radius * radius;
4003 @end group
4004 @end smallexample
4005 the compiler performs the entire computation with @code{double}
4006 because the floating-point literal is a @code{double}.
4008 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4009 @opindex Wduplicate-decl-specifier
4010 @opindex Wno-duplicate-decl-specifier
4011 Warn if a declaration has duplicate @code{const}, @code{volatile},
4012 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4013 @option{-Wall}.
4015 @item -Wformat
4016 @itemx -Wformat=@var{n}
4017 @opindex Wformat
4018 @opindex Wno-format
4019 @opindex ffreestanding
4020 @opindex fno-builtin
4021 @opindex Wformat=
4022 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4023 the arguments supplied have types appropriate to the format string
4024 specified, and that the conversions specified in the format string make
4025 sense.  This includes standard functions, and others specified by format
4026 attributes (@pxref{Function Attributes}), in the @code{printf},
4027 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4028 not in the C standard) families (or other target-specific families).
4029 Which functions are checked without format attributes having been
4030 specified depends on the standard version selected, and such checks of
4031 functions without the attribute specified are disabled by
4032 @option{-ffreestanding} or @option{-fno-builtin}.
4034 The formats are checked against the format features supported by GNU
4035 libc version 2.2.  These include all ISO C90 and C99 features, as well
4036 as features from the Single Unix Specification and some BSD and GNU
4037 extensions.  Other library implementations may not support all these
4038 features; GCC does not support warning about features that go beyond a
4039 particular library's limitations.  However, if @option{-Wpedantic} is used
4040 with @option{-Wformat}, warnings are given about format features not
4041 in the selected standard version (but not for @code{strfmon} formats,
4042 since those are not in any version of the C standard).  @xref{C Dialect
4043 Options,,Options Controlling C Dialect}.
4045 @table @gcctabopt
4046 @item -Wformat=1
4047 @itemx -Wformat
4048 @opindex Wformat
4049 @opindex Wformat=1
4050 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4051 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4052 @option{-Wformat} also checks for null format arguments for several
4053 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4054 aspects of this level of format checking can be disabled by the
4055 options: @option{-Wno-format-contains-nul},
4056 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4057 @option{-Wformat} is enabled by @option{-Wall}.
4059 @item -Wno-format-contains-nul
4060 @opindex Wno-format-contains-nul
4061 @opindex Wformat-contains-nul
4062 If @option{-Wformat} is specified, do not warn about format strings that
4063 contain NUL bytes.
4065 @item -Wno-format-extra-args
4066 @opindex Wno-format-extra-args
4067 @opindex Wformat-extra-args
4068 If @option{-Wformat} is specified, do not warn about excess arguments to a
4069 @code{printf} or @code{scanf} format function.  The C standard specifies
4070 that such arguments are ignored.
4072 Where the unused arguments lie between used arguments that are
4073 specified with @samp{$} operand number specifications, normally
4074 warnings are still given, since the implementation could not know what
4075 type to pass to @code{va_arg} to skip the unused arguments.  However,
4076 in the case of @code{scanf} formats, this option suppresses the
4077 warning if the unused arguments are all pointers, since the Single
4078 Unix Specification says that such unused arguments are allowed.
4080 @item -Wformat-overflow
4081 @itemx -Wformat-overflow=@var{level}
4082 @opindex Wformat-overflow
4083 @opindex Wno-format-overflow
4084 Warn about calls to formatted input/output functions such as @code{sprintf}
4085 and @code{vsprintf} that might overflow the destination buffer.  When the
4086 exact number of bytes written by a format directive cannot be determined
4087 at compile-time it is estimated based on heuristics that depend on the
4088 @var{level} argument and on optimization.  While enabling optimization
4089 will in most cases improve the accuracy of the warning, it may also
4090 result in false positives.
4092 @table @gcctabopt
4093 @item -Wformat-overflow
4094 @item -Wformat-overflow=1
4095 @opindex Wformat-overflow
4096 @opindex Wno-format-overflow
4097 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4098 employs a conservative approach that warns only about calls that most
4099 likely overflow the buffer.  At this level, numeric arguments to format
4100 directives with unknown values are assumed to have the value of one, and
4101 strings of unknown length to be empty.  Numeric arguments that are known
4102 to be bounded to a subrange of their type, or string arguments whose output
4103 is bounded either by their directive's precision or by a finite set of
4104 string literals, are assumed to take on the value within the range that
4105 results in the most bytes on output.  For example, the call to @code{sprintf}
4106 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4107 the terminating NUL character (@code{'\0'}) appended by the function
4108 to the destination buffer will be written past its end.  Increasing
4109 the size of the buffer by a single byte is sufficient to avoid the
4110 warning, though it may not be sufficient to avoid the overflow.
4112 @smallexample
4113 void f (int a, int b)
4115   char buf [12];
4116   sprintf (buf, "a = %i, b = %i\n", a, b);
4118 @end smallexample
4120 @item -Wformat-overflow=2
4121 Level @var{2} warns also about calls that might overflow the destination
4122 buffer given an argument of sufficient length or magnitude.  At level
4123 @var{2}, unknown numeric arguments are assumed to have the minimum
4124 representable value for signed types with a precision greater than 1, and
4125 the maximum representable value otherwise.  Unknown string arguments whose
4126 length cannot be assumed to be bounded either by the directive's precision,
4127 or by a finite set of string literals they may evaluate to, or the character
4128 array they may point to, are assumed to be 1 character long.
4130 At level @var{2}, the call in the example above is again diagnosed, but
4131 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4132 @code{%i} directive will write some of its digits beyond the end of
4133 the destination buffer.  To make the call safe regardless of the values
4134 of the two variables, the size of the destination buffer must be increased
4135 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4136 an informational note following the warning.
4138 An alternative to increasing the size of the destination buffer is to
4139 constrain the range of formatted values.  The maximum length of string
4140 arguments can be bounded by specifying the precision in the format
4141 directive.  When numeric arguments of format directives can be assumed
4142 to be bounded by less than the precision of their type, choosing
4143 an appropriate length modifier to the format specifier will reduce
4144 the required buffer size.  For example, if @var{a} and @var{b} in the
4145 example above can be assumed to be within the precision of
4146 the @code{short int} type then using either the @code{%hi} format
4147 directive or casting the argument to @code{short} reduces the maximum
4148 required size of the buffer to 24 bytes.
4150 @smallexample
4151 void f (int a, int b)
4153   char buf [23];
4154   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4156 @end smallexample
4157 @end table
4159 @item -Wno-format-zero-length
4160 @opindex Wno-format-zero-length
4161 @opindex Wformat-zero-length
4162 If @option{-Wformat} is specified, do not warn about zero-length formats.
4163 The C standard specifies that zero-length formats are allowed.
4166 @item -Wformat=2
4167 @opindex Wformat=2
4168 Enable @option{-Wformat} plus additional format checks.  Currently
4169 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4170 -Wformat-y2k}.
4172 @item -Wformat-nonliteral
4173 @opindex Wformat-nonliteral
4174 @opindex Wno-format-nonliteral
4175 If @option{-Wformat} is specified, also warn if the format string is not a
4176 string literal and so cannot be checked, unless the format function
4177 takes its format arguments as a @code{va_list}.
4179 @item -Wformat-security
4180 @opindex Wformat-security
4181 @opindex Wno-format-security
4182 If @option{-Wformat} is specified, also warn about uses of format
4183 functions that represent possible security problems.  At present, this
4184 warns about calls to @code{printf} and @code{scanf} functions where the
4185 format string is not a string literal and there are no format arguments,
4186 as in @code{printf (foo);}.  This may be a security hole if the format
4187 string came from untrusted input and contains @samp{%n}.  (This is
4188 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4189 in future warnings may be added to @option{-Wformat-security} that are not
4190 included in @option{-Wformat-nonliteral}.)
4192 @item -Wformat-signedness
4193 @opindex Wformat-signedness
4194 @opindex Wno-format-signedness
4195 If @option{-Wformat} is specified, also warn if the format string
4196 requires an unsigned argument and the argument is signed and vice versa.
4198 @item -Wformat-truncation
4199 @itemx -Wformat-truncation=@var{level}
4200 @opindex Wformat-truncation
4201 @opindex Wno-format-truncation
4202 Warn about calls to formatted input/output functions such as @code{snprintf}
4203 and @code{vsnprintf} that might result in output truncation.  When the exact
4204 number of bytes written by a format directive cannot be determined at
4205 compile-time it is estimated based on heuristics that depend on
4206 the @var{level} argument and on optimization.  While enabling optimization
4207 will in most cases improve the accuracy of the warning, it may also result
4208 in false positives.  Except as noted otherwise, the option uses the same
4209 logic @option{-Wformat-overflow}.
4211 @table @gcctabopt
4212 @item -Wformat-truncation
4213 @item -Wformat-truncation=1
4214 @opindex Wformat-truncation
4215 @opindex Wno-format-overflow
4216 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4217 employs a conservative approach that warns only about calls to bounded
4218 functions whose return value is unused and that will most likely result
4219 in output truncation.
4221 @item -Wformat-truncation=2
4222 Level @var{2} warns also about calls to bounded functions whose return
4223 value is used and that might result in truncation given an argument of
4224 sufficient length or magnitude.
4225 @end table
4227 @item -Wformat-y2k
4228 @opindex Wformat-y2k
4229 @opindex Wno-format-y2k
4230 If @option{-Wformat} is specified, also warn about @code{strftime}
4231 formats that may yield only a two-digit year.
4232 @end table
4234 @item -Wnonnull
4235 @opindex Wnonnull
4236 @opindex Wno-nonnull
4237 Warn about passing a null pointer for arguments marked as
4238 requiring a non-null value by the @code{nonnull} function attribute.
4240 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4241 can be disabled with the @option{-Wno-nonnull} option.
4243 @item -Wnonnull-compare
4244 @opindex Wnonnull-compare
4245 @opindex Wno-nonnull-compare
4246 Warn when comparing an argument marked with the @code{nonnull}
4247 function attribute against null inside the function.
4249 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4250 can be disabled with the @option{-Wno-nonnull-compare} option.
4252 @item -Wnull-dereference
4253 @opindex Wnull-dereference
4254 @opindex Wno-null-dereference
4255 Warn if the compiler detects paths that trigger erroneous or
4256 undefined behavior due to dereferencing a null pointer.  This option
4257 is only active when @option{-fdelete-null-pointer-checks} is active,
4258 which is enabled by optimizations in most targets.  The precision of
4259 the warnings depends on the optimization options used.
4261 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4262 @opindex Winit-self
4263 @opindex Wno-init-self
4264 Warn about uninitialized variables that are initialized with themselves.
4265 Note this option can only be used with the @option{-Wuninitialized} option.
4267 For example, GCC warns about @code{i} being uninitialized in the
4268 following snippet only when @option{-Winit-self} has been specified:
4269 @smallexample
4270 @group
4271 int f()
4273   int i = i;
4274   return i;
4276 @end group
4277 @end smallexample
4279 This warning is enabled by @option{-Wall} in C++.
4281 @item -Wimplicit-int @r{(C and Objective-C only)}
4282 @opindex Wimplicit-int
4283 @opindex Wno-implicit-int
4284 Warn when a declaration does not specify a type.
4285 This warning is enabled by @option{-Wall}.
4287 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4288 @opindex Wimplicit-function-declaration
4289 @opindex Wno-implicit-function-declaration
4290 Give a warning whenever a function is used before being declared. In
4291 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4292 enabled by default and it is made into an error by
4293 @option{-pedantic-errors}. This warning is also enabled by
4294 @option{-Wall}.
4296 @item -Wimplicit @r{(C and Objective-C only)}
4297 @opindex Wimplicit
4298 @opindex Wno-implicit
4299 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4300 This warning is enabled by @option{-Wall}.
4302 @item -Wimplicit-fallthrough
4303 @opindex Wimplicit-fallthrough
4304 @opindex Wno-implicit-fallthrough
4305 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4306 and @option{-Wno-implicit-fallthrough} is the same as
4307 @option{-Wimplicit-fallthrough=0}.
4309 @item -Wimplicit-fallthrough=@var{n}
4310 @opindex Wimplicit-fallthrough=
4311 Warn when a switch case falls through.  For example:
4313 @smallexample
4314 @group
4315 switch (cond)
4316   @{
4317   case 1:
4318     a = 1;
4319     break;
4320   case 2:
4321     a = 2;
4322   case 3:
4323     a = 3;
4324     break;
4325   @}
4326 @end group
4327 @end smallexample
4329 This warning does not warn when the last statement of a case cannot
4330 fall through, e.g. when there is a return statement or a call to function
4331 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4332 also takes into account control flow statements, such as ifs, and only
4333 warns when appropriate.  E.g.@:
4335 @smallexample
4336 @group
4337 switch (cond)
4338   @{
4339   case 1:
4340     if (i > 3) @{
4341       bar (5);
4342       break;
4343     @} else if (i < 1) @{
4344       bar (0);
4345     @} else
4346       return;
4347   default:
4348     @dots{}
4349   @}
4350 @end group
4351 @end smallexample
4353 Since there are occasions where a switch case fall through is desirable,
4354 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4355 to be used along with a null statement to suppress this warning that
4356 would normally occur:
4358 @smallexample
4359 @group
4360 switch (cond)
4361   @{
4362   case 1:
4363     bar (0);
4364     __attribute__ ((fallthrough));
4365   default:
4366     @dots{}
4367   @}
4368 @end group
4369 @end smallexample
4371 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4372 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4373 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4374 Instead of these attributes, it is also possible to add a fallthrough comment
4375 to silence the warning.  The whole body of the C or C++ style comment should
4376 match the given regular expressions listed below.  The option argument @var{n}
4377 specifies what kind of comments are accepted:
4379 @itemize @bullet
4381 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4383 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4384 expression, any comment is used as fallthrough comment.
4386 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4387 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4389 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4390 following regular expressions:
4392 @itemize @bullet
4394 @item @code{-fallthrough}
4396 @item @code{@@fallthrough@@}
4398 @item @code{lint -fallthrough[ \t]*}
4400 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4402 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4404 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4406 @end itemize
4408 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4409 following regular expressions:
4411 @itemize @bullet
4413 @item @code{-fallthrough}
4415 @item @code{@@fallthrough@@}
4417 @item @code{lint -fallthrough[ \t]*}
4419 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4421 @end itemize
4423 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4424 fallthrough comments, only attributes disable the warning.
4426 @end itemize
4428 The comment needs to be followed after optional whitespace and other comments
4429 by @code{case} or @code{default} keywords or by a user label that precedes some
4430 @code{case} or @code{default} label.
4432 @smallexample
4433 @group
4434 switch (cond)
4435   @{
4436   case 1:
4437     bar (0);
4438     /* FALLTHRU */
4439   default:
4440     @dots{}
4441   @}
4442 @end group
4443 @end smallexample
4445 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4447 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4448 @opindex Wif-not-aligned
4449 @opindex Wno-if-not-aligned
4450 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4451 should be issued.  This is is enabled by default.
4452 Use @option{-Wno-if-not-aligned} to disable it.
4454 @item -Wignored-qualifiers @r{(C and C++ only)}
4455 @opindex Wignored-qualifiers
4456 @opindex Wno-ignored-qualifiers
4457 Warn if the return type of a function has a type qualifier
4458 such as @code{const}.  For ISO C such a type qualifier has no effect,
4459 since the value returned by a function is not an lvalue.
4460 For C++, the warning is only emitted for scalar types or @code{void}.
4461 ISO C prohibits qualified @code{void} return types on function
4462 definitions, so such return types always receive a warning
4463 even without this option.
4465 This warning is also enabled by @option{-Wextra}.
4467 @item -Wignored-attributes @r{(C and C++ only)}
4468 @opindex Wignored-attributes
4469 @opindex Wno-ignored-attributes
4470 Warn when an attribute is ignored.  This is different from the
4471 @option{-Wattributes} option in that it warns whenever the compiler decides
4472 to drop an attribute, not that the attribute is either unknown, used in a
4473 wrong place, etc.  This warning is enabled by default.
4475 @item -Wmain
4476 @opindex Wmain
4477 @opindex Wno-main
4478 Warn if the type of @code{main} is suspicious.  @code{main} should be
4479 a function with external linkage, returning int, taking either zero
4480 arguments, two, or three arguments of appropriate types.  This warning
4481 is enabled by default in C++ and is enabled by either @option{-Wall}
4482 or @option{-Wpedantic}.
4484 @item -Wmisleading-indentation @r{(C and C++ only)}
4485 @opindex Wmisleading-indentation
4486 @opindex Wno-misleading-indentation
4487 Warn when the indentation of the code does not reflect the block structure.
4488 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4489 @code{for} clauses with a guarded statement that does not use braces,
4490 followed by an unguarded statement with the same indentation.
4492 In the following example, the call to ``bar'' is misleadingly indented as
4493 if it were guarded by the ``if'' conditional.
4495 @smallexample
4496   if (some_condition ())
4497     foo ();
4498     bar ();  /* Gotcha: this is not guarded by the "if".  */
4499 @end smallexample
4501 In the case of mixed tabs and spaces, the warning uses the
4502 @option{-ftabstop=} option to determine if the statements line up
4503 (defaulting to 8).
4505 The warning is not issued for code involving multiline preprocessor logic
4506 such as the following example.
4508 @smallexample
4509   if (flagA)
4510     foo (0);
4511 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4512   if (flagB)
4513 #endif
4514     foo (1);
4515 @end smallexample
4517 The warning is not issued after a @code{#line} directive, since this
4518 typically indicates autogenerated code, and no assumptions can be made
4519 about the layout of the file that the directive references.
4521 This warning is enabled by @option{-Wall} in C and C++.
4523 @item -Wmissing-braces
4524 @opindex Wmissing-braces
4525 @opindex Wno-missing-braces
4526 Warn if an aggregate or union initializer is not fully bracketed.  In
4527 the following example, the initializer for @code{a} is not fully
4528 bracketed, but that for @code{b} is fully bracketed.  This warning is
4529 enabled by @option{-Wall} in C.
4531 @smallexample
4532 int a[2][2] = @{ 0, 1, 2, 3 @};
4533 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4534 @end smallexample
4536 This warning is enabled by @option{-Wall}.
4538 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4539 @opindex Wmissing-include-dirs
4540 @opindex Wno-missing-include-dirs
4541 Warn if a user-supplied include directory does not exist.
4543 @item -Wmultistatement-macros
4544 @opindex Wmultistatement-macros
4545 @opindex Wno-multistatement-macros
4546 Warn about unsafe multiple statement macros that appear to be guarded
4547 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4548 @code{while}, in which only the first statement is actually guarded after
4549 the macro is expanded.
4551 For example:
4553 @smallexample
4554 #define DOIT x++; y++
4555 if (c)
4556   DOIT;
4557 @end smallexample
4559 will increment @code{y} unconditionally, not just when @code{c} holds.
4560 The can usually be fixed by wrapping the macro in a do-while loop:
4561 @smallexample
4562 #define DOIT do @{ x++; y++; @} while (0)
4563 if (c)
4564   DOIT;
4565 @end smallexample
4567 This warning is enabled by @option{-Wall} in C and C++.
4569 @item -Wparentheses
4570 @opindex Wparentheses
4571 @opindex Wno-parentheses
4572 Warn if parentheses are omitted in certain contexts, such
4573 as when there is an assignment in a context where a truth value
4574 is expected, or when operators are nested whose precedence people
4575 often get confused about.
4577 Also warn if a comparison like @code{x<=y<=z} appears; this is
4578 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4579 interpretation from that of ordinary mathematical notation.
4581 Also warn for dangerous uses of the GNU extension to
4582 @code{?:} with omitted middle operand. When the condition
4583 in the @code{?}: operator is a boolean expression, the omitted value is
4584 always 1.  Often programmers expect it to be a value computed
4585 inside the conditional expression instead.
4587 For C++ this also warns for some cases of unnecessary parentheses in
4588 declarations, which can indicate an attempt at a function call instead
4589 of a declaration:
4590 @smallexample
4592   // Declares a local variable called mymutex.
4593   std::unique_lock<std::mutex> (mymutex);
4594   // User meant std::unique_lock<std::mutex> lock (mymutex);
4596 @end smallexample
4598 This warning is enabled by @option{-Wall}.
4600 @item -Wsequence-point
4601 @opindex Wsequence-point
4602 @opindex Wno-sequence-point
4603 Warn about code that may have undefined semantics because of violations
4604 of sequence point rules in the C and C++ standards.
4606 The C and C++ standards define the order in which expressions in a C/C++
4607 program are evaluated in terms of @dfn{sequence points}, which represent
4608 a partial ordering between the execution of parts of the program: those
4609 executed before the sequence point, and those executed after it.  These
4610 occur after the evaluation of a full expression (one which is not part
4611 of a larger expression), after the evaluation of the first operand of a
4612 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4613 function is called (but after the evaluation of its arguments and the
4614 expression denoting the called function), and in certain other places.
4615 Other than as expressed by the sequence point rules, the order of
4616 evaluation of subexpressions of an expression is not specified.  All
4617 these rules describe only a partial order rather than a total order,
4618 since, for example, if two functions are called within one expression
4619 with no sequence point between them, the order in which the functions
4620 are called is not specified.  However, the standards committee have
4621 ruled that function calls do not overlap.
4623 It is not specified when between sequence points modifications to the
4624 values of objects take effect.  Programs whose behavior depends on this
4625 have undefined behavior; the C and C++ standards specify that ``Between
4626 the previous and next sequence point an object shall have its stored
4627 value modified at most once by the evaluation of an expression.
4628 Furthermore, the prior value shall be read only to determine the value
4629 to be stored.''.  If a program breaks these rules, the results on any
4630 particular implementation are entirely unpredictable.
4632 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4633 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4634 diagnosed by this option, and it may give an occasional false positive
4635 result, but in general it has been found fairly effective at detecting
4636 this sort of problem in programs.
4638 The C++17 standard will define the order of evaluation of operands in
4639 more cases: in particular it requires that the right-hand side of an
4640 assignment be evaluated before the left-hand side, so the above
4641 examples are no longer undefined.  But this warning will still warn
4642 about them, to help people avoid writing code that is undefined in C
4643 and earlier revisions of C++.
4645 The standard is worded confusingly, therefore there is some debate
4646 over the precise meaning of the sequence point rules in subtle cases.
4647 Links to discussions of the problem, including proposed formal
4648 definitions, may be found on the GCC readings page, at
4649 @uref{http://gcc.gnu.org/@/readings.html}.
4651 This warning is enabled by @option{-Wall} for C and C++.
4653 @item -Wno-return-local-addr
4654 @opindex Wno-return-local-addr
4655 @opindex Wreturn-local-addr
4656 Do not warn about returning a pointer (or in C++, a reference) to a
4657 variable that goes out of scope after the function returns.
4659 @item -Wreturn-type
4660 @opindex Wreturn-type
4661 @opindex Wno-return-type
4662 Warn whenever a function is defined with a return type that defaults
4663 to @code{int}.  Also warn about any @code{return} statement with no
4664 return value in a function whose return type is not @code{void}
4665 (falling off the end of the function body is considered returning
4666 without a value).
4668 For C only, warn about a @code{return} statement with an expression in a
4669 function whose return type is @code{void}, unless the expression type is
4670 also @code{void}.  As a GNU extension, the latter case is accepted
4671 without a warning unless @option{-Wpedantic} is used.
4673 For C++, a function without return type always produces a diagnostic
4674 message, even when @option{-Wno-return-type} is specified.  The only
4675 exceptions are @code{main} and functions defined in system headers.
4677 This warning is enabled by @option{-Wall}.
4679 @item -Wshift-count-negative
4680 @opindex Wshift-count-negative
4681 @opindex Wno-shift-count-negative
4682 Warn if shift count is negative. This warning is enabled by default.
4684 @item -Wshift-count-overflow
4685 @opindex Wshift-count-overflow
4686 @opindex Wno-shift-count-overflow
4687 Warn if shift count >= width of type. This warning is enabled by default.
4689 @item -Wshift-negative-value
4690 @opindex Wshift-negative-value
4691 @opindex Wno-shift-negative-value
4692 Warn if left shifting a negative value.  This warning is enabled by
4693 @option{-Wextra} in C99 and C++11 modes (and newer).
4695 @item -Wshift-overflow
4696 @itemx -Wshift-overflow=@var{n}
4697 @opindex Wshift-overflow
4698 @opindex Wno-shift-overflow
4699 Warn about left shift overflows.  This warning is enabled by
4700 default in C99 and C++11 modes (and newer).
4702 @table @gcctabopt
4703 @item -Wshift-overflow=1
4704 This is the warning level of @option{-Wshift-overflow} and is enabled
4705 by default in C99 and C++11 modes (and newer).  This warning level does
4706 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4707 an overflow is still rejected in contexts where an integer constant expression
4708 is required.)
4710 @item -Wshift-overflow=2
4711 This warning level also warns about left-shifting 1 into the sign bit,
4712 unless C++14 mode is active.
4713 @end table
4715 @item -Wswitch
4716 @opindex Wswitch
4717 @opindex Wno-switch
4718 Warn whenever a @code{switch} statement has an index of enumerated type
4719 and lacks a @code{case} for one or more of the named codes of that
4720 enumeration.  (The presence of a @code{default} label prevents this
4721 warning.)  @code{case} labels outside the enumeration range also
4722 provoke warnings when this option is used (even if there is a
4723 @code{default} label).
4724 This warning is enabled by @option{-Wall}.
4726 @item -Wswitch-default
4727 @opindex Wswitch-default
4728 @opindex Wno-switch-default
4729 Warn whenever a @code{switch} statement does not have a @code{default}
4730 case.
4732 @item -Wswitch-enum
4733 @opindex Wswitch-enum
4734 @opindex Wno-switch-enum
4735 Warn whenever a @code{switch} statement has an index of enumerated type
4736 and lacks a @code{case} for one or more of the named codes of that
4737 enumeration.  @code{case} labels outside the enumeration range also
4738 provoke warnings when this option is used.  The only difference
4739 between @option{-Wswitch} and this option is that this option gives a
4740 warning about an omitted enumeration code even if there is a
4741 @code{default} label.
4743 @item -Wswitch-bool
4744 @opindex Wswitch-bool
4745 @opindex Wno-switch-bool
4746 Warn whenever a @code{switch} statement has an index of boolean type
4747 and the case values are outside the range of a boolean type.
4748 It is possible to suppress this warning by casting the controlling
4749 expression to a type other than @code{bool}.  For example:
4750 @smallexample
4751 @group
4752 switch ((int) (a == 4))
4753   @{
4754   @dots{}
4755   @}
4756 @end group
4757 @end smallexample
4758 This warning is enabled by default for C and C++ programs.
4760 @item -Wswitch-unreachable
4761 @opindex Wswitch-unreachable
4762 @opindex Wno-switch-unreachable
4763 Warn whenever a @code{switch} statement contains statements between the
4764 controlling expression and the first case label, which will never be
4765 executed.  For example:
4766 @smallexample
4767 @group
4768 switch (cond)
4769   @{
4770    i = 15;
4771   @dots{}
4772    case 5:
4773   @dots{}
4774   @}
4775 @end group
4776 @end smallexample
4777 @option{-Wswitch-unreachable} does not warn if the statement between the
4778 controlling expression and the first case label is just a declaration:
4779 @smallexample
4780 @group
4781 switch (cond)
4782   @{
4783    int i;
4784   @dots{}
4785    case 5:
4786    i = 5;
4787   @dots{}
4788   @}
4789 @end group
4790 @end smallexample
4791 This warning is enabled by default for C and C++ programs.
4793 @item -Wsync-nand @r{(C and C++ only)}
4794 @opindex Wsync-nand
4795 @opindex Wno-sync-nand
4796 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4797 built-in functions are used.  These functions changed semantics in GCC 4.4.
4799 @item -Wunused-but-set-parameter
4800 @opindex Wunused-but-set-parameter
4801 @opindex Wno-unused-but-set-parameter
4802 Warn whenever a function parameter is assigned to, but otherwise unused
4803 (aside from its declaration).
4805 To suppress this warning use the @code{unused} attribute
4806 (@pxref{Variable Attributes}).
4808 This warning is also enabled by @option{-Wunused} together with
4809 @option{-Wextra}.
4811 @item -Wunused-but-set-variable
4812 @opindex Wunused-but-set-variable
4813 @opindex Wno-unused-but-set-variable
4814 Warn whenever a local variable is assigned to, but otherwise unused
4815 (aside from its declaration).
4816 This warning is enabled by @option{-Wall}.
4818 To suppress this warning use the @code{unused} attribute
4819 (@pxref{Variable Attributes}).
4821 This warning is also enabled by @option{-Wunused}, which is enabled
4822 by @option{-Wall}.
4824 @item -Wunused-function
4825 @opindex Wunused-function
4826 @opindex Wno-unused-function
4827 Warn whenever a static function is declared but not defined or a
4828 non-inline static function is unused.
4829 This warning is enabled by @option{-Wall}.
4831 @item -Wunused-label
4832 @opindex Wunused-label
4833 @opindex Wno-unused-label
4834 Warn whenever a label is declared but not used.
4835 This warning is enabled by @option{-Wall}.
4837 To suppress this warning use the @code{unused} attribute
4838 (@pxref{Variable Attributes}).
4840 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4841 @opindex Wunused-local-typedefs
4842 Warn when a typedef locally defined in a function is not used.
4843 This warning is enabled by @option{-Wall}.
4845 @item -Wunused-parameter
4846 @opindex Wunused-parameter
4847 @opindex Wno-unused-parameter
4848 Warn whenever a function parameter is unused aside from its declaration.
4850 To suppress this warning use the @code{unused} attribute
4851 (@pxref{Variable Attributes}).
4853 @item -Wno-unused-result
4854 @opindex Wunused-result
4855 @opindex Wno-unused-result
4856 Do not warn if a caller of a function marked with attribute
4857 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4858 its return value. The default is @option{-Wunused-result}.
4860 @item -Wunused-variable
4861 @opindex Wunused-variable
4862 @opindex Wno-unused-variable
4863 Warn whenever a local or static variable is unused aside from its
4864 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4865 but not for C++. This warning is enabled by @option{-Wall}.
4867 To suppress this warning use the @code{unused} attribute
4868 (@pxref{Variable Attributes}).
4870 @item -Wunused-const-variable
4871 @itemx -Wunused-const-variable=@var{n}
4872 @opindex Wunused-const-variable
4873 @opindex Wno-unused-const-variable
4874 Warn whenever a constant static variable is unused aside from its declaration.
4875 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4876 for C, but not for C++. In C this declares variable storage, but in C++ this
4877 is not an error since const variables take the place of @code{#define}s.
4879 To suppress this warning use the @code{unused} attribute
4880 (@pxref{Variable Attributes}).
4882 @table @gcctabopt
4883 @item -Wunused-const-variable=1
4884 This is the warning level that is enabled by @option{-Wunused-variable} for
4885 C.  It warns only about unused static const variables defined in the main
4886 compilation unit, but not about static const variables declared in any
4887 header included.
4889 @item -Wunused-const-variable=2
4890 This warning level also warns for unused constant static variables in
4891 headers (excluding system headers).  This is the warning level of
4892 @option{-Wunused-const-variable} and must be explicitly requested since
4893 in C++ this isn't an error and in C it might be harder to clean up all
4894 headers included.
4895 @end table
4897 @item -Wunused-value
4898 @opindex Wunused-value
4899 @opindex Wno-unused-value
4900 Warn whenever a statement computes a result that is explicitly not
4901 used. To suppress this warning cast the unused expression to
4902 @code{void}. This includes an expression-statement or the left-hand
4903 side of a comma expression that contains no side effects. For example,
4904 an expression such as @code{x[i,j]} causes a warning, while
4905 @code{x[(void)i,j]} does not.
4907 This warning is enabled by @option{-Wall}.
4909 @item -Wunused
4910 @opindex Wunused
4911 @opindex Wno-unused
4912 All the above @option{-Wunused} options combined.
4914 In order to get a warning about an unused function parameter, you must
4915 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4916 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4918 @item -Wuninitialized
4919 @opindex Wuninitialized
4920 @opindex Wno-uninitialized
4921 Warn if an automatic variable is used without first being initialized
4922 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4923 warn if a non-static reference or non-static @code{const} member
4924 appears in a class without constructors.
4926 If you want to warn about code that uses the uninitialized value of the
4927 variable in its own initializer, use the @option{-Winit-self} option.
4929 These warnings occur for individual uninitialized or clobbered
4930 elements of structure, union or array variables as well as for
4931 variables that are uninitialized or clobbered as a whole.  They do
4932 not occur for variables or elements declared @code{volatile}.  Because
4933 these warnings depend on optimization, the exact variables or elements
4934 for which there are warnings depends on the precise optimization
4935 options and version of GCC used.
4937 Note that there may be no warning about a variable that is used only
4938 to compute a value that itself is never used, because such
4939 computations may be deleted by data flow analysis before the warnings
4940 are printed.
4942 @item -Winvalid-memory-model
4943 @opindex Winvalid-memory-model
4944 @opindex Wno-invalid-memory-model
4945 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4946 and the C11 atomic generic functions with a memory consistency argument
4947 that is either invalid for the operation or outside the range of values
4948 of the @code{memory_order} enumeration.  For example, since the
4949 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4950 defined for the relaxed, release, and sequentially consistent memory
4951 orders the following code is diagnosed:
4953 @smallexample
4954 void store (int *i)
4956   __atomic_store_n (i, 0, memory_order_consume);
4958 @end smallexample
4960 @option{-Winvalid-memory-model} is enabled by default.
4962 @item -Wmaybe-uninitialized
4963 @opindex Wmaybe-uninitialized
4964 @opindex Wno-maybe-uninitialized
4965 For an automatic (i.e.@ local) variable, if there exists a path from the
4966 function entry to a use of the variable that is initialized, but there exist
4967 some other paths for which the variable is not initialized, the compiler
4968 emits a warning if it cannot prove the uninitialized paths are not
4969 executed at run time.
4971 These warnings are only possible in optimizing compilation, because otherwise
4972 GCC does not keep track of the state of variables.
4974 These warnings are made optional because GCC may not be able to determine when
4975 the code is correct in spite of appearing to have an error.  Here is one
4976 example of how this can happen:
4978 @smallexample
4979 @group
4981   int x;
4982   switch (y)
4983     @{
4984     case 1: x = 1;
4985       break;
4986     case 2: x = 4;
4987       break;
4988     case 3: x = 5;
4989     @}
4990   foo (x);
4992 @end group
4993 @end smallexample
4995 @noindent
4996 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4997 always initialized, but GCC doesn't know this. To suppress the
4998 warning, you need to provide a default case with assert(0) or
4999 similar code.
5001 @cindex @code{longjmp} warnings
5002 This option also warns when a non-volatile automatic variable might be
5003 changed by a call to @code{longjmp}.
5004 The compiler sees only the calls to @code{setjmp}.  It cannot know
5005 where @code{longjmp} will be called; in fact, a signal handler could
5006 call it at any point in the code.  As a result, you may get a warning
5007 even when there is in fact no problem because @code{longjmp} cannot
5008 in fact be called at the place that would cause a problem.
5010 Some spurious warnings can be avoided if you declare all the functions
5011 you use that never return as @code{noreturn}.  @xref{Function
5012 Attributes}.
5014 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5016 @item -Wunknown-pragmas
5017 @opindex Wunknown-pragmas
5018 @opindex Wno-unknown-pragmas
5019 @cindex warning for unknown pragmas
5020 @cindex unknown pragmas, warning
5021 @cindex pragmas, warning of unknown
5022 Warn when a @code{#pragma} directive is encountered that is not understood by 
5023 GCC@.  If this command-line option is used, warnings are even issued
5024 for unknown pragmas in system header files.  This is not the case if
5025 the warnings are only enabled by the @option{-Wall} command-line option.
5027 @item -Wno-pragmas
5028 @opindex Wno-pragmas
5029 @opindex Wpragmas
5030 Do not warn about misuses of pragmas, such as incorrect parameters,
5031 invalid syntax, or conflicts between pragmas.  See also
5032 @option{-Wunknown-pragmas}.
5034 @item -Wstrict-aliasing
5035 @opindex Wstrict-aliasing
5036 @opindex Wno-strict-aliasing
5037 This option is only active when @option{-fstrict-aliasing} is active.
5038 It warns about code that might break the strict aliasing rules that the
5039 compiler is using for optimization.  The warning does not catch all
5040 cases, but does attempt to catch the more common pitfalls.  It is
5041 included in @option{-Wall}.
5042 It is equivalent to @option{-Wstrict-aliasing=3}
5044 @item -Wstrict-aliasing=n
5045 @opindex Wstrict-aliasing=n
5046 This option is only active when @option{-fstrict-aliasing} is active.
5047 It warns about code that might break the strict aliasing rules that the
5048 compiler is using for optimization.
5049 Higher levels correspond to higher accuracy (fewer false positives).
5050 Higher levels also correspond to more effort, similar to the way @option{-O} 
5051 works.
5052 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5054 Level 1: Most aggressive, quick, least accurate.
5055 Possibly useful when higher levels
5056 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5057 false negatives.  However, it has many false positives.
5058 Warns for all pointer conversions between possibly incompatible types,
5059 even if never dereferenced.  Runs in the front end only.
5061 Level 2: Aggressive, quick, not too precise.
5062 May still have many false positives (not as many as level 1 though),
5063 and few false negatives (but possibly more than level 1).
5064 Unlike level 1, it only warns when an address is taken.  Warns about
5065 incomplete types.  Runs in the front end only.
5067 Level 3 (default for @option{-Wstrict-aliasing}):
5068 Should have very few false positives and few false
5069 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5070 Takes care of the common pun+dereference pattern in the front end:
5071 @code{*(int*)&some_float}.
5072 If optimization is enabled, it also runs in the back end, where it deals
5073 with multiple statement cases using flow-sensitive points-to information.
5074 Only warns when the converted pointer is dereferenced.
5075 Does not warn about incomplete types.
5077 @item -Wstrict-overflow
5078 @itemx -Wstrict-overflow=@var{n}
5079 @opindex Wstrict-overflow
5080 @opindex Wno-strict-overflow
5081 This option is only active when signed overflow is undefined.
5082 It warns about cases where the compiler optimizes based on the
5083 assumption that signed overflow does not occur.  Note that it does not
5084 warn about all cases where the code might overflow: it only warns
5085 about cases where the compiler implements some optimization.  Thus
5086 this warning depends on the optimization level.
5088 An optimization that assumes that signed overflow does not occur is
5089 perfectly safe if the values of the variables involved are such that
5090 overflow never does, in fact, occur.  Therefore this warning can
5091 easily give a false positive: a warning about code that is not
5092 actually a problem.  To help focus on important issues, several
5093 warning levels are defined.  No warnings are issued for the use of
5094 undefined signed overflow when estimating how many iterations a loop
5095 requires, in particular when determining whether a loop will be
5096 executed at all.
5098 @table @gcctabopt
5099 @item -Wstrict-overflow=1
5100 Warn about cases that are both questionable and easy to avoid.  For
5101 example the compiler simplifies
5102 @code{x + 1 > x} to @code{1}.  This level of
5103 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5104 are not, and must be explicitly requested.
5106 @item -Wstrict-overflow=2
5107 Also warn about other cases where a comparison is simplified to a
5108 constant.  For example: @code{abs (x) >= 0}.  This can only be
5109 simplified when signed integer overflow is undefined, because
5110 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5111 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5112 @option{-Wstrict-overflow=2}.
5114 @item -Wstrict-overflow=3
5115 Also warn about other cases where a comparison is simplified.  For
5116 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5118 @item -Wstrict-overflow=4
5119 Also warn about other simplifications not covered by the above cases.
5120 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5122 @item -Wstrict-overflow=5
5123 Also warn about cases where the compiler reduces the magnitude of a
5124 constant involved in a comparison.  For example: @code{x + 2 > y} is
5125 simplified to @code{x + 1 >= y}.  This is reported only at the
5126 highest warning level because this simplification applies to many
5127 comparisons, so this warning level gives a very large number of
5128 false positives.
5129 @end table
5131 @item -Wstringop-overflow
5132 @itemx -Wstringop-overflow=@var{type}
5133 @opindex Wstringop-overflow
5134 @opindex Wno-stringop-overflow
5135 Warn for calls to string manipulation functions such as @code{memcpy} and
5136 @code{strcpy} that are determined to overflow the destination buffer.  The
5137 optional argument is one greater than the type of Object Size Checking to
5138 perform to determine the size of the destination.  @xref{Object Size Checking}.
5139 The argument is meaningful only for functions that operate on character arrays
5140 but not for raw memory functions like @code{memcpy} which always make use
5141 of Object Size type-0.  The option also warns for calls that specify a size
5142 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5143 The option produces the best results with optimization enabled but can detect
5144 a small subset of simple buffer overflows even without optimization in
5145 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5146 correspond to the standard functions.  In any case, the option warns about
5147 just a subset of buffer overflows detected by the corresponding overflow
5148 checking built-ins.  For example, the option will issue a warning for
5149 the @code{strcpy} call below because it copies at least 5 characters
5150 (the string @code{"blue"} including the terminating NUL) into the buffer
5151 of size 4.
5153 @smallexample
5154 enum Color @{ blue, purple, yellow @};
5155 const char* f (enum Color clr)
5157   static char buf [4];
5158   const char *str;
5159   switch (clr)
5160     @{
5161       case blue: str = "blue"; break;
5162       case purple: str = "purple"; break;
5163       case yellow: str = "yellow"; break;
5164     @}
5166   return strcpy (buf, str);   // warning here
5168 @end smallexample
5170 Option @option{-Wstringop-overflow=2} is enabled by default.
5172 @table @gcctabopt
5173 @item -Wstringop-overflow
5174 @item -Wstringop-overflow=1
5175 @opindex Wstringop-overflow
5176 @opindex Wno-stringop-overflow
5177 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5178 to determine the sizes of destination objects.  This is the default setting
5179 of the option.  At this setting the option will not warn for writes past
5180 the end of subobjects of larger objects accessed by pointers unless the
5181 size of the largest surrounding object is known.  When the destination may
5182 be one of several objects it is assumed to be the largest one of them.  On
5183 Linux systems, when optimization is enabled at this setting the option warns
5184 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5185 a non-zero value.
5187 @item -Wstringop-overflow=2
5188 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5189 to determine the sizes of destination objects.  At this setting the option
5190 will warn about overflows when writing to members of the largest complete
5191 objects whose exact size is known.  It will, however, not warn for excessive
5192 writes to the same members of unknown objects referenced by pointers since
5193 they may point to arrays containing unknown numbers of elements.
5195 @item -Wstringop-overflow=3
5196 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5197 to determine the sizes of destination objects.  At this setting the option
5198 warns about overflowing the smallest object or data member.  This is the
5199 most restrictive setting of the option that may result in warnings for safe
5200 code.
5202 @item -Wstringop-overflow=4
5203 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5204 to determine the sizes of destination objects.  At this setting the option
5205 will warn about overflowing any data members, and when the destination is
5206 one of several objects it uses the size of the largest of them to decide
5207 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5208 setting of the option may result in warnings for benign code.
5209 @end table
5211 @item -Wstringop-truncation
5212 @opindex Wstringop-truncation
5213 @opindex Wno-stringop-truncation
5214 Warn for calls to bounded string manipulation functions such as @code{strncat},
5215 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5216 or leave the destination unchanged.
5218 In the following example, the call to @code{strncat} specifies a bound that
5219 is less than the length of the source string.  As a result, the copy of
5220 the source will be truncated and so the call is diagnosed.  To avoid the
5221 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5223 @smallexample
5224 void append (char *buf, size_t bufsize)
5226   strncat (buf, ".txt", 3);
5228 @end smallexample
5230 As another example, the following call to @code{strncpy} results in copying
5231 to @code{d} just the characters preceding the terminating NUL, without
5232 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5233 necessarily a NUL-terminated string is a common mistake, and so the call
5234 is diagnosed.  To avoid the warning when the result is not expected to be
5235 NUL-terminated, call @code{memcpy} instead.
5237 @smallexample
5238 void copy (char *d, const char *s)
5240   strncpy (d, s, strlen (s));
5242 @end smallexample
5244 In the following example, the call to @code{strncpy} specifies the size
5245 of the destination buffer as the bound.  If the length of the source
5246 string is equal to or greater than this size the result of the copy will
5247 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5248 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5249 element of the buffer to @code{NUL}.
5251 @smallexample
5252 void copy (const char *s)
5254   char buf[80];
5255   strncpy (buf, s, sizeof buf);
5256   @dots{}
5258 @end smallexample
5260 In situations where a character array is intended to store a sequence
5261 of bytes with no terminating @code{NUL} such an array may be annotated
5262 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5263 however, are not suitable arguments to functions that expect
5264 @code{NUL}-terminated strings.  To help detect accidental misuses of
5265 such arrays GCC issues warnings unless it can prove that the use is
5266 safe.  @xref{Common Variable Attributes}.
5268 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5269 @opindex Wsuggest-attribute=
5270 @opindex Wno-suggest-attribute=
5271 Warn for cases where adding an attribute may be beneficial. The
5272 attributes currently supported are listed below.
5274 @table @gcctabopt
5275 @item -Wsuggest-attribute=pure
5276 @itemx -Wsuggest-attribute=const
5277 @itemx -Wsuggest-attribute=noreturn
5278 @itemx -Wsuggest-attribute=malloc
5279 @opindex Wsuggest-attribute=pure
5280 @opindex Wno-suggest-attribute=pure
5281 @opindex Wsuggest-attribute=const
5282 @opindex Wno-suggest-attribute=const
5283 @opindex Wsuggest-attribute=noreturn
5284 @opindex Wno-suggest-attribute=noreturn
5285 @opindex Wsuggest-attribute=malloc
5286 @opindex Wno-suggest-attribute=malloc
5288 Warn about functions that might be candidates for attributes
5289 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5290 only warns for functions visible in other compilation units or (in the case of
5291 @code{pure} and @code{const}) if it cannot prove that the function returns
5292 normally. A function returns normally if it doesn't contain an infinite loop or
5293 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5294 requires option @option{-fipa-pure-const}, which is enabled by default at
5295 @option{-O} and higher.  Higher optimization levels improve the accuracy
5296 of the analysis.
5298 @item -Wsuggest-attribute=format
5299 @itemx -Wmissing-format-attribute
5300 @opindex Wsuggest-attribute=format
5301 @opindex Wmissing-format-attribute
5302 @opindex Wno-suggest-attribute=format
5303 @opindex Wno-missing-format-attribute
5304 @opindex Wformat
5305 @opindex Wno-format
5307 Warn about function pointers that might be candidates for @code{format}
5308 attributes.  Note these are only possible candidates, not absolute ones.
5309 GCC guesses that function pointers with @code{format} attributes that
5310 are used in assignment, initialization, parameter passing or return
5311 statements should have a corresponding @code{format} attribute in the
5312 resulting type.  I.e.@: the left-hand side of the assignment or
5313 initialization, the type of the parameter variable, or the return type
5314 of the containing function respectively should also have a @code{format}
5315 attribute to avoid the warning.
5317 GCC also warns about function definitions that might be
5318 candidates for @code{format} attributes.  Again, these are only
5319 possible candidates.  GCC guesses that @code{format} attributes
5320 might be appropriate for any function that calls a function like
5321 @code{vprintf} or @code{vscanf}, but this might not always be the
5322 case, and some functions for which @code{format} attributes are
5323 appropriate may not be detected.
5325 @item -Wsuggest-attribute=cold
5326 @opindex Wsuggest-attribute=cold
5327 @opindex Wno-suggest-attribute=cold
5329 Warn about functions that might be candidates for @code{cold} attribute.  This
5330 is based on static detection and generally will only warn about functions which
5331 always leads to a call to another @code{cold} function such as wrappers of
5332 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5333 @end table
5335 @item -Wsuggest-final-types
5336 @opindex Wno-suggest-final-types
5337 @opindex Wsuggest-final-types
5338 Warn about types with virtual methods where code quality would be improved
5339 if the type were declared with the C++11 @code{final} specifier, 
5340 or, if possible,
5341 declared in an anonymous namespace. This allows GCC to more aggressively
5342 devirtualize the polymorphic calls. This warning is more effective with link
5343 time optimization, where the information about the class hierarchy graph is
5344 more complete.
5346 @item -Wsuggest-final-methods
5347 @opindex Wno-suggest-final-methods
5348 @opindex Wsuggest-final-methods
5349 Warn about virtual methods where code quality would be improved if the method
5350 were declared with the C++11 @code{final} specifier, 
5351 or, if possible, its type were
5352 declared in an anonymous namespace or with the @code{final} specifier.
5353 This warning is
5354 more effective with link-time optimization, where the information about the
5355 class hierarchy graph is more complete. It is recommended to first consider
5356 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5357 annotations.
5359 @item -Wsuggest-override
5360 Warn about overriding virtual functions that are not marked with the override
5361 keyword.
5363 @item -Walloc-zero
5364 @opindex Wno-alloc-zero
5365 @opindex Walloc-zero
5366 Warn about calls to allocation functions decorated with attribute
5367 @code{alloc_size} that specify zero bytes, including those to the built-in
5368 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5369 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5370 when called with a zero size differs among implementations (and in the case
5371 of @code{realloc} has been deprecated) relying on it may result in subtle
5372 portability bugs and should be avoided.
5374 @item -Walloc-size-larger-than=@var{n}
5375 Warn about calls to functions decorated with attribute @code{alloc_size}
5376 that attempt to allocate objects larger than the specified number of bytes,
5377 or where the result of the size computation in an integer type with infinite
5378 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5379 may end in one of the standard suffixes designating a multiple of bytes
5380 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5381 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5382 @xref{Function Attributes}.
5384 @item -Walloca
5385 @opindex Wno-alloca
5386 @opindex Walloca
5387 This option warns on all uses of @code{alloca} in the source.
5389 @item -Walloca-larger-than=@var{n}
5390 This option warns on calls to @code{alloca} that are not bounded by a
5391 controlling predicate limiting its argument of integer type to at most
5392 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5393 Arguments of non-integer types are considered unbounded even if they
5394 appear to be constrained to the expected range.
5396 For example, a bounded case of @code{alloca} could be:
5398 @smallexample
5399 void func (size_t n)
5401   void *p;
5402   if (n <= 1000)
5403     p = alloca (n);
5404   else
5405     p = malloc (n);
5406   f (p);
5408 @end smallexample
5410 In the above example, passing @code{-Walloca-larger-than=1000} would not
5411 issue a warning because the call to @code{alloca} is known to be at most
5412 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5413 the compiler would emit a warning.
5415 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5416 controlling predicate constraining its integer argument.  For example:
5418 @smallexample
5419 void func ()
5421   void *p = alloca (n);
5422   f (p);
5424 @end smallexample
5426 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5427 a warning, but this time because of the lack of bounds checking.
5429 Note, that even seemingly correct code involving signed integers could
5430 cause a warning:
5432 @smallexample
5433 void func (signed int n)
5435   if (n < 500)
5436     @{
5437       p = alloca (n);
5438       f (p);
5439     @}
5441 @end smallexample
5443 In the above example, @var{n} could be negative, causing a larger than
5444 expected argument to be implicitly cast into the @code{alloca} call.
5446 This option also warns when @code{alloca} is used in a loop.
5448 This warning is not enabled by @option{-Wall}, and is only active when
5449 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5451 See also @option{-Wvla-larger-than=@var{n}}.
5453 @item -Warray-bounds
5454 @itemx -Warray-bounds=@var{n}
5455 @opindex Wno-array-bounds
5456 @opindex Warray-bounds
5457 This option is only active when @option{-ftree-vrp} is active
5458 (default for @option{-O2} and above). It warns about subscripts to arrays
5459 that are always out of bounds. This warning is enabled by @option{-Wall}.
5461 @table @gcctabopt
5462 @item -Warray-bounds=1
5463 This is the warning level of @option{-Warray-bounds} and is enabled
5464 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5466 @item -Warray-bounds=2
5467 This warning level also warns about out of bounds access for
5468 arrays at the end of a struct and for arrays accessed through
5469 pointers. This warning level may give a larger number of
5470 false positives and is deactivated by default.
5471 @end table
5473 @item -Wattribute-alias
5474 Warn about declarations using the @code{alias} and similar attributes whose
5475 target is incompatible with the type of the alias.  @xref{Function Attributes,
5476 ,Declaring Attributes of Functions}.
5478 @item -Wbool-compare
5479 @opindex Wno-bool-compare
5480 @opindex Wbool-compare
5481 Warn about boolean expression compared with an integer value different from
5482 @code{true}/@code{false}.  For instance, the following comparison is
5483 always false:
5484 @smallexample
5485 int n = 5;
5486 @dots{}
5487 if ((n > 1) == 2) @{ @dots{} @}
5488 @end smallexample
5489 This warning is enabled by @option{-Wall}.
5491 @item -Wbool-operation
5492 @opindex Wno-bool-operation
5493 @opindex Wbool-operation
5494 Warn about suspicious operations on expressions of a boolean type.  For
5495 instance, bitwise negation of a boolean is very likely a bug in the program.
5496 For C, this warning also warns about incrementing or decrementing a boolean,
5497 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5498 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5500 This warning is enabled by @option{-Wall}.
5502 @item -Wduplicated-branches
5503 @opindex Wno-duplicated-branches
5504 @opindex Wduplicated-branches
5505 Warn when an if-else has identical branches.  This warning detects cases like
5506 @smallexample
5507 if (p != NULL)
5508   return 0;
5509 else
5510   return 0;
5511 @end smallexample
5512 It doesn't warn when both branches contain just a null statement.  This warning
5513 also warn for conditional operators:
5514 @smallexample
5515   int i = x ? *p : *p;
5516 @end smallexample
5518 @item -Wduplicated-cond
5519 @opindex Wno-duplicated-cond
5520 @opindex Wduplicated-cond
5521 Warn about duplicated conditions in an if-else-if chain.  For instance,
5522 warn for the following code:
5523 @smallexample
5524 if (p->q != NULL) @{ @dots{} @}
5525 else if (p->q != NULL) @{ @dots{} @}
5526 @end smallexample
5528 @item -Wframe-address
5529 @opindex Wno-frame-address
5530 @opindex Wframe-address
5531 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5532 is called with an argument greater than 0.  Such calls may return indeterminate
5533 values or crash the program.  The warning is included in @option{-Wall}.
5535 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5536 @opindex Wno-discarded-qualifiers
5537 @opindex Wdiscarded-qualifiers
5538 Do not warn if type qualifiers on pointers are being discarded.
5539 Typically, the compiler warns if a @code{const char *} variable is
5540 passed to a function that takes a @code{char *} parameter.  This option
5541 can be used to suppress such a warning.
5543 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5544 @opindex Wno-discarded-array-qualifiers
5545 @opindex Wdiscarded-array-qualifiers
5546 Do not warn if type qualifiers on arrays which are pointer targets
5547 are being discarded. Typically, the compiler warns if a
5548 @code{const int (*)[]} variable is passed to a function that
5549 takes a @code{int (*)[]} parameter.  This option can be used to
5550 suppress such a warning.
5552 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5553 @opindex Wno-incompatible-pointer-types
5554 @opindex Wincompatible-pointer-types
5555 Do not warn when there is a conversion between pointers that have incompatible
5556 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5557 which warns for pointer argument passing or assignment with different
5558 signedness.
5560 @item -Wno-int-conversion @r{(C and Objective-C only)}
5561 @opindex Wno-int-conversion
5562 @opindex Wint-conversion
5563 Do not warn about incompatible integer to pointer and pointer to integer
5564 conversions.  This warning is about implicit conversions; for explicit
5565 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5566 @option{-Wno-pointer-to-int-cast} may be used.
5568 @item -Wno-div-by-zero
5569 @opindex Wno-div-by-zero
5570 @opindex Wdiv-by-zero
5571 Do not warn about compile-time integer division by zero.  Floating-point
5572 division by zero is not warned about, as it can be a legitimate way of
5573 obtaining infinities and NaNs.
5575 @item -Wsystem-headers
5576 @opindex Wsystem-headers
5577 @opindex Wno-system-headers
5578 @cindex warnings from system headers
5579 @cindex system headers, warnings from
5580 Print warning messages for constructs found in system header files.
5581 Warnings from system headers are normally suppressed, on the assumption
5582 that they usually do not indicate real problems and would only make the
5583 compiler output harder to read.  Using this command-line option tells
5584 GCC to emit warnings from system headers as if they occurred in user
5585 code.  However, note that using @option{-Wall} in conjunction with this
5586 option does @emph{not} warn about unknown pragmas in system
5587 headers---for that, @option{-Wunknown-pragmas} must also be used.
5589 @item -Wtautological-compare
5590 @opindex Wtautological-compare
5591 @opindex Wno-tautological-compare
5592 Warn if a self-comparison always evaluates to true or false.  This
5593 warning detects various mistakes such as:
5594 @smallexample
5595 int i = 1;
5596 @dots{}
5597 if (i > i) @{ @dots{} @}
5598 @end smallexample
5600 This warning also warns about bitwise comparisons that always evaluate
5601 to true or false, for instance:
5602 @smallexample
5603 if ((a & 16) == 10) @{ @dots{} @}
5604 @end smallexample
5605 will always be false.
5607 This warning is enabled by @option{-Wall}.
5609 @item -Wtrampolines
5610 @opindex Wtrampolines
5611 @opindex Wno-trampolines
5612 Warn about trampolines generated for pointers to nested functions.
5613 A trampoline is a small piece of data or code that is created at run
5614 time on the stack when the address of a nested function is taken, and is
5615 used to call the nested function indirectly.  For some targets, it is
5616 made up of data only and thus requires no special treatment.  But, for
5617 most targets, it is made up of code and thus requires the stack to be
5618 made executable in order for the program to work properly.
5620 @item -Wfloat-equal
5621 @opindex Wfloat-equal
5622 @opindex Wno-float-equal
5623 Warn if floating-point values are used in equality comparisons.
5625 The idea behind this is that sometimes it is convenient (for the
5626 programmer) to consider floating-point values as approximations to
5627 infinitely precise real numbers.  If you are doing this, then you need
5628 to compute (by analyzing the code, or in some other way) the maximum or
5629 likely maximum error that the computation introduces, and allow for it
5630 when performing comparisons (and when producing output, but that's a
5631 different problem).  In particular, instead of testing for equality, you
5632 should check to see whether the two values have ranges that overlap; and
5633 this is done with the relational operators, so equality comparisons are
5634 probably mistaken.
5636 @item -Wtraditional @r{(C and Objective-C only)}
5637 @opindex Wtraditional
5638 @opindex Wno-traditional
5639 Warn about certain constructs that behave differently in traditional and
5640 ISO C@.  Also warn about ISO C constructs that have no traditional C
5641 equivalent, and/or problematic constructs that should be avoided.
5643 @itemize @bullet
5644 @item
5645 Macro parameters that appear within string literals in the macro body.
5646 In traditional C macro replacement takes place within string literals,
5647 but in ISO C it does not.
5649 @item
5650 In traditional C, some preprocessor directives did not exist.
5651 Traditional preprocessors only considered a line to be a directive
5652 if the @samp{#} appeared in column 1 on the line.  Therefore
5653 @option{-Wtraditional} warns about directives that traditional C
5654 understands but ignores because the @samp{#} does not appear as the
5655 first character on the line.  It also suggests you hide directives like
5656 @code{#pragma} not understood by traditional C by indenting them.  Some
5657 traditional implementations do not recognize @code{#elif}, so this option
5658 suggests avoiding it altogether.
5660 @item
5661 A function-like macro that appears without arguments.
5663 @item
5664 The unary plus operator.
5666 @item
5667 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5668 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5669 constants.)  Note, these suffixes appear in macros defined in the system
5670 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5671 Use of these macros in user code might normally lead to spurious
5672 warnings, however GCC's integrated preprocessor has enough context to
5673 avoid warning in these cases.
5675 @item
5676 A function declared external in one block and then used after the end of
5677 the block.
5679 @item
5680 A @code{switch} statement has an operand of type @code{long}.
5682 @item
5683 A non-@code{static} function declaration follows a @code{static} one.
5684 This construct is not accepted by some traditional C compilers.
5686 @item
5687 The ISO type of an integer constant has a different width or
5688 signedness from its traditional type.  This warning is only issued if
5689 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5690 typically represent bit patterns, are not warned about.
5692 @item
5693 Usage of ISO string concatenation is detected.
5695 @item
5696 Initialization of automatic aggregates.
5698 @item
5699 Identifier conflicts with labels.  Traditional C lacks a separate
5700 namespace for labels.
5702 @item
5703 Initialization of unions.  If the initializer is zero, the warning is
5704 omitted.  This is done under the assumption that the zero initializer in
5705 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5706 initializer warnings and relies on default initialization to zero in the
5707 traditional C case.
5709 @item
5710 Conversions by prototypes between fixed/floating-point values and vice
5711 versa.  The absence of these prototypes when compiling with traditional
5712 C causes serious problems.  This is a subset of the possible
5713 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5715 @item
5716 Use of ISO C style function definitions.  This warning intentionally is
5717 @emph{not} issued for prototype declarations or variadic functions
5718 because these ISO C features appear in your code when using
5719 libiberty's traditional C compatibility macros, @code{PARAMS} and
5720 @code{VPARAMS}.  This warning is also bypassed for nested functions
5721 because that feature is already a GCC extension and thus not relevant to
5722 traditional C compatibility.
5723 @end itemize
5725 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5726 @opindex Wtraditional-conversion
5727 @opindex Wno-traditional-conversion
5728 Warn if a prototype causes a type conversion that is different from what
5729 would happen to the same argument in the absence of a prototype.  This
5730 includes conversions of fixed point to floating and vice versa, and
5731 conversions changing the width or signedness of a fixed-point argument
5732 except when the same as the default promotion.
5734 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5735 @opindex Wdeclaration-after-statement
5736 @opindex Wno-declaration-after-statement
5737 Warn when a declaration is found after a statement in a block.  This
5738 construct, known from C++, was introduced with ISO C99 and is by default
5739 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5741 @item -Wshadow
5742 @opindex Wshadow
5743 @opindex Wno-shadow
5744 Warn whenever a local variable or type declaration shadows another
5745 variable, parameter, type, class member (in C++), or instance variable
5746 (in Objective-C) or whenever a built-in function is shadowed. Note
5747 that in C++, the compiler warns if a local variable shadows an
5748 explicit typedef, but not if it shadows a struct/class/enum.
5749 Same as @option{-Wshadow=global}.
5751 @item -Wno-shadow-ivar @r{(Objective-C only)}
5752 @opindex Wno-shadow-ivar
5753 @opindex Wshadow-ivar
5754 Do not warn whenever a local variable shadows an instance variable in an
5755 Objective-C method.
5757 @item -Wshadow=global
5758 @opindex Wshadow=local
5759 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5761 @item -Wshadow=local
5762 @opindex Wshadow=local
5763 Warn when a local variable shadows another local variable or parameter.
5764 This warning is enabled by @option{-Wshadow=global}.
5766 @item -Wshadow=compatible-local
5767 @opindex Wshadow=compatible-local
5768 Warn when a local variable shadows another local variable or parameter
5769 whose type is compatible with that of the shadowing variable. In C++,
5770 type compatibility here means the type of the shadowing variable can be
5771 converted to that of the shadowed variable. The creation of this flag
5772 (in addition to @option{-Wshadow=local}) is based on the idea that when
5773 a local variable shadows another one of incompatible type, it is most
5774 likely intentional, not a bug or typo, as shown in the following example:
5776 @smallexample
5777 @group
5778 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5780   for (int i = 0; i < N; ++i)
5781   @{
5782     ...
5783   @}
5784   ...
5786 @end group
5787 @end smallexample
5789 Since the two variable @code{i} in the example above have incompatible types,
5790 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5791 Because their types are incompatible, if a programmer accidentally uses one
5792 in place of the other, type checking will catch that and emit an error or
5793 warning. So not warning (about shadowing) in this case will not lead to
5794 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5795 possibly reduce the number of warnings triggered by intentional shadowing.
5797 This warning is enabled by @option{-Wshadow=local}.
5799 @item -Wlarger-than=@var{len}
5800 @opindex Wlarger-than=@var{len}
5801 @opindex Wlarger-than-@var{len}
5802 Warn whenever an object of larger than @var{len} bytes is defined.
5804 @item -Wframe-larger-than=@var{len}
5805 @opindex Wframe-larger-than
5806 Warn if the size of a function frame is larger than @var{len} bytes.
5807 The computation done to determine the stack frame size is approximate
5808 and not conservative.
5809 The actual requirements may be somewhat greater than @var{len}
5810 even if you do not get a warning.  In addition, any space allocated
5811 via @code{alloca}, variable-length arrays, or related constructs
5812 is not included by the compiler when determining
5813 whether or not to issue a warning.
5815 @item -Wno-free-nonheap-object
5816 @opindex Wno-free-nonheap-object
5817 @opindex Wfree-nonheap-object
5818 Do not warn when attempting to free an object that was not allocated
5819 on the heap.
5821 @item -Wstack-usage=@var{len}
5822 @opindex Wstack-usage
5823 Warn if the stack usage of a function might be larger than @var{len} bytes.
5824 The computation done to determine the stack usage is conservative.
5825 Any space allocated via @code{alloca}, variable-length arrays, or related
5826 constructs is included by the compiler when determining whether or not to
5827 issue a warning.
5829 The message is in keeping with the output of @option{-fstack-usage}.
5831 @itemize
5832 @item
5833 If the stack usage is fully static but exceeds the specified amount, it's:
5835 @smallexample
5836   warning: stack usage is 1120 bytes
5837 @end smallexample
5838 @item
5839 If the stack usage is (partly) dynamic but bounded, it's:
5841 @smallexample
5842   warning: stack usage might be 1648 bytes
5843 @end smallexample
5844 @item
5845 If the stack usage is (partly) dynamic and not bounded, it's:
5847 @smallexample
5848   warning: stack usage might be unbounded
5849 @end smallexample
5850 @end itemize
5852 @item -Wunsafe-loop-optimizations
5853 @opindex Wunsafe-loop-optimizations
5854 @opindex Wno-unsafe-loop-optimizations
5855 Warn if the loop cannot be optimized because the compiler cannot
5856 assume anything on the bounds of the loop indices.  With
5857 @option{-funsafe-loop-optimizations} warn if the compiler makes
5858 such assumptions.
5860 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5861 @opindex Wno-pedantic-ms-format
5862 @opindex Wpedantic-ms-format
5863 When used in combination with @option{-Wformat}
5864 and @option{-pedantic} without GNU extensions, this option
5865 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5866 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5867 which depend on the MS runtime.
5869 @item -Waligned-new
5870 @opindex Waligned-new
5871 @opindex Wno-aligned-new
5872 Warn about a new-expression of a type that requires greater alignment
5873 than the @code{alignof(std::max_align_t)} but uses an allocation
5874 function without an explicit alignment parameter. This option is
5875 enabled by @option{-Wall}.
5877 Normally this only warns about global allocation functions, but
5878 @option{-Waligned-new=all} also warns about class member allocation
5879 functions.
5881 @item -Wplacement-new
5882 @itemx -Wplacement-new=@var{n}
5883 @opindex Wplacement-new
5884 @opindex Wno-placement-new
5885 Warn about placement new expressions with undefined behavior, such as
5886 constructing an object in a buffer that is smaller than the type of
5887 the object.  For example, the placement new expression below is diagnosed
5888 because it attempts to construct an array of 64 integers in a buffer only
5889 64 bytes large.
5890 @smallexample
5891 char buf [64];
5892 new (buf) int[64];
5893 @end smallexample
5894 This warning is enabled by default.
5896 @table @gcctabopt
5897 @item -Wplacement-new=1
5898 This is the default warning level of @option{-Wplacement-new}.  At this
5899 level the warning is not issued for some strictly undefined constructs that
5900 GCC allows as extensions for compatibility with legacy code.  For example,
5901 the following @code{new} expression is not diagnosed at this level even
5902 though it has undefined behavior according to the C++ standard because
5903 it writes past the end of the one-element array.
5904 @smallexample
5905 struct S @{ int n, a[1]; @};
5906 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5907 new (s->a)int [32]();
5908 @end smallexample
5910 @item -Wplacement-new=2
5911 At this level, in addition to diagnosing all the same constructs as at level
5912 1, a diagnostic is also issued for placement new expressions that construct
5913 an object in the last member of structure whose type is an array of a single
5914 element and whose size is less than the size of the object being constructed.
5915 While the previous example would be diagnosed, the following construct makes
5916 use of the flexible member array extension to avoid the warning at level 2.
5917 @smallexample
5918 struct S @{ int n, a[]; @};
5919 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5920 new (s->a)int [32]();
5921 @end smallexample
5923 @end table
5925 @item -Wpointer-arith
5926 @opindex Wpointer-arith
5927 @opindex Wno-pointer-arith
5928 Warn about anything that depends on the ``size of'' a function type or
5929 of @code{void}.  GNU C assigns these types a size of 1, for
5930 convenience in calculations with @code{void *} pointers and pointers
5931 to functions.  In C++, warn also when an arithmetic operation involves
5932 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5934 @item -Wpointer-compare
5935 @opindex Wpointer-compare
5936 @opindex Wno-pointer-compare
5937 Warn if a pointer is compared with a zero character constant.  This usually
5938 means that the pointer was meant to be dereferenced.  For example:
5940 @smallexample
5941 const char *p = foo ();
5942 if (p == '\0')
5943   return 42;
5944 @end smallexample
5946 Note that the code above is invalid in C++11.
5948 This warning is enabled by default.
5950 @item -Wtype-limits
5951 @opindex Wtype-limits
5952 @opindex Wno-type-limits
5953 Warn if a comparison is always true or always false due to the limited
5954 range of the data type, but do not warn for constant expressions.  For
5955 example, warn if an unsigned variable is compared against zero with
5956 @code{<} or @code{>=}.  This warning is also enabled by
5957 @option{-Wextra}.
5959 @include cppwarnopts.texi
5961 @item -Wbad-function-cast @r{(C and Objective-C only)}
5962 @opindex Wbad-function-cast
5963 @opindex Wno-bad-function-cast
5964 Warn when a function call is cast to a non-matching type.
5965 For example, warn if a call to a function returning an integer type 
5966 is cast to a pointer type.
5968 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5969 @opindex Wc90-c99-compat
5970 @opindex Wno-c90-c99-compat
5971 Warn about features not present in ISO C90, but present in ISO C99.
5972 For instance, warn about use of variable length arrays, @code{long long}
5973 type, @code{bool} type, compound literals, designated initializers, and so
5974 on.  This option is independent of the standards mode.  Warnings are disabled
5975 in the expression that follows @code{__extension__}.
5977 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5978 @opindex Wc99-c11-compat
5979 @opindex Wno-c99-c11-compat
5980 Warn about features not present in ISO C99, but present in ISO C11.
5981 For instance, warn about use of anonymous structures and unions,
5982 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5983 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5984 and so on.  This option is independent of the standards mode.  Warnings are
5985 disabled in the expression that follows @code{__extension__}.
5987 @item -Wc++-compat @r{(C and Objective-C only)}
5988 @opindex Wc++-compat
5989 Warn about ISO C constructs that are outside of the common subset of
5990 ISO C and ISO C++, e.g.@: request for implicit conversion from
5991 @code{void *} to a pointer to non-@code{void} type.
5993 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5994 @opindex Wc++11-compat
5995 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5996 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5997 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5998 enabled by @option{-Wall}.
6000 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6001 @opindex Wc++14-compat
6002 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6003 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6005 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6006 @opindex Wc++17-compat
6007 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6008 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6010 @item -Wcast-qual
6011 @opindex Wcast-qual
6012 @opindex Wno-cast-qual
6013 Warn whenever a pointer is cast so as to remove a type qualifier from
6014 the target type.  For example, warn if a @code{const char *} is cast
6015 to an ordinary @code{char *}.
6017 Also warn when making a cast that introduces a type qualifier in an
6018 unsafe way.  For example, casting @code{char **} to @code{const char **}
6019 is unsafe, as in this example:
6021 @smallexample
6022   /* p is char ** value.  */
6023   const char **q = (const char **) p;
6024   /* Assignment of readonly string to const char * is OK.  */
6025   *q = "string";
6026   /* Now char** pointer points to read-only memory.  */
6027   **p = 'b';
6028 @end smallexample
6030 @item -Wcast-align
6031 @opindex Wcast-align
6032 @opindex Wno-cast-align
6033 Warn whenever a pointer is cast such that the required alignment of the
6034 target is increased.  For example, warn if a @code{char *} is cast to
6035 an @code{int *} on machines where integers can only be accessed at
6036 two- or four-byte boundaries.
6038 @item -Wcast-align=strict
6039 @opindex Wcast-align=strict
6040 Warn whenever a pointer is cast such that the required alignment of the
6041 target is increased.  For example, warn if a @code{char *} is cast to
6042 an @code{int *} regardless of the target machine.
6044 @item -Wwrite-strings
6045 @opindex Wwrite-strings
6046 @opindex Wno-write-strings
6047 When compiling C, give string constants the type @code{const
6048 char[@var{length}]} so that copying the address of one into a
6049 non-@code{const} @code{char *} pointer produces a warning.  These
6050 warnings help you find at compile time code that can try to write
6051 into a string constant, but only if you have been very careful about
6052 using @code{const} in declarations and prototypes.  Otherwise, it is
6053 just a nuisance. This is why we did not make @option{-Wall} request
6054 these warnings.
6056 When compiling C++, warn about the deprecated conversion from string
6057 literals to @code{char *}.  This warning is enabled by default for C++
6058 programs.
6060 @item -Wcatch-value
6061 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6062 @opindex Wcatch-value
6063 @opindex Wno-catch-value
6064 Warn about catch handlers that do not catch via reference.
6065 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6066 warn about polymorphic class types that are caught by value.
6067 With @option{-Wcatch-value=2} warn about all class types that are caught
6068 by value. With @option{-Wcatch-value=3} warn about all types that are
6069 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6071 @item -Wclobbered
6072 @opindex Wclobbered
6073 @opindex Wno-clobbered
6074 Warn for variables that might be changed by @code{longjmp} or
6075 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6077 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6078 @opindex Wconditionally-supported
6079 @opindex Wno-conditionally-supported
6080 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6082 @item -Wconversion
6083 @opindex Wconversion
6084 @opindex Wno-conversion
6085 Warn for implicit conversions that may alter a value. This includes
6086 conversions between real and integer, like @code{abs (x)} when
6087 @code{x} is @code{double}; conversions between signed and unsigned,
6088 like @code{unsigned ui = -1}; and conversions to smaller types, like
6089 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6090 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6091 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6092 conversions between signed and unsigned integers can be disabled by
6093 using @option{-Wno-sign-conversion}.
6095 For C++, also warn for confusing overload resolution for user-defined
6096 conversions; and conversions that never use a type conversion
6097 operator: conversions to @code{void}, the same type, a base class or a
6098 reference to them. Warnings about conversions between signed and
6099 unsigned integers are disabled by default in C++ unless
6100 @option{-Wsign-conversion} is explicitly enabled.
6102 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6103 @opindex Wconversion-null
6104 @opindex Wno-conversion-null
6105 Do not warn for conversions between @code{NULL} and non-pointer
6106 types. @option{-Wconversion-null} is enabled by default.
6108 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6109 @opindex Wzero-as-null-pointer-constant
6110 @opindex Wno-zero-as-null-pointer-constant
6111 Warn when a literal @samp{0} is used as null pointer constant.  This can
6112 be useful to facilitate the conversion to @code{nullptr} in C++11.
6114 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6115 @opindex Wsubobject-linkage
6116 @opindex Wno-subobject-linkage
6117 Warn if a class type has a base or a field whose type uses the anonymous
6118 namespace or depends on a type with no linkage.  If a type A depends on
6119 a type B with no or internal linkage, defining it in multiple
6120 translation units would be an ODR violation because the meaning of B
6121 is different in each translation unit.  If A only appears in a single
6122 translation unit, the best way to silence the warning is to give it
6123 internal linkage by putting it in an anonymous namespace as well.  The
6124 compiler doesn't give this warning for types defined in the main .C
6125 file, as those are unlikely to have multiple definitions.
6126 @option{-Wsubobject-linkage} is enabled by default.
6128 @item -Wdangling-else
6129 @opindex Wdangling-else
6130 @opindex Wno-dangling-else
6131 Warn about constructions where there may be confusion to which
6132 @code{if} statement an @code{else} branch belongs.  Here is an example of
6133 such a case:
6135 @smallexample
6136 @group
6138   if (a)
6139     if (b)
6140       foo ();
6141   else
6142     bar ();
6144 @end group
6145 @end smallexample
6147 In C/C++, every @code{else} branch belongs to the innermost possible
6148 @code{if} statement, which in this example is @code{if (b)}.  This is
6149 often not what the programmer expected, as illustrated in the above
6150 example by indentation the programmer chose.  When there is the
6151 potential for this confusion, GCC issues a warning when this flag
6152 is specified.  To eliminate the warning, add explicit braces around
6153 the innermost @code{if} statement so there is no way the @code{else}
6154 can belong to the enclosing @code{if}.  The resulting code
6155 looks like this:
6157 @smallexample
6158 @group
6160   if (a)
6161     @{
6162       if (b)
6163         foo ();
6164       else
6165         bar ();
6166     @}
6168 @end group
6169 @end smallexample
6171 This warning is enabled by @option{-Wparentheses}.
6173 @item -Wdate-time
6174 @opindex Wdate-time
6175 @opindex Wno-date-time
6176 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6177 are encountered as they might prevent bit-wise-identical reproducible
6178 compilations.
6180 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6181 @opindex Wdelete-incomplete
6182 @opindex Wno-delete-incomplete
6183 Warn when deleting a pointer to incomplete type, which may cause
6184 undefined behavior at runtime.  This warning is enabled by default.
6186 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6187 @opindex Wuseless-cast
6188 @opindex Wno-useless-cast
6189 Warn when an expression is casted to its own type.
6191 @item -Wempty-body
6192 @opindex Wempty-body
6193 @opindex Wno-empty-body
6194 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6195 while} statement.  This warning is also enabled by @option{-Wextra}.
6197 @item -Wenum-compare
6198 @opindex Wenum-compare
6199 @opindex Wno-enum-compare
6200 Warn about a comparison between values of different enumerated types.
6201 In C++ enumerated type mismatches in conditional expressions are also
6202 diagnosed and the warning is enabled by default.  In C this warning is 
6203 enabled by @option{-Wall}.
6205 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6206 @opindex Wextra-semi
6207 @opindex Wno-extra-semi
6208 Warn about redundant semicolon after in-class function definition.
6210 @item -Wjump-misses-init @r{(C, Objective-C only)}
6211 @opindex Wjump-misses-init
6212 @opindex Wno-jump-misses-init
6213 Warn if a @code{goto} statement or a @code{switch} statement jumps
6214 forward across the initialization of a variable, or jumps backward to a
6215 label after the variable has been initialized.  This only warns about
6216 variables that are initialized when they are declared.  This warning is
6217 only supported for C and Objective-C; in C++ this sort of branch is an
6218 error in any case.
6220 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6221 can be disabled with the @option{-Wno-jump-misses-init} option.
6223 @item -Wsign-compare
6224 @opindex Wsign-compare
6225 @opindex Wno-sign-compare
6226 @cindex warning for comparison of signed and unsigned values
6227 @cindex comparison of signed and unsigned values, warning
6228 @cindex signed and unsigned values, comparison warning
6229 Warn when a comparison between signed and unsigned values could produce
6230 an incorrect result when the signed value is converted to unsigned.
6231 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6232 also enabled by @option{-Wextra}.
6234 @item -Wsign-conversion
6235 @opindex Wsign-conversion
6236 @opindex Wno-sign-conversion
6237 Warn for implicit conversions that may change the sign of an integer
6238 value, like assigning a signed integer expression to an unsigned
6239 integer variable. An explicit cast silences the warning. In C, this
6240 option is enabled also by @option{-Wconversion}.
6242 @item -Wfloat-conversion
6243 @opindex Wfloat-conversion
6244 @opindex Wno-float-conversion
6245 Warn for implicit conversions that reduce the precision of a real value.
6246 This includes conversions from real to integer, and from higher precision
6247 real to lower precision real values.  This option is also enabled by
6248 @option{-Wconversion}.
6250 @item -Wno-scalar-storage-order
6251 @opindex -Wno-scalar-storage-order
6252 @opindex -Wscalar-storage-order
6253 Do not warn on suspicious constructs involving reverse scalar storage order.
6255 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6256 @opindex Wsized-deallocation
6257 @opindex Wno-sized-deallocation
6258 Warn about a definition of an unsized deallocation function
6259 @smallexample
6260 void operator delete (void *) noexcept;
6261 void operator delete[] (void *) noexcept;
6262 @end smallexample
6263 without a definition of the corresponding sized deallocation function
6264 @smallexample
6265 void operator delete (void *, std::size_t) noexcept;
6266 void operator delete[] (void *, std::size_t) noexcept;
6267 @end smallexample
6268 or vice versa.  Enabled by @option{-Wextra} along with
6269 @option{-fsized-deallocation}.
6271 @item -Wsizeof-pointer-div
6272 @opindex Wsizeof-pointer-div
6273 @opindex Wno-sizeof-pointer-div
6274 Warn for suspicious divisions of two sizeof expressions that divide
6275 the pointer size by the element size, which is the usual way to compute
6276 the array size but won't work out correctly with pointers.  This warning
6277 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6278 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6280 @item -Wsizeof-pointer-memaccess
6281 @opindex Wsizeof-pointer-memaccess
6282 @opindex Wno-sizeof-pointer-memaccess
6283 Warn for suspicious length parameters to certain string and memory built-in
6284 functions if the argument uses @code{sizeof}.  This warning triggers for
6285 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6286 an array, but a pointer, and suggests a possible fix, or about
6287 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6288 also warns about calls to bounded string copy functions like @code{strncat}
6289 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6290 the source array.  For example, in the following function the call to
6291 @code{strncat} specifies the size of the source string as the bound.  That
6292 is almost certainly a mistake and so the call is diagnosed.
6293 @smallexample
6294 void make_file (const char *name)
6296   char path[PATH_MAX];
6297   strncpy (path, name, sizeof path - 1);
6298   strncat (path, ".text", sizeof ".text");
6299   @dots{}
6301 @end smallexample
6303 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6305 @item -Wsizeof-array-argument
6306 @opindex Wsizeof-array-argument
6307 @opindex Wno-sizeof-array-argument
6308 Warn when the @code{sizeof} operator is applied to a parameter that is
6309 declared as an array in a function definition.  This warning is enabled by
6310 default for C and C++ programs.
6312 @item -Wmemset-elt-size
6313 @opindex Wmemset-elt-size
6314 @opindex Wno-memset-elt-size
6315 Warn for suspicious calls to the @code{memset} built-in function, if the
6316 first argument references an array, and the third argument is a number
6317 equal to the number of elements, but not equal to the size of the array
6318 in memory.  This indicates that the user has omitted a multiplication by
6319 the element size.  This warning is enabled by @option{-Wall}.
6321 @item -Wmemset-transposed-args
6322 @opindex Wmemset-transposed-args
6323 @opindex Wno-memset-transposed-args
6324 Warn for suspicious calls to the @code{memset} built-in function, if the
6325 second argument is not zero and the third argument is zero.  This warns e.g.@
6326 about @code{memset (buf, sizeof buf, 0)} where most probably
6327 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6328 is only emitted if the third argument is literal zero.  If it is some
6329 expression that is folded to zero, a cast of zero to some type, etc., 
6330 it is far less likely that the user has mistakenly exchanged the arguments 
6331 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6333 @item -Waddress
6334 @opindex Waddress
6335 @opindex Wno-address
6336 Warn about suspicious uses of memory addresses. These include using
6337 the address of a function in a conditional expression, such as
6338 @code{void func(void); if (func)}, and comparisons against the memory
6339 address of a string literal, such as @code{if (x == "abc")}.  Such
6340 uses typically indicate a programmer error: the address of a function
6341 always evaluates to true, so their use in a conditional usually
6342 indicate that the programmer forgot the parentheses in a function
6343 call; and comparisons against string literals result in unspecified
6344 behavior and are not portable in C, so they usually indicate that the
6345 programmer intended to use @code{strcmp}.  This warning is enabled by
6346 @option{-Wall}.
6348 @item -Wlogical-op
6349 @opindex Wlogical-op
6350 @opindex Wno-logical-op
6351 Warn about suspicious uses of logical operators in expressions.
6352 This includes using logical operators in contexts where a
6353 bit-wise operator is likely to be expected.  Also warns when
6354 the operands of a logical operator are the same:
6355 @smallexample
6356 extern int a;
6357 if (a < 0 && a < 0) @{ @dots{} @}
6358 @end smallexample
6360 @item -Wlogical-not-parentheses
6361 @opindex Wlogical-not-parentheses
6362 @opindex Wno-logical-not-parentheses
6363 Warn about logical not used on the left hand side operand of a comparison.
6364 This option does not warn if the right operand is considered to be a boolean
6365 expression.  Its purpose is to detect suspicious code like the following:
6366 @smallexample
6367 int a;
6368 @dots{}
6369 if (!a > 1) @{ @dots{} @}
6370 @end smallexample
6372 It is possible to suppress the warning by wrapping the LHS into
6373 parentheses:
6374 @smallexample
6375 if ((!a) > 1) @{ @dots{} @}
6376 @end smallexample
6378 This warning is enabled by @option{-Wall}.
6380 @item -Waggregate-return
6381 @opindex Waggregate-return
6382 @opindex Wno-aggregate-return
6383 Warn if any functions that return structures or unions are defined or
6384 called.  (In languages where you can return an array, this also elicits
6385 a warning.)
6387 @item -Wno-aggressive-loop-optimizations
6388 @opindex Wno-aggressive-loop-optimizations
6389 @opindex Waggressive-loop-optimizations
6390 Warn if in a loop with constant number of iterations the compiler detects
6391 undefined behavior in some statement during one or more of the iterations.
6393 @item -Wno-attributes
6394 @opindex Wno-attributes
6395 @opindex Wattributes
6396 Do not warn if an unexpected @code{__attribute__} is used, such as
6397 unrecognized attributes, function attributes applied to variables,
6398 etc.  This does not stop errors for incorrect use of supported
6399 attributes.
6401 @item -Wno-builtin-declaration-mismatch
6402 @opindex Wno-builtin-declaration-mismatch
6403 @opindex Wbuiltin-declaration-mismatch
6404 Warn if a built-in function is declared with the wrong signature or 
6405 as non-function.
6406 This warning is enabled by default.
6408 @item -Wno-builtin-macro-redefined
6409 @opindex Wno-builtin-macro-redefined
6410 @opindex Wbuiltin-macro-redefined
6411 Do not warn if certain built-in macros are redefined.  This suppresses
6412 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6413 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6415 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6416 @opindex Wstrict-prototypes
6417 @opindex Wno-strict-prototypes
6418 Warn if a function is declared or defined without specifying the
6419 argument types.  (An old-style function definition is permitted without
6420 a warning if preceded by a declaration that specifies the argument
6421 types.)
6423 @item -Wold-style-declaration @r{(C and Objective-C only)}
6424 @opindex Wold-style-declaration
6425 @opindex Wno-old-style-declaration
6426 Warn for obsolescent usages, according to the C Standard, in a
6427 declaration. For example, warn if storage-class specifiers like
6428 @code{static} are not the first things in a declaration.  This warning
6429 is also enabled by @option{-Wextra}.
6431 @item -Wold-style-definition @r{(C and Objective-C only)}
6432 @opindex Wold-style-definition
6433 @opindex Wno-old-style-definition
6434 Warn if an old-style function definition is used.  A warning is given
6435 even if there is a previous prototype.
6437 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6438 @opindex Wmissing-parameter-type
6439 @opindex Wno-missing-parameter-type
6440 A function parameter is declared without a type specifier in K&R-style
6441 functions:
6443 @smallexample
6444 void foo(bar) @{ @}
6445 @end smallexample
6447 This warning is also enabled by @option{-Wextra}.
6449 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6450 @opindex Wmissing-prototypes
6451 @opindex Wno-missing-prototypes
6452 Warn if a global function is defined without a previous prototype
6453 declaration.  This warning is issued even if the definition itself
6454 provides a prototype.  Use this option to detect global functions
6455 that do not have a matching prototype declaration in a header file.
6456 This option is not valid for C++ because all function declarations
6457 provide prototypes and a non-matching declaration declares an
6458 overload rather than conflict with an earlier declaration.
6459 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6461 @item -Wmissing-declarations
6462 @opindex Wmissing-declarations
6463 @opindex Wno-missing-declarations
6464 Warn if a global function is defined without a previous declaration.
6465 Do so even if the definition itself provides a prototype.
6466 Use this option to detect global functions that are not declared in
6467 header files.  In C, no warnings are issued for functions with previous
6468 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6469 missing prototypes.  In C++, no warnings are issued for function templates,
6470 or for inline functions, or for functions in anonymous namespaces.
6472 @item -Wmissing-field-initializers
6473 @opindex Wmissing-field-initializers
6474 @opindex Wno-missing-field-initializers
6475 @opindex W
6476 @opindex Wextra
6477 @opindex Wno-extra
6478 Warn if a structure's initializer has some fields missing.  For
6479 example, the following code causes such a warning, because
6480 @code{x.h} is implicitly zero:
6482 @smallexample
6483 struct s @{ int f, g, h; @};
6484 struct s x = @{ 3, 4 @};
6485 @end smallexample
6487 This option does not warn about designated initializers, so the following
6488 modification does not trigger a warning:
6490 @smallexample
6491 struct s @{ int f, g, h; @};
6492 struct s x = @{ .f = 3, .g = 4 @};
6493 @end smallexample
6495 In C this option does not warn about the universal zero initializer
6496 @samp{@{ 0 @}}:
6498 @smallexample
6499 struct s @{ int f, g, h; @};
6500 struct s x = @{ 0 @};
6501 @end smallexample
6503 Likewise, in C++ this option does not warn about the empty @{ @}
6504 initializer, for example:
6506 @smallexample
6507 struct s @{ int f, g, h; @};
6508 s x = @{ @};
6509 @end smallexample
6511 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6512 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6514 @item -Wno-multichar
6515 @opindex Wno-multichar
6516 @opindex Wmultichar
6517 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6518 Usually they indicate a typo in the user's code, as they have
6519 implementation-defined values, and should not be used in portable code.
6521 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6522 @opindex Wnormalized=
6523 @opindex Wnormalized
6524 @opindex Wno-normalized
6525 @cindex NFC
6526 @cindex NFKC
6527 @cindex character set, input normalization
6528 In ISO C and ISO C++, two identifiers are different if they are
6529 different sequences of characters.  However, sometimes when characters
6530 outside the basic ASCII character set are used, you can have two
6531 different character sequences that look the same.  To avoid confusion,
6532 the ISO 10646 standard sets out some @dfn{normalization rules} which
6533 when applied ensure that two sequences that look the same are turned into
6534 the same sequence.  GCC can warn you if you are using identifiers that
6535 have not been normalized; this option controls that warning.
6537 There are four levels of warning supported by GCC@.  The default is
6538 @option{-Wnormalized=nfc}, which warns about any identifier that is
6539 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6540 recommended form for most uses.  It is equivalent to
6541 @option{-Wnormalized}.
6543 Unfortunately, there are some characters allowed in identifiers by
6544 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6545 identifiers.  That is, there's no way to use these symbols in portable
6546 ISO C or C++ and have all your identifiers in NFC@.
6547 @option{-Wnormalized=id} suppresses the warning for these characters.
6548 It is hoped that future versions of the standards involved will correct
6549 this, which is why this option is not the default.
6551 You can switch the warning off for all characters by writing
6552 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6553 only do this if you are using some other normalization scheme (like
6554 ``D''), because otherwise you can easily create bugs that are
6555 literally impossible to see.
6557 Some characters in ISO 10646 have distinct meanings but look identical
6558 in some fonts or display methodologies, especially once formatting has
6559 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6560 LETTER N'', displays just like a regular @code{n} that has been
6561 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6562 normalization scheme to convert all these into a standard form as
6563 well, and GCC warns if your code is not in NFKC if you use
6564 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6565 about every identifier that contains the letter O because it might be
6566 confused with the digit 0, and so is not the default, but may be
6567 useful as a local coding convention if the programming environment 
6568 cannot be fixed to display these characters distinctly.
6570 @item -Wno-deprecated
6571 @opindex Wno-deprecated
6572 @opindex Wdeprecated
6573 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6575 @item -Wno-deprecated-declarations
6576 @opindex Wno-deprecated-declarations
6577 @opindex Wdeprecated-declarations
6578 Do not warn about uses of functions (@pxref{Function Attributes}),
6579 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6580 Attributes}) marked as deprecated by using the @code{deprecated}
6581 attribute.
6583 @item -Wno-overflow
6584 @opindex Wno-overflow
6585 @opindex Woverflow
6586 Do not warn about compile-time overflow in constant expressions.
6588 @item -Wno-odr
6589 @opindex Wno-odr
6590 @opindex Wodr
6591 Warn about One Definition Rule violations during link-time optimization.
6592 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6594 @item -Wopenmp-simd
6595 @opindex Wopenm-simd
6596 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6597 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6598 option can be used to relax the cost model.
6600 @item -Woverride-init @r{(C and Objective-C only)}
6601 @opindex Woverride-init
6602 @opindex Wno-override-init
6603 @opindex W
6604 @opindex Wextra
6605 @opindex Wno-extra
6606 Warn if an initialized field without side effects is overridden when
6607 using designated initializers (@pxref{Designated Inits, , Designated
6608 Initializers}).
6610 This warning is included in @option{-Wextra}.  To get other
6611 @option{-Wextra} warnings without this one, use @option{-Wextra
6612 -Wno-override-init}.
6614 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6615 @opindex Woverride-init-side-effects
6616 @opindex Wno-override-init-side-effects
6617 Warn if an initialized field with side effects is overridden when
6618 using designated initializers (@pxref{Designated Inits, , Designated
6619 Initializers}).  This warning is enabled by default.
6621 @item -Wpacked
6622 @opindex Wpacked
6623 @opindex Wno-packed
6624 Warn if a structure is given the packed attribute, but the packed
6625 attribute has no effect on the layout or size of the structure.
6626 Such structures may be mis-aligned for little benefit.  For
6627 instance, in this code, the variable @code{f.x} in @code{struct bar}
6628 is misaligned even though @code{struct bar} does not itself
6629 have the packed attribute:
6631 @smallexample
6632 @group
6633 struct foo @{
6634   int x;
6635   char a, b, c, d;
6636 @} __attribute__((packed));
6637 struct bar @{
6638   char z;
6639   struct foo f;
6641 @end group
6642 @end smallexample
6644 @item -Wpacked-bitfield-compat
6645 @opindex Wpacked-bitfield-compat
6646 @opindex Wno-packed-bitfield-compat
6647 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6648 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6649 the change can lead to differences in the structure layout.  GCC
6650 informs you when the offset of such a field has changed in GCC 4.4.
6651 For example there is no longer a 4-bit padding between field @code{a}
6652 and @code{b} in this structure:
6654 @smallexample
6655 struct foo
6657   char a:4;
6658   char b:8;
6659 @} __attribute__ ((packed));
6660 @end smallexample
6662 This warning is enabled by default.  Use
6663 @option{-Wno-packed-bitfield-compat} to disable this warning.
6665 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6666 @opindex Wpacked-not-aligned
6667 @opindex Wno-packed-not-aligned
6668 Warn if a structure field with explicitly specified alignment in a
6669 packed struct or union is misaligned.  For example, a warning will
6670 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6671 'struct S' is less than 8}, in this code:
6673 @smallexample
6674 @group
6675 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6676 struct __attribute__ ((packed)) S @{
6677   struct S8 s8;
6679 @end group
6680 @end smallexample
6682 This warning is enabled by @option{-Wall}.
6684 @item -Wpadded
6685 @opindex Wpadded
6686 @opindex Wno-padded
6687 Warn if padding is included in a structure, either to align an element
6688 of the structure or to align the whole structure.  Sometimes when this
6689 happens it is possible to rearrange the fields of the structure to
6690 reduce the padding and so make the structure smaller.
6692 @item -Wredundant-decls
6693 @opindex Wredundant-decls
6694 @opindex Wno-redundant-decls
6695 Warn if anything is declared more than once in the same scope, even in
6696 cases where multiple declaration is valid and changes nothing.
6698 @item -Wrestrict
6699 @opindex Wrestrict
6700 @opindex Wno-restrict
6701 Warn when an argument passed to a restrict-qualified parameter
6702 aliases with another argument.
6704 @item -Wnested-externs @r{(C and Objective-C only)}
6705 @opindex Wnested-externs
6706 @opindex Wno-nested-externs
6707 Warn if an @code{extern} declaration is encountered within a function.
6709 @item -Wno-inherited-variadic-ctor
6710 @opindex Winherited-variadic-ctor
6711 @opindex Wno-inherited-variadic-ctor
6712 Suppress warnings about use of C++11 inheriting constructors when the
6713 base class inherited from has a C variadic constructor; the warning is
6714 on by default because the ellipsis is not inherited.
6716 @item -Winline
6717 @opindex Winline
6718 @opindex Wno-inline
6719 Warn if a function that is declared as inline cannot be inlined.
6720 Even with this option, the compiler does not warn about failures to
6721 inline functions declared in system headers.
6723 The compiler uses a variety of heuristics to determine whether or not
6724 to inline a function.  For example, the compiler takes into account
6725 the size of the function being inlined and the amount of inlining
6726 that has already been done in the current function.  Therefore,
6727 seemingly insignificant changes in the source program can cause the
6728 warnings produced by @option{-Winline} to appear or disappear.
6730 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6731 @opindex Wno-invalid-offsetof
6732 @opindex Winvalid-offsetof
6733 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6734 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6735 to a non-standard-layout type is undefined.  In existing C++ implementations,
6736 however, @code{offsetof} typically gives meaningful results.
6737 This flag is for users who are aware that they are
6738 writing nonportable code and who have deliberately chosen to ignore the
6739 warning about it.
6741 The restrictions on @code{offsetof} may be relaxed in a future version
6742 of the C++ standard.
6744 @item -Wint-in-bool-context
6745 @opindex Wint-in-bool-context
6746 @opindex Wno-int-in-bool-context
6747 Warn for suspicious use of integer values where boolean values are expected,
6748 such as conditional expressions (?:) using non-boolean integer constants in
6749 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6750 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6751 for all kinds of multiplications regardless of the data type.
6752 This warning is enabled by @option{-Wall}.
6754 @item -Wno-int-to-pointer-cast
6755 @opindex Wno-int-to-pointer-cast
6756 @opindex Wint-to-pointer-cast
6757 Suppress warnings from casts to pointer type of an integer of a
6758 different size. In C++, casting to a pointer type of smaller size is
6759 an error. @option{Wint-to-pointer-cast} is enabled by default.
6762 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6763 @opindex Wno-pointer-to-int-cast
6764 @opindex Wpointer-to-int-cast
6765 Suppress warnings from casts from a pointer to an integer type of a
6766 different size.
6768 @item -Winvalid-pch
6769 @opindex Winvalid-pch
6770 @opindex Wno-invalid-pch
6771 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6772 the search path but cannot be used.
6774 @item -Wlong-long
6775 @opindex Wlong-long
6776 @opindex Wno-long-long
6777 Warn if @code{long long} type is used.  This is enabled by either
6778 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6779 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6781 @item -Wvariadic-macros
6782 @opindex Wvariadic-macros
6783 @opindex Wno-variadic-macros
6784 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6785 alternate syntax is used in ISO C99 mode.  This is enabled by either
6786 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6787 messages, use @option{-Wno-variadic-macros}.
6789 @item -Wvarargs
6790 @opindex Wvarargs
6791 @opindex Wno-varargs
6792 Warn upon questionable usage of the macros used to handle variable
6793 arguments like @code{va_start}.  This is default.  To inhibit the
6794 warning messages, use @option{-Wno-varargs}.
6796 @item -Wvector-operation-performance
6797 @opindex Wvector-operation-performance
6798 @opindex Wno-vector-operation-performance
6799 Warn if vector operation is not implemented via SIMD capabilities of the
6800 architecture.  Mainly useful for the performance tuning.
6801 Vector operation can be implemented @code{piecewise}, which means that the
6802 scalar operation is performed on every vector element; 
6803 @code{in parallel}, which means that the vector operation is implemented
6804 using scalars of wider type, which normally is more performance efficient;
6805 and @code{as a single scalar}, which means that vector fits into a
6806 scalar type.
6808 @item -Wno-virtual-move-assign
6809 @opindex Wvirtual-move-assign
6810 @opindex Wno-virtual-move-assign
6811 Suppress warnings about inheriting from a virtual base with a
6812 non-trivial C++11 move assignment operator.  This is dangerous because
6813 if the virtual base is reachable along more than one path, it is
6814 moved multiple times, which can mean both objects end up in the
6815 moved-from state.  If the move assignment operator is written to avoid
6816 moving from a moved-from object, this warning can be disabled.
6818 @item -Wvla
6819 @opindex Wvla
6820 @opindex Wno-vla
6821 Warn if a variable-length array is used in the code.
6822 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6823 the variable-length array.
6825 @item -Wvla-larger-than=@var{n}
6826 If this option is used, the compiler will warn on uses of
6827 variable-length arrays where the size is either unbounded, or bounded
6828 by an argument that can be larger than @var{n} bytes.  This is similar
6829 to how @option{-Walloca-larger-than=@var{n}} works, but with
6830 variable-length arrays.
6832 Note that GCC may optimize small variable-length arrays of a known
6833 value into plain arrays, so this warning may not get triggered for
6834 such arrays.
6836 This warning is not enabled by @option{-Wall}, and is only active when
6837 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6839 See also @option{-Walloca-larger-than=@var{n}}.
6841 @item -Wvolatile-register-var
6842 @opindex Wvolatile-register-var
6843 @opindex Wno-volatile-register-var
6844 Warn if a register variable is declared volatile.  The volatile
6845 modifier does not inhibit all optimizations that may eliminate reads
6846 and/or writes to register variables.  This warning is enabled by
6847 @option{-Wall}.
6849 @item -Wdisabled-optimization
6850 @opindex Wdisabled-optimization
6851 @opindex Wno-disabled-optimization
6852 Warn if a requested optimization pass is disabled.  This warning does
6853 not generally indicate that there is anything wrong with your code; it
6854 merely indicates that GCC's optimizers are unable to handle the code
6855 effectively.  Often, the problem is that your code is too big or too
6856 complex; GCC refuses to optimize programs when the optimization
6857 itself is likely to take inordinate amounts of time.
6859 @item -Wpointer-sign @r{(C and Objective-C only)}
6860 @opindex Wpointer-sign
6861 @opindex Wno-pointer-sign
6862 Warn for pointer argument passing or assignment with different signedness.
6863 This option is only supported for C and Objective-C@.  It is implied by
6864 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6865 @option{-Wno-pointer-sign}.
6867 @item -Wstack-protector
6868 @opindex Wstack-protector
6869 @opindex Wno-stack-protector
6870 This option is only active when @option{-fstack-protector} is active.  It
6871 warns about functions that are not protected against stack smashing.
6873 @item -Woverlength-strings
6874 @opindex Woverlength-strings
6875 @opindex Wno-overlength-strings
6876 Warn about string constants that are longer than the ``minimum
6877 maximum'' length specified in the C standard.  Modern compilers
6878 generally allow string constants that are much longer than the
6879 standard's minimum limit, but very portable programs should avoid
6880 using longer strings.
6882 The limit applies @emph{after} string constant concatenation, and does
6883 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6884 C99, it was raised to 4095.  C++98 does not specify a normative
6885 minimum maximum, so we do not diagnose overlength strings in C++@.
6887 This option is implied by @option{-Wpedantic}, and can be disabled with
6888 @option{-Wno-overlength-strings}.
6890 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6891 @opindex Wunsuffixed-float-constants
6893 Issue a warning for any floating constant that does not have
6894 a suffix.  When used together with @option{-Wsystem-headers} it
6895 warns about such constants in system header files.  This can be useful
6896 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6897 from the decimal floating-point extension to C99.
6899 @item -Wno-designated-init @r{(C and Objective-C only)}
6900 Suppress warnings when a positional initializer is used to initialize
6901 a structure that has been marked with the @code{designated_init}
6902 attribute.
6904 @item -Whsa
6905 Issue a warning when HSAIL cannot be emitted for the compiled function or
6906 OpenMP construct.
6908 @end table
6910 @node Debugging Options
6911 @section Options for Debugging Your Program
6912 @cindex options, debugging
6913 @cindex debugging information options
6915 To tell GCC to emit extra information for use by a debugger, in almost 
6916 all cases you need only to add @option{-g} to your other options.
6918 GCC allows you to use @option{-g} with
6919 @option{-O}.  The shortcuts taken by optimized code may occasionally
6920 be surprising: some variables you declared may not exist
6921 at all; flow of control may briefly move where you did not expect it;
6922 some statements may not be executed because they compute constant
6923 results or their values are already at hand; some statements may
6924 execute in different places because they have been moved out of loops.
6925 Nevertheless it is possible to debug optimized output.  This makes
6926 it reasonable to use the optimizer for programs that might have bugs.
6928 If you are not using some other optimization option, consider
6929 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6930 With no @option{-O} option at all, some compiler passes that collect
6931 information useful for debugging do not run at all, so that
6932 @option{-Og} may result in a better debugging experience.
6934 @table @gcctabopt
6935 @item -g
6936 @opindex g
6937 Produce debugging information in the operating system's native format
6938 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6939 information.
6941 On most systems that use stabs format, @option{-g} enables use of extra
6942 debugging information that only GDB can use; this extra information
6943 makes debugging work better in GDB but probably makes other debuggers
6944 crash or
6945 refuse to read the program.  If you want to control for certain whether
6946 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6947 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6949 @item -ggdb
6950 @opindex ggdb
6951 Produce debugging information for use by GDB@.  This means to use the
6952 most expressive format available (DWARF, stabs, or the native format
6953 if neither of those are supported), including GDB extensions if at all
6954 possible.
6956 @item -gdwarf
6957 @itemx -gdwarf-@var{version}
6958 @opindex gdwarf
6959 Produce debugging information in DWARF format (if that is supported).
6960 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6961 for most targets is 4.  DWARF Version 5 is only experimental.
6963 Note that with DWARF Version 2, some ports require and always
6964 use some non-conflicting DWARF 3 extensions in the unwind tables.
6966 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6967 for maximum benefit.
6969 GCC no longer supports DWARF Version 1, which is substantially
6970 different than Version 2 and later.  For historical reasons, some
6971 other DWARF-related options such as
6972 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6973 in their names, but apply to all currently-supported versions of DWARF.
6975 @item -gstabs
6976 @opindex gstabs
6977 Produce debugging information in stabs format (if that is supported),
6978 without GDB extensions.  This is the format used by DBX on most BSD
6979 systems.  On MIPS, Alpha and System V Release 4 systems this option
6980 produces stabs debugging output that is not understood by DBX@.
6981 On System V Release 4 systems this option requires the GNU assembler.
6983 @item -gstabs+
6984 @opindex gstabs+
6985 Produce debugging information in stabs format (if that is supported),
6986 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6987 use of these extensions is likely to make other debuggers crash or
6988 refuse to read the program.
6990 @item -gxcoff
6991 @opindex gxcoff
6992 Produce debugging information in XCOFF format (if that is supported).
6993 This is the format used by the DBX debugger on IBM RS/6000 systems.
6995 @item -gxcoff+
6996 @opindex gxcoff+
6997 Produce debugging information in XCOFF format (if that is supported),
6998 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6999 use of these extensions is likely to make other debuggers crash or
7000 refuse to read the program, and may cause assemblers other than the GNU
7001 assembler (GAS) to fail with an error.
7003 @item -gvms
7004 @opindex gvms
7005 Produce debugging information in Alpha/VMS debug format (if that is
7006 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7008 @item -g@var{level}
7009 @itemx -ggdb@var{level}
7010 @itemx -gstabs@var{level}
7011 @itemx -gxcoff@var{level}
7012 @itemx -gvms@var{level}
7013 Request debugging information and also use @var{level} to specify how
7014 much information.  The default level is 2.
7016 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7017 @option{-g}.
7019 Level 1 produces minimal information, enough for making backtraces in
7020 parts of the program that you don't plan to debug.  This includes
7021 descriptions of functions and external variables, and line number
7022 tables, but no information about local variables.
7024 Level 3 includes extra information, such as all the macro definitions
7025 present in the program.  Some debuggers support macro expansion when
7026 you use @option{-g3}.
7028 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7029 confusion with @option{-gdwarf-@var{level}}.
7030 Instead use an additional @option{-g@var{level}} option to change the
7031 debug level for DWARF.
7033 @item -feliminate-unused-debug-symbols
7034 @opindex feliminate-unused-debug-symbols
7035 Produce debugging information in stabs format (if that is supported),
7036 for only symbols that are actually used.
7038 @item -femit-class-debug-always
7039 @opindex femit-class-debug-always
7040 Instead of emitting debugging information for a C++ class in only one
7041 object file, emit it in all object files using the class.  This option
7042 should be used only with debuggers that are unable to handle the way GCC
7043 normally emits debugging information for classes because using this
7044 option increases the size of debugging information by as much as a
7045 factor of two.
7047 @item -fno-merge-debug-strings
7048 @opindex fmerge-debug-strings
7049 @opindex fno-merge-debug-strings
7050 Direct the linker to not merge together strings in the debugging
7051 information that are identical in different object files.  Merging is
7052 not supported by all assemblers or linkers.  Merging decreases the size
7053 of the debug information in the output file at the cost of increasing
7054 link processing time.  Merging is enabled by default.
7056 @item -fdebug-prefix-map=@var{old}=@var{new}
7057 @opindex fdebug-prefix-map
7058 When compiling files in directory @file{@var{old}}, record debugging
7059 information describing them as in @file{@var{new}} instead.  This can be
7060 used to replace a build-time path with an install-time path in the debug info.
7061 It can also be used to change an absolute path to a relative path by using
7062 @file{.} for @var{new}.  This can give more reproducible builds, which are
7063 location independent, but may require an extra command to tell GDB where to
7064 find the source files.
7066 @item -fvar-tracking
7067 @opindex fvar-tracking
7068 Run variable tracking pass.  It computes where variables are stored at each
7069 position in code.  Better debugging information is then generated
7070 (if the debugging information format supports this information).
7072 It is enabled by default when compiling with optimization (@option{-Os},
7073 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7074 the debug info format supports it.
7076 @item -fvar-tracking-assignments
7077 @opindex fvar-tracking-assignments
7078 @opindex fno-var-tracking-assignments
7079 Annotate assignments to user variables early in the compilation and
7080 attempt to carry the annotations over throughout the compilation all the
7081 way to the end, in an attempt to improve debug information while
7082 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7084 It can be enabled even if var-tracking is disabled, in which case
7085 annotations are created and maintained, but discarded at the end.
7086 By default, this flag is enabled together with @option{-fvar-tracking},
7087 except when selective scheduling is enabled.
7089 @item -gsplit-dwarf
7090 @opindex gsplit-dwarf
7091 Separate as much DWARF debugging information as possible into a
7092 separate output file with the extension @file{.dwo}.  This option allows
7093 the build system to avoid linking files with debug information.  To
7094 be useful, this option requires a debugger capable of reading @file{.dwo}
7095 files.
7097 @item -gpubnames
7098 @opindex gpubnames
7099 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7101 @item -ggnu-pubnames
7102 @opindex ggnu-pubnames
7103 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7104 suitable for conversion into a GDB@ index.  This option is only useful
7105 with a linker that can produce GDB@ index version 7.
7107 @item -fdebug-types-section
7108 @opindex fdebug-types-section
7109 @opindex fno-debug-types-section
7110 When using DWARF Version 4 or higher, type DIEs can be put into
7111 their own @code{.debug_types} section instead of making them part of the
7112 @code{.debug_info} section.  It is more efficient to put them in a separate
7113 comdat sections since the linker can then remove duplicates.
7114 But not all DWARF consumers support @code{.debug_types} sections yet
7115 and on some objects @code{.debug_types} produces larger instead of smaller
7116 debugging information.
7118 @item -grecord-gcc-switches
7119 @item -gno-record-gcc-switches
7120 @opindex grecord-gcc-switches
7121 @opindex gno-record-gcc-switches
7122 This switch causes the command-line options used to invoke the
7123 compiler that may affect code generation to be appended to the
7124 DW_AT_producer attribute in DWARF debugging information.  The options
7125 are concatenated with spaces separating them from each other and from
7126 the compiler version.  
7127 It is enabled by default.
7128 See also @option{-frecord-gcc-switches} for another
7129 way of storing compiler options into the object file.  
7131 @item -gstrict-dwarf
7132 @opindex gstrict-dwarf
7133 Disallow using extensions of later DWARF standard version than selected
7134 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7135 DWARF extensions from later standard versions is allowed.
7137 @item -gno-strict-dwarf
7138 @opindex gno-strict-dwarf
7139 Allow using extensions of later DWARF standard version than selected with
7140 @option{-gdwarf-@var{version}}.
7142 @item -gcolumn-info
7143 @item -gno-column-info
7144 @opindex gcolumn-info
7145 @opindex gno-column-info
7146 Emit location column information into DWARF debugging information, rather
7147 than just file and line.
7148 This option is enabled by default.
7150 @item -gstatement-frontiers
7151 @item -gno-statement-frontiers
7152 @opindex gstatement-frontiers
7153 @opindex gno-statement-frontiers
7154 This option causes GCC to create markers in the internal representation
7155 at the beginning of statements, and to keep them roughly in place
7156 throughout compilation, using them to guide the output of @code{is_stmt}
7157 markers in the line number table.  This is enabled by default when
7158 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7159 @dots{}), and outputting DWARF 2 debug information at the normal level.
7161 @item -gz@r{[}=@var{type}@r{]}
7162 @opindex gz
7163 Produce compressed debug sections in DWARF format, if that is supported.
7164 If @var{type} is not given, the default type depends on the capabilities
7165 of the assembler and linker used.  @var{type} may be one of
7166 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7167 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7168 compression in traditional GNU format).  If the linker doesn't support
7169 writing compressed debug sections, the option is rejected.  Otherwise,
7170 if the assembler does not support them, @option{-gz} is silently ignored
7171 when producing object files.
7173 @item -femit-struct-debug-baseonly
7174 @opindex femit-struct-debug-baseonly
7175 Emit debug information for struct-like types
7176 only when the base name of the compilation source file
7177 matches the base name of file in which the struct is defined.
7179 This option substantially reduces the size of debugging information,
7180 but at significant potential loss in type information to the debugger.
7181 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7182 See @option{-femit-struct-debug-detailed} for more detailed control.
7184 This option works only with DWARF debug output.
7186 @item -femit-struct-debug-reduced
7187 @opindex femit-struct-debug-reduced
7188 Emit debug information for struct-like types
7189 only when the base name of the compilation source file
7190 matches the base name of file in which the type is defined,
7191 unless the struct is a template or defined in a system header.
7193 This option significantly reduces the size of debugging information,
7194 with some potential loss in type information to the debugger.
7195 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7196 See @option{-femit-struct-debug-detailed} for more detailed control.
7198 This option works only with DWARF debug output.
7200 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7201 @opindex femit-struct-debug-detailed
7202 Specify the struct-like types
7203 for which the compiler generates debug information.
7204 The intent is to reduce duplicate struct debug information
7205 between different object files within the same program.
7207 This option is a detailed version of
7208 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7209 which serves for most needs.
7211 A specification has the syntax@*
7212 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7214 The optional first word limits the specification to
7215 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7216 A struct type is used directly when it is the type of a variable, member.
7217 Indirect uses arise through pointers to structs.
7218 That is, when use of an incomplete struct is valid, the use is indirect.
7219 An example is
7220 @samp{struct one direct; struct two * indirect;}.
7222 The optional second word limits the specification to
7223 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7224 Generic structs are a bit complicated to explain.
7225 For C++, these are non-explicit specializations of template classes,
7226 or non-template classes within the above.
7227 Other programming languages have generics,
7228 but @option{-femit-struct-debug-detailed} does not yet implement them.
7230 The third word specifies the source files for those
7231 structs for which the compiler should emit debug information.
7232 The values @samp{none} and @samp{any} have the normal meaning.
7233 The value @samp{base} means that
7234 the base of name of the file in which the type declaration appears
7235 must match the base of the name of the main compilation file.
7236 In practice, this means that when compiling @file{foo.c}, debug information
7237 is generated for types declared in that file and @file{foo.h},
7238 but not other header files.
7239 The value @samp{sys} means those types satisfying @samp{base}
7240 or declared in system or compiler headers.
7242 You may need to experiment to determine the best settings for your application.
7244 The default is @option{-femit-struct-debug-detailed=all}.
7246 This option works only with DWARF debug output.
7248 @item -fno-dwarf2-cfi-asm
7249 @opindex fdwarf2-cfi-asm
7250 @opindex fno-dwarf2-cfi-asm
7251 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7252 instead of using GAS @code{.cfi_*} directives.
7254 @item -fno-eliminate-unused-debug-types
7255 @opindex feliminate-unused-debug-types
7256 @opindex fno-eliminate-unused-debug-types
7257 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7258 output for types that are nowhere used in the source file being compiled.
7259 Sometimes it is useful to have GCC emit debugging
7260 information for all types declared in a compilation
7261 unit, regardless of whether or not they are actually used
7262 in that compilation unit, for example 
7263 if, in the debugger, you want to cast a value to a type that is
7264 not actually used in your program (but is declared).  More often,
7265 however, this results in a significant amount of wasted space.
7266 @end table
7268 @node Optimize Options
7269 @section Options That Control Optimization
7270 @cindex optimize options
7271 @cindex options, optimization
7273 These options control various sorts of optimizations.
7275 Without any optimization option, the compiler's goal is to reduce the
7276 cost of compilation and to make debugging produce the expected
7277 results.  Statements are independent: if you stop the program with a
7278 breakpoint between statements, you can then assign a new value to any
7279 variable or change the program counter to any other statement in the
7280 function and get exactly the results you expect from the source
7281 code.
7283 Turning on optimization flags makes the compiler attempt to improve
7284 the performance and/or code size at the expense of compilation time
7285 and possibly the ability to debug the program.
7287 The compiler performs optimization based on the knowledge it has of the
7288 program.  Compiling multiple files at once to a single output file mode allows
7289 the compiler to use information gained from all of the files when compiling
7290 each of them.
7292 Not all optimizations are controlled directly by a flag.  Only
7293 optimizations that have a flag are listed in this section.
7295 Most optimizations are only enabled if an @option{-O} level is set on
7296 the command line.  Otherwise they are disabled, even if individual
7297 optimization flags are specified.
7299 Depending on the target and how GCC was configured, a slightly different
7300 set of optimizations may be enabled at each @option{-O} level than
7301 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7302 to find out the exact set of optimizations that are enabled at each level.
7303 @xref{Overall Options}, for examples.
7305 @table @gcctabopt
7306 @item -O
7307 @itemx -O1
7308 @opindex O
7309 @opindex O1
7310 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7311 more memory for a large function.
7313 With @option{-O}, the compiler tries to reduce code size and execution
7314 time, without performing any optimizations that take a great deal of
7315 compilation time.
7317 @option{-O} turns on the following optimization flags:
7318 @gccoptlist{
7319 -fauto-inc-dec @gol
7320 -fbranch-count-reg @gol
7321 -fcombine-stack-adjustments @gol
7322 -fcompare-elim @gol
7323 -fcprop-registers @gol
7324 -fdce @gol
7325 -fdefer-pop @gol
7326 -fdelayed-branch @gol
7327 -fdse @gol
7328 -fforward-propagate @gol
7329 -fguess-branch-probability @gol
7330 -fif-conversion2 @gol
7331 -fif-conversion @gol
7332 -finline-functions-called-once @gol
7333 -fipa-pure-const @gol
7334 -fipa-profile @gol
7335 -fipa-reference @gol
7336 -fmerge-constants @gol
7337 -fmove-loop-invariants @gol
7338 -fomit-frame-pointer @gol
7339 -freorder-blocks @gol
7340 -fshrink-wrap @gol
7341 -fshrink-wrap-separate @gol
7342 -fsplit-wide-types @gol
7343 -fssa-backprop @gol
7344 -fssa-phiopt @gol
7345 -ftree-bit-ccp @gol
7346 -ftree-ccp @gol
7347 -ftree-ch @gol
7348 -ftree-coalesce-vars @gol
7349 -ftree-copy-prop @gol
7350 -ftree-dce @gol
7351 -ftree-dominator-opts @gol
7352 -ftree-dse @gol
7353 -ftree-forwprop @gol
7354 -ftree-fre @gol
7355 -ftree-phiprop @gol
7356 -ftree-sink @gol
7357 -ftree-slsr @gol
7358 -ftree-sra @gol
7359 -ftree-pta @gol
7360 -ftree-ter @gol
7361 -funit-at-a-time}
7363 @item -O2
7364 @opindex O2
7365 Optimize even more.  GCC performs nearly all supported optimizations
7366 that do not involve a space-speed tradeoff.
7367 As compared to @option{-O}, this option increases both compilation time
7368 and the performance of the generated code.
7370 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7371 also turns on the following optimization flags:
7372 @gccoptlist{-fthread-jumps @gol
7373 -falign-functions  -falign-jumps @gol
7374 -falign-loops  -falign-labels @gol
7375 -fcaller-saves @gol
7376 -fcrossjumping @gol
7377 -fcse-follow-jumps  -fcse-skip-blocks @gol
7378 -fdelete-null-pointer-checks @gol
7379 -fdevirtualize -fdevirtualize-speculatively @gol
7380 -fexpensive-optimizations @gol
7381 -fgcse  -fgcse-lm  @gol
7382 -fhoist-adjacent-loads @gol
7383 -finline-small-functions @gol
7384 -findirect-inlining @gol
7385 -fipa-cp @gol
7386 -fipa-bit-cp @gol
7387 -fipa-vrp @gol
7388 -fipa-sra @gol
7389 -fipa-icf @gol
7390 -fisolate-erroneous-paths-dereference @gol
7391 -flra-remat @gol
7392 -foptimize-sibling-calls @gol
7393 -foptimize-strlen @gol
7394 -fpartial-inlining @gol
7395 -fpeephole2 @gol
7396 -freorder-blocks-algorithm=stc @gol
7397 -freorder-blocks-and-partition -freorder-functions @gol
7398 -frerun-cse-after-loop  @gol
7399 -fsched-interblock  -fsched-spec @gol
7400 -fschedule-insns  -fschedule-insns2 @gol
7401 -fstore-merging @gol
7402 -fstrict-aliasing @gol
7403 -ftree-builtin-call-dce @gol
7404 -ftree-switch-conversion -ftree-tail-merge @gol
7405 -fcode-hoisting @gol
7406 -ftree-pre @gol
7407 -ftree-vrp @gol
7408 -fipa-ra}
7410 Please note the warning under @option{-fgcse} about
7411 invoking @option{-O2} on programs that use computed gotos.
7413 @item -O3
7414 @opindex O3
7415 Optimize yet more.  @option{-O3} turns on all optimizations specified
7416 by @option{-O2} and also turns on the following optimization flags:
7417 @gccoptlist{-finline-functions @gol
7418 -funswitch-loops @gol
7419 -fpredictive-commoning @gol
7420 -fgcse-after-reload @gol
7421 -ftree-loop-vectorize @gol
7422 -ftree-loop-distribution @gol
7423 -ftree-loop-distribute-patterns @gol
7424 -floop-interchange @gol
7425 -fsplit-paths @gol
7426 -ftree-slp-vectorize @gol
7427 -fvect-cost-model @gol
7428 -ftree-partial-pre @gol
7429 -fpeel-loops @gol
7430 -fipa-cp-clone}
7432 @item -O0
7433 @opindex O0
7434 Reduce compilation time and make debugging produce the expected
7435 results.  This is the default.
7437 @item -Os
7438 @opindex Os
7439 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7440 do not typically increase code size.  It also performs further
7441 optimizations designed to reduce code size.
7443 @option{-Os} disables the following optimization flags:
7444 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7445 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7446 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7448 @item -Ofast
7449 @opindex Ofast
7450 Disregard strict standards compliance.  @option{-Ofast} enables all
7451 @option{-O3} optimizations.  It also enables optimizations that are not
7452 valid for all standard-compliant programs.
7453 It turns on @option{-ffast-math} and the Fortran-specific
7454 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7455 specified, and @option{-fno-protect-parens}.
7457 @item -Og
7458 @opindex Og
7459 Optimize debugging experience.  @option{-Og} enables optimizations
7460 that do not interfere with debugging. It should be the optimization
7461 level of choice for the standard edit-compile-debug cycle, offering
7462 a reasonable level of optimization while maintaining fast compilation
7463 and a good debugging experience.
7464 @end table
7466 If you use multiple @option{-O} options, with or without level numbers,
7467 the last such option is the one that is effective.
7469 Options of the form @option{-f@var{flag}} specify machine-independent
7470 flags.  Most flags have both positive and negative forms; the negative
7471 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7472 below, only one of the forms is listed---the one you typically 
7473 use.  You can figure out the other form by either removing @samp{no-}
7474 or adding it.
7476 The following options control specific optimizations.  They are either
7477 activated by @option{-O} options or are related to ones that are.  You
7478 can use the following flags in the rare cases when ``fine-tuning'' of
7479 optimizations to be performed is desired.
7481 @table @gcctabopt
7482 @item -fno-defer-pop
7483 @opindex fno-defer-pop
7484 Always pop the arguments to each function call as soon as that function
7485 returns.  For machines that must pop arguments after a function call,
7486 the compiler normally lets arguments accumulate on the stack for several
7487 function calls and pops them all at once.
7489 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7491 @item -fforward-propagate
7492 @opindex fforward-propagate
7493 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7494 instructions and checks if the result can be simplified.  If loop unrolling
7495 is active, two passes are performed and the second is scheduled after
7496 loop unrolling.
7498 This option is enabled by default at optimization levels @option{-O},
7499 @option{-O2}, @option{-O3}, @option{-Os}.
7501 @item -ffp-contract=@var{style}
7502 @opindex ffp-contract
7503 @option{-ffp-contract=off} disables floating-point expression contraction.
7504 @option{-ffp-contract=fast} enables floating-point expression contraction
7505 such as forming of fused multiply-add operations if the target has
7506 native support for them.
7507 @option{-ffp-contract=on} enables floating-point expression contraction
7508 if allowed by the language standard.  This is currently not implemented
7509 and treated equal to @option{-ffp-contract=off}.
7511 The default is @option{-ffp-contract=fast}.
7513 @item -fomit-frame-pointer
7514 @opindex fomit-frame-pointer
7515 Omit the frame pointer in functions that don't need one.  This avoids the
7516 instructions to save, set up and restore the frame pointer; on many targets
7517 it also makes an extra register available.
7519 On some targets this flag has no effect because the standard calling sequence
7520 always uses a frame pointer, so it cannot be omitted.
7522 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7523 is used in all functions.  Several targets always omit the frame pointer in
7524 leaf functions.
7526 Enabled by default at @option{-O} and higher.
7528 @item -foptimize-sibling-calls
7529 @opindex foptimize-sibling-calls
7530 Optimize sibling and tail recursive calls.
7532 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7534 @item -foptimize-strlen
7535 @opindex foptimize-strlen
7536 Optimize various standard C string functions (e.g. @code{strlen},
7537 @code{strchr} or @code{strcpy}) and
7538 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7540 Enabled at levels @option{-O2}, @option{-O3}.
7542 @item -fno-inline
7543 @opindex fno-inline
7544 Do not expand any functions inline apart from those marked with
7545 the @code{always_inline} attribute.  This is the default when not
7546 optimizing.
7548 Single functions can be exempted from inlining by marking them
7549 with the @code{noinline} attribute.
7551 @item -finline-small-functions
7552 @opindex finline-small-functions
7553 Integrate functions into their callers when their body is smaller than expected
7554 function call code (so overall size of program gets smaller).  The compiler
7555 heuristically decides which functions are simple enough to be worth integrating
7556 in this way.  This inlining applies to all functions, even those not declared
7557 inline.
7559 Enabled at level @option{-O2}.
7561 @item -findirect-inlining
7562 @opindex findirect-inlining
7563 Inline also indirect calls that are discovered to be known at compile
7564 time thanks to previous inlining.  This option has any effect only
7565 when inlining itself is turned on by the @option{-finline-functions}
7566 or @option{-finline-small-functions} options.
7568 Enabled at level @option{-O2}.
7570 @item -finline-functions
7571 @opindex finline-functions
7572 Consider all functions for inlining, even if they are not declared inline.
7573 The compiler heuristically decides which functions are worth integrating
7574 in this way.
7576 If all calls to a given function are integrated, and the function is
7577 declared @code{static}, then the function is normally not output as
7578 assembler code in its own right.
7580 Enabled at level @option{-O3}.
7582 @item -finline-functions-called-once
7583 @opindex finline-functions-called-once
7584 Consider all @code{static} functions called once for inlining into their
7585 caller even if they are not marked @code{inline}.  If a call to a given
7586 function is integrated, then the function is not output as assembler code
7587 in its own right.
7589 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7591 @item -fearly-inlining
7592 @opindex fearly-inlining
7593 Inline functions marked by @code{always_inline} and functions whose body seems
7594 smaller than the function call overhead early before doing
7595 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7596 makes profiling significantly cheaper and usually inlining faster on programs
7597 having large chains of nested wrapper functions.
7599 Enabled by default.
7601 @item -fipa-sra
7602 @opindex fipa-sra
7603 Perform interprocedural scalar replacement of aggregates, removal of
7604 unused parameters and replacement of parameters passed by reference
7605 by parameters passed by value.
7607 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7609 @item -finline-limit=@var{n}
7610 @opindex finline-limit
7611 By default, GCC limits the size of functions that can be inlined.  This flag
7612 allows coarse control of this limit.  @var{n} is the size of functions that
7613 can be inlined in number of pseudo instructions.
7615 Inlining is actually controlled by a number of parameters, which may be
7616 specified individually by using @option{--param @var{name}=@var{value}}.
7617 The @option{-finline-limit=@var{n}} option sets some of these parameters
7618 as follows:
7620 @table @gcctabopt
7621 @item max-inline-insns-single
7622 is set to @var{n}/2.
7623 @item max-inline-insns-auto
7624 is set to @var{n}/2.
7625 @end table
7627 See below for a documentation of the individual
7628 parameters controlling inlining and for the defaults of these parameters.
7630 @emph{Note:} there may be no value to @option{-finline-limit} that results
7631 in default behavior.
7633 @emph{Note:} pseudo instruction represents, in this particular context, an
7634 abstract measurement of function's size.  In no way does it represent a count
7635 of assembly instructions and as such its exact meaning might change from one
7636 release to an another.
7638 @item -fno-keep-inline-dllexport
7639 @opindex fno-keep-inline-dllexport
7640 This is a more fine-grained version of @option{-fkeep-inline-functions},
7641 which applies only to functions that are declared using the @code{dllexport}
7642 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7643 Functions}.
7645 @item -fkeep-inline-functions
7646 @opindex fkeep-inline-functions
7647 In C, emit @code{static} functions that are declared @code{inline}
7648 into the object file, even if the function has been inlined into all
7649 of its callers.  This switch does not affect functions using the
7650 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7651 inline functions into the object file.
7653 @item -fkeep-static-functions
7654 @opindex fkeep-static-functions
7655 Emit @code{static} functions into the object file, even if the function
7656 is never used.
7658 @item -fkeep-static-consts
7659 @opindex fkeep-static-consts
7660 Emit variables declared @code{static const} when optimization isn't turned
7661 on, even if the variables aren't referenced.
7663 GCC enables this option by default.  If you want to force the compiler to
7664 check if a variable is referenced, regardless of whether or not
7665 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7667 @item -fmerge-constants
7668 @opindex fmerge-constants
7669 Attempt to merge identical constants (string constants and floating-point
7670 constants) across compilation units.
7672 This option is the default for optimized compilation if the assembler and
7673 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7674 behavior.
7676 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7678 @item -fmerge-all-constants
7679 @opindex fmerge-all-constants
7680 Attempt to merge identical constants and identical variables.
7682 This option implies @option{-fmerge-constants}.  In addition to
7683 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7684 arrays or initialized constant variables with integral or floating-point
7685 types.  Languages like C or C++ require each variable, including multiple
7686 instances of the same variable in recursive calls, to have distinct locations,
7687 so using this option results in non-conforming
7688 behavior.
7690 @item -fmodulo-sched
7691 @opindex fmodulo-sched
7692 Perform swing modulo scheduling immediately before the first scheduling
7693 pass.  This pass looks at innermost loops and reorders their
7694 instructions by overlapping different iterations.
7696 @item -fmodulo-sched-allow-regmoves
7697 @opindex fmodulo-sched-allow-regmoves
7698 Perform more aggressive SMS-based modulo scheduling with register moves
7699 allowed.  By setting this flag certain anti-dependences edges are
7700 deleted, which triggers the generation of reg-moves based on the
7701 life-range analysis.  This option is effective only with
7702 @option{-fmodulo-sched} enabled.
7704 @item -fno-branch-count-reg
7705 @opindex fno-branch-count-reg
7706 Avoid running a pass scanning for opportunities to use ``decrement and
7707 branch'' instructions on a count register instead of generating sequences
7708 of instructions that decrement a register, compare it against zero, and
7709 then branch based upon the result.  This option is only meaningful on
7710 architectures that support such instructions, which include x86, PowerPC,
7711 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7712 doesn't remove the decrement and branch instructions from the generated
7713 instruction stream introduced by other optimization passes.
7715 Enabled by default at @option{-O1} and higher.
7717 The default is @option{-fbranch-count-reg}.
7719 @item -fno-function-cse
7720 @opindex fno-function-cse
7721 Do not put function addresses in registers; make each instruction that
7722 calls a constant function contain the function's address explicitly.
7724 This option results in less efficient code, but some strange hacks
7725 that alter the assembler output may be confused by the optimizations
7726 performed when this option is not used.
7728 The default is @option{-ffunction-cse}
7730 @item -fno-zero-initialized-in-bss
7731 @opindex fno-zero-initialized-in-bss
7732 If the target supports a BSS section, GCC by default puts variables that
7733 are initialized to zero into BSS@.  This can save space in the resulting
7734 code.
7736 This option turns off this behavior because some programs explicitly
7737 rely on variables going to the data section---e.g., so that the
7738 resulting executable can find the beginning of that section and/or make
7739 assumptions based on that.
7741 The default is @option{-fzero-initialized-in-bss}.
7743 @item -fthread-jumps
7744 @opindex fthread-jumps
7745 Perform optimizations that check to see if a jump branches to a
7746 location where another comparison subsumed by the first is found.  If
7747 so, the first branch is redirected to either the destination of the
7748 second branch or a point immediately following it, depending on whether
7749 the condition is known to be true or false.
7751 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7753 @item -fsplit-wide-types
7754 @opindex fsplit-wide-types
7755 When using a type that occupies multiple registers, such as @code{long
7756 long} on a 32-bit system, split the registers apart and allocate them
7757 independently.  This normally generates better code for those types,
7758 but may make debugging more difficult.
7760 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7761 @option{-Os}.
7763 @item -fcse-follow-jumps
7764 @opindex fcse-follow-jumps
7765 In common subexpression elimination (CSE), scan through jump instructions
7766 when the target of the jump is not reached by any other path.  For
7767 example, when CSE encounters an @code{if} statement with an
7768 @code{else} clause, CSE follows the jump when the condition
7769 tested is false.
7771 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7773 @item -fcse-skip-blocks
7774 @opindex fcse-skip-blocks
7775 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7776 follow jumps that conditionally skip over blocks.  When CSE
7777 encounters a simple @code{if} statement with no else clause,
7778 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7779 body of the @code{if}.
7781 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7783 @item -frerun-cse-after-loop
7784 @opindex frerun-cse-after-loop
7785 Re-run common subexpression elimination after loop optimizations are
7786 performed.
7788 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7790 @item -fgcse
7791 @opindex fgcse
7792 Perform a global common subexpression elimination pass.
7793 This pass also performs global constant and copy propagation.
7795 @emph{Note:} When compiling a program using computed gotos, a GCC
7796 extension, you may get better run-time performance if you disable
7797 the global common subexpression elimination pass by adding
7798 @option{-fno-gcse} to the command line.
7800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7802 @item -fgcse-lm
7803 @opindex fgcse-lm
7804 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7805 attempts to move loads that are only killed by stores into themselves.  This
7806 allows a loop containing a load/store sequence to be changed to a load outside
7807 the loop, and a copy/store within the loop.
7809 Enabled by default when @option{-fgcse} is enabled.
7811 @item -fgcse-sm
7812 @opindex fgcse-sm
7813 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7814 global common subexpression elimination.  This pass attempts to move
7815 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7816 loops containing a load/store sequence can be changed to a load before
7817 the loop and a store after the loop.
7819 Not enabled at any optimization level.
7821 @item -fgcse-las
7822 @opindex fgcse-las
7823 When @option{-fgcse-las} is enabled, the global common subexpression
7824 elimination pass eliminates redundant loads that come after stores to the
7825 same memory location (both partial and full redundancies).
7827 Not enabled at any optimization level.
7829 @item -fgcse-after-reload
7830 @opindex fgcse-after-reload
7831 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7832 pass is performed after reload.  The purpose of this pass is to clean up
7833 redundant spilling.
7835 @item -faggressive-loop-optimizations
7836 @opindex faggressive-loop-optimizations
7837 This option tells the loop optimizer to use language constraints to
7838 derive bounds for the number of iterations of a loop.  This assumes that
7839 loop code does not invoke undefined behavior by for example causing signed
7840 integer overflows or out-of-bound array accesses.  The bounds for the
7841 number of iterations of a loop are used to guide loop unrolling and peeling
7842 and loop exit test optimizations.
7843 This option is enabled by default.
7845 @item -funconstrained-commons
7846 @opindex funconstrained-commons
7847 This option tells the compiler that variables declared in common blocks
7848 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7849 prevents certain optimizations that depend on knowing the array bounds.
7851 @item -fcrossjumping
7852 @opindex fcrossjumping
7853 Perform cross-jumping transformation.
7854 This transformation unifies equivalent code and saves code size.  The
7855 resulting code may or may not perform better than without cross-jumping.
7857 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7859 @item -fauto-inc-dec
7860 @opindex fauto-inc-dec
7861 Combine increments or decrements of addresses with memory accesses.
7862 This pass is always skipped on architectures that do not have
7863 instructions to support this.  Enabled by default at @option{-O} and
7864 higher on architectures that support this.
7866 @item -fdce
7867 @opindex fdce
7868 Perform dead code elimination (DCE) on RTL@.
7869 Enabled by default at @option{-O} and higher.
7871 @item -fdse
7872 @opindex fdse
7873 Perform dead store elimination (DSE) on RTL@.
7874 Enabled by default at @option{-O} and higher.
7876 @item -fif-conversion
7877 @opindex fif-conversion
7878 Attempt to transform conditional jumps into branch-less equivalents.  This
7879 includes use of conditional moves, min, max, set flags and abs instructions, and
7880 some tricks doable by standard arithmetics.  The use of conditional execution
7881 on chips where it is available is controlled by @option{-fif-conversion2}.
7883 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7885 @item -fif-conversion2
7886 @opindex fif-conversion2
7887 Use conditional execution (where available) to transform conditional jumps into
7888 branch-less equivalents.
7890 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7892 @item -fdeclone-ctor-dtor
7893 @opindex fdeclone-ctor-dtor
7894 The C++ ABI requires multiple entry points for constructors and
7895 destructors: one for a base subobject, one for a complete object, and
7896 one for a virtual destructor that calls operator delete afterwards.
7897 For a hierarchy with virtual bases, the base and complete variants are
7898 clones, which means two copies of the function.  With this option, the
7899 base and complete variants are changed to be thunks that call a common
7900 implementation.
7902 Enabled by @option{-Os}.
7904 @item -fdelete-null-pointer-checks
7905 @opindex fdelete-null-pointer-checks
7906 Assume that programs cannot safely dereference null pointers, and that
7907 no code or data element resides at address zero.
7908 This option enables simple constant
7909 folding optimizations at all optimization levels.  In addition, other
7910 optimization passes in GCC use this flag to control global dataflow
7911 analyses that eliminate useless checks for null pointers; these assume
7912 that a memory access to address zero always results in a trap, so
7913 that if a pointer is checked after it has already been dereferenced,
7914 it cannot be null.
7916 Note however that in some environments this assumption is not true.
7917 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7918 for programs that depend on that behavior.
7920 This option is enabled by default on most targets.  On Nios II ELF, it
7921 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7923 Passes that use the dataflow information
7924 are enabled independently at different optimization levels.
7926 @item -fdevirtualize
7927 @opindex fdevirtualize
7928 Attempt to convert calls to virtual functions to direct calls.  This
7929 is done both within a procedure and interprocedurally as part of
7930 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7931 propagation (@option{-fipa-cp}).
7932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7934 @item -fdevirtualize-speculatively
7935 @opindex fdevirtualize-speculatively
7936 Attempt to convert calls to virtual functions to speculative direct calls.
7937 Based on the analysis of the type inheritance graph, determine for a given call
7938 the set of likely targets. If the set is small, preferably of size 1, change
7939 the call into a conditional deciding between direct and indirect calls.  The
7940 speculative calls enable more optimizations, such as inlining.  When they seem
7941 useless after further optimization, they are converted back into original form.
7943 @item -fdevirtualize-at-ltrans
7944 @opindex fdevirtualize-at-ltrans
7945 Stream extra information needed for aggressive devirtualization when running
7946 the link-time optimizer in local transformation mode.  
7947 This option enables more devirtualization but
7948 significantly increases the size of streamed data. For this reason it is
7949 disabled by default.
7951 @item -fexpensive-optimizations
7952 @opindex fexpensive-optimizations
7953 Perform a number of minor optimizations that are relatively expensive.
7955 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7957 @item -free
7958 @opindex free
7959 Attempt to remove redundant extension instructions.  This is especially
7960 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7961 registers after writing to their lower 32-bit half.
7963 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7964 @option{-O3}, @option{-Os}.
7966 @item -fno-lifetime-dse
7967 @opindex fno-lifetime-dse
7968 In C++ the value of an object is only affected by changes within its
7969 lifetime: when the constructor begins, the object has an indeterminate
7970 value, and any changes during the lifetime of the object are dead when
7971 the object is destroyed.  Normally dead store elimination will take
7972 advantage of this; if your code relies on the value of the object
7973 storage persisting beyond the lifetime of the object, you can use this
7974 flag to disable this optimization.  To preserve stores before the
7975 constructor starts (e.g. because your operator new clears the object
7976 storage) but still treat the object as dead after the destructor you,
7977 can use @option{-flifetime-dse=1}.  The default behavior can be
7978 explicitly selected with @option{-flifetime-dse=2}.
7979 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7981 @item -flive-range-shrinkage
7982 @opindex flive-range-shrinkage
7983 Attempt to decrease register pressure through register live range
7984 shrinkage.  This is helpful for fast processors with small or moderate
7985 size register sets.
7987 @item -fira-algorithm=@var{algorithm}
7988 @opindex fira-algorithm
7989 Use the specified coloring algorithm for the integrated register
7990 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7991 specifies Chow's priority coloring, or @samp{CB}, which specifies
7992 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7993 for all architectures, but for those targets that do support it, it is
7994 the default because it generates better code.
7996 @item -fira-region=@var{region}
7997 @opindex fira-region
7998 Use specified regions for the integrated register allocator.  The
7999 @var{region} argument should be one of the following:
8001 @table @samp
8003 @item all
8004 Use all loops as register allocation regions.
8005 This can give the best results for machines with a small and/or
8006 irregular register set.
8008 @item mixed
8009 Use all loops except for loops with small register pressure 
8010 as the regions.  This value usually gives
8011 the best results in most cases and for most architectures,
8012 and is enabled by default when compiling with optimization for speed
8013 (@option{-O}, @option{-O2}, @dots{}).
8015 @item one
8016 Use all functions as a single region.  
8017 This typically results in the smallest code size, and is enabled by default for
8018 @option{-Os} or @option{-O0}.
8020 @end table
8022 @item -fira-hoist-pressure
8023 @opindex fira-hoist-pressure
8024 Use IRA to evaluate register pressure in the code hoisting pass for
8025 decisions to hoist expressions.  This option usually results in smaller
8026 code, but it can slow the compiler down.
8028 This option is enabled at level @option{-Os} for all targets.
8030 @item -fira-loop-pressure
8031 @opindex fira-loop-pressure
8032 Use IRA to evaluate register pressure in loops for decisions to move
8033 loop invariants.  This option usually results in generation
8034 of faster and smaller code on machines with large register files (>= 32
8035 registers), but it can slow the compiler down.
8037 This option is enabled at level @option{-O3} for some targets.
8039 @item -fno-ira-share-save-slots
8040 @opindex fno-ira-share-save-slots
8041 Disable sharing of stack slots used for saving call-used hard
8042 registers living through a call.  Each hard register gets a
8043 separate stack slot, and as a result function stack frames are
8044 larger.
8046 @item -fno-ira-share-spill-slots
8047 @opindex fno-ira-share-spill-slots
8048 Disable sharing of stack slots allocated for pseudo-registers.  Each
8049 pseudo-register that does not get a hard register gets a separate
8050 stack slot, and as a result function stack frames are larger.
8052 @item -flra-remat
8053 @opindex flra-remat
8054 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8055 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8056 values if it is profitable.
8058 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8060 @item -fdelayed-branch
8061 @opindex fdelayed-branch
8062 If supported for the target machine, attempt to reorder instructions
8063 to exploit instruction slots available after delayed branch
8064 instructions.
8066 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8068 @item -fschedule-insns
8069 @opindex fschedule-insns
8070 If supported for the target machine, attempt to reorder instructions to
8071 eliminate execution stalls due to required data being unavailable.  This
8072 helps machines that have slow floating point or memory load instructions
8073 by allowing other instructions to be issued until the result of the load
8074 or floating-point instruction is required.
8076 Enabled at levels @option{-O2}, @option{-O3}.
8078 @item -fschedule-insns2
8079 @opindex fschedule-insns2
8080 Similar to @option{-fschedule-insns}, but requests an additional pass of
8081 instruction scheduling after register allocation has been done.  This is
8082 especially useful on machines with a relatively small number of
8083 registers and where memory load instructions take more than one cycle.
8085 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8087 @item -fno-sched-interblock
8088 @opindex fno-sched-interblock
8089 Don't schedule instructions across basic blocks.  This is normally
8090 enabled by default when scheduling before register allocation, i.e.@:
8091 with @option{-fschedule-insns} or at @option{-O2} or higher.
8093 @item -fno-sched-spec
8094 @opindex fno-sched-spec
8095 Don't allow speculative motion of non-load instructions.  This is normally
8096 enabled by default when scheduling before register allocation, i.e.@:
8097 with @option{-fschedule-insns} or at @option{-O2} or higher.
8099 @item -fsched-pressure
8100 @opindex fsched-pressure
8101 Enable register pressure sensitive insn scheduling before register
8102 allocation.  This only makes sense when scheduling before register
8103 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8104 @option{-O2} or higher.  Usage of this option can improve the
8105 generated code and decrease its size by preventing register pressure
8106 increase above the number of available hard registers and subsequent
8107 spills in register allocation.
8109 @item -fsched-spec-load
8110 @opindex fsched-spec-load
8111 Allow speculative motion of some load instructions.  This only makes
8112 sense when scheduling before register allocation, i.e.@: with
8113 @option{-fschedule-insns} or at @option{-O2} or higher.
8115 @item -fsched-spec-load-dangerous
8116 @opindex fsched-spec-load-dangerous
8117 Allow speculative motion of more load instructions.  This only makes
8118 sense when scheduling before register allocation, i.e.@: with
8119 @option{-fschedule-insns} or at @option{-O2} or higher.
8121 @item -fsched-stalled-insns
8122 @itemx -fsched-stalled-insns=@var{n}
8123 @opindex fsched-stalled-insns
8124 Define how many insns (if any) can be moved prematurely from the queue
8125 of stalled insns into the ready list during the second scheduling pass.
8126 @option{-fno-sched-stalled-insns} means that no insns are moved
8127 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8128 on how many queued insns can be moved prematurely.
8129 @option{-fsched-stalled-insns} without a value is equivalent to
8130 @option{-fsched-stalled-insns=1}.
8132 @item -fsched-stalled-insns-dep
8133 @itemx -fsched-stalled-insns-dep=@var{n}
8134 @opindex fsched-stalled-insns-dep
8135 Define how many insn groups (cycles) are examined for a dependency
8136 on a stalled insn that is a candidate for premature removal from the queue
8137 of stalled insns.  This has an effect only during the second scheduling pass,
8138 and only if @option{-fsched-stalled-insns} is used.
8139 @option{-fno-sched-stalled-insns-dep} is equivalent to
8140 @option{-fsched-stalled-insns-dep=0}.
8141 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8142 @option{-fsched-stalled-insns-dep=1}.
8144 @item -fsched2-use-superblocks
8145 @opindex fsched2-use-superblocks
8146 When scheduling after register allocation, use superblock scheduling.
8147 This allows motion across basic block boundaries,
8148 resulting in faster schedules.  This option is experimental, as not all machine
8149 descriptions used by GCC model the CPU closely enough to avoid unreliable
8150 results from the algorithm.
8152 This only makes sense when scheduling after register allocation, i.e.@: with
8153 @option{-fschedule-insns2} or at @option{-O2} or higher.
8155 @item -fsched-group-heuristic
8156 @opindex fsched-group-heuristic
8157 Enable the group heuristic in the scheduler.  This heuristic favors
8158 the instruction that belongs to a schedule group.  This is enabled
8159 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8160 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8162 @item -fsched-critical-path-heuristic
8163 @opindex fsched-critical-path-heuristic
8164 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8165 instructions on the critical path.  This is enabled by default when
8166 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8167 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8169 @item -fsched-spec-insn-heuristic
8170 @opindex fsched-spec-insn-heuristic
8171 Enable the speculative instruction heuristic in the scheduler.  This
8172 heuristic favors speculative instructions with greater dependency weakness.
8173 This is enabled by default when scheduling is enabled, i.e.@:
8174 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8175 or at @option{-O2} or higher.
8177 @item -fsched-rank-heuristic
8178 @opindex fsched-rank-heuristic
8179 Enable the rank heuristic in the scheduler.  This heuristic favors
8180 the instruction belonging to a basic block with greater size or frequency.
8181 This is enabled by default when scheduling is enabled, i.e.@:
8182 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8183 at @option{-O2} or higher.
8185 @item -fsched-last-insn-heuristic
8186 @opindex fsched-last-insn-heuristic
8187 Enable the last-instruction heuristic in the scheduler.  This heuristic
8188 favors the instruction that is less dependent on the last instruction
8189 scheduled.  This is enabled by default when scheduling is enabled,
8190 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8191 at @option{-O2} or higher.
8193 @item -fsched-dep-count-heuristic
8194 @opindex fsched-dep-count-heuristic
8195 Enable the dependent-count heuristic in the scheduler.  This heuristic
8196 favors the instruction that has more instructions depending on it.
8197 This is enabled by default when scheduling is enabled, i.e.@:
8198 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8199 at @option{-O2} or higher.
8201 @item -freschedule-modulo-scheduled-loops
8202 @opindex freschedule-modulo-scheduled-loops
8203 Modulo scheduling is performed before traditional scheduling.  If a loop
8204 is modulo scheduled, later scheduling passes may change its schedule.  
8205 Use this option to control that behavior.
8207 @item -fselective-scheduling
8208 @opindex fselective-scheduling
8209 Schedule instructions using selective scheduling algorithm.  Selective
8210 scheduling runs instead of the first scheduler pass.
8212 @item -fselective-scheduling2
8213 @opindex fselective-scheduling2
8214 Schedule instructions using selective scheduling algorithm.  Selective
8215 scheduling runs instead of the second scheduler pass.
8217 @item -fsel-sched-pipelining
8218 @opindex fsel-sched-pipelining
8219 Enable software pipelining of innermost loops during selective scheduling.
8220 This option has no effect unless one of @option{-fselective-scheduling} or
8221 @option{-fselective-scheduling2} is turned on.
8223 @item -fsel-sched-pipelining-outer-loops
8224 @opindex fsel-sched-pipelining-outer-loops
8225 When pipelining loops during selective scheduling, also pipeline outer loops.
8226 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8228 @item -fsemantic-interposition
8229 @opindex fsemantic-interposition
8230 Some object formats, like ELF, allow interposing of symbols by the 
8231 dynamic linker.
8232 This means that for symbols exported from the DSO, the compiler cannot perform
8233 interprocedural propagation, inlining and other optimizations in anticipation
8234 that the function or variable in question may change. While this feature is
8235 useful, for example, to rewrite memory allocation functions by a debugging
8236 implementation, it is expensive in the terms of code quality.
8237 With @option{-fno-semantic-interposition} the compiler assumes that 
8238 if interposition happens for functions the overwriting function will have 
8239 precisely the same semantics (and side effects). 
8240 Similarly if interposition happens
8241 for variables, the constructor of the variable will be the same. The flag
8242 has no effect for functions explicitly declared inline 
8243 (where it is never allowed for interposition to change semantics) 
8244 and for symbols explicitly declared weak.
8246 @item -fshrink-wrap
8247 @opindex fshrink-wrap
8248 Emit function prologues only before parts of the function that need it,
8249 rather than at the top of the function.  This flag is enabled by default at
8250 @option{-O} and higher.
8252 @item -fshrink-wrap-separate
8253 @opindex fshrink-wrap-separate
8254 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8255 those parts are only executed when needed.
8256 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8257 is also turned on and the target supports this.
8259 @item -fcaller-saves
8260 @opindex fcaller-saves
8261 Enable allocation of values to registers that are clobbered by
8262 function calls, by emitting extra instructions to save and restore the
8263 registers around such calls.  Such allocation is done only when it
8264 seems to result in better code.
8266 This option is always enabled by default on certain machines, usually
8267 those which have no call-preserved registers to use instead.
8269 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8271 @item -fcombine-stack-adjustments
8272 @opindex fcombine-stack-adjustments
8273 Tracks stack adjustments (pushes and pops) and stack memory references
8274 and then tries to find ways to combine them.
8276 Enabled by default at @option{-O1} and higher.
8278 @item -fipa-ra
8279 @opindex fipa-ra
8280 Use caller save registers for allocation if those registers are not used by
8281 any called function.  In that case it is not necessary to save and restore
8282 them around calls.  This is only possible if called functions are part of
8283 same compilation unit as current function and they are compiled before it.
8285 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8286 is disabled if generated code will be instrumented for profiling
8287 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8288 exactly (this happens on targets that do not expose prologues
8289 and epilogues in RTL).
8291 @item -fconserve-stack
8292 @opindex fconserve-stack
8293 Attempt to minimize stack usage.  The compiler attempts to use less
8294 stack space, even if that makes the program slower.  This option
8295 implies setting the @option{large-stack-frame} parameter to 100
8296 and the @option{large-stack-frame-growth} parameter to 400.
8298 @item -ftree-reassoc
8299 @opindex ftree-reassoc
8300 Perform reassociation on trees.  This flag is enabled by default
8301 at @option{-O} and higher.
8303 @item -fcode-hoisting
8304 @opindex fcode-hoisting
8305 Perform code hoisting.  Code hoisting tries to move the
8306 evaluation of expressions executed on all paths to the function exit
8307 as early as possible.  This is especially useful as a code size
8308 optimization, but it often helps for code speed as well.
8309 This flag is enabled by default at @option{-O2} and higher.
8311 @item -ftree-pre
8312 @opindex ftree-pre
8313 Perform partial redundancy elimination (PRE) on trees.  This flag is
8314 enabled by default at @option{-O2} and @option{-O3}.
8316 @item -ftree-partial-pre
8317 @opindex ftree-partial-pre
8318 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8319 enabled by default at @option{-O3}.
8321 @item -ftree-forwprop
8322 @opindex ftree-forwprop
8323 Perform forward propagation on trees.  This flag is enabled by default
8324 at @option{-O} and higher.
8326 @item -ftree-fre
8327 @opindex ftree-fre
8328 Perform full redundancy elimination (FRE) on trees.  The difference
8329 between FRE and PRE is that FRE only considers expressions
8330 that are computed on all paths leading to the redundant computation.
8331 This analysis is faster than PRE, though it exposes fewer redundancies.
8332 This flag is enabled by default at @option{-O} and higher.
8334 @item -ftree-phiprop
8335 @opindex ftree-phiprop
8336 Perform hoisting of loads from conditional pointers on trees.  This
8337 pass is enabled by default at @option{-O} and higher.
8339 @item -fhoist-adjacent-loads
8340 @opindex fhoist-adjacent-loads
8341 Speculatively hoist loads from both branches of an if-then-else if the
8342 loads are from adjacent locations in the same structure and the target
8343 architecture has a conditional move instruction.  This flag is enabled
8344 by default at @option{-O2} and higher.
8346 @item -ftree-copy-prop
8347 @opindex ftree-copy-prop
8348 Perform copy propagation on trees.  This pass eliminates unnecessary
8349 copy operations.  This flag is enabled by default at @option{-O} and
8350 higher.
8352 @item -fipa-pure-const
8353 @opindex fipa-pure-const
8354 Discover which functions are pure or constant.
8355 Enabled by default at @option{-O} and higher.
8357 @item -fipa-reference
8358 @opindex fipa-reference
8359 Discover which static variables do not escape the
8360 compilation unit.
8361 Enabled by default at @option{-O} and higher.
8363 @item -fipa-pta
8364 @opindex fipa-pta
8365 Perform interprocedural pointer analysis and interprocedural modification
8366 and reference analysis.  This option can cause excessive memory and
8367 compile-time usage on large compilation units.  It is not enabled by
8368 default at any optimization level.
8370 @item -fipa-profile
8371 @opindex fipa-profile
8372 Perform interprocedural profile propagation.  The functions called only from
8373 cold functions are marked as cold. Also functions executed once (such as
8374 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8375 functions and loop less parts of functions executed once are then optimized for
8376 size.
8377 Enabled by default at @option{-O} and higher.
8379 @item -fipa-cp
8380 @opindex fipa-cp
8381 Perform interprocedural constant propagation.
8382 This optimization analyzes the program to determine when values passed
8383 to functions are constants and then optimizes accordingly.
8384 This optimization can substantially increase performance
8385 if the application has constants passed to functions.
8386 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8388 @item -fipa-cp-clone
8389 @opindex fipa-cp-clone
8390 Perform function cloning to make interprocedural constant propagation stronger.
8391 When enabled, interprocedural constant propagation performs function cloning
8392 when externally visible function can be called with constant arguments.
8393 Because this optimization can create multiple copies of functions,
8394 it may significantly increase code size
8395 (see @option{--param ipcp-unit-growth=@var{value}}).
8396 This flag is enabled by default at @option{-O3}.
8398 @item -fipa-bit-cp
8399 @opindex -fipa-bit-cp
8400 When enabled, perform interprocedural bitwise constant
8401 propagation. This flag is enabled by default at @option{-O2}. It
8402 requires that @option{-fipa-cp} is enabled.
8404 @item -fipa-vrp
8405 @opindex -fipa-vrp
8406 When enabled, perform interprocedural propagation of value
8407 ranges. This flag is enabled by default at @option{-O2}. It requires
8408 that @option{-fipa-cp} is enabled.
8410 @item -fipa-icf
8411 @opindex fipa-icf
8412 Perform Identical Code Folding for functions and read-only variables.
8413 The optimization reduces code size and may disturb unwind stacks by replacing
8414 a function by equivalent one with a different name. The optimization works
8415 more effectively with link-time optimization enabled.
8417 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8418 works on different levels and thus the optimizations are not same - there are
8419 equivalences that are found only by GCC and equivalences found only by Gold.
8421 This flag is enabled by default at @option{-O2} and @option{-Os}.
8423 @item -fisolate-erroneous-paths-dereference
8424 @opindex fisolate-erroneous-paths-dereference
8425 Detect paths that trigger erroneous or undefined behavior due to
8426 dereferencing a null pointer.  Isolate those paths from the main control
8427 flow and turn the statement with erroneous or undefined behavior into a trap.
8428 This flag is enabled by default at @option{-O2} and higher and depends on
8429 @option{-fdelete-null-pointer-checks} also being enabled.
8431 @item -fisolate-erroneous-paths-attribute
8432 @opindex fisolate-erroneous-paths-attribute
8433 Detect paths that trigger erroneous or undefined behavior due a null value
8434 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8435 attribute.  Isolate those paths from the main control flow and turn the
8436 statement with erroneous or undefined behavior into a trap.  This is not
8437 currently enabled, but may be enabled by @option{-O2} in the future.
8439 @item -ftree-sink
8440 @opindex ftree-sink
8441 Perform forward store motion on trees.  This flag is
8442 enabled by default at @option{-O} and higher.
8444 @item -ftree-bit-ccp
8445 @opindex ftree-bit-ccp
8446 Perform sparse conditional bit constant propagation on trees and propagate
8447 pointer alignment information.
8448 This pass only operates on local scalar variables and is enabled by default
8449 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8451 @item -ftree-ccp
8452 @opindex ftree-ccp
8453 Perform sparse conditional constant propagation (CCP) on trees.  This
8454 pass only operates on local scalar variables and is enabled by default
8455 at @option{-O} and higher.
8457 @item -fssa-backprop
8458 @opindex fssa-backprop
8459 Propagate information about uses of a value up the definition chain
8460 in order to simplify the definitions.  For example, this pass strips
8461 sign operations if the sign of a value never matters.  The flag is
8462 enabled by default at @option{-O} and higher.
8464 @item -fssa-phiopt
8465 @opindex fssa-phiopt
8466 Perform pattern matching on SSA PHI nodes to optimize conditional
8467 code.  This pass is enabled by default at @option{-O} and higher.
8469 @item -ftree-switch-conversion
8470 @opindex ftree-switch-conversion
8471 Perform conversion of simple initializations in a switch to
8472 initializations from a scalar array.  This flag is enabled by default
8473 at @option{-O2} and higher.
8475 @item -ftree-tail-merge
8476 @opindex ftree-tail-merge
8477 Look for identical code sequences.  When found, replace one with a jump to the
8478 other.  This optimization is known as tail merging or cross jumping.  This flag
8479 is enabled by default at @option{-O2} and higher.  The compilation time
8480 in this pass can
8481 be limited using @option{max-tail-merge-comparisons} parameter and
8482 @option{max-tail-merge-iterations} parameter.
8484 @item -ftree-dce
8485 @opindex ftree-dce
8486 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8487 default at @option{-O} and higher.
8489 @item -ftree-builtin-call-dce
8490 @opindex ftree-builtin-call-dce
8491 Perform conditional dead code elimination (DCE) for calls to built-in functions
8492 that may set @code{errno} but are otherwise side-effect free.  This flag is
8493 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8494 specified.
8496 @item -ftree-dominator-opts
8497 @opindex ftree-dominator-opts
8498 Perform a variety of simple scalar cleanups (constant/copy
8499 propagation, redundancy elimination, range propagation and expression
8500 simplification) based on a dominator tree traversal.  This also
8501 performs jump threading (to reduce jumps to jumps). This flag is
8502 enabled by default at @option{-O} and higher.
8504 @item -ftree-dse
8505 @opindex ftree-dse
8506 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8507 a memory location that is later overwritten by another store without
8508 any intervening loads.  In this case the earlier store can be deleted.  This
8509 flag is enabled by default at @option{-O} and higher.
8511 @item -ftree-ch
8512 @opindex ftree-ch
8513 Perform loop header copying on trees.  This is beneficial since it increases
8514 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8515 is enabled by default at @option{-O} and higher.  It is not enabled
8516 for @option{-Os}, since it usually increases code size.
8518 @item -ftree-loop-optimize
8519 @opindex ftree-loop-optimize
8520 Perform loop optimizations on trees.  This flag is enabled by default
8521 at @option{-O} and higher.
8523 @item -ftree-loop-linear
8524 @itemx -floop-strip-mine
8525 @itemx -floop-block
8526 @opindex ftree-loop-linear
8527 @opindex floop-strip-mine
8528 @opindex floop-block
8529 Perform loop nest optimizations.  Same as
8530 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8531 to be configured with @option{--with-isl} to enable the Graphite loop
8532 transformation infrastructure.
8534 @item -fgraphite-identity
8535 @opindex fgraphite-identity
8536 Enable the identity transformation for graphite.  For every SCoP we generate
8537 the polyhedral representation and transform it back to gimple.  Using
8538 @option{-fgraphite-identity} we can check the costs or benefits of the
8539 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8540 are also performed by the code generator isl, like index splitting and
8541 dead code elimination in loops.
8543 @item -floop-nest-optimize
8544 @opindex floop-nest-optimize
8545 Enable the isl based loop nest optimizer.  This is a generic loop nest
8546 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8547 structure optimized for data-locality and parallelism.  This option
8548 is experimental.
8550 @item -floop-parallelize-all
8551 @opindex floop-parallelize-all
8552 Use the Graphite data dependence analysis to identify loops that can
8553 be parallelized.  Parallelize all the loops that can be analyzed to
8554 not contain loop carried dependences without checking that it is
8555 profitable to parallelize the loops.
8557 @item -ftree-coalesce-vars
8558 @opindex ftree-coalesce-vars
8559 While transforming the program out of the SSA representation, attempt to
8560 reduce copying by coalescing versions of different user-defined
8561 variables, instead of just compiler temporaries.  This may severely
8562 limit the ability to debug an optimized program compiled with
8563 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8564 prevents SSA coalescing of user variables.  This option is enabled by
8565 default if optimization is enabled, and it does very little otherwise.
8567 @item -ftree-loop-if-convert
8568 @opindex ftree-loop-if-convert
8569 Attempt to transform conditional jumps in the innermost loops to
8570 branch-less equivalents.  The intent is to remove control-flow from
8571 the innermost loops in order to improve the ability of the
8572 vectorization pass to handle these loops.  This is enabled by default
8573 if vectorization is enabled.
8575 @item -ftree-loop-distribution
8576 @opindex ftree-loop-distribution
8577 Perform loop distribution.  This flag can improve cache performance on
8578 big loop bodies and allow further loop optimizations, like
8579 parallelization or vectorization, to take place.  For example, the loop
8580 @smallexample
8581 DO I = 1, N
8582   A(I) = B(I) + C
8583   D(I) = E(I) * F
8584 ENDDO
8585 @end smallexample
8586 is transformed to
8587 @smallexample
8588 DO I = 1, N
8589    A(I) = B(I) + C
8590 ENDDO
8591 DO I = 1, N
8592    D(I) = E(I) * F
8593 ENDDO
8594 @end smallexample
8596 @item -ftree-loop-distribute-patterns
8597 @opindex ftree-loop-distribute-patterns
8598 Perform loop distribution of patterns that can be code generated with
8599 calls to a library.  This flag is enabled by default at @option{-O3}.
8601 This pass distributes the initialization loops and generates a call to
8602 memset zero.  For example, the loop
8603 @smallexample
8604 DO I = 1, N
8605   A(I) = 0
8606   B(I) = A(I) + I
8607 ENDDO
8608 @end smallexample
8609 is transformed to
8610 @smallexample
8611 DO I = 1, N
8612    A(I) = 0
8613 ENDDO
8614 DO I = 1, N
8615    B(I) = A(I) + I
8616 ENDDO
8617 @end smallexample
8618 and the initialization loop is transformed into a call to memset zero.
8620 @item -floop-interchange
8621 @opindex floop-interchange
8622 Perform loop interchange outside of graphite.  This flag can improve cache
8623 performance on loop nest and allow further loop optimizations, like
8624 vectorization, to take place.  For example, the loop
8625 @smallexample
8626 for (int i = 0; i < N; i++)
8627   for (int j = 0; j < N; j++)
8628     for (int k = 0; k < N; k++)
8629       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8630 @end smallexample
8631 is transformed to
8632 @smallexample
8633 for (int i = 0; i < N; i++)
8634   for (int k = 0; k < N; k++)
8635     for (int j = 0; j < N; j++)
8636       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8637 @end smallexample
8639 @item -ftree-loop-im
8640 @opindex ftree-loop-im
8641 Perform loop invariant motion on trees.  This pass moves only invariants that
8642 are hard to handle at RTL level (function calls, operations that expand to
8643 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8644 operands of conditions that are invariant out of the loop, so that we can use
8645 just trivial invariantness analysis in loop unswitching.  The pass also includes
8646 store motion.
8648 @item -ftree-loop-ivcanon
8649 @opindex ftree-loop-ivcanon
8650 Create a canonical counter for number of iterations in loops for which
8651 determining number of iterations requires complicated analysis.  Later
8652 optimizations then may determine the number easily.  Useful especially
8653 in connection with unrolling.
8655 @item -fivopts
8656 @opindex fivopts
8657 Perform induction variable optimizations (strength reduction, induction
8658 variable merging and induction variable elimination) on trees.
8660 @item -ftree-parallelize-loops=n
8661 @opindex ftree-parallelize-loops
8662 Parallelize loops, i.e., split their iteration space to run in n threads.
8663 This is only possible for loops whose iterations are independent
8664 and can be arbitrarily reordered.  The optimization is only
8665 profitable on multiprocessor machines, for loops that are CPU-intensive,
8666 rather than constrained e.g.@: by memory bandwidth.  This option
8667 implies @option{-pthread}, and thus is only supported on targets
8668 that have support for @option{-pthread}.
8670 @item -ftree-pta
8671 @opindex ftree-pta
8672 Perform function-local points-to analysis on trees.  This flag is
8673 enabled by default at @option{-O} and higher.
8675 @item -ftree-sra
8676 @opindex ftree-sra
8677 Perform scalar replacement of aggregates.  This pass replaces structure
8678 references with scalars to prevent committing structures to memory too
8679 early.  This flag is enabled by default at @option{-O} and higher.
8681 @item -fstore-merging
8682 @opindex fstore-merging
8683 Perform merging of narrow stores to consecutive memory addresses.  This pass
8684 merges contiguous stores of immediate values narrower than a word into fewer
8685 wider stores to reduce the number of instructions.  This is enabled by default
8686 at @option{-O2} and higher as well as @option{-Os}.
8688 @item -ftree-ter
8689 @opindex ftree-ter
8690 Perform temporary expression replacement during the SSA->normal phase.  Single
8691 use/single def temporaries are replaced at their use location with their
8692 defining expression.  This results in non-GIMPLE code, but gives the expanders
8693 much more complex trees to work on resulting in better RTL generation.  This is
8694 enabled by default at @option{-O} and higher.
8696 @item -ftree-slsr
8697 @opindex ftree-slsr
8698 Perform straight-line strength reduction on trees.  This recognizes related
8699 expressions involving multiplications and replaces them by less expensive
8700 calculations when possible.  This is enabled by default at @option{-O} and
8701 higher.
8703 @item -ftree-vectorize
8704 @opindex ftree-vectorize
8705 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8706 and @option{-ftree-slp-vectorize} if not explicitly specified.
8708 @item -ftree-loop-vectorize
8709 @opindex ftree-loop-vectorize
8710 Perform loop vectorization on trees. This flag is enabled by default at
8711 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8713 @item -ftree-slp-vectorize
8714 @opindex ftree-slp-vectorize
8715 Perform basic block vectorization on trees. This flag is enabled by default at
8716 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8718 @item -fvect-cost-model=@var{model}
8719 @opindex fvect-cost-model
8720 Alter the cost model used for vectorization.  The @var{model} argument
8721 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8722 With the @samp{unlimited} model the vectorized code-path is assumed
8723 to be profitable while with the @samp{dynamic} model a runtime check
8724 guards the vectorized code-path to enable it only for iteration
8725 counts that will likely execute faster than when executing the original
8726 scalar loop.  The @samp{cheap} model disables vectorization of
8727 loops where doing so would be cost prohibitive for example due to
8728 required runtime checks for data dependence or alignment but otherwise
8729 is equal to the @samp{dynamic} model.
8730 The default cost model depends on other optimization flags and is
8731 either @samp{dynamic} or @samp{cheap}.
8733 @item -fsimd-cost-model=@var{model}
8734 @opindex fsimd-cost-model
8735 Alter the cost model used for vectorization of loops marked with the OpenMP
8736 or Cilk Plus simd directive.  The @var{model} argument should be one of
8737 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8738 have the same meaning as described in @option{-fvect-cost-model} and by
8739 default a cost model defined with @option{-fvect-cost-model} is used.
8741 @item -ftree-vrp
8742 @opindex ftree-vrp
8743 Perform Value Range Propagation on trees.  This is similar to the
8744 constant propagation pass, but instead of values, ranges of values are
8745 propagated.  This allows the optimizers to remove unnecessary range
8746 checks like array bound checks and null pointer checks.  This is
8747 enabled by default at @option{-O2} and higher.  Null pointer check
8748 elimination is only done if @option{-fdelete-null-pointer-checks} is
8749 enabled.
8751 @item -fsplit-paths
8752 @opindex fsplit-paths
8753 Split paths leading to loop backedges.  This can improve dead code
8754 elimination and common subexpression elimination.  This is enabled by
8755 default at @option{-O2} and above.
8757 @item -fsplit-ivs-in-unroller
8758 @opindex fsplit-ivs-in-unroller
8759 Enables expression of values of induction variables in later iterations
8760 of the unrolled loop using the value in the first iteration.  This breaks
8761 long dependency chains, thus improving efficiency of the scheduling passes.
8763 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8764 same effect.  However, that is not reliable in cases where the loop body
8765 is more complicated than a single basic block.  It also does not work at all
8766 on some architectures due to restrictions in the CSE pass.
8768 This optimization is enabled by default.
8770 @item -fvariable-expansion-in-unroller
8771 @opindex fvariable-expansion-in-unroller
8772 With this option, the compiler creates multiple copies of some
8773 local variables when unrolling a loop, which can result in superior code.
8775 @item -fpartial-inlining
8776 @opindex fpartial-inlining
8777 Inline parts of functions.  This option has any effect only
8778 when inlining itself is turned on by the @option{-finline-functions}
8779 or @option{-finline-small-functions} options.
8781 Enabled at level @option{-O2}.
8783 @item -fpredictive-commoning
8784 @opindex fpredictive-commoning
8785 Perform predictive commoning optimization, i.e., reusing computations
8786 (especially memory loads and stores) performed in previous
8787 iterations of loops.
8789 This option is enabled at level @option{-O3}.
8791 @item -fprefetch-loop-arrays
8792 @opindex fprefetch-loop-arrays
8793 If supported by the target machine, generate instructions to prefetch
8794 memory to improve the performance of loops that access large arrays.
8796 This option may generate better or worse code; results are highly
8797 dependent on the structure of loops within the source code.
8799 Disabled at level @option{-Os}.
8801 @item -fno-printf-return-value
8802 @opindex fno-printf-return-value
8803 Do not substitute constants for known return value of formatted output
8804 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8805 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8806 transformation allows GCC to optimize or even eliminate branches based
8807 on the known return value of these functions called with arguments that
8808 are either constant, or whose values are known to be in a range that
8809 makes determining the exact return value possible.  For example, when
8810 @option{-fprintf-return-value} is in effect, both the branch and the
8811 body of the @code{if} statement (but not the call to @code{snprint})
8812 can be optimized away when @code{i} is a 32-bit or smaller integer
8813 because the return value is guaranteed to be at most 8.
8815 @smallexample
8816 char buf[9];
8817 if (snprintf (buf, "%08x", i) >= sizeof buf)
8818   @dots{}
8819 @end smallexample
8821 The @option{-fprintf-return-value} option relies on other optimizations
8822 and yields best results with @option{-O2}.  It works in tandem with the
8823 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8824 The @option{-fprintf-return-value} option is enabled by default.
8826 @item -fno-peephole
8827 @itemx -fno-peephole2
8828 @opindex fno-peephole
8829 @opindex fno-peephole2
8830 Disable any machine-specific peephole optimizations.  The difference
8831 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8832 are implemented in the compiler; some targets use one, some use the
8833 other, a few use both.
8835 @option{-fpeephole} is enabled by default.
8836 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8838 @item -fno-guess-branch-probability
8839 @opindex fno-guess-branch-probability
8840 Do not guess branch probabilities using heuristics.
8842 GCC uses heuristics to guess branch probabilities if they are
8843 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8844 heuristics are based on the control flow graph.  If some branch probabilities
8845 are specified by @code{__builtin_expect}, then the heuristics are
8846 used to guess branch probabilities for the rest of the control flow graph,
8847 taking the @code{__builtin_expect} info into account.  The interactions
8848 between the heuristics and @code{__builtin_expect} can be complex, and in
8849 some cases, it may be useful to disable the heuristics so that the effects
8850 of @code{__builtin_expect} are easier to understand.
8852 The default is @option{-fguess-branch-probability} at levels
8853 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8855 @item -freorder-blocks
8856 @opindex freorder-blocks
8857 Reorder basic blocks in the compiled function in order to reduce number of
8858 taken branches and improve code locality.
8860 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8862 @item -freorder-blocks-algorithm=@var{algorithm}
8863 @opindex freorder-blocks-algorithm
8864 Use the specified algorithm for basic block reordering.  The
8865 @var{algorithm} argument can be @samp{simple}, which does not increase
8866 code size (except sometimes due to secondary effects like alignment),
8867 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8868 put all often executed code together, minimizing the number of branches
8869 executed by making extra copies of code.
8871 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8872 @samp{stc} at levels @option{-O2}, @option{-O3}.
8874 @item -freorder-blocks-and-partition
8875 @opindex freorder-blocks-and-partition
8876 In addition to reordering basic blocks in the compiled function, in order
8877 to reduce number of taken branches, partitions hot and cold basic blocks
8878 into separate sections of the assembly and @file{.o} files, to improve
8879 paging and cache locality performance.
8881 This optimization is automatically turned off in the presence of
8882 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8883 section attribute and on any architecture that does not support named
8884 sections.  When @option{-fsplit-stack} is used this option is not
8885 enabled by default (to avoid linker errors), but may be enabled
8886 explicitly (if using a working linker).
8888 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8890 @item -freorder-functions
8891 @opindex freorder-functions
8892 Reorder functions in the object file in order to
8893 improve code locality.  This is implemented by using special
8894 subsections @code{.text.hot} for most frequently executed functions and
8895 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8896 the linker so object file format must support named sections and linker must
8897 place them in a reasonable way.
8899 Also profile feedback must be available to make this option effective.  See
8900 @option{-fprofile-arcs} for details.
8902 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8904 @item -fstrict-aliasing
8905 @opindex fstrict-aliasing
8906 Allow the compiler to assume the strictest aliasing rules applicable to
8907 the language being compiled.  For C (and C++), this activates
8908 optimizations based on the type of expressions.  In particular, an
8909 object of one type is assumed never to reside at the same address as an
8910 object of a different type, unless the types are almost the same.  For
8911 example, an @code{unsigned int} can alias an @code{int}, but not a
8912 @code{void*} or a @code{double}.  A character type may alias any other
8913 type.
8915 @anchor{Type-punning}Pay special attention to code like this:
8916 @smallexample
8917 union a_union @{
8918   int i;
8919   double d;
8922 int f() @{
8923   union a_union t;
8924   t.d = 3.0;
8925   return t.i;
8927 @end smallexample
8928 The practice of reading from a different union member than the one most
8929 recently written to (called ``type-punning'') is common.  Even with
8930 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8931 is accessed through the union type.  So, the code above works as
8932 expected.  @xref{Structures unions enumerations and bit-fields
8933 implementation}.  However, this code might not:
8934 @smallexample
8935 int f() @{
8936   union a_union t;
8937   int* ip;
8938   t.d = 3.0;
8939   ip = &t.i;
8940   return *ip;
8942 @end smallexample
8944 Similarly, access by taking the address, casting the resulting pointer
8945 and dereferencing the result has undefined behavior, even if the cast
8946 uses a union type, e.g.:
8947 @smallexample
8948 int f() @{
8949   double d = 3.0;
8950   return ((union a_union *) &d)->i;
8952 @end smallexample
8954 The @option{-fstrict-aliasing} option is enabled at levels
8955 @option{-O2}, @option{-O3}, @option{-Os}.
8957 @item -falign-functions
8958 @itemx -falign-functions=@var{n}
8959 @opindex falign-functions
8960 Align the start of functions to the next power-of-two greater than
8961 @var{n}, skipping up to @var{n} bytes.  For instance,
8962 @option{-falign-functions=32} aligns functions to the next 32-byte
8963 boundary, but @option{-falign-functions=24} aligns to the next
8964 32-byte boundary only if this can be done by skipping 23 bytes or less.
8966 @option{-fno-align-functions} and @option{-falign-functions=1} are
8967 equivalent and mean that functions are not aligned.
8969 Some assemblers only support this flag when @var{n} is a power of two;
8970 in that case, it is rounded up.
8972 If @var{n} is not specified or is zero, use a machine-dependent default.
8974 Enabled at levels @option{-O2}, @option{-O3}.
8976 @item -flimit-function-alignment
8977 If this option is enabled, the compiler tries to avoid unnecessarily
8978 overaligning functions. It attempts to instruct the assembler to align
8979 by the amount specified by @option{-falign-functions}, but not to
8980 skip more bytes than the size of the function.
8982 @item -falign-labels
8983 @itemx -falign-labels=@var{n}
8984 @opindex falign-labels
8985 Align all branch targets to a power-of-two boundary, skipping up to
8986 @var{n} bytes like @option{-falign-functions}.  This option can easily
8987 make code slower, because it must insert dummy operations for when the
8988 branch target is reached in the usual flow of the code.
8990 @option{-fno-align-labels} and @option{-falign-labels=1} are
8991 equivalent and mean that labels are not aligned.
8993 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8994 are greater than this value, then their values are used instead.
8996 If @var{n} is not specified or is zero, use a machine-dependent default
8997 which is very likely to be @samp{1}, meaning no alignment.
8999 Enabled at levels @option{-O2}, @option{-O3}.
9001 @item -falign-loops
9002 @itemx -falign-loops=@var{n}
9003 @opindex falign-loops
9004 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9005 like @option{-falign-functions}.  If the loops are
9006 executed many times, this makes up for any execution of the dummy
9007 operations.
9009 @option{-fno-align-loops} and @option{-falign-loops=1} are
9010 equivalent and mean that loops are not aligned.
9012 If @var{n} is not specified or is zero, use a machine-dependent default.
9014 Enabled at levels @option{-O2}, @option{-O3}.
9016 @item -falign-jumps
9017 @itemx -falign-jumps=@var{n}
9018 @opindex falign-jumps
9019 Align branch targets to a power-of-two boundary, for branch targets
9020 where the targets can only be reached by jumping, skipping up to @var{n}
9021 bytes like @option{-falign-functions}.  In this case, no dummy operations
9022 need be executed.
9024 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9025 equivalent and mean that loops are not aligned.
9027 If @var{n} is not specified or is zero, use a machine-dependent default.
9029 Enabled at levels @option{-O2}, @option{-O3}.
9031 @item -funit-at-a-time
9032 @opindex funit-at-a-time
9033 This option is left for compatibility reasons. @option{-funit-at-a-time}
9034 has no effect, while @option{-fno-unit-at-a-time} implies
9035 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9037 Enabled by default.
9039 @item -fno-toplevel-reorder
9040 @opindex fno-toplevel-reorder
9041 Do not reorder top-level functions, variables, and @code{asm}
9042 statements.  Output them in the same order that they appear in the
9043 input file.  When this option is used, unreferenced static variables
9044 are not removed.  This option is intended to support existing code
9045 that relies on a particular ordering.  For new code, it is better to
9046 use attributes when possible.
9048 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9049 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9050 targets.
9052 @item -fweb
9053 @opindex fweb
9054 Constructs webs as commonly used for register allocation purposes and assign
9055 each web individual pseudo register.  This allows the register allocation pass
9056 to operate on pseudos directly, but also strengthens several other optimization
9057 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9058 however, make debugging impossible, since variables no longer stay in a
9059 ``home register''.
9061 Enabled by default with @option{-funroll-loops}.
9063 @item -fwhole-program
9064 @opindex fwhole-program
9065 Assume that the current compilation unit represents the whole program being
9066 compiled.  All public functions and variables with the exception of @code{main}
9067 and those merged by attribute @code{externally_visible} become static functions
9068 and in effect are optimized more aggressively by interprocedural optimizers.
9070 This option should not be used in combination with @option{-flto}.
9071 Instead relying on a linker plugin should provide safer and more precise
9072 information.
9074 @item -flto[=@var{n}]
9075 @opindex flto
9076 This option runs the standard link-time optimizer.  When invoked
9077 with source code, it generates GIMPLE (one of GCC's internal
9078 representations) and writes it to special ELF sections in the object
9079 file.  When the object files are linked together, all the function
9080 bodies are read from these ELF sections and instantiated as if they
9081 had been part of the same translation unit.
9083 To use the link-time optimizer, @option{-flto} and optimization
9084 options should be specified at compile time and during the final link.
9085 It is recommended that you compile all the files participating in the
9086 same link with the same options and also specify those options at
9087 link time.  
9088 For example:
9090 @smallexample
9091 gcc -c -O2 -flto foo.c
9092 gcc -c -O2 -flto bar.c
9093 gcc -o myprog -flto -O2 foo.o bar.o
9094 @end smallexample
9096 The first two invocations to GCC save a bytecode representation
9097 of GIMPLE into special ELF sections inside @file{foo.o} and
9098 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9099 @file{foo.o} and @file{bar.o}, merges the two files into a single
9100 internal image, and compiles the result as usual.  Since both
9101 @file{foo.o} and @file{bar.o} are merged into a single image, this
9102 causes all the interprocedural analyses and optimizations in GCC to
9103 work across the two files as if they were a single one.  This means,
9104 for example, that the inliner is able to inline functions in
9105 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9107 Another (simpler) way to enable link-time optimization is:
9109 @smallexample
9110 gcc -o myprog -flto -O2 foo.c bar.c
9111 @end smallexample
9113 The above generates bytecode for @file{foo.c} and @file{bar.c},
9114 merges them together into a single GIMPLE representation and optimizes
9115 them as usual to produce @file{myprog}.
9117 The only important thing to keep in mind is that to enable link-time
9118 optimizations you need to use the GCC driver to perform the link step.
9119 GCC then automatically performs link-time optimization if any of the
9120 objects involved were compiled with the @option{-flto} command-line option.  
9121 You generally
9122 should specify the optimization options to be used for link-time
9123 optimization though GCC tries to be clever at guessing an
9124 optimization level to use from the options used at compile time
9125 if you fail to specify one at link time.  You can always override
9126 the automatic decision to do link-time optimization
9127 by passing @option{-fno-lto} to the link command.
9129 To make whole program optimization effective, it is necessary to make
9130 certain whole program assumptions.  The compiler needs to know
9131 what functions and variables can be accessed by libraries and runtime
9132 outside of the link-time optimized unit.  When supported by the linker,
9133 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9134 to the compiler about used and externally visible symbols.  When
9135 the linker plugin is not available, @option{-fwhole-program} should be
9136 used to allow the compiler to make these assumptions, which leads
9137 to more aggressive optimization decisions.
9139 When @option{-fuse-linker-plugin} is not enabled, when a file is
9140 compiled with @option{-flto}, the generated object file is larger than
9141 a regular object file because it contains GIMPLE bytecodes and the usual
9142 final code (see @option{-ffat-lto-objects}.  This means that
9143 object files with LTO information can be linked as normal object
9144 files; if @option{-fno-lto} is passed to the linker, no
9145 interprocedural optimizations are applied.  Note that when
9146 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9147 but you cannot perform a regular, non-LTO link on them.
9149 Additionally, the optimization flags used to compile individual files
9150 are not necessarily related to those used at link time.  For instance,
9152 @smallexample
9153 gcc -c -O0 -ffat-lto-objects -flto foo.c
9154 gcc -c -O0 -ffat-lto-objects -flto bar.c
9155 gcc -o myprog -O3 foo.o bar.o
9156 @end smallexample
9158 This produces individual object files with unoptimized assembler
9159 code, but the resulting binary @file{myprog} is optimized at
9160 @option{-O3}.  If, instead, the final binary is generated with
9161 @option{-fno-lto}, then @file{myprog} is not optimized.
9163 When producing the final binary, GCC only
9164 applies link-time optimizations to those files that contain bytecode.
9165 Therefore, you can mix and match object files and libraries with
9166 GIMPLE bytecodes and final object code.  GCC automatically selects
9167 which files to optimize in LTO mode and which files to link without
9168 further processing.
9170 There are some code generation flags preserved by GCC when
9171 generating bytecodes, as they need to be used during the final link
9172 stage.  Generally options specified at link time override those
9173 specified at compile time.
9175 If you do not specify an optimization level option @option{-O} at
9176 link time, then GCC uses the highest optimization level 
9177 used when compiling the object files.
9179 Currently, the following options and their settings are taken from
9180 the first object file that explicitly specifies them: 
9181 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9182 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9183 and all the @option{-m} target flags.
9185 Certain ABI-changing flags are required to match in all compilation units,
9186 and trying to override this at link time with a conflicting value
9187 is ignored.  This includes options such as @option{-freg-struct-return}
9188 and @option{-fpcc-struct-return}. 
9190 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9191 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9192 are passed through to the link stage and merged conservatively for
9193 conflicting translation units.  Specifically
9194 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9195 precedence; and for example @option{-ffp-contract=off} takes precedence
9196 over @option{-ffp-contract=fast}.  You can override them at link time.
9198 If LTO encounters objects with C linkage declared with incompatible
9199 types in separate translation units to be linked together (undefined
9200 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9201 issued.  The behavior is still undefined at run time.  Similar
9202 diagnostics may be raised for other languages.
9204 Another feature of LTO is that it is possible to apply interprocedural
9205 optimizations on files written in different languages:
9207 @smallexample
9208 gcc -c -flto foo.c
9209 g++ -c -flto bar.cc
9210 gfortran -c -flto baz.f90
9211 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9212 @end smallexample
9214 Notice that the final link is done with @command{g++} to get the C++
9215 runtime libraries and @option{-lgfortran} is added to get the Fortran
9216 runtime libraries.  In general, when mixing languages in LTO mode, you
9217 should use the same link command options as when mixing languages in a
9218 regular (non-LTO) compilation.
9220 If object files containing GIMPLE bytecode are stored in a library archive, say
9221 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9222 are using a linker with plugin support.  To create static libraries suitable
9223 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9224 and @command{ranlib}; 
9225 to show the symbols of object files with GIMPLE bytecode, use
9226 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9227 and @command{nm} have been compiled with plugin support.  At link time, use the the
9228 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9229 the LTO optimization process:
9231 @smallexample
9232 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9233 @end smallexample
9235 With the linker plugin enabled, the linker extracts the needed
9236 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9237 to make them part of the aggregated GIMPLE image to be optimized.
9239 If you are not using a linker with plugin support and/or do not
9240 enable the linker plugin, then the objects inside @file{libfoo.a}
9241 are extracted and linked as usual, but they do not participate
9242 in the LTO optimization process.  In order to make a static library suitable
9243 for both LTO optimization and usual linkage, compile its object files with
9244 @option{-flto} @option{-ffat-lto-objects}.
9246 Link-time optimizations do not require the presence of the whole program to
9247 operate.  If the program does not require any symbols to be exported, it is
9248 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9249 the interprocedural optimizers to use more aggressive assumptions which may
9250 lead to improved optimization opportunities.
9251 Use of @option{-fwhole-program} is not needed when linker plugin is
9252 active (see @option{-fuse-linker-plugin}).
9254 The current implementation of LTO makes no
9255 attempt to generate bytecode that is portable between different
9256 types of hosts.  The bytecode files are versioned and there is a
9257 strict version check, so bytecode files generated in one version of
9258 GCC do not work with an older or newer version of GCC.
9260 Link-time optimization does not work well with generation of debugging
9261 information.  Combining @option{-flto} with
9262 @option{-g} is currently experimental and expected to produce unexpected
9263 results.
9265 If you specify the optional @var{n}, the optimization and code
9266 generation done at link time is executed in parallel using @var{n}
9267 parallel jobs by utilizing an installed @command{make} program.  The
9268 environment variable @env{MAKE} may be used to override the program
9269 used.  The default value for @var{n} is 1.
9271 You can also specify @option{-flto=jobserver} to use GNU make's
9272 job server mode to determine the number of parallel jobs. This
9273 is useful when the Makefile calling GCC is already executing in parallel.
9274 You must prepend a @samp{+} to the command recipe in the parent Makefile
9275 for this to work.  This option likely only works if @env{MAKE} is
9276 GNU make.
9278 @item -flto-partition=@var{alg}
9279 @opindex flto-partition
9280 Specify the partitioning algorithm used by the link-time optimizer.
9281 The value is either @samp{1to1} to specify a partitioning mirroring
9282 the original source files or @samp{balanced} to specify partitioning
9283 into equally sized chunks (whenever possible) or @samp{max} to create
9284 new partition for every symbol where possible.  Specifying @samp{none}
9285 as an algorithm disables partitioning and streaming completely. 
9286 The default value is @samp{balanced}. While @samp{1to1} can be used
9287 as an workaround for various code ordering issues, the @samp{max}
9288 partitioning is intended for internal testing only.
9289 The value @samp{one} specifies that exactly one partition should be
9290 used while the value @samp{none} bypasses partitioning and executes
9291 the link-time optimization step directly from the WPA phase.
9293 @item -flto-odr-type-merging
9294 @opindex flto-odr-type-merging
9295 Enable streaming of mangled types names of C++ types and their unification
9296 at link time.  This increases size of LTO object files, but enables
9297 diagnostics about One Definition Rule violations.
9299 @item -flto-compression-level=@var{n}
9300 @opindex flto-compression-level
9301 This option specifies the level of compression used for intermediate
9302 language written to LTO object files, and is only meaningful in
9303 conjunction with LTO mode (@option{-flto}).  Valid
9304 values are 0 (no compression) to 9 (maximum compression).  Values
9305 outside this range are clamped to either 0 or 9.  If the option is not
9306 given, a default balanced compression setting is used.
9308 @item -fuse-linker-plugin
9309 @opindex fuse-linker-plugin
9310 Enables the use of a linker plugin during link-time optimization.  This
9311 option relies on plugin support in the linker, which is available in gold
9312 or in GNU ld 2.21 or newer.
9314 This option enables the extraction of object files with GIMPLE bytecode out
9315 of library archives. This improves the quality of optimization by exposing
9316 more code to the link-time optimizer.  This information specifies what
9317 symbols can be accessed externally (by non-LTO object or during dynamic
9318 linking).  Resulting code quality improvements on binaries (and shared
9319 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9320 See @option{-flto} for a description of the effect of this flag and how to
9321 use it.
9323 This option is enabled by default when LTO support in GCC is enabled
9324 and GCC was configured for use with
9325 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9327 @item -ffat-lto-objects
9328 @opindex ffat-lto-objects
9329 Fat LTO objects are object files that contain both the intermediate language
9330 and the object code. This makes them usable for both LTO linking and normal
9331 linking. This option is effective only when compiling with @option{-flto}
9332 and is ignored at link time.
9334 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9335 requires the complete toolchain to be aware of LTO. It requires a linker with
9336 linker plugin support for basic functionality.  Additionally,
9337 @command{nm}, @command{ar} and @command{ranlib}
9338 need to support linker plugins to allow a full-featured build environment
9339 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9340 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9341 to these tools. With non fat LTO makefiles need to be modified to use them.
9343 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9344 support.
9346 @item -fcompare-elim
9347 @opindex fcompare-elim
9348 After register allocation and post-register allocation instruction splitting,
9349 identify arithmetic instructions that compute processor flags similar to a
9350 comparison operation based on that arithmetic.  If possible, eliminate the
9351 explicit comparison operation.
9353 This pass only applies to certain targets that cannot explicitly represent
9354 the comparison operation before register allocation is complete.
9356 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9358 @item -fcprop-registers
9359 @opindex fcprop-registers
9360 After register allocation and post-register allocation instruction splitting,
9361 perform a copy-propagation pass to try to reduce scheduling dependencies
9362 and occasionally eliminate the copy.
9364 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9366 @item -fprofile-correction
9367 @opindex fprofile-correction
9368 Profiles collected using an instrumented binary for multi-threaded programs may
9369 be inconsistent due to missed counter updates. When this option is specified,
9370 GCC uses heuristics to correct or smooth out such inconsistencies. By
9371 default, GCC emits an error message when an inconsistent profile is detected.
9373 @item -fprofile-use
9374 @itemx -fprofile-use=@var{path}
9375 @opindex fprofile-use
9376 Enable profile feedback-directed optimizations, 
9377 and the following optimizations
9378 which are generally profitable only with profile feedback available:
9379 @option{-fbranch-probabilities}, @option{-fvpt},
9380 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9381 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9383 Before you can use this option, you must first generate profiling information.
9384 @xref{Instrumentation Options}, for information about the
9385 @option{-fprofile-generate} option.
9387 By default, GCC emits an error message if the feedback profiles do not
9388 match the source code.  This error can be turned into a warning by using
9389 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9390 code.
9392 If @var{path} is specified, GCC looks at the @var{path} to find
9393 the profile feedback data files. See @option{-fprofile-dir}.
9395 @item -fauto-profile
9396 @itemx -fauto-profile=@var{path}
9397 @opindex fauto-profile
9398 Enable sampling-based feedback-directed optimizations, 
9399 and the following optimizations
9400 which are generally profitable only with profile feedback available:
9401 @option{-fbranch-probabilities}, @option{-fvpt},
9402 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9403 @option{-ftree-vectorize},
9404 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9405 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9406 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9408 @var{path} is the name of a file containing AutoFDO profile information.
9409 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9411 Producing an AutoFDO profile data file requires running your program
9412 with the @command{perf} utility on a supported GNU/Linux target system.
9413 For more information, see @uref{https://perf.wiki.kernel.org/}.
9415 E.g.
9416 @smallexample
9417 perf record -e br_inst_retired:near_taken -b -o perf.data \
9418     -- your_program
9419 @end smallexample
9421 Then use the @command{create_gcov} tool to convert the raw profile data
9422 to a format that can be used by GCC.@  You must also supply the 
9423 unstripped binary for your program to this tool.  
9424 See @uref{https://github.com/google/autofdo}.
9426 E.g.
9427 @smallexample
9428 create_gcov --binary=your_program.unstripped --profile=perf.data \
9429     --gcov=profile.afdo
9430 @end smallexample
9431 @end table
9433 The following options control compiler behavior regarding floating-point 
9434 arithmetic.  These options trade off between speed and
9435 correctness.  All must be specifically enabled.
9437 @table @gcctabopt
9438 @item -ffloat-store
9439 @opindex ffloat-store
9440 Do not store floating-point variables in registers, and inhibit other
9441 options that might change whether a floating-point value is taken from a
9442 register or memory.
9444 @cindex floating-point precision
9445 This option prevents undesirable excess precision on machines such as
9446 the 68000 where the floating registers (of the 68881) keep more
9447 precision than a @code{double} is supposed to have.  Similarly for the
9448 x86 architecture.  For most programs, the excess precision does only
9449 good, but a few programs rely on the precise definition of IEEE floating
9450 point.  Use @option{-ffloat-store} for such programs, after modifying
9451 them to store all pertinent intermediate computations into variables.
9453 @item -fexcess-precision=@var{style}
9454 @opindex fexcess-precision
9455 This option allows further control over excess precision on machines
9456 where floating-point operations occur in a format with more precision or
9457 range than the IEEE standard and interchange floating-point types.  By
9458 default, @option{-fexcess-precision=fast} is in effect; this means that
9459 operations may be carried out in a wider precision than the types specified
9460 in the source if that would result in faster code, and it is unpredictable
9461 when rounding to the types specified in the source code takes place.
9462 When compiling C, if @option{-fexcess-precision=standard} is specified then
9463 excess precision follows the rules specified in ISO C99; in particular,
9464 both casts and assignments cause values to be rounded to their
9465 semantic types (whereas @option{-ffloat-store} only affects
9466 assignments).  This option is enabled by default for C if a strict
9467 conformance option such as @option{-std=c99} is used.
9468 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9469 regardless of whether a strict conformance option is used.
9471 @opindex mfpmath
9472 @option{-fexcess-precision=standard} is not implemented for languages
9473 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9474 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9475 semantics apply without excess precision, and in the latter, rounding
9476 is unpredictable.
9478 @item -ffast-math
9479 @opindex ffast-math
9480 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9481 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9482 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9483 @option{-fexcess-precision=fast}.
9485 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9487 This option is not turned on by any @option{-O} option besides
9488 @option{-Ofast} since it can result in incorrect output for programs
9489 that depend on an exact implementation of IEEE or ISO rules/specifications
9490 for math functions. It may, however, yield faster code for programs
9491 that do not require the guarantees of these specifications.
9493 @item -fno-math-errno
9494 @opindex fno-math-errno
9495 Do not set @code{errno} after calling math functions that are executed
9496 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9497 IEEE exceptions for math error handling may want to use this flag
9498 for speed while maintaining IEEE arithmetic compatibility.
9500 This option is not turned on by any @option{-O} option since
9501 it can result in incorrect output for programs that depend on
9502 an exact implementation of IEEE or ISO rules/specifications for
9503 math functions. It may, however, yield faster code for programs
9504 that do not require the guarantees of these specifications.
9506 The default is @option{-fmath-errno}.
9508 On Darwin systems, the math library never sets @code{errno}.  There is
9509 therefore no reason for the compiler to consider the possibility that
9510 it might, and @option{-fno-math-errno} is the default.
9512 @item -funsafe-math-optimizations
9513 @opindex funsafe-math-optimizations
9515 Allow optimizations for floating-point arithmetic that (a) assume
9516 that arguments and results are valid and (b) may violate IEEE or
9517 ANSI standards.  When used at link time, it may include libraries
9518 or startup files that change the default FPU control word or other
9519 similar optimizations.
9521 This option is not turned on by any @option{-O} option since
9522 it can result in incorrect output for programs that depend on
9523 an exact implementation of IEEE or ISO rules/specifications for
9524 math functions. It may, however, yield faster code for programs
9525 that do not require the guarantees of these specifications.
9526 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9527 @option{-fassociative-math} and @option{-freciprocal-math}.
9529 The default is @option{-fno-unsafe-math-optimizations}.
9531 @item -fassociative-math
9532 @opindex fassociative-math
9534 Allow re-association of operands in series of floating-point operations.
9535 This violates the ISO C and C++ language standard by possibly changing
9536 computation result.  NOTE: re-ordering may change the sign of zero as
9537 well as ignore NaNs and inhibit or create underflow or overflow (and
9538 thus cannot be used on code that relies on rounding behavior like
9539 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9540 and thus may not be used when ordered comparisons are required.
9541 This option requires that both @option{-fno-signed-zeros} and
9542 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9543 much sense with @option{-frounding-math}. For Fortran the option
9544 is automatically enabled when both @option{-fno-signed-zeros} and
9545 @option{-fno-trapping-math} are in effect.
9547 The default is @option{-fno-associative-math}.
9549 @item -freciprocal-math
9550 @opindex freciprocal-math
9552 Allow the reciprocal of a value to be used instead of dividing by
9553 the value if this enables optimizations.  For example @code{x / y}
9554 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9555 is subject to common subexpression elimination.  Note that this loses
9556 precision and increases the number of flops operating on the value.
9558 The default is @option{-fno-reciprocal-math}.
9560 @item -ffinite-math-only
9561 @opindex ffinite-math-only
9562 Allow optimizations for floating-point arithmetic that assume
9563 that arguments and results are not NaNs or +-Infs.
9565 This option is not turned on by any @option{-O} option since
9566 it can result in incorrect output for programs that depend on
9567 an exact implementation of IEEE or ISO rules/specifications for
9568 math functions. It may, however, yield faster code for programs
9569 that do not require the guarantees of these specifications.
9571 The default is @option{-fno-finite-math-only}.
9573 @item -fno-signed-zeros
9574 @opindex fno-signed-zeros
9575 Allow optimizations for floating-point arithmetic that ignore the
9576 signedness of zero.  IEEE arithmetic specifies the behavior of
9577 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9578 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9579 This option implies that the sign of a zero result isn't significant.
9581 The default is @option{-fsigned-zeros}.
9583 @item -fno-trapping-math
9584 @opindex fno-trapping-math
9585 Compile code assuming that floating-point operations cannot generate
9586 user-visible traps.  These traps include division by zero, overflow,
9587 underflow, inexact result and invalid operation.  This option requires
9588 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9589 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9591 This option should never be turned on by any @option{-O} option since
9592 it can result in incorrect output for programs that depend on
9593 an exact implementation of IEEE or ISO rules/specifications for
9594 math functions.
9596 The default is @option{-ftrapping-math}.
9598 @item -frounding-math
9599 @opindex frounding-math
9600 Disable transformations and optimizations that assume default floating-point
9601 rounding behavior.  This is round-to-zero for all floating point
9602 to integer conversions, and round-to-nearest for all other arithmetic
9603 truncations.  This option should be specified for programs that change
9604 the FP rounding mode dynamically, or that may be executed with a
9605 non-default rounding mode.  This option disables constant folding of
9606 floating-point expressions at compile time (which may be affected by
9607 rounding mode) and arithmetic transformations that are unsafe in the
9608 presence of sign-dependent rounding modes.
9610 The default is @option{-fno-rounding-math}.
9612 This option is experimental and does not currently guarantee to
9613 disable all GCC optimizations that are affected by rounding mode.
9614 Future versions of GCC may provide finer control of this setting
9615 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9616 will be used to specify the default state for @code{FENV_ACCESS}.
9618 @item -fsignaling-nans
9619 @opindex fsignaling-nans
9620 Compile code assuming that IEEE signaling NaNs may generate user-visible
9621 traps during floating-point operations.  Setting this option disables
9622 optimizations that may change the number of exceptions visible with
9623 signaling NaNs.  This option implies @option{-ftrapping-math}.
9625 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9626 be defined.
9628 The default is @option{-fno-signaling-nans}.
9630 This option is experimental and does not currently guarantee to
9631 disable all GCC optimizations that affect signaling NaN behavior.
9633 @item -fno-fp-int-builtin-inexact
9634 @opindex fno-fp-int-builtin-inexact
9635 Do not allow the built-in functions @code{ceil}, @code{floor},
9636 @code{round} and @code{trunc}, and their @code{float} and @code{long
9637 double} variants, to generate code that raises the ``inexact''
9638 floating-point exception for noninteger arguments.  ISO C99 and C11
9639 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9640 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9641 functions to do so.
9643 The default is @option{-ffp-int-builtin-inexact}, allowing the
9644 exception to be raised.  This option does nothing unless
9645 @option{-ftrapping-math} is in effect.
9647 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9648 generate a call to a library function then the ``inexact'' exception
9649 may be raised if the library implementation does not follow TS 18661.
9651 @item -fsingle-precision-constant
9652 @opindex fsingle-precision-constant
9653 Treat floating-point constants as single precision instead of
9654 implicitly converting them to double-precision constants.
9656 @item -fcx-limited-range
9657 @opindex fcx-limited-range
9658 When enabled, this option states that a range reduction step is not
9659 needed when performing complex division.  Also, there is no checking
9660 whether the result of a complex multiplication or division is @code{NaN
9661 + I*NaN}, with an attempt to rescue the situation in that case.  The
9662 default is @option{-fno-cx-limited-range}, but is enabled by
9663 @option{-ffast-math}.
9665 This option controls the default setting of the ISO C99
9666 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9667 all languages.
9669 @item -fcx-fortran-rules
9670 @opindex fcx-fortran-rules
9671 Complex multiplication and division follow Fortran rules.  Range
9672 reduction is done as part of complex division, but there is no checking
9673 whether the result of a complex multiplication or division is @code{NaN
9674 + I*NaN}, with an attempt to rescue the situation in that case.
9676 The default is @option{-fno-cx-fortran-rules}.
9678 @end table
9680 The following options control optimizations that may improve
9681 performance, but are not enabled by any @option{-O} options.  This
9682 section includes experimental options that may produce broken code.
9684 @table @gcctabopt
9685 @item -fbranch-probabilities
9686 @opindex fbranch-probabilities
9687 After running a program compiled with @option{-fprofile-arcs}
9688 (@pxref{Instrumentation Options}),
9689 you can compile it a second time using
9690 @option{-fbranch-probabilities}, to improve optimizations based on
9691 the number of times each branch was taken.  When a program
9692 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9693 counts to a file called @file{@var{sourcename}.gcda} for each source
9694 file.  The information in this data file is very dependent on the
9695 structure of the generated code, so you must use the same source code
9696 and the same optimization options for both compilations.
9698 With @option{-fbranch-probabilities}, GCC puts a
9699 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9700 These can be used to improve optimization.  Currently, they are only
9701 used in one place: in @file{reorg.c}, instead of guessing which path a
9702 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9703 exactly determine which path is taken more often.
9705 @item -fprofile-values
9706 @opindex fprofile-values
9707 If combined with @option{-fprofile-arcs}, it adds code so that some
9708 data about values of expressions in the program is gathered.
9710 With @option{-fbranch-probabilities}, it reads back the data gathered
9711 from profiling values of expressions for usage in optimizations.
9713 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9715 @item -fprofile-reorder-functions
9716 @opindex fprofile-reorder-functions
9717 Function reordering based on profile instrumentation collects
9718 first time of execution of a function and orders these functions
9719 in ascending order.
9721 Enabled with @option{-fprofile-use}.
9723 @item -fvpt
9724 @opindex fvpt
9725 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9726 to add code to gather information about values of expressions.
9728 With @option{-fbranch-probabilities}, it reads back the data gathered
9729 and actually performs the optimizations based on them.
9730 Currently the optimizations include specialization of division operations
9731 using the knowledge about the value of the denominator.
9733 @item -frename-registers
9734 @opindex frename-registers
9735 Attempt to avoid false dependencies in scheduled code by making use
9736 of registers left over after register allocation.  This optimization
9737 most benefits processors with lots of registers.  Depending on the
9738 debug information format adopted by the target, however, it can
9739 make debugging impossible, since variables no longer stay in
9740 a ``home register''.
9742 Enabled by default with @option{-funroll-loops}.
9744 @item -fschedule-fusion
9745 @opindex fschedule-fusion
9746 Performs a target dependent pass over the instruction stream to schedule
9747 instructions of same type together because target machine can execute them
9748 more efficiently if they are adjacent to each other in the instruction flow.
9750 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9752 @item -ftracer
9753 @opindex ftracer
9754 Perform tail duplication to enlarge superblock size.  This transformation
9755 simplifies the control flow of the function allowing other optimizations to do
9756 a better job.
9758 Enabled with @option{-fprofile-use}.
9760 @item -funroll-loops
9761 @opindex funroll-loops
9762 Unroll loops whose number of iterations can be determined at compile time or
9763 upon entry to the loop.  @option{-funroll-loops} implies
9764 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9765 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9766 a small constant number of iterations).  This option makes code larger, and may
9767 or may not make it run faster.
9769 Enabled with @option{-fprofile-use}.
9771 @item -funroll-all-loops
9772 @opindex funroll-all-loops
9773 Unroll all loops, even if their number of iterations is uncertain when
9774 the loop is entered.  This usually makes programs run more slowly.
9775 @option{-funroll-all-loops} implies the same options as
9776 @option{-funroll-loops}.
9778 @item -fpeel-loops
9779 @opindex fpeel-loops
9780 Peels loops for which there is enough information that they do not
9781 roll much (from profile feedback or static analysis).  It also turns on
9782 complete loop peeling (i.e.@: complete removal of loops with small constant
9783 number of iterations).
9785 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9787 @item -fmove-loop-invariants
9788 @opindex fmove-loop-invariants
9789 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9790 at level @option{-O1}
9792 @item -fsplit-loops
9793 @opindex fsplit-loops
9794 Split a loop into two if it contains a condition that's always true
9795 for one side of the iteration space and false for the other.
9797 @item -funswitch-loops
9798 @opindex funswitch-loops
9799 Move branches with loop invariant conditions out of the loop, with duplicates
9800 of the loop on both branches (modified according to result of the condition).
9802 @item -floop-unroll-and-jam
9803 @opindex floop-unroll-and-jam
9804 Apply unroll and jam transoformations on feasible loops.  In a loop
9805 nest this unrolls the outer loop by some factor and fuses the resulting
9806 multiple inner loops.
9808 @item -ffunction-sections
9809 @itemx -fdata-sections
9810 @opindex ffunction-sections
9811 @opindex fdata-sections
9812 Place each function or data item into its own section in the output
9813 file if the target supports arbitrary sections.  The name of the
9814 function or the name of the data item determines the section's name
9815 in the output file.
9817 Use these options on systems where the linker can perform optimizations to
9818 improve locality of reference in the instruction space.  Most systems using the
9819 ELF object format have linkers with such optimizations.  On AIX, the linker
9820 rearranges sections (CSECTs) based on the call graph.  The performance impact
9821 varies.
9823 Together with a linker garbage collection (linker @option{--gc-sections}
9824 option) these options may lead to smaller statically-linked executables (after
9825 stripping).
9827 On ELF/DWARF systems these options do not degenerate the quality of the debug
9828 information.  There could be issues with other object files/debug info formats.
9830 Only use these options when there are significant benefits from doing so.  When
9831 you specify these options, the assembler and linker create larger object and
9832 executable files and are also slower.  These options affect code generation.
9833 They prevent optimizations by the compiler and assembler using relative
9834 locations inside a translation unit since the locations are unknown until
9835 link time.  An example of such an optimization is relaxing calls to short call
9836 instructions.
9838 @item -fbranch-target-load-optimize
9839 @opindex fbranch-target-load-optimize
9840 Perform branch target register load optimization before prologue / epilogue
9841 threading.
9842 The use of target registers can typically be exposed only during reload,
9843 thus hoisting loads out of loops and doing inter-block scheduling needs
9844 a separate optimization pass.
9846 @item -fbranch-target-load-optimize2
9847 @opindex fbranch-target-load-optimize2
9848 Perform branch target register load optimization after prologue / epilogue
9849 threading.
9851 @item -fbtr-bb-exclusive
9852 @opindex fbtr-bb-exclusive
9853 When performing branch target register load optimization, don't reuse
9854 branch target registers within any basic block.
9856 @item -fstdarg-opt
9857 @opindex fstdarg-opt
9858 Optimize the prologue of variadic argument functions with respect to usage of
9859 those arguments.
9861 @item -fsection-anchors
9862 @opindex fsection-anchors
9863 Try to reduce the number of symbolic address calculations by using
9864 shared ``anchor'' symbols to address nearby objects.  This transformation
9865 can help to reduce the number of GOT entries and GOT accesses on some
9866 targets.
9868 For example, the implementation of the following function @code{foo}:
9870 @smallexample
9871 static int a, b, c;
9872 int foo (void) @{ return a + b + c; @}
9873 @end smallexample
9875 @noindent
9876 usually calculates the addresses of all three variables, but if you
9877 compile it with @option{-fsection-anchors}, it accesses the variables
9878 from a common anchor point instead.  The effect is similar to the
9879 following pseudocode (which isn't valid C):
9881 @smallexample
9882 int foo (void)
9884   register int *xr = &x;
9885   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9887 @end smallexample
9889 Not all targets support this option.
9891 @item --param @var{name}=@var{value}
9892 @opindex param
9893 In some places, GCC uses various constants to control the amount of
9894 optimization that is done.  For example, GCC does not inline functions
9895 that contain more than a certain number of instructions.  You can
9896 control some of these constants on the command line using the
9897 @option{--param} option.
9899 The names of specific parameters, and the meaning of the values, are
9900 tied to the internals of the compiler, and are subject to change
9901 without notice in future releases.
9903 In each case, the @var{value} is an integer.  The allowable choices for
9904 @var{name} are:
9906 @table @gcctabopt
9907 @item predictable-branch-outcome
9908 When branch is predicted to be taken with probability lower than this threshold
9909 (in percent), then it is considered well predictable. The default is 10.
9911 @item max-rtl-if-conversion-insns
9912 RTL if-conversion tries to remove conditional branches around a block and
9913 replace them with conditionally executed instructions.  This parameter
9914 gives the maximum number of instructions in a block which should be
9915 considered for if-conversion.  The default is 10, though the compiler will
9916 also use other heuristics to decide whether if-conversion is likely to be
9917 profitable.
9919 @item max-rtl-if-conversion-predictable-cost
9920 @item max-rtl-if-conversion-unpredictable-cost
9921 RTL if-conversion will try to remove conditional branches around a block
9922 and replace them with conditionally executed instructions.  These parameters
9923 give the maximum permissible cost for the sequence that would be generated
9924 by if-conversion depending on whether the branch is statically determined
9925 to be predictable or not.  The units for this parameter are the same as
9926 those for the GCC internal seq_cost metric.  The compiler will try to
9927 provide a reasonable default for this parameter using the BRANCH_COST
9928 target macro.
9930 @item max-crossjump-edges
9931 The maximum number of incoming edges to consider for cross-jumping.
9932 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9933 the number of edges incoming to each block.  Increasing values mean
9934 more aggressive optimization, making the compilation time increase with
9935 probably small improvement in executable size.
9937 @item min-crossjump-insns
9938 The minimum number of instructions that must be matched at the end
9939 of two blocks before cross-jumping is performed on them.  This
9940 value is ignored in the case where all instructions in the block being
9941 cross-jumped from are matched.  The default value is 5.
9943 @item max-grow-copy-bb-insns
9944 The maximum code size expansion factor when copying basic blocks
9945 instead of jumping.  The expansion is relative to a jump instruction.
9946 The default value is 8.
9948 @item max-goto-duplication-insns
9949 The maximum number of instructions to duplicate to a block that jumps
9950 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9951 passes, GCC factors computed gotos early in the compilation process,
9952 and unfactors them as late as possible.  Only computed jumps at the
9953 end of a basic blocks with no more than max-goto-duplication-insns are
9954 unfactored.  The default value is 8.
9956 @item max-delay-slot-insn-search
9957 The maximum number of instructions to consider when looking for an
9958 instruction to fill a delay slot.  If more than this arbitrary number of
9959 instructions are searched, the time savings from filling the delay slot
9960 are minimal, so stop searching.  Increasing values mean more
9961 aggressive optimization, making the compilation time increase with probably
9962 small improvement in execution time.
9964 @item max-delay-slot-live-search
9965 When trying to fill delay slots, the maximum number of instructions to
9966 consider when searching for a block with valid live register
9967 information.  Increasing this arbitrarily chosen value means more
9968 aggressive optimization, increasing the compilation time.  This parameter
9969 should be removed when the delay slot code is rewritten to maintain the
9970 control-flow graph.
9972 @item max-gcse-memory
9973 The approximate maximum amount of memory that can be allocated in
9974 order to perform the global common subexpression elimination
9975 optimization.  If more memory than specified is required, the
9976 optimization is not done.
9978 @item max-gcse-insertion-ratio
9979 If the ratio of expression insertions to deletions is larger than this value
9980 for any expression, then RTL PRE inserts or removes the expression and thus
9981 leaves partially redundant computations in the instruction stream.  The default value is 20.
9983 @item max-pending-list-length
9984 The maximum number of pending dependencies scheduling allows
9985 before flushing the current state and starting over.  Large functions
9986 with few branches or calls can create excessively large lists which
9987 needlessly consume memory and resources.
9989 @item max-modulo-backtrack-attempts
9990 The maximum number of backtrack attempts the scheduler should make
9991 when modulo scheduling a loop.  Larger values can exponentially increase
9992 compilation time.
9994 @item max-inline-insns-single
9995 Several parameters control the tree inliner used in GCC@.
9996 This number sets the maximum number of instructions (counted in GCC's
9997 internal representation) in a single function that the tree inliner
9998 considers for inlining.  This only affects functions declared
9999 inline and methods implemented in a class declaration (C++).
10000 The default value is 400.
10002 @item max-inline-insns-auto
10003 When you use @option{-finline-functions} (included in @option{-O3}),
10004 a lot of functions that would otherwise not be considered for inlining
10005 by the compiler are investigated.  To those functions, a different
10006 (more restrictive) limit compared to functions declared inline can
10007 be applied.
10008 The default value is 40.
10010 @item inline-min-speedup
10011 When estimated performance improvement of caller + callee runtime exceeds this
10012 threshold (in percent), the function can be inlined regardless of the limit on
10013 @option{--param max-inline-insns-single} and @option{--param
10014 max-inline-insns-auto}.
10016 @item large-function-insns
10017 The limit specifying really large functions.  For functions larger than this
10018 limit after inlining, inlining is constrained by
10019 @option{--param large-function-growth}.  This parameter is useful primarily
10020 to avoid extreme compilation time caused by non-linear algorithms used by the
10021 back end.
10022 The default value is 2700.
10024 @item large-function-growth
10025 Specifies maximal growth of large function caused by inlining in percents.
10026 The default value is 100 which limits large function growth to 2.0 times
10027 the original size.
10029 @item large-unit-insns
10030 The limit specifying large translation unit.  Growth caused by inlining of
10031 units larger than this limit is limited by @option{--param inline-unit-growth}.
10032 For small units this might be too tight.
10033 For example, consider a unit consisting of function A
10034 that is inline and B that just calls A three times.  If B is small relative to
10035 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10036 large units consisting of small inlineable functions, however, the overall unit
10037 growth limit is needed to avoid exponential explosion of code size.  Thus for
10038 smaller units, the size is increased to @option{--param large-unit-insns}
10039 before applying @option{--param inline-unit-growth}.  The default is 10000.
10041 @item inline-unit-growth
10042 Specifies maximal overall growth of the compilation unit caused by inlining.
10043 The default value is 20 which limits unit growth to 1.2 times the original
10044 size. Cold functions (either marked cold via an attribute or by profile
10045 feedback) are not accounted into the unit size.
10047 @item ipcp-unit-growth
10048 Specifies maximal overall growth of the compilation unit caused by
10049 interprocedural constant propagation.  The default value is 10 which limits
10050 unit growth to 1.1 times the original size.
10052 @item large-stack-frame
10053 The limit specifying large stack frames.  While inlining the algorithm is trying
10054 to not grow past this limit too much.  The default value is 256 bytes.
10056 @item large-stack-frame-growth
10057 Specifies maximal growth of large stack frames caused by inlining in percents.
10058 The default value is 1000 which limits large stack frame growth to 11 times
10059 the original size.
10061 @item max-inline-insns-recursive
10062 @itemx max-inline-insns-recursive-auto
10063 Specifies the maximum number of instructions an out-of-line copy of a
10064 self-recursive inline
10065 function can grow into by performing recursive inlining.
10067 @option{--param max-inline-insns-recursive} applies to functions
10068 declared inline.
10069 For functions not declared inline, recursive inlining
10070 happens only when @option{-finline-functions} (included in @option{-O3}) is
10071 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10072 default value is 450.
10074 @item max-inline-recursive-depth
10075 @itemx max-inline-recursive-depth-auto
10076 Specifies the maximum recursion depth used for recursive inlining.
10078 @option{--param max-inline-recursive-depth} applies to functions
10079 declared inline.  For functions not declared inline, recursive inlining
10080 happens only when @option{-finline-functions} (included in @option{-O3}) is
10081 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10082 default value is 8.
10084 @item min-inline-recursive-probability
10085 Recursive inlining is profitable only for function having deep recursion
10086 in average and can hurt for function having little recursion depth by
10087 increasing the prologue size or complexity of function body to other
10088 optimizers.
10090 When profile feedback is available (see @option{-fprofile-generate}) the actual
10091 recursion depth can be guessed from the probability that function recurses
10092 via a given call expression.  This parameter limits inlining only to call
10093 expressions whose probability exceeds the given threshold (in percents).
10094 The default value is 10.
10096 @item early-inlining-insns
10097 Specify growth that the early inliner can make.  In effect it increases
10098 the amount of inlining for code having a large abstraction penalty.
10099 The default value is 14.
10101 @item max-early-inliner-iterations
10102 Limit of iterations of the early inliner.  This basically bounds
10103 the number of nested indirect calls the early inliner can resolve.
10104 Deeper chains are still handled by late inlining.
10106 @item comdat-sharing-probability
10107 Probability (in percent) that C++ inline function with comdat visibility
10108 are shared across multiple compilation units.  The default value is 20.
10110 @item profile-func-internal-id
10111 A parameter to control whether to use function internal id in profile
10112 database lookup. If the value is 0, the compiler uses an id that
10113 is based on function assembler name and filename, which makes old profile
10114 data more tolerant to source changes such as function reordering etc.
10115 The default value is 0.
10117 @item min-vect-loop-bound
10118 The minimum number of iterations under which loops are not vectorized
10119 when @option{-ftree-vectorize} is used.  The number of iterations after
10120 vectorization needs to be greater than the value specified by this option
10121 to allow vectorization.  The default value is 0.
10123 @item gcse-cost-distance-ratio
10124 Scaling factor in calculation of maximum distance an expression
10125 can be moved by GCSE optimizations.  This is currently supported only in the
10126 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10127 is with simple expressions, i.e., the expressions that have cost
10128 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10129 hoisting of simple expressions.  The default value is 10.
10131 @item gcse-unrestricted-cost
10132 Cost, roughly measured as the cost of a single typical machine
10133 instruction, at which GCSE optimizations do not constrain
10134 the distance an expression can travel.  This is currently
10135 supported only in the code hoisting pass.  The lesser the cost,
10136 the more aggressive code hoisting is.  Specifying 0 
10137 allows all expressions to travel unrestricted distances.
10138 The default value is 3.
10140 @item max-hoist-depth
10141 The depth of search in the dominator tree for expressions to hoist.
10142 This is used to avoid quadratic behavior in hoisting algorithm.
10143 The value of 0 does not limit on the search, but may slow down compilation
10144 of huge functions.  The default value is 30.
10146 @item max-tail-merge-comparisons
10147 The maximum amount of similar bbs to compare a bb with.  This is used to
10148 avoid quadratic behavior in tree tail merging.  The default value is 10.
10150 @item max-tail-merge-iterations
10151 The maximum amount of iterations of the pass over the function.  This is used to
10152 limit compilation time in tree tail merging.  The default value is 2.
10154 @item store-merging-allow-unaligned
10155 Allow the store merging pass to introduce unaligned stores if it is legal to
10156 do so.  The default value is 1.
10158 @item max-stores-to-merge
10159 The maximum number of stores to attempt to merge into wider stores in the store
10160 merging pass.  The minimum value is 2 and the default is 64.
10162 @item max-unrolled-insns
10163 The maximum number of instructions that a loop may have to be unrolled.
10164 If a loop is unrolled, this parameter also determines how many times
10165 the loop code is unrolled.
10167 @item max-average-unrolled-insns
10168 The maximum number of instructions biased by probabilities of their execution
10169 that a loop may have to be unrolled.  If a loop is unrolled,
10170 this parameter also determines how many times the loop code is unrolled.
10172 @item max-unroll-times
10173 The maximum number of unrollings of a single loop.
10175 @item max-peeled-insns
10176 The maximum number of instructions that a loop may have to be peeled.
10177 If a loop is peeled, this parameter also determines how many times
10178 the loop code is peeled.
10180 @item max-peel-times
10181 The maximum number of peelings of a single loop.
10183 @item max-peel-branches
10184 The maximum number of branches on the hot path through the peeled sequence.
10186 @item max-completely-peeled-insns
10187 The maximum number of insns of a completely peeled loop.
10189 @item max-completely-peel-times
10190 The maximum number of iterations of a loop to be suitable for complete peeling.
10192 @item max-completely-peel-loop-nest-depth
10193 The maximum depth of a loop nest suitable for complete peeling.
10195 @item max-unswitch-insns
10196 The maximum number of insns of an unswitched loop.
10198 @item max-unswitch-level
10199 The maximum number of branches unswitched in a single loop.
10201 @item max-loop-headers-insns
10202 The maximum number of insns in loop header duplicated by the copy loop headers
10203 pass.
10205 @item lim-expensive
10206 The minimum cost of an expensive expression in the loop invariant motion.
10208 @item iv-consider-all-candidates-bound
10209 Bound on number of candidates for induction variables, below which
10210 all candidates are considered for each use in induction variable
10211 optimizations.  If there are more candidates than this,
10212 only the most relevant ones are considered to avoid quadratic time complexity.
10214 @item iv-max-considered-uses
10215 The induction variable optimizations give up on loops that contain more
10216 induction variable uses.
10218 @item iv-always-prune-cand-set-bound
10219 If the number of candidates in the set is smaller than this value,
10220 always try to remove unnecessary ivs from the set
10221 when adding a new one.
10223 @item avg-loop-niter
10224 Average number of iterations of a loop.
10226 @item dse-max-object-size
10227 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10228 Larger values may result in larger compilation times.
10230 @item scev-max-expr-size
10231 Bound on size of expressions used in the scalar evolutions analyzer.
10232 Large expressions slow the analyzer.
10234 @item scev-max-expr-complexity
10235 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10236 Complex expressions slow the analyzer.
10238 @item max-tree-if-conversion-phi-args
10239 Maximum number of arguments in a PHI supported by TREE if conversion
10240 unless the loop is marked with simd pragma.
10242 @item vect-max-version-for-alignment-checks
10243 The maximum number of run-time checks that can be performed when
10244 doing loop versioning for alignment in the vectorizer.
10246 @item vect-max-version-for-alias-checks
10247 The maximum number of run-time checks that can be performed when
10248 doing loop versioning for alias in the vectorizer.
10250 @item vect-max-peeling-for-alignment
10251 The maximum number of loop peels to enhance access alignment
10252 for vectorizer. Value -1 means no limit.
10254 @item max-iterations-to-track
10255 The maximum number of iterations of a loop the brute-force algorithm
10256 for analysis of the number of iterations of the loop tries to evaluate.
10258 @item hot-bb-count-ws-permille
10259 A basic block profile count is considered hot if it contributes to 
10260 the given permillage (i.e. 0...1000) of the entire profiled execution.
10262 @item hot-bb-frequency-fraction
10263 Select fraction of the entry block frequency of executions of basic block in
10264 function given basic block needs to have to be considered hot.
10266 @item max-predicted-iterations
10267 The maximum number of loop iterations we predict statically.  This is useful
10268 in cases where a function contains a single loop with known bound and
10269 another loop with unknown bound.
10270 The known number of iterations is predicted correctly, while
10271 the unknown number of iterations average to roughly 10.  This means that the
10272 loop without bounds appears artificially cold relative to the other one.
10274 @item builtin-expect-probability
10275 Control the probability of the expression having the specified value. This
10276 parameter takes a percentage (i.e. 0 ... 100) as input.
10277 The default probability of 90 is obtained empirically.
10279 @item align-threshold
10281 Select fraction of the maximal frequency of executions of a basic block in
10282 a function to align the basic block.
10284 @item align-loop-iterations
10286 A loop expected to iterate at least the selected number of iterations is
10287 aligned.
10289 @item tracer-dynamic-coverage
10290 @itemx tracer-dynamic-coverage-feedback
10292 This value is used to limit superblock formation once the given percentage of
10293 executed instructions is covered.  This limits unnecessary code size
10294 expansion.
10296 The @option{tracer-dynamic-coverage-feedback} parameter
10297 is used only when profile
10298 feedback is available.  The real profiles (as opposed to statically estimated
10299 ones) are much less balanced allowing the threshold to be larger value.
10301 @item tracer-max-code-growth
10302 Stop tail duplication once code growth has reached given percentage.  This is
10303 a rather artificial limit, as most of the duplicates are eliminated later in
10304 cross jumping, so it may be set to much higher values than is the desired code
10305 growth.
10307 @item tracer-min-branch-ratio
10309 Stop reverse growth when the reverse probability of best edge is less than this
10310 threshold (in percent).
10312 @item tracer-min-branch-probability
10313 @itemx tracer-min-branch-probability-feedback
10315 Stop forward growth if the best edge has probability lower than this
10316 threshold.
10318 Similarly to @option{tracer-dynamic-coverage} two parameters are
10319 provided.  @option{tracer-min-branch-probability-feedback} is used for
10320 compilation with profile feedback and @option{tracer-min-branch-probability}
10321 compilation without.  The value for compilation with profile feedback
10322 needs to be more conservative (higher) in order to make tracer
10323 effective.
10325 @item stack-clash-protection-guard-size
10326 Specify the size of the operating system provided stack guard as
10327 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10328 Acceptable values are between 12 and 30.  Higher values may reduce the
10329 number of explicit probes, but a value larger than the operating system
10330 provided guard will leave code vulnerable to stack clash style attacks.
10332 @item stack-clash-protection-probe-interval
10333 Stack clash protection involves probing stack space as it is allocated.  This
10334 param controls the maximum distance between probes into the stack as 2 raised
10335 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10336 12.  Higher values may reduce the number of explicit probes, but a value
10337 larger than the operating system provided guard will leave code vulnerable to
10338 stack clash style attacks.
10340 @item max-cse-path-length
10342 The maximum number of basic blocks on path that CSE considers.
10343 The default is 10.
10345 @item max-cse-insns
10346 The maximum number of instructions CSE processes before flushing.
10347 The default is 1000.
10349 @item ggc-min-expand
10351 GCC uses a garbage collector to manage its own memory allocation.  This
10352 parameter specifies the minimum percentage by which the garbage
10353 collector's heap should be allowed to expand between collections.
10354 Tuning this may improve compilation speed; it has no effect on code
10355 generation.
10357 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10358 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10359 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10360 GCC is not able to calculate RAM on a particular platform, the lower
10361 bound of 30% is used.  Setting this parameter and
10362 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10363 every opportunity.  This is extremely slow, but can be useful for
10364 debugging.
10366 @item ggc-min-heapsize
10368 Minimum size of the garbage collector's heap before it begins bothering
10369 to collect garbage.  The first collection occurs after the heap expands
10370 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10371 tuning this may improve compilation speed, and has no effect on code
10372 generation.
10374 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10375 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10376 with a lower bound of 4096 (four megabytes) and an upper bound of
10377 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10378 particular platform, the lower bound is used.  Setting this parameter
10379 very large effectively disables garbage collection.  Setting this
10380 parameter and @option{ggc-min-expand} to zero causes a full collection
10381 to occur at every opportunity.
10383 @item max-reload-search-insns
10384 The maximum number of instruction reload should look backward for equivalent
10385 register.  Increasing values mean more aggressive optimization, making the
10386 compilation time increase with probably slightly better performance.
10387 The default value is 100.
10389 @item max-cselib-memory-locations
10390 The maximum number of memory locations cselib should take into account.
10391 Increasing values mean more aggressive optimization, making the compilation time
10392 increase with probably slightly better performance.  The default value is 500.
10394 @item max-sched-ready-insns
10395 The maximum number of instructions ready to be issued the scheduler should
10396 consider at any given time during the first scheduling pass.  Increasing
10397 values mean more thorough searches, making the compilation time increase
10398 with probably little benefit.  The default value is 100.
10400 @item max-sched-region-blocks
10401 The maximum number of blocks in a region to be considered for
10402 interblock scheduling.  The default value is 10.
10404 @item max-pipeline-region-blocks
10405 The maximum number of blocks in a region to be considered for
10406 pipelining in the selective scheduler.  The default value is 15.
10408 @item max-sched-region-insns
10409 The maximum number of insns in a region to be considered for
10410 interblock scheduling.  The default value is 100.
10412 @item max-pipeline-region-insns
10413 The maximum number of insns in a region to be considered for
10414 pipelining in the selective scheduler.  The default value is 200.
10416 @item min-spec-prob
10417 The minimum probability (in percents) of reaching a source block
10418 for interblock speculative scheduling.  The default value is 40.
10420 @item max-sched-extend-regions-iters
10421 The maximum number of iterations through CFG to extend regions.
10422 A value of 0 (the default) disables region extensions.
10424 @item max-sched-insn-conflict-delay
10425 The maximum conflict delay for an insn to be considered for speculative motion.
10426 The default value is 3.
10428 @item sched-spec-prob-cutoff
10429 The minimal probability of speculation success (in percents), so that
10430 speculative insns are scheduled.
10431 The default value is 40.
10433 @item sched-state-edge-prob-cutoff
10434 The minimum probability an edge must have for the scheduler to save its
10435 state across it.
10436 The default value is 10.
10438 @item sched-mem-true-dep-cost
10439 Minimal distance (in CPU cycles) between store and load targeting same
10440 memory locations.  The default value is 1.
10442 @item selsched-max-lookahead
10443 The maximum size of the lookahead window of selective scheduling.  It is a
10444 depth of search for available instructions.
10445 The default value is 50.
10447 @item selsched-max-sched-times
10448 The maximum number of times that an instruction is scheduled during
10449 selective scheduling.  This is the limit on the number of iterations
10450 through which the instruction may be pipelined.  The default value is 2.
10452 @item selsched-insns-to-rename
10453 The maximum number of best instructions in the ready list that are considered
10454 for renaming in the selective scheduler.  The default value is 2.
10456 @item sms-min-sc
10457 The minimum value of stage count that swing modulo scheduler
10458 generates.  The default value is 2.
10460 @item max-last-value-rtl
10461 The maximum size measured as number of RTLs that can be recorded in an expression
10462 in combiner for a pseudo register as last known value of that register.  The default
10463 is 10000.
10465 @item max-combine-insns
10466 The maximum number of instructions the RTL combiner tries to combine.
10467 The default value is 2 at @option{-Og} and 4 otherwise.
10469 @item integer-share-limit
10470 Small integer constants can use a shared data structure, reducing the
10471 compiler's memory usage and increasing its speed.  This sets the maximum
10472 value of a shared integer constant.  The default value is 256.
10474 @item ssp-buffer-size
10475 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10476 protection when @option{-fstack-protection} is used.
10478 @item min-size-for-stack-sharing
10479 The minimum size of variables taking part in stack slot sharing when not
10480 optimizing. The default value is 32.
10482 @item max-jump-thread-duplication-stmts
10483 Maximum number of statements allowed in a block that needs to be
10484 duplicated when threading jumps.
10486 @item max-fields-for-field-sensitive
10487 Maximum number of fields in a structure treated in
10488 a field sensitive manner during pointer analysis.  The default is zero
10489 for @option{-O0} and @option{-O1},
10490 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10492 @item prefetch-latency
10493 Estimate on average number of instructions that are executed before
10494 prefetch finishes.  The distance prefetched ahead is proportional
10495 to this constant.  Increasing this number may also lead to less
10496 streams being prefetched (see @option{simultaneous-prefetches}).
10498 @item simultaneous-prefetches
10499 Maximum number of prefetches that can run at the same time.
10501 @item l1-cache-line-size
10502 The size of cache line in L1 cache, in bytes.
10504 @item l1-cache-size
10505 The size of L1 cache, in kilobytes.
10507 @item l2-cache-size
10508 The size of L2 cache, in kilobytes.
10510 @item loop-interchange-max-num-stmts
10511 The maximum number of stmts in a loop to be interchanged.
10513 @item loop-interchange-stride-ratio
10514 The minimum ratio between stride of two loops for interchange to be profitable.
10516 @item min-insn-to-prefetch-ratio
10517 The minimum ratio between the number of instructions and the
10518 number of prefetches to enable prefetching in a loop.
10520 @item prefetch-min-insn-to-mem-ratio
10521 The minimum ratio between the number of instructions and the
10522 number of memory references to enable prefetching in a loop.
10524 @item use-canonical-types
10525 Whether the compiler should use the ``canonical'' type system.  By
10526 default, this should always be 1, which uses a more efficient internal
10527 mechanism for comparing types in C++ and Objective-C++.  However, if
10528 bugs in the canonical type system are causing compilation failures,
10529 set this value to 0 to disable canonical types.
10531 @item switch-conversion-max-branch-ratio
10532 Switch initialization conversion refuses to create arrays that are
10533 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10534 branches in the switch.
10536 @item max-partial-antic-length
10537 Maximum length of the partial antic set computed during the tree
10538 partial redundancy elimination optimization (@option{-ftree-pre}) when
10539 optimizing at @option{-O3} and above.  For some sorts of source code
10540 the enhanced partial redundancy elimination optimization can run away,
10541 consuming all of the memory available on the host machine.  This
10542 parameter sets a limit on the length of the sets that are computed,
10543 which prevents the runaway behavior.  Setting a value of 0 for
10544 this parameter allows an unlimited set length.
10546 @item sccvn-max-scc-size
10547 Maximum size of a strongly connected component (SCC) during SCCVN
10548 processing.  If this limit is hit, SCCVN processing for the whole
10549 function is not done and optimizations depending on it are
10550 disabled.  The default maximum SCC size is 10000.
10552 @item sccvn-max-alias-queries-per-access
10553 Maximum number of alias-oracle queries we perform when looking for
10554 redundancies for loads and stores.  If this limit is hit the search
10555 is aborted and the load or store is not considered redundant.  The
10556 number of queries is algorithmically limited to the number of
10557 stores on all paths from the load to the function entry.
10558 The default maximum number of queries is 1000.
10560 @item ira-max-loops-num
10561 IRA uses regional register allocation by default.  If a function
10562 contains more loops than the number given by this parameter, only at most
10563 the given number of the most frequently-executed loops form regions
10564 for regional register allocation.  The default value of the
10565 parameter is 100.
10567 @item ira-max-conflict-table-size 
10568 Although IRA uses a sophisticated algorithm to compress the conflict
10569 table, the table can still require excessive amounts of memory for
10570 huge functions.  If the conflict table for a function could be more
10571 than the size in MB given by this parameter, the register allocator
10572 instead uses a faster, simpler, and lower-quality
10573 algorithm that does not require building a pseudo-register conflict table.  
10574 The default value of the parameter is 2000.
10576 @item ira-loop-reserved-regs
10577 IRA can be used to evaluate more accurate register pressure in loops
10578 for decisions to move loop invariants (see @option{-O3}).  The number
10579 of available registers reserved for some other purposes is given
10580 by this parameter.  The default value of the parameter is 2, which is
10581 the minimal number of registers needed by typical instructions.
10582 This value is the best found from numerous experiments.
10584 @item lra-inheritance-ebb-probability-cutoff
10585 LRA tries to reuse values reloaded in registers in subsequent insns.
10586 This optimization is called inheritance.  EBB is used as a region to
10587 do this optimization.  The parameter defines a minimal fall-through
10588 edge probability in percentage used to add BB to inheritance EBB in
10589 LRA.  The default value of the parameter is 40.  The value was chosen
10590 from numerous runs of SPEC2000 on x86-64.
10592 @item loop-invariant-max-bbs-in-loop
10593 Loop invariant motion can be very expensive, both in compilation time and
10594 in amount of needed compile-time memory, with very large loops.  Loops
10595 with more basic blocks than this parameter won't have loop invariant
10596 motion optimization performed on them.  The default value of the
10597 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10599 @item loop-max-datarefs-for-datadeps
10600 Building data dependencies is expensive for very large loops.  This
10601 parameter limits the number of data references in loops that are
10602 considered for data dependence analysis.  These large loops are no
10603 handled by the optimizations using loop data dependencies.
10604 The default value is 1000.
10606 @item max-vartrack-size
10607 Sets a maximum number of hash table slots to use during variable
10608 tracking dataflow analysis of any function.  If this limit is exceeded
10609 with variable tracking at assignments enabled, analysis for that
10610 function is retried without it, after removing all debug insns from
10611 the function.  If the limit is exceeded even without debug insns, var
10612 tracking analysis is completely disabled for the function.  Setting
10613 the parameter to zero makes it unlimited.
10615 @item max-vartrack-expr-depth
10616 Sets a maximum number of recursion levels when attempting to map
10617 variable names or debug temporaries to value expressions.  This trades
10618 compilation time for more complete debug information.  If this is set too
10619 low, value expressions that are available and could be represented in
10620 debug information may end up not being used; setting this higher may
10621 enable the compiler to find more complex debug expressions, but compile
10622 time and memory use may grow.  The default is 12.
10624 @item max-debug-marker-count
10625 Sets a threshold on the number of debug markers (e.g. begin stmt
10626 markers) to avoid complexity explosion at inlining or expanding to RTL.
10627 If a function has more such gimple stmts than the set limit, such stmts
10628 will be dropped from the inlined copy of a function, and from its RTL
10629 expansion.  The default is 100000.
10631 @item min-nondebug-insn-uid
10632 Use uids starting at this parameter for nondebug insns.  The range below
10633 the parameter is reserved exclusively for debug insns created by
10634 @option{-fvar-tracking-assignments}, but debug insns may get
10635 (non-overlapping) uids above it if the reserved range is exhausted.
10637 @item ipa-sra-ptr-growth-factor
10638 IPA-SRA replaces a pointer to an aggregate with one or more new
10639 parameters only when their cumulative size is less or equal to
10640 @option{ipa-sra-ptr-growth-factor} times the size of the original
10641 pointer parameter.
10643 @item sra-max-scalarization-size-Ospeed
10644 @item sra-max-scalarization-size-Osize
10645 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10646 replace scalar parts of aggregates with uses of independent scalar
10647 variables.  These parameters control the maximum size, in storage units,
10648 of aggregate which is considered for replacement when compiling for
10649 speed
10650 (@option{sra-max-scalarization-size-Ospeed}) or size
10651 (@option{sra-max-scalarization-size-Osize}) respectively.
10653 @item tm-max-aggregate-size
10654 When making copies of thread-local variables in a transaction, this
10655 parameter specifies the size in bytes after which variables are
10656 saved with the logging functions as opposed to save/restore code
10657 sequence pairs.  This option only applies when using
10658 @option{-fgnu-tm}.
10660 @item graphite-max-nb-scop-params
10661 To avoid exponential effects in the Graphite loop transforms, the
10662 number of parameters in a Static Control Part (SCoP) is bounded.  The
10663 default value is 10 parameters, a value of zero can be used to lift
10664 the bound.  A variable whose value is unknown at compilation time and
10665 defined outside a SCoP is a parameter of the SCoP.
10667 @item loop-block-tile-size
10668 Loop blocking or strip mining transforms, enabled with
10669 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10670 loop in the loop nest by a given number of iterations.  The strip
10671 length can be changed using the @option{loop-block-tile-size}
10672 parameter.  The default value is 51 iterations.
10674 @item loop-unroll-jam-size
10675 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10676 default value is 4.
10678 @item loop-unroll-jam-depth
10679 Specify the dimension to be unrolled (counting from the most inner loop)
10680 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10682 @item ipa-cp-value-list-size
10683 IPA-CP attempts to track all possible values and types passed to a function's
10684 parameter in order to propagate them and perform devirtualization.
10685 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10686 stores per one formal parameter of a function.
10688 @item ipa-cp-eval-threshold
10689 IPA-CP calculates its own score of cloning profitability heuristics
10690 and performs those cloning opportunities with scores that exceed
10691 @option{ipa-cp-eval-threshold}.
10693 @item ipa-cp-recursion-penalty
10694 Percentage penalty the recursive functions will receive when they
10695 are evaluated for cloning.
10697 @item ipa-cp-single-call-penalty
10698 Percentage penalty functions containing a single call to another
10699 function will receive when they are evaluated for cloning.
10702 @item ipa-max-agg-items
10703 IPA-CP is also capable to propagate a number of scalar values passed
10704 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10705 number of such values per one parameter.
10707 @item ipa-cp-loop-hint-bonus
10708 When IPA-CP determines that a cloning candidate would make the number
10709 of iterations of a loop known, it adds a bonus of
10710 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10711 the candidate.
10713 @item ipa-cp-array-index-hint-bonus
10714 When IPA-CP determines that a cloning candidate would make the index of
10715 an array access known, it adds a bonus of
10716 @option{ipa-cp-array-index-hint-bonus} to the profitability
10717 score of the candidate.
10719 @item ipa-max-aa-steps
10720 During its analysis of function bodies, IPA-CP employs alias analysis
10721 in order to track values pointed to by function parameters.  In order
10722 not spend too much time analyzing huge functions, it gives up and
10723 consider all memory clobbered after examining
10724 @option{ipa-max-aa-steps} statements modifying memory.
10726 @item lto-partitions
10727 Specify desired number of partitions produced during WHOPR compilation.
10728 The number of partitions should exceed the number of CPUs used for compilation.
10729 The default value is 32.
10731 @item lto-min-partition
10732 Size of minimal partition for WHOPR (in estimated instructions).
10733 This prevents expenses of splitting very small programs into too many
10734 partitions.
10736 @item lto-max-partition
10737 Size of max partition for WHOPR (in estimated instructions).
10738 to provide an upper bound for individual size of partition.
10739 Meant to be used only with balanced partitioning.
10741 @item cxx-max-namespaces-for-diagnostic-help
10742 The maximum number of namespaces to consult for suggestions when C++
10743 name lookup fails for an identifier.  The default is 1000.
10745 @item sink-frequency-threshold
10746 The maximum relative execution frequency (in percents) of the target block
10747 relative to a statement's original block to allow statement sinking of a
10748 statement.  Larger numbers result in more aggressive statement sinking.
10749 The default value is 75.  A small positive adjustment is applied for
10750 statements with memory operands as those are even more profitable so sink.
10752 @item max-stores-to-sink
10753 The maximum number of conditional store pairs that can be sunk.  Set to 0
10754 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10755 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10757 @item allow-store-data-races
10758 Allow optimizers to introduce new data races on stores.
10759 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10760 at optimization level @option{-Ofast}.
10762 @item case-values-threshold
10763 The smallest number of different values for which it is best to use a
10764 jump-table instead of a tree of conditional branches.  If the value is
10765 0, use the default for the machine.  The default is 0.
10767 @item tree-reassoc-width
10768 Set the maximum number of instructions executed in parallel in
10769 reassociated tree. This parameter overrides target dependent
10770 heuristics used by default if has non zero value.
10772 @item sched-pressure-algorithm
10773 Choose between the two available implementations of
10774 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10775 and is the more likely to prevent instructions from being reordered.
10776 Algorithm 2 was designed to be a compromise between the relatively
10777 conservative approach taken by algorithm 1 and the rather aggressive
10778 approach taken by the default scheduler.  It relies more heavily on
10779 having a regular register file and accurate register pressure classes.
10780 See @file{haifa-sched.c} in the GCC sources for more details.
10782 The default choice depends on the target.
10784 @item max-slsr-cand-scan
10785 Set the maximum number of existing candidates that are considered when
10786 seeking a basis for a new straight-line strength reduction candidate.
10788 @item asan-globals
10789 Enable buffer overflow detection for global objects.  This kind
10790 of protection is enabled by default if you are using
10791 @option{-fsanitize=address} option.
10792 To disable global objects protection use @option{--param asan-globals=0}.
10794 @item asan-stack
10795 Enable buffer overflow detection for stack objects.  This kind of
10796 protection is enabled by default when using @option{-fsanitize=address}.
10797 To disable stack protection use @option{--param asan-stack=0} option.
10799 @item asan-instrument-reads
10800 Enable buffer overflow detection for memory reads.  This kind of
10801 protection is enabled by default when using @option{-fsanitize=address}.
10802 To disable memory reads protection use
10803 @option{--param asan-instrument-reads=0}.
10805 @item asan-instrument-writes
10806 Enable buffer overflow detection for memory writes.  This kind of
10807 protection is enabled by default when using @option{-fsanitize=address}.
10808 To disable memory writes protection use
10809 @option{--param asan-instrument-writes=0} option.
10811 @item asan-memintrin
10812 Enable detection for built-in functions.  This kind of protection
10813 is enabled by default when using @option{-fsanitize=address}.
10814 To disable built-in functions protection use
10815 @option{--param asan-memintrin=0}.
10817 @item asan-use-after-return
10818 Enable detection of use-after-return.  This kind of protection
10819 is enabled by default when using the @option{-fsanitize=address} option.
10820 To disable it use @option{--param asan-use-after-return=0}.
10822 Note: By default the check is disabled at run time.  To enable it,
10823 add @code{detect_stack_use_after_return=1} to the environment variable
10824 @env{ASAN_OPTIONS}.
10826 @item asan-instrumentation-with-call-threshold
10827 If number of memory accesses in function being instrumented
10828 is greater or equal to this number, use callbacks instead of inline checks.
10829 E.g. to disable inline code use
10830 @option{--param asan-instrumentation-with-call-threshold=0}.
10832 @item use-after-scope-direct-emission-threshold
10833 If the size of a local variable in bytes is smaller or equal to this
10834 number, directly poison (or unpoison) shadow memory instead of using
10835 run-time callbacks.  The default value is 256.
10837 @item chkp-max-ctor-size
10838 Static constructors generated by Pointer Bounds Checker may become very
10839 large and significantly increase compile time at optimization level
10840 @option{-O1} and higher.  This parameter is a maximum number of statements
10841 in a single generated constructor.  Default value is 5000.
10843 @item max-fsm-thread-path-insns
10844 Maximum number of instructions to copy when duplicating blocks on a
10845 finite state automaton jump thread path.  The default is 100.
10847 @item max-fsm-thread-length
10848 Maximum number of basic blocks on a finite state automaton jump thread
10849 path.  The default is 10.
10851 @item max-fsm-thread-paths
10852 Maximum number of new jump thread paths to create for a finite state
10853 automaton.  The default is 50.
10855 @item parloops-chunk-size
10856 Chunk size of omp schedule for loops parallelized by parloops.  The default
10857 is 0.
10859 @item parloops-schedule
10860 Schedule type of omp schedule for loops parallelized by parloops (static,
10861 dynamic, guided, auto, runtime).  The default is static.
10863 @item parloops-min-per-thread
10864 The minimum number of iterations per thread of an innermost parallelized
10865 loop for which the parallelized variant is prefered over the single threaded
10866 one.  The default is 100.  Note that for a parallelized loop nest the
10867 minimum number of iterations of the outermost loop per thread is two.
10869 @item max-ssa-name-query-depth
10870 Maximum depth of recursion when querying properties of SSA names in things
10871 like fold routines.  One level of recursion corresponds to following a
10872 use-def chain.
10874 @item hsa-gen-debug-stores
10875 Enable emission of special debug stores within HSA kernels which are
10876 then read and reported by libgomp plugin.  Generation of these stores
10877 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10878 enable it.
10880 @item max-speculative-devirt-maydefs
10881 The maximum number of may-defs we analyze when looking for a must-def
10882 specifying the dynamic type of an object that invokes a virtual call
10883 we may be able to devirtualize speculatively.
10885 @item max-vrp-switch-assertions
10886 The maximum number of assertions to add along the default edge of a switch
10887 statement during VRP.  The default is 10.
10889 @item unroll-jam-min-percent
10890 The minimum percentage of memory references that must be optimized
10891 away for the unroll-and-jam transformation to be considered profitable.
10893 @item unroll-jam-max-unroll
10894 The maximum number of times the outer loop should be unrolled by
10895 the unroll-and-jam transformation.
10896 @end table
10897 @end table
10899 @node Instrumentation Options
10900 @section Program Instrumentation Options
10901 @cindex instrumentation options
10902 @cindex program instrumentation options
10903 @cindex run-time error checking options
10904 @cindex profiling options
10905 @cindex options, program instrumentation
10906 @cindex options, run-time error checking
10907 @cindex options, profiling
10909 GCC supports a number of command-line options that control adding
10910 run-time instrumentation to the code it normally generates.  
10911 For example, one purpose of instrumentation is collect profiling
10912 statistics for use in finding program hot spots, code coverage
10913 analysis, or profile-guided optimizations.
10914 Another class of program instrumentation is adding run-time checking 
10915 to detect programming errors like invalid pointer
10916 dereferences or out-of-bounds array accesses, as well as deliberately
10917 hostile attacks such as stack smashing or C++ vtable hijacking.
10918 There is also a general hook which can be used to implement other
10919 forms of tracing or function-level instrumentation for debug or
10920 program analysis purposes.
10922 @table @gcctabopt
10923 @cindex @command{prof}
10924 @item -p
10925 @opindex p
10926 Generate extra code to write profile information suitable for the
10927 analysis program @command{prof}.  You must use this option when compiling
10928 the source files you want data about, and you must also use it when
10929 linking.
10931 @cindex @command{gprof}
10932 @item -pg
10933 @opindex pg
10934 Generate extra code to write profile information suitable for the
10935 analysis program @command{gprof}.  You must use this option when compiling
10936 the source files you want data about, and you must also use it when
10937 linking.
10939 @item -fprofile-arcs
10940 @opindex fprofile-arcs
10941 Add code so that program flow @dfn{arcs} are instrumented.  During
10942 execution the program records how many times each branch and call is
10943 executed and how many times it is taken or returns.  On targets that support
10944 constructors with priority support, profiling properly handles constructors,
10945 destructors and C++ constructors (and destructors) of classes which are used
10946 as a type of a global variable.
10948 When the compiled
10949 program exits it saves this data to a file called
10950 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10951 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10952 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10953 @var{auxname} is generated from the name of the output file, if
10954 explicitly specified and it is not the final executable, otherwise it is
10955 the basename of the source file.  In both cases any suffix is removed
10956 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10957 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10958 @xref{Cross-profiling}.
10960 @cindex @command{gcov}
10961 @item --coverage
10962 @opindex coverage
10964 This option is used to compile and link code instrumented for coverage
10965 analysis.  The option is a synonym for @option{-fprofile-arcs}
10966 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10967 linking).  See the documentation for those options for more details.
10969 @itemize
10971 @item
10972 Compile the source files with @option{-fprofile-arcs} plus optimization
10973 and code generation options.  For test coverage analysis, use the
10974 additional @option{-ftest-coverage} option.  You do not need to profile
10975 every source file in a program.
10977 @item
10978 Compile the source files additionally with @option{-fprofile-abs-path}
10979 to create absolute path names in the @file{.gcno} files.  This allows
10980 @command{gcov} to find the correct sources in projects where compilations
10981 occur with different working directories.
10983 @item
10984 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10985 (the latter implies the former).
10987 @item
10988 Run the program on a representative workload to generate the arc profile
10989 information.  This may be repeated any number of times.  You can run
10990 concurrent instances of your program, and provided that the file system
10991 supports locking, the data files will be correctly updated.  Unless
10992 a strict ISO C dialect option is in effect, @code{fork} calls are
10993 detected and correctly handled without double counting.
10995 @item
10996 For profile-directed optimizations, compile the source files again with
10997 the same optimization and code generation options plus
10998 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10999 Control Optimization}).
11001 @item
11002 For test coverage analysis, use @command{gcov} to produce human readable
11003 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11004 @command{gcov} documentation for further information.
11006 @end itemize
11008 With @option{-fprofile-arcs}, for each function of your program GCC
11009 creates a program flow graph, then finds a spanning tree for the graph.
11010 Only arcs that are not on the spanning tree have to be instrumented: the
11011 compiler adds code to count the number of times that these arcs are
11012 executed.  When an arc is the only exit or only entrance to a block, the
11013 instrumentation code can be added to the block; otherwise, a new basic
11014 block must be created to hold the instrumentation code.
11016 @need 2000
11017 @item -ftest-coverage
11018 @opindex ftest-coverage
11019 Produce a notes file that the @command{gcov} code-coverage utility
11020 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11021 show program coverage.  Each source file's note file is called
11022 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11023 above for a description of @var{auxname} and instructions on how to
11024 generate test coverage data.  Coverage data matches the source files
11025 more closely if you do not optimize.
11027 @item -fprofile-abs-path
11028 @opindex fprofile-abs-path
11029 Automatically convert relative source file names to absolute path names
11030 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11031 sources in projects where compilations occur with different working
11032 directories.
11034 @item -fprofile-dir=@var{path}
11035 @opindex fprofile-dir
11037 Set the directory to search for the profile data files in to @var{path}.
11038 This option affects only the profile data generated by
11039 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11040 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11041 and its related options.  Both absolute and relative paths can be used.
11042 By default, GCC uses the current directory as @var{path}, thus the
11043 profile data file appears in the same directory as the object file.
11045 @item -fprofile-generate
11046 @itemx -fprofile-generate=@var{path}
11047 @opindex fprofile-generate
11049 Enable options usually used for instrumenting application to produce
11050 profile useful for later recompilation with profile feedback based
11051 optimization.  You must use @option{-fprofile-generate} both when
11052 compiling and when linking your program.
11054 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11056 If @var{path} is specified, GCC looks at the @var{path} to find
11057 the profile feedback data files. See @option{-fprofile-dir}.
11059 To optimize the program based on the collected profile information, use
11060 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11062 @item -fprofile-update=@var{method}
11063 @opindex fprofile-update
11065 Alter the update method for an application instrumented for profile
11066 feedback based optimization.  The @var{method} argument should be one of
11067 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11068 The first one is useful for single-threaded applications,
11069 while the second one prevents profile corruption by emitting thread-safe code.
11071 @strong{Warning:} When an application does not properly join all threads
11072 (or creates an detached thread), a profile file can be still corrupted.
11074 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11075 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11076 automatically selects @samp{prefer-atomic} when @option{-pthread}
11077 is present in the command line.
11079 @item -fsanitize=address
11080 @opindex fsanitize=address
11081 Enable AddressSanitizer, a fast memory error detector.
11082 Memory access instructions are instrumented to detect
11083 out-of-bounds and use-after-free bugs.
11084 The option enables @option{-fsanitize-address-use-after-scope}.
11085 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11086 more details.  The run-time behavior can be influenced using the
11087 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11088 the available options are shown at startup of the instrumented program.  See
11089 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11090 for a list of supported options.
11091 The option cannot be combined with @option{-fsanitize=thread}
11092 and/or @option{-fcheck-pointer-bounds}.
11094 @item -fsanitize=kernel-address
11095 @opindex fsanitize=kernel-address
11096 Enable AddressSanitizer for Linux kernel.
11097 See @uref{https://github.com/google/kasan/wiki} for more details.
11098 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11100 @item -fsanitize=pointer-compare
11101 @opindex fsanitize=pointer-compare
11102 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11103 The option must be combined with either @option{-fsanitize=kernel-address} or
11104 @option{-fsanitize=address}
11105 The option cannot be combined with @option{-fsanitize=thread}
11106 and/or @option{-fcheck-pointer-bounds}.
11107 Note: By default the check is disabled at run time.  To enable it,
11108 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11109 @env{ASAN_OPTIONS}.
11111 @item -fsanitize=pointer-subtract
11112 @opindex fsanitize=pointer-subtract
11113 Instrument subtraction with pointer operands.
11114 The option must be combined with either @option{-fsanitize=kernel-address} or
11115 @option{-fsanitize=address}
11116 The option cannot be combined with @option{-fsanitize=thread}
11117 and/or @option{-fcheck-pointer-bounds}.
11118 Note: By default the check is disabled at run time.  To enable it,
11119 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11120 @env{ASAN_OPTIONS}.
11122 @item -fsanitize=thread
11123 @opindex fsanitize=thread
11124 Enable ThreadSanitizer, a fast data race detector.
11125 Memory access instructions are instrumented to detect
11126 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11127 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11128 environment variable; see
11129 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11130 supported options.
11131 The option cannot be combined with @option{-fsanitize=address},
11132 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11134 Note that sanitized atomic builtins cannot throw exceptions when
11135 operating on invalid memory addresses with non-call exceptions
11136 (@option{-fnon-call-exceptions}).
11138 @item -fsanitize=leak
11139 @opindex fsanitize=leak
11140 Enable LeakSanitizer, a memory leak detector.
11141 This option only matters for linking of executables and
11142 the executable is linked against a library that overrides @code{malloc}
11143 and other allocator functions.  See
11144 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11145 details.  The run-time behavior can be influenced using the
11146 @env{LSAN_OPTIONS} environment variable.
11147 The option cannot be combined with @option{-fsanitize=thread}.
11149 @item -fsanitize=undefined
11150 @opindex fsanitize=undefined
11151 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11152 Various computations are instrumented to detect undefined behavior
11153 at runtime.  Current suboptions are:
11155 @table @gcctabopt
11157 @item -fsanitize=shift
11158 @opindex fsanitize=shift
11159 This option enables checking that the result of a shift operation is
11160 not undefined.  Note that what exactly is considered undefined differs
11161 slightly between C and C++, as well as between ISO C90 and C99, etc.
11162 This option has two suboptions, @option{-fsanitize=shift-base} and
11163 @option{-fsanitize=shift-exponent}.
11165 @item -fsanitize=shift-exponent
11166 @opindex fsanitize=shift-exponent
11167 This option enables checking that the second argument of a shift operation
11168 is not negative and is smaller than the precision of the promoted first
11169 argument.
11171 @item -fsanitize=shift-base
11172 @opindex fsanitize=shift-base
11173 If the second argument of a shift operation is within range, check that the
11174 result of a shift operation is not undefined.  Note that what exactly is
11175 considered undefined differs slightly between C and C++, as well as between
11176 ISO C90 and C99, etc.
11178 @item -fsanitize=integer-divide-by-zero
11179 @opindex fsanitize=integer-divide-by-zero
11180 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11182 @item -fsanitize=unreachable
11183 @opindex fsanitize=unreachable
11184 With this option, the compiler turns the @code{__builtin_unreachable}
11185 call into a diagnostics message call instead.  When reaching the
11186 @code{__builtin_unreachable} call, the behavior is undefined.
11188 @item -fsanitize=vla-bound
11189 @opindex fsanitize=vla-bound
11190 This option instructs the compiler to check that the size of a variable
11191 length array is positive.
11193 @item -fsanitize=null
11194 @opindex fsanitize=null
11195 This option enables pointer checking.  Particularly, the application
11196 built with this option turned on will issue an error message when it
11197 tries to dereference a NULL pointer, or if a reference (possibly an
11198 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11199 on an object pointed by a NULL pointer.
11201 @item -fsanitize=return
11202 @opindex fsanitize=return
11203 This option enables return statement checking.  Programs
11204 built with this option turned on will issue an error message
11205 when the end of a non-void function is reached without actually
11206 returning a value.  This option works in C++ only.
11208 @item -fsanitize=signed-integer-overflow
11209 @opindex fsanitize=signed-integer-overflow
11210 This option enables signed integer overflow checking.  We check that
11211 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11212 does not overflow in the signed arithmetics.  Note, integer promotion
11213 rules must be taken into account.  That is, the following is not an
11214 overflow:
11215 @smallexample
11216 signed char a = SCHAR_MAX;
11217 a++;
11218 @end smallexample
11220 @item -fsanitize=bounds
11221 @opindex fsanitize=bounds
11222 This option enables instrumentation of array bounds.  Various out of bounds
11223 accesses are detected.  Flexible array members, flexible array member-like
11224 arrays, and initializers of variables with static storage are not instrumented.
11225 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11227 @item -fsanitize=bounds-strict
11228 @opindex fsanitize=bounds-strict
11229 This option enables strict instrumentation of array bounds.  Most out of bounds
11230 accesses are detected, including flexible array members and flexible array
11231 member-like arrays.  Initializers of variables with static storage are not
11232 instrumented.  The option cannot be combined
11233 with @option{-fcheck-pointer-bounds}.
11235 @item -fsanitize=alignment
11236 @opindex fsanitize=alignment
11238 This option enables checking of alignment of pointers when they are
11239 dereferenced, or when a reference is bound to insufficiently aligned target,
11240 or when a method or constructor is invoked on insufficiently aligned object.
11242 @item -fsanitize=object-size
11243 @opindex fsanitize=object-size
11244 This option enables instrumentation of memory references using the
11245 @code{__builtin_object_size} function.  Various out of bounds pointer
11246 accesses are detected.
11248 @item -fsanitize=float-divide-by-zero
11249 @opindex fsanitize=float-divide-by-zero
11250 Detect floating-point division by zero.  Unlike other similar options,
11251 @option{-fsanitize=float-divide-by-zero} is not enabled by
11252 @option{-fsanitize=undefined}, since floating-point division by zero can
11253 be a legitimate way of obtaining infinities and NaNs.
11255 @item -fsanitize=float-cast-overflow
11256 @opindex fsanitize=float-cast-overflow
11257 This option enables floating-point type to integer conversion checking.
11258 We check that the result of the conversion does not overflow.
11259 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11260 not enabled by @option{-fsanitize=undefined}.
11261 This option does not work well with @code{FE_INVALID} exceptions enabled.
11263 @item -fsanitize=nonnull-attribute
11264 @opindex fsanitize=nonnull-attribute
11266 This option enables instrumentation of calls, checking whether null values
11267 are not passed to arguments marked as requiring a non-null value by the
11268 @code{nonnull} function attribute.
11270 @item -fsanitize=returns-nonnull-attribute
11271 @opindex fsanitize=returns-nonnull-attribute
11273 This option enables instrumentation of return statements in functions
11274 marked with @code{returns_nonnull} function attribute, to detect returning
11275 of null values from such functions.
11277 @item -fsanitize=bool
11278 @opindex fsanitize=bool
11280 This option enables instrumentation of loads from bool.  If a value other
11281 than 0/1 is loaded, a run-time error is issued.
11283 @item -fsanitize=enum
11284 @opindex fsanitize=enum
11286 This option enables instrumentation of loads from an enum type.  If
11287 a value outside the range of values for the enum type is loaded,
11288 a run-time error is issued.
11290 @item -fsanitize=vptr
11291 @opindex fsanitize=vptr
11293 This option enables instrumentation of C++ member function calls, member
11294 accesses and some conversions between pointers to base and derived classes,
11295 to verify the referenced object has the correct dynamic type.
11297 @item -fsanitize=pointer-overflow
11298 @opindex fsanitize=pointer-overflow
11300 This option enables instrumentation of pointer arithmetics.  If the pointer
11301 arithmetics overflows, a run-time error is issued.
11303 @item -fsanitize=builtin
11304 @opindex fsanitize=builtin
11306 This option enables instrumentation of arguments to selected builtin
11307 functions.  If an invalid value is passed to such arguments, a run-time
11308 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11309 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11310 by this option.
11312 @end table
11314 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11315 @option{-fsanitize=undefined} gives a diagnostic message.
11316 This currently works only for the C family of languages.
11318 @item -fno-sanitize=all
11319 @opindex fno-sanitize=all
11321 This option disables all previously enabled sanitizers.
11322 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11323 together.
11325 @item -fasan-shadow-offset=@var{number}
11326 @opindex fasan-shadow-offset
11327 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11328 It is useful for experimenting with different shadow memory layouts in
11329 Kernel AddressSanitizer.
11331 @item -fsanitize-sections=@var{s1},@var{s2},...
11332 @opindex fsanitize-sections
11333 Sanitize global variables in selected user-defined sections.  @var{si} may
11334 contain wildcards.
11336 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11337 @opindex fsanitize-recover
11338 @opindex fno-sanitize-recover
11339 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11340 mentioned in comma-separated list of @var{opts}.  Enabling this option
11341 for a sanitizer component causes it to attempt to continue
11342 running the program as if no error happened.  This means multiple
11343 runtime errors can be reported in a single program run, and the exit
11344 code of the program may indicate success even when errors
11345 have been reported.  The @option{-fno-sanitize-recover=} option
11346 can be used to alter
11347 this behavior: only the first detected error is reported
11348 and program then exits with a non-zero exit code.
11350 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11351 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11352 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11353 @option{-fsanitize=bounds-strict},
11354 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11355 For these sanitizers error recovery is turned on by default,
11356 except @option{-fsanitize=address}, for which this feature is experimental.
11357 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11358 accepted, the former enables recovery for all sanitizers that support it,
11359 the latter disables recovery for all sanitizers that support it.
11361 Even if a recovery mode is turned on the compiler side, it needs to be also
11362 enabled on the runtime library side, otherwise the failures are still fatal.
11363 The runtime library defaults to @code{halt_on_error=0} for
11364 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11365 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11366 setting the @code{halt_on_error} flag in the corresponding environment variable.
11368 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11369 equivalent to specifying an @var{opts} list of:
11371 @smallexample
11372 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11373 @end smallexample
11375 @item -fsanitize-address-use-after-scope
11376 @opindex fsanitize-address-use-after-scope
11377 Enable sanitization of local variables to detect use-after-scope bugs.
11378 The option sets @option{-fstack-reuse} to @samp{none}.
11380 @item -fsanitize-undefined-trap-on-error
11381 @opindex fsanitize-undefined-trap-on-error
11382 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11383 report undefined behavior using @code{__builtin_trap} rather than
11384 a @code{libubsan} library routine.  The advantage of this is that the
11385 @code{libubsan} library is not needed and is not linked in, so this
11386 is usable even in freestanding environments.
11388 @item -fsanitize-coverage=trace-pc
11389 @opindex fsanitize-coverage=trace-pc
11390 Enable coverage-guided fuzzing code instrumentation.
11391 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11393 @item -fsanitize-coverage=trace-cmp
11394 @opindex fsanitize-coverage=trace-cmp
11395 Enable dataflow guided fuzzing code instrumentation.
11396 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11397 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11398 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11399 variable or @code{__sanitizer_cov_trace_const_cmp1},
11400 @code{__sanitizer_cov_trace_const_cmp2},
11401 @code{__sanitizer_cov_trace_const_cmp4} or
11402 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11403 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11404 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11405 @code{__sanitizer_cov_trace_switch} for switch statements.
11407 @item -fbounds-check
11408 @opindex fbounds-check
11409 For front ends that support it, generate additional code to check that
11410 indices used to access arrays are within the declared range.  This is
11411 currently only supported by the Fortran front end, where this option
11412 defaults to false.
11414 @item -fcheck-pointer-bounds
11415 @opindex fcheck-pointer-bounds
11416 @opindex fno-check-pointer-bounds
11417 @cindex Pointer Bounds Checker options
11418 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11419 is instrumented with checks of the pointer used for memory access against
11420 bounds associated with that pointer.  
11422 Currently there
11423 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11424 and @option{-mmpx} are required to enable this feature.  
11425 MPX-based instrumentation requires
11426 a runtime library to enable MPX in hardware and handle bounds
11427 violation signals.  By default when @option{-fcheck-pointer-bounds}
11428 and @option{-mmpx} options are used to link a program, the GCC driver
11429 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11430 Bounds checking on calls to dynamic libraries requires a linker
11431 with @option{-z bndplt} support; if GCC was configured with a linker
11432 without support for this option (including the Gold linker and older
11433 versions of ld), a warning is given if you link with @option{-mmpx}
11434 without also specifying @option{-static}, since the overall effectiveness
11435 of the bounds checking protection is reduced.
11436 See also @option{-static-libmpxwrappers}.
11438 MPX-based instrumentation
11439 may be used for debugging and also may be included in production code
11440 to increase program security.  Depending on usage, you may
11441 have different requirements for the runtime library.  The current version
11442 of the MPX runtime library is more oriented for use as a debugging
11443 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11444 also @option{-static-libmpx}.  The runtime library  behavior can be
11445 influenced using various @env{CHKP_RT_*} environment variables.  See
11446 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11447 for more details.
11449 Generated instrumentation may be controlled by various
11450 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11451 structure field attribute (@pxref{Type Attributes}) and
11452 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11453 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11454 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11455 Bounds Checker builtins}, for more information.
11457 @item -fchkp-check-incomplete-type
11458 @opindex fchkp-check-incomplete-type
11459 @opindex fno-chkp-check-incomplete-type
11460 Generate pointer bounds checks for variables with incomplete type.
11461 Enabled by default.
11463 @item -fchkp-narrow-bounds
11464 @opindex fchkp-narrow-bounds
11465 @opindex fno-chkp-narrow-bounds
11466 Controls bounds used by Pointer Bounds Checker for pointers to object
11467 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11468 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11469 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11471 @item -fchkp-first-field-has-own-bounds
11472 @opindex fchkp-first-field-has-own-bounds
11473 @opindex fno-chkp-first-field-has-own-bounds
11474 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11475 first field in the structure.  By default a pointer to the first field has
11476 the same bounds as a pointer to the whole structure.
11478 @item -fchkp-flexible-struct-trailing-arrays
11479 @opindex fchkp-flexible-struct-trailing-arrays
11480 @opindex fno-chkp-flexible-struct-trailing-arrays
11481 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11482 possibly flexible.  By default only array fields with zero length or that are
11483 marked with attribute bnd_variable_size are treated as flexible.
11485 @item -fchkp-narrow-to-innermost-array
11486 @opindex fchkp-narrow-to-innermost-array
11487 @opindex fno-chkp-narrow-to-innermost-array
11488 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11489 case of nested static array access.  By default this option is disabled and
11490 bounds of the outermost array are used.
11492 @item -fchkp-optimize
11493 @opindex fchkp-optimize
11494 @opindex fno-chkp-optimize
11495 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11496 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11498 @item -fchkp-use-fast-string-functions
11499 @opindex fchkp-use-fast-string-functions
11500 @opindex fno-chkp-use-fast-string-functions
11501 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11502 by Pointer Bounds Checker.  Disabled by default.
11504 @item -fchkp-use-nochk-string-functions
11505 @opindex fchkp-use-nochk-string-functions
11506 @opindex fno-chkp-use-nochk-string-functions
11507 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11508 by Pointer Bounds Checker.  Disabled by default.
11510 @item -fchkp-use-static-bounds
11511 @opindex fchkp-use-static-bounds
11512 @opindex fno-chkp-use-static-bounds
11513 Allow Pointer Bounds Checker to generate static bounds holding
11514 bounds of static variables.  Enabled by default.
11516 @item -fchkp-use-static-const-bounds
11517 @opindex fchkp-use-static-const-bounds
11518 @opindex fno-chkp-use-static-const-bounds
11519 Use statically-initialized bounds for constant bounds instead of
11520 generating them each time they are required.  By default enabled when
11521 @option{-fchkp-use-static-bounds} is enabled.
11523 @item -fchkp-treat-zero-dynamic-size-as-infinite
11524 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11525 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11526 With this option, objects with incomplete type whose
11527 dynamically-obtained size is zero are treated as having infinite size
11528 instead by Pointer Bounds
11529 Checker.  This option may be helpful if a program is linked with a library
11530 missing size information for some symbols.  Disabled by default.
11532 @item -fchkp-check-read
11533 @opindex fchkp-check-read
11534 @opindex fno-chkp-check-read
11535 Instructs Pointer Bounds Checker to generate checks for all read
11536 accesses to memory.  Enabled by default.
11538 @item -fchkp-check-write
11539 @opindex fchkp-check-write
11540 @opindex fno-chkp-check-write
11541 Instructs Pointer Bounds Checker to generate checks for all write
11542 accesses to memory.  Enabled by default.
11544 @item -fchkp-store-bounds
11545 @opindex fchkp-store-bounds
11546 @opindex fno-chkp-store-bounds
11547 Instructs Pointer Bounds Checker to generate bounds stores for
11548 pointer writes.  Enabled by default.
11550 @item -fchkp-instrument-calls
11551 @opindex fchkp-instrument-calls
11552 @opindex fno-chkp-instrument-calls
11553 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11554 Enabled by default.
11556 @item -fchkp-instrument-marked-only
11557 @opindex fchkp-instrument-marked-only
11558 @opindex fno-chkp-instrument-marked-only
11559 Instructs Pointer Bounds Checker to instrument only functions
11560 marked with the @code{bnd_instrument} attribute
11561 (@pxref{Function Attributes}).  Disabled by default.
11563 @item -fchkp-use-wrappers
11564 @opindex fchkp-use-wrappers
11565 @opindex fno-chkp-use-wrappers
11566 Allows Pointer Bounds Checker to replace calls to built-in functions
11567 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11568 is used to link a program, the GCC driver automatically links
11569 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11570 Enabled by default.
11572 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11573 @opindex fcf-protection
11574 Enable code instrumentation of control-flow transfers to increase
11575 program security by checking that target addresses of control-flow
11576 transfer instructions (such as indirect function call, function return,
11577 indirect jump) are valid.  This prevents diverting the flow of control
11578 to an unexpected target.  This is intended to protect against such
11579 threats as Return-oriented Programming (ROP), and similarly
11580 call/jmp-oriented programming (COP/JOP).
11582 The value @code{branch} tells the compiler to implement checking of
11583 validity of control-flow transfer at the point of indirect branch
11584 instructions, i.e. call/jmp instructions.  The value @code{return}
11585 implements checking of validity at the point of returning from a
11586 function.  The value @code{full} is an alias for specifying both
11587 @code{branch} and @code{return}. The value @code{none} turns off
11588 instrumentation.
11590 You can also use the @code{nocf_check} attribute to identify
11591 which functions and calls should be skipped from instrumentation
11592 (@pxref{Function Attributes}).
11594 Currently the x86 GNU/Linux target provides an implementation based
11595 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11596 for x86 is controlled by target-specific options @option{-mcet},
11597 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11599 @item -fstack-protector
11600 @opindex fstack-protector
11601 Emit extra code to check for buffer overflows, such as stack smashing
11602 attacks.  This is done by adding a guard variable to functions with
11603 vulnerable objects.  This includes functions that call @code{alloca}, and
11604 functions with buffers larger than 8 bytes.  The guards are initialized
11605 when a function is entered and then checked when the function exits.
11606 If a guard check fails, an error message is printed and the program exits.
11608 @item -fstack-protector-all
11609 @opindex fstack-protector-all
11610 Like @option{-fstack-protector} except that all functions are protected.
11612 @item -fstack-protector-strong
11613 @opindex fstack-protector-strong
11614 Like @option{-fstack-protector} but includes additional functions to
11615 be protected --- those that have local array definitions, or have
11616 references to local frame addresses.
11618 @item -fstack-protector-explicit
11619 @opindex fstack-protector-explicit
11620 Like @option{-fstack-protector} but only protects those functions which
11621 have the @code{stack_protect} attribute.
11623 @item -fstack-check
11624 @opindex fstack-check
11625 Generate code to verify that you do not go beyond the boundary of the
11626 stack.  You should specify this flag if you are running in an
11627 environment with multiple threads, but you only rarely need to specify it in
11628 a single-threaded environment since stack overflow is automatically
11629 detected on nearly all systems if there is only one stack.
11631 Note that this switch does not actually cause checking to be done; the
11632 operating system or the language runtime must do that.  The switch causes
11633 generation of code to ensure that they see the stack being extended.
11635 You can additionally specify a string parameter: @samp{no} means no
11636 checking, @samp{generic} means force the use of old-style checking,
11637 @samp{specific} means use the best checking method and is equivalent
11638 to bare @option{-fstack-check}.
11640 Old-style checking is a generic mechanism that requires no specific
11641 target support in the compiler but comes with the following drawbacks:
11643 @enumerate
11644 @item
11645 Modified allocation strategy for large objects: they are always
11646 allocated dynamically if their size exceeds a fixed threshold.  Note this
11647 may change the semantics of some code.
11649 @item
11650 Fixed limit on the size of the static frame of functions: when it is
11651 topped by a particular function, stack checking is not reliable and
11652 a warning is issued by the compiler.
11654 @item
11655 Inefficiency: because of both the modified allocation strategy and the
11656 generic implementation, code performance is hampered.
11657 @end enumerate
11659 Note that old-style stack checking is also the fallback method for
11660 @samp{specific} if no target support has been added in the compiler.
11662 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11663 and stack overflows.  @samp{specific} is an excellent choice when compiling
11664 Ada code.  It is not generally sufficient to protect against stack-clash
11665 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11667 @item -fstack-clash-protection
11668 @opindex fstack-clash-protection
11669 Generate code to prevent stack clash style attacks.  When this option is
11670 enabled, the compiler will only allocate one page of stack space at a time
11671 and each page is accessed immediately after allocation.  Thus, it prevents
11672 allocations from jumping over any stack guard page provided by the
11673 operating system.
11675 Most targets do not fully support stack clash protection.  However, on
11676 those targets @option{-fstack-clash-protection} will protect dynamic stack
11677 allocations.  @option{-fstack-clash-protection} may also provide limited
11678 protection for static stack allocations if the target supports
11679 @option{-fstack-check=specific}.
11681 @item -fstack-limit-register=@var{reg}
11682 @itemx -fstack-limit-symbol=@var{sym}
11683 @itemx -fno-stack-limit
11684 @opindex fstack-limit-register
11685 @opindex fstack-limit-symbol
11686 @opindex fno-stack-limit
11687 Generate code to ensure that the stack does not grow beyond a certain value,
11688 either the value of a register or the address of a symbol.  If a larger
11689 stack is required, a signal is raised at run time.  For most targets,
11690 the signal is raised before the stack overruns the boundary, so
11691 it is possible to catch the signal without taking special precautions.
11693 For instance, if the stack starts at absolute address @samp{0x80000000}
11694 and grows downwards, you can use the flags
11695 @option{-fstack-limit-symbol=__stack_limit} and
11696 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11697 of 128KB@.  Note that this may only work with the GNU linker.
11699 You can locally override stack limit checking by using the
11700 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11702 @item -fsplit-stack
11703 @opindex fsplit-stack
11704 Generate code to automatically split the stack before it overflows.
11705 The resulting program has a discontiguous stack which can only
11706 overflow if the program is unable to allocate any more memory.  This
11707 is most useful when running threaded programs, as it is no longer
11708 necessary to calculate a good stack size to use for each thread.  This
11709 is currently only implemented for the x86 targets running
11710 GNU/Linux.
11712 When code compiled with @option{-fsplit-stack} calls code compiled
11713 without @option{-fsplit-stack}, there may not be much stack space
11714 available for the latter code to run.  If compiling all code,
11715 including library code, with @option{-fsplit-stack} is not an option,
11716 then the linker can fix up these calls so that the code compiled
11717 without @option{-fsplit-stack} always has a large stack.  Support for
11718 this is implemented in the gold linker in GNU binutils release 2.21
11719 and later.
11721 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11722 @opindex fvtable-verify
11723 This option is only available when compiling C++ code.
11724 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11725 feature that verifies at run time, for every virtual call, that
11726 the vtable pointer through which the call is made is valid for the type of
11727 the object, and has not been corrupted or overwritten.  If an invalid vtable
11728 pointer is detected at run time, an error is reported and execution of the
11729 program is immediately halted.
11731 This option causes run-time data structures to be built at program startup,
11732 which are used for verifying the vtable pointers.  
11733 The options @samp{std} and @samp{preinit}
11734 control the timing of when these data structures are built.  In both cases the
11735 data structures are built before execution reaches @code{main}.  Using
11736 @option{-fvtable-verify=std} causes the data structures to be built after
11737 shared libraries have been loaded and initialized.
11738 @option{-fvtable-verify=preinit} causes them to be built before shared
11739 libraries have been loaded and initialized.
11741 If this option appears multiple times in the command line with different
11742 values specified, @samp{none} takes highest priority over both @samp{std} and
11743 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11745 @item -fvtv-debug
11746 @opindex fvtv-debug
11747 When used in conjunction with @option{-fvtable-verify=std} or 
11748 @option{-fvtable-verify=preinit}, causes debug versions of the 
11749 runtime functions for the vtable verification feature to be called.  
11750 This flag also causes the compiler to log information about which 
11751 vtable pointers it finds for each class.
11752 This information is written to a file named @file{vtv_set_ptr_data.log} 
11753 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11754 if that is defined or the current working directory otherwise.
11756 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11757 file, be sure to delete any existing one.
11759 @item -fvtv-counts
11760 @opindex fvtv-counts
11761 This is a debugging flag.  When used in conjunction with
11762 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11763 causes the compiler to keep track of the total number of virtual calls
11764 it encounters and the number of verifications it inserts.  It also
11765 counts the number of calls to certain run-time library functions
11766 that it inserts and logs this information for each compilation unit.
11767 The compiler writes this information to a file named
11768 @file{vtv_count_data.log} in the directory named by the environment
11769 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11770 directory otherwise.  It also counts the size of the vtable pointer sets
11771 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11772 in the same directory.
11774 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11775 files, be sure to delete any existing ones.
11777 @item -finstrument-functions
11778 @opindex finstrument-functions
11779 Generate instrumentation calls for entry and exit to functions.  Just
11780 after function entry and just before function exit, the following
11781 profiling functions are called with the address of the current
11782 function and its call site.  (On some platforms,
11783 @code{__builtin_return_address} does not work beyond the current
11784 function, so the call site information may not be available to the
11785 profiling functions otherwise.)
11787 @smallexample
11788 void __cyg_profile_func_enter (void *this_fn,
11789                                void *call_site);
11790 void __cyg_profile_func_exit  (void *this_fn,
11791                                void *call_site);
11792 @end smallexample
11794 The first argument is the address of the start of the current function,
11795 which may be looked up exactly in the symbol table.
11797 This instrumentation is also done for functions expanded inline in other
11798 functions.  The profiling calls indicate where, conceptually, the
11799 inline function is entered and exited.  This means that addressable
11800 versions of such functions must be available.  If all your uses of a
11801 function are expanded inline, this may mean an additional expansion of
11802 code size.  If you use @code{extern inline} in your C code, an
11803 addressable version of such functions must be provided.  (This is
11804 normally the case anyway, but if you get lucky and the optimizer always
11805 expands the functions inline, you might have gotten away without
11806 providing static copies.)
11808 A function may be given the attribute @code{no_instrument_function}, in
11809 which case this instrumentation is not done.  This can be used, for
11810 example, for the profiling functions listed above, high-priority
11811 interrupt routines, and any functions from which the profiling functions
11812 cannot safely be called (perhaps signal handlers, if the profiling
11813 routines generate output or allocate memory).
11815 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11816 @opindex finstrument-functions-exclude-file-list
11818 Set the list of functions that are excluded from instrumentation (see
11819 the description of @option{-finstrument-functions}).  If the file that
11820 contains a function definition matches with one of @var{file}, then
11821 that function is not instrumented.  The match is done on substrings:
11822 if the @var{file} parameter is a substring of the file name, it is
11823 considered to be a match.
11825 For example:
11827 @smallexample
11828 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11829 @end smallexample
11831 @noindent
11832 excludes any inline function defined in files whose pathnames
11833 contain @file{/bits/stl} or @file{include/sys}.
11835 If, for some reason, you want to include letter @samp{,} in one of
11836 @var{sym}, write @samp{\,}. For example,
11837 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11838 (note the single quote surrounding the option).
11840 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11841 @opindex finstrument-functions-exclude-function-list
11843 This is similar to @option{-finstrument-functions-exclude-file-list},
11844 but this option sets the list of function names to be excluded from
11845 instrumentation.  The function name to be matched is its user-visible
11846 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11847 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11848 match is done on substrings: if the @var{sym} parameter is a substring
11849 of the function name, it is considered to be a match.  For C99 and C++
11850 extended identifiers, the function name must be given in UTF-8, not
11851 using universal character names.
11853 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11854 @opindex fpatchable-function-entry
11855 Generate @var{N} NOPs right at the beginning
11856 of each function, with the function entry point before the @var{M}th NOP.
11857 If @var{M} is omitted, it defaults to @code{0} so the
11858 function entry points to the address just at the first NOP.
11859 The NOP instructions reserve extra space which can be used to patch in
11860 any desired instrumentation at run time, provided that the code segment
11861 is writable.  The amount of space is controllable indirectly via
11862 the number of NOPs; the NOP instruction used corresponds to the instruction
11863 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11864 is target-specific and may also depend on the architecture variant and/or
11865 other compilation options.
11867 For run-time identification, the starting addresses of these areas,
11868 which correspond to their respective function entries minus @var{M},
11869 are additionally collected in the @code{__patchable_function_entries}
11870 section of the resulting binary.
11872 Note that the value of @code{__attribute__ ((patchable_function_entry
11873 (N,M)))} takes precedence over command-line option
11874 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11875 the area size or to remove it completely on a single function.
11876 If @code{N=0}, no pad location is recorded.
11878 The NOP instructions are inserted at---and maybe before, depending on
11879 @var{M}---the function entry address, even before the prologue.
11881 @end table
11884 @node Preprocessor Options
11885 @section Options Controlling the Preprocessor
11886 @cindex preprocessor options
11887 @cindex options, preprocessor
11889 These options control the C preprocessor, which is run on each C source
11890 file before actual compilation.
11892 If you use the @option{-E} option, nothing is done except preprocessing.
11893 Some of these options make sense only together with @option{-E} because
11894 they cause the preprocessor output to be unsuitable for actual
11895 compilation.
11897 In addition to the options listed here, there are a number of options 
11898 to control search paths for include files documented in 
11899 @ref{Directory Options}.  
11900 Options to control preprocessor diagnostics are listed in 
11901 @ref{Warning Options}.
11903 @table @gcctabopt
11904 @include cppopts.texi
11906 @item -Wp,@var{option}
11907 @opindex Wp
11908 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11909 and pass @var{option} directly through to the preprocessor.  If
11910 @var{option} contains commas, it is split into multiple options at the
11911 commas.  However, many options are modified, translated or interpreted
11912 by the compiler driver before being passed to the preprocessor, and
11913 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11914 interface is undocumented and subject to change, so whenever possible
11915 you should avoid using @option{-Wp} and let the driver handle the
11916 options instead.
11918 @item -Xpreprocessor @var{option}
11919 @opindex Xpreprocessor
11920 Pass @var{option} as an option to the preprocessor.  You can use this to
11921 supply system-specific preprocessor options that GCC does not 
11922 recognize.
11924 If you want to pass an option that takes an argument, you must use
11925 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11927 @item -no-integrated-cpp
11928 @opindex no-integrated-cpp
11929 Perform preprocessing as a separate pass before compilation.
11930 By default, GCC performs preprocessing as an integrated part of
11931 input tokenization and parsing.
11932 If this option is provided, the appropriate language front end
11933 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11934 and Objective-C, respectively) is instead invoked twice,
11935 once for preprocessing only and once for actual compilation
11936 of the preprocessed input.
11937 This option may be useful in conjunction with the @option{-B} or
11938 @option{-wrapper} options to specify an alternate preprocessor or
11939 perform additional processing of the program source between
11940 normal preprocessing and compilation.
11942 @end table
11944 @node Assembler Options
11945 @section Passing Options to the Assembler
11947 @c prevent bad page break with this line
11948 You can pass options to the assembler.
11950 @table @gcctabopt
11951 @item -Wa,@var{option}
11952 @opindex Wa
11953 Pass @var{option} as an option to the assembler.  If @var{option}
11954 contains commas, it is split into multiple options at the commas.
11956 @item -Xassembler @var{option}
11957 @opindex Xassembler
11958 Pass @var{option} as an option to the assembler.  You can use this to
11959 supply system-specific assembler options that GCC does not
11960 recognize.
11962 If you want to pass an option that takes an argument, you must use
11963 @option{-Xassembler} twice, once for the option and once for the argument.
11965 @end table
11967 @node Link Options
11968 @section Options for Linking
11969 @cindex link options
11970 @cindex options, linking
11972 These options come into play when the compiler links object files into
11973 an executable output file.  They are meaningless if the compiler is
11974 not doing a link step.
11976 @table @gcctabopt
11977 @cindex file names
11978 @item @var{object-file-name}
11979 A file name that does not end in a special recognized suffix is
11980 considered to name an object file or library.  (Object files are
11981 distinguished from libraries by the linker according to the file
11982 contents.)  If linking is done, these object files are used as input
11983 to the linker.
11985 @item -c
11986 @itemx -S
11987 @itemx -E
11988 @opindex c
11989 @opindex S
11990 @opindex E
11991 If any of these options is used, then the linker is not run, and
11992 object file names should not be used as arguments.  @xref{Overall
11993 Options}.
11995 @item -fuse-ld=bfd
11996 @opindex fuse-ld=bfd
11997 Use the @command{bfd} linker instead of the default linker.
11999 @item -fuse-ld=gold
12000 @opindex fuse-ld=gold
12001 Use the @command{gold} linker instead of the default linker.
12003 @cindex Libraries
12004 @item -l@var{library}
12005 @itemx -l @var{library}
12006 @opindex l
12007 Search the library named @var{library} when linking.  (The second
12008 alternative with the library as a separate argument is only for
12009 POSIX compliance and is not recommended.)
12011 It makes a difference where in the command you write this option; the
12012 linker searches and processes libraries and object files in the order they
12013 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12014 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12015 to functions in @samp{z}, those functions may not be loaded.
12017 The linker searches a standard list of directories for the library,
12018 which is actually a file named @file{lib@var{library}.a}.  The linker
12019 then uses this file as if it had been specified precisely by name.
12021 The directories searched include several standard system directories
12022 plus any that you specify with @option{-L}.
12024 Normally the files found this way are library files---archive files
12025 whose members are object files.  The linker handles an archive file by
12026 scanning through it for members which define symbols that have so far
12027 been referenced but not defined.  But if the file that is found is an
12028 ordinary object file, it is linked in the usual fashion.  The only
12029 difference between using an @option{-l} option and specifying a file name
12030 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12031 and searches several directories.
12033 @item -lobjc
12034 @opindex lobjc
12035 You need this special case of the @option{-l} option in order to
12036 link an Objective-C or Objective-C++ program.
12038 @item -nostartfiles
12039 @opindex nostartfiles
12040 Do not use the standard system startup files when linking.
12041 The standard system libraries are used normally, unless @option{-nostdlib}
12042 or @option{-nodefaultlibs} is used.
12044 @item -nodefaultlibs
12045 @opindex nodefaultlibs
12046 Do not use the standard system libraries when linking.
12047 Only the libraries you specify are passed to the linker, and options
12048 specifying linkage of the system libraries, such as @option{-static-libgcc}
12049 or @option{-shared-libgcc}, are ignored.  
12050 The standard startup files are used normally, unless @option{-nostartfiles}
12051 is used.  
12053 The compiler may generate calls to @code{memcmp},
12054 @code{memset}, @code{memcpy} and @code{memmove}.
12055 These entries are usually resolved by entries in
12056 libc.  These entry points should be supplied through some other
12057 mechanism when this option is specified.
12059 @item -nostdlib
12060 @opindex nostdlib
12061 Do not use the standard system startup files or libraries when linking.
12062 No startup files and only the libraries you specify are passed to
12063 the linker, and options specifying linkage of the system libraries, such as
12064 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12066 The compiler may generate calls to @code{memcmp}, @code{memset},
12067 @code{memcpy} and @code{memmove}.
12068 These entries are usually resolved by entries in
12069 libc.  These entry points should be supplied through some other
12070 mechanism when this option is specified.
12072 @cindex @option{-lgcc}, use with @option{-nostdlib}
12073 @cindex @option{-nostdlib} and unresolved references
12074 @cindex unresolved references and @option{-nostdlib}
12075 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12076 @cindex @option{-nodefaultlibs} and unresolved references
12077 @cindex unresolved references and @option{-nodefaultlibs}
12078 One of the standard libraries bypassed by @option{-nostdlib} and
12079 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12080 which GCC uses to overcome shortcomings of particular machines, or special
12081 needs for some languages.
12082 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12083 Collection (GCC) Internals},
12084 for more discussion of @file{libgcc.a}.)
12085 In most cases, you need @file{libgcc.a} even when you want to avoid
12086 other standard libraries.  In other words, when you specify @option{-nostdlib}
12087 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12088 This ensures that you have no unresolved references to internal GCC
12089 library subroutines.
12090 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12091 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12092 GNU Compiler Collection (GCC) Internals}.)
12094 @item -pie
12095 @opindex pie
12096 Produce a dynamically linked position independent executable on targets
12097 that support it.  For predictable results, you must also specify the same
12098 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12099 or model suboptions) when you specify this linker option.
12101 @item -no-pie
12102 @opindex no-pie
12103 Don't produce a dynamically linked position independent executable.
12105 @item -static-pie
12106 @opindex static-pie
12107 Produce a static position independent executable on targets that support
12108 it.  A static position independent executable is similar to a static
12109 executable, but can be loaded at any address without a dynamic linker.
12110 For predictable results, you must also specify the same set of options
12111 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12112 suboptions) when you specify this linker option.
12114 @item -pthread
12115 @opindex pthread
12116 Link with the POSIX threads library.  This option is supported on 
12117 GNU/Linux targets, most other Unix derivatives, and also on 
12118 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12119 flags for the preprocessor, so it should be used consistently for both
12120 compilation and linking.
12122 @item -rdynamic
12123 @opindex rdynamic
12124 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12125 that support it. This instructs the linker to add all symbols, not
12126 only used ones, to the dynamic symbol table. This option is needed
12127 for some uses of @code{dlopen} or to allow obtaining backtraces
12128 from within a program.
12130 @item -s
12131 @opindex s
12132 Remove all symbol table and relocation information from the executable.
12134 @item -static
12135 @opindex static
12136 On systems that support dynamic linking, this overrides @option{-pie}
12137 and prevents linking with the shared libraries.  On other systems, this
12138 option has no effect.
12140 @item -shared
12141 @opindex shared
12142 Produce a shared object which can then be linked with other objects to
12143 form an executable.  Not all systems support this option.  For predictable
12144 results, you must also specify the same set of options used for compilation
12145 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12146 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12147 needs to build supplementary stub code for constructors to work.  On
12148 multi-libbed systems, @samp{gcc -shared} must select the correct support
12149 libraries to link against.  Failing to supply the correct flags may lead
12150 to subtle defects.  Supplying them in cases where they are not necessary
12151 is innocuous.}
12153 @item -shared-libgcc
12154 @itemx -static-libgcc
12155 @opindex shared-libgcc
12156 @opindex static-libgcc
12157 On systems that provide @file{libgcc} as a shared library, these options
12158 force the use of either the shared or static version, respectively.
12159 If no shared version of @file{libgcc} was built when the compiler was
12160 configured, these options have no effect.
12162 There are several situations in which an application should use the
12163 shared @file{libgcc} instead of the static version.  The most common
12164 of these is when the application wishes to throw and catch exceptions
12165 across different shared libraries.  In that case, each of the libraries
12166 as well as the application itself should use the shared @file{libgcc}.
12168 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12169  whenever you build a shared library or a main executable, because C++
12170  programs typically use exceptions, so this is the right thing to do.
12172 If, instead, you use the GCC driver to create shared libraries, you may
12173 find that they are not always linked with the shared @file{libgcc}.
12174 If GCC finds, at its configuration time, that you have a non-GNU linker
12175 or a GNU linker that does not support option @option{--eh-frame-hdr},
12176 it links the shared version of @file{libgcc} into shared libraries
12177 by default.  Otherwise, it takes advantage of the linker and optimizes
12178 away the linking with the shared version of @file{libgcc}, linking with
12179 the static version of libgcc by default.  This allows exceptions to
12180 propagate through such shared libraries, without incurring relocation
12181 costs at library load time.
12183 However, if a library or main executable is supposed to throw or catch
12184 exceptions, you must link it using the G++ driver, as appropriate
12185 for the languages used in the program, or using the option
12186 @option{-shared-libgcc}, such that it is linked with the shared
12187 @file{libgcc}.
12189 @item -static-libasan
12190 @opindex static-libasan
12191 When the @option{-fsanitize=address} option is used to link a program,
12192 the GCC driver automatically links against @option{libasan}.  If
12193 @file{libasan} is available as a shared library, and the @option{-static}
12194 option is not used, then this links against the shared version of
12195 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12196 driver to link @file{libasan} statically, without necessarily linking
12197 other libraries statically.
12199 @item -static-libtsan
12200 @opindex static-libtsan
12201 When the @option{-fsanitize=thread} option is used to link a program,
12202 the GCC driver automatically links against @option{libtsan}.  If
12203 @file{libtsan} is available as a shared library, and the @option{-static}
12204 option is not used, then this links against the shared version of
12205 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12206 driver to link @file{libtsan} statically, without necessarily linking
12207 other libraries statically.
12209 @item -static-liblsan
12210 @opindex static-liblsan
12211 When the @option{-fsanitize=leak} option is used to link a program,
12212 the GCC driver automatically links against @option{liblsan}.  If
12213 @file{liblsan} is available as a shared library, and the @option{-static}
12214 option is not used, then this links against the shared version of
12215 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12216 driver to link @file{liblsan} statically, without necessarily linking
12217 other libraries statically.
12219 @item -static-libubsan
12220 @opindex static-libubsan
12221 When the @option{-fsanitize=undefined} option is used to link a program,
12222 the GCC driver automatically links against @option{libubsan}.  If
12223 @file{libubsan} is available as a shared library, and the @option{-static}
12224 option is not used, then this links against the shared version of
12225 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12226 driver to link @file{libubsan} statically, without necessarily linking
12227 other libraries statically.
12229 @item -static-libmpx
12230 @opindex static-libmpx
12231 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12232 used to link a program, the GCC driver automatically links against
12233 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12234 and the @option{-static} option is not used, then this links against
12235 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12236 option directs the GCC driver to link @file{libmpx} statically,
12237 without necessarily linking other libraries statically.
12239 @item -static-libmpxwrappers
12240 @opindex static-libmpxwrappers
12241 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12242 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12243 GCC driver automatically links against @file{libmpxwrappers}.  If
12244 @file{libmpxwrappers} is available as a shared library, and the
12245 @option{-static} option is not used, then this links against the shared
12246 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12247 option directs the GCC driver to link @file{libmpxwrappers} statically,
12248 without necessarily linking other libraries statically.
12250 @item -static-libstdc++
12251 @opindex static-libstdc++
12252 When the @command{g++} program is used to link a C++ program, it
12253 normally automatically links against @option{libstdc++}.  If
12254 @file{libstdc++} is available as a shared library, and the
12255 @option{-static} option is not used, then this links against the
12256 shared version of @file{libstdc++}.  That is normally fine.  However, it
12257 is sometimes useful to freeze the version of @file{libstdc++} used by
12258 the program without going all the way to a fully static link.  The
12259 @option{-static-libstdc++} option directs the @command{g++} driver to
12260 link @file{libstdc++} statically, without necessarily linking other
12261 libraries statically.
12263 @item -symbolic
12264 @opindex symbolic
12265 Bind references to global symbols when building a shared object.  Warn
12266 about any unresolved references (unless overridden by the link editor
12267 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12268 this option.
12270 @item -T @var{script}
12271 @opindex T
12272 @cindex linker script
12273 Use @var{script} as the linker script.  This option is supported by most
12274 systems using the GNU linker.  On some targets, such as bare-board
12275 targets without an operating system, the @option{-T} option may be required
12276 when linking to avoid references to undefined symbols.
12278 @item -Xlinker @var{option}
12279 @opindex Xlinker
12280 Pass @var{option} as an option to the linker.  You can use this to
12281 supply system-specific linker options that GCC does not recognize.
12283 If you want to pass an option that takes a separate argument, you must use
12284 @option{-Xlinker} twice, once for the option and once for the argument.
12285 For example, to pass @option{-assert definitions}, you must write
12286 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12287 @option{-Xlinker "-assert definitions"}, because this passes the entire
12288 string as a single argument, which is not what the linker expects.
12290 When using the GNU linker, it is usually more convenient to pass
12291 arguments to linker options using the @option{@var{option}=@var{value}}
12292 syntax than as separate arguments.  For example, you can specify
12293 @option{-Xlinker -Map=output.map} rather than
12294 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12295 this syntax for command-line options.
12297 @item -Wl,@var{option}
12298 @opindex Wl
12299 Pass @var{option} as an option to the linker.  If @var{option} contains
12300 commas, it is split into multiple options at the commas.  You can use this
12301 syntax to pass an argument to the option.
12302 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12303 linker.  When using the GNU linker, you can also get the same effect with
12304 @option{-Wl,-Map=output.map}.
12306 @item -u @var{symbol}
12307 @opindex u
12308 Pretend the symbol @var{symbol} is undefined, to force linking of
12309 library modules to define it.  You can use @option{-u} multiple times with
12310 different symbols to force loading of additional library modules.
12312 @item -z @var{keyword}
12313 @opindex z
12314 @option{-z} is passed directly on to the linker along with the keyword
12315 @var{keyword}. See the section in the documentation of your linker for
12316 permitted values and their meanings.
12317 @end table
12319 @node Directory Options
12320 @section Options for Directory Search
12321 @cindex directory options
12322 @cindex options, directory search
12323 @cindex search path
12325 These options specify directories to search for header files, for
12326 libraries and for parts of the compiler:
12328 @table @gcctabopt
12329 @include cppdiropts.texi
12331 @item -iplugindir=@var{dir}
12332 @opindex iplugindir=
12333 Set the directory to search for plugins that are passed
12334 by @option{-fplugin=@var{name}} instead of
12335 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12336 to be used by the user, but only passed by the driver.
12338 @item -L@var{dir}
12339 @opindex L
12340 Add directory @var{dir} to the list of directories to be searched
12341 for @option{-l}.
12343 @item -B@var{prefix}
12344 @opindex B
12345 This option specifies where to find the executables, libraries,
12346 include files, and data files of the compiler itself.
12348 The compiler driver program runs one or more of the subprograms
12349 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12350 @var{prefix} as a prefix for each program it tries to run, both with and
12351 without @samp{@var{machine}/@var{version}/} for the corresponding target
12352 machine and compiler version.
12354 For each subprogram to be run, the compiler driver first tries the
12355 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12356 is not specified, the driver tries two standard prefixes, 
12357 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12358 those results in a file name that is found, the unmodified program
12359 name is searched for using the directories specified in your
12360 @env{PATH} environment variable.
12362 The compiler checks to see if the path provided by @option{-B}
12363 refers to a directory, and if necessary it adds a directory
12364 separator character at the end of the path.
12366 @option{-B} prefixes that effectively specify directory names also apply
12367 to libraries in the linker, because the compiler translates these
12368 options into @option{-L} options for the linker.  They also apply to
12369 include files in the preprocessor, because the compiler translates these
12370 options into @option{-isystem} options for the preprocessor.  In this case,
12371 the compiler appends @samp{include} to the prefix.
12373 The runtime support file @file{libgcc.a} can also be searched for using
12374 the @option{-B} prefix, if needed.  If it is not found there, the two
12375 standard prefixes above are tried, and that is all.  The file is left
12376 out of the link if it is not found by those means.
12378 Another way to specify a prefix much like the @option{-B} prefix is to use
12379 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12380 Variables}.
12382 As a special kludge, if the path provided by @option{-B} is
12383 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12384 9, then it is replaced by @file{[dir/]include}.  This is to help
12385 with boot-strapping the compiler.
12387 @item -no-canonical-prefixes
12388 @opindex no-canonical-prefixes
12389 Do not expand any symbolic links, resolve references to @samp{/../}
12390 or @samp{/./}, or make the path absolute when generating a relative
12391 prefix.
12393 @item --sysroot=@var{dir}
12394 @opindex sysroot
12395 Use @var{dir} as the logical root directory for headers and libraries.
12396 For example, if the compiler normally searches for headers in
12397 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12398 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12400 If you use both this option and the @option{-isysroot} option, then
12401 the @option{--sysroot} option applies to libraries, but the
12402 @option{-isysroot} option applies to header files.
12404 The GNU linker (beginning with version 2.16) has the necessary support
12405 for this option.  If your linker does not support this option, the
12406 header file aspect of @option{--sysroot} still works, but the
12407 library aspect does not.
12409 @item --no-sysroot-suffix
12410 @opindex no-sysroot-suffix
12411 For some targets, a suffix is added to the root directory specified
12412 with @option{--sysroot}, depending on the other options used, so that
12413 headers may for example be found in
12414 @file{@var{dir}/@var{suffix}/usr/include} instead of
12415 @file{@var{dir}/usr/include}.  This option disables the addition of
12416 such a suffix.
12418 @end table
12420 @node Code Gen Options
12421 @section Options for Code Generation Conventions
12422 @cindex code generation conventions
12423 @cindex options, code generation
12424 @cindex run-time options
12426 These machine-independent options control the interface conventions
12427 used in code generation.
12429 Most of them have both positive and negative forms; the negative form
12430 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12431 one of the forms is listed---the one that is not the default.  You
12432 can figure out the other form by either removing @samp{no-} or adding
12435 @table @gcctabopt
12436 @item -fstack-reuse=@var{reuse-level}
12437 @opindex fstack_reuse
12438 This option controls stack space reuse for user declared local/auto variables
12439 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12440 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12441 local variables and temporaries, @samp{named_vars} enables the reuse only for
12442 user defined local variables with names, and @samp{none} disables stack reuse
12443 completely. The default value is @samp{all}. The option is needed when the
12444 program extends the lifetime of a scoped local variable or a compiler generated
12445 temporary beyond the end point defined by the language.  When a lifetime of
12446 a variable ends, and if the variable lives in memory, the optimizing compiler
12447 has the freedom to reuse its stack space with other temporaries or scoped
12448 local variables whose live range does not overlap with it. Legacy code extending
12449 local lifetime is likely to break with the stack reuse optimization.
12451 For example,
12453 @smallexample
12454    int *p;
12455    @{
12456      int local1;
12458      p = &local1;
12459      local1 = 10;
12460      ....
12461    @}
12462    @{
12463       int local2;
12464       local2 = 20;
12465       ...
12466    @}
12468    if (*p == 10)  // out of scope use of local1
12469      @{
12471      @}
12472 @end smallexample
12474 Another example:
12475 @smallexample
12477    struct A
12478    @{
12479        A(int k) : i(k), j(k) @{ @}
12480        int i;
12481        int j;
12482    @};
12484    A *ap;
12486    void foo(const A& ar)
12487    @{
12488       ap = &ar;
12489    @}
12491    void bar()
12492    @{
12493       foo(A(10)); // temp object's lifetime ends when foo returns
12495       @{
12496         A a(20);
12497         ....
12498       @}
12499       ap->i+= 10;  // ap references out of scope temp whose space
12500                    // is reused with a. What is the value of ap->i?
12501    @}
12503 @end smallexample
12505 The lifetime of a compiler generated temporary is well defined by the C++
12506 standard. When a lifetime of a temporary ends, and if the temporary lives
12507 in memory, the optimizing compiler has the freedom to reuse its stack
12508 space with other temporaries or scoped local variables whose live range
12509 does not overlap with it. However some of the legacy code relies on
12510 the behavior of older compilers in which temporaries' stack space is
12511 not reused, the aggressive stack reuse can lead to runtime errors. This
12512 option is used to control the temporary stack reuse optimization.
12514 @item -ftrapv
12515 @opindex ftrapv
12516 This option generates traps for signed overflow on addition, subtraction,
12517 multiplication operations.
12518 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12519 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12520 @option{-fwrapv} being effective.  Note that only active options override, so
12521 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12522 results in @option{-ftrapv} being effective.
12524 @item -fwrapv
12525 @opindex fwrapv
12526 This option instructs the compiler to assume that signed arithmetic
12527 overflow of addition, subtraction and multiplication wraps around
12528 using twos-complement representation.  This flag enables some optimizations
12529 and disables others.
12530 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12531 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12532 @option{-fwrapv} being effective.  Note that only active options override, so
12533 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12534 results in @option{-ftrapv} being effective.
12536 @item -fexceptions
12537 @opindex fexceptions
12538 Enable exception handling.  Generates extra code needed to propagate
12539 exceptions.  For some targets, this implies GCC generates frame
12540 unwind information for all functions, which can produce significant data
12541 size overhead, although it does not affect execution.  If you do not
12542 specify this option, GCC enables it by default for languages like
12543 C++ that normally require exception handling, and disables it for
12544 languages like C that do not normally require it.  However, you may need
12545 to enable this option when compiling C code that needs to interoperate
12546 properly with exception handlers written in C++.  You may also wish to
12547 disable this option if you are compiling older C++ programs that don't
12548 use exception handling.
12550 @item -fnon-call-exceptions
12551 @opindex fnon-call-exceptions
12552 Generate code that allows trapping instructions to throw exceptions.
12553 Note that this requires platform-specific runtime support that does
12554 not exist everywhere.  Moreover, it only allows @emph{trapping}
12555 instructions to throw exceptions, i.e.@: memory references or floating-point
12556 instructions.  It does not allow exceptions to be thrown from
12557 arbitrary signal handlers such as @code{SIGALRM}.
12559 @item -fdelete-dead-exceptions
12560 @opindex fdelete-dead-exceptions
12561 Consider that instructions that may throw exceptions but don't otherwise
12562 contribute to the execution of the program can be optimized away.
12563 This option is enabled by default for the Ada front end, as permitted by
12564 the Ada language specification.
12565 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12567 @item -funwind-tables
12568 @opindex funwind-tables
12569 Similar to @option{-fexceptions}, except that it just generates any needed
12570 static data, but does not affect the generated code in any other way.
12571 You normally do not need to enable this option; instead, a language processor
12572 that needs this handling enables it on your behalf.
12574 @item -fasynchronous-unwind-tables
12575 @opindex fasynchronous-unwind-tables
12576 Generate unwind table in DWARF format, if supported by target machine.  The
12577 table is exact at each instruction boundary, so it can be used for stack
12578 unwinding from asynchronous events (such as debugger or garbage collector).
12580 @item -fno-gnu-unique
12581 @opindex fno-gnu-unique
12582 On systems with recent GNU assembler and C library, the C++ compiler
12583 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12584 of template static data members and static local variables in inline
12585 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12586 is necessary to avoid problems with a library used by two different
12587 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12588 therefore disagreeing with the other one about the binding of the
12589 symbol.  But this causes @code{dlclose} to be ignored for affected
12590 DSOs; if your program relies on reinitialization of a DSO via
12591 @code{dlclose} and @code{dlopen}, you can use
12592 @option{-fno-gnu-unique}.
12594 @item -fpcc-struct-return
12595 @opindex fpcc-struct-return
12596 Return ``short'' @code{struct} and @code{union} values in memory like
12597 longer ones, rather than in registers.  This convention is less
12598 efficient, but it has the advantage of allowing intercallability between
12599 GCC-compiled files and files compiled with other compilers, particularly
12600 the Portable C Compiler (pcc).
12602 The precise convention for returning structures in memory depends
12603 on the target configuration macros.
12605 Short structures and unions are those whose size and alignment match
12606 that of some integer type.
12608 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12609 switch is not binary compatible with code compiled with the
12610 @option{-freg-struct-return} switch.
12611 Use it to conform to a non-default application binary interface.
12613 @item -freg-struct-return
12614 @opindex freg-struct-return
12615 Return @code{struct} and @code{union} values in registers when possible.
12616 This is more efficient for small structures than
12617 @option{-fpcc-struct-return}.
12619 If you specify neither @option{-fpcc-struct-return} nor
12620 @option{-freg-struct-return}, GCC defaults to whichever convention is
12621 standard for the target.  If there is no standard convention, GCC
12622 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12623 the principal compiler.  In those cases, we can choose the standard, and
12624 we chose the more efficient register return alternative.
12626 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12627 switch is not binary compatible with code compiled with the
12628 @option{-fpcc-struct-return} switch.
12629 Use it to conform to a non-default application binary interface.
12631 @item -fshort-enums
12632 @opindex fshort-enums
12633 Allocate to an @code{enum} type only as many bytes as it needs for the
12634 declared range of possible values.  Specifically, the @code{enum} type
12635 is equivalent to the smallest integer type that has enough room.
12637 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12638 code that is not binary compatible with code generated without that switch.
12639 Use it to conform to a non-default application binary interface.
12641 @item -fshort-wchar
12642 @opindex fshort-wchar
12643 Override the underlying type for @code{wchar_t} to be @code{short
12644 unsigned int} instead of the default for the target.  This option is
12645 useful for building programs to run under WINE@.
12647 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12648 code that is not binary compatible with code generated without that switch.
12649 Use it to conform to a non-default application binary interface.
12651 @item -fno-common
12652 @opindex fno-common
12653 @cindex tentative definitions
12654 In C code, this option controls the placement of global variables 
12655 defined without an initializer, known as @dfn{tentative definitions} 
12656 in the C standard.  Tentative definitions are distinct from declarations 
12657 of a variable with the @code{extern} keyword, which do not allocate storage.
12659 Unix C compilers have traditionally allocated storage for
12660 uninitialized global variables in a common block.  This allows the
12661 linker to resolve all tentative definitions of the same variable
12662 in different compilation units to the same object, or to a non-tentative
12663 definition.  
12664 This is the behavior specified by @option{-fcommon}, and is the default for 
12665 GCC on most targets.  
12666 On the other hand, this behavior is not required by ISO
12667 C, and on some targets may carry a speed or code size penalty on
12668 variable references.
12670 The @option{-fno-common} option specifies that the compiler should instead
12671 place uninitialized global variables in the data section of the object file.
12672 This inhibits the merging of tentative definitions by the linker so
12673 you get a multiple-definition error if the same 
12674 variable is defined in more than one compilation unit.
12675 Compiling with @option{-fno-common} is useful on targets for which
12676 it provides better performance, or if you wish to verify that the
12677 program will work on other systems that always treat uninitialized
12678 variable definitions this way.
12680 @item -fno-ident
12681 @opindex fno-ident
12682 Ignore the @code{#ident} directive.
12684 @item -finhibit-size-directive
12685 @opindex finhibit-size-directive
12686 Don't output a @code{.size} assembler directive, or anything else that
12687 would cause trouble if the function is split in the middle, and the
12688 two halves are placed at locations far apart in memory.  This option is
12689 used when compiling @file{crtstuff.c}; you should not need to use it
12690 for anything else.
12692 @item -fverbose-asm
12693 @opindex fverbose-asm
12694 Put extra commentary information in the generated assembly code to
12695 make it more readable.  This option is generally only of use to those
12696 who actually need to read the generated assembly code (perhaps while
12697 debugging the compiler itself).
12699 @option{-fno-verbose-asm}, the default, causes the
12700 extra information to be omitted and is useful when comparing two assembler
12701 files.
12703 The added comments include:
12705 @itemize @bullet
12707 @item
12708 information on the compiler version and command-line options,
12710 @item
12711 the source code lines associated with the assembly instructions,
12712 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12714 @item
12715 hints on which high-level expressions correspond to
12716 the various assembly instruction operands.
12718 @end itemize
12720 For example, given this C source file:
12722 @smallexample
12723 int test (int n)
12725   int i;
12726   int total = 0;
12728   for (i = 0; i < n; i++)
12729     total += i * i;
12731   return total;
12733 @end smallexample
12735 compiling to (x86_64) assembly via @option{-S} and emitting the result
12736 direct to stdout via @option{-o} @option{-}
12738 @smallexample
12739 gcc -S test.c -fverbose-asm -Os -o -
12740 @end smallexample
12742 gives output similar to this:
12744 @smallexample
12745         .file   "test.c"
12746 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12747   [...snip...]
12748 # options passed:
12749   [...snip...]
12751         .text
12752         .globl  test
12753         .type   test, @@function
12754 test:
12755 .LFB0:
12756         .cfi_startproc
12757 # test.c:4:   int total = 0;
12758         xorl    %eax, %eax      # <retval>
12759 # test.c:6:   for (i = 0; i < n; i++)
12760         xorl    %edx, %edx      # i
12761 .L2:
12762 # test.c:6:   for (i = 0; i < n; i++)
12763         cmpl    %edi, %edx      # n, i
12764         jge     .L5     #,
12765 # test.c:7:     total += i * i;
12766         movl    %edx, %ecx      # i, tmp92
12767         imull   %edx, %ecx      # i, tmp92
12768 # test.c:6:   for (i = 0; i < n; i++)
12769         incl    %edx    # i
12770 # test.c:7:     total += i * i;
12771         addl    %ecx, %eax      # tmp92, <retval>
12772         jmp     .L2     #
12773 .L5:
12774 # test.c:10: @}
12775         ret
12776         .cfi_endproc
12777 .LFE0:
12778         .size   test, .-test
12779         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12780         .section        .note.GNU-stack,"",@@progbits
12781 @end smallexample
12783 The comments are intended for humans rather than machines and hence the
12784 precise format of the comments is subject to change.
12786 @item -frecord-gcc-switches
12787 @opindex frecord-gcc-switches
12788 This switch causes the command line used to invoke the
12789 compiler to be recorded into the object file that is being created.
12790 This switch is only implemented on some targets and the exact format
12791 of the recording is target and binary file format dependent, but it
12792 usually takes the form of a section containing ASCII text.  This
12793 switch is related to the @option{-fverbose-asm} switch, but that
12794 switch only records information in the assembler output file as
12795 comments, so it never reaches the object file.
12796 See also @option{-grecord-gcc-switches} for another
12797 way of storing compiler options into the object file.
12799 @item -fpic
12800 @opindex fpic
12801 @cindex global offset table
12802 @cindex PIC
12803 Generate position-independent code (PIC) suitable for use in a shared
12804 library, if supported for the target machine.  Such code accesses all
12805 constant addresses through a global offset table (GOT)@.  The dynamic
12806 loader resolves the GOT entries when the program starts (the dynamic
12807 loader is not part of GCC; it is part of the operating system).  If
12808 the GOT size for the linked executable exceeds a machine-specific
12809 maximum size, you get an error message from the linker indicating that
12810 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12811 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12812 on the m68k and RS/6000.  The x86 has no such limit.)
12814 Position-independent code requires special support, and therefore works
12815 only on certain machines.  For the x86, GCC supports PIC for System V
12816 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12817 position-independent.
12819 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12820 are defined to 1.
12822 @item -fPIC
12823 @opindex fPIC
12824 If supported for the target machine, emit position-independent code,
12825 suitable for dynamic linking and avoiding any limit on the size of the
12826 global offset table.  This option makes a difference on AArch64, m68k,
12827 PowerPC and SPARC@.
12829 Position-independent code requires special support, and therefore works
12830 only on certain machines.
12832 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12833 are defined to 2.
12835 @item -fpie
12836 @itemx -fPIE
12837 @opindex fpie
12838 @opindex fPIE
12839 These options are similar to @option{-fpic} and @option{-fPIC}, but
12840 generated position independent code can be only linked into executables.
12841 Usually these options are used when @option{-pie} GCC option is
12842 used during linking.
12844 @option{-fpie} and @option{-fPIE} both define the macros
12845 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12846 for @option{-fpie} and 2 for @option{-fPIE}.
12848 @item -fno-plt
12849 @opindex fno-plt
12850 Do not use the PLT for external function calls in position-independent code.
12851 Instead, load the callee address at call sites from the GOT and branch to it.
12852 This leads to more efficient code by eliminating PLT stubs and exposing
12853 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12854 PLT stubs expect the GOT pointer in a specific register, this gives more
12855 register allocation freedom to the compiler.
12856 Lazy binding requires use of the PLT; 
12857 with @option{-fno-plt} all external symbols are resolved at load time.
12859 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12860 through the PLT for specific external functions.
12862 In position-dependent code, a few targets also convert calls to
12863 functions that are marked to not use the PLT to use the GOT instead.
12865 @item -fno-jump-tables
12866 @opindex fno-jump-tables
12867 Do not use jump tables for switch statements even where it would be
12868 more efficient than other code generation strategies.  This option is
12869 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12870 building code that forms part of a dynamic linker and cannot
12871 reference the address of a jump table.  On some targets, jump tables
12872 do not require a GOT and this option is not needed.
12874 @item -ffixed-@var{reg}
12875 @opindex ffixed
12876 Treat the register named @var{reg} as a fixed register; generated code
12877 should never refer to it (except perhaps as a stack pointer, frame
12878 pointer or in some other fixed role).
12880 @var{reg} must be the name of a register.  The register names accepted
12881 are machine-specific and are defined in the @code{REGISTER_NAMES}
12882 macro in the machine description macro file.
12884 This flag does not have a negative form, because it specifies a
12885 three-way choice.
12887 @item -fcall-used-@var{reg}
12888 @opindex fcall-used
12889 Treat the register named @var{reg} as an allocable register that is
12890 clobbered by function calls.  It may be allocated for temporaries or
12891 variables that do not live across a call.  Functions compiled this way
12892 do not save and restore the register @var{reg}.
12894 It is an error to use this flag with the frame pointer or stack pointer.
12895 Use of this flag for other registers that have fixed pervasive roles in
12896 the machine's execution model produces disastrous results.
12898 This flag does not have a negative form, because it specifies a
12899 three-way choice.
12901 @item -fcall-saved-@var{reg}
12902 @opindex fcall-saved
12903 Treat the register named @var{reg} as an allocable register saved by
12904 functions.  It may be allocated even for temporaries or variables that
12905 live across a call.  Functions compiled this way save and restore
12906 the register @var{reg} if they use it.
12908 It is an error to use this flag with the frame pointer or stack pointer.
12909 Use of this flag for other registers that have fixed pervasive roles in
12910 the machine's execution model produces disastrous results.
12912 A different sort of disaster results from the use of this flag for
12913 a register in which function values may be returned.
12915 This flag does not have a negative form, because it specifies a
12916 three-way choice.
12918 @item -fpack-struct[=@var{n}]
12919 @opindex fpack-struct
12920 Without a value specified, pack all structure members together without
12921 holes.  When a value is specified (which must be a small power of two), pack
12922 structure members according to this value, representing the maximum
12923 alignment (that is, objects with default alignment requirements larger than
12924 this are output potentially unaligned at the next fitting location.
12926 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12927 code that is not binary compatible with code generated without that switch.
12928 Additionally, it makes the code suboptimal.
12929 Use it to conform to a non-default application binary interface.
12931 @item -fleading-underscore
12932 @opindex fleading-underscore
12933 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12934 change the way C symbols are represented in the object file.  One use
12935 is to help link with legacy assembly code.
12937 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12938 generate code that is not binary compatible with code generated without that
12939 switch.  Use it to conform to a non-default application binary interface.
12940 Not all targets provide complete support for this switch.
12942 @item -ftls-model=@var{model}
12943 @opindex ftls-model
12944 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12945 The @var{model} argument should be one of @samp{global-dynamic},
12946 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12947 Note that the choice is subject to optimization: the compiler may use
12948 a more efficient model for symbols not visible outside of the translation
12949 unit, or if @option{-fpic} is not given on the command line.
12951 The default without @option{-fpic} is @samp{initial-exec}; with
12952 @option{-fpic} the default is @samp{global-dynamic}.
12954 @item -ftrampolines
12955 @opindex ftrampolines
12956 For targets that normally need trampolines for nested functions, always
12957 generate them instead of using descriptors.  Otherwise, for targets that
12958 do not need them, like for example HP-PA or IA-64, do nothing.
12960 A trampoline is a small piece of code that is created at run time on the
12961 stack when the address of a nested function is taken, and is used to call
12962 the nested function indirectly.  Therefore, it requires the stack to be
12963 made executable in order for the program to work properly.
12965 @option{-fno-trampolines} is enabled by default on a language by language
12966 basis to let the compiler avoid generating them, if it computes that this
12967 is safe, and replace them with descriptors.  Descriptors are made up of data
12968 only, but the generated code must be prepared to deal with them.  As of this
12969 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12971 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12972 @option{-fno-trampolines} are not binary compatible if nested functions are
12973 present.  This option must therefore be used on a program-wide basis and be
12974 manipulated with extreme care.
12976 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12977 @opindex fvisibility
12978 Set the default ELF image symbol visibility to the specified option---all
12979 symbols are marked with this unless overridden within the code.
12980 Using this feature can very substantially improve linking and
12981 load times of shared object libraries, produce more optimized
12982 code, provide near-perfect API export and prevent symbol clashes.
12983 It is @strong{strongly} recommended that you use this in any shared objects
12984 you distribute.
12986 Despite the nomenclature, @samp{default} always means public; i.e.,
12987 available to be linked against from outside the shared object.
12988 @samp{protected} and @samp{internal} are pretty useless in real-world
12989 usage so the only other commonly used option is @samp{hidden}.
12990 The default if @option{-fvisibility} isn't specified is
12991 @samp{default}, i.e., make every symbol public.
12993 A good explanation of the benefits offered by ensuring ELF
12994 symbols have the correct visibility is given by ``How To Write
12995 Shared Libraries'' by Ulrich Drepper (which can be found at
12996 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12997 solution made possible by this option to marking things hidden when
12998 the default is public is to make the default hidden and mark things
12999 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13000 and @code{__attribute__ ((visibility("default")))} instead of
13001 @code{__declspec(dllexport)} you get almost identical semantics with
13002 identical syntax.  This is a great boon to those working with
13003 cross-platform projects.
13005 For those adding visibility support to existing code, you may find
13006 @code{#pragma GCC visibility} of use.  This works by you enclosing
13007 the declarations you wish to set visibility for with (for example)
13008 @code{#pragma GCC visibility push(hidden)} and
13009 @code{#pragma GCC visibility pop}.
13010 Bear in mind that symbol visibility should be viewed @strong{as
13011 part of the API interface contract} and thus all new code should
13012 always specify visibility when it is not the default; i.e., declarations
13013 only for use within the local DSO should @strong{always} be marked explicitly
13014 as hidden as so to avoid PLT indirection overheads---making this
13015 abundantly clear also aids readability and self-documentation of the code.
13016 Note that due to ISO C++ specification requirements, @code{operator new} and
13017 @code{operator delete} must always be of default visibility.
13019 Be aware that headers from outside your project, in particular system
13020 headers and headers from any other library you use, may not be
13021 expecting to be compiled with visibility other than the default.  You
13022 may need to explicitly say @code{#pragma GCC visibility push(default)}
13023 before including any such headers.
13025 @code{extern} declarations are not affected by @option{-fvisibility}, so
13026 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13027 no modifications.  However, this means that calls to @code{extern}
13028 functions with no explicit visibility use the PLT, so it is more
13029 effective to use @code{__attribute ((visibility))} and/or
13030 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13031 declarations should be treated as hidden.
13033 Note that @option{-fvisibility} does affect C++ vague linkage
13034 entities. This means that, for instance, an exception class that is
13035 be thrown between DSOs must be explicitly marked with default
13036 visibility so that the @samp{type_info} nodes are unified between
13037 the DSOs.
13039 An overview of these techniques, their benefits and how to use them
13040 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13042 @item -fstrict-volatile-bitfields
13043 @opindex fstrict-volatile-bitfields
13044 This option should be used if accesses to volatile bit-fields (or other
13045 structure fields, although the compiler usually honors those types
13046 anyway) should use a single access of the width of the
13047 field's type, aligned to a natural alignment if possible.  For
13048 example, targets with memory-mapped peripheral registers might require
13049 all such accesses to be 16 bits wide; with this flag you can
13050 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13051 is 16 bits on these targets) to force GCC to use 16-bit accesses
13052 instead of, perhaps, a more efficient 32-bit access.
13054 If this option is disabled, the compiler uses the most efficient
13055 instruction.  In the previous example, that might be a 32-bit load
13056 instruction, even though that accesses bytes that do not contain
13057 any portion of the bit-field, or memory-mapped registers unrelated to
13058 the one being updated.
13060 In some cases, such as when the @code{packed} attribute is applied to a 
13061 structure field, it may not be possible to access the field with a single
13062 read or write that is correctly aligned for the target machine.  In this
13063 case GCC falls back to generating multiple accesses rather than code that 
13064 will fault or truncate the result at run time.
13066 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13067 not allowed to touch non bit-field members.  It is therefore recommended
13068 to define all bits of the field's type as bit-field members.
13070 The default value of this option is determined by the application binary
13071 interface for the target processor.
13073 @item -fsync-libcalls
13074 @opindex fsync-libcalls
13075 This option controls whether any out-of-line instance of the @code{__sync}
13076 family of functions may be used to implement the C++11 @code{__atomic}
13077 family of functions.
13079 The default value of this option is enabled, thus the only useful form
13080 of the option is @option{-fno-sync-libcalls}.  This option is used in
13081 the implementation of the @file{libatomic} runtime library.
13083 @end table
13085 @node Developer Options
13086 @section GCC Developer Options
13087 @cindex developer options
13088 @cindex debugging GCC
13089 @cindex debug dump options
13090 @cindex dump options
13091 @cindex compilation statistics
13093 This section describes command-line options that are primarily of
13094 interest to GCC developers, including options to support compiler
13095 testing and investigation of compiler bugs and compile-time
13096 performance problems.  This includes options that produce debug dumps
13097 at various points in the compilation; that print statistics such as
13098 memory use and execution time; and that print information about GCC's
13099 configuration, such as where it searches for libraries.  You should
13100 rarely need to use any of these options for ordinary compilation and
13101 linking tasks.
13103 @table @gcctabopt
13105 @item -d@var{letters}
13106 @itemx -fdump-rtl-@var{pass}
13107 @itemx -fdump-rtl-@var{pass}=@var{filename}
13108 @opindex d
13109 @opindex fdump-rtl-@var{pass}
13110 Says to make debugging dumps during compilation at times specified by
13111 @var{letters}.  This is used for debugging the RTL-based passes of the
13112 compiler.  The file names for most of the dumps are made by appending
13113 a pass number and a word to the @var{dumpname}, and the files are
13114 created in the directory of the output file.  In case of
13115 @option{=@var{filename}} option, the dump is output on the given file
13116 instead of the pass numbered dump files.  Note that the pass number is
13117 assigned as passes are registered into the pass manager.  Most passes
13118 are registered in the order that they will execute and for these passes
13119 the number corresponds to the pass execution order.  However, passes
13120 registered by plugins, passes specific to compilation targets, or
13121 passes that are otherwise registered after all the other passes are
13122 numbered higher than a pass named "final", even if they are executed
13123 earlier.  @var{dumpname} is generated from the name of the output
13124 file if explicitly specified and not an executable, otherwise it is
13125 the basename of the source file.  
13127 Some @option{-d@var{letters}} switches have different meaning when
13128 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13129 for information about preprocessor-specific dump options.
13131 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13132 @option{-d} option @var{letters}.  Here are the possible
13133 letters for use in @var{pass} and @var{letters}, and their meanings:
13135 @table @gcctabopt
13137 @item -fdump-rtl-alignments
13138 @opindex fdump-rtl-alignments
13139 Dump after branch alignments have been computed.
13141 @item -fdump-rtl-asmcons
13142 @opindex fdump-rtl-asmcons
13143 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13145 @item -fdump-rtl-auto_inc_dec
13146 @opindex fdump-rtl-auto_inc_dec
13147 Dump after auto-inc-dec discovery.  This pass is only run on
13148 architectures that have auto inc or auto dec instructions.
13150 @item -fdump-rtl-barriers
13151 @opindex fdump-rtl-barriers
13152 Dump after cleaning up the barrier instructions.
13154 @item -fdump-rtl-bbpart
13155 @opindex fdump-rtl-bbpart
13156 Dump after partitioning hot and cold basic blocks.
13158 @item -fdump-rtl-bbro
13159 @opindex fdump-rtl-bbro
13160 Dump after block reordering.
13162 @item -fdump-rtl-btl1
13163 @itemx -fdump-rtl-btl2
13164 @opindex fdump-rtl-btl2
13165 @opindex fdump-rtl-btl2
13166 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13167 after the two branch
13168 target load optimization passes.
13170 @item -fdump-rtl-bypass
13171 @opindex fdump-rtl-bypass
13172 Dump after jump bypassing and control flow optimizations.
13174 @item -fdump-rtl-combine
13175 @opindex fdump-rtl-combine
13176 Dump after the RTL instruction combination pass.
13178 @item -fdump-rtl-compgotos
13179 @opindex fdump-rtl-compgotos
13180 Dump after duplicating the computed gotos.
13182 @item -fdump-rtl-ce1
13183 @itemx -fdump-rtl-ce2
13184 @itemx -fdump-rtl-ce3
13185 @opindex fdump-rtl-ce1
13186 @opindex fdump-rtl-ce2
13187 @opindex fdump-rtl-ce3
13188 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13189 @option{-fdump-rtl-ce3} enable dumping after the three
13190 if conversion passes.
13192 @item -fdump-rtl-cprop_hardreg
13193 @opindex fdump-rtl-cprop_hardreg
13194 Dump after hard register copy propagation.
13196 @item -fdump-rtl-csa
13197 @opindex fdump-rtl-csa
13198 Dump after combining stack adjustments.
13200 @item -fdump-rtl-cse1
13201 @itemx -fdump-rtl-cse2
13202 @opindex fdump-rtl-cse1
13203 @opindex fdump-rtl-cse2
13204 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13205 the two common subexpression elimination passes.
13207 @item -fdump-rtl-dce
13208 @opindex fdump-rtl-dce
13209 Dump after the standalone dead code elimination passes.
13211 @item -fdump-rtl-dbr
13212 @opindex fdump-rtl-dbr
13213 Dump after delayed branch scheduling.
13215 @item -fdump-rtl-dce1
13216 @itemx -fdump-rtl-dce2
13217 @opindex fdump-rtl-dce1
13218 @opindex fdump-rtl-dce2
13219 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13220 the two dead store elimination passes.
13222 @item -fdump-rtl-eh
13223 @opindex fdump-rtl-eh
13224 Dump after finalization of EH handling code.
13226 @item -fdump-rtl-eh_ranges
13227 @opindex fdump-rtl-eh_ranges
13228 Dump after conversion of EH handling range regions.
13230 @item -fdump-rtl-expand
13231 @opindex fdump-rtl-expand
13232 Dump after RTL generation.
13234 @item -fdump-rtl-fwprop1
13235 @itemx -fdump-rtl-fwprop2
13236 @opindex fdump-rtl-fwprop1
13237 @opindex fdump-rtl-fwprop2
13238 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13239 dumping after the two forward propagation passes.
13241 @item -fdump-rtl-gcse1
13242 @itemx -fdump-rtl-gcse2
13243 @opindex fdump-rtl-gcse1
13244 @opindex fdump-rtl-gcse2
13245 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13246 after global common subexpression elimination.
13248 @item -fdump-rtl-init-regs
13249 @opindex fdump-rtl-init-regs
13250 Dump after the initialization of the registers.
13252 @item -fdump-rtl-initvals
13253 @opindex fdump-rtl-initvals
13254 Dump after the computation of the initial value sets.
13256 @item -fdump-rtl-into_cfglayout
13257 @opindex fdump-rtl-into_cfglayout
13258 Dump after converting to cfglayout mode.
13260 @item -fdump-rtl-ira
13261 @opindex fdump-rtl-ira
13262 Dump after iterated register allocation.
13264 @item -fdump-rtl-jump
13265 @opindex fdump-rtl-jump
13266 Dump after the second jump optimization.
13268 @item -fdump-rtl-loop2
13269 @opindex fdump-rtl-loop2
13270 @option{-fdump-rtl-loop2} enables dumping after the rtl
13271 loop optimization passes.
13273 @item -fdump-rtl-mach
13274 @opindex fdump-rtl-mach
13275 Dump after performing the machine dependent reorganization pass, if that
13276 pass exists.
13278 @item -fdump-rtl-mode_sw
13279 @opindex fdump-rtl-mode_sw
13280 Dump after removing redundant mode switches.
13282 @item -fdump-rtl-rnreg
13283 @opindex fdump-rtl-rnreg
13284 Dump after register renumbering.
13286 @item -fdump-rtl-outof_cfglayout
13287 @opindex fdump-rtl-outof_cfglayout
13288 Dump after converting from cfglayout mode.
13290 @item -fdump-rtl-peephole2
13291 @opindex fdump-rtl-peephole2
13292 Dump after the peephole pass.
13294 @item -fdump-rtl-postreload
13295 @opindex fdump-rtl-postreload
13296 Dump after post-reload optimizations.
13298 @item -fdump-rtl-pro_and_epilogue
13299 @opindex fdump-rtl-pro_and_epilogue
13300 Dump after generating the function prologues and epilogues.
13302 @item -fdump-rtl-sched1
13303 @itemx -fdump-rtl-sched2
13304 @opindex fdump-rtl-sched1
13305 @opindex fdump-rtl-sched2
13306 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13307 after the basic block scheduling passes.
13309 @item -fdump-rtl-ree
13310 @opindex fdump-rtl-ree
13311 Dump after sign/zero extension elimination.
13313 @item -fdump-rtl-seqabstr
13314 @opindex fdump-rtl-seqabstr
13315 Dump after common sequence discovery.
13317 @item -fdump-rtl-shorten
13318 @opindex fdump-rtl-shorten
13319 Dump after shortening branches.
13321 @item -fdump-rtl-sibling
13322 @opindex fdump-rtl-sibling
13323 Dump after sibling call optimizations.
13325 @item -fdump-rtl-split1
13326 @itemx -fdump-rtl-split2
13327 @itemx -fdump-rtl-split3
13328 @itemx -fdump-rtl-split4
13329 @itemx -fdump-rtl-split5
13330 @opindex fdump-rtl-split1
13331 @opindex fdump-rtl-split2
13332 @opindex fdump-rtl-split3
13333 @opindex fdump-rtl-split4
13334 @opindex fdump-rtl-split5
13335 These options enable dumping after five rounds of
13336 instruction splitting.
13338 @item -fdump-rtl-sms
13339 @opindex fdump-rtl-sms
13340 Dump after modulo scheduling.  This pass is only run on some
13341 architectures.
13343 @item -fdump-rtl-stack
13344 @opindex fdump-rtl-stack
13345 Dump after conversion from GCC's ``flat register file'' registers to the
13346 x87's stack-like registers.  This pass is only run on x86 variants.
13348 @item -fdump-rtl-subreg1
13349 @itemx -fdump-rtl-subreg2
13350 @opindex fdump-rtl-subreg1
13351 @opindex fdump-rtl-subreg2
13352 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13353 the two subreg expansion passes.
13355 @item -fdump-rtl-unshare
13356 @opindex fdump-rtl-unshare
13357 Dump after all rtl has been unshared.
13359 @item -fdump-rtl-vartrack
13360 @opindex fdump-rtl-vartrack
13361 Dump after variable tracking.
13363 @item -fdump-rtl-vregs
13364 @opindex fdump-rtl-vregs
13365 Dump after converting virtual registers to hard registers.
13367 @item -fdump-rtl-web
13368 @opindex fdump-rtl-web
13369 Dump after live range splitting.
13371 @item -fdump-rtl-regclass
13372 @itemx -fdump-rtl-subregs_of_mode_init
13373 @itemx -fdump-rtl-subregs_of_mode_finish
13374 @itemx -fdump-rtl-dfinit
13375 @itemx -fdump-rtl-dfinish
13376 @opindex fdump-rtl-regclass
13377 @opindex fdump-rtl-subregs_of_mode_init
13378 @opindex fdump-rtl-subregs_of_mode_finish
13379 @opindex fdump-rtl-dfinit
13380 @opindex fdump-rtl-dfinish
13381 These dumps are defined but always produce empty files.
13383 @item -da
13384 @itemx -fdump-rtl-all
13385 @opindex da
13386 @opindex fdump-rtl-all
13387 Produce all the dumps listed above.
13389 @item -dA
13390 @opindex dA
13391 Annotate the assembler output with miscellaneous debugging information.
13393 @item -dD
13394 @opindex dD
13395 Dump all macro definitions, at the end of preprocessing, in addition to
13396 normal output.
13398 @item -dH
13399 @opindex dH
13400 Produce a core dump whenever an error occurs.
13402 @item -dp
13403 @opindex dp
13404 Annotate the assembler output with a comment indicating which
13405 pattern and alternative is used.  The length and cost of each instruction are
13406 also printed.
13408 @item -dP
13409 @opindex dP
13410 Dump the RTL in the assembler output as a comment before each instruction.
13411 Also turns on @option{-dp} annotation.
13413 @item -dx
13414 @opindex dx
13415 Just generate RTL for a function instead of compiling it.  Usually used
13416 with @option{-fdump-rtl-expand}.
13417 @end table
13419 @item -fdump-noaddr
13420 @opindex fdump-noaddr
13421 When doing debugging dumps, suppress address output.  This makes it more
13422 feasible to use diff on debugging dumps for compiler invocations with
13423 different compiler binaries and/or different
13424 text / bss / data / heap / stack / dso start locations.
13426 @item -freport-bug
13427 @opindex freport-bug
13428 Collect and dump debug information into a temporary file if an
13429 internal compiler error (ICE) occurs.
13431 @item -fdump-unnumbered
13432 @opindex fdump-unnumbered
13433 When doing debugging dumps, suppress instruction numbers and address output.
13434 This makes it more feasible to use diff on debugging dumps for compiler
13435 invocations with different options, in particular with and without
13436 @option{-g}.
13438 @item -fdump-unnumbered-links
13439 @opindex fdump-unnumbered-links
13440 When doing debugging dumps (see @option{-d} option above), suppress
13441 instruction numbers for the links to the previous and next instructions
13442 in a sequence.
13444 @item -fdump-ipa-@var{switch}
13445 @opindex fdump-ipa
13446 Control the dumping at various stages of inter-procedural analysis
13447 language tree to a file.  The file name is generated by appending a
13448 switch specific suffix to the source file name, and the file is created
13449 in the same directory as the output file.  The following dumps are
13450 possible:
13452 @table @samp
13453 @item all
13454 Enables all inter-procedural analysis dumps.
13456 @item cgraph
13457 Dumps information about call-graph optimization, unused function removal,
13458 and inlining decisions.
13460 @item inline
13461 Dump after function inlining.
13463 @end table
13465 @item -fdump-lang-all
13466 @itemx -fdump-lang-@var{switch}
13467 @itemx -fdump-lang-@var{switch}-@var{options}
13468 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13469 @opindex fdump-lang-all
13470 @opindex fdump-lang
13471 Control the dumping of language-specific information.  The @var{options}
13472 and @var{filename} portions behave as described in the
13473 @option{-fdump-tree} option.  The following @var{switch} values are
13474 accepted:
13476 @table @samp
13477 @item all
13479 Enable all language-specific dumps.
13481 @item class
13482 Dump class hierarchy information.  Virtual table information is emitted
13483 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13485 @item raw
13486 Dump the raw internal tree data.  This option is applicable to C++ only.
13488 @end table
13490 @item -fdump-passes
13491 @opindex fdump-passes
13492 Print on @file{stderr} the list of optimization passes that are turned
13493 on and off by the current command-line options.
13495 @item -fdump-statistics-@var{option}
13496 @opindex fdump-statistics
13497 Enable and control dumping of pass statistics in a separate file.  The
13498 file name is generated by appending a suffix ending in
13499 @samp{.statistics} to the source file name, and the file is created in
13500 the same directory as the output file.  If the @samp{-@var{option}}
13501 form is used, @samp{-stats} causes counters to be summed over the
13502 whole compilation unit while @samp{-details} dumps every event as
13503 the passes generate them.  The default with no option is to sum
13504 counters for each function compiled.
13506 @item -fdump-tree-all
13507 @itemx -fdump-tree-@var{switch}
13508 @itemx -fdump-tree-@var{switch}-@var{options}
13509 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13510 @opindex fdump-tree-all
13511 @opindex fdump-tree
13512 Control the dumping at various stages of processing the intermediate
13513 language tree to a file.  The file name is generated by appending a
13514 switch-specific suffix to the source file name, and the file is
13515 created in the same directory as the output file. In case of
13516 @option{=@var{filename}} option, the dump is output on the given file
13517 instead of the auto named dump files.  If the @samp{-@var{options}}
13518 form is used, @var{options} is a list of @samp{-} separated options
13519 which control the details of the dump.  Not all options are applicable
13520 to all dumps; those that are not meaningful are ignored.  The
13521 following options are available
13523 @table @samp
13524 @item address
13525 Print the address of each node.  Usually this is not meaningful as it
13526 changes according to the environment and source file.  Its primary use
13527 is for tying up a dump file with a debug environment.
13528 @item asmname
13529 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13530 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13531 use working backward from mangled names in the assembly file.
13532 @item slim
13533 When dumping front-end intermediate representations, inhibit dumping
13534 of members of a scope or body of a function merely because that scope
13535 has been reached.  Only dump such items when they are directly reachable
13536 by some other path.
13538 When dumping pretty-printed trees, this option inhibits dumping the
13539 bodies of control structures.
13541 When dumping RTL, print the RTL in slim (condensed) form instead of
13542 the default LISP-like representation.
13543 @item raw
13544 Print a raw representation of the tree.  By default, trees are
13545 pretty-printed into a C-like representation.
13546 @item details
13547 Enable more detailed dumps (not honored by every dump option). Also
13548 include information from the optimization passes.
13549 @item stats
13550 Enable dumping various statistics about the pass (not honored by every dump
13551 option).
13552 @item blocks
13553 Enable showing basic block boundaries (disabled in raw dumps).
13554 @item graph
13555 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13556 dump a representation of the control flow graph suitable for viewing with
13557 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13558 the file is pretty-printed as a subgraph, so that GraphViz can render them
13559 all in a single plot.
13561 This option currently only works for RTL dumps, and the RTL is always
13562 dumped in slim form.
13563 @item vops
13564 Enable showing virtual operands for every statement.
13565 @item lineno
13566 Enable showing line numbers for statements.
13567 @item uid
13568 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13569 @item verbose
13570 Enable showing the tree dump for each statement.
13571 @item eh
13572 Enable showing the EH region number holding each statement.
13573 @item scev
13574 Enable showing scalar evolution analysis details.
13575 @item optimized
13576 Enable showing optimization information (only available in certain
13577 passes).
13578 @item missed
13579 Enable showing missed optimization information (only available in certain
13580 passes).
13581 @item note
13582 Enable other detailed optimization information (only available in
13583 certain passes).
13584 @item =@var{filename}
13585 Instead of an auto named dump file, output into the given file
13586 name. The file names @file{stdout} and @file{stderr} are treated
13587 specially and are considered already open standard streams. For
13588 example,
13590 @smallexample
13591 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13592      -fdump-tree-pre=/dev/stderr file.c
13593 @end smallexample
13595 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13596 output on to @file{stderr}. If two conflicting dump filenames are
13597 given for the same pass, then the latter option overrides the earlier
13598 one.
13600 @item all
13601 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13602 and @option{lineno}.
13604 @item optall
13605 Turn on all optimization options, i.e., @option{optimized},
13606 @option{missed}, and @option{note}.
13607 @end table
13609 To determine what tree dumps are available or find the dump for a pass
13610 of interest follow the steps below.
13612 @enumerate
13613 @item
13614 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13615 look for a code that corresponds to the pass you are interested in.
13616 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13617 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13618 The number at the end distinguishes distinct invocations of the same pass.
13619 @item
13620 To enable the creation of the dump file, append the pass code to
13621 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13622 to enable the dump from the Early Value Range Propagation pass, invoke
13623 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13624 specify the name of the dump file.  If you don't specify one, GCC
13625 creates as described below.
13626 @item
13627 Find the pass dump in a file whose name is composed of three components
13628 separated by a period: the name of the source file GCC was invoked to
13629 compile, a numeric suffix indicating the pass number followed by the
13630 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13631 and finally the pass code.  For example, the Early VRP pass dump might
13632 be in a file named @file{myfile.c.038t.evrp} in the current working
13633 directory.  Note that the numeric codes are not stable and may change
13634 from one version of GCC to another.
13635 @end enumerate
13637 @item -fopt-info
13638 @itemx -fopt-info-@var{options}
13639 @itemx -fopt-info-@var{options}=@var{filename}
13640 @opindex fopt-info
13641 Controls optimization dumps from various optimization passes. If the
13642 @samp{-@var{options}} form is used, @var{options} is a list of
13643 @samp{-} separated option keywords to select the dump details and
13644 optimizations.  
13646 The @var{options} can be divided into two groups: options describing the
13647 verbosity of the dump, and options describing which optimizations
13648 should be included. The options from both the groups can be freely
13649 mixed as they are non-overlapping. However, in case of any conflicts,
13650 the later options override the earlier options on the command
13651 line. 
13653 The following options control the dump verbosity:
13655 @table @samp
13656 @item optimized
13657 Print information when an optimization is successfully applied. It is
13658 up to a pass to decide which information is relevant. For example, the
13659 vectorizer passes print the source location of loops which are
13660 successfully vectorized.
13661 @item missed
13662 Print information about missed optimizations. Individual passes
13663 control which information to include in the output. 
13664 @item note
13665 Print verbose information about optimizations, such as certain
13666 transformations, more detailed messages about decisions etc.
13667 @item all
13668 Print detailed optimization information. This includes
13669 @samp{optimized}, @samp{missed}, and @samp{note}.
13670 @end table
13672 One or more of the following option keywords can be used to describe a
13673 group of optimizations:
13675 @table @samp
13676 @item ipa
13677 Enable dumps from all interprocedural optimizations.
13678 @item loop
13679 Enable dumps from all loop optimizations.
13680 @item inline
13681 Enable dumps from all inlining optimizations.
13682 @item omp
13683 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13684 @item vec
13685 Enable dumps from all vectorization optimizations.
13686 @item optall
13687 Enable dumps from all optimizations. This is a superset of
13688 the optimization groups listed above.
13689 @end table
13691 If @var{options} is
13692 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13693 info about successful optimizations from all the passes.  
13695 If the @var{filename} is provided, then the dumps from all the
13696 applicable optimizations are concatenated into the @var{filename}.
13697 Otherwise the dump is output onto @file{stderr}. Though multiple
13698 @option{-fopt-info} options are accepted, only one of them can include
13699 a @var{filename}. If other filenames are provided then all but the
13700 first such option are ignored.
13702 Note that the output @var{filename} is overwritten
13703 in case of multiple translation units. If a combined output from
13704 multiple translation units is desired, @file{stderr} should be used
13705 instead.
13707 In the following example, the optimization info is output to
13708 @file{stderr}:
13710 @smallexample
13711 gcc -O3 -fopt-info
13712 @end smallexample
13714 This example:
13715 @smallexample
13716 gcc -O3 -fopt-info-missed=missed.all
13717 @end smallexample
13719 @noindent
13720 outputs missed optimization report from all the passes into
13721 @file{missed.all}, and this one:
13723 @smallexample
13724 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13725 @end smallexample
13727 @noindent
13728 prints information about missed optimization opportunities from
13729 vectorization passes on @file{stderr}.  
13730 Note that @option{-fopt-info-vec-missed} is equivalent to 
13731 @option{-fopt-info-missed-vec}.  The order of the optimization group
13732 names and message types listed after @option{-fopt-info} does not matter.
13734 As another example,
13735 @smallexample
13736 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13737 @end smallexample
13739 @noindent
13740 outputs information about missed optimizations as well as
13741 optimized locations from all the inlining passes into
13742 @file{inline.txt}.
13744 Finally, consider:
13746 @smallexample
13747 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13748 @end smallexample
13750 @noindent
13751 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13752 in conflict since only one output file is allowed. In this case, only
13753 the first option takes effect and the subsequent options are
13754 ignored. Thus only @file{vec.miss} is produced which contains
13755 dumps from the vectorizer about missed opportunities.
13757 @item -fsched-verbose=@var{n}
13758 @opindex fsched-verbose
13759 On targets that use instruction scheduling, this option controls the
13760 amount of debugging output the scheduler prints to the dump files.
13762 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13763 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13764 For @var{n} greater than one, it also output basic block probabilities,
13765 detailed ready list information and unit/insn info.  For @var{n} greater
13766 than two, it includes RTL at abort point, control-flow and regions info.
13767 And for @var{n} over four, @option{-fsched-verbose} also includes
13768 dependence info.
13772 @item -fenable-@var{kind}-@var{pass}
13773 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13774 @opindex fdisable-
13775 @opindex fenable-
13777 This is a set of options that are used to explicitly disable/enable
13778 optimization passes.  These options are intended for use for debugging GCC.
13779 Compiler users should use regular options for enabling/disabling
13780 passes instead.
13782 @table @gcctabopt
13784 @item -fdisable-ipa-@var{pass}
13785 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13786 statically invoked in the compiler multiple times, the pass name should be
13787 appended with a sequential number starting from 1.
13789 @item -fdisable-rtl-@var{pass}
13790 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13791 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13792 statically invoked in the compiler multiple times, the pass name should be
13793 appended with a sequential number starting from 1.  @var{range-list} is a 
13794 comma-separated list of function ranges or assembler names.  Each range is a number
13795 pair separated by a colon.  The range is inclusive in both ends.  If the range
13796 is trivial, the number pair can be simplified as a single number.  If the
13797 function's call graph node's @var{uid} falls within one of the specified ranges,
13798 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13799 function header of a dump file, and the pass names can be dumped by using
13800 option @option{-fdump-passes}.
13802 @item -fdisable-tree-@var{pass}
13803 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13804 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13805 option arguments.
13807 @item -fenable-ipa-@var{pass}
13808 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13809 statically invoked in the compiler multiple times, the pass name should be
13810 appended with a sequential number starting from 1.
13812 @item -fenable-rtl-@var{pass}
13813 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13814 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13815 description and examples.
13817 @item -fenable-tree-@var{pass}
13818 @itemx -fenable-tree-@var{pass}=@var{range-list}
13819 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13820 of option arguments.
13822 @end table
13824 Here are some examples showing uses of these options.
13826 @smallexample
13828 # disable ccp1 for all functions
13829    -fdisable-tree-ccp1
13830 # disable complete unroll for function whose cgraph node uid is 1
13831    -fenable-tree-cunroll=1
13832 # disable gcse2 for functions at the following ranges [1,1],
13833 # [300,400], and [400,1000]
13834 # disable gcse2 for functions foo and foo2
13835    -fdisable-rtl-gcse2=foo,foo2
13836 # disable early inlining
13837    -fdisable-tree-einline
13838 # disable ipa inlining
13839    -fdisable-ipa-inline
13840 # enable tree full unroll
13841    -fenable-tree-unroll
13843 @end smallexample
13845 @item -fchecking
13846 @itemx -fchecking=@var{n}
13847 @opindex fchecking
13848 @opindex fno-checking
13849 Enable internal consistency checking.  The default depends on
13850 the compiler configuration.  @option{-fchecking=2} enables further
13851 internal consistency checking that might affect code generation.
13853 @item -frandom-seed=@var{string}
13854 @opindex frandom-seed
13855 This option provides a seed that GCC uses in place of
13856 random numbers in generating certain symbol names
13857 that have to be different in every compiled file.  It is also used to
13858 place unique stamps in coverage data files and the object files that
13859 produce them.  You can use the @option{-frandom-seed} option to produce
13860 reproducibly identical object files.
13862 The @var{string} can either be a number (decimal, octal or hex) or an
13863 arbitrary string (in which case it's converted to a number by
13864 computing CRC32).
13866 The @var{string} should be different for every file you compile.
13868 @item -save-temps
13869 @itemx -save-temps=cwd
13870 @opindex save-temps
13871 Store the usual ``temporary'' intermediate files permanently; place them
13872 in the current directory and name them based on the source file.  Thus,
13873 compiling @file{foo.c} with @option{-c -save-temps} produces files
13874 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13875 preprocessed @file{foo.i} output file even though the compiler now
13876 normally uses an integrated preprocessor.
13878 When used in combination with the @option{-x} command-line option,
13879 @option{-save-temps} is sensible enough to avoid over writing an
13880 input source file with the same extension as an intermediate file.
13881 The corresponding intermediate file may be obtained by renaming the
13882 source file before using @option{-save-temps}.
13884 If you invoke GCC in parallel, compiling several different source
13885 files that share a common base name in different subdirectories or the
13886 same source file compiled for multiple output destinations, it is
13887 likely that the different parallel compilers will interfere with each
13888 other, and overwrite the temporary files.  For instance:
13890 @smallexample
13891 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13892 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13893 @end smallexample
13895 may result in @file{foo.i} and @file{foo.o} being written to
13896 simultaneously by both compilers.
13898 @item -save-temps=obj
13899 @opindex save-temps=obj
13900 Store the usual ``temporary'' intermediate files permanently.  If the
13901 @option{-o} option is used, the temporary files are based on the
13902 object file.  If the @option{-o} option is not used, the
13903 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13905 For example:
13907 @smallexample
13908 gcc -save-temps=obj -c foo.c
13909 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13910 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13911 @end smallexample
13913 @noindent
13914 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13915 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13916 @file{dir2/yfoobar.o}.
13918 @item -time@r{[}=@var{file}@r{]}
13919 @opindex time
13920 Report the CPU time taken by each subprocess in the compilation
13921 sequence.  For C source files, this is the compiler proper and assembler
13922 (plus the linker if linking is done).
13924 Without the specification of an output file, the output looks like this:
13926 @smallexample
13927 # cc1 0.12 0.01
13928 # as 0.00 0.01
13929 @end smallexample
13931 The first number on each line is the ``user time'', that is time spent
13932 executing the program itself.  The second number is ``system time'',
13933 time spent executing operating system routines on behalf of the program.
13934 Both numbers are in seconds.
13936 With the specification of an output file, the output is appended to the
13937 named file, and it looks like this:
13939 @smallexample
13940 0.12 0.01 cc1 @var{options}
13941 0.00 0.01 as @var{options}
13942 @end smallexample
13944 The ``user time'' and the ``system time'' are moved before the program
13945 name, and the options passed to the program are displayed, so that one
13946 can later tell what file was being compiled, and with which options.
13948 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13949 @opindex fdump-final-insns
13950 Dump the final internal representation (RTL) to @var{file}.  If the
13951 optional argument is omitted (or if @var{file} is @code{.}), the name
13952 of the dump file is determined by appending @code{.gkd} to the
13953 compilation output file name.
13955 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13956 @opindex fcompare-debug
13957 @opindex fno-compare-debug
13958 If no error occurs during compilation, run the compiler a second time,
13959 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13960 passed to the second compilation.  Dump the final internal
13961 representation in both compilations, and print an error if they differ.
13963 If the equal sign is omitted, the default @option{-gtoggle} is used.
13965 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13966 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13967 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13968 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13969 is used.
13971 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13972 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13973 of the final representation and the second compilation, preventing even
13974 @env{GCC_COMPARE_DEBUG} from taking effect.
13976 To verify full coverage during @option{-fcompare-debug} testing, set
13977 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13978 which GCC rejects as an invalid option in any actual compilation
13979 (rather than preprocessing, assembly or linking).  To get just a
13980 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13981 not overridden} will do.
13983 @item -fcompare-debug-second
13984 @opindex fcompare-debug-second
13985 This option is implicitly passed to the compiler for the second
13986 compilation requested by @option{-fcompare-debug}, along with options to
13987 silence warnings, and omitting other options that would cause
13988 side-effect compiler outputs to files or to the standard output.  Dump
13989 files and preserved temporary files are renamed so as to contain the
13990 @code{.gk} additional extension during the second compilation, to avoid
13991 overwriting those generated by the first.
13993 When this option is passed to the compiler driver, it causes the
13994 @emph{first} compilation to be skipped, which makes it useful for little
13995 other than debugging the compiler proper.
13997 @item -gtoggle
13998 @opindex gtoggle
13999 Turn off generation of debug info, if leaving out this option
14000 generates it, or turn it on at level 2 otherwise.  The position of this
14001 argument in the command line does not matter; it takes effect after all
14002 other options are processed, and it does so only once, no matter how
14003 many times it is given.  This is mainly intended to be used with
14004 @option{-fcompare-debug}.
14006 @item -fvar-tracking-assignments-toggle
14007 @opindex fvar-tracking-assignments-toggle
14008 @opindex fno-var-tracking-assignments-toggle
14009 Toggle @option{-fvar-tracking-assignments}, in the same way that
14010 @option{-gtoggle} toggles @option{-g}.
14012 @item -Q
14013 @opindex Q
14014 Makes the compiler print out each function name as it is compiled, and
14015 print some statistics about each pass when it finishes.
14017 @item -ftime-report
14018 @opindex ftime-report
14019 Makes the compiler print some statistics about the time consumed by each
14020 pass when it finishes.
14022 @item -ftime-report-details
14023 @opindex ftime-report-details
14024 Record the time consumed by infrastructure parts separately for each pass.
14026 @item -fira-verbose=@var{n}
14027 @opindex fira-verbose
14028 Control the verbosity of the dump file for the integrated register allocator.
14029 The default value is 5.  If the value @var{n} is greater or equal to 10,
14030 the dump output is sent to stderr using the same format as @var{n} minus 10.
14032 @item -flto-report
14033 @opindex flto-report
14034 Prints a report with internal details on the workings of the link-time
14035 optimizer.  The contents of this report vary from version to version.
14036 It is meant to be useful to GCC developers when processing object
14037 files in LTO mode (via @option{-flto}).
14039 Disabled by default.
14041 @item -flto-report-wpa
14042 @opindex flto-report-wpa
14043 Like @option{-flto-report}, but only print for the WPA phase of Link
14044 Time Optimization.
14046 @item -fmem-report
14047 @opindex fmem-report
14048 Makes the compiler print some statistics about permanent memory
14049 allocation when it finishes.
14051 @item -fmem-report-wpa
14052 @opindex fmem-report-wpa
14053 Makes the compiler print some statistics about permanent memory
14054 allocation for the WPA phase only.
14056 @item -fpre-ipa-mem-report
14057 @opindex fpre-ipa-mem-report
14058 @item -fpost-ipa-mem-report
14059 @opindex fpost-ipa-mem-report
14060 Makes the compiler print some statistics about permanent memory
14061 allocation before or after interprocedural optimization.
14063 @item -fprofile-report
14064 @opindex fprofile-report
14065 Makes the compiler print some statistics about consistency of the
14066 (estimated) profile and effect of individual passes.
14068 @item -fstack-usage
14069 @opindex fstack-usage
14070 Makes the compiler output stack usage information for the program, on a
14071 per-function basis.  The filename for the dump is made by appending
14072 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14073 the output file, if explicitly specified and it is not an executable,
14074 otherwise it is the basename of the source file.  An entry is made up
14075 of three fields:
14077 @itemize
14078 @item
14079 The name of the function.
14080 @item
14081 A number of bytes.
14082 @item
14083 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14084 @end itemize
14086 The qualifier @code{static} means that the function manipulates the stack
14087 statically: a fixed number of bytes are allocated for the frame on function
14088 entry and released on function exit; no stack adjustments are otherwise made
14089 in the function.  The second field is this fixed number of bytes.
14091 The qualifier @code{dynamic} means that the function manipulates the stack
14092 dynamically: in addition to the static allocation described above, stack
14093 adjustments are made in the body of the function, for example to push/pop
14094 arguments around function calls.  If the qualifier @code{bounded} is also
14095 present, the amount of these adjustments is bounded at compile time and
14096 the second field is an upper bound of the total amount of stack used by
14097 the function.  If it is not present, the amount of these adjustments is
14098 not bounded at compile time and the second field only represents the
14099 bounded part.
14101 @item -fstats
14102 @opindex fstats
14103 Emit statistics about front-end processing at the end of the compilation.
14104 This option is supported only by the C++ front end, and
14105 the information is generally only useful to the G++ development team.
14107 @item -fdbg-cnt-list
14108 @opindex fdbg-cnt-list
14109 Print the name and the counter upper bound for all debug counters.
14112 @item -fdbg-cnt=@var{counter-value-list}
14113 @opindex fdbg-cnt
14114 Set the internal debug counter upper bound.  @var{counter-value-list}
14115 is a comma-separated list of @var{name}:@var{value} pairs
14116 which sets the upper bound of each debug counter @var{name} to @var{value}.
14117 All debug counters have the initial upper bound of @code{UINT_MAX};
14118 thus @code{dbg_cnt} returns true always unless the upper bound
14119 is set by this option.
14120 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14121 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14123 @item -print-file-name=@var{library}
14124 @opindex print-file-name
14125 Print the full absolute name of the library file @var{library} that
14126 would be used when linking---and don't do anything else.  With this
14127 option, GCC does not compile or link anything; it just prints the
14128 file name.
14130 @item -print-multi-directory
14131 @opindex print-multi-directory
14132 Print the directory name corresponding to the multilib selected by any
14133 other switches present in the command line.  This directory is supposed
14134 to exist in @env{GCC_EXEC_PREFIX}.
14136 @item -print-multi-lib
14137 @opindex print-multi-lib
14138 Print the mapping from multilib directory names to compiler switches
14139 that enable them.  The directory name is separated from the switches by
14140 @samp{;}, and each switch starts with an @samp{@@} instead of the
14141 @samp{-}, without spaces between multiple switches.  This is supposed to
14142 ease shell processing.
14144 @item -print-multi-os-directory
14145 @opindex print-multi-os-directory
14146 Print the path to OS libraries for the selected
14147 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14148 present in the @file{lib} subdirectory and no multilibs are used, this is
14149 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14150 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14151 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14152 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14154 @item -print-multiarch
14155 @opindex print-multiarch
14156 Print the path to OS libraries for the selected multiarch,
14157 relative to some @file{lib} subdirectory.
14159 @item -print-prog-name=@var{program}
14160 @opindex print-prog-name
14161 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14163 @item -print-libgcc-file-name
14164 @opindex print-libgcc-file-name
14165 Same as @option{-print-file-name=libgcc.a}.
14167 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14168 but you do want to link with @file{libgcc.a}.  You can do:
14170 @smallexample
14171 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14172 @end smallexample
14174 @item -print-search-dirs
14175 @opindex print-search-dirs
14176 Print the name of the configured installation directory and a list of
14177 program and library directories @command{gcc} searches---and don't do anything else.
14179 This is useful when @command{gcc} prints the error message
14180 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14181 To resolve this you either need to put @file{cpp0} and the other compiler
14182 components where @command{gcc} expects to find them, or you can set the environment
14183 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14184 Don't forget the trailing @samp{/}.
14185 @xref{Environment Variables}.
14187 @item -print-sysroot
14188 @opindex print-sysroot
14189 Print the target sysroot directory that is used during
14190 compilation.  This is the target sysroot specified either at configure
14191 time or using the @option{--sysroot} option, possibly with an extra
14192 suffix that depends on compilation options.  If no target sysroot is
14193 specified, the option prints nothing.
14195 @item -print-sysroot-headers-suffix
14196 @opindex print-sysroot-headers-suffix
14197 Print the suffix added to the target sysroot when searching for
14198 headers, or give an error if the compiler is not configured with such
14199 a suffix---and don't do anything else.
14201 @item -dumpmachine
14202 @opindex dumpmachine
14203 Print the compiler's target machine (for example,
14204 @samp{i686-pc-linux-gnu})---and don't do anything else.
14206 @item -dumpversion
14207 @opindex dumpversion
14208 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14209 anything else.  This is the compiler version used in filesystem paths,
14210 specs, can be depending on how the compiler has been configured just
14211 a single number (major version), two numbers separated by dot (major and
14212 minor version) or three numbers separated by dots (major, minor and patchlevel
14213 version).
14215 @item -dumpfullversion
14216 @opindex dumpfullversion
14217 Print the full compiler version, always 3 numbers separated by dots,
14218 major, minor and patchlevel version.
14220 @item -dumpspecs
14221 @opindex dumpspecs
14222 Print the compiler's built-in specs---and don't do anything else.  (This
14223 is used when GCC itself is being built.)  @xref{Spec Files}.
14224 @end table
14226 @node Submodel Options
14227 @section Machine-Dependent Options
14228 @cindex submodel options
14229 @cindex specifying hardware config
14230 @cindex hardware models and configurations, specifying
14231 @cindex target-dependent options
14232 @cindex machine-dependent options
14234 Each target machine supported by GCC can have its own options---for
14235 example, to allow you to compile for a particular processor variant or
14236 ABI, or to control optimizations specific to that machine.  By
14237 convention, the names of machine-specific options start with
14238 @samp{-m}.
14240 Some configurations of the compiler also support additional target-specific
14241 options, usually for compatibility with other compilers on the same
14242 platform.
14244 @c This list is ordered alphanumerically by subsection name.
14245 @c It should be the same order and spelling as these options are listed
14246 @c in Machine Dependent Options
14248 @menu
14249 * AArch64 Options::
14250 * Adapteva Epiphany Options::
14251 * ARC Options::
14252 * ARM Options::
14253 * AVR Options::
14254 * Blackfin Options::
14255 * C6X Options::
14256 * CRIS Options::
14257 * CR16 Options::
14258 * Darwin Options::
14259 * DEC Alpha Options::
14260 * FR30 Options::
14261 * FT32 Options::
14262 * FRV Options::
14263 * GNU/Linux Options::
14264 * H8/300 Options::
14265 * HPPA Options::
14266 * IA-64 Options::
14267 * LM32 Options::
14268 * M32C Options::
14269 * M32R/D Options::
14270 * M680x0 Options::
14271 * MCore Options::
14272 * MeP Options::
14273 * MicroBlaze Options::
14274 * MIPS Options::
14275 * MMIX Options::
14276 * MN10300 Options::
14277 * Moxie Options::
14278 * MSP430 Options::
14279 * NDS32 Options::
14280 * Nios II Options::
14281 * Nvidia PTX Options::
14282 * PDP-11 Options::
14283 * picoChip Options::
14284 * PowerPC Options::
14285 * RISC-V Options::
14286 * RL78 Options::
14287 * RS/6000 and PowerPC Options::
14288 * RX Options::
14289 * S/390 and zSeries Options::
14290 * Score Options::
14291 * SH Options::
14292 * Solaris 2 Options::
14293 * SPARC Options::
14294 * SPU Options::
14295 * System V Options::
14296 * TILE-Gx Options::
14297 * TILEPro Options::
14298 * V850 Options::
14299 * VAX Options::
14300 * Visium Options::
14301 * VMS Options::
14302 * VxWorks Options::
14303 * x86 Options::
14304 * x86 Windows Options::
14305 * Xstormy16 Options::
14306 * Xtensa Options::
14307 * zSeries Options::
14308 @end menu
14310 @node AArch64 Options
14311 @subsection AArch64 Options
14312 @cindex AArch64 Options
14314 These options are defined for AArch64 implementations:
14316 @table @gcctabopt
14318 @item -mabi=@var{name}
14319 @opindex mabi
14320 Generate code for the specified data model.  Permissible values
14321 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14322 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14323 but long int and pointers are 64 bits.
14325 The default depends on the specific target configuration.  Note that
14326 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14327 entire program with the same ABI, and link with a compatible set of libraries.
14329 @item -mbig-endian
14330 @opindex mbig-endian
14331 Generate big-endian code.  This is the default when GCC is configured for an
14332 @samp{aarch64_be-*-*} target.
14334 @item -mgeneral-regs-only
14335 @opindex mgeneral-regs-only
14336 Generate code which uses only the general-purpose registers.  This will prevent
14337 the compiler from using floating-point and Advanced SIMD registers but will not
14338 impose any restrictions on the assembler.
14340 @item -mlittle-endian
14341 @opindex mlittle-endian
14342 Generate little-endian code.  This is the default when GCC is configured for an
14343 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14345 @item -mcmodel=tiny
14346 @opindex mcmodel=tiny
14347 Generate code for the tiny code model.  The program and its statically defined
14348 symbols must be within 1MB of each other.  Programs can be statically or
14349 dynamically linked.
14351 @item -mcmodel=small
14352 @opindex mcmodel=small
14353 Generate code for the small code model.  The program and its statically defined
14354 symbols must be within 4GB of each other.  Programs can be statically or
14355 dynamically linked.  This is the default code model.
14357 @item -mcmodel=large
14358 @opindex mcmodel=large
14359 Generate code for the large code model.  This makes no assumptions about
14360 addresses and sizes of sections.  Programs can be statically linked only.
14362 @item -mstrict-align
14363 @opindex mstrict-align
14364 Avoid generating memory accesses that may not be aligned on a natural object
14365 boundary as described in the architecture specification.
14367 @item -momit-leaf-frame-pointer
14368 @itemx -mno-omit-leaf-frame-pointer
14369 @opindex momit-leaf-frame-pointer
14370 @opindex mno-omit-leaf-frame-pointer
14371 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14372 default.
14374 @item -mtls-dialect=desc
14375 @opindex mtls-dialect=desc
14376 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14377 of TLS variables.  This is the default.
14379 @item -mtls-dialect=traditional
14380 @opindex mtls-dialect=traditional
14381 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14382 of TLS variables.
14384 @item -mtls-size=@var{size}
14385 @opindex mtls-size
14386 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14387 This option requires binutils 2.26 or newer.
14389 @item -mfix-cortex-a53-835769
14390 @itemx -mno-fix-cortex-a53-835769
14391 @opindex mfix-cortex-a53-835769
14392 @opindex mno-fix-cortex-a53-835769
14393 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14394 This involves inserting a NOP instruction between memory instructions and
14395 64-bit integer multiply-accumulate instructions.
14397 @item -mfix-cortex-a53-843419
14398 @itemx -mno-fix-cortex-a53-843419
14399 @opindex mfix-cortex-a53-843419
14400 @opindex mno-fix-cortex-a53-843419
14401 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14402 This erratum workaround is made at link time and this will only pass the
14403 corresponding flag to the linker.
14405 @item -mlow-precision-recip-sqrt
14406 @item -mno-low-precision-recip-sqrt
14407 @opindex mlow-precision-recip-sqrt
14408 @opindex mno-low-precision-recip-sqrt
14409 Enable or disable the reciprocal square root approximation.
14410 This option only has an effect if @option{-ffast-math} or
14411 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14412 precision of reciprocal square root results to about 16 bits for
14413 single precision and to 32 bits for double precision.
14415 @item -mlow-precision-sqrt
14416 @item -mno-low-precision-sqrt
14417 @opindex -mlow-precision-sqrt
14418 @opindex -mno-low-precision-sqrt
14419 Enable or disable the square root approximation.
14420 This option only has an effect if @option{-ffast-math} or
14421 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14422 precision of square root results to about 16 bits for
14423 single precision and to 32 bits for double precision.
14424 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14426 @item -mlow-precision-div
14427 @item -mno-low-precision-div
14428 @opindex -mlow-precision-div
14429 @opindex -mno-low-precision-div
14430 Enable or disable the division approximation.
14431 This option only has an effect if @option{-ffast-math} or
14432 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14433 precision of division results to about 16 bits for
14434 single precision and to 32 bits for double precision.
14436 @item -march=@var{name}
14437 @opindex march
14438 Specify the name of the target architecture and, optionally, one or
14439 more feature modifiers.  This option has the form
14440 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14442 The permissible values for @var{arch} are @samp{armv8-a},
14443 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14445 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14446 support for the ARMv8.3-A architecture extensions.
14448 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14449 support for the ARMv8.2-A architecture extensions.
14451 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14452 support for the ARMv8.1-A architecture extension.  In particular, it
14453 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14455 The value @samp{native} is available on native AArch64 GNU/Linux and
14456 causes the compiler to pick the architecture of the host system.  This
14457 option has no effect if the compiler is unable to recognize the
14458 architecture of the host system,
14460 The permissible values for @var{feature} are listed in the sub-section
14461 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14462 Feature Modifiers}.  Where conflicting feature modifiers are
14463 specified, the right-most feature is used.
14465 GCC uses @var{name} to determine what kind of instructions it can emit
14466 when generating assembly code.  If @option{-march} is specified
14467 without either of @option{-mtune} or @option{-mcpu} also being
14468 specified, the code is tuned to perform well across a range of target
14469 processors implementing the target architecture.
14471 @item -mtune=@var{name}
14472 @opindex mtune
14473 Specify the name of the target processor for which GCC should tune the
14474 performance of the code.  Permissible values for this option are:
14475 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14476 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14477 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14478 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14479 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14480 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14481 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14482 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14483 @samp{native}.
14485 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14486 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14487 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14488 big.LITTLE system.
14490 Additionally on native AArch64 GNU/Linux systems the value
14491 @samp{native} tunes performance to the host system.  This option has no effect
14492 if the compiler is unable to recognize the processor of the host system.
14494 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14495 are specified, the code is tuned to perform well across a range
14496 of target processors.
14498 This option cannot be suffixed by feature modifiers.
14500 @item -mcpu=@var{name}
14501 @opindex mcpu
14502 Specify the name of the target processor, optionally suffixed by one
14503 or more feature modifiers.  This option has the form
14504 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14505 the permissible values for @var{cpu} are the same as those available
14506 for @option{-mtune}.  The permissible values for @var{feature} are
14507 documented in the sub-section on
14508 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14509 Feature Modifiers}.  Where conflicting feature modifiers are
14510 specified, the right-most feature is used.
14512 GCC uses @var{name} to determine what kind of instructions it can emit when
14513 generating assembly code (as if by @option{-march}) and to determine
14514 the target processor for which to tune for performance (as if
14515 by @option{-mtune}).  Where this option is used in conjunction
14516 with @option{-march} or @option{-mtune}, those options take precedence
14517 over the appropriate part of this option.
14519 @item -moverride=@var{string}
14520 @opindex moverride
14521 Override tuning decisions made by the back-end in response to a
14522 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14523 for @var{string} in this option are not guaranteed to be consistent
14524 across releases.
14526 This option is only intended to be useful when developing GCC.
14528 @item -mpc-relative-literal-loads
14529 @itemx -mno-pc-relative-literal-loads
14530 @opindex mpc-relative-literal-loads
14531 @opindex mno-pc-relative-literal-loads
14532 Enable or disable PC-relative literal loads.  With this option literal pools are
14533 accessed using a single instruction and emitted after each function.  This
14534 limits the maximum size of functions to 1MB.  This is enabled by default for
14535 @option{-mcmodel=tiny}.
14537 @item -msign-return-address=@var{scope}
14538 @opindex msign-return-address
14539 Select the function scope on which return address signing will be applied.
14540 Permissible values are @samp{none}, which disables return address signing,
14541 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14542 functions, and @samp{all}, which enables pointer signing for all functions.  The
14543 default value is @samp{none}.
14545 @end table
14547 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14548 @anchor{aarch64-feature-modifiers}
14549 @cindex @option{-march} feature modifiers
14550 @cindex @option{-mcpu} feature modifiers
14551 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14552 the following and their inverses @option{no@var{feature}}:
14554 @table @samp
14555 @item crc
14556 Enable CRC extension.  This is on by default for
14557 @option{-march=armv8.1-a}.
14558 @item crypto
14559 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14560 instructions.
14561 @item fp
14562 Enable floating-point instructions.  This is on by default for all possible
14563 values for options @option{-march} and @option{-mcpu}.
14564 @item simd
14565 Enable Advanced SIMD instructions.  This also enables floating-point
14566 instructions.  This is on by default for all possible values for options
14567 @option{-march} and @option{-mcpu}.
14568 @item lse
14569 Enable Large System Extension instructions.  This is on by default for
14570 @option{-march=armv8.1-a}.
14571 @item rdma
14572 Enable Round Double Multiply Accumulate instructions.  This is on by default
14573 for @option{-march=armv8.1-a}.
14574 @item fp16
14575 Enable FP16 extension.  This also enables floating-point instructions.
14576 @item rcpc
14577 Enable the RcPc extension.  This does not change code generation from GCC,
14578 but is passed on to the assembler, enabling inline asm statements to use
14579 instructions from the RcPc extension.
14580 @item dotprod
14581 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14583 @end table
14585 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14586 Conversely, @option{nofp} implies @option{nosimd}, which implies
14587 @option{nocrypto}.
14589 @node Adapteva Epiphany Options
14590 @subsection Adapteva Epiphany Options
14592 These @samp{-m} options are defined for Adapteva Epiphany:
14594 @table @gcctabopt
14595 @item -mhalf-reg-file
14596 @opindex mhalf-reg-file
14597 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14598 That allows code to run on hardware variants that lack these registers.
14600 @item -mprefer-short-insn-regs
14601 @opindex mprefer-short-insn-regs
14602 Preferentially allocate registers that allow short instruction generation.
14603 This can result in increased instruction count, so this may either reduce or
14604 increase overall code size.
14606 @item -mbranch-cost=@var{num}
14607 @opindex mbranch-cost
14608 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14609 This cost is only a heuristic and is not guaranteed to produce
14610 consistent results across releases.
14612 @item -mcmove
14613 @opindex mcmove
14614 Enable the generation of conditional moves.
14616 @item -mnops=@var{num}
14617 @opindex mnops
14618 Emit @var{num} NOPs before every other generated instruction.
14620 @item -mno-soft-cmpsf
14621 @opindex mno-soft-cmpsf
14622 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14623 and test the flags.  This is faster than a software comparison, but can
14624 get incorrect results in the presence of NaNs, or when two different small
14625 numbers are compared such that their difference is calculated as zero.
14626 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14627 software comparisons.
14629 @item -mstack-offset=@var{num}
14630 @opindex mstack-offset
14631 Set the offset between the top of the stack and the stack pointer.
14632 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14633 can be used by leaf functions without stack allocation.
14634 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14635 Note also that this option changes the ABI; compiling a program with a
14636 different stack offset than the libraries have been compiled with
14637 generally does not work.
14638 This option can be useful if you want to evaluate if a different stack
14639 offset would give you better code, but to actually use a different stack
14640 offset to build working programs, it is recommended to configure the
14641 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14643 @item -mno-round-nearest
14644 @opindex mno-round-nearest
14645 Make the scheduler assume that the rounding mode has been set to
14646 truncating.  The default is @option{-mround-nearest}.
14648 @item -mlong-calls
14649 @opindex mlong-calls
14650 If not otherwise specified by an attribute, assume all calls might be beyond
14651 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14652 function address into a register before performing a (otherwise direct) call.
14653 This is the default.
14655 @item -mshort-calls
14656 @opindex short-calls
14657 If not otherwise specified by an attribute, assume all direct calls are
14658 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14659 for direct calls.  The default is @option{-mlong-calls}.
14661 @item -msmall16
14662 @opindex msmall16
14663 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14664 apply to function addresses for which @option{-mlong-calls} semantics
14665 are in effect.
14667 @item -mfp-mode=@var{mode}
14668 @opindex mfp-mode
14669 Set the prevailing mode of the floating-point unit.
14670 This determines the floating-point mode that is provided and expected
14671 at function call and return time.  Making this mode match the mode you
14672 predominantly need at function start can make your programs smaller and
14673 faster by avoiding unnecessary mode switches.
14675 @var{mode} can be set to one the following values:
14677 @table @samp
14678 @item caller
14679 Any mode at function entry is valid, and retained or restored when
14680 the function returns, and when it calls other functions.
14681 This mode is useful for compiling libraries or other compilation units
14682 you might want to incorporate into different programs with different
14683 prevailing FPU modes, and the convenience of being able to use a single
14684 object file outweighs the size and speed overhead for any extra
14685 mode switching that might be needed, compared with what would be needed
14686 with a more specific choice of prevailing FPU mode.
14688 @item truncate
14689 This is the mode used for floating-point calculations with
14690 truncating (i.e.@: round towards zero) rounding mode.  That includes
14691 conversion from floating point to integer.
14693 @item round-nearest
14694 This is the mode used for floating-point calculations with
14695 round-to-nearest-or-even rounding mode.
14697 @item int
14698 This is the mode used to perform integer calculations in the FPU, e.g.@:
14699 integer multiply, or integer multiply-and-accumulate.
14700 @end table
14702 The default is @option{-mfp-mode=caller}
14704 @item -mnosplit-lohi
14705 @itemx -mno-postinc
14706 @itemx -mno-postmodify
14707 @opindex mnosplit-lohi
14708 @opindex mno-postinc
14709 @opindex mno-postmodify
14710 Code generation tweaks that disable, respectively, splitting of 32-bit
14711 loads, generation of post-increment addresses, and generation of
14712 post-modify addresses.  The defaults are @option{msplit-lohi},
14713 @option{-mpost-inc}, and @option{-mpost-modify}.
14715 @item -mnovect-double
14716 @opindex mno-vect-double
14717 Change the preferred SIMD mode to SImode.  The default is
14718 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14720 @item -max-vect-align=@var{num}
14721 @opindex max-vect-align
14722 The maximum alignment for SIMD vector mode types.
14723 @var{num} may be 4 or 8.  The default is 8.
14724 Note that this is an ABI change, even though many library function
14725 interfaces are unaffected if they don't use SIMD vector modes
14726 in places that affect size and/or alignment of relevant types.
14728 @item -msplit-vecmove-early
14729 @opindex msplit-vecmove-early
14730 Split vector moves into single word moves before reload.  In theory this
14731 can give better register allocation, but so far the reverse seems to be
14732 generally the case.
14734 @item -m1reg-@var{reg}
14735 @opindex m1reg-
14736 Specify a register to hold the constant @minus{}1, which makes loading small negative
14737 constants and certain bitmasks faster.
14738 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14739 which specify use of that register as a fixed register,
14740 and @samp{none}, which means that no register is used for this
14741 purpose.  The default is @option{-m1reg-none}.
14743 @end table
14745 @node ARC Options
14746 @subsection ARC Options
14747 @cindex ARC options
14749 The following options control the architecture variant for which code
14750 is being compiled:
14752 @c architecture variants
14753 @table @gcctabopt
14755 @item -mbarrel-shifter
14756 @opindex mbarrel-shifter
14757 Generate instructions supported by barrel shifter.  This is the default
14758 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14760 @item -mcpu=@var{cpu}
14761 @opindex mcpu
14762 Set architecture type, register usage, and instruction scheduling
14763 parameters for @var{cpu}.  There are also shortcut alias options
14764 available for backward compatibility and convenience.  Supported
14765 values for @var{cpu} are
14767 @table @samp
14768 @opindex mA6
14769 @opindex mARC600
14770 @item arc600
14771 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14773 @item arc601
14774 @opindex mARC601
14775 Compile for ARC601.  Alias: @option{-mARC601}.
14777 @item arc700
14778 @opindex mA7
14779 @opindex mARC700
14780 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14781 This is the default when configured with @option{--with-cpu=arc700}@.
14783 @item arcem
14784 Compile for ARC EM.
14786 @item archs
14787 Compile for ARC HS.
14789 @item em
14790 Compile for ARC EM CPU with no hardware extensions.
14792 @item em4
14793 Compile for ARC EM4 CPU.
14795 @item em4_dmips
14796 Compile for ARC EM4 DMIPS CPU.
14798 @item em4_fpus
14799 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14800 extension.
14802 @item em4_fpuda
14803 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14804 double assist instructions.
14806 @item hs
14807 Compile for ARC HS CPU with no hardware extensions except the atomic
14808 instructions.
14810 @item hs34
14811 Compile for ARC HS34 CPU.
14813 @item hs38
14814 Compile for ARC HS38 CPU.
14816 @item hs38_linux
14817 Compile for ARC HS38 CPU with all hardware extensions on.
14819 @item arc600_norm
14820 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14822 @item arc600_mul32x16
14823 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14824 instructions enabled.
14826 @item arc600_mul64
14827 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14828 instructions enabled.
14830 @item arc601_norm
14831 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14833 @item arc601_mul32x16
14834 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14835 instructions enabled.
14837 @item arc601_mul64
14838 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14839 instructions enabled.
14841 @item nps400
14842 Compile for ARC 700 on NPS400 chip.
14844 @end table
14846 @item -mdpfp
14847 @opindex mdpfp
14848 @itemx -mdpfp-compact
14849 @opindex mdpfp-compact
14850 Generate double-precision FPX instructions, tuned for the compact
14851 implementation.
14853 @item -mdpfp-fast
14854 @opindex mdpfp-fast
14855 Generate double-precision FPX instructions, tuned for the fast
14856 implementation.
14858 @item -mno-dpfp-lrsr
14859 @opindex mno-dpfp-lrsr
14860 Disable @code{lr} and @code{sr} instructions from using FPX extension
14861 aux registers.
14863 @item -mea
14864 @opindex mea
14865 Generate extended arithmetic instructions.  Currently only
14866 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14867 supported.  This is always enabled for @option{-mcpu=ARC700}.
14869 @item -mno-mpy
14870 @opindex mno-mpy
14871 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14872 deprecated.
14874 @item -mmul32x16
14875 @opindex mmul32x16
14876 Generate 32x16-bit multiply and multiply-accumulate instructions.
14878 @item -mmul64
14879 @opindex mmul64
14880 Generate @code{mul64} and @code{mulu64} instructions.  
14881 Only valid for @option{-mcpu=ARC600}.
14883 @item -mnorm
14884 @opindex mnorm
14885 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14886 is in effect.
14888 @item -mspfp
14889 @opindex mspfp
14890 @itemx -mspfp-compact
14891 @opindex mspfp-compact
14892 Generate single-precision FPX instructions, tuned for the compact
14893 implementation.
14895 @item -mspfp-fast
14896 @opindex mspfp-fast
14897 Generate single-precision FPX instructions, tuned for the fast
14898 implementation.
14900 @item -msimd
14901 @opindex msimd
14902 Enable generation of ARC SIMD instructions via target-specific
14903 builtins.  Only valid for @option{-mcpu=ARC700}.
14905 @item -msoft-float
14906 @opindex msoft-float
14907 This option ignored; it is provided for compatibility purposes only.
14908 Software floating-point code is emitted by default, and this default
14909 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14910 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14911 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14913 @item -mswap
14914 @opindex mswap
14915 Generate @code{swap} instructions.
14917 @item -matomic
14918 @opindex matomic
14919 This enables use of the locked load/store conditional extension to implement
14920 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14921 EM cores.
14923 @item -mdiv-rem
14924 @opindex mdiv-rem
14925 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14927 @item -mcode-density
14928 @opindex mcode-density
14929 Enable code density instructions for ARC EM.  
14930 This option is on by default for ARC HS.
14932 @item -mll64
14933 @opindex mll64
14934 Enable double load/store operations for ARC HS cores.
14936 @item -mtp-regno=@var{regno}
14937 @opindex mtp-regno
14938 Specify thread pointer register number.
14940 @item -mmpy-option=@var{multo}
14941 @opindex mmpy-option
14942 Compile ARCv2 code with a multiplier design option.  You can specify 
14943 the option using either a string or numeric value for @var{multo}.  
14944 @samp{wlh1} is the default value.  The recognized values are:
14946 @table @samp
14947 @item 0
14948 @itemx none
14949 No multiplier available.
14951 @item 1
14952 @itemx w
14953 16x16 multiplier, fully pipelined.
14954 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14956 @item 2
14957 @itemx wlh1
14958 32x32 multiplier, fully
14959 pipelined (1 stage).  The following instructions are additionally
14960 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14962 @item 3
14963 @itemx wlh2
14964 32x32 multiplier, fully pipelined
14965 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14966 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14968 @item 4
14969 @itemx wlh3
14970 Two 16x16 multipliers, blocking,
14971 sequential.  The following instructions are additionally enabled: @code{mpy},
14972 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14974 @item 5
14975 @itemx wlh4
14976 One 16x16 multiplier, blocking,
14977 sequential.  The following instructions are additionally enabled: @code{mpy},
14978 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14980 @item 6
14981 @itemx wlh5
14982 One 32x4 multiplier, blocking,
14983 sequential.  The following instructions are additionally enabled: @code{mpy},
14984 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14986 @item 7
14987 @itemx plus_dmpy
14988 ARC HS SIMD support.
14990 @item 8
14991 @itemx plus_macd
14992 ARC HS SIMD support.
14994 @item 9
14995 @itemx plus_qmacw
14996 ARC HS SIMD support.
14998 @end table
15000 This option is only available for ARCv2 cores@.
15002 @item -mfpu=@var{fpu}
15003 @opindex mfpu
15004 Enables support for specific floating-point hardware extensions for ARCv2
15005 cores.  Supported values for @var{fpu} are:
15007 @table @samp
15009 @item fpus
15010 Enables support for single-precision floating-point hardware
15011 extensions@.
15013 @item fpud
15014 Enables support for double-precision floating-point hardware
15015 extensions.  The single-precision floating-point extension is also
15016 enabled.  Not available for ARC EM@.
15018 @item fpuda
15019 Enables support for double-precision floating-point hardware
15020 extensions using double-precision assist instructions.  The single-precision
15021 floating-point extension is also enabled.  This option is
15022 only available for ARC EM@.
15024 @item fpuda_div
15025 Enables support for double-precision floating-point hardware
15026 extensions using double-precision assist instructions.
15027 The single-precision floating-point, square-root, and divide 
15028 extensions are also enabled.  This option is
15029 only available for ARC EM@.
15031 @item fpuda_fma
15032 Enables support for double-precision floating-point hardware
15033 extensions using double-precision assist instructions.
15034 The single-precision floating-point and fused multiply and add 
15035 hardware extensions are also enabled.  This option is
15036 only available for ARC EM@.
15038 @item fpuda_all
15039 Enables support for double-precision floating-point hardware
15040 extensions using double-precision assist instructions.
15041 All single-precision floating-point hardware extensions are also
15042 enabled.  This option is only available for ARC EM@.
15044 @item fpus_div
15045 Enables support for single-precision floating-point, square-root and divide 
15046 hardware extensions@.
15048 @item fpud_div
15049 Enables support for double-precision floating-point, square-root and divide 
15050 hardware extensions.  This option
15051 includes option @samp{fpus_div}. Not available for ARC EM@.
15053 @item fpus_fma
15054 Enables support for single-precision floating-point and 
15055 fused multiply and add hardware extensions@.
15057 @item fpud_fma
15058 Enables support for double-precision floating-point and 
15059 fused multiply and add hardware extensions.  This option
15060 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15062 @item fpus_all
15063 Enables support for all single-precision floating-point hardware
15064 extensions@.
15066 @item fpud_all
15067 Enables support for all single- and double-precision floating-point
15068 hardware extensions.  Not available for ARC EM@.
15070 @end table
15072 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15073 @opindex mirq-ctrl-saved
15074 Specifies general-purposes registers that the processor automatically
15075 saves/restores on interrupt entry and exit.  @var{register-range} is
15076 specified as two registers separated by a dash.  The register range
15077 always starts with @code{r0}, the upper limit is @code{fp} register.
15078 @var{blink} and @var{lp_count} are optional.  This option is only
15079 valid for ARC EM and ARC HS cores.
15081 @item -mrgf-banked-regs=@var{number}
15082 @opindex mrgf-banked-regs
15083 Specifies the number of registers replicated in second register bank
15084 on entry to fast interrupt.  Fast interrupts are interrupts with the
15085 highest priority level P0.  These interrupts save only PC and STATUS32
15086 registers to avoid memory transactions during interrupt entry and exit
15087 sequences.  Use this option when you are using fast interrupts in an
15088 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15090 @item -mlpc-width=@var{width}
15091 @opindex mlpc-width
15092 Specify the width of the @code{lp_count} register.  Valid values for
15093 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15094 fixed to 32 bits.  If the width is less than 32, the compiler does not
15095 attempt to transform loops in your program to use the zero-delay loop
15096 mechanism unless it is known that the @code{lp_count} register can
15097 hold the required loop-counter value.  Depending on the width
15098 specified, the compiler and run-time library might continue to use the
15099 loop mechanism for various needs.  This option defines macro
15100 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15102 @end table
15104 The following options are passed through to the assembler, and also
15105 define preprocessor macro symbols.
15107 @c Flags used by the assembler, but for which we define preprocessor
15108 @c macro symbols as well.
15109 @table @gcctabopt
15110 @item -mdsp-packa
15111 @opindex mdsp-packa
15112 Passed down to the assembler to enable the DSP Pack A extensions.
15113 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15114 deprecated.
15116 @item -mdvbf
15117 @opindex mdvbf
15118 Passed down to the assembler to enable the dual Viterbi butterfly
15119 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15120 option is deprecated.
15122 @c ARC700 4.10 extension instruction
15123 @item -mlock
15124 @opindex mlock
15125 Passed down to the assembler to enable the locked load/store
15126 conditional extension.  Also sets the preprocessor symbol
15127 @code{__Xlock}.
15129 @item -mmac-d16
15130 @opindex mmac-d16
15131 Passed down to the assembler.  Also sets the preprocessor symbol
15132 @code{__Xxmac_d16}.  This option is deprecated.
15134 @item -mmac-24
15135 @opindex mmac-24
15136 Passed down to the assembler.  Also sets the preprocessor symbol
15137 @code{__Xxmac_24}.  This option is deprecated.
15139 @c ARC700 4.10 extension instruction
15140 @item -mrtsc
15141 @opindex mrtsc
15142 Passed down to the assembler to enable the 64-bit time-stamp counter
15143 extension instruction.  Also sets the preprocessor symbol
15144 @code{__Xrtsc}.  This option is deprecated.
15146 @c ARC700 4.10 extension instruction
15147 @item -mswape
15148 @opindex mswape
15149 Passed down to the assembler to enable the swap byte ordering
15150 extension instruction.  Also sets the preprocessor symbol
15151 @code{__Xswape}.
15153 @item -mtelephony
15154 @opindex mtelephony
15155 Passed down to the assembler to enable dual- and single-operand
15156 instructions for telephony.  Also sets the preprocessor symbol
15157 @code{__Xtelephony}.  This option is deprecated.
15159 @item -mxy
15160 @opindex mxy
15161 Passed down to the assembler to enable the XY memory extension.  Also
15162 sets the preprocessor symbol @code{__Xxy}.
15164 @end table
15166 The following options control how the assembly code is annotated:
15168 @c Assembly annotation options
15169 @table @gcctabopt
15170 @item -misize
15171 @opindex misize
15172 Annotate assembler instructions with estimated addresses.
15174 @item -mannotate-align
15175 @opindex mannotate-align
15176 Explain what alignment considerations lead to the decision to make an
15177 instruction short or long.
15179 @end table
15181 The following options are passed through to the linker:
15183 @c options passed through to the linker
15184 @table @gcctabopt
15185 @item -marclinux
15186 @opindex marclinux
15187 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15188 This option is enabled by default in tool chains built for
15189 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15190 when profiling is not requested.
15192 @item -marclinux_prof
15193 @opindex marclinux_prof
15194 Passed through to the linker, to specify use of the
15195 @code{arclinux_prof} emulation.  This option is enabled by default in
15196 tool chains built for @w{@code{arc-linux-uclibc}} and
15197 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15199 @end table
15201 The following options control the semantics of generated code:
15203 @c semantically relevant code generation options
15204 @table @gcctabopt
15205 @item -mlong-calls
15206 @opindex mlong-calls
15207 Generate calls as register indirect calls, thus providing access
15208 to the full 32-bit address range.
15210 @item -mmedium-calls
15211 @opindex mmedium-calls
15212 Don't use less than 25-bit addressing range for calls, which is the
15213 offset available for an unconditional branch-and-link
15214 instruction.  Conditional execution of function calls is suppressed, to
15215 allow use of the 25-bit range, rather than the 21-bit range with
15216 conditional branch-and-link.  This is the default for tool chains built
15217 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15219 @item -G @var{num}
15220 @opindex G
15221 Put definitions of externally-visible data in a small data section if
15222 that data is no bigger than @var{num} bytes.  The default value of
15223 @var{num} is 4 for any ARC configuration, or 8 when we have double
15224 load/store operations.
15226 @item -mno-sdata
15227 @opindex mno-sdata
15228 Do not generate sdata references.  This is the default for tool chains
15229 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15230 targets.
15232 @item -mvolatile-cache
15233 @opindex mvolatile-cache
15234 Use ordinarily cached memory accesses for volatile references.  This is the
15235 default.
15237 @item -mno-volatile-cache
15238 @opindex mno-volatile-cache
15239 Enable cache bypass for volatile references.
15241 @end table
15243 The following options fine tune code generation:
15244 @c code generation tuning options
15245 @table @gcctabopt
15246 @item -malign-call
15247 @opindex malign-call
15248 Do alignment optimizations for call instructions.
15250 @item -mauto-modify-reg
15251 @opindex mauto-modify-reg
15252 Enable the use of pre/post modify with register displacement.
15254 @item -mbbit-peephole
15255 @opindex mbbit-peephole
15256 Enable bbit peephole2.
15258 @item -mno-brcc
15259 @opindex mno-brcc
15260 This option disables a target-specific pass in @file{arc_reorg} to
15261 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15262 It has no effect on
15263 generation of these instructions driven by the combiner pass.
15265 @item -mcase-vector-pcrel
15266 @opindex mcase-vector-pcrel
15267 Use PC-relative switch case tables to enable case table shortening.
15268 This is the default for @option{-Os}.
15270 @item -mcompact-casesi
15271 @opindex mcompact-casesi
15272 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15273 and only available for ARCv1 cores.
15275 @item -mno-cond-exec
15276 @opindex mno-cond-exec
15277 Disable the ARCompact-specific pass to generate conditional 
15278 execution instructions.
15280 Due to delay slot scheduling and interactions between operand numbers,
15281 literal sizes, instruction lengths, and the support for conditional execution,
15282 the target-independent pass to generate conditional execution is often lacking,
15283 so the ARC port has kept a special pass around that tries to find more
15284 conditional execution generation opportunities after register allocation,
15285 branch shortening, and delay slot scheduling have been done.  This pass
15286 generally, but not always, improves performance and code size, at the cost of
15287 extra compilation time, which is why there is an option to switch it off.
15288 If you have a problem with call instructions exceeding their allowable
15289 offset range because they are conditionalized, you should consider using
15290 @option{-mmedium-calls} instead.
15292 @item -mearly-cbranchsi
15293 @opindex mearly-cbranchsi
15294 Enable pre-reload use of the @code{cbranchsi} pattern.
15296 @item -mexpand-adddi
15297 @opindex mexpand-adddi
15298 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15299 @code{add.f}, @code{adc} etc.  This option is deprecated.
15301 @item -mindexed-loads
15302 @opindex mindexed-loads
15303 Enable the use of indexed loads.  This can be problematic because some
15304 optimizers then assume that indexed stores exist, which is not
15305 the case.
15307 @opindex mlra
15308 Enable Local Register Allocation.  This is still experimental for ARC,
15309 so by default the compiler uses standard reload
15310 (i.e. @option{-mno-lra}).
15312 @item -mlra-priority-none
15313 @opindex mlra-priority-none
15314 Don't indicate any priority for target registers.
15316 @item -mlra-priority-compact
15317 @opindex mlra-priority-compact
15318 Indicate target register priority for r0..r3 / r12..r15.
15320 @item -mlra-priority-noncompact
15321 @opindex mlra-priority-noncompact
15322 Reduce target register priority for r0..r3 / r12..r15.
15324 @item -mno-millicode
15325 @opindex mno-millicode
15326 When optimizing for size (using @option{-Os}), prologues and epilogues
15327 that have to save or restore a large number of registers are often
15328 shortened by using call to a special function in libgcc; this is
15329 referred to as a @emph{millicode} call.  As these calls can pose
15330 performance issues, and/or cause linking issues when linking in a
15331 nonstandard way, this option is provided to turn off millicode call
15332 generation.
15334 @item -mmixed-code
15335 @opindex mmixed-code
15336 Tweak register allocation to help 16-bit instruction generation.
15337 This generally has the effect of decreasing the average instruction size
15338 while increasing the instruction count.
15340 @item -mq-class
15341 @opindex mq-class
15342 Enable @samp{q} instruction alternatives.
15343 This is the default for @option{-Os}.
15345 @item -mRcq
15346 @opindex mRcq
15347 Enable @samp{Rcq} constraint handling.  
15348 Most short code generation depends on this.
15349 This is the default.
15351 @item -mRcw
15352 @opindex mRcw
15353 Enable @samp{Rcw} constraint handling.  
15354 Most ccfsm condexec mostly depends on this.
15355 This is the default.
15357 @item -msize-level=@var{level}
15358 @opindex msize-level
15359 Fine-tune size optimization with regards to instruction lengths and alignment.
15360 The recognized values for @var{level} are:
15361 @table @samp
15362 @item 0
15363 No size optimization.  This level is deprecated and treated like @samp{1}.
15365 @item 1
15366 Short instructions are used opportunistically.
15368 @item 2
15369 In addition, alignment of loops and of code after barriers are dropped.
15371 @item 3
15372 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15374 @end table
15376 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15377 the behavior when this is not set is equivalent to level @samp{1}.
15379 @item -mtune=@var{cpu}
15380 @opindex mtune
15381 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15382 by @option{-mcpu=}.
15384 Supported values for @var{cpu} are
15386 @table @samp
15387 @item ARC600
15388 Tune for ARC600 CPU.
15390 @item ARC601
15391 Tune for ARC601 CPU.
15393 @item ARC700
15394 Tune for ARC700 CPU with standard multiplier block.
15396 @item ARC700-xmac
15397 Tune for ARC700 CPU with XMAC block.
15399 @item ARC725D
15400 Tune for ARC725D CPU.
15402 @item ARC750D
15403 Tune for ARC750D CPU.
15405 @end table
15407 @item -mmultcost=@var{num}
15408 @opindex mmultcost
15409 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15410 normal instruction.
15412 @item -munalign-prob-threshold=@var{probability}
15413 @opindex munalign-prob-threshold
15414 Set probability threshold for unaligning branches.
15415 When tuning for @samp{ARC700} and optimizing for speed, branches without
15416 filled delay slot are preferably emitted unaligned and long, unless
15417 profiling indicates that the probability for the branch to be taken
15418 is below @var{probability}.  @xref{Cross-profiling}.
15419 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15421 @end table
15423 The following options are maintained for backward compatibility, but
15424 are now deprecated and will be removed in a future release:
15426 @c Deprecated options
15427 @table @gcctabopt
15429 @item -margonaut
15430 @opindex margonaut
15431 Obsolete FPX.
15433 @item -mbig-endian
15434 @opindex mbig-endian
15435 @itemx -EB
15436 @opindex EB
15437 Compile code for big-endian targets.  Use of these options is now
15438 deprecated.  Big-endian code is supported by configuring GCC to build
15439 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15440 for which big endian is the default.
15442 @item -mlittle-endian
15443 @opindex mlittle-endian
15444 @itemx -EL
15445 @opindex EL
15446 Compile code for little-endian targets.  Use of these options is now
15447 deprecated.  Little-endian code is supported by configuring GCC to build 
15448 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15449 for which little endian is the default.
15451 @item -mbarrel_shifter
15452 @opindex mbarrel_shifter
15453 Replaced by @option{-mbarrel-shifter}.
15455 @item -mdpfp_compact
15456 @opindex mdpfp_compact
15457 Replaced by @option{-mdpfp-compact}.
15459 @item -mdpfp_fast
15460 @opindex mdpfp_fast
15461 Replaced by @option{-mdpfp-fast}.
15463 @item -mdsp_packa
15464 @opindex mdsp_packa
15465 Replaced by @option{-mdsp-packa}.
15467 @item -mEA
15468 @opindex mEA
15469 Replaced by @option{-mea}.
15471 @item -mmac_24
15472 @opindex mmac_24
15473 Replaced by @option{-mmac-24}.
15475 @item -mmac_d16
15476 @opindex mmac_d16
15477 Replaced by @option{-mmac-d16}.
15479 @item -mspfp_compact
15480 @opindex mspfp_compact
15481 Replaced by @option{-mspfp-compact}.
15483 @item -mspfp_fast
15484 @opindex mspfp_fast
15485 Replaced by @option{-mspfp-fast}.
15487 @item -mtune=@var{cpu}
15488 @opindex mtune
15489 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15490 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15491 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15493 @item -multcost=@var{num}
15494 @opindex multcost
15495 Replaced by @option{-mmultcost}.
15497 @end table
15499 @node ARM Options
15500 @subsection ARM Options
15501 @cindex ARM options
15503 These @samp{-m} options are defined for the ARM port:
15505 @table @gcctabopt
15506 @item -mabi=@var{name}
15507 @opindex mabi
15508 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15509 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15511 @item -mapcs-frame
15512 @opindex mapcs-frame
15513 Generate a stack frame that is compliant with the ARM Procedure Call
15514 Standard for all functions, even if this is not strictly necessary for
15515 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15516 with this option causes the stack frames not to be generated for
15517 leaf functions.  The default is @option{-mno-apcs-frame}.
15518 This option is deprecated.
15520 @item -mapcs
15521 @opindex mapcs
15522 This is a synonym for @option{-mapcs-frame} and is deprecated.
15524 @ignore
15525 @c not currently implemented
15526 @item -mapcs-stack-check
15527 @opindex mapcs-stack-check
15528 Generate code to check the amount of stack space available upon entry to
15529 every function (that actually uses some stack space).  If there is
15530 insufficient space available then either the function
15531 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15532 called, depending upon the amount of stack space required.  The runtime
15533 system is required to provide these functions.  The default is
15534 @option{-mno-apcs-stack-check}, since this produces smaller code.
15536 @c not currently implemented
15537 @item -mapcs-reentrant
15538 @opindex mapcs-reentrant
15539 Generate reentrant, position-independent code.  The default is
15540 @option{-mno-apcs-reentrant}.
15541 @end ignore
15543 @item -mthumb-interwork
15544 @opindex mthumb-interwork
15545 Generate code that supports calling between the ARM and Thumb
15546 instruction sets.  Without this option, on pre-v5 architectures, the
15547 two instruction sets cannot be reliably used inside one program.  The
15548 default is @option{-mno-thumb-interwork}, since slightly larger code
15549 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15550 configurations this option is meaningless.
15552 @item -mno-sched-prolog
15553 @opindex mno-sched-prolog
15554 Prevent the reordering of instructions in the function prologue, or the
15555 merging of those instruction with the instructions in the function's
15556 body.  This means that all functions start with a recognizable set
15557 of instructions (or in fact one of a choice from a small set of
15558 different function prologues), and this information can be used to
15559 locate the start of functions inside an executable piece of code.  The
15560 default is @option{-msched-prolog}.
15562 @item -mfloat-abi=@var{name}
15563 @opindex mfloat-abi
15564 Specifies which floating-point ABI to use.  Permissible values
15565 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15567 Specifying @samp{soft} causes GCC to generate output containing
15568 library calls for floating-point operations.
15569 @samp{softfp} allows the generation of code using hardware floating-point
15570 instructions, but still uses the soft-float calling conventions.
15571 @samp{hard} allows generation of floating-point instructions
15572 and uses FPU-specific calling conventions.
15574 The default depends on the specific target configuration.  Note that
15575 the hard-float and soft-float ABIs are not link-compatible; you must
15576 compile your entire program with the same ABI, and link with a
15577 compatible set of libraries.
15579 @item -mlittle-endian
15580 @opindex mlittle-endian
15581 Generate code for a processor running in little-endian mode.  This is
15582 the default for all standard configurations.
15584 @item -mbig-endian
15585 @opindex mbig-endian
15586 Generate code for a processor running in big-endian mode; the default is
15587 to compile code for a little-endian processor.
15589 @item -mbe8
15590 @itemx -mbe32
15591 @opindex mbe8
15592 When linking a big-endian image select between BE8 and BE32 formats.
15593 The option has no effect for little-endian images and is ignored.  The
15594 default is dependent on the selected target architecture.  For ARMv6
15595 and later architectures the default is BE8, for older architectures
15596 the default is BE32.  BE32 format has been deprecated by ARM.
15598 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15599 @opindex march
15600 This specifies the name of the target ARM architecture.  GCC uses this
15601 name to determine what kind of instructions it can emit when generating
15602 assembly code.  This option can be used in conjunction with or instead
15603 of the @option{-mcpu=} option.
15605 Permissible names are:
15606 @samp{armv4t},
15607 @samp{armv5t}, @samp{armv5te},
15608 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15609 @samp{armv6z}, @samp{armv6zk},
15610 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15611 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15612 @samp{armv7-r},
15613 @samp{armv8-r},
15614 @samp{armv6-m}, @samp{armv6s-m},
15615 @samp{armv7-m}, @samp{armv7e-m},
15616 @samp{armv8-m.base}, @samp{armv8-m.main},
15617 @samp{iwmmxt} and @samp{iwmmxt2}.
15619 Additionally, the following architectures, which lack support for the
15620 Thumb exection state, are recognized but support is deprecated:
15621 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15622 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15624 Many of the architectures support extensions.  These can be added by
15625 appending @samp{+@var{extension}} to the architecture name.  Extension
15626 options are processed in order and capabilities accumulate.  An extension
15627 will also enable any necessary base extensions
15628 upon which it depends.  For example, the @samp{+crypto} extension
15629 will always enable the @samp{+simd} extension.  The exception to the
15630 additive construction is for extensions that are prefixed with
15631 @samp{+no@dots{}}: these extensions disable the specified option and
15632 any other extensions that may depend on the presence of that
15633 extension.
15635 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15636 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15637 entirely disabled by the @samp{+nofp} option that follows it.
15639 Most extension names are generically named, but have an effect that is
15640 dependent upon the architecture to which it is applied.  For example,
15641 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15642 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15643 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15644 variant for @samp{armv8-a}.
15646 The table below lists the supported extensions for each architecture.
15647 Architectures not mentioned do not support any extensions.
15649 @table @samp
15650 @item  armv5e
15651 @itemx armv5te
15652 @itemx armv6
15653 @itemx armv6j
15654 @itemx armv6k
15655 @itemx armv6kz
15656 @itemx armv6t2
15657 @itemx armv6z
15658 @itemx armv6zk
15659 @table @samp
15660 @item +fp
15661 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15662 used as an alias for this extension.
15664 @item +nofp
15665 Disable the floating-point instructions.
15666 @end table
15668 @item armv7
15669 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15670 @table @samp
15671 @item +fp
15672 The VFPv3 floating-point instructions, with 16 double-precision
15673 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15674 for this extension.  Note that floating-point is not supported by the
15675 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15676 ARMv7-R architectures.
15678 @item +nofp
15679 Disable the floating-point instructions.
15680 @end table
15682 @item armv7-a
15683 @table @samp
15684 @item +fp
15685 The VFPv3 floating-point instructions, with 16 double-precision
15686 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15687 for this extension.
15689 @item +simd
15690 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15691 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15692 for this extension.
15694 @item +vfpv3
15695 The VFPv3 floating-point instructions, with 32 double-precision
15696 registers.
15698 @item +vfpv3-d16-fp16
15699 The VFPv3 floating-point instructions, with 16 double-precision
15700 registers and the half-precision floating-point conversion operations.
15702 @item +vfpv3-fp16
15703 The VFPv3 floating-point instructions, with 32 double-precision
15704 registers and the half-precision floating-point conversion operations.
15706 @item +vfpv4-d16
15707 The VFPv4 floating-point instructions, with 16 double-precision
15708 registers.
15710 @item +vfpv4
15711 The VFPv4 floating-point instructions, with 32 double-precision
15712 registers.
15714 @item +neon-fp16
15715 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15716 the half-precision floating-point conversion operations.
15718 @item +neon-vfpv4
15719 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15721 @item +nosimd
15722 Disable the Advanced SIMD instructions (does not disable floating point).
15724 @item +nofp
15725 Disable the floating-point and Advanced SIMD instructions.
15726 @end table
15728 @item armv7ve
15729 The extended version of the ARMv7-A architecture with support for
15730 virtualization.
15731 @table @samp
15732 @item +fp
15733 The VFPv4 floating-point instructions, with 16 double-precision registers.
15734 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15736 @item +simd
15737 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15738 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15740 @item +vfpv3-d16
15741 The VFPv3 floating-point instructions, with 16 double-precision
15742 registers.
15744 @item +vfpv3
15745 The VFPv3 floating-point instructions, with 32 double-precision
15746 registers.
15748 @item +vfpv3-d16-fp16
15749 The VFPv3 floating-point instructions, with 16 double-precision
15750 registers and the half-precision floating-point conversion operations.
15752 @item +vfpv3-fp16
15753 The VFPv3 floating-point instructions, with 32 double-precision
15754 registers and the half-precision floating-point conversion operations.
15756 @item +vfpv4-d16
15757 The VFPv4 floating-point instructions, with 16 double-precision
15758 registers.
15760 @item +vfpv4
15761 The VFPv4 floating-point instructions, with 32 double-precision
15762 registers.
15764 @item +neon
15765 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15766 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15768 @item +neon-fp16
15769 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15770 the half-precision floating-point conversion operations.
15772 @item +nosimd
15773 Disable the Advanced SIMD instructions (does not disable floating point).
15775 @item +nofp
15776 Disable the floating-point and Advanced SIMD instructions.
15777 @end table
15779 @item armv8-a
15780 @table @samp
15781 @item +crc
15782 The Cyclic Redundancy Check (CRC) instructions.
15783 @item +simd
15784 The ARMv8-A Advanced SIMD and floating-point instructions.
15785 @item +crypto
15786 The cryptographic instructions.
15787 @item +nocrypto
15788 Disable the cryptographic isntructions.
15789 @item +nofp
15790 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15791 @end table
15793 @item armv8.1-a
15794 @table @samp
15795 @item +simd
15796 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15798 @item +crypto
15799 The cryptographic instructions.  This also enables the Advanced SIMD and
15800 floating-point instructions.
15802 @item +nocrypto
15803 Disable the cryptographic isntructions.
15805 @item +nofp
15806 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15807 @end table
15809 @item armv8.2-a
15810 @table @samp
15811 @item +fp16
15812 The half-precision floating-point data processing instructions.
15813 This also enables the Advanced SIMD and floating-point instructions.
15815 @item +simd
15816 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15818 @item +crypto
15819 The cryptographic instructions.  This also enables the Advanced SIMD and
15820 floating-point instructions.
15822 @item +dotprod
15823 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15825 @item +nocrypto
15826 Disable the cryptographic extension.
15828 @item +nofp
15829 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15830 @end table
15832 @item armv7-r
15833 @table @samp
15834 @item +fp.sp
15835 The single-precision VFPv3 floating-point instructions.  The extension
15836 @samp{+vfpv3xd} can be used as an alias for this extension.
15838 @item +fp
15839 The VFPv3 floating-point instructions with 16 double-precision registers.
15840 The extension +vfpv3-d16 can be used as an alias for this extension.
15842 @item +nofp
15843 Disable the floating-point extension.
15845 @item +idiv
15846 The ARM-state integer division instructions.
15848 @item +noidiv
15849 Disable the ARM-state integer division extension.
15850 @end table
15852 @item armv7e-m
15853 @table @samp
15854 @item +fp
15855 The single-precision VFPv4 floating-point instructions.
15857 @item +fpv5
15858 The single-precision FPv5 floating-point instructions.
15860 @item +fp.dp
15861 The single- and double-precision FPv5 floating-point instructions.
15863 @item +nofp
15864 Disable the floating-point extensions.
15865 @end table
15867 @item  armv8-m.main
15868 @table @samp
15869 @item +dsp
15870 The DSP instructions.
15872 @item +nodsp
15873 Disable the DSP extension.
15875 @item +fp
15876 The single-precision floating-point instructions.
15878 @item +fp.dp
15879 The single- and double-precision floating-point instructions.
15881 @item +nofp
15882 Disable the floating-point extension.
15883 @end table
15885 @item armv8-r
15886 @table @samp
15887 @item +crc
15888 The Cyclic Redundancy Check (CRC) instructions.
15889 @item +fp.sp
15890 The single-precision FPv5 floating-point instructions.
15891 @item +simd
15892 The ARMv8-A Advanced SIMD and floating-point instructions.
15893 @item +crypto
15894 The cryptographic instructions.
15895 @item +nocrypto
15896 Disable the cryptographic isntructions.
15897 @item +nofp
15898 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15899 @end table
15901 @end table
15903 @option{-march=native} causes the compiler to auto-detect the architecture
15904 of the build computer.  At present, this feature is only supported on
15905 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15906 is unsuccessful the option has no effect.
15908 @item -mtune=@var{name}
15909 @opindex mtune
15910 This option specifies the name of the target ARM processor for
15911 which GCC should tune the performance of the code.
15912 For some ARM implementations better performance can be obtained by using
15913 this option.
15914 Permissible names are: @samp{arm2}, @samp{arm250},
15915 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15916 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15917 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15918 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15919 @samp{arm720},
15920 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15921 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15922 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15923 @samp{strongarm1110},
15924 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15925 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15926 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15927 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15928 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15929 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15930 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15931 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15932 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15933 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15934 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15935 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15936 @samp{cortex-r8}, @samp{cortex-r52},
15937 @samp{cortex-m33},
15938 @samp{cortex-m23},
15939 @samp{cortex-m7},
15940 @samp{cortex-m4},
15941 @samp{cortex-m3},
15942 @samp{cortex-m1},
15943 @samp{cortex-m0},
15944 @samp{cortex-m0plus},
15945 @samp{cortex-m1.small-multiply},
15946 @samp{cortex-m0.small-multiply},
15947 @samp{cortex-m0plus.small-multiply},
15948 @samp{exynos-m1},
15949 @samp{marvell-pj4},
15950 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15951 @samp{fa526}, @samp{fa626},
15952 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15953 @samp{xgene1}.
15955 Additionally, this option can specify that GCC should tune the performance
15956 of the code for a big.LITTLE system.  Permissible names are:
15957 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15958 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15959 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15960 @samp{cortex-a75.cortex-a55}.
15962 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15963 performance for a blend of processors within architecture @var{arch}.
15964 The aim is to generate code that run well on the current most popular
15965 processors, balancing between optimizations that benefit some CPUs in the
15966 range, and avoiding performance pitfalls of other CPUs.  The effects of
15967 this option may change in future GCC versions as CPU models come and go.
15969 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15970 the extension options do not affect the tuning of the generated code.
15972 @option{-mtune=native} causes the compiler to auto-detect the CPU
15973 of the build computer.  At present, this feature is only supported on
15974 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15975 unsuccessful the option has no effect.
15977 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15978 @opindex mcpu
15979 This specifies the name of the target ARM processor.  GCC uses this name
15980 to derive the name of the target ARM architecture (as if specified
15981 by @option{-march}) and the ARM processor type for which to tune for
15982 performance (as if specified by @option{-mtune}).  Where this option
15983 is used in conjunction with @option{-march} or @option{-mtune},
15984 those options take precedence over the appropriate part of this option.
15986 Many of the supported CPUs implement optional architectural
15987 extensions.  Where this is so the architectural extensions are
15988 normally enabled by default.  If implementations that lack the
15989 extension exist, then the extension syntax can be used to disable
15990 those extensions that have been omitted.  For floating-point and
15991 Advanced SIMD (Neon) instructions, the settings of the options
15992 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15993 floating-point and Advanced SIMD instructions will only be used if
15994 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15995 @option{-mfpu} other than @samp{auto} will override the available
15996 floating-point and SIMD extension instructions.
15998 For example, @samp{cortex-a9} can be found in three major
15999 configurations: integer only, with just a floating-point unit or with
16000 floating-point and Advanced SIMD.  The default is to enable all the
16001 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16002 be used to disable just the SIMD or both the SIMD and floating-point
16003 instructions respectively.
16005 Permissible names for this option are the same as those for
16006 @option{-mtune}.
16008 The following extension options are common to the listed CPUs:
16010 @table @samp
16011 @item +nodsp
16012 Disable the DSP instructions on @samp{cortex-m33}.
16014 @item  +nofp
16015 Disables the floating-point instructions on @samp{arm9e},
16016 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16017 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16018 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16019 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16020 Disables the floating-point and SIMD instructions on
16021 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16022 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16023 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16024 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16025 @samp{cortex-a53} and @samp{cortex-a55}.
16027 @item +nofp.dp
16028 Disables the double-precision component of the floating-point instructions
16029 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16031 @item +nosimd
16032 Disables the SIMD (but not floating-point) instructions on
16033 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16034 and @samp{cortex-a9}.
16036 @item +crypto
16037 Enables the cryptographic instructions on @samp{cortex-a32},
16038 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16039 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16040 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16041 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16042 @samp{cortex-a75.cortex-a55}.
16043 @end table
16045 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16046 VFPv3 with 16 double-precision registers.  It supports the following
16047 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16048 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16049 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16050 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16051 @option{-march=armv7-a}.
16053 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16054 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16055 See @option{-mtune} for more information.
16057 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16058 of the build computer.  At present, this feature is only supported on
16059 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16060 is unsuccessful the option has no effect.
16062 @item -mfpu=@var{name}
16063 @opindex mfpu
16064 This specifies what floating-point hardware (or hardware emulation) is
16065 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16066 @samp{vfpv3},
16067 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16068 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16069 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16070 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16071 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16072 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16073 is an alias for @samp{vfpv2}.
16075 The setting @samp{auto} is the default and is special.  It causes the
16076 compiler to select the floating-point and Advanced SIMD instructions
16077 based on the settings of @option{-mcpu} and @option{-march}.
16079 If the selected floating-point hardware includes the NEON extension
16080 (e.g. @option{-mfpu=neon}), note that floating-point
16081 operations are not generated by GCC's auto-vectorization pass unless
16082 @option{-funsafe-math-optimizations} is also specified.  This is
16083 because NEON hardware does not fully implement the IEEE 754 standard for
16084 floating-point arithmetic (in particular denormal values are treated as
16085 zero), so the use of NEON instructions may lead to a loss of precision.
16087 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}).
16089 @item -mfp16-format=@var{name}
16090 @opindex mfp16-format
16091 Specify the format of the @code{__fp16} half-precision floating-point type.
16092 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16093 the default is @samp{none}, in which case the @code{__fp16} type is not
16094 defined.  @xref{Half-Precision}, for more information.
16096 @item -mstructure-size-boundary=@var{n}
16097 @opindex mstructure-size-boundary
16098 The sizes of all structures and unions are rounded up to a multiple
16099 of the number of bits set by this option.  Permissible values are 8, 32
16100 and 64.  The default value varies for different toolchains.  For the COFF
16101 targeted toolchain the default value is 8.  A value of 64 is only allowed
16102 if the underlying ABI supports it.
16104 Specifying a larger number can produce faster, more efficient code, but
16105 can also increase the size of the program.  Different values are potentially
16106 incompatible.  Code compiled with one value cannot necessarily expect to
16107 work with code or libraries compiled with another value, if they exchange
16108 information using structures or unions.
16110 This option is deprecated.
16112 @item -mabort-on-noreturn
16113 @opindex mabort-on-noreturn
16114 Generate a call to the function @code{abort} at the end of a
16115 @code{noreturn} function.  It is executed if the function tries to
16116 return.
16118 @item -mlong-calls
16119 @itemx -mno-long-calls
16120 @opindex mlong-calls
16121 @opindex mno-long-calls
16122 Tells the compiler to perform function calls by first loading the
16123 address of the function into a register and then performing a subroutine
16124 call on this register.  This switch is needed if the target function
16125 lies outside of the 64-megabyte addressing range of the offset-based
16126 version of subroutine call instruction.
16128 Even if this switch is enabled, not all function calls are turned
16129 into long calls.  The heuristic is that static functions, functions
16130 that have the @code{short_call} attribute, functions that are inside
16131 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16132 definitions have already been compiled within the current compilation
16133 unit are not turned into long calls.  The exceptions to this rule are
16134 that weak function definitions, functions with the @code{long_call}
16135 attribute or the @code{section} attribute, and functions that are within
16136 the scope of a @code{#pragma long_calls} directive are always
16137 turned into long calls.
16139 This feature is not enabled by default.  Specifying
16140 @option{-mno-long-calls} restores the default behavior, as does
16141 placing the function calls within the scope of a @code{#pragma
16142 long_calls_off} directive.  Note these switches have no effect on how
16143 the compiler generates code to handle function calls via function
16144 pointers.
16146 @item -msingle-pic-base
16147 @opindex msingle-pic-base
16148 Treat the register used for PIC addressing as read-only, rather than
16149 loading it in the prologue for each function.  The runtime system is
16150 responsible for initializing this register with an appropriate value
16151 before execution begins.
16153 @item -mpic-register=@var{reg}
16154 @opindex mpic-register
16155 Specify the register to be used for PIC addressing.
16156 For standard PIC base case, the default is any suitable register
16157 determined by compiler.  For single PIC base case, the default is
16158 @samp{R9} if target is EABI based or stack-checking is enabled,
16159 otherwise the default is @samp{R10}.
16161 @item -mpic-data-is-text-relative
16162 @opindex mpic-data-is-text-relative
16163 Assume that the displacement between the text and data segments is fixed
16164 at static link time.  This permits using PC-relative addressing
16165 operations to access data known to be in the data segment.  For
16166 non-VxWorks RTP targets, this option is enabled by default.  When
16167 disabled on such targets, it will enable @option{-msingle-pic-base} by
16168 default.
16170 @item -mpoke-function-name
16171 @opindex mpoke-function-name
16172 Write the name of each function into the text section, directly
16173 preceding the function prologue.  The generated code is similar to this:
16175 @smallexample
16176      t0
16177          .ascii "arm_poke_function_name", 0
16178          .align
16179      t1
16180          .word 0xff000000 + (t1 - t0)
16181      arm_poke_function_name
16182          mov     ip, sp
16183          stmfd   sp!, @{fp, ip, lr, pc@}
16184          sub     fp, ip, #4
16185 @end smallexample
16187 When performing a stack backtrace, code can inspect the value of
16188 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16189 location @code{pc - 12} and the top 8 bits are set, then we know that
16190 there is a function name embedded immediately preceding this location
16191 and has length @code{((pc[-3]) & 0xff000000)}.
16193 @item -mthumb
16194 @itemx -marm
16195 @opindex marm
16196 @opindex mthumb
16198 Select between generating code that executes in ARM and Thumb
16199 states.  The default for most configurations is to generate code
16200 that executes in ARM state, but the default can be changed by
16201 configuring GCC with the @option{--with-mode=}@var{state}
16202 configure option.
16204 You can also override the ARM and Thumb mode for each function
16205 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16206 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16208 @item -mtpcs-frame
16209 @opindex mtpcs-frame
16210 Generate a stack frame that is compliant with the Thumb Procedure Call
16211 Standard for all non-leaf functions.  (A leaf function is one that does
16212 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16214 @item -mtpcs-leaf-frame
16215 @opindex mtpcs-leaf-frame
16216 Generate a stack frame that is compliant with the Thumb Procedure Call
16217 Standard for all leaf functions.  (A leaf function is one that does
16218 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16220 @item -mcallee-super-interworking
16221 @opindex mcallee-super-interworking
16222 Gives all externally visible functions in the file being compiled an ARM
16223 instruction set header which switches to Thumb mode before executing the
16224 rest of the function.  This allows these functions to be called from
16225 non-interworking code.  This option is not valid in AAPCS configurations
16226 because interworking is enabled by default.
16228 @item -mcaller-super-interworking
16229 @opindex mcaller-super-interworking
16230 Allows calls via function pointers (including virtual functions) to
16231 execute correctly regardless of whether the target code has been
16232 compiled for interworking or not.  There is a small overhead in the cost
16233 of executing a function pointer if this option is enabled.  This option
16234 is not valid in AAPCS configurations because interworking is enabled
16235 by default.
16237 @item -mtp=@var{name}
16238 @opindex mtp
16239 Specify the access model for the thread local storage pointer.  The valid
16240 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16241 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16242 (supported in the arm6k architecture), and @samp{auto}, which uses the
16243 best available method for the selected processor.  The default setting is
16244 @samp{auto}.
16246 @item -mtls-dialect=@var{dialect}
16247 @opindex mtls-dialect
16248 Specify the dialect to use for accessing thread local storage.  Two
16249 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16250 @samp{gnu} dialect selects the original GNU scheme for supporting
16251 local and global dynamic TLS models.  The @samp{gnu2} dialect
16252 selects the GNU descriptor scheme, which provides better performance
16253 for shared libraries.  The GNU descriptor scheme is compatible with
16254 the original scheme, but does require new assembler, linker and
16255 library support.  Initial and local exec TLS models are unaffected by
16256 this option and always use the original scheme.
16258 @item -mword-relocations
16259 @opindex mword-relocations
16260 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16261 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16262 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16263 is specified.
16265 @item -mfix-cortex-m3-ldrd
16266 @opindex mfix-cortex-m3-ldrd
16267 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16268 with overlapping destination and base registers are used.  This option avoids
16269 generating these instructions.  This option is enabled by default when
16270 @option{-mcpu=cortex-m3} is specified.
16272 @item -munaligned-access
16273 @itemx -mno-unaligned-access
16274 @opindex munaligned-access
16275 @opindex mno-unaligned-access
16276 Enables (or disables) reading and writing of 16- and 32- bit values
16277 from addresses that are not 16- or 32- bit aligned.  By default
16278 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16279 ARMv8-M Baseline architectures, and enabled for all other
16280 architectures.  If unaligned access is not enabled then words in packed
16281 data structures are accessed a byte at a time.
16283 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16284 generated object file to either true or false, depending upon the
16285 setting of this option.  If unaligned access is enabled then the
16286 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16287 defined.
16289 @item -mneon-for-64bits
16290 @opindex mneon-for-64bits
16291 Enables using Neon to handle scalar 64-bits operations. This is
16292 disabled by default since the cost of moving data from core registers
16293 to Neon is high.
16295 @item -mslow-flash-data
16296 @opindex mslow-flash-data
16297 Assume loading data from flash is slower than fetching instruction.
16298 Therefore literal load is minimized for better performance.
16299 This option is only supported when compiling for ARMv7 M-profile and
16300 off by default.
16302 @item -masm-syntax-unified
16303 @opindex masm-syntax-unified
16304 Assume inline assembler is using unified asm syntax.  The default is
16305 currently off which implies divided syntax.  This option has no impact
16306 on Thumb2. However, this may change in future releases of GCC.
16307 Divided syntax should be considered deprecated.
16309 @item -mrestrict-it
16310 @opindex mrestrict-it
16311 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16312 IT blocks can only contain a single 16-bit instruction from a select
16313 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16315 @item -mprint-tune-info
16316 @opindex mprint-tune-info
16317 Print CPU tuning information as comment in assembler file.  This is
16318 an option used only for regression testing of the compiler and not
16319 intended for ordinary use in compiling code.  This option is disabled
16320 by default.
16322 @item -mpure-code
16323 @opindex mpure-code
16324 Do not allow constant data to be placed in code sections.
16325 Additionally, when compiling for ELF object format give all text sections the
16326 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16327 is only available when generating non-pic code for M-profile targets with the
16328 MOVT instruction.
16330 @item -mcmse
16331 @opindex mcmse
16332 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16333 Development Tools Engineering Specification", which can be found on
16334 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16335 @end table
16337 @node AVR Options
16338 @subsection AVR Options
16339 @cindex AVR Options
16341 These options are defined for AVR implementations:
16343 @table @gcctabopt
16344 @item -mmcu=@var{mcu}
16345 @opindex mmcu
16346 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16348 The default for this option is@tie{}@samp{avr2}.
16350 GCC supports the following AVR devices and ISAs:
16352 @include avr-mmcu.texi
16354 @item -mabsdata
16355 @opindex mabsdata
16357 Assume that all data in static storage can be accessed by LDS / STS
16358 instructions.  This option has only an effect on reduced Tiny devices like
16359 ATtiny40.  See also the @code{absdata}
16360 @ref{AVR Variable Attributes,variable attribute}.
16362 @item -maccumulate-args
16363 @opindex maccumulate-args
16364 Accumulate outgoing function arguments and acquire/release the needed
16365 stack space for outgoing function arguments once in function
16366 prologue/epilogue.  Without this option, outgoing arguments are pushed
16367 before calling a function and popped afterwards.
16369 Popping the arguments after the function call can be expensive on
16370 AVR so that accumulating the stack space might lead to smaller
16371 executables because arguments need not be removed from the
16372 stack after such a function call.
16374 This option can lead to reduced code size for functions that perform
16375 several calls to functions that get their arguments on the stack like
16376 calls to printf-like functions.
16378 @item -mbranch-cost=@var{cost}
16379 @opindex mbranch-cost
16380 Set the branch costs for conditional branch instructions to
16381 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16382 integers. The default branch cost is 0.
16384 @item -mcall-prologues
16385 @opindex mcall-prologues
16386 Functions prologues/epilogues are expanded as calls to appropriate
16387 subroutines.  Code size is smaller.
16389 @item -mgas-isr-prologues
16390 @opindex mgas-isr-prologues
16391 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16392 instruction supported by GNU Binutils.
16393 If this option is on, the feature can still be disabled for individual
16394 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16395 function attribute.  This feature is activated per default
16396 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16397 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16399 @item -mint8
16400 @opindex mint8
16401 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16402 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16403 and @code{long long} is 4 bytes.  Please note that this option does not
16404 conform to the C standards, but it results in smaller code
16405 size.
16407 @item -mn-flash=@var{num}
16408 @opindex mn-flash
16409 Assume that the flash memory has a size of 
16410 @var{num} times 64@tie{}KiB.
16412 @item -mno-interrupts
16413 @opindex mno-interrupts
16414 Generated code is not compatible with hardware interrupts.
16415 Code size is smaller.
16417 @item -mrelax
16418 @opindex mrelax
16419 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16420 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16421 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16422 the assembler's command line and the @option{--relax} option to the
16423 linker's command line.
16425 Jump relaxing is performed by the linker because jump offsets are not
16426 known before code is located. Therefore, the assembler code generated by the
16427 compiler is the same, but the instructions in the executable may
16428 differ from instructions in the assembler code.
16430 Relaxing must be turned on if linker stubs are needed, see the
16431 section on @code{EIND} and linker stubs below.
16433 @item -mrmw
16434 @opindex mrmw
16435 Assume that the device supports the Read-Modify-Write
16436 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16438 @item -mshort-calls
16439 @opindex mshort-calls
16441 Assume that @code{RJMP} and @code{RCALL} can target the whole
16442 program memory.
16444 This option is used internally for multilib selection.  It is
16445 not an optimization option, and you don't need to set it by hand.
16447 @item -msp8
16448 @opindex msp8
16449 Treat the stack pointer register as an 8-bit register,
16450 i.e.@: assume the high byte of the stack pointer is zero.
16451 In general, you don't need to set this option by hand.
16453 This option is used internally by the compiler to select and
16454 build multilibs for architectures @code{avr2} and @code{avr25}.
16455 These architectures mix devices with and without @code{SPH}.
16456 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16457 the compiler driver adds or removes this option from the compiler
16458 proper's command line, because the compiler then knows if the device
16459 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16460 register or not.
16462 @item -mstrict-X
16463 @opindex mstrict-X
16464 Use address register @code{X} in a way proposed by the hardware.  This means
16465 that @code{X} is only used in indirect, post-increment or
16466 pre-decrement addressing.
16468 Without this option, the @code{X} register may be used in the same way
16469 as @code{Y} or @code{Z} which then is emulated by additional
16470 instructions.  
16471 For example, loading a value with @code{X+const} addressing with a
16472 small non-negative @code{const < 64} to a register @var{Rn} is
16473 performed as
16475 @example
16476 adiw r26, const   ; X += const
16477 ld   @var{Rn}, X        ; @var{Rn} = *X
16478 sbiw r26, const   ; X -= const
16479 @end example
16481 @item -mtiny-stack
16482 @opindex mtiny-stack
16483 Only change the lower 8@tie{}bits of the stack pointer.
16485 @item -mfract-convert-truncate
16486 @opindex mfract-convert-truncate
16487 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16489 @item -nodevicelib
16490 @opindex nodevicelib
16491 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16493 @item -Waddr-space-convert
16494 @opindex Waddr-space-convert
16495 Warn about conversions between address spaces in the case where the
16496 resulting address space is not contained in the incoming address space.
16498 @item -Wmisspelled-isr
16499 @opindex Wmisspelled-isr
16500 Warn if the ISR is misspelled, i.e. without __vector prefix.
16501 Enabled by default.
16502 @end table
16504 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16505 @cindex @code{EIND}
16506 Pointers in the implementation are 16@tie{}bits wide.
16507 The address of a function or label is represented as word address so
16508 that indirect jumps and calls can target any code address in the
16509 range of 64@tie{}Ki words.
16511 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16512 bytes of program memory space, there is a special function register called
16513 @code{EIND} that serves as most significant part of the target address
16514 when @code{EICALL} or @code{EIJMP} instructions are used.
16516 Indirect jumps and calls on these devices are handled as follows by
16517 the compiler and are subject to some limitations:
16519 @itemize @bullet
16521 @item
16522 The compiler never sets @code{EIND}.
16524 @item
16525 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16526 instructions or might read @code{EIND} directly in order to emulate an
16527 indirect call/jump by means of a @code{RET} instruction.
16529 @item
16530 The compiler assumes that @code{EIND} never changes during the startup
16531 code or during the application. In particular, @code{EIND} is not
16532 saved/restored in function or interrupt service routine
16533 prologue/epilogue.
16535 @item
16536 For indirect calls to functions and computed goto, the linker
16537 generates @emph{stubs}. Stubs are jump pads sometimes also called
16538 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16539 The stub contains a direct jump to the desired address.
16541 @item
16542 Linker relaxation must be turned on so that the linker generates
16543 the stubs correctly in all situations. See the compiler option
16544 @option{-mrelax} and the linker option @option{--relax}.
16545 There are corner cases where the linker is supposed to generate stubs
16546 but aborts without relaxation and without a helpful error message.
16548 @item
16549 The default linker script is arranged for code with @code{EIND = 0}.
16550 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16551 linker script has to be used in order to place the sections whose
16552 name start with @code{.trampolines} into the segment where @code{EIND}
16553 points to.
16555 @item
16556 The startup code from libgcc never sets @code{EIND}.
16557 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16558 For the impact of AVR-LibC on @code{EIND}, see the
16559 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16561 @item
16562 It is legitimate for user-specific startup code to set up @code{EIND}
16563 early, for example by means of initialization code located in
16564 section @code{.init3}. Such code runs prior to general startup code
16565 that initializes RAM and calls constructors, but after the bit
16566 of startup code from AVR-LibC that sets @code{EIND} to the segment
16567 where the vector table is located.
16568 @example
16569 #include <avr/io.h>
16571 static void
16572 __attribute__((section(".init3"),naked,used,no_instrument_function))
16573 init3_set_eind (void)
16575   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16576                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16578 @end example
16580 @noindent
16581 The @code{__trampolines_start} symbol is defined in the linker script.
16583 @item
16584 Stubs are generated automatically by the linker if
16585 the following two conditions are met:
16586 @itemize @minus
16588 @item The address of a label is taken by means of the @code{gs} modifier
16589 (short for @emph{generate stubs}) like so:
16590 @example
16591 LDI r24, lo8(gs(@var{func}))
16592 LDI r25, hi8(gs(@var{func}))
16593 @end example
16594 @item The final location of that label is in a code segment
16595 @emph{outside} the segment where the stubs are located.
16596 @end itemize
16598 @item
16599 The compiler emits such @code{gs} modifiers for code labels in the
16600 following situations:
16601 @itemize @minus
16602 @item Taking address of a function or code label.
16603 @item Computed goto.
16604 @item If prologue-save function is used, see @option{-mcall-prologues}
16605 command-line option.
16606 @item Switch/case dispatch tables. If you do not want such dispatch
16607 tables you can specify the @option{-fno-jump-tables} command-line option.
16608 @item C and C++ constructors/destructors called during startup/shutdown.
16609 @item If the tools hit a @code{gs()} modifier explained above.
16610 @end itemize
16612 @item
16613 Jumping to non-symbolic addresses like so is @emph{not} supported:
16615 @example
16616 int main (void)
16618     /* Call function at word address 0x2 */
16619     return ((int(*)(void)) 0x2)();
16621 @end example
16623 Instead, a stub has to be set up, i.e.@: the function has to be called
16624 through a symbol (@code{func_4} in the example):
16626 @example
16627 int main (void)
16629     extern int func_4 (void);
16631     /* Call function at byte address 0x4 */
16632     return func_4();
16634 @end example
16636 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16637 Alternatively, @code{func_4} can be defined in the linker script.
16638 @end itemize
16640 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16641 @cindex @code{RAMPD}
16642 @cindex @code{RAMPX}
16643 @cindex @code{RAMPY}
16644 @cindex @code{RAMPZ}
16645 Some AVR devices support memories larger than the 64@tie{}KiB range
16646 that can be accessed with 16-bit pointers.  To access memory locations
16647 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16648 register is used as high part of the address:
16649 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16650 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16651 register, respectively, to get a wide address. Similarly,
16652 @code{RAMPD} is used together with direct addressing.
16654 @itemize
16655 @item
16656 The startup code initializes the @code{RAMP} special function
16657 registers with zero.
16659 @item
16660 If a @ref{AVR Named Address Spaces,named address space} other than
16661 generic or @code{__flash} is used, then @code{RAMPZ} is set
16662 as needed before the operation.
16664 @item
16665 If the device supports RAM larger than 64@tie{}KiB and the compiler
16666 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16667 is reset to zero after the operation.
16669 @item
16670 If the device comes with a specific @code{RAMP} register, the ISR
16671 prologue/epilogue saves/restores that SFR and initializes it with
16672 zero in case the ISR code might (implicitly) use it.
16674 @item
16675 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16676 If you use inline assembler to read from locations outside the
16677 16-bit address range and change one of the @code{RAMP} registers,
16678 you must reset it to zero after the access.
16680 @end itemize
16682 @subsubsection AVR Built-in Macros
16684 GCC defines several built-in macros so that the user code can test
16685 for the presence or absence of features.  Almost any of the following
16686 built-in macros are deduced from device capabilities and thus
16687 triggered by the @option{-mmcu=} command-line option.
16689 For even more AVR-specific built-in macros see
16690 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16692 @table @code
16694 @item __AVR_ARCH__
16695 Build-in macro that resolves to a decimal number that identifies the
16696 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16697 Possible values are:
16699 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16700 @code{4}, @code{5}, @code{51}, @code{6}
16702 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16703 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16705 respectively and
16707 @code{100},
16708 @code{102}, @code{103}, @code{104},
16709 @code{105}, @code{106}, @code{107}
16711 for @var{mcu}=@code{avrtiny},
16712 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16713 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16714 If @var{mcu} specifies a device, this built-in macro is set
16715 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16716 defined to @code{4}.
16718 @item __AVR_@var{Device}__
16719 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16720 the device's name. For example, @option{-mmcu=atmega8} defines the
16721 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16722 @code{__AVR_ATtiny261A__}, etc.
16724 The built-in macros' names follow
16725 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16726 the device name as from the AVR user manual. The difference between
16727 @var{Device} in the built-in macro and @var{device} in
16728 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16730 If @var{device} is not a device but only a core architecture like
16731 @samp{avr51}, this macro is not defined.
16733 @item __AVR_DEVICE_NAME__
16734 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16735 the device's name. For example, with @option{-mmcu=atmega8} the macro
16736 is defined to @code{atmega8}.
16738 If @var{device} is not a device but only a core architecture like
16739 @samp{avr51}, this macro is not defined.
16741 @item __AVR_XMEGA__
16742 The device / architecture belongs to the XMEGA family of devices.
16744 @item __AVR_HAVE_ELPM__
16745 The device has the @code{ELPM} instruction.
16747 @item __AVR_HAVE_ELPMX__
16748 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16749 R@var{n},Z+} instructions.
16751 @item __AVR_HAVE_MOVW__
16752 The device has the @code{MOVW} instruction to perform 16-bit
16753 register-register moves.
16755 @item __AVR_HAVE_LPMX__
16756 The device has the @code{LPM R@var{n},Z} and
16757 @code{LPM R@var{n},Z+} instructions.
16759 @item __AVR_HAVE_MUL__
16760 The device has a hardware multiplier. 
16762 @item __AVR_HAVE_JMP_CALL__
16763 The device has the @code{JMP} and @code{CALL} instructions.
16764 This is the case for devices with more than 8@tie{}KiB of program
16765 memory.
16767 @item __AVR_HAVE_EIJMP_EICALL__
16768 @itemx __AVR_3_BYTE_PC__
16769 The device has the @code{EIJMP} and @code{EICALL} instructions.
16770 This is the case for devices with more than 128@tie{}KiB of program memory.
16771 This also means that the program counter
16772 (PC) is 3@tie{}bytes wide.
16774 @item __AVR_2_BYTE_PC__
16775 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16776 with up to 128@tie{}KiB of program memory.
16778 @item __AVR_HAVE_8BIT_SP__
16779 @itemx __AVR_HAVE_16BIT_SP__
16780 The stack pointer (SP) register is treated as 8-bit respectively
16781 16-bit register by the compiler.
16782 The definition of these macros is affected by @option{-mtiny-stack}.
16784 @item __AVR_HAVE_SPH__
16785 @itemx __AVR_SP8__
16786 The device has the SPH (high part of stack pointer) special function
16787 register or has an 8-bit stack pointer, respectively.
16788 The definition of these macros is affected by @option{-mmcu=} and
16789 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16790 by @option{-msp8}.
16792 @item __AVR_HAVE_RAMPD__
16793 @itemx __AVR_HAVE_RAMPX__
16794 @itemx __AVR_HAVE_RAMPY__
16795 @itemx __AVR_HAVE_RAMPZ__
16796 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16797 @code{RAMPZ} special function register, respectively.
16799 @item __NO_INTERRUPTS__
16800 This macro reflects the @option{-mno-interrupts} command-line option.
16802 @item __AVR_ERRATA_SKIP__
16803 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16804 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16805 instructions because of a hardware erratum.  Skip instructions are
16806 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16807 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16808 set.
16810 @item __AVR_ISA_RMW__
16811 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16813 @item __AVR_SFR_OFFSET__=@var{offset}
16814 Instructions that can address I/O special function registers directly
16815 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16816 address as if addressed by an instruction to access RAM like @code{LD}
16817 or @code{STS}. This offset depends on the device architecture and has
16818 to be subtracted from the RAM address in order to get the
16819 respective I/O@tie{}address.
16821 @item __AVR_SHORT_CALLS__
16822 The @option{-mshort-calls} command line option is set.
16824 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16825 Some devices support reading from flash memory by means of @code{LD*}
16826 instructions.  The flash memory is seen in the data address space
16827 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16828 is not defined, this feature is not available.  If defined,
16829 the address space is linear and there is no need to put
16830 @code{.rodata} into RAM.  This is handled by the default linker
16831 description file, and is currently available for
16832 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16833 there is no need to use address spaces like @code{__flash} or
16834 features like attribute @code{progmem} and @code{pgm_read_*}.
16836 @item __WITH_AVRLIBC__
16837 The compiler is configured to be used together with AVR-Libc.
16838 See the @option{--with-avrlibc} configure option.
16840 @end table
16842 @node Blackfin Options
16843 @subsection Blackfin Options
16844 @cindex Blackfin Options
16846 @table @gcctabopt
16847 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16848 @opindex mcpu=
16849 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16850 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16851 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16852 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16853 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16854 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16855 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16856 @samp{bf561}, @samp{bf592}.
16858 The optional @var{sirevision} specifies the silicon revision of the target
16859 Blackfin processor.  Any workarounds available for the targeted silicon revision
16860 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16861 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16862 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16863 hexadecimal digits representing the major and minor numbers in the silicon
16864 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16865 is not defined.  If @var{sirevision} is @samp{any}, the
16866 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16867 If this optional @var{sirevision} is not used, GCC assumes the latest known
16868 silicon revision of the targeted Blackfin processor.
16870 GCC defines a preprocessor macro for the specified @var{cpu}.
16871 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16872 provided by libgloss to be linked in if @option{-msim} is not given.
16874 Without this option, @samp{bf532} is used as the processor by default.
16876 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16877 only the preprocessor macro is defined.
16879 @item -msim
16880 @opindex msim
16881 Specifies that the program will be run on the simulator.  This causes
16882 the simulator BSP provided by libgloss to be linked in.  This option
16883 has effect only for @samp{bfin-elf} toolchain.
16884 Certain other options, such as @option{-mid-shared-library} and
16885 @option{-mfdpic}, imply @option{-msim}.
16887 @item -momit-leaf-frame-pointer
16888 @opindex momit-leaf-frame-pointer
16889 Don't keep the frame pointer in a register for leaf functions.  This
16890 avoids the instructions to save, set up and restore frame pointers and
16891 makes an extra register available in leaf functions.
16893 @item -mspecld-anomaly
16894 @opindex mspecld-anomaly
16895 When enabled, the compiler ensures that the generated code does not
16896 contain speculative loads after jump instructions. If this option is used,
16897 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16899 @item -mno-specld-anomaly
16900 @opindex mno-specld-anomaly
16901 Don't generate extra code to prevent speculative loads from occurring.
16903 @item -mcsync-anomaly
16904 @opindex mcsync-anomaly
16905 When enabled, the compiler ensures that the generated code does not
16906 contain CSYNC or SSYNC instructions too soon after conditional branches.
16907 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16909 @item -mno-csync-anomaly
16910 @opindex mno-csync-anomaly
16911 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16912 occurring too soon after a conditional branch.
16914 @item -mlow-64k
16915 @opindex mlow-64k
16916 When enabled, the compiler is free to take advantage of the knowledge that
16917 the entire program fits into the low 64k of memory.
16919 @item -mno-low-64k
16920 @opindex mno-low-64k
16921 Assume that the program is arbitrarily large.  This is the default.
16923 @item -mstack-check-l1
16924 @opindex mstack-check-l1
16925 Do stack checking using information placed into L1 scratchpad memory by the
16926 uClinux kernel.
16928 @item -mid-shared-library
16929 @opindex mid-shared-library
16930 Generate code that supports shared libraries via the library ID method.
16931 This allows for execute in place and shared libraries in an environment
16932 without virtual memory management.  This option implies @option{-fPIC}.
16933 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16935 @item -mno-id-shared-library
16936 @opindex mno-id-shared-library
16937 Generate code that doesn't assume ID-based shared libraries are being used.
16938 This is the default.
16940 @item -mleaf-id-shared-library
16941 @opindex mleaf-id-shared-library
16942 Generate code that supports shared libraries via the library ID method,
16943 but assumes that this library or executable won't link against any other
16944 ID shared libraries.  That allows the compiler to use faster code for jumps
16945 and calls.
16947 @item -mno-leaf-id-shared-library
16948 @opindex mno-leaf-id-shared-library
16949 Do not assume that the code being compiled won't link against any ID shared
16950 libraries.  Slower code is generated for jump and call insns.
16952 @item -mshared-library-id=n
16953 @opindex mshared-library-id
16954 Specifies the identification number of the ID-based shared library being
16955 compiled.  Specifying a value of 0 generates more compact code; specifying
16956 other values forces the allocation of that number to the current
16957 library but is no more space- or time-efficient than omitting this option.
16959 @item -msep-data
16960 @opindex msep-data
16961 Generate code that allows the data segment to be located in a different
16962 area of memory from the text segment.  This allows for execute in place in
16963 an environment without virtual memory management by eliminating relocations
16964 against the text section.
16966 @item -mno-sep-data
16967 @opindex mno-sep-data
16968 Generate code that assumes that the data segment follows the text segment.
16969 This is the default.
16971 @item -mlong-calls
16972 @itemx -mno-long-calls
16973 @opindex mlong-calls
16974 @opindex mno-long-calls
16975 Tells the compiler to perform function calls by first loading the
16976 address of the function into a register and then performing a subroutine
16977 call on this register.  This switch is needed if the target function
16978 lies outside of the 24-bit addressing range of the offset-based
16979 version of subroutine call instruction.
16981 This feature is not enabled by default.  Specifying
16982 @option{-mno-long-calls} restores the default behavior.  Note these
16983 switches have no effect on how the compiler generates code to handle
16984 function calls via function pointers.
16986 @item -mfast-fp
16987 @opindex mfast-fp
16988 Link with the fast floating-point library. This library relaxes some of
16989 the IEEE floating-point standard's rules for checking inputs against
16990 Not-a-Number (NAN), in the interest of performance.
16992 @item -minline-plt
16993 @opindex minline-plt
16994 Enable inlining of PLT entries in function calls to functions that are
16995 not known to bind locally.  It has no effect without @option{-mfdpic}.
16997 @item -mmulticore
16998 @opindex mmulticore
16999 Build a standalone application for multicore Blackfin processors. 
17000 This option causes proper start files and link scripts supporting 
17001 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17002 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17004 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17005 selects the one-application-per-core programming model.  Without
17006 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17007 programming model is used. In this model, the main function of Core B
17008 should be named as @code{coreb_main}.
17010 If this option is not used, the single-core application programming
17011 model is used.
17013 @item -mcorea
17014 @opindex mcorea
17015 Build a standalone application for Core A of BF561 when using
17016 the one-application-per-core programming model. Proper start files
17017 and link scripts are used to support Core A, and the macro
17018 @code{__BFIN_COREA} is defined.
17019 This option can only be used in conjunction with @option{-mmulticore}.
17021 @item -mcoreb
17022 @opindex mcoreb
17023 Build a standalone application for Core B of BF561 when using
17024 the one-application-per-core programming model. Proper start files
17025 and link scripts are used to support Core B, and the macro
17026 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17027 should be used instead of @code{main}. 
17028 This option can only be used in conjunction with @option{-mmulticore}.
17030 @item -msdram
17031 @opindex msdram
17032 Build a standalone application for SDRAM. Proper start files and
17033 link scripts are used to put the application into SDRAM, and the macro
17034 @code{__BFIN_SDRAM} is defined.
17035 The loader should initialize SDRAM before loading the application.
17037 @item -micplb
17038 @opindex micplb
17039 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17040 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17041 are enabled; for standalone applications the default is off.
17042 @end table
17044 @node C6X Options
17045 @subsection C6X Options
17046 @cindex C6X Options
17048 @table @gcctabopt
17049 @item -march=@var{name}
17050 @opindex march
17051 This specifies the name of the target architecture.  GCC uses this
17052 name to determine what kind of instructions it can emit when generating
17053 assembly code.  Permissible names are: @samp{c62x},
17054 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17056 @item -mbig-endian
17057 @opindex mbig-endian
17058 Generate code for a big-endian target.
17060 @item -mlittle-endian
17061 @opindex mlittle-endian
17062 Generate code for a little-endian target.  This is the default.
17064 @item -msim
17065 @opindex msim
17066 Choose startup files and linker script suitable for the simulator.
17068 @item -msdata=default
17069 @opindex msdata=default
17070 Put small global and static data in the @code{.neardata} section,
17071 which is pointed to by register @code{B14}.  Put small uninitialized
17072 global and static data in the @code{.bss} section, which is adjacent
17073 to the @code{.neardata} section.  Put small read-only data into the
17074 @code{.rodata} section.  The corresponding sections used for large
17075 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17077 @item -msdata=all
17078 @opindex msdata=all
17079 Put all data, not just small objects, into the sections reserved for
17080 small data, and use addressing relative to the @code{B14} register to
17081 access them.
17083 @item -msdata=none
17084 @opindex msdata=none
17085 Make no use of the sections reserved for small data, and use absolute
17086 addresses to access all data.  Put all initialized global and static
17087 data in the @code{.fardata} section, and all uninitialized data in the
17088 @code{.far} section.  Put all constant data into the @code{.const}
17089 section.
17090 @end table
17092 @node CRIS Options
17093 @subsection CRIS Options
17094 @cindex CRIS Options
17096 These options are defined specifically for the CRIS ports.
17098 @table @gcctabopt
17099 @item -march=@var{architecture-type}
17100 @itemx -mcpu=@var{architecture-type}
17101 @opindex march
17102 @opindex mcpu
17103 Generate code for the specified architecture.  The choices for
17104 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17105 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17106 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17107 @samp{v10}.
17109 @item -mtune=@var{architecture-type}
17110 @opindex mtune
17111 Tune to @var{architecture-type} everything applicable about the generated
17112 code, except for the ABI and the set of available instructions.  The
17113 choices for @var{architecture-type} are the same as for
17114 @option{-march=@var{architecture-type}}.
17116 @item -mmax-stack-frame=@var{n}
17117 @opindex mmax-stack-frame
17118 Warn when the stack frame of a function exceeds @var{n} bytes.
17120 @item -metrax4
17121 @itemx -metrax100
17122 @opindex metrax4
17123 @opindex metrax100
17124 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17125 @option{-march=v3} and @option{-march=v8} respectively.
17127 @item -mmul-bug-workaround
17128 @itemx -mno-mul-bug-workaround
17129 @opindex mmul-bug-workaround
17130 @opindex mno-mul-bug-workaround
17131 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17132 models where it applies.  This option is active by default.
17134 @item -mpdebug
17135 @opindex mpdebug
17136 Enable CRIS-specific verbose debug-related information in the assembly
17137 code.  This option also has the effect of turning off the @samp{#NO_APP}
17138 formatted-code indicator to the assembler at the beginning of the
17139 assembly file.
17141 @item -mcc-init
17142 @opindex mcc-init
17143 Do not use condition-code results from previous instruction; always emit
17144 compare and test instructions before use of condition codes.
17146 @item -mno-side-effects
17147 @opindex mno-side-effects
17148 Do not emit instructions with side effects in addressing modes other than
17149 post-increment.
17151 @item -mstack-align
17152 @itemx -mno-stack-align
17153 @itemx -mdata-align
17154 @itemx -mno-data-align
17155 @itemx -mconst-align
17156 @itemx -mno-const-align
17157 @opindex mstack-align
17158 @opindex mno-stack-align
17159 @opindex mdata-align
17160 @opindex mno-data-align
17161 @opindex mconst-align
17162 @opindex mno-const-align
17163 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17164 stack frame, individual data and constants to be aligned for the maximum
17165 single data access size for the chosen CPU model.  The default is to
17166 arrange for 32-bit alignment.  ABI details such as structure layout are
17167 not affected by these options.
17169 @item -m32-bit
17170 @itemx -m16-bit
17171 @itemx -m8-bit
17172 @opindex m32-bit
17173 @opindex m16-bit
17174 @opindex m8-bit
17175 Similar to the stack- data- and const-align options above, these options
17176 arrange for stack frame, writable data and constants to all be 32-bit,
17177 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17179 @item -mno-prologue-epilogue
17180 @itemx -mprologue-epilogue
17181 @opindex mno-prologue-epilogue
17182 @opindex mprologue-epilogue
17183 With @option{-mno-prologue-epilogue}, the normal function prologue and
17184 epilogue which set up the stack frame are omitted and no return
17185 instructions or return sequences are generated in the code.  Use this
17186 option only together with visual inspection of the compiled code: no
17187 warnings or errors are generated when call-saved registers must be saved,
17188 or storage for local variables needs to be allocated.
17190 @item -mno-gotplt
17191 @itemx -mgotplt
17192 @opindex mno-gotplt
17193 @opindex mgotplt
17194 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17195 instruction sequences that load addresses for functions from the PLT part
17196 of the GOT rather than (traditional on other architectures) calls to the
17197 PLT@.  The default is @option{-mgotplt}.
17199 @item -melf
17200 @opindex melf
17201 Legacy no-op option only recognized with the cris-axis-elf and
17202 cris-axis-linux-gnu targets.
17204 @item -mlinux
17205 @opindex mlinux
17206 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17208 @item -sim
17209 @opindex sim
17210 This option, recognized for the cris-axis-elf, arranges
17211 to link with input-output functions from a simulator library.  Code,
17212 initialized data and zero-initialized data are allocated consecutively.
17214 @item -sim2
17215 @opindex sim2
17216 Like @option{-sim}, but pass linker options to locate initialized data at
17217 0x40000000 and zero-initialized data at 0x80000000.
17218 @end table
17220 @node CR16 Options
17221 @subsection CR16 Options
17222 @cindex CR16 Options
17224 These options are defined specifically for the CR16 ports.
17226 @table @gcctabopt
17228 @item -mmac
17229 @opindex mmac
17230 Enable the use of multiply-accumulate instructions. Disabled by default.
17232 @item -mcr16cplus
17233 @itemx -mcr16c
17234 @opindex mcr16cplus
17235 @opindex mcr16c
17236 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17237 is default.
17239 @item -msim
17240 @opindex msim
17241 Links the library libsim.a which is in compatible with simulator. Applicable
17242 to ELF compiler only.
17244 @item -mint32
17245 @opindex mint32
17246 Choose integer type as 32-bit wide.
17248 @item -mbit-ops
17249 @opindex mbit-ops
17250 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17252 @item -mdata-model=@var{model}
17253 @opindex mdata-model
17254 Choose a data model. The choices for @var{model} are @samp{near},
17255 @samp{far} or @samp{medium}. @samp{medium} is default.
17256 However, @samp{far} is not valid with @option{-mcr16c}, as the
17257 CR16C architecture does not support the far data model.
17258 @end table
17260 @node Darwin Options
17261 @subsection Darwin Options
17262 @cindex Darwin options
17264 These options are defined for all architectures running the Darwin operating
17265 system.
17267 FSF GCC on Darwin does not create ``fat'' object files; it creates
17268 an object file for the single architecture that GCC was built to
17269 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17270 @option{-arch} options are used; it does so by running the compiler or
17271 linker multiple times and joining the results together with
17272 @file{lipo}.
17274 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17275 @samp{i686}) is determined by the flags that specify the ISA
17276 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17277 @option{-force_cpusubtype_ALL} option can be used to override this.
17279 The Darwin tools vary in their behavior when presented with an ISA
17280 mismatch.  The assembler, @file{as}, only permits instructions to
17281 be used that are valid for the subtype of the file it is generating,
17282 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17283 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17284 and prints an error if asked to create a shared library with a less
17285 restrictive subtype than its input files (for instance, trying to put
17286 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17287 for executables, @command{ld}, quietly gives the executable the most
17288 restrictive subtype of any of its input files.
17290 @table @gcctabopt
17291 @item -F@var{dir}
17292 @opindex F
17293 Add the framework directory @var{dir} to the head of the list of
17294 directories to be searched for header files.  These directories are
17295 interleaved with those specified by @option{-I} options and are
17296 scanned in a left-to-right order.
17298 A framework directory is a directory with frameworks in it.  A
17299 framework is a directory with a @file{Headers} and/or
17300 @file{PrivateHeaders} directory contained directly in it that ends
17301 in @file{.framework}.  The name of a framework is the name of this
17302 directory excluding the @file{.framework}.  Headers associated with
17303 the framework are found in one of those two directories, with
17304 @file{Headers} being searched first.  A subframework is a framework
17305 directory that is in a framework's @file{Frameworks} directory.
17306 Includes of subframework headers can only appear in a header of a
17307 framework that contains the subframework, or in a sibling subframework
17308 header.  Two subframeworks are siblings if they occur in the same
17309 framework.  A subframework should not have the same name as a
17310 framework; a warning is issued if this is violated.  Currently a
17311 subframework cannot have subframeworks; in the future, the mechanism
17312 may be extended to support this.  The standard frameworks can be found
17313 in @file{/System/Library/Frameworks} and
17314 @file{/Library/Frameworks}.  An example include looks like
17315 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17316 the name of the framework and @file{header.h} is found in the
17317 @file{PrivateHeaders} or @file{Headers} directory.
17319 @item -iframework@var{dir}
17320 @opindex iframework
17321 Like @option{-F} except the directory is a treated as a system
17322 directory.  The main difference between this @option{-iframework} and
17323 @option{-F} is that with @option{-iframework} the compiler does not
17324 warn about constructs contained within header files found via
17325 @var{dir}.  This option is valid only for the C family of languages.
17327 @item -gused
17328 @opindex gused
17329 Emit debugging information for symbols that are used.  For stabs
17330 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17331 This is by default ON@.
17333 @item -gfull
17334 @opindex gfull
17335 Emit debugging information for all symbols and types.
17337 @item -mmacosx-version-min=@var{version}
17338 The earliest version of MacOS X that this executable will run on
17339 is @var{version}.  Typical values of @var{version} include @code{10.1},
17340 @code{10.2}, and @code{10.3.9}.
17342 If the compiler was built to use the system's headers by default,
17343 then the default for this option is the system version on which the
17344 compiler is running, otherwise the default is to make choices that
17345 are compatible with as many systems and code bases as possible.
17347 @item -mkernel
17348 @opindex mkernel
17349 Enable kernel development mode.  The @option{-mkernel} option sets
17350 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17351 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17352 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17353 applicable.  This mode also sets @option{-mno-altivec},
17354 @option{-msoft-float}, @option{-fno-builtin} and
17355 @option{-mlong-branch} for PowerPC targets.
17357 @item -mone-byte-bool
17358 @opindex mone-byte-bool
17359 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17360 By default @code{sizeof(bool)} is @code{4} when compiling for
17361 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17362 option has no effect on x86.
17364 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17365 to generate code that is not binary compatible with code generated
17366 without that switch.  Using this switch may require recompiling all
17367 other modules in a program, including system libraries.  Use this
17368 switch to conform to a non-default data model.
17370 @item -mfix-and-continue
17371 @itemx -ffix-and-continue
17372 @itemx -findirect-data
17373 @opindex mfix-and-continue
17374 @opindex ffix-and-continue
17375 @opindex findirect-data
17376 Generate code suitable for fast turnaround development, such as to
17377 allow GDB to dynamically load @file{.o} files into already-running
17378 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17379 are provided for backwards compatibility.
17381 @item -all_load
17382 @opindex all_load
17383 Loads all members of static archive libraries.
17384 See man ld(1) for more information.
17386 @item -arch_errors_fatal
17387 @opindex arch_errors_fatal
17388 Cause the errors having to do with files that have the wrong architecture
17389 to be fatal.
17391 @item -bind_at_load
17392 @opindex bind_at_load
17393 Causes the output file to be marked such that the dynamic linker will
17394 bind all undefined references when the file is loaded or launched.
17396 @item -bundle
17397 @opindex bundle
17398 Produce a Mach-o bundle format file.
17399 See man ld(1) for more information.
17401 @item -bundle_loader @var{executable}
17402 @opindex bundle_loader
17403 This option specifies the @var{executable} that will load the build
17404 output file being linked.  See man ld(1) for more information.
17406 @item -dynamiclib
17407 @opindex dynamiclib
17408 When passed this option, GCC produces a dynamic library instead of
17409 an executable when linking, using the Darwin @file{libtool} command.
17411 @item -force_cpusubtype_ALL
17412 @opindex force_cpusubtype_ALL
17413 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17414 one controlled by the @option{-mcpu} or @option{-march} option.
17416 @item -allowable_client  @var{client_name}
17417 @itemx -client_name
17418 @itemx -compatibility_version
17419 @itemx -current_version
17420 @itemx -dead_strip
17421 @itemx -dependency-file
17422 @itemx -dylib_file
17423 @itemx -dylinker_install_name
17424 @itemx -dynamic
17425 @itemx -exported_symbols_list
17426 @itemx -filelist
17427 @need 800
17428 @itemx -flat_namespace
17429 @itemx -force_flat_namespace
17430 @itemx -headerpad_max_install_names
17431 @itemx -image_base
17432 @itemx -init
17433 @itemx -install_name
17434 @itemx -keep_private_externs
17435 @itemx -multi_module
17436 @itemx -multiply_defined
17437 @itemx -multiply_defined_unused
17438 @need 800
17439 @itemx -noall_load
17440 @itemx -no_dead_strip_inits_and_terms
17441 @itemx -nofixprebinding
17442 @itemx -nomultidefs
17443 @itemx -noprebind
17444 @itemx -noseglinkedit
17445 @itemx -pagezero_size
17446 @itemx -prebind
17447 @itemx -prebind_all_twolevel_modules
17448 @itemx -private_bundle
17449 @need 800
17450 @itemx -read_only_relocs
17451 @itemx -sectalign
17452 @itemx -sectobjectsymbols
17453 @itemx -whyload
17454 @itemx -seg1addr
17455 @itemx -sectcreate
17456 @itemx -sectobjectsymbols
17457 @itemx -sectorder
17458 @itemx -segaddr
17459 @itemx -segs_read_only_addr
17460 @need 800
17461 @itemx -segs_read_write_addr
17462 @itemx -seg_addr_table
17463 @itemx -seg_addr_table_filename
17464 @itemx -seglinkedit
17465 @itemx -segprot
17466 @itemx -segs_read_only_addr
17467 @itemx -segs_read_write_addr
17468 @itemx -single_module
17469 @itemx -static
17470 @itemx -sub_library
17471 @need 800
17472 @itemx -sub_umbrella
17473 @itemx -twolevel_namespace
17474 @itemx -umbrella
17475 @itemx -undefined
17476 @itemx -unexported_symbols_list
17477 @itemx -weak_reference_mismatches
17478 @itemx -whatsloaded
17479 @opindex allowable_client
17480 @opindex client_name
17481 @opindex compatibility_version
17482 @opindex current_version
17483 @opindex dead_strip
17484 @opindex dependency-file
17485 @opindex dylib_file
17486 @opindex dylinker_install_name
17487 @opindex dynamic
17488 @opindex exported_symbols_list
17489 @opindex filelist
17490 @opindex flat_namespace
17491 @opindex force_flat_namespace
17492 @opindex headerpad_max_install_names
17493 @opindex image_base
17494 @opindex init
17495 @opindex install_name
17496 @opindex keep_private_externs
17497 @opindex multi_module
17498 @opindex multiply_defined
17499 @opindex multiply_defined_unused
17500 @opindex noall_load
17501 @opindex no_dead_strip_inits_and_terms
17502 @opindex nofixprebinding
17503 @opindex nomultidefs
17504 @opindex noprebind
17505 @opindex noseglinkedit
17506 @opindex pagezero_size
17507 @opindex prebind
17508 @opindex prebind_all_twolevel_modules
17509 @opindex private_bundle
17510 @opindex read_only_relocs
17511 @opindex sectalign
17512 @opindex sectobjectsymbols
17513 @opindex whyload
17514 @opindex seg1addr
17515 @opindex sectcreate
17516 @opindex sectobjectsymbols
17517 @opindex sectorder
17518 @opindex segaddr
17519 @opindex segs_read_only_addr
17520 @opindex segs_read_write_addr
17521 @opindex seg_addr_table
17522 @opindex seg_addr_table_filename
17523 @opindex seglinkedit
17524 @opindex segprot
17525 @opindex segs_read_only_addr
17526 @opindex segs_read_write_addr
17527 @opindex single_module
17528 @opindex static
17529 @opindex sub_library
17530 @opindex sub_umbrella
17531 @opindex twolevel_namespace
17532 @opindex umbrella
17533 @opindex undefined
17534 @opindex unexported_symbols_list
17535 @opindex weak_reference_mismatches
17536 @opindex whatsloaded
17537 These options are passed to the Darwin linker.  The Darwin linker man page
17538 describes them in detail.
17539 @end table
17541 @node DEC Alpha Options
17542 @subsection DEC Alpha Options
17544 These @samp{-m} options are defined for the DEC Alpha implementations:
17546 @table @gcctabopt
17547 @item -mno-soft-float
17548 @itemx -msoft-float
17549 @opindex mno-soft-float
17550 @opindex msoft-float
17551 Use (do not use) the hardware floating-point instructions for
17552 floating-point operations.  When @option{-msoft-float} is specified,
17553 functions in @file{libgcc.a} are used to perform floating-point
17554 operations.  Unless they are replaced by routines that emulate the
17555 floating-point operations, or compiled in such a way as to call such
17556 emulations routines, these routines issue floating-point
17557 operations.   If you are compiling for an Alpha without floating-point
17558 operations, you must ensure that the library is built so as not to call
17559 them.
17561 Note that Alpha implementations without floating-point operations are
17562 required to have floating-point registers.
17564 @item -mfp-reg
17565 @itemx -mno-fp-regs
17566 @opindex mfp-reg
17567 @opindex mno-fp-regs
17568 Generate code that uses (does not use) the floating-point register set.
17569 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17570 register set is not used, floating-point operands are passed in integer
17571 registers as if they were integers and floating-point results are passed
17572 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17573 so any function with a floating-point argument or return value called by code
17574 compiled with @option{-mno-fp-regs} must also be compiled with that
17575 option.
17577 A typical use of this option is building a kernel that does not use,
17578 and hence need not save and restore, any floating-point registers.
17580 @item -mieee
17581 @opindex mieee
17582 The Alpha architecture implements floating-point hardware optimized for
17583 maximum performance.  It is mostly compliant with the IEEE floating-point
17584 standard.  However, for full compliance, software assistance is
17585 required.  This option generates code fully IEEE-compliant code
17586 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17587 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17588 defined during compilation.  The resulting code is less efficient but is
17589 able to correctly support denormalized numbers and exceptional IEEE
17590 values such as not-a-number and plus/minus infinity.  Other Alpha
17591 compilers call this option @option{-ieee_with_no_inexact}.
17593 @item -mieee-with-inexact
17594 @opindex mieee-with-inexact
17595 This is like @option{-mieee} except the generated code also maintains
17596 the IEEE @var{inexact-flag}.  Turning on this option causes the
17597 generated code to implement fully-compliant IEEE math.  In addition to
17598 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17599 macro.  On some Alpha implementations the resulting code may execute
17600 significantly slower than the code generated by default.  Since there is
17601 very little code that depends on the @var{inexact-flag}, you should
17602 normally not specify this option.  Other Alpha compilers call this
17603 option @option{-ieee_with_inexact}.
17605 @item -mfp-trap-mode=@var{trap-mode}
17606 @opindex mfp-trap-mode
17607 This option controls what floating-point related traps are enabled.
17608 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17609 The trap mode can be set to one of four values:
17611 @table @samp
17612 @item n
17613 This is the default (normal) setting.  The only traps that are enabled
17614 are the ones that cannot be disabled in software (e.g., division by zero
17615 trap).
17617 @item u
17618 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17619 as well.
17621 @item su
17622 Like @samp{u}, but the instructions are marked to be safe for software
17623 completion (see Alpha architecture manual for details).
17625 @item sui
17626 Like @samp{su}, but inexact traps are enabled as well.
17627 @end table
17629 @item -mfp-rounding-mode=@var{rounding-mode}
17630 @opindex mfp-rounding-mode
17631 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17632 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17635 @table @samp
17636 @item n
17637 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17638 the nearest machine number or towards the even machine number in case
17639 of a tie.
17641 @item m
17642 Round towards minus infinity.
17644 @item c
17645 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17647 @item d
17648 Dynamic rounding mode.  A field in the floating-point control register
17649 (@var{fpcr}, see Alpha architecture reference manual) controls the
17650 rounding mode in effect.  The C library initializes this register for
17651 rounding towards plus infinity.  Thus, unless your program modifies the
17652 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17653 @end table
17655 @item -mtrap-precision=@var{trap-precision}
17656 @opindex mtrap-precision
17657 In the Alpha architecture, floating-point traps are imprecise.  This
17658 means without software assistance it is impossible to recover from a
17659 floating trap and program execution normally needs to be terminated.
17660 GCC can generate code that can assist operating system trap handlers
17661 in determining the exact location that caused a floating-point trap.
17662 Depending on the requirements of an application, different levels of
17663 precisions can be selected:
17665 @table @samp
17666 @item p
17667 Program precision.  This option is the default and means a trap handler
17668 can only identify which program caused a floating-point exception.
17670 @item f
17671 Function precision.  The trap handler can determine the function that
17672 caused a floating-point exception.
17674 @item i
17675 Instruction precision.  The trap handler can determine the exact
17676 instruction that caused a floating-point exception.
17677 @end table
17679 Other Alpha compilers provide the equivalent options called
17680 @option{-scope_safe} and @option{-resumption_safe}.
17682 @item -mieee-conformant
17683 @opindex mieee-conformant
17684 This option marks the generated code as IEEE conformant.  You must not
17685 use this option unless you also specify @option{-mtrap-precision=i} and either
17686 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17687 is to emit the line @samp{.eflag 48} in the function prologue of the
17688 generated assembly file.
17690 @item -mbuild-constants
17691 @opindex mbuild-constants
17692 Normally GCC examines a 32- or 64-bit integer constant to
17693 see if it can construct it from smaller constants in two or three
17694 instructions.  If it cannot, it outputs the constant as a literal and
17695 generates code to load it from the data segment at run time.
17697 Use this option to require GCC to construct @emph{all} integer constants
17698 using code, even if it takes more instructions (the maximum is six).
17700 You typically use this option to build a shared library dynamic
17701 loader.  Itself a shared library, it must relocate itself in memory
17702 before it can find the variables and constants in its own data segment.
17704 @item -mbwx
17705 @itemx -mno-bwx
17706 @itemx -mcix
17707 @itemx -mno-cix
17708 @itemx -mfix
17709 @itemx -mno-fix
17710 @itemx -mmax
17711 @itemx -mno-max
17712 @opindex mbwx
17713 @opindex mno-bwx
17714 @opindex mcix
17715 @opindex mno-cix
17716 @opindex mfix
17717 @opindex mno-fix
17718 @opindex mmax
17719 @opindex mno-max
17720 Indicate whether GCC should generate code to use the optional BWX,
17721 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17722 sets supported by the CPU type specified via @option{-mcpu=} option or that
17723 of the CPU on which GCC was built if none is specified.
17725 @item -mfloat-vax
17726 @itemx -mfloat-ieee
17727 @opindex mfloat-vax
17728 @opindex mfloat-ieee
17729 Generate code that uses (does not use) VAX F and G floating-point
17730 arithmetic instead of IEEE single and double precision.
17732 @item -mexplicit-relocs
17733 @itemx -mno-explicit-relocs
17734 @opindex mexplicit-relocs
17735 @opindex mno-explicit-relocs
17736 Older Alpha assemblers provided no way to generate symbol relocations
17737 except via assembler macros.  Use of these macros does not allow
17738 optimal instruction scheduling.  GNU binutils as of version 2.12
17739 supports a new syntax that allows the compiler to explicitly mark
17740 which relocations should apply to which instructions.  This option
17741 is mostly useful for debugging, as GCC detects the capabilities of
17742 the assembler when it is built and sets the default accordingly.
17744 @item -msmall-data
17745 @itemx -mlarge-data
17746 @opindex msmall-data
17747 @opindex mlarge-data
17748 When @option{-mexplicit-relocs} is in effect, static data is
17749 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17750 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17751 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17752 16-bit relocations off of the @code{$gp} register.  This limits the
17753 size of the small data area to 64KB, but allows the variables to be
17754 directly accessed via a single instruction.
17756 The default is @option{-mlarge-data}.  With this option the data area
17757 is limited to just below 2GB@.  Programs that require more than 2GB of
17758 data must use @code{malloc} or @code{mmap} to allocate the data in the
17759 heap instead of in the program's data segment.
17761 When generating code for shared libraries, @option{-fpic} implies
17762 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17764 @item -msmall-text
17765 @itemx -mlarge-text
17766 @opindex msmall-text
17767 @opindex mlarge-text
17768 When @option{-msmall-text} is used, the compiler assumes that the
17769 code of the entire program (or shared library) fits in 4MB, and is
17770 thus reachable with a branch instruction.  When @option{-msmall-data}
17771 is used, the compiler can assume that all local symbols share the
17772 same @code{$gp} value, and thus reduce the number of instructions
17773 required for a function call from 4 to 1.
17775 The default is @option{-mlarge-text}.
17777 @item -mcpu=@var{cpu_type}
17778 @opindex mcpu
17779 Set the instruction set and instruction scheduling parameters for
17780 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17781 style name or the corresponding chip number.  GCC supports scheduling
17782 parameters for the EV4, EV5 and EV6 family of processors and
17783 chooses the default values for the instruction set from the processor
17784 you specify.  If you do not specify a processor type, GCC defaults
17785 to the processor on which the compiler was built.
17787 Supported values for @var{cpu_type} are
17789 @table @samp
17790 @item ev4
17791 @itemx ev45
17792 @itemx 21064
17793 Schedules as an EV4 and has no instruction set extensions.
17795 @item ev5
17796 @itemx 21164
17797 Schedules as an EV5 and has no instruction set extensions.
17799 @item ev56
17800 @itemx 21164a
17801 Schedules as an EV5 and supports the BWX extension.
17803 @item pca56
17804 @itemx 21164pc
17805 @itemx 21164PC
17806 Schedules as an EV5 and supports the BWX and MAX extensions.
17808 @item ev6
17809 @itemx 21264
17810 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17812 @item ev67
17813 @itemx 21264a
17814 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17815 @end table
17817 Native toolchains also support the value @samp{native},
17818 which selects the best architecture option for the host processor.
17819 @option{-mcpu=native} has no effect if GCC does not recognize
17820 the processor.
17822 @item -mtune=@var{cpu_type}
17823 @opindex mtune
17824 Set only the instruction scheduling parameters for machine type
17825 @var{cpu_type}.  The instruction set is not changed.
17827 Native toolchains also support the value @samp{native},
17828 which selects the best architecture option for the host processor.
17829 @option{-mtune=native} has no effect if GCC does not recognize
17830 the processor.
17832 @item -mmemory-latency=@var{time}
17833 @opindex mmemory-latency
17834 Sets the latency the scheduler should assume for typical memory
17835 references as seen by the application.  This number is highly
17836 dependent on the memory access patterns used by the application
17837 and the size of the external cache on the machine.
17839 Valid options for @var{time} are
17841 @table @samp
17842 @item @var{number}
17843 A decimal number representing clock cycles.
17845 @item L1
17846 @itemx L2
17847 @itemx L3
17848 @itemx main
17849 The compiler contains estimates of the number of clock cycles for
17850 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17851 (also called Dcache, Scache, and Bcache), as well as to main memory.
17852 Note that L3 is only valid for EV5.
17854 @end table
17855 @end table
17857 @node FR30 Options
17858 @subsection FR30 Options
17859 @cindex FR30 Options
17861 These options are defined specifically for the FR30 port.
17863 @table @gcctabopt
17865 @item -msmall-model
17866 @opindex msmall-model
17867 Use the small address space model.  This can produce smaller code, but
17868 it does assume that all symbolic values and addresses fit into a
17869 20-bit range.
17871 @item -mno-lsim
17872 @opindex mno-lsim
17873 Assume that runtime support has been provided and so there is no need
17874 to include the simulator library (@file{libsim.a}) on the linker
17875 command line.
17877 @end table
17879 @node FT32 Options
17880 @subsection FT32 Options
17881 @cindex FT32 Options
17883 These options are defined specifically for the FT32 port.
17885 @table @gcctabopt
17887 @item -msim
17888 @opindex msim
17889 Specifies that the program will be run on the simulator.  This causes
17890 an alternate runtime startup and library to be linked.
17891 You must not use this option when generating programs that will run on
17892 real hardware; you must provide your own runtime library for whatever
17893 I/O functions are needed.
17895 @item -mlra
17896 @opindex mlra
17897 Enable Local Register Allocation.  This is still experimental for FT32,
17898 so by default the compiler uses standard reload.
17900 @item -mnodiv
17901 @opindex mnodiv
17902 Do not use div and mod instructions.
17904 @item -mft32b
17905 @opindex mft32b
17906 Enable use of the extended instructions of the FT32B processor.
17908 @item -mcompress
17909 @opindex mcompress
17910 Compress all code using the Ft32B code compression scheme.
17912 @item -mnopm
17913 @opindex  mnopm
17914 Do not generate code that reads program memory.
17916 @end table
17918 @node FRV Options
17919 @subsection FRV Options
17920 @cindex FRV Options
17922 @table @gcctabopt
17923 @item -mgpr-32
17924 @opindex mgpr-32
17926 Only use the first 32 general-purpose registers.
17928 @item -mgpr-64
17929 @opindex mgpr-64
17931 Use all 64 general-purpose registers.
17933 @item -mfpr-32
17934 @opindex mfpr-32
17936 Use only the first 32 floating-point registers.
17938 @item -mfpr-64
17939 @opindex mfpr-64
17941 Use all 64 floating-point registers.
17943 @item -mhard-float
17944 @opindex mhard-float
17946 Use hardware instructions for floating-point operations.
17948 @item -msoft-float
17949 @opindex msoft-float
17951 Use library routines for floating-point operations.
17953 @item -malloc-cc
17954 @opindex malloc-cc
17956 Dynamically allocate condition code registers.
17958 @item -mfixed-cc
17959 @opindex mfixed-cc
17961 Do not try to dynamically allocate condition code registers, only
17962 use @code{icc0} and @code{fcc0}.
17964 @item -mdword
17965 @opindex mdword
17967 Change ABI to use double word insns.
17969 @item -mno-dword
17970 @opindex mno-dword
17972 Do not use double word instructions.
17974 @item -mdouble
17975 @opindex mdouble
17977 Use floating-point double instructions.
17979 @item -mno-double
17980 @opindex mno-double
17982 Do not use floating-point double instructions.
17984 @item -mmedia
17985 @opindex mmedia
17987 Use media instructions.
17989 @item -mno-media
17990 @opindex mno-media
17992 Do not use media instructions.
17994 @item -mmuladd
17995 @opindex mmuladd
17997 Use multiply and add/subtract instructions.
17999 @item -mno-muladd
18000 @opindex mno-muladd
18002 Do not use multiply and add/subtract instructions.
18004 @item -mfdpic
18005 @opindex mfdpic
18007 Select the FDPIC ABI, which uses function descriptors to represent
18008 pointers to functions.  Without any PIC/PIE-related options, it
18009 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18010 assumes GOT entries and small data are within a 12-bit range from the
18011 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18012 are computed with 32 bits.
18013 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18015 @item -minline-plt
18016 @opindex minline-plt
18018 Enable inlining of PLT entries in function calls to functions that are
18019 not known to bind locally.  It has no effect without @option{-mfdpic}.
18020 It's enabled by default if optimizing for speed and compiling for
18021 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18022 optimization option such as @option{-O3} or above is present in the
18023 command line.
18025 @item -mTLS
18026 @opindex mTLS
18028 Assume a large TLS segment when generating thread-local code.
18030 @item -mtls
18031 @opindex mtls
18033 Do not assume a large TLS segment when generating thread-local code.
18035 @item -mgprel-ro
18036 @opindex mgprel-ro
18038 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18039 that is known to be in read-only sections.  It's enabled by default,
18040 except for @option{-fpic} or @option{-fpie}: even though it may help
18041 make the global offset table smaller, it trades 1 instruction for 4.
18042 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18043 one of which may be shared by multiple symbols, and it avoids the need
18044 for a GOT entry for the referenced symbol, so it's more likely to be a
18045 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18047 @item -multilib-library-pic
18048 @opindex multilib-library-pic
18050 Link with the (library, not FD) pic libraries.  It's implied by
18051 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18052 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18053 it explicitly.
18055 @item -mlinked-fp
18056 @opindex mlinked-fp
18058 Follow the EABI requirement of always creating a frame pointer whenever
18059 a stack frame is allocated.  This option is enabled by default and can
18060 be disabled with @option{-mno-linked-fp}.
18062 @item -mlong-calls
18063 @opindex mlong-calls
18065 Use indirect addressing to call functions outside the current
18066 compilation unit.  This allows the functions to be placed anywhere
18067 within the 32-bit address space.
18069 @item -malign-labels
18070 @opindex malign-labels
18072 Try to align labels to an 8-byte boundary by inserting NOPs into the
18073 previous packet.  This option only has an effect when VLIW packing
18074 is enabled.  It doesn't create new packets; it merely adds NOPs to
18075 existing ones.
18077 @item -mlibrary-pic
18078 @opindex mlibrary-pic
18080 Generate position-independent EABI code.
18082 @item -macc-4
18083 @opindex macc-4
18085 Use only the first four media accumulator registers.
18087 @item -macc-8
18088 @opindex macc-8
18090 Use all eight media accumulator registers.
18092 @item -mpack
18093 @opindex mpack
18095 Pack VLIW instructions.
18097 @item -mno-pack
18098 @opindex mno-pack
18100 Do not pack VLIW instructions.
18102 @item -mno-eflags
18103 @opindex mno-eflags
18105 Do not mark ABI switches in e_flags.
18107 @item -mcond-move
18108 @opindex mcond-move
18110 Enable the use of conditional-move instructions (default).
18112 This switch is mainly for debugging the compiler and will likely be removed
18113 in a future version.
18115 @item -mno-cond-move
18116 @opindex mno-cond-move
18118 Disable the use of conditional-move instructions.
18120 This switch is mainly for debugging the compiler and will likely be removed
18121 in a future version.
18123 @item -mscc
18124 @opindex mscc
18126 Enable the use of conditional set instructions (default).
18128 This switch is mainly for debugging the compiler and will likely be removed
18129 in a future version.
18131 @item -mno-scc
18132 @opindex mno-scc
18134 Disable the use of conditional set instructions.
18136 This switch is mainly for debugging the compiler and will likely be removed
18137 in a future version.
18139 @item -mcond-exec
18140 @opindex mcond-exec
18142 Enable the use of conditional execution (default).
18144 This switch is mainly for debugging the compiler and will likely be removed
18145 in a future version.
18147 @item -mno-cond-exec
18148 @opindex mno-cond-exec
18150 Disable the use of conditional execution.
18152 This switch is mainly for debugging the compiler and will likely be removed
18153 in a future version.
18155 @item -mvliw-branch
18156 @opindex mvliw-branch
18158 Run a pass to pack branches into VLIW instructions (default).
18160 This switch is mainly for debugging the compiler and will likely be removed
18161 in a future version.
18163 @item -mno-vliw-branch
18164 @opindex mno-vliw-branch
18166 Do not run a pass to pack branches into VLIW instructions.
18168 This switch is mainly for debugging the compiler and will likely be removed
18169 in a future version.
18171 @item -mmulti-cond-exec
18172 @opindex mmulti-cond-exec
18174 Enable optimization of @code{&&} and @code{||} in conditional execution
18175 (default).
18177 This switch is mainly for debugging the compiler and will likely be removed
18178 in a future version.
18180 @item -mno-multi-cond-exec
18181 @opindex mno-multi-cond-exec
18183 Disable optimization of @code{&&} and @code{||} in conditional execution.
18185 This switch is mainly for debugging the compiler and will likely be removed
18186 in a future version.
18188 @item -mnested-cond-exec
18189 @opindex mnested-cond-exec
18191 Enable nested conditional execution optimizations (default).
18193 This switch is mainly for debugging the compiler and will likely be removed
18194 in a future version.
18196 @item -mno-nested-cond-exec
18197 @opindex mno-nested-cond-exec
18199 Disable nested conditional execution optimizations.
18201 This switch is mainly for debugging the compiler and will likely be removed
18202 in a future version.
18204 @item -moptimize-membar
18205 @opindex moptimize-membar
18207 This switch removes redundant @code{membar} instructions from the
18208 compiler-generated code.  It is enabled by default.
18210 @item -mno-optimize-membar
18211 @opindex mno-optimize-membar
18213 This switch disables the automatic removal of redundant @code{membar}
18214 instructions from the generated code.
18216 @item -mtomcat-stats
18217 @opindex mtomcat-stats
18219 Cause gas to print out tomcat statistics.
18221 @item -mcpu=@var{cpu}
18222 @opindex mcpu
18224 Select the processor type for which to generate code.  Possible values are
18225 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18226 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18228 @end table
18230 @node GNU/Linux Options
18231 @subsection GNU/Linux Options
18233 These @samp{-m} options are defined for GNU/Linux targets:
18235 @table @gcctabopt
18236 @item -mglibc
18237 @opindex mglibc
18238 Use the GNU C library.  This is the default except
18239 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18240 @samp{*-*-linux-*android*} targets.
18242 @item -muclibc
18243 @opindex muclibc
18244 Use uClibc C library.  This is the default on
18245 @samp{*-*-linux-*uclibc*} targets.
18247 @item -mmusl
18248 @opindex mmusl
18249 Use the musl C library.  This is the default on
18250 @samp{*-*-linux-*musl*} targets.
18252 @item -mbionic
18253 @opindex mbionic
18254 Use Bionic C library.  This is the default on
18255 @samp{*-*-linux-*android*} targets.
18257 @item -mandroid
18258 @opindex mandroid
18259 Compile code compatible with Android platform.  This is the default on
18260 @samp{*-*-linux-*android*} targets.
18262 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18263 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18264 this option makes the GCC driver pass Android-specific options to the linker.
18265 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18266 to be defined.
18268 @item -tno-android-cc
18269 @opindex tno-android-cc
18270 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18271 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18272 @option{-fno-rtti} by default.
18274 @item -tno-android-ld
18275 @opindex tno-android-ld
18276 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18277 linking options to the linker.
18279 @end table
18281 @node H8/300 Options
18282 @subsection H8/300 Options
18284 These @samp{-m} options are defined for the H8/300 implementations:
18286 @table @gcctabopt
18287 @item -mrelax
18288 @opindex mrelax
18289 Shorten some address references at link time, when possible; uses the
18290 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18291 ld, Using ld}, for a fuller description.
18293 @item -mh
18294 @opindex mh
18295 Generate code for the H8/300H@.
18297 @item -ms
18298 @opindex ms
18299 Generate code for the H8S@.
18301 @item -mn
18302 @opindex mn
18303 Generate code for the H8S and H8/300H in the normal mode.  This switch
18304 must be used either with @option{-mh} or @option{-ms}.
18306 @item -ms2600
18307 @opindex ms2600
18308 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18310 @item -mexr
18311 @opindex mexr
18312 Extended registers are stored on stack before execution of function
18313 with monitor attribute. Default option is @option{-mexr}.
18314 This option is valid only for H8S targets.
18316 @item -mno-exr
18317 @opindex mno-exr
18318 Extended registers are not stored on stack before execution of function 
18319 with monitor attribute. Default option is @option{-mno-exr}. 
18320 This option is valid only for H8S targets.
18322 @item -mint32
18323 @opindex mint32
18324 Make @code{int} data 32 bits by default.
18326 @item -malign-300
18327 @opindex malign-300
18328 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18329 The default for the H8/300H and H8S is to align longs and floats on
18330 4-byte boundaries.
18331 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18332 This option has no effect on the H8/300.
18333 @end table
18335 @node HPPA Options
18336 @subsection HPPA Options
18337 @cindex HPPA Options
18339 These @samp{-m} options are defined for the HPPA family of computers:
18341 @table @gcctabopt
18342 @item -march=@var{architecture-type}
18343 @opindex march
18344 Generate code for the specified architecture.  The choices for
18345 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18346 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18347 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18348 architecture option for your machine.  Code compiled for lower numbered
18349 architectures runs on higher numbered architectures, but not the
18350 other way around.
18352 @item -mpa-risc-1-0
18353 @itemx -mpa-risc-1-1
18354 @itemx -mpa-risc-2-0
18355 @opindex mpa-risc-1-0
18356 @opindex mpa-risc-1-1
18357 @opindex mpa-risc-2-0
18358 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18360 @item -mcaller-copies
18361 @opindex mcaller-copies
18362 The caller copies function arguments passed by hidden reference.  This
18363 option should be used with care as it is not compatible with the default
18364 32-bit runtime.  However, only aggregates larger than eight bytes are
18365 passed by hidden reference and the option provides better compatibility
18366 with OpenMP.
18368 @item -mjump-in-delay
18369 @opindex mjump-in-delay
18370 This option is ignored and provided for compatibility purposes only.
18372 @item -mdisable-fpregs
18373 @opindex mdisable-fpregs
18374 Prevent floating-point registers from being used in any manner.  This is
18375 necessary for compiling kernels that perform lazy context switching of
18376 floating-point registers.  If you use this option and attempt to perform
18377 floating-point operations, the compiler aborts.
18379 @item -mdisable-indexing
18380 @opindex mdisable-indexing
18381 Prevent the compiler from using indexing address modes.  This avoids some
18382 rather obscure problems when compiling MIG generated code under MACH@.
18384 @item -mno-space-regs
18385 @opindex mno-space-regs
18386 Generate code that assumes the target has no space registers.  This allows
18387 GCC to generate faster indirect calls and use unscaled index address modes.
18389 Such code is suitable for level 0 PA systems and kernels.
18391 @item -mfast-indirect-calls
18392 @opindex mfast-indirect-calls
18393 Generate code that assumes calls never cross space boundaries.  This
18394 allows GCC to emit code that performs faster indirect calls.
18396 This option does not work in the presence of shared libraries or nested
18397 functions.
18399 @item -mfixed-range=@var{register-range}
18400 @opindex mfixed-range
18401 Generate code treating the given register range as fixed registers.
18402 A fixed register is one that the register allocator cannot use.  This is
18403 useful when compiling kernel code.  A register range is specified as
18404 two registers separated by a dash.  Multiple register ranges can be
18405 specified separated by a comma.
18407 @item -mlong-load-store
18408 @opindex mlong-load-store
18409 Generate 3-instruction load and store sequences as sometimes required by
18410 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18411 the HP compilers.
18413 @item -mportable-runtime
18414 @opindex mportable-runtime
18415 Use the portable calling conventions proposed by HP for ELF systems.
18417 @item -mgas
18418 @opindex mgas
18419 Enable the use of assembler directives only GAS understands.
18421 @item -mschedule=@var{cpu-type}
18422 @opindex mschedule
18423 Schedule code according to the constraints for the machine type
18424 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18425 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18426 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18427 proper scheduling option for your machine.  The default scheduling is
18428 @samp{8000}.
18430 @item -mlinker-opt
18431 @opindex mlinker-opt
18432 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18433 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18434 linkers in which they give bogus error messages when linking some programs.
18436 @item -msoft-float
18437 @opindex msoft-float
18438 Generate output containing library calls for floating point.
18439 @strong{Warning:} the requisite libraries are not available for all HPPA
18440 targets.  Normally the facilities of the machine's usual C compiler are
18441 used, but this cannot be done directly in cross-compilation.  You must make
18442 your own arrangements to provide suitable library functions for
18443 cross-compilation.
18445 @option{-msoft-float} changes the calling convention in the output file;
18446 therefore, it is only useful if you compile @emph{all} of a program with
18447 this option.  In particular, you need to compile @file{libgcc.a}, the
18448 library that comes with GCC, with @option{-msoft-float} in order for
18449 this to work.
18451 @item -msio
18452 @opindex msio
18453 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18454 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18455 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18456 options are available under HP-UX and HI-UX@.
18458 @item -mgnu-ld
18459 @opindex mgnu-ld
18460 Use options specific to GNU @command{ld}.
18461 This passes @option{-shared} to @command{ld} when
18462 building a shared library.  It is the default when GCC is configured,
18463 explicitly or implicitly, with the GNU linker.  This option does not
18464 affect which @command{ld} is called; it only changes what parameters
18465 are passed to that @command{ld}.
18466 The @command{ld} that is called is determined by the
18467 @option{--with-ld} configure option, GCC's program search path, and
18468 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18469 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18470 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18472 @item -mhp-ld
18473 @opindex mhp-ld
18474 Use options specific to HP @command{ld}.
18475 This passes @option{-b} to @command{ld} when building
18476 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18477 links.  It is the default when GCC is configured, explicitly or
18478 implicitly, with the HP linker.  This option does not affect
18479 which @command{ld} is called; it only changes what parameters are passed to that
18480 @command{ld}.
18481 The @command{ld} that is called is determined by the @option{--with-ld}
18482 configure option, GCC's program search path, and finally by the user's
18483 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18484 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18485 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18487 @item -mlong-calls
18488 @opindex mno-long-calls
18489 Generate code that uses long call sequences.  This ensures that a call
18490 is always able to reach linker generated stubs.  The default is to generate
18491 long calls only when the distance from the call site to the beginning
18492 of the function or translation unit, as the case may be, exceeds a
18493 predefined limit set by the branch type being used.  The limits for
18494 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18495 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18496 240,000 bytes.
18498 Distances are measured from the beginning of functions when using the
18499 @option{-ffunction-sections} option, or when using the @option{-mgas}
18500 and @option{-mno-portable-runtime} options together under HP-UX with
18501 the SOM linker.
18503 It is normally not desirable to use this option as it degrades
18504 performance.  However, it may be useful in large applications,
18505 particularly when partial linking is used to build the application.
18507 The types of long calls used depends on the capabilities of the
18508 assembler and linker, and the type of code being generated.  The
18509 impact on systems that support long absolute calls, and long pic
18510 symbol-difference or pc-relative calls should be relatively small.
18511 However, an indirect call is used on 32-bit ELF systems in pic code
18512 and it is quite long.
18514 @item -munix=@var{unix-std}
18515 @opindex march
18516 Generate compiler predefines and select a startfile for the specified
18517 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18518 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18519 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18520 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18521 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18522 and later.
18524 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18525 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18526 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18527 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18528 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18529 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18531 It is @emph{important} to note that this option changes the interfaces
18532 for various library routines.  It also affects the operational behavior
18533 of the C library.  Thus, @emph{extreme} care is needed in using this
18534 option.
18536 Library code that is intended to operate with more than one UNIX
18537 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18538 as appropriate.  Most GNU software doesn't provide this capability.
18540 @item -nolibdld
18541 @opindex nolibdld
18542 Suppress the generation of link options to search libdld.sl when the
18543 @option{-static} option is specified on HP-UX 10 and later.
18545 @item -static
18546 @opindex static
18547 The HP-UX implementation of setlocale in libc has a dependency on
18548 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18549 when the @option{-static} option is specified, special link options
18550 are needed to resolve this dependency.
18552 On HP-UX 10 and later, the GCC driver adds the necessary options to
18553 link with libdld.sl when the @option{-static} option is specified.
18554 This causes the resulting binary to be dynamic.  On the 64-bit port,
18555 the linkers generate dynamic binaries by default in any case.  The
18556 @option{-nolibdld} option can be used to prevent the GCC driver from
18557 adding these link options.
18559 @item -threads
18560 @opindex threads
18561 Add support for multithreading with the @dfn{dce thread} library
18562 under HP-UX@.  This option sets flags for both the preprocessor and
18563 linker.
18564 @end table
18566 @node IA-64 Options
18567 @subsection IA-64 Options
18568 @cindex IA-64 Options
18570 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18572 @table @gcctabopt
18573 @item -mbig-endian
18574 @opindex mbig-endian
18575 Generate code for a big-endian target.  This is the default for HP-UX@.
18577 @item -mlittle-endian
18578 @opindex mlittle-endian
18579 Generate code for a little-endian target.  This is the default for AIX5
18580 and GNU/Linux.
18582 @item -mgnu-as
18583 @itemx -mno-gnu-as
18584 @opindex mgnu-as
18585 @opindex mno-gnu-as
18586 Generate (or don't) code for the GNU assembler.  This is the default.
18587 @c Also, this is the default if the configure option @option{--with-gnu-as}
18588 @c is used.
18590 @item -mgnu-ld
18591 @itemx -mno-gnu-ld
18592 @opindex mgnu-ld
18593 @opindex mno-gnu-ld
18594 Generate (or don't) code for the GNU linker.  This is the default.
18595 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18596 @c is used.
18598 @item -mno-pic
18599 @opindex mno-pic
18600 Generate code that does not use a global pointer register.  The result
18601 is not position independent code, and violates the IA-64 ABI@.
18603 @item -mvolatile-asm-stop
18604 @itemx -mno-volatile-asm-stop
18605 @opindex mvolatile-asm-stop
18606 @opindex mno-volatile-asm-stop
18607 Generate (or don't) a stop bit immediately before and after volatile asm
18608 statements.
18610 @item -mregister-names
18611 @itemx -mno-register-names
18612 @opindex mregister-names
18613 @opindex mno-register-names
18614 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18615 the stacked registers.  This may make assembler output more readable.
18617 @item -mno-sdata
18618 @itemx -msdata
18619 @opindex mno-sdata
18620 @opindex msdata
18621 Disable (or enable) optimizations that use the small data section.  This may
18622 be useful for working around optimizer bugs.
18624 @item -mconstant-gp
18625 @opindex mconstant-gp
18626 Generate code that uses a single constant global pointer value.  This is
18627 useful when compiling kernel code.
18629 @item -mauto-pic
18630 @opindex mauto-pic
18631 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18632 This is useful when compiling firmware code.
18634 @item -minline-float-divide-min-latency
18635 @opindex minline-float-divide-min-latency
18636 Generate code for inline divides of floating-point values
18637 using the minimum latency algorithm.
18639 @item -minline-float-divide-max-throughput
18640 @opindex minline-float-divide-max-throughput
18641 Generate code for inline divides of floating-point values
18642 using the maximum throughput algorithm.
18644 @item -mno-inline-float-divide
18645 @opindex mno-inline-float-divide
18646 Do not generate inline code for divides of floating-point values.
18648 @item -minline-int-divide-min-latency
18649 @opindex minline-int-divide-min-latency
18650 Generate code for inline divides of integer values
18651 using the minimum latency algorithm.
18653 @item -minline-int-divide-max-throughput
18654 @opindex minline-int-divide-max-throughput
18655 Generate code for inline divides of integer values
18656 using the maximum throughput algorithm.
18658 @item -mno-inline-int-divide
18659 @opindex mno-inline-int-divide
18660 Do not generate inline code for divides of integer values.
18662 @item -minline-sqrt-min-latency
18663 @opindex minline-sqrt-min-latency
18664 Generate code for inline square roots
18665 using the minimum latency algorithm.
18667 @item -minline-sqrt-max-throughput
18668 @opindex minline-sqrt-max-throughput
18669 Generate code for inline square roots
18670 using the maximum throughput algorithm.
18672 @item -mno-inline-sqrt
18673 @opindex mno-inline-sqrt
18674 Do not generate inline code for @code{sqrt}.
18676 @item -mfused-madd
18677 @itemx -mno-fused-madd
18678 @opindex mfused-madd
18679 @opindex mno-fused-madd
18680 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18681 instructions.  The default is to use these instructions.
18683 @item -mno-dwarf2-asm
18684 @itemx -mdwarf2-asm
18685 @opindex mno-dwarf2-asm
18686 @opindex mdwarf2-asm
18687 Don't (or do) generate assembler code for the DWARF line number debugging
18688 info.  This may be useful when not using the GNU assembler.
18690 @item -mearly-stop-bits
18691 @itemx -mno-early-stop-bits
18692 @opindex mearly-stop-bits
18693 @opindex mno-early-stop-bits
18694 Allow stop bits to be placed earlier than immediately preceding the
18695 instruction that triggered the stop bit.  This can improve instruction
18696 scheduling, but does not always do so.
18698 @item -mfixed-range=@var{register-range}
18699 @opindex mfixed-range
18700 Generate code treating the given register range as fixed registers.
18701 A fixed register is one that the register allocator cannot use.  This is
18702 useful when compiling kernel code.  A register range is specified as
18703 two registers separated by a dash.  Multiple register ranges can be
18704 specified separated by a comma.
18706 @item -mtls-size=@var{tls-size}
18707 @opindex mtls-size
18708 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18711 @item -mtune=@var{cpu-type}
18712 @opindex mtune
18713 Tune the instruction scheduling for a particular CPU, Valid values are
18714 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18715 and @samp{mckinley}.
18717 @item -milp32
18718 @itemx -mlp64
18719 @opindex milp32
18720 @opindex mlp64
18721 Generate code for a 32-bit or 64-bit environment.
18722 The 32-bit environment sets int, long and pointer to 32 bits.
18723 The 64-bit environment sets int to 32 bits and long and pointer
18724 to 64 bits.  These are HP-UX specific flags.
18726 @item -mno-sched-br-data-spec
18727 @itemx -msched-br-data-spec
18728 @opindex mno-sched-br-data-spec
18729 @opindex msched-br-data-spec
18730 (Dis/En)able data speculative scheduling before reload.
18731 This results in generation of @code{ld.a} instructions and
18732 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18733 The default setting is disabled.
18735 @item -msched-ar-data-spec
18736 @itemx -mno-sched-ar-data-spec
18737 @opindex msched-ar-data-spec
18738 @opindex mno-sched-ar-data-spec
18739 (En/Dis)able data speculative scheduling after reload.
18740 This results in generation of @code{ld.a} instructions and
18741 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18742 The default setting is enabled.
18744 @item -mno-sched-control-spec
18745 @itemx -msched-control-spec
18746 @opindex mno-sched-control-spec
18747 @opindex msched-control-spec
18748 (Dis/En)able control speculative scheduling.  This feature is
18749 available only during region scheduling (i.e.@: before reload).
18750 This results in generation of the @code{ld.s} instructions and
18751 the corresponding check instructions @code{chk.s}.
18752 The default setting is disabled.
18754 @item -msched-br-in-data-spec
18755 @itemx -mno-sched-br-in-data-spec
18756 @opindex msched-br-in-data-spec
18757 @opindex mno-sched-br-in-data-spec
18758 (En/Dis)able speculative scheduling of the instructions that
18759 are dependent on the data speculative loads before reload.
18760 This is effective only with @option{-msched-br-data-spec} enabled.
18761 The default setting is enabled.
18763 @item -msched-ar-in-data-spec
18764 @itemx -mno-sched-ar-in-data-spec
18765 @opindex msched-ar-in-data-spec
18766 @opindex mno-sched-ar-in-data-spec
18767 (En/Dis)able speculative scheduling of the instructions that
18768 are dependent on the data speculative loads after reload.
18769 This is effective only with @option{-msched-ar-data-spec} enabled.
18770 The default setting is enabled.
18772 @item -msched-in-control-spec
18773 @itemx -mno-sched-in-control-spec
18774 @opindex msched-in-control-spec
18775 @opindex mno-sched-in-control-spec
18776 (En/Dis)able speculative scheduling of the instructions that
18777 are dependent on the control speculative loads.
18778 This is effective only with @option{-msched-control-spec} enabled.
18779 The default setting is enabled.
18781 @item -mno-sched-prefer-non-data-spec-insns
18782 @itemx -msched-prefer-non-data-spec-insns
18783 @opindex mno-sched-prefer-non-data-spec-insns
18784 @opindex msched-prefer-non-data-spec-insns
18785 If enabled, data-speculative instructions are chosen for schedule
18786 only if there are no other choices at the moment.  This makes
18787 the use of the data speculation much more conservative.
18788 The default setting is disabled.
18790 @item -mno-sched-prefer-non-control-spec-insns
18791 @itemx -msched-prefer-non-control-spec-insns
18792 @opindex mno-sched-prefer-non-control-spec-insns
18793 @opindex msched-prefer-non-control-spec-insns
18794 If enabled, control-speculative instructions are chosen for schedule
18795 only if there are no other choices at the moment.  This makes
18796 the use of the control speculation much more conservative.
18797 The default setting is disabled.
18799 @item -mno-sched-count-spec-in-critical-path
18800 @itemx -msched-count-spec-in-critical-path
18801 @opindex mno-sched-count-spec-in-critical-path
18802 @opindex msched-count-spec-in-critical-path
18803 If enabled, speculative dependencies are considered during
18804 computation of the instructions priorities.  This makes the use of the
18805 speculation a bit more conservative.
18806 The default setting is disabled.
18808 @item -msched-spec-ldc
18809 @opindex msched-spec-ldc
18810 Use a simple data speculation check.  This option is on by default.
18812 @item -msched-control-spec-ldc
18813 @opindex msched-spec-ldc
18814 Use a simple check for control speculation.  This option is on by default.
18816 @item -msched-stop-bits-after-every-cycle
18817 @opindex msched-stop-bits-after-every-cycle
18818 Place a stop bit after every cycle when scheduling.  This option is on
18819 by default.
18821 @item -msched-fp-mem-deps-zero-cost
18822 @opindex msched-fp-mem-deps-zero-cost
18823 Assume that floating-point stores and loads are not likely to cause a conflict
18824 when placed into the same instruction group.  This option is disabled by
18825 default.
18827 @item -msel-sched-dont-check-control-spec
18828 @opindex msel-sched-dont-check-control-spec
18829 Generate checks for control speculation in selective scheduling.
18830 This flag is disabled by default.
18832 @item -msched-max-memory-insns=@var{max-insns}
18833 @opindex msched-max-memory-insns
18834 Limit on the number of memory insns per instruction group, giving lower
18835 priority to subsequent memory insns attempting to schedule in the same
18836 instruction group. Frequently useful to prevent cache bank conflicts.
18837 The default value is 1.
18839 @item -msched-max-memory-insns-hard-limit
18840 @opindex msched-max-memory-insns-hard-limit
18841 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18842 disallowing more than that number in an instruction group.
18843 Otherwise, the limit is ``soft'', meaning that non-memory operations
18844 are preferred when the limit is reached, but memory operations may still
18845 be scheduled.
18847 @end table
18849 @node LM32 Options
18850 @subsection LM32 Options
18851 @cindex LM32 options
18853 These @option{-m} options are defined for the LatticeMico32 architecture:
18855 @table @gcctabopt
18856 @item -mbarrel-shift-enabled
18857 @opindex mbarrel-shift-enabled
18858 Enable barrel-shift instructions.
18860 @item -mdivide-enabled
18861 @opindex mdivide-enabled
18862 Enable divide and modulus instructions.
18864 @item -mmultiply-enabled
18865 @opindex multiply-enabled
18866 Enable multiply instructions.
18868 @item -msign-extend-enabled
18869 @opindex msign-extend-enabled
18870 Enable sign extend instructions.
18872 @item -muser-enabled
18873 @opindex muser-enabled
18874 Enable user-defined instructions.
18876 @end table
18878 @node M32C Options
18879 @subsection M32C Options
18880 @cindex M32C options
18882 @table @gcctabopt
18883 @item -mcpu=@var{name}
18884 @opindex mcpu=
18885 Select the CPU for which code is generated.  @var{name} may be one of
18886 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18887 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18888 the M32C/80 series.
18890 @item -msim
18891 @opindex msim
18892 Specifies that the program will be run on the simulator.  This causes
18893 an alternate runtime library to be linked in which supports, for
18894 example, file I/O@.  You must not use this option when generating
18895 programs that will run on real hardware; you must provide your own
18896 runtime library for whatever I/O functions are needed.
18898 @item -memregs=@var{number}
18899 @opindex memregs=
18900 Specifies the number of memory-based pseudo-registers GCC uses
18901 during code generation.  These pseudo-registers are used like real
18902 registers, so there is a tradeoff between GCC's ability to fit the
18903 code into available registers, and the performance penalty of using
18904 memory instead of registers.  Note that all modules in a program must
18905 be compiled with the same value for this option.  Because of that, you
18906 must not use this option with GCC's default runtime libraries.
18908 @end table
18910 @node M32R/D Options
18911 @subsection M32R/D Options
18912 @cindex M32R/D options
18914 These @option{-m} options are defined for Renesas M32R/D architectures:
18916 @table @gcctabopt
18917 @item -m32r2
18918 @opindex m32r2
18919 Generate code for the M32R/2@.
18921 @item -m32rx
18922 @opindex m32rx
18923 Generate code for the M32R/X@.
18925 @item -m32r
18926 @opindex m32r
18927 Generate code for the M32R@.  This is the default.
18929 @item -mmodel=small
18930 @opindex mmodel=small
18931 Assume all objects live in the lower 16MB of memory (so that their addresses
18932 can be loaded with the @code{ld24} instruction), and assume all subroutines
18933 are reachable with the @code{bl} instruction.
18934 This is the default.
18936 The addressability of a particular object can be set with the
18937 @code{model} attribute.
18939 @item -mmodel=medium
18940 @opindex mmodel=medium
18941 Assume objects may be anywhere in the 32-bit address space (the compiler
18942 generates @code{seth/add3} instructions to load their addresses), and
18943 assume all subroutines are reachable with the @code{bl} instruction.
18945 @item -mmodel=large
18946 @opindex mmodel=large
18947 Assume objects may be anywhere in the 32-bit address space (the compiler
18948 generates @code{seth/add3} instructions to load their addresses), and
18949 assume subroutines may not be reachable with the @code{bl} instruction
18950 (the compiler generates the much slower @code{seth/add3/jl}
18951 instruction sequence).
18953 @item -msdata=none
18954 @opindex msdata=none
18955 Disable use of the small data area.  Variables are put into
18956 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18957 @code{section} attribute has been specified).
18958 This is the default.
18960 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18961 Objects may be explicitly put in the small data area with the
18962 @code{section} attribute using one of these sections.
18964 @item -msdata=sdata
18965 @opindex msdata=sdata
18966 Put small global and static data in the small data area, but do not
18967 generate special code to reference them.
18969 @item -msdata=use
18970 @opindex msdata=use
18971 Put small global and static data in the small data area, and generate
18972 special instructions to reference them.
18974 @item -G @var{num}
18975 @opindex G
18976 @cindex smaller data references
18977 Put global and static objects less than or equal to @var{num} bytes
18978 into the small data or BSS sections instead of the normal data or BSS
18979 sections.  The default value of @var{num} is 8.
18980 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18981 for this option to have any effect.
18983 All modules should be compiled with the same @option{-G @var{num}} value.
18984 Compiling with different values of @var{num} may or may not work; if it
18985 doesn't the linker gives an error message---incorrect code is not
18986 generated.
18988 @item -mdebug
18989 @opindex mdebug
18990 Makes the M32R-specific code in the compiler display some statistics
18991 that might help in debugging programs.
18993 @item -malign-loops
18994 @opindex malign-loops
18995 Align all loops to a 32-byte boundary.
18997 @item -mno-align-loops
18998 @opindex mno-align-loops
18999 Do not enforce a 32-byte alignment for loops.  This is the default.
19001 @item -missue-rate=@var{number}
19002 @opindex missue-rate=@var{number}
19003 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19004 or 2.
19006 @item -mbranch-cost=@var{number}
19007 @opindex mbranch-cost=@var{number}
19008 @var{number} can only be 1 or 2.  If it is 1 then branches are
19009 preferred over conditional code, if it is 2, then the opposite applies.
19011 @item -mflush-trap=@var{number}
19012 @opindex mflush-trap=@var{number}
19013 Specifies the trap number to use to flush the cache.  The default is
19014 12.  Valid numbers are between 0 and 15 inclusive.
19016 @item -mno-flush-trap
19017 @opindex mno-flush-trap
19018 Specifies that the cache cannot be flushed by using a trap.
19020 @item -mflush-func=@var{name}
19021 @opindex mflush-func=@var{name}
19022 Specifies the name of the operating system function to call to flush
19023 the cache.  The default is @samp{_flush_cache}, but a function call
19024 is only used if a trap is not available.
19026 @item -mno-flush-func
19027 @opindex mno-flush-func
19028 Indicates that there is no OS function for flushing the cache.
19030 @end table
19032 @node M680x0 Options
19033 @subsection M680x0 Options
19034 @cindex M680x0 options
19036 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19037 The default settings depend on which architecture was selected when
19038 the compiler was configured; the defaults for the most common choices
19039 are given below.
19041 @table @gcctabopt
19042 @item -march=@var{arch}
19043 @opindex march
19044 Generate code for a specific M680x0 or ColdFire instruction set
19045 architecture.  Permissible values of @var{arch} for M680x0
19046 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19047 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19048 architectures are selected according to Freescale's ISA classification
19049 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19050 @samp{isab} and @samp{isac}.
19052 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19053 code for a ColdFire target.  The @var{arch} in this macro is one of the
19054 @option{-march} arguments given above.
19056 When used together, @option{-march} and @option{-mtune} select code
19057 that runs on a family of similar processors but that is optimized
19058 for a particular microarchitecture.
19060 @item -mcpu=@var{cpu}
19061 @opindex mcpu
19062 Generate code for a specific M680x0 or ColdFire processor.
19063 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19064 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19065 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19066 below, which also classifies the CPUs into families:
19068 @multitable @columnfractions 0.20 0.80
19069 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19070 @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}
19071 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19072 @item @samp{5206e} @tab @samp{5206e}
19073 @item @samp{5208} @tab @samp{5207} @samp{5208}
19074 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19075 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19076 @item @samp{5216} @tab @samp{5214} @samp{5216}
19077 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19078 @item @samp{5225} @tab @samp{5224} @samp{5225}
19079 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19080 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19081 @item @samp{5249} @tab @samp{5249}
19082 @item @samp{5250} @tab @samp{5250}
19083 @item @samp{5271} @tab @samp{5270} @samp{5271}
19084 @item @samp{5272} @tab @samp{5272}
19085 @item @samp{5275} @tab @samp{5274} @samp{5275}
19086 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19087 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19088 @item @samp{5307} @tab @samp{5307}
19089 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19090 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19091 @item @samp{5407} @tab @samp{5407}
19092 @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}
19093 @end multitable
19095 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19096 @var{arch} is compatible with @var{cpu}.  Other combinations of
19097 @option{-mcpu} and @option{-march} are rejected.
19099 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19100 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19101 where the value of @var{family} is given by the table above.
19103 @item -mtune=@var{tune}
19104 @opindex mtune
19105 Tune the code for a particular microarchitecture within the
19106 constraints set by @option{-march} and @option{-mcpu}.
19107 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19108 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19109 and @samp{cpu32}.  The ColdFire microarchitectures
19110 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19112 You can also use @option{-mtune=68020-40} for code that needs
19113 to run relatively well on 68020, 68030 and 68040 targets.
19114 @option{-mtune=68020-60} is similar but includes 68060 targets
19115 as well.  These two options select the same tuning decisions as
19116 @option{-m68020-40} and @option{-m68020-60} respectively.
19118 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19119 when tuning for 680x0 architecture @var{arch}.  It also defines
19120 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19121 option is used.  If GCC is tuning for a range of architectures,
19122 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19123 it defines the macros for every architecture in the range.
19125 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19126 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19127 of the arguments given above.
19129 @item -m68000
19130 @itemx -mc68000
19131 @opindex m68000
19132 @opindex mc68000
19133 Generate output for a 68000.  This is the default
19134 when the compiler is configured for 68000-based systems.
19135 It is equivalent to @option{-march=68000}.
19137 Use this option for microcontrollers with a 68000 or EC000 core,
19138 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19140 @item -m68010
19141 @opindex m68010
19142 Generate output for a 68010.  This is the default
19143 when the compiler is configured for 68010-based systems.
19144 It is equivalent to @option{-march=68010}.
19146 @item -m68020
19147 @itemx -mc68020
19148 @opindex m68020
19149 @opindex mc68020
19150 Generate output for a 68020.  This is the default
19151 when the compiler is configured for 68020-based systems.
19152 It is equivalent to @option{-march=68020}.
19154 @item -m68030
19155 @opindex m68030
19156 Generate output for a 68030.  This is the default when the compiler is
19157 configured for 68030-based systems.  It is equivalent to
19158 @option{-march=68030}.
19160 @item -m68040
19161 @opindex m68040
19162 Generate output for a 68040.  This is the default when the compiler is
19163 configured for 68040-based systems.  It is equivalent to
19164 @option{-march=68040}.
19166 This option inhibits the use of 68881/68882 instructions that have to be
19167 emulated by software on the 68040.  Use this option if your 68040 does not
19168 have code to emulate those instructions.
19170 @item -m68060
19171 @opindex m68060
19172 Generate output for a 68060.  This is the default when the compiler is
19173 configured for 68060-based systems.  It is equivalent to
19174 @option{-march=68060}.
19176 This option inhibits the use of 68020 and 68881/68882 instructions that
19177 have to be emulated by software on the 68060.  Use this option if your 68060
19178 does not have code to emulate those instructions.
19180 @item -mcpu32
19181 @opindex mcpu32
19182 Generate output for a CPU32.  This is the default
19183 when the compiler is configured for CPU32-based systems.
19184 It is equivalent to @option{-march=cpu32}.
19186 Use this option for microcontrollers with a
19187 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19188 68336, 68340, 68341, 68349 and 68360.
19190 @item -m5200
19191 @opindex m5200
19192 Generate output for a 520X ColdFire CPU@.  This is the default
19193 when the compiler is configured for 520X-based systems.
19194 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19195 in favor of that option.
19197 Use this option for microcontroller with a 5200 core, including
19198 the MCF5202, MCF5203, MCF5204 and MCF5206.
19200 @item -m5206e
19201 @opindex m5206e
19202 Generate output for a 5206e ColdFire CPU@.  The option is now
19203 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19205 @item -m528x
19206 @opindex m528x
19207 Generate output for a member of the ColdFire 528X family.
19208 The option is now deprecated in favor of the equivalent
19209 @option{-mcpu=528x}.
19211 @item -m5307
19212 @opindex m5307
19213 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19214 in favor of the equivalent @option{-mcpu=5307}.
19216 @item -m5407
19217 @opindex m5407
19218 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19219 in favor of the equivalent @option{-mcpu=5407}.
19221 @item -mcfv4e
19222 @opindex mcfv4e
19223 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19224 This includes use of hardware floating-point instructions.
19225 The option is equivalent to @option{-mcpu=547x}, and is now
19226 deprecated in favor of that option.
19228 @item -m68020-40
19229 @opindex m68020-40
19230 Generate output for a 68040, without using any of the new instructions.
19231 This results in code that can run relatively efficiently on either a
19232 68020/68881 or a 68030 or a 68040.  The generated code does use the
19233 68881 instructions that are emulated on the 68040.
19235 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19237 @item -m68020-60
19238 @opindex m68020-60
19239 Generate output for a 68060, without using any of the new instructions.
19240 This results in code that can run relatively efficiently on either a
19241 68020/68881 or a 68030 or a 68040.  The generated code does use the
19242 68881 instructions that are emulated on the 68060.
19244 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19246 @item -mhard-float
19247 @itemx -m68881
19248 @opindex mhard-float
19249 @opindex m68881
19250 Generate floating-point instructions.  This is the default for 68020
19251 and above, and for ColdFire devices that have an FPU@.  It defines the
19252 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19253 on ColdFire targets.
19255 @item -msoft-float
19256 @opindex msoft-float
19257 Do not generate floating-point instructions; use library calls instead.
19258 This is the default for 68000, 68010, and 68832 targets.  It is also
19259 the default for ColdFire devices that have no FPU.
19261 @item -mdiv
19262 @itemx -mno-div
19263 @opindex mdiv
19264 @opindex mno-div
19265 Generate (do not generate) ColdFire hardware divide and remainder
19266 instructions.  If @option{-march} is used without @option{-mcpu},
19267 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19268 architectures.  Otherwise, the default is taken from the target CPU
19269 (either the default CPU, or the one specified by @option{-mcpu}).  For
19270 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19271 @option{-mcpu=5206e}.
19273 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19275 @item -mshort
19276 @opindex mshort
19277 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19278 Additionally, parameters passed on the stack are also aligned to a
19279 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19281 @item -mno-short
19282 @opindex mno-short
19283 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19285 @item -mnobitfield
19286 @itemx -mno-bitfield
19287 @opindex mnobitfield
19288 @opindex mno-bitfield
19289 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19290 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19292 @item -mbitfield
19293 @opindex mbitfield
19294 Do use the bit-field instructions.  The @option{-m68020} option implies
19295 @option{-mbitfield}.  This is the default if you use a configuration
19296 designed for a 68020.
19298 @item -mrtd
19299 @opindex mrtd
19300 Use a different function-calling convention, in which functions
19301 that take a fixed number of arguments return with the @code{rtd}
19302 instruction, which pops their arguments while returning.  This
19303 saves one instruction in the caller since there is no need to pop
19304 the arguments there.
19306 This calling convention is incompatible with the one normally
19307 used on Unix, so you cannot use it if you need to call libraries
19308 compiled with the Unix compiler.
19310 Also, you must provide function prototypes for all functions that
19311 take variable numbers of arguments (including @code{printf});
19312 otherwise incorrect code is generated for calls to those
19313 functions.
19315 In addition, seriously incorrect code results if you call a
19316 function with too many arguments.  (Normally, extra arguments are
19317 harmlessly ignored.)
19319 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19320 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19322 @item -mno-rtd
19323 @opindex mno-rtd
19324 Do not use the calling conventions selected by @option{-mrtd}.
19325 This is the default.
19327 @item -malign-int
19328 @itemx -mno-align-int
19329 @opindex malign-int
19330 @opindex mno-align-int
19331 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19332 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19333 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19334 Aligning variables on 32-bit boundaries produces code that runs somewhat
19335 faster on processors with 32-bit busses at the expense of more memory.
19337 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19338 aligns structures containing the above types differently than
19339 most published application binary interface specifications for the m68k.
19341 @item -mpcrel
19342 @opindex mpcrel
19343 Use the pc-relative addressing mode of the 68000 directly, instead of
19344 using a global offset table.  At present, this option implies @option{-fpic},
19345 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19346 not presently supported with @option{-mpcrel}, though this could be supported for
19347 68020 and higher processors.
19349 @item -mno-strict-align
19350 @itemx -mstrict-align
19351 @opindex mno-strict-align
19352 @opindex mstrict-align
19353 Do not (do) assume that unaligned memory references are handled by
19354 the system.
19356 @item -msep-data
19357 Generate code that allows the data segment to be located in a different
19358 area of memory from the text segment.  This allows for execute-in-place in
19359 an environment without virtual memory management.  This option implies
19360 @option{-fPIC}.
19362 @item -mno-sep-data
19363 Generate code that assumes that the data segment follows the text segment.
19364 This is the default.
19366 @item -mid-shared-library
19367 Generate code that supports shared libraries via the library ID method.
19368 This allows for execute-in-place and shared libraries in an environment
19369 without virtual memory management.  This option implies @option{-fPIC}.
19371 @item -mno-id-shared-library
19372 Generate code that doesn't assume ID-based shared libraries are being used.
19373 This is the default.
19375 @item -mshared-library-id=n
19376 Specifies the identification number of the ID-based shared library being
19377 compiled.  Specifying a value of 0 generates more compact code; specifying
19378 other values forces the allocation of that number to the current
19379 library, but is no more space- or time-efficient than omitting this option.
19381 @item -mxgot
19382 @itemx -mno-xgot
19383 @opindex mxgot
19384 @opindex mno-xgot
19385 When generating position-independent code for ColdFire, generate code
19386 that works if the GOT has more than 8192 entries.  This code is
19387 larger and slower than code generated without this option.  On M680x0
19388 processors, this option is not needed; @option{-fPIC} suffices.
19390 GCC normally uses a single instruction to load values from the GOT@.
19391 While this is relatively efficient, it only works if the GOT
19392 is smaller than about 64k.  Anything larger causes the linker
19393 to report an error such as:
19395 @cindex relocation truncated to fit (ColdFire)
19396 @smallexample
19397 relocation truncated to fit: R_68K_GOT16O foobar
19398 @end smallexample
19400 If this happens, you should recompile your code with @option{-mxgot}.
19401 It should then work with very large GOTs.  However, code generated with
19402 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19403 the value of a global symbol.
19405 Note that some linkers, including newer versions of the GNU linker,
19406 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19407 you should only need to use @option{-mxgot} when compiling a single
19408 object file that accesses more than 8192 GOT entries.  Very few do.
19410 These options have no effect unless GCC is generating
19411 position-independent code.
19413 @item -mlong-jump-table-offsets
19414 @opindex mlong-jump-table-offsets
19415 Use 32-bit offsets in @code{switch} tables.  The default is to use
19416 16-bit offsets.
19418 @end table
19420 @node MCore Options
19421 @subsection MCore Options
19422 @cindex MCore options
19424 These are the @samp{-m} options defined for the Motorola M*Core
19425 processors.
19427 @table @gcctabopt
19429 @item -mhardlit
19430 @itemx -mno-hardlit
19431 @opindex mhardlit
19432 @opindex mno-hardlit
19433 Inline constants into the code stream if it can be done in two
19434 instructions or less.
19436 @item -mdiv
19437 @itemx -mno-div
19438 @opindex mdiv
19439 @opindex mno-div
19440 Use the divide instruction.  (Enabled by default).
19442 @item -mrelax-immediate
19443 @itemx -mno-relax-immediate
19444 @opindex mrelax-immediate
19445 @opindex mno-relax-immediate
19446 Allow arbitrary-sized immediates in bit operations.
19448 @item -mwide-bitfields
19449 @itemx -mno-wide-bitfields
19450 @opindex mwide-bitfields
19451 @opindex mno-wide-bitfields
19452 Always treat bit-fields as @code{int}-sized.
19454 @item -m4byte-functions
19455 @itemx -mno-4byte-functions
19456 @opindex m4byte-functions
19457 @opindex mno-4byte-functions
19458 Force all functions to be aligned to a 4-byte boundary.
19460 @item -mcallgraph-data
19461 @itemx -mno-callgraph-data
19462 @opindex mcallgraph-data
19463 @opindex mno-callgraph-data
19464 Emit callgraph information.
19466 @item -mslow-bytes
19467 @itemx -mno-slow-bytes
19468 @opindex mslow-bytes
19469 @opindex mno-slow-bytes
19470 Prefer word access when reading byte quantities.
19472 @item -mlittle-endian
19473 @itemx -mbig-endian
19474 @opindex mlittle-endian
19475 @opindex mbig-endian
19476 Generate code for a little-endian target.
19478 @item -m210
19479 @itemx -m340
19480 @opindex m210
19481 @opindex m340
19482 Generate code for the 210 processor.
19484 @item -mno-lsim
19485 @opindex mno-lsim
19486 Assume that runtime support has been provided and so omit the
19487 simulator library (@file{libsim.a)} from the linker command line.
19489 @item -mstack-increment=@var{size}
19490 @opindex mstack-increment
19491 Set the maximum amount for a single stack increment operation.  Large
19492 values can increase the speed of programs that contain functions
19493 that need a large amount of stack space, but they can also trigger a
19494 segmentation fault if the stack is extended too much.  The default
19495 value is 0x1000.
19497 @end table
19499 @node MeP Options
19500 @subsection MeP Options
19501 @cindex MeP options
19503 @table @gcctabopt
19505 @item -mabsdiff
19506 @opindex mabsdiff
19507 Enables the @code{abs} instruction, which is the absolute difference
19508 between two registers.
19510 @item -mall-opts
19511 @opindex mall-opts
19512 Enables all the optional instructions---average, multiply, divide, bit
19513 operations, leading zero, absolute difference, min/max, clip, and
19514 saturation.
19517 @item -maverage
19518 @opindex maverage
19519 Enables the @code{ave} instruction, which computes the average of two
19520 registers.
19522 @item -mbased=@var{n}
19523 @opindex mbased=
19524 Variables of size @var{n} bytes or smaller are placed in the
19525 @code{.based} section by default.  Based variables use the @code{$tp}
19526 register as a base register, and there is a 128-byte limit to the
19527 @code{.based} section.
19529 @item -mbitops
19530 @opindex mbitops
19531 Enables the bit operation instructions---bit test (@code{btstm}), set
19532 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19533 test-and-set (@code{tas}).
19535 @item -mc=@var{name}
19536 @opindex mc=
19537 Selects which section constant data is placed in.  @var{name} may
19538 be @samp{tiny}, @samp{near}, or @samp{far}.
19540 @item -mclip
19541 @opindex mclip
19542 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19543 useful unless you also provide @option{-mminmax}.
19545 @item -mconfig=@var{name}
19546 @opindex mconfig=
19547 Selects one of the built-in core configurations.  Each MeP chip has
19548 one or more modules in it; each module has a core CPU and a variety of
19549 coprocessors, optional instructions, and peripherals.  The
19550 @code{MeP-Integrator} tool, not part of GCC, provides these
19551 configurations through this option; using this option is the same as
19552 using all the corresponding command-line options.  The default
19553 configuration is @samp{default}.
19555 @item -mcop
19556 @opindex mcop
19557 Enables the coprocessor instructions.  By default, this is a 32-bit
19558 coprocessor.  Note that the coprocessor is normally enabled via the
19559 @option{-mconfig=} option.
19561 @item -mcop32
19562 @opindex mcop32
19563 Enables the 32-bit coprocessor's instructions.
19565 @item -mcop64
19566 @opindex mcop64
19567 Enables the 64-bit coprocessor's instructions.
19569 @item -mivc2
19570 @opindex mivc2
19571 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19573 @item -mdc
19574 @opindex mdc
19575 Causes constant variables to be placed in the @code{.near} section.
19577 @item -mdiv
19578 @opindex mdiv
19579 Enables the @code{div} and @code{divu} instructions.
19581 @item -meb
19582 @opindex meb
19583 Generate big-endian code.
19585 @item -mel
19586 @opindex mel
19587 Generate little-endian code.
19589 @item -mio-volatile
19590 @opindex mio-volatile
19591 Tells the compiler that any variable marked with the @code{io}
19592 attribute is to be considered volatile.
19594 @item -ml
19595 @opindex ml
19596 Causes variables to be assigned to the @code{.far} section by default.
19598 @item -mleadz
19599 @opindex mleadz
19600 Enables the @code{leadz} (leading zero) instruction.
19602 @item -mm
19603 @opindex mm
19604 Causes variables to be assigned to the @code{.near} section by default.
19606 @item -mminmax
19607 @opindex mminmax
19608 Enables the @code{min} and @code{max} instructions.
19610 @item -mmult
19611 @opindex mmult
19612 Enables the multiplication and multiply-accumulate instructions.
19614 @item -mno-opts
19615 @opindex mno-opts
19616 Disables all the optional instructions enabled by @option{-mall-opts}.
19618 @item -mrepeat
19619 @opindex mrepeat
19620 Enables the @code{repeat} and @code{erepeat} instructions, used for
19621 low-overhead looping.
19623 @item -ms
19624 @opindex ms
19625 Causes all variables to default to the @code{.tiny} section.  Note
19626 that there is a 65536-byte limit to this section.  Accesses to these
19627 variables use the @code{%gp} base register.
19629 @item -msatur
19630 @opindex msatur
19631 Enables the saturation instructions.  Note that the compiler does not
19632 currently generate these itself, but this option is included for
19633 compatibility with other tools, like @code{as}.
19635 @item -msdram
19636 @opindex msdram
19637 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19639 @item -msim
19640 @opindex msim
19641 Link the simulator run-time libraries.
19643 @item -msimnovec
19644 @opindex msimnovec
19645 Link the simulator runtime libraries, excluding built-in support
19646 for reset and exception vectors and tables.
19648 @item -mtf
19649 @opindex mtf
19650 Causes all functions to default to the @code{.far} section.  Without
19651 this option, functions default to the @code{.near} section.
19653 @item -mtiny=@var{n}
19654 @opindex mtiny=
19655 Variables that are @var{n} bytes or smaller are allocated to the
19656 @code{.tiny} section.  These variables use the @code{$gp} base
19657 register.  The default for this option is 4, but note that there's a
19658 65536-byte limit to the @code{.tiny} section.
19660 @end table
19662 @node MicroBlaze Options
19663 @subsection MicroBlaze Options
19664 @cindex MicroBlaze Options
19666 @table @gcctabopt
19668 @item -msoft-float
19669 @opindex msoft-float
19670 Use software emulation for floating point (default).
19672 @item -mhard-float
19673 @opindex mhard-float
19674 Use hardware floating-point instructions.
19676 @item -mmemcpy
19677 @opindex mmemcpy
19678 Do not optimize block moves, use @code{memcpy}.
19680 @item -mno-clearbss
19681 @opindex mno-clearbss
19682 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19684 @item -mcpu=@var{cpu-type}
19685 @opindex mcpu=
19686 Use features of, and schedule code for, the given CPU.
19687 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19688 where @var{X} is a major version, @var{YY} is the minor version, and
19689 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19690 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19692 @item -mxl-soft-mul
19693 @opindex mxl-soft-mul
19694 Use software multiply emulation (default).
19696 @item -mxl-soft-div
19697 @opindex mxl-soft-div
19698 Use software emulation for divides (default).
19700 @item -mxl-barrel-shift
19701 @opindex mxl-barrel-shift
19702 Use the hardware barrel shifter.
19704 @item -mxl-pattern-compare
19705 @opindex mxl-pattern-compare
19706 Use pattern compare instructions.
19708 @item -msmall-divides
19709 @opindex msmall-divides
19710 Use table lookup optimization for small signed integer divisions.
19712 @item -mxl-stack-check
19713 @opindex mxl-stack-check
19714 This option is deprecated.  Use @option{-fstack-check} instead.
19716 @item -mxl-gp-opt
19717 @opindex mxl-gp-opt
19718 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19720 @item -mxl-multiply-high
19721 @opindex mxl-multiply-high
19722 Use multiply high instructions for high part of 32x32 multiply.
19724 @item -mxl-float-convert
19725 @opindex mxl-float-convert
19726 Use hardware floating-point conversion instructions.
19728 @item -mxl-float-sqrt
19729 @opindex mxl-float-sqrt
19730 Use hardware floating-point square root instruction.
19732 @item -mbig-endian
19733 @opindex mbig-endian
19734 Generate code for a big-endian target.
19736 @item -mlittle-endian
19737 @opindex mlittle-endian
19738 Generate code for a little-endian target.
19740 @item -mxl-reorder
19741 @opindex mxl-reorder
19742 Use reorder instructions (swap and byte reversed load/store).
19744 @item -mxl-mode-@var{app-model}
19745 Select application model @var{app-model}.  Valid models are
19746 @table @samp
19747 @item executable
19748 normal executable (default), uses startup code @file{crt0.o}.
19750 @item xmdstub
19751 for use with Xilinx Microprocessor Debugger (XMD) based
19752 software intrusive debug agent called xmdstub. This uses startup file
19753 @file{crt1.o} and sets the start address of the program to 0x800.
19755 @item bootstrap
19756 for applications that are loaded using a bootloader.
19757 This model uses startup file @file{crt2.o} which does not contain a processor
19758 reset vector handler. This is suitable for transferring control on a
19759 processor reset to the bootloader rather than the application.
19761 @item novectors
19762 for applications that do not require any of the
19763 MicroBlaze vectors. This option may be useful for applications running
19764 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19765 @end table
19767 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19768 @option{-mxl-mode-@var{app-model}}.
19770 @end table
19772 @node MIPS Options
19773 @subsection MIPS Options
19774 @cindex MIPS options
19776 @table @gcctabopt
19778 @item -EB
19779 @opindex EB
19780 Generate big-endian code.
19782 @item -EL
19783 @opindex EL
19784 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19785 configurations.
19787 @item -march=@var{arch}
19788 @opindex march
19789 Generate code that runs on @var{arch}, which can be the name of a
19790 generic MIPS ISA, or the name of a particular processor.
19791 The ISA names are:
19792 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19793 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19794 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19795 @samp{mips64r5} and @samp{mips64r6}.
19796 The processor names are:
19797 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19798 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19799 @samp{5kc}, @samp{5kf},
19800 @samp{20kc},
19801 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19802 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19803 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19804 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19805 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19806 @samp{i6400},
19807 @samp{interaptiv},
19808 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19809 @samp{m4k},
19810 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19811 @samp{m5100}, @samp{m5101},
19812 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19813 @samp{orion},
19814 @samp{p5600},
19815 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19816 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19817 @samp{rm7000}, @samp{rm9000},
19818 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19819 @samp{sb1},
19820 @samp{sr71000},
19821 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19822 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19823 @samp{xlr} and @samp{xlp}.
19824 The special value @samp{from-abi} selects the
19825 most compatible architecture for the selected ABI (that is,
19826 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19828 The native Linux/GNU toolchain also supports the value @samp{native},
19829 which selects the best architecture option for the host processor.
19830 @option{-march=native} has no effect if GCC does not recognize
19831 the processor.
19833 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19834 (for example, @option{-march=r2k}).  Prefixes are optional, and
19835 @samp{vr} may be written @samp{r}.
19837 Names of the form @samp{@var{n}f2_1} refer to processors with
19838 FPUs clocked at half the rate of the core, names of the form
19839 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19840 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19841 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19842 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19843 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19844 accepted as synonyms for @samp{@var{n}f1_1}.
19846 GCC defines two macros based on the value of this option.  The first
19847 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19848 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19849 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19850 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19851 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19853 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19854 above.  In other words, it has the full prefix and does not
19855 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19856 the macro names the resolved architecture (either @code{"mips1"} or
19857 @code{"mips3"}).  It names the default architecture when no
19858 @option{-march} option is given.
19860 @item -mtune=@var{arch}
19861 @opindex mtune
19862 Optimize for @var{arch}.  Among other things, this option controls
19863 the way instructions are scheduled, and the perceived cost of arithmetic
19864 operations.  The list of @var{arch} values is the same as for
19865 @option{-march}.
19867 When this option is not used, GCC optimizes for the processor
19868 specified by @option{-march}.  By using @option{-march} and
19869 @option{-mtune} together, it is possible to generate code that
19870 runs on a family of processors, but optimize the code for one
19871 particular member of that family.
19873 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19874 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19875 @option{-march} ones described above.
19877 @item -mips1
19878 @opindex mips1
19879 Equivalent to @option{-march=mips1}.
19881 @item -mips2
19882 @opindex mips2
19883 Equivalent to @option{-march=mips2}.
19885 @item -mips3
19886 @opindex mips3
19887 Equivalent to @option{-march=mips3}.
19889 @item -mips4
19890 @opindex mips4
19891 Equivalent to @option{-march=mips4}.
19893 @item -mips32
19894 @opindex mips32
19895 Equivalent to @option{-march=mips32}.
19897 @item -mips32r3
19898 @opindex mips32r3
19899 Equivalent to @option{-march=mips32r3}.
19901 @item -mips32r5
19902 @opindex mips32r5
19903 Equivalent to @option{-march=mips32r5}.
19905 @item -mips32r6
19906 @opindex mips32r6
19907 Equivalent to @option{-march=mips32r6}.
19909 @item -mips64
19910 @opindex mips64
19911 Equivalent to @option{-march=mips64}.
19913 @item -mips64r2
19914 @opindex mips64r2
19915 Equivalent to @option{-march=mips64r2}.
19917 @item -mips64r3
19918 @opindex mips64r3
19919 Equivalent to @option{-march=mips64r3}.
19921 @item -mips64r5
19922 @opindex mips64r5
19923 Equivalent to @option{-march=mips64r5}.
19925 @item -mips64r6
19926 @opindex mips64r6
19927 Equivalent to @option{-march=mips64r6}.
19929 @item -mips16
19930 @itemx -mno-mips16
19931 @opindex mips16
19932 @opindex mno-mips16
19933 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19934 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19936 MIPS16 code generation can also be controlled on a per-function basis
19937 by means of @code{mips16} and @code{nomips16} attributes.
19938 @xref{Function Attributes}, for more information.
19940 @item -mflip-mips16
19941 @opindex mflip-mips16
19942 Generate MIPS16 code on alternating functions.  This option is provided
19943 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19944 not intended for ordinary use in compiling user code.
19946 @item -minterlink-compressed
19947 @item -mno-interlink-compressed
19948 @opindex minterlink-compressed
19949 @opindex mno-interlink-compressed
19950 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19951 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19953 For example, code using the standard ISA encoding cannot jump directly
19954 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19955 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19956 knows that the target of the jump is not compressed.
19958 @item -minterlink-mips16
19959 @itemx -mno-interlink-mips16
19960 @opindex minterlink-mips16
19961 @opindex mno-interlink-mips16
19962 Aliases of @option{-minterlink-compressed} and
19963 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19964 and are retained for backwards compatibility.
19966 @item -mabi=32
19967 @itemx -mabi=o64
19968 @itemx -mabi=n32
19969 @itemx -mabi=64
19970 @itemx -mabi=eabi
19971 @opindex mabi=32
19972 @opindex mabi=o64
19973 @opindex mabi=n32
19974 @opindex mabi=64
19975 @opindex mabi=eabi
19976 Generate code for the given ABI@.
19978 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19979 generates 64-bit code when you select a 64-bit architecture, but you
19980 can use @option{-mgp32} to get 32-bit code instead.
19982 For information about the O64 ABI, see
19983 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19985 GCC supports a variant of the o32 ABI in which floating-point registers
19986 are 64 rather than 32 bits wide.  You can select this combination with
19987 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19988 and @code{mfhc1} instructions and is therefore only supported for
19989 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19991 The register assignments for arguments and return values remain the
19992 same, but each scalar value is passed in a single 64-bit register
19993 rather than a pair of 32-bit registers.  For example, scalar
19994 floating-point values are returned in @samp{$f0} only, not a
19995 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19996 remains the same in that the even-numbered double-precision registers
19997 are saved.
19999 Two additional variants of the o32 ABI are supported to enable
20000 a transition from 32-bit to 64-bit registers.  These are FPXX
20001 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20002 The FPXX extension mandates that all code must execute correctly
20003 when run using 32-bit or 64-bit registers.  The code can be interlinked
20004 with either FP32 or FP64, but not both.
20005 The FP64A extension is similar to the FP64 extension but forbids the
20006 use of odd-numbered single-precision registers.  This can be used
20007 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20008 processors and allows both FP32 and FP64A code to interlink and
20009 run in the same process without changing FPU modes.
20011 @item -mabicalls
20012 @itemx -mno-abicalls
20013 @opindex mabicalls
20014 @opindex mno-abicalls
20015 Generate (do not generate) code that is suitable for SVR4-style
20016 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20017 systems.
20019 @item -mshared
20020 @itemx -mno-shared
20021 Generate (do not generate) code that is fully position-independent,
20022 and that can therefore be linked into shared libraries.  This option
20023 only affects @option{-mabicalls}.
20025 All @option{-mabicalls} code has traditionally been position-independent,
20026 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20027 as an extension, the GNU toolchain allows executables to use absolute
20028 accesses for locally-binding symbols.  It can also use shorter GP
20029 initialization sequences and generate direct calls to locally-defined
20030 functions.  This mode is selected by @option{-mno-shared}.
20032 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20033 objects that can only be linked by the GNU linker.  However, the option
20034 does not affect the ABI of the final executable; it only affects the ABI
20035 of relocatable objects.  Using @option{-mno-shared} generally makes
20036 executables both smaller and quicker.
20038 @option{-mshared} is the default.
20040 @item -mplt
20041 @itemx -mno-plt
20042 @opindex mplt
20043 @opindex mno-plt
20044 Assume (do not assume) that the static and dynamic linkers
20045 support PLTs and copy relocations.  This option only affects
20046 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20047 has no effect without @option{-msym32}.
20049 You can make @option{-mplt} the default by configuring
20050 GCC with @option{--with-mips-plt}.  The default is
20051 @option{-mno-plt} otherwise.
20053 @item -mxgot
20054 @itemx -mno-xgot
20055 @opindex mxgot
20056 @opindex mno-xgot
20057 Lift (do not lift) the usual restrictions on the size of the global
20058 offset table.
20060 GCC normally uses a single instruction to load values from the GOT@.
20061 While this is relatively efficient, it only works if the GOT
20062 is smaller than about 64k.  Anything larger causes the linker
20063 to report an error such as:
20065 @cindex relocation truncated to fit (MIPS)
20066 @smallexample
20067 relocation truncated to fit: R_MIPS_GOT16 foobar
20068 @end smallexample
20070 If this happens, you should recompile your code with @option{-mxgot}.
20071 This works with very large GOTs, although the code is also
20072 less efficient, since it takes three instructions to fetch the
20073 value of a global symbol.
20075 Note that some linkers can create multiple GOTs.  If you have such a
20076 linker, you should only need to use @option{-mxgot} when a single object
20077 file accesses more than 64k's worth of GOT entries.  Very few do.
20079 These options have no effect unless GCC is generating position
20080 independent code.
20082 @item -mgp32
20083 @opindex mgp32
20084 Assume that general-purpose registers are 32 bits wide.
20086 @item -mgp64
20087 @opindex mgp64
20088 Assume that general-purpose registers are 64 bits wide.
20090 @item -mfp32
20091 @opindex mfp32
20092 Assume that floating-point registers are 32 bits wide.
20094 @item -mfp64
20095 @opindex mfp64
20096 Assume that floating-point registers are 64 bits wide.
20098 @item -mfpxx
20099 @opindex mfpxx
20100 Do not assume the width of floating-point registers.
20102 @item -mhard-float
20103 @opindex mhard-float
20104 Use floating-point coprocessor instructions.
20106 @item -msoft-float
20107 @opindex msoft-float
20108 Do not use floating-point coprocessor instructions.  Implement
20109 floating-point calculations using library calls instead.
20111 @item -mno-float
20112 @opindex mno-float
20113 Equivalent to @option{-msoft-float}, but additionally asserts that the
20114 program being compiled does not perform any floating-point operations.
20115 This option is presently supported only by some bare-metal MIPS
20116 configurations, where it may select a special set of libraries
20117 that lack all floating-point support (including, for example, the
20118 floating-point @code{printf} formats).  
20119 If code compiled with @option{-mno-float} accidentally contains
20120 floating-point operations, it is likely to suffer a link-time
20121 or run-time failure.
20123 @item -msingle-float
20124 @opindex msingle-float
20125 Assume that the floating-point coprocessor only supports single-precision
20126 operations.
20128 @item -mdouble-float
20129 @opindex mdouble-float
20130 Assume that the floating-point coprocessor supports double-precision
20131 operations.  This is the default.
20133 @item -modd-spreg
20134 @itemx -mno-odd-spreg
20135 @opindex modd-spreg
20136 @opindex mno-odd-spreg
20137 Enable the use of odd-numbered single-precision floating-point registers
20138 for the o32 ABI.  This is the default for processors that are known to
20139 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20140 is set by default.
20142 @item -mabs=2008
20143 @itemx -mabs=legacy
20144 @opindex mabs=2008
20145 @opindex mabs=legacy
20146 These options control the treatment of the special not-a-number (NaN)
20147 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20148 @code{neg.@i{fmt}} machine instructions.
20150 By default or when @option{-mabs=legacy} is used the legacy
20151 treatment is selected.  In this case these instructions are considered
20152 arithmetic and avoided where correct operation is required and the
20153 input operand might be a NaN.  A longer sequence of instructions that
20154 manipulate the sign bit of floating-point datum manually is used
20155 instead unless the @option{-ffinite-math-only} option has also been
20156 specified.
20158 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20159 this case these instructions are considered non-arithmetic and therefore
20160 operating correctly in all cases, including in particular where the
20161 input operand is a NaN.  These instructions are therefore always used
20162 for the respective operations.
20164 @item -mnan=2008
20165 @itemx -mnan=legacy
20166 @opindex mnan=2008
20167 @opindex mnan=legacy
20168 These options control the encoding of the special not-a-number (NaN)
20169 IEEE 754 floating-point data.
20171 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20172 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20173 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20174 by the first bit of their trailing significand field being 1.
20176 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20177 this case qNaNs are denoted by the first bit of their trailing
20178 significand field being 1, whereas sNaNs are denoted by the first bit of
20179 their trailing significand field being 0.
20181 The default is @option{-mnan=legacy} unless GCC has been configured with
20182 @option{--with-nan=2008}.
20184 @item -mllsc
20185 @itemx -mno-llsc
20186 @opindex mllsc
20187 @opindex mno-llsc
20188 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20189 implement atomic memory built-in functions.  When neither option is
20190 specified, GCC uses the instructions if the target architecture
20191 supports them.
20193 @option{-mllsc} is useful if the runtime environment can emulate the
20194 instructions and @option{-mno-llsc} can be useful when compiling for
20195 nonstandard ISAs.  You can make either option the default by
20196 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20197 respectively.  @option{--with-llsc} is the default for some
20198 configurations; see the installation documentation for details.
20200 @item -mdsp
20201 @itemx -mno-dsp
20202 @opindex mdsp
20203 @opindex mno-dsp
20204 Use (do not use) revision 1 of the MIPS DSP ASE@.
20205 @xref{MIPS DSP Built-in Functions}.  This option defines the
20206 preprocessor macro @code{__mips_dsp}.  It also defines
20207 @code{__mips_dsp_rev} to 1.
20209 @item -mdspr2
20210 @itemx -mno-dspr2
20211 @opindex mdspr2
20212 @opindex mno-dspr2
20213 Use (do not use) revision 2 of the MIPS DSP ASE@.
20214 @xref{MIPS DSP Built-in Functions}.  This option defines the
20215 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20216 It also defines @code{__mips_dsp_rev} to 2.
20218 @item -msmartmips
20219 @itemx -mno-smartmips
20220 @opindex msmartmips
20221 @opindex mno-smartmips
20222 Use (do not use) the MIPS SmartMIPS ASE.
20224 @item -mpaired-single
20225 @itemx -mno-paired-single
20226 @opindex mpaired-single
20227 @opindex mno-paired-single
20228 Use (do not use) paired-single floating-point instructions.
20229 @xref{MIPS Paired-Single Support}.  This option requires
20230 hardware floating-point support to be enabled.
20232 @item -mdmx
20233 @itemx -mno-mdmx
20234 @opindex mdmx
20235 @opindex mno-mdmx
20236 Use (do not use) MIPS Digital Media Extension instructions.
20237 This option can only be used when generating 64-bit code and requires
20238 hardware floating-point support to be enabled.
20240 @item -mips3d
20241 @itemx -mno-mips3d
20242 @opindex mips3d
20243 @opindex mno-mips3d
20244 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20245 The option @option{-mips3d} implies @option{-mpaired-single}.
20247 @item -mmicromips
20248 @itemx -mno-micromips
20249 @opindex mmicromips
20250 @opindex mno-mmicromips
20251 Generate (do not generate) microMIPS code.
20253 MicroMIPS code generation can also be controlled on a per-function basis
20254 by means of @code{micromips} and @code{nomicromips} attributes.
20255 @xref{Function Attributes}, for more information.
20257 @item -mmt
20258 @itemx -mno-mt
20259 @opindex mmt
20260 @opindex mno-mt
20261 Use (do not use) MT Multithreading instructions.
20263 @item -mmcu
20264 @itemx -mno-mcu
20265 @opindex mmcu
20266 @opindex mno-mcu
20267 Use (do not use) the MIPS MCU ASE instructions.
20269 @item -meva
20270 @itemx -mno-eva
20271 @opindex meva
20272 @opindex mno-eva
20273 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20275 @item -mvirt
20276 @itemx -mno-virt
20277 @opindex mvirt
20278 @opindex mno-virt
20279 Use (do not use) the MIPS Virtualization (VZ) instructions.
20281 @item -mxpa
20282 @itemx -mno-xpa
20283 @opindex mxpa
20284 @opindex mno-xpa
20285 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20287 @item -mlong64
20288 @opindex mlong64
20289 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20290 an explanation of the default and the way that the pointer size is
20291 determined.
20293 @item -mlong32
20294 @opindex mlong32
20295 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20297 The default size of @code{int}s, @code{long}s and pointers depends on
20298 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20299 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20300 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20301 or the same size as integer registers, whichever is smaller.
20303 @item -msym32
20304 @itemx -mno-sym32
20305 @opindex msym32
20306 @opindex mno-sym32
20307 Assume (do not assume) that all symbols have 32-bit values, regardless
20308 of the selected ABI@.  This option is useful in combination with
20309 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20310 to generate shorter and faster references to symbolic addresses.
20312 @item -G @var{num}
20313 @opindex G
20314 Put definitions of externally-visible data in a small data section
20315 if that data is no bigger than @var{num} bytes.  GCC can then generate
20316 more efficient accesses to the data; see @option{-mgpopt} for details.
20318 The default @option{-G} option depends on the configuration.
20320 @item -mlocal-sdata
20321 @itemx -mno-local-sdata
20322 @opindex mlocal-sdata
20323 @opindex mno-local-sdata
20324 Extend (do not extend) the @option{-G} behavior to local data too,
20325 such as to static variables in C@.  @option{-mlocal-sdata} is the
20326 default for all configurations.
20328 If the linker complains that an application is using too much small data,
20329 you might want to try rebuilding the less performance-critical parts with
20330 @option{-mno-local-sdata}.  You might also want to build large
20331 libraries with @option{-mno-local-sdata}, so that the libraries leave
20332 more room for the main program.
20334 @item -mextern-sdata
20335 @itemx -mno-extern-sdata
20336 @opindex mextern-sdata
20337 @opindex mno-extern-sdata
20338 Assume (do not assume) that externally-defined data is in
20339 a small data section if the size of that data is within the @option{-G} limit.
20340 @option{-mextern-sdata} is the default for all configurations.
20342 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20343 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20344 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20345 is placed in a small data section.  If @var{Var} is defined by another
20346 module, you must either compile that module with a high-enough
20347 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20348 definition.  If @var{Var} is common, you must link the application
20349 with a high-enough @option{-G} setting.
20351 The easiest way of satisfying these restrictions is to compile
20352 and link every module with the same @option{-G} option.  However,
20353 you may wish to build a library that supports several different
20354 small data limits.  You can do this by compiling the library with
20355 the highest supported @option{-G} setting and additionally using
20356 @option{-mno-extern-sdata} to stop the library from making assumptions
20357 about externally-defined data.
20359 @item -mgpopt
20360 @itemx -mno-gpopt
20361 @opindex mgpopt
20362 @opindex mno-gpopt
20363 Use (do not use) GP-relative accesses for symbols that are known to be
20364 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20365 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20366 configurations.
20368 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20369 might not hold the value of @code{_gp}.  For example, if the code is
20370 part of a library that might be used in a boot monitor, programs that
20371 call boot monitor routines pass an unknown value in @code{$gp}.
20372 (In such situations, the boot monitor itself is usually compiled
20373 with @option{-G0}.)
20375 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20376 @option{-mno-extern-sdata}.
20378 @item -membedded-data
20379 @itemx -mno-embedded-data
20380 @opindex membedded-data
20381 @opindex mno-embedded-data
20382 Allocate variables to the read-only data section first if possible, then
20383 next in the small data section if possible, otherwise in data.  This gives
20384 slightly slower code than the default, but reduces the amount of RAM required
20385 when executing, and thus may be preferred for some embedded systems.
20387 @item -muninit-const-in-rodata
20388 @itemx -mno-uninit-const-in-rodata
20389 @opindex muninit-const-in-rodata
20390 @opindex mno-uninit-const-in-rodata
20391 Put uninitialized @code{const} variables in the read-only data section.
20392 This option is only meaningful in conjunction with @option{-membedded-data}.
20394 @item -mcode-readable=@var{setting}
20395 @opindex mcode-readable
20396 Specify whether GCC may generate code that reads from executable sections.
20397 There are three possible settings:
20399 @table @gcctabopt
20400 @item -mcode-readable=yes
20401 Instructions may freely access executable sections.  This is the
20402 default setting.
20404 @item -mcode-readable=pcrel
20405 MIPS16 PC-relative load instructions can access executable sections,
20406 but other instructions must not do so.  This option is useful on 4KSc
20407 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20408 It is also useful on processors that can be configured to have a dual
20409 instruction/data SRAM interface and that, like the M4K, automatically
20410 redirect PC-relative loads to the instruction RAM.
20412 @item -mcode-readable=no
20413 Instructions must not access executable sections.  This option can be
20414 useful on targets that are configured to have a dual instruction/data
20415 SRAM interface but that (unlike the M4K) do not automatically redirect
20416 PC-relative loads to the instruction RAM.
20417 @end table
20419 @item -msplit-addresses
20420 @itemx -mno-split-addresses
20421 @opindex msplit-addresses
20422 @opindex mno-split-addresses
20423 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20424 relocation operators.  This option has been superseded by
20425 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20427 @item -mexplicit-relocs
20428 @itemx -mno-explicit-relocs
20429 @opindex mexplicit-relocs
20430 @opindex mno-explicit-relocs
20431 Use (do not use) assembler relocation operators when dealing with symbolic
20432 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20433 is to use assembler macros instead.
20435 @option{-mexplicit-relocs} is the default if GCC was configured
20436 to use an assembler that supports relocation operators.
20438 @item -mcheck-zero-division
20439 @itemx -mno-check-zero-division
20440 @opindex mcheck-zero-division
20441 @opindex mno-check-zero-division
20442 Trap (do not trap) on integer division by zero.
20444 The default is @option{-mcheck-zero-division}.
20446 @item -mdivide-traps
20447 @itemx -mdivide-breaks
20448 @opindex mdivide-traps
20449 @opindex mdivide-breaks
20450 MIPS systems check for division by zero by generating either a
20451 conditional trap or a break instruction.  Using traps results in
20452 smaller code, but is only supported on MIPS II and later.  Also, some
20453 versions of the Linux kernel have a bug that prevents trap from
20454 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20455 allow conditional traps on architectures that support them and
20456 @option{-mdivide-breaks} to force the use of breaks.
20458 The default is usually @option{-mdivide-traps}, but this can be
20459 overridden at configure time using @option{--with-divide=breaks}.
20460 Divide-by-zero checks can be completely disabled using
20461 @option{-mno-check-zero-division}.
20463 @item -mload-store-pairs
20464 @itemx -mno-load-store-pairs
20465 @opindex mload-store-pairs
20466 @opindex mno-load-store-pairs
20467 Enable (disable) an optimization that pairs consecutive load or store
20468 instructions to enable load/store bonding.  This option is enabled by
20469 default but only takes effect when the selected architecture is known
20470 to support bonding.
20472 @item -mmemcpy
20473 @itemx -mno-memcpy
20474 @opindex mmemcpy
20475 @opindex mno-memcpy
20476 Force (do not force) the use of @code{memcpy} for non-trivial block
20477 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20478 most constant-sized copies.
20480 @item -mlong-calls
20481 @itemx -mno-long-calls
20482 @opindex mlong-calls
20483 @opindex mno-long-calls
20484 Disable (do not disable) use of the @code{jal} instruction.  Calling
20485 functions using @code{jal} is more efficient but requires the caller
20486 and callee to be in the same 256 megabyte segment.
20488 This option has no effect on abicalls code.  The default is
20489 @option{-mno-long-calls}.
20491 @item -mmad
20492 @itemx -mno-mad
20493 @opindex mmad
20494 @opindex mno-mad
20495 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20496 instructions, as provided by the R4650 ISA@.
20498 @item -mimadd
20499 @itemx -mno-imadd
20500 @opindex mimadd
20501 @opindex mno-imadd
20502 Enable (disable) use of the @code{madd} and @code{msub} integer
20503 instructions.  The default is @option{-mimadd} on architectures
20504 that support @code{madd} and @code{msub} except for the 74k 
20505 architecture where it was found to generate slower code.
20507 @item -mfused-madd
20508 @itemx -mno-fused-madd
20509 @opindex mfused-madd
20510 @opindex mno-fused-madd
20511 Enable (disable) use of the floating-point multiply-accumulate
20512 instructions, when they are available.  The default is
20513 @option{-mfused-madd}.
20515 On the R8000 CPU when multiply-accumulate instructions are used,
20516 the intermediate product is calculated to infinite precision
20517 and is not subject to the FCSR Flush to Zero bit.  This may be
20518 undesirable in some circumstances.  On other processors the result
20519 is numerically identical to the equivalent computation using
20520 separate multiply, add, subtract and negate instructions.
20522 @item -nocpp
20523 @opindex nocpp
20524 Tell the MIPS assembler to not run its preprocessor over user
20525 assembler files (with a @samp{.s} suffix) when assembling them.
20527 @item -mfix-24k
20528 @item -mno-fix-24k
20529 @opindex mfix-24k
20530 @opindex mno-fix-24k
20531 Work around the 24K E48 (lost data on stores during refill) errata.
20532 The workarounds are implemented by the assembler rather than by GCC@.
20534 @item -mfix-r4000
20535 @itemx -mno-fix-r4000
20536 @opindex mfix-r4000
20537 @opindex mno-fix-r4000
20538 Work around certain R4000 CPU errata:
20539 @itemize @minus
20540 @item
20541 A double-word or a variable shift may give an incorrect result if executed
20542 immediately after starting an integer division.
20543 @item
20544 A double-word or a variable shift may give an incorrect result if executed
20545 while an integer multiplication is in progress.
20546 @item
20547 An integer division may give an incorrect result if started in a delay slot
20548 of a taken branch or a jump.
20549 @end itemize
20551 @item -mfix-r4400
20552 @itemx -mno-fix-r4400
20553 @opindex mfix-r4400
20554 @opindex mno-fix-r4400
20555 Work around certain R4400 CPU errata:
20556 @itemize @minus
20557 @item
20558 A double-word or a variable shift may give an incorrect result if executed
20559 immediately after starting an integer division.
20560 @end itemize
20562 @item -mfix-r10000
20563 @itemx -mno-fix-r10000
20564 @opindex mfix-r10000
20565 @opindex mno-fix-r10000
20566 Work around certain R10000 errata:
20567 @itemize @minus
20568 @item
20569 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20570 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20571 @end itemize
20573 This option can only be used if the target architecture supports
20574 branch-likely instructions.  @option{-mfix-r10000} is the default when
20575 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20576 otherwise.
20578 @item -mfix-rm7000
20579 @itemx -mno-fix-rm7000
20580 @opindex mfix-rm7000
20581 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20582 workarounds are implemented by the assembler rather than by GCC@.
20584 @item -mfix-vr4120
20585 @itemx -mno-fix-vr4120
20586 @opindex mfix-vr4120
20587 Work around certain VR4120 errata:
20588 @itemize @minus
20589 @item
20590 @code{dmultu} does not always produce the correct result.
20591 @item
20592 @code{div} and @code{ddiv} do not always produce the correct result if one
20593 of the operands is negative.
20594 @end itemize
20595 The workarounds for the division errata rely on special functions in
20596 @file{libgcc.a}.  At present, these functions are only provided by
20597 the @code{mips64vr*-elf} configurations.
20599 Other VR4120 errata require a NOP to be inserted between certain pairs of
20600 instructions.  These errata are handled by the assembler, not by GCC itself.
20602 @item -mfix-vr4130
20603 @opindex mfix-vr4130
20604 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20605 workarounds are implemented by the assembler rather than by GCC,
20606 although GCC avoids using @code{mflo} and @code{mfhi} if the
20607 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20608 instructions are available instead.
20610 @item -mfix-sb1
20611 @itemx -mno-fix-sb1
20612 @opindex mfix-sb1
20613 Work around certain SB-1 CPU core errata.
20614 (This flag currently works around the SB-1 revision 2
20615 ``F1'' and ``F2'' floating-point errata.)
20617 @item -mr10k-cache-barrier=@var{setting}
20618 @opindex mr10k-cache-barrier
20619 Specify whether GCC should insert cache barriers to avoid the
20620 side-effects of speculation on R10K processors.
20622 In common with many processors, the R10K tries to predict the outcome
20623 of a conditional branch and speculatively executes instructions from
20624 the ``taken'' branch.  It later aborts these instructions if the
20625 predicted outcome is wrong.  However, on the R10K, even aborted
20626 instructions can have side effects.
20628 This problem only affects kernel stores and, depending on the system,
20629 kernel loads.  As an example, a speculatively-executed store may load
20630 the target memory into cache and mark the cache line as dirty, even if
20631 the store itself is later aborted.  If a DMA operation writes to the
20632 same area of memory before the ``dirty'' line is flushed, the cached
20633 data overwrites the DMA-ed data.  See the R10K processor manual
20634 for a full description, including other potential problems.
20636 One workaround is to insert cache barrier instructions before every memory
20637 access that might be speculatively executed and that might have side
20638 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20639 controls GCC's implementation of this workaround.  It assumes that
20640 aborted accesses to any byte in the following regions does not have
20641 side effects:
20643 @enumerate
20644 @item
20645 the memory occupied by the current function's stack frame;
20647 @item
20648 the memory occupied by an incoming stack argument;
20650 @item
20651 the memory occupied by an object with a link-time-constant address.
20652 @end enumerate
20654 It is the kernel's responsibility to ensure that speculative
20655 accesses to these regions are indeed safe.
20657 If the input program contains a function declaration such as:
20659 @smallexample
20660 void foo (void);
20661 @end smallexample
20663 then the implementation of @code{foo} must allow @code{j foo} and
20664 @code{jal foo} to be executed speculatively.  GCC honors this
20665 restriction for functions it compiles itself.  It expects non-GCC
20666 functions (such as hand-written assembly code) to do the same.
20668 The option has three forms:
20670 @table @gcctabopt
20671 @item -mr10k-cache-barrier=load-store
20672 Insert a cache barrier before a load or store that might be
20673 speculatively executed and that might have side effects even
20674 if aborted.
20676 @item -mr10k-cache-barrier=store
20677 Insert a cache barrier before a store that might be speculatively
20678 executed and that might have side effects even if aborted.
20680 @item -mr10k-cache-barrier=none
20681 Disable the insertion of cache barriers.  This is the default setting.
20682 @end table
20684 @item -mflush-func=@var{func}
20685 @itemx -mno-flush-func
20686 @opindex mflush-func
20687 Specifies the function to call to flush the I and D caches, or to not
20688 call any such function.  If called, the function must take the same
20689 arguments as the common @code{_flush_func}, that is, the address of the
20690 memory range for which the cache is being flushed, the size of the
20691 memory range, and the number 3 (to flush both caches).  The default
20692 depends on the target GCC was configured for, but commonly is either
20693 @code{_flush_func} or @code{__cpu_flush}.
20695 @item mbranch-cost=@var{num}
20696 @opindex mbranch-cost
20697 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20698 This cost is only a heuristic and is not guaranteed to produce
20699 consistent results across releases.  A zero cost redundantly selects
20700 the default, which is based on the @option{-mtune} setting.
20702 @item -mbranch-likely
20703 @itemx -mno-branch-likely
20704 @opindex mbranch-likely
20705 @opindex mno-branch-likely
20706 Enable or disable use of Branch Likely instructions, regardless of the
20707 default for the selected architecture.  By default, Branch Likely
20708 instructions may be generated if they are supported by the selected
20709 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20710 and processors that implement those architectures; for those, Branch
20711 Likely instructions are not be generated by default because the MIPS32
20712 and MIPS64 architectures specifically deprecate their use.
20714 @item -mcompact-branches=never
20715 @itemx -mcompact-branches=optimal
20716 @itemx -mcompact-branches=always
20717 @opindex mcompact-branches=never
20718 @opindex mcompact-branches=optimal
20719 @opindex mcompact-branches=always
20720 These options control which form of branches will be generated.  The
20721 default is @option{-mcompact-branches=optimal}.
20723 The @option{-mcompact-branches=never} option ensures that compact branch
20724 instructions will never be generated.
20726 The @option{-mcompact-branches=always} option ensures that a compact
20727 branch instruction will be generated if available.  If a compact branch
20728 instruction is not available, a delay slot form of the branch will be
20729 used instead.
20731 This option is supported from MIPS Release 6 onwards.
20733 The @option{-mcompact-branches=optimal} option will cause a delay slot
20734 branch to be used if one is available in the current ISA and the delay
20735 slot is successfully filled.  If the delay slot is not filled, a compact
20736 branch will be chosen if one is available.
20738 @item -mfp-exceptions
20739 @itemx -mno-fp-exceptions
20740 @opindex mfp-exceptions
20741 Specifies whether FP exceptions are enabled.  This affects how
20742 FP instructions are scheduled for some processors.
20743 The default is that FP exceptions are
20744 enabled.
20746 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20747 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20748 FP pipe.
20750 @item -mvr4130-align
20751 @itemx -mno-vr4130-align
20752 @opindex mvr4130-align
20753 The VR4130 pipeline is two-way superscalar, but can only issue two
20754 instructions together if the first one is 8-byte aligned.  When this
20755 option is enabled, GCC aligns pairs of instructions that it
20756 thinks should execute in parallel.
20758 This option only has an effect when optimizing for the VR4130.
20759 It normally makes code faster, but at the expense of making it bigger.
20760 It is enabled by default at optimization level @option{-O3}.
20762 @item -msynci
20763 @itemx -mno-synci
20764 @opindex msynci
20765 Enable (disable) generation of @code{synci} instructions on
20766 architectures that support it.  The @code{synci} instructions (if
20767 enabled) are generated when @code{__builtin___clear_cache} is
20768 compiled.
20770 This option defaults to @option{-mno-synci}, but the default can be
20771 overridden by configuring GCC with @option{--with-synci}.
20773 When compiling code for single processor systems, it is generally safe
20774 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20775 does not invalidate the instruction caches on all cores and may lead
20776 to undefined behavior.
20778 @item -mrelax-pic-calls
20779 @itemx -mno-relax-pic-calls
20780 @opindex mrelax-pic-calls
20781 Try to turn PIC calls that are normally dispatched via register
20782 @code{$25} into direct calls.  This is only possible if the linker can
20783 resolve the destination at link time and if the destination is within
20784 range for a direct call.
20786 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20787 an assembler and a linker that support the @code{.reloc} assembly
20788 directive and @option{-mexplicit-relocs} is in effect.  With
20789 @option{-mno-explicit-relocs}, this optimization can be performed by the
20790 assembler and the linker alone without help from the compiler.
20792 @item -mmcount-ra-address
20793 @itemx -mno-mcount-ra-address
20794 @opindex mmcount-ra-address
20795 @opindex mno-mcount-ra-address
20796 Emit (do not emit) code that allows @code{_mcount} to modify the
20797 calling function's return address.  When enabled, this option extends
20798 the usual @code{_mcount} interface with a new @var{ra-address}
20799 parameter, which has type @code{intptr_t *} and is passed in register
20800 @code{$12}.  @code{_mcount} can then modify the return address by
20801 doing both of the following:
20802 @itemize
20803 @item
20804 Returning the new address in register @code{$31}.
20805 @item
20806 Storing the new address in @code{*@var{ra-address}},
20807 if @var{ra-address} is nonnull.
20808 @end itemize
20810 The default is @option{-mno-mcount-ra-address}.
20812 @item -mframe-header-opt
20813 @itemx -mno-frame-header-opt
20814 @opindex mframe-header-opt
20815 Enable (disable) frame header optimization in the o32 ABI.  When using the
20816 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20817 function to write out register arguments.  When enabled, this optimization
20818 will suppress the allocation of the frame header if it can be determined that
20819 it is unused.
20821 This optimization is off by default at all optimization levels.
20823 @item -mlxc1-sxc1
20824 @itemx -mno-lxc1-sxc1
20825 @opindex mlxc1-sxc1
20826 When applicable, enable (disable) the generation of @code{lwxc1},
20827 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20829 @item -mmadd4
20830 @itemx -mno-madd4
20831 @opindex mmadd4
20832 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20833 @code{madd.d} and related instructions.  Enabled by default.
20835 @end table
20837 @node MMIX Options
20838 @subsection MMIX Options
20839 @cindex MMIX Options
20841 These options are defined for the MMIX:
20843 @table @gcctabopt
20844 @item -mlibfuncs
20845 @itemx -mno-libfuncs
20846 @opindex mlibfuncs
20847 @opindex mno-libfuncs
20848 Specify that intrinsic library functions are being compiled, passing all
20849 values in registers, no matter the size.
20851 @item -mepsilon
20852 @itemx -mno-epsilon
20853 @opindex mepsilon
20854 @opindex mno-epsilon
20855 Generate floating-point comparison instructions that compare with respect
20856 to the @code{rE} epsilon register.
20858 @item -mabi=mmixware
20859 @itemx -mabi=gnu
20860 @opindex mabi=mmixware
20861 @opindex mabi=gnu
20862 Generate code that passes function parameters and return values that (in
20863 the called function) are seen as registers @code{$0} and up, as opposed to
20864 the GNU ABI which uses global registers @code{$231} and up.
20866 @item -mzero-extend
20867 @itemx -mno-zero-extend
20868 @opindex mzero-extend
20869 @opindex mno-zero-extend
20870 When reading data from memory in sizes shorter than 64 bits, use (do not
20871 use) zero-extending load instructions by default, rather than
20872 sign-extending ones.
20874 @item -mknuthdiv
20875 @itemx -mno-knuthdiv
20876 @opindex mknuthdiv
20877 @opindex mno-knuthdiv
20878 Make the result of a division yielding a remainder have the same sign as
20879 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20880 remainder follows the sign of the dividend.  Both methods are
20881 arithmetically valid, the latter being almost exclusively used.
20883 @item -mtoplevel-symbols
20884 @itemx -mno-toplevel-symbols
20885 @opindex mtoplevel-symbols
20886 @opindex mno-toplevel-symbols
20887 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20888 code can be used with the @code{PREFIX} assembly directive.
20890 @item -melf
20891 @opindex melf
20892 Generate an executable in the ELF format, rather than the default
20893 @samp{mmo} format used by the @command{mmix} simulator.
20895 @item -mbranch-predict
20896 @itemx -mno-branch-predict
20897 @opindex mbranch-predict
20898 @opindex mno-branch-predict
20899 Use (do not use) the probable-branch instructions, when static branch
20900 prediction indicates a probable branch.
20902 @item -mbase-addresses
20903 @itemx -mno-base-addresses
20904 @opindex mbase-addresses
20905 @opindex mno-base-addresses
20906 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20907 base address automatically generates a request (handled by the assembler
20908 and the linker) for a constant to be set up in a global register.  The
20909 register is used for one or more base address requests within the range 0
20910 to 255 from the value held in the register.  The generally leads to short
20911 and fast code, but the number of different data items that can be
20912 addressed is limited.  This means that a program that uses lots of static
20913 data may require @option{-mno-base-addresses}.
20915 @item -msingle-exit
20916 @itemx -mno-single-exit
20917 @opindex msingle-exit
20918 @opindex mno-single-exit
20919 Force (do not force) generated code to have a single exit point in each
20920 function.
20921 @end table
20923 @node MN10300 Options
20924 @subsection MN10300 Options
20925 @cindex MN10300 options
20927 These @option{-m} options are defined for Matsushita MN10300 architectures:
20929 @table @gcctabopt
20930 @item -mmult-bug
20931 @opindex mmult-bug
20932 Generate code to avoid bugs in the multiply instructions for the MN10300
20933 processors.  This is the default.
20935 @item -mno-mult-bug
20936 @opindex mno-mult-bug
20937 Do not generate code to avoid bugs in the multiply instructions for the
20938 MN10300 processors.
20940 @item -mam33
20941 @opindex mam33
20942 Generate code using features specific to the AM33 processor.
20944 @item -mno-am33
20945 @opindex mno-am33
20946 Do not generate code using features specific to the AM33 processor.  This
20947 is the default.
20949 @item -mam33-2
20950 @opindex mam33-2
20951 Generate code using features specific to the AM33/2.0 processor.
20953 @item -mam34
20954 @opindex mam34
20955 Generate code using features specific to the AM34 processor.
20957 @item -mtune=@var{cpu-type}
20958 @opindex mtune
20959 Use the timing characteristics of the indicated CPU type when
20960 scheduling instructions.  This does not change the targeted processor
20961 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20962 @samp{am33-2} or @samp{am34}.
20964 @item -mreturn-pointer-on-d0
20965 @opindex mreturn-pointer-on-d0
20966 When generating a function that returns a pointer, return the pointer
20967 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20968 only in @code{a0}, and attempts to call such functions without a prototype
20969 result in errors.  Note that this option is on by default; use
20970 @option{-mno-return-pointer-on-d0} to disable it.
20972 @item -mno-crt0
20973 @opindex mno-crt0
20974 Do not link in the C run-time initialization object file.
20976 @item -mrelax
20977 @opindex mrelax
20978 Indicate to the linker that it should perform a relaxation optimization pass
20979 to shorten branches, calls and absolute memory addresses.  This option only
20980 has an effect when used on the command line for the final link step.
20982 This option makes symbolic debugging impossible.
20984 @item -mliw
20985 @opindex mliw
20986 Allow the compiler to generate @emph{Long Instruction Word}
20987 instructions if the target is the @samp{AM33} or later.  This is the
20988 default.  This option defines the preprocessor macro @code{__LIW__}.
20990 @item -mnoliw
20991 @opindex mnoliw
20992 Do not allow the compiler to generate @emph{Long Instruction Word}
20993 instructions.  This option defines the preprocessor macro
20994 @code{__NO_LIW__}.
20996 @item -msetlb
20997 @opindex msetlb
20998 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20999 instructions if the target is the @samp{AM33} or later.  This is the
21000 default.  This option defines the preprocessor macro @code{__SETLB__}.
21002 @item -mnosetlb
21003 @opindex mnosetlb
21004 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21005 instructions.  This option defines the preprocessor macro
21006 @code{__NO_SETLB__}.
21008 @end table
21010 @node Moxie Options
21011 @subsection Moxie Options
21012 @cindex Moxie Options
21014 @table @gcctabopt
21016 @item -meb
21017 @opindex meb
21018 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21019 configurations.
21021 @item -mel
21022 @opindex mel
21023 Generate little-endian code.
21025 @item -mmul.x
21026 @opindex mmul.x
21027 Generate mul.x and umul.x instructions.  This is the default for
21028 @samp{moxiebox-*-*} configurations.
21030 @item -mno-crt0
21031 @opindex mno-crt0
21032 Do not link in the C run-time initialization object file.
21034 @end table
21036 @node MSP430 Options
21037 @subsection MSP430 Options
21038 @cindex MSP430 Options
21040 These options are defined for the MSP430:
21042 @table @gcctabopt
21044 @item -masm-hex
21045 @opindex masm-hex
21046 Force assembly output to always use hex constants.  Normally such
21047 constants are signed decimals, but this option is available for
21048 testsuite and/or aesthetic purposes.
21050 @item -mmcu=
21051 @opindex mmcu=
21052 Select the MCU to target.  This is used to create a C preprocessor
21053 symbol based upon the MCU name, converted to upper case and pre- and
21054 post-fixed with @samp{__}.  This in turn is used by the
21055 @file{msp430.h} header file to select an MCU-specific supplementary
21056 header file.
21058 The option also sets the ISA to use.  If the MCU name is one that is
21059 known to only support the 430 ISA then that is selected, otherwise the
21060 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21061 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21062 name selects the 430X ISA.
21064 In addition an MCU-specific linker script is added to the linker
21065 command line.  The script's name is the name of the MCU with
21066 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21067 command line defines the C preprocessor symbol @code{__XXX__} and
21068 cause the linker to search for a script called @file{xxx.ld}.
21070 This option is also passed on to the assembler.
21072 @item -mwarn-mcu
21073 @itemx -mno-warn-mcu
21074 @opindex mwarn-mcu
21075 @opindex mno-warn-mcu
21076 This option enables or disables warnings about conflicts between the
21077 MCU name specified by the @option{-mmcu} option and the ISA set by the
21078 @option{-mcpu} option and/or the hardware multiply support set by the
21079 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21080 MCU names.  This option is on by default.
21082 @item -mcpu=
21083 @opindex mcpu=
21084 Specifies the ISA to use.  Accepted values are @samp{msp430},
21085 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21086 @option{-mmcu=} option should be used to select the ISA.
21088 @item -msim
21089 @opindex msim
21090 Link to the simulator runtime libraries and linker script.  Overrides
21091 any scripts that would be selected by the @option{-mmcu=} option.
21093 @item -mlarge
21094 @opindex mlarge
21095 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21097 @item -msmall
21098 @opindex msmall
21099 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21101 @item -mrelax
21102 @opindex mrelax
21103 This option is passed to the assembler and linker, and allows the
21104 linker to perform certain optimizations that cannot be done until
21105 the final link.
21107 @item mhwmult=
21108 @opindex mhwmult=
21109 Describes the type of hardware multiply supported by the target.
21110 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21111 for the original 16-bit-only multiply supported by early MCUs.
21112 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21113 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21114 A value of @samp{auto} can also be given.  This tells GCC to deduce
21115 the hardware multiply support based upon the MCU name provided by the
21116 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21117 the MCU name is not recognized then no hardware multiply support is
21118 assumed.  @code{auto} is the default setting.
21120 Hardware multiplies are normally performed by calling a library
21121 routine.  This saves space in the generated code.  When compiling at
21122 @option{-O3} or higher however the hardware multiplier is invoked
21123 inline.  This makes for bigger, but faster code.
21125 The hardware multiply routines disable interrupts whilst running and
21126 restore the previous interrupt state when they finish.  This makes
21127 them safe to use inside interrupt handlers as well as in normal code.
21129 @item -minrt
21130 @opindex minrt
21131 Enable the use of a minimum runtime environment - no static
21132 initializers or constructors.  This is intended for memory-constrained
21133 devices.  The compiler includes special symbols in some objects
21134 that tell the linker and runtime which code fragments are required.
21136 @item -mcode-region=
21137 @itemx -mdata-region=
21138 @opindex mcode-region
21139 @opindex mdata-region
21140 These options tell the compiler where to place functions and data that
21141 do not have one of the @code{lower}, @code{upper}, @code{either} or
21142 @code{section} attributes.  Possible values are @code{lower},
21143 @code{upper}, @code{either} or @code{any}.  The first three behave
21144 like the corresponding attribute.  The fourth possible value -
21145 @code{any} - is the default.  It leaves placement entirely up to the
21146 linker script and how it assigns the standard sections
21147 (@code{.text}, @code{.data}, etc) to the memory regions.
21149 @item -msilicon-errata=
21150 @opindex msilicon-errata
21151 This option passes on a request to assembler to enable the fixes for
21152 the named silicon errata.
21154 @item -msilicon-errata-warn=
21155 @opindex msilicon-errata-warn
21156 This option passes on a request to the assembler to enable warning
21157 messages when a silicon errata might need to be applied.
21159 @end table
21161 @node NDS32 Options
21162 @subsection NDS32 Options
21163 @cindex NDS32 Options
21165 These options are defined for NDS32 implementations:
21167 @table @gcctabopt
21169 @item -mbig-endian
21170 @opindex mbig-endian
21171 Generate code in big-endian mode.
21173 @item -mlittle-endian
21174 @opindex mlittle-endian
21175 Generate code in little-endian mode.
21177 @item -mreduced-regs
21178 @opindex mreduced-regs
21179 Use reduced-set registers for register allocation.
21181 @item -mfull-regs
21182 @opindex mfull-regs
21183 Use full-set registers for register allocation.
21185 @item -mcmov
21186 @opindex mcmov
21187 Generate conditional move instructions.
21189 @item -mno-cmov
21190 @opindex mno-cmov
21191 Do not generate conditional move instructions.
21193 @item -mperf-ext
21194 @opindex mperf-ext
21195 Generate performance extension instructions.
21197 @item -mno-perf-ext
21198 @opindex mno-perf-ext
21199 Do not generate performance extension instructions.
21201 @item -mv3push
21202 @opindex mv3push
21203 Generate v3 push25/pop25 instructions.
21205 @item -mno-v3push
21206 @opindex mno-v3push
21207 Do not generate v3 push25/pop25 instructions.
21209 @item -m16-bit
21210 @opindex m16-bit
21211 Generate 16-bit instructions.
21213 @item -mno-16-bit
21214 @opindex mno-16-bit
21215 Do not generate 16-bit instructions.
21217 @item -misr-vector-size=@var{num}
21218 @opindex misr-vector-size
21219 Specify the size of each interrupt vector, which must be 4 or 16.
21221 @item -mcache-block-size=@var{num}
21222 @opindex mcache-block-size
21223 Specify the size of each cache block,
21224 which must be a power of 2 between 4 and 512.
21226 @item -march=@var{arch}
21227 @opindex march
21228 Specify the name of the target architecture.
21230 @item -mcmodel=@var{code-model}
21231 @opindex mcmodel
21232 Set the code model to one of
21233 @table @asis
21234 @item @samp{small}
21235 All the data and read-only data segments must be within 512KB addressing space.
21236 The text segment must be within 16MB addressing space.
21237 @item @samp{medium}
21238 The data segment must be within 512KB while the read-only data segment can be
21239 within 4GB addressing space.  The text segment should be still within 16MB
21240 addressing space.
21241 @item @samp{large}
21242 All the text and data segments can be within 4GB addressing space.
21243 @end table
21245 @item -mctor-dtor
21246 @opindex mctor-dtor
21247 Enable constructor/destructor feature.
21249 @item -mrelax
21250 @opindex mrelax
21251 Guide linker to relax instructions.
21253 @end table
21255 @node Nios II Options
21256 @subsection Nios II Options
21257 @cindex Nios II options
21258 @cindex Altera Nios II options
21260 These are the options defined for the Altera Nios II processor.
21262 @table @gcctabopt
21264 @item -G @var{num}
21265 @opindex G
21266 @cindex smaller data references
21267 Put global and static objects less than or equal to @var{num} bytes
21268 into the small data or BSS sections instead of the normal data or BSS
21269 sections.  The default value of @var{num} is 8.
21271 @item -mgpopt=@var{option}
21272 @item -mgpopt
21273 @itemx -mno-gpopt
21274 @opindex mgpopt
21275 @opindex mno-gpopt
21276 Generate (do not generate) GP-relative accesses.  The following 
21277 @var{option} names are recognized:
21279 @table @samp
21281 @item none
21282 Do not generate GP-relative accesses.
21284 @item local
21285 Generate GP-relative accesses for small data objects that are not 
21286 external, weak, or uninitialized common symbols.  
21287 Also use GP-relative addressing for objects that
21288 have been explicitly placed in a small data section via a @code{section}
21289 attribute.
21291 @item global
21292 As for @samp{local}, but also generate GP-relative accesses for
21293 small data objects that are external, weak, or common.  If you use this option,
21294 you must ensure that all parts of your program (including libraries) are
21295 compiled with the same @option{-G} setting.
21297 @item data
21298 Generate GP-relative accesses for all data objects in the program.  If you
21299 use this option, the entire data and BSS segments
21300 of your program must fit in 64K of memory and you must use an appropriate
21301 linker script to allocate them within the addressable range of the
21302 global pointer.
21304 @item all
21305 Generate GP-relative addresses for function pointers as well as data
21306 pointers.  If you use this option, the entire text, data, and BSS segments
21307 of your program must fit in 64K of memory and you must use an appropriate
21308 linker script to allocate them within the addressable range of the
21309 global pointer.
21311 @end table
21313 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21314 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21316 The default is @option{-mgpopt} except when @option{-fpic} or
21317 @option{-fPIC} is specified to generate position-independent code.
21318 Note that the Nios II ABI does not permit GP-relative accesses from
21319 shared libraries.
21321 You may need to specify @option{-mno-gpopt} explicitly when building
21322 programs that include large amounts of small data, including large
21323 GOT data sections.  In this case, the 16-bit offset for GP-relative
21324 addressing may not be large enough to allow access to the entire 
21325 small data section.
21327 @item -mgprel-sec=@var{regexp}
21328 @opindex mgprel-sec
21329 This option specifies additional section names that can be accessed via
21330 GP-relative addressing.  It is most useful in conjunction with 
21331 @code{section} attributes on variable declarations 
21332 (@pxref{Common Variable Attributes}) and a custom linker script.  
21333 The @var{regexp} is a POSIX Extended Regular Expression.
21335 This option does not affect the behavior of the @option{-G} option, and 
21336 and the specified sections are in addition to the standard @code{.sdata} 
21337 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21339 @item -mr0rel-sec=@var{regexp}
21340 @opindex mr0rel-sec
21341 This option specifies names of sections that can be accessed via a 
21342 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21343 of the 32-bit address space.  It is most useful in conjunction with 
21344 @code{section} attributes on variable declarations 
21345 (@pxref{Common Variable Attributes}) and a custom linker script.  
21346 The @var{regexp} is a POSIX Extended Regular Expression.
21348 In contrast to the use of GP-relative addressing for small data, 
21349 zero-based addressing is never generated by default and there are no 
21350 conventional section names used in standard linker scripts for sections
21351 in the low or high areas of memory.
21353 @item -mel
21354 @itemx -meb
21355 @opindex mel
21356 @opindex meb
21357 Generate little-endian (default) or big-endian (experimental) code,
21358 respectively.
21360 @item -march=@var{arch}
21361 @opindex march
21362 This specifies the name of the target Nios II architecture.  GCC uses this
21363 name to determine what kind of instructions it can emit when generating
21364 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21366 The preprocessor macro @code{__nios2_arch__} is available to programs,
21367 with value 1 or 2, indicating the targeted ISA level.
21369 @item -mbypass-cache
21370 @itemx -mno-bypass-cache
21371 @opindex mno-bypass-cache
21372 @opindex mbypass-cache
21373 Force all load and store instructions to always bypass cache by 
21374 using I/O variants of the instructions. The default is not to
21375 bypass the cache.
21377 @item -mno-cache-volatile 
21378 @itemx -mcache-volatile       
21379 @opindex mcache-volatile 
21380 @opindex mno-cache-volatile
21381 Volatile memory access bypass the cache using the I/O variants of 
21382 the load and store instructions. The default is not to bypass the cache.
21384 @item -mno-fast-sw-div
21385 @itemx -mfast-sw-div
21386 @opindex mno-fast-sw-div
21387 @opindex mfast-sw-div
21388 Do not use table-based fast divide for small numbers. The default 
21389 is to use the fast divide at @option{-O3} and above.
21391 @item -mno-hw-mul
21392 @itemx -mhw-mul
21393 @itemx -mno-hw-mulx
21394 @itemx -mhw-mulx
21395 @itemx -mno-hw-div
21396 @itemx -mhw-div
21397 @opindex mno-hw-mul
21398 @opindex mhw-mul
21399 @opindex mno-hw-mulx
21400 @opindex mhw-mulx
21401 @opindex mno-hw-div
21402 @opindex mhw-div
21403 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21404 instructions by the compiler. The default is to emit @code{mul}
21405 and not emit @code{div} and @code{mulx}.
21407 @item -mbmx
21408 @itemx -mno-bmx
21409 @itemx -mcdx
21410 @itemx -mno-cdx
21411 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21412 CDX (code density) instructions.  Enabling these instructions also
21413 requires @option{-march=r2}.  Since these instructions are optional
21414 extensions to the R2 architecture, the default is not to emit them.
21416 @item -mcustom-@var{insn}=@var{N}
21417 @itemx -mno-custom-@var{insn}
21418 @opindex mcustom-@var{insn}
21419 @opindex mno-custom-@var{insn}
21420 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21421 custom instruction with encoding @var{N} when generating code that uses 
21422 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21423 instruction 253 for single-precision floating-point add operations instead
21424 of the default behavior of using a library call.
21426 The following values of @var{insn} are supported.  Except as otherwise
21427 noted, floating-point operations are expected to be implemented with
21428 normal IEEE 754 semantics and correspond directly to the C operators or the
21429 equivalent GCC built-in functions (@pxref{Other Builtins}).
21431 Single-precision floating point:
21432 @table @asis
21434 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21435 Binary arithmetic operations.
21437 @item @samp{fnegs}
21438 Unary negation.
21440 @item @samp{fabss}
21441 Unary absolute value.
21443 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21444 Comparison operations.
21446 @item @samp{fmins}, @samp{fmaxs}
21447 Floating-point minimum and maximum.  These instructions are only
21448 generated if @option{-ffinite-math-only} is specified.
21450 @item @samp{fsqrts}
21451 Unary square root operation.
21453 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21454 Floating-point trigonometric and exponential functions.  These instructions
21455 are only generated if @option{-funsafe-math-optimizations} is also specified.
21457 @end table
21459 Double-precision floating point:
21460 @table @asis
21462 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21463 Binary arithmetic operations.
21465 @item @samp{fnegd}
21466 Unary negation.
21468 @item @samp{fabsd}
21469 Unary absolute value.
21471 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21472 Comparison operations.
21474 @item @samp{fmind}, @samp{fmaxd}
21475 Double-precision minimum and maximum.  These instructions are only
21476 generated if @option{-ffinite-math-only} is specified.
21478 @item @samp{fsqrtd}
21479 Unary square root operation.
21481 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21482 Double-precision trigonometric and exponential functions.  These instructions
21483 are only generated if @option{-funsafe-math-optimizations} is also specified.
21485 @end table
21487 Conversions:
21488 @table @asis
21489 @item @samp{fextsd}
21490 Conversion from single precision to double precision.
21492 @item @samp{ftruncds}
21493 Conversion from double precision to single precision.
21495 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21496 Conversion from floating point to signed or unsigned integer types, with
21497 truncation towards zero.
21499 @item @samp{round}
21500 Conversion from single-precision floating point to signed integer,
21501 rounding to the nearest integer and ties away from zero.
21502 This corresponds to the @code{__builtin_lroundf} function when
21503 @option{-fno-math-errno} is used.
21505 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21506 Conversion from signed or unsigned integer types to floating-point types.
21508 @end table
21510 In addition, all of the following transfer instructions for internal
21511 registers X and Y must be provided to use any of the double-precision
21512 floating-point instructions.  Custom instructions taking two
21513 double-precision source operands expect the first operand in the
21514 64-bit register X.  The other operand (or only operand of a unary
21515 operation) is given to the custom arithmetic instruction with the
21516 least significant half in source register @var{src1} and the most
21517 significant half in @var{src2}.  A custom instruction that returns a
21518 double-precision result returns the most significant 32 bits in the
21519 destination register and the other half in 32-bit register Y.  
21520 GCC automatically generates the necessary code sequences to write
21521 register X and/or read register Y when double-precision floating-point
21522 instructions are used.
21524 @table @asis
21526 @item @samp{fwrx}
21527 Write @var{src1} into the least significant half of X and @var{src2} into
21528 the most significant half of X.
21530 @item @samp{fwry}
21531 Write @var{src1} into Y.
21533 @item @samp{frdxhi}, @samp{frdxlo}
21534 Read the most or least (respectively) significant half of X and store it in
21535 @var{dest}.
21537 @item @samp{frdy}
21538 Read the value of Y and store it into @var{dest}.
21539 @end table
21541 Note that you can gain more local control over generation of Nios II custom
21542 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21543 and @code{target("no-custom-@var{insn}")} function attributes
21544 (@pxref{Function Attributes})
21545 or pragmas (@pxref{Function Specific Option Pragmas}).
21547 @item -mcustom-fpu-cfg=@var{name}
21548 @opindex mcustom-fpu-cfg
21550 This option enables a predefined, named set of custom instruction encodings
21551 (see @option{-mcustom-@var{insn}} above).  
21552 Currently, the following sets are defined:
21554 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21555 @gccoptlist{-mcustom-fmuls=252 @gol
21556 -mcustom-fadds=253 @gol
21557 -mcustom-fsubs=254 @gol
21558 -fsingle-precision-constant}
21560 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21561 @gccoptlist{-mcustom-fmuls=252 @gol
21562 -mcustom-fadds=253 @gol
21563 -mcustom-fsubs=254 @gol
21564 -mcustom-fdivs=255 @gol
21565 -fsingle-precision-constant}
21567 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21568 @gccoptlist{-mcustom-floatus=243 @gol
21569 -mcustom-fixsi=244 @gol
21570 -mcustom-floatis=245 @gol
21571 -mcustom-fcmpgts=246 @gol
21572 -mcustom-fcmples=249 @gol
21573 -mcustom-fcmpeqs=250 @gol
21574 -mcustom-fcmpnes=251 @gol
21575 -mcustom-fmuls=252 @gol
21576 -mcustom-fadds=253 @gol
21577 -mcustom-fsubs=254 @gol
21578 -mcustom-fdivs=255 @gol
21579 -fsingle-precision-constant}
21581 Custom instruction assignments given by individual
21582 @option{-mcustom-@var{insn}=} options override those given by
21583 @option{-mcustom-fpu-cfg=}, regardless of the
21584 order of the options on the command line.
21586 Note that you can gain more local control over selection of a FPU
21587 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21588 function attribute (@pxref{Function Attributes})
21589 or pragma (@pxref{Function Specific Option Pragmas}).
21591 @end table
21593 These additional @samp{-m} options are available for the Altera Nios II
21594 ELF (bare-metal) target:
21596 @table @gcctabopt
21598 @item -mhal
21599 @opindex mhal
21600 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21601 startup and termination code, and is typically used in conjunction with
21602 @option{-msys-crt0=} to specify the location of the alternate startup code
21603 provided by the HAL BSP.
21605 @item -msmallc
21606 @opindex msmallc
21607 Link with a limited version of the C library, @option{-lsmallc}, rather than
21608 Newlib.
21610 @item -msys-crt0=@var{startfile}
21611 @opindex msys-crt0
21612 @var{startfile} is the file name of the startfile (crt0) to use 
21613 when linking.  This option is only useful in conjunction with @option{-mhal}.
21615 @item -msys-lib=@var{systemlib}
21616 @opindex msys-lib
21617 @var{systemlib} is the library name of the library that provides
21618 low-level system calls required by the C library,
21619 e.g. @code{read} and @code{write}.
21620 This option is typically used to link with a library provided by a HAL BSP.
21622 @end table
21624 @node Nvidia PTX Options
21625 @subsection Nvidia PTX Options
21626 @cindex Nvidia PTX options
21627 @cindex nvptx options
21629 These options are defined for Nvidia PTX:
21631 @table @gcctabopt
21633 @item -m32
21634 @itemx -m64
21635 @opindex m32
21636 @opindex m64
21637 Generate code for 32-bit or 64-bit ABI.
21639 @item -mmainkernel
21640 @opindex mmainkernel
21641 Link in code for a __main kernel.  This is for stand-alone instead of
21642 offloading execution.
21644 @item -moptimize
21645 @opindex moptimize
21646 Apply partitioned execution optimizations.  This is the default when any
21647 level of optimization is selected.
21649 @item -msoft-stack
21650 @opindex msoft-stack
21651 Generate code that does not use @code{.local} memory
21652 directly for stack storage. Instead, a per-warp stack pointer is
21653 maintained explicitly. This enables variable-length stack allocation (with
21654 variable-length arrays or @code{alloca}), and when global memory is used for
21655 underlying storage, makes it possible to access automatic variables from other
21656 threads, or with atomic instructions. This code generation variant is used
21657 for OpenMP offloading, but the option is exposed on its own for the purpose
21658 of testing the compiler; to generate code suitable for linking into programs
21659 using OpenMP offloading, use option @option{-mgomp}.
21661 @item -muniform-simt
21662 @opindex muniform-simt
21663 Switch to code generation variant that allows to execute all threads in each
21664 warp, while maintaining memory state and side effects as if only one thread
21665 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21666 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21667 current lane index equals the master lane index), and the register being
21668 assigned is copied via a shuffle instruction from the master lane.  Outside of
21669 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21670 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21671 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21672 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21673 with current lane index to compute the master lane index.
21675 @item -mgomp
21676 @opindex mgomp
21677 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21678 @option{-muniform-simt} options, and selects corresponding multilib variant.
21680 @end table
21682 @node PDP-11 Options
21683 @subsection PDP-11 Options
21684 @cindex PDP-11 Options
21686 These options are defined for the PDP-11:
21688 @table @gcctabopt
21689 @item -mfpu
21690 @opindex mfpu
21691 Use hardware FPP floating point.  This is the default.  (FIS floating
21692 point on the PDP-11/40 is not supported.)
21694 @item -msoft-float
21695 @opindex msoft-float
21696 Do not use hardware floating point.
21698 @item -mac0
21699 @opindex mac0
21700 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21702 @item -mno-ac0
21703 @opindex mno-ac0
21704 Return floating-point results in memory.  This is the default.
21706 @item -m40
21707 @opindex m40
21708 Generate code for a PDP-11/40.
21710 @item -m45
21711 @opindex m45
21712 Generate code for a PDP-11/45.  This is the default.
21714 @item -m10
21715 @opindex m10
21716 Generate code for a PDP-11/10.
21718 @item -mbcopy-builtin
21719 @opindex mbcopy-builtin
21720 Use inline @code{movmemhi} patterns for copying memory.  This is the
21721 default.
21723 @item -mbcopy
21724 @opindex mbcopy
21725 Do not use inline @code{movmemhi} patterns for copying memory.
21727 @item -mint16
21728 @itemx -mno-int32
21729 @opindex mint16
21730 @opindex mno-int32
21731 Use 16-bit @code{int}.  This is the default.
21733 @item -mint32
21734 @itemx -mno-int16
21735 @opindex mint32
21736 @opindex mno-int16
21737 Use 32-bit @code{int}.
21739 @item -mfloat64
21740 @itemx -mno-float32
21741 @opindex mfloat64
21742 @opindex mno-float32
21743 Use 64-bit @code{float}.  This is the default.
21745 @item -mfloat32
21746 @itemx -mno-float64
21747 @opindex mfloat32
21748 @opindex mno-float64
21749 Use 32-bit @code{float}.
21751 @item -mabshi
21752 @opindex mabshi
21753 Use @code{abshi2} pattern.  This is the default.
21755 @item -mno-abshi
21756 @opindex mno-abshi
21757 Do not use @code{abshi2} pattern.
21759 @item -mbranch-expensive
21760 @opindex mbranch-expensive
21761 Pretend that branches are expensive.  This is for experimenting with
21762 code generation only.
21764 @item -mbranch-cheap
21765 @opindex mbranch-cheap
21766 Do not pretend that branches are expensive.  This is the default.
21768 @item -munix-asm
21769 @opindex munix-asm
21770 Use Unix assembler syntax.  This is the default when configured for
21771 @samp{pdp11-*-bsd}.
21773 @item -mdec-asm
21774 @opindex mdec-asm
21775 Use DEC assembler syntax.  This is the default when configured for any
21776 PDP-11 target other than @samp{pdp11-*-bsd}.
21777 @end table
21779 @node picoChip Options
21780 @subsection picoChip Options
21781 @cindex picoChip options
21783 These @samp{-m} options are defined for picoChip implementations:
21785 @table @gcctabopt
21787 @item -mae=@var{ae_type}
21788 @opindex mcpu
21789 Set the instruction set, register set, and instruction scheduling
21790 parameters for array element type @var{ae_type}.  Supported values
21791 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21793 @option{-mae=ANY} selects a completely generic AE type.  Code
21794 generated with this option runs on any of the other AE types.  The
21795 code is not as efficient as it would be if compiled for a specific
21796 AE type, and some types of operation (e.g., multiplication) do not
21797 work properly on all types of AE.
21799 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21800 for compiled code, and is the default.
21802 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21803 option may suffer from poor performance of byte (char) manipulation,
21804 since the DSP AE does not provide hardware support for byte load/stores.
21806 @item -msymbol-as-address
21807 Enable the compiler to directly use a symbol name as an address in a
21808 load/store instruction, without first loading it into a
21809 register.  Typically, the use of this option generates larger
21810 programs, which run faster than when the option isn't used.  However, the
21811 results vary from program to program, so it is left as a user option,
21812 rather than being permanently enabled.
21814 @item -mno-inefficient-warnings
21815 Disables warnings about the generation of inefficient code.  These
21816 warnings can be generated, for example, when compiling code that
21817 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21818 no hardware support for byte-level memory operations, so all byte
21819 load/stores must be synthesized from word load/store operations.  This is
21820 inefficient and a warning is generated to indicate
21821 that you should rewrite the code to avoid byte operations, or to target
21822 an AE type that has the necessary hardware support.  This option disables
21823 these warnings.
21825 @end table
21827 @node PowerPC Options
21828 @subsection PowerPC Options
21829 @cindex PowerPC options
21831 These are listed under @xref{RS/6000 and PowerPC Options}.
21833 @node RISC-V Options
21834 @subsection RISC-V Options
21835 @cindex RISC-V Options
21837 These command-line options are defined for RISC-V targets:
21839 @table @gcctabopt
21840 @item -mbranch-cost=@var{n}
21841 @opindex mbranch-cost
21842 Set the cost of branches to roughly @var{n} instructions.
21844 @item -mplt
21845 @itemx -mno-plt
21846 @opindex plt
21847 When generating PIC code, do or don't allow the use of PLTs. Ignored for
21848 non-PIC.  The default is @option{-mplt}.
21850 @item -mabi=@var{ABI-string}
21851 @opindex mabi
21852 Specify integer and floating-point calling convention.  @var{ABI-string}
21853 contains two parts: the size of integer types and the registers used for
21854 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
21855 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
21856 32-bit), and that floating-point values up to 64 bits wide are passed in F
21857 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
21858 allows the compiler to generate code that uses the F and D extensions but only
21859 allows floating-point values up to 32 bits long to be passed in registers; or
21860 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
21861 passed in registers.
21863 The default for this argument is system dependent, users who want a specific
21864 calling convention should specify one explicitly.  The valid calling
21865 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
21866 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
21867 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
21868 invalid because the ABI requires 64-bit values be passed in F registers, but F
21869 registers are only 32 bits wide.
21871 @item -mfdiv
21872 @itemx -mno-fdiv
21873 @opindex mfdiv
21874 Do or don't use hardware floating-point divide and square root instructions.
21875 This requires the F or D extensions for floating-point registers.  The default
21876 is to use them if the specified architecture has these instructions.
21878 @item -mdiv
21879 @itemx -mno-div
21880 @opindex mdiv
21881 Do or don't use hardware instructions for integer division.  This requires the
21882 M extension.  The default is to use them if the specified architecture has
21883 these instructions.
21885 @item -march=@var{ISA-string}
21886 @opindex march
21887 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21888 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21890 @item -mtune=@var{processor-string}
21891 @opindex mtune
21892 Optimize the output for the given processor, specified by microarchitecture
21893 name.
21895 @item -msmall-data-limit=@var{n}
21896 @opindex msmall-data-limit
21897 Put global and static data smaller than @var{n} bytes into a special section
21898 (on some targets).
21900 @item -msave-restore
21901 @itemx -mno-save-restore
21902 @opindex msave-restore
21903 Do or don't use smaller but slower prologue and epilogue code that uses
21904 library function calls.  The default is to use fast inline prologues and
21905 epilogues.
21907 @item -mstrict-align
21908 @itemx -mno-strict-align
21909 @opindex mstrict-align
21910 Do not or do generate unaligned memory accesses.  The default is set depending
21911 on whether the processor we are optimizing for supports fast unaligned access
21912 or not.
21914 @item -mcmodel=medlow
21915 @opindex mcmodel=medlow
21916 Generate code for the medium-low code model. The program and its statically
21917 defined symbols must lie within a single 2 GiB address range and must lie
21918 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
21919 statically or dynamically linked. This is the default code model.
21921 @item -mcmodel=medany
21922 @opindex mcmodel=medany
21923 Generate code for the medium-any code model. The program and its statically
21924 defined symbols must be within any single 2 GiB address range. Programs can be
21925 statically or dynamically linked.
21927 @item -mexplicit-relocs
21928 @itemx -mno-exlicit-relocs
21929 Use or do not use assembler relocation operators when dealing with symbolic
21930 addresses.  The alternative is to use assembler macros instead, which may
21931 limit optimization.
21933 @end table
21935 @node RL78 Options
21936 @subsection RL78 Options
21937 @cindex RL78 Options
21939 @table @gcctabopt
21941 @item -msim
21942 @opindex msim
21943 Links in additional target libraries to support operation within a
21944 simulator.
21946 @item -mmul=none
21947 @itemx -mmul=g10
21948 @itemx -mmul=g13
21949 @itemx -mmul=g14
21950 @itemx -mmul=rl78
21951 @opindex mmul
21952 Specifies the type of hardware multiplication and division support to
21953 be used.  The simplest is @code{none}, which uses software for both
21954 multiplication and division.  This is the default.  The @code{g13}
21955 value is for the hardware multiply/divide peripheral found on the
21956 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21957 the multiplication and division instructions supported by the RL78/G14
21958 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21959 the value @code{mg10} is an alias for @code{none}.
21961 In addition a C preprocessor macro is defined, based upon the setting
21962 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21963 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21965 @item -mcpu=g10
21966 @itemx -mcpu=g13
21967 @itemx -mcpu=g14
21968 @itemx -mcpu=rl78
21969 @opindex mcpu
21970 Specifies the RL78 core to target.  The default is the G14 core, also
21971 known as an S3 core or just RL78.  The G13 or S2 core does not have
21972 multiply or divide instructions, instead it uses a hardware peripheral
21973 for these operations.  The G10 or S1 core does not have register
21974 banks, so it uses a different calling convention.
21976 If this option is set it also selects the type of hardware multiply
21977 support to use, unless this is overridden by an explicit
21978 @option{-mmul=none} option on the command line.  Thus specifying
21979 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21980 peripheral and specifying @option{-mcpu=g10} disables the use of
21981 hardware multiplications altogether.
21983 Note, although the RL78/G14 core is the default target, specifying
21984 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21985 change the behavior of the toolchain since it also enables G14
21986 hardware multiply support.  If these options are not specified on the
21987 command line then software multiplication routines will be used even
21988 though the code targets the RL78 core.  This is for backwards
21989 compatibility with older toolchains which did not have hardware
21990 multiply and divide support.
21992 In addition a C preprocessor macro is defined, based upon the setting
21993 of this option.  Possible values are: @code{__RL78_G10__},
21994 @code{__RL78_G13__} or @code{__RL78_G14__}.
21996 @item -mg10
21997 @itemx -mg13
21998 @itemx -mg14
21999 @itemx -mrl78
22000 @opindex mg10
22001 @opindex mg13
22002 @opindex mg14
22003 @opindex mrl78
22004 These are aliases for the corresponding @option{-mcpu=} option.  They
22005 are provided for backwards compatibility.
22007 @item -mallregs
22008 @opindex mallregs
22009 Allow the compiler to use all of the available registers.  By default
22010 registers @code{r24..r31} are reserved for use in interrupt handlers.
22011 With this option enabled these registers can be used in ordinary
22012 functions as well.
22014 @item -m64bit-doubles
22015 @itemx -m32bit-doubles
22016 @opindex m64bit-doubles
22017 @opindex m32bit-doubles
22018 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22019 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22020 @option{-m32bit-doubles}.
22022 @item -msave-mduc-in-interrupts
22023 @item -mno-save-mduc-in-interrupts
22024 @opindex msave-mduc-in-interrupts
22025 @opindex mno-save-mduc-in-interrupts
22026 Specifies that interrupt handler functions should preserve the
22027 MDUC registers.  This is only necessary if normal code might use
22028 the MDUC registers, for example because it performs multiplication
22029 and division operations.  The default is to ignore the MDUC registers
22030 as this makes the interrupt handlers faster.  The target option -mg13
22031 needs to be passed for this to work as this feature is only available
22032 on the G13 target (S2 core).  The MDUC registers will only be saved
22033 if the interrupt handler performs a multiplication or division
22034 operation or it calls another function.
22036 @end table
22038 @node RS/6000 and PowerPC Options
22039 @subsection IBM RS/6000 and PowerPC Options
22040 @cindex RS/6000 and PowerPC Options
22041 @cindex IBM RS/6000 and PowerPC Options
22043 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22044 @table @gcctabopt
22045 @item -mpowerpc-gpopt
22046 @itemx -mno-powerpc-gpopt
22047 @itemx -mpowerpc-gfxopt
22048 @itemx -mno-powerpc-gfxopt
22049 @need 800
22050 @itemx -mpowerpc64
22051 @itemx -mno-powerpc64
22052 @itemx -mmfcrf
22053 @itemx -mno-mfcrf
22054 @itemx -mpopcntb
22055 @itemx -mno-popcntb
22056 @itemx -mpopcntd
22057 @itemx -mno-popcntd
22058 @itemx -mfprnd
22059 @itemx -mno-fprnd
22060 @need 800
22061 @itemx -mcmpb
22062 @itemx -mno-cmpb
22063 @itemx -mmfpgpr
22064 @itemx -mno-mfpgpr
22065 @itemx -mhard-dfp
22066 @itemx -mno-hard-dfp
22067 @opindex mpowerpc-gpopt
22068 @opindex mno-powerpc-gpopt
22069 @opindex mpowerpc-gfxopt
22070 @opindex mno-powerpc-gfxopt
22071 @opindex mpowerpc64
22072 @opindex mno-powerpc64
22073 @opindex mmfcrf
22074 @opindex mno-mfcrf
22075 @opindex mpopcntb
22076 @opindex mno-popcntb
22077 @opindex mpopcntd
22078 @opindex mno-popcntd
22079 @opindex mfprnd
22080 @opindex mno-fprnd
22081 @opindex mcmpb
22082 @opindex mno-cmpb
22083 @opindex mmfpgpr
22084 @opindex mno-mfpgpr
22085 @opindex mhard-dfp
22086 @opindex mno-hard-dfp
22087 You use these options to specify which instructions are available on the
22088 processor you are using.  The default value of these options is
22089 determined when configuring GCC@.  Specifying the
22090 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22091 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22092 rather than the options listed above.
22094 Specifying @option{-mpowerpc-gpopt} allows
22095 GCC to use the optional PowerPC architecture instructions in the
22096 General Purpose group, including floating-point square root.  Specifying
22097 @option{-mpowerpc-gfxopt} allows GCC to
22098 use the optional PowerPC architecture instructions in the Graphics
22099 group, including floating-point select.
22101 The @option{-mmfcrf} option allows GCC to generate the move from
22102 condition register field instruction implemented on the POWER4
22103 processor and other processors that support the PowerPC V2.01
22104 architecture.
22105 The @option{-mpopcntb} option allows GCC to generate the popcount and
22106 double-precision FP reciprocal estimate instruction implemented on the
22107 POWER5 processor and other processors that support the PowerPC V2.02
22108 architecture.
22109 The @option{-mpopcntd} option allows GCC to generate the popcount
22110 instruction implemented on the POWER7 processor and other processors
22111 that support the PowerPC V2.06 architecture.
22112 The @option{-mfprnd} option allows GCC to generate the FP round to
22113 integer instructions implemented on the POWER5+ processor and other
22114 processors that support the PowerPC V2.03 architecture.
22115 The @option{-mcmpb} option allows GCC to generate the compare bytes
22116 instruction implemented on the POWER6 processor and other processors
22117 that support the PowerPC V2.05 architecture.
22118 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22119 general-purpose register instructions implemented on the POWER6X
22120 processor and other processors that support the extended PowerPC V2.05
22121 architecture.
22122 The @option{-mhard-dfp} option allows GCC to generate the decimal
22123 floating-point instructions implemented on some POWER processors.
22125 The @option{-mpowerpc64} option allows GCC to generate the additional
22126 64-bit instructions that are found in the full PowerPC64 architecture
22127 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22128 @option{-mno-powerpc64}.
22130 @item -mcpu=@var{cpu_type}
22131 @opindex mcpu
22132 Set architecture type, register usage, and
22133 instruction scheduling parameters for machine type @var{cpu_type}.
22134 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22135 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22136 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22137 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22138 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22139 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22140 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22141 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22142 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22143 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22144 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22145 and @samp{rs64}.
22147 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22148 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22149 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22150 architecture machine types, with an appropriate, generic processor
22151 model assumed for scheduling purposes.
22153 The other options specify a specific processor.  Code generated under
22154 those options runs best on that processor, and may not run at all on
22155 others.
22157 The @option{-mcpu} options automatically enable or disable the
22158 following options:
22160 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22161 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22162 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22163 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22164 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22165 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22167 The particular options set for any particular CPU varies between
22168 compiler versions, depending on what setting seems to produce optimal
22169 code for that CPU; it doesn't necessarily reflect the actual hardware's
22170 capabilities.  If you wish to set an individual option to a particular
22171 value, you may specify it after the @option{-mcpu} option, like
22172 @option{-mcpu=970 -mno-altivec}.
22174 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22175 not enabled or disabled by the @option{-mcpu} option at present because
22176 AIX does not have full support for these options.  You may still
22177 enable or disable them individually if you're sure it'll work in your
22178 environment.
22180 @item -mtune=@var{cpu_type}
22181 @opindex mtune
22182 Set the instruction scheduling parameters for machine type
22183 @var{cpu_type}, but do not set the architecture type or register usage,
22184 as @option{-mcpu=@var{cpu_type}} does.  The same
22185 values for @var{cpu_type} are used for @option{-mtune} as for
22186 @option{-mcpu}.  If both are specified, the code generated uses the
22187 architecture and registers set by @option{-mcpu}, but the
22188 scheduling parameters set by @option{-mtune}.
22190 @item -mcmodel=small
22191 @opindex mcmodel=small
22192 Generate PowerPC64 code for the small model: The TOC is limited to
22193 64k.
22195 @item -mcmodel=medium
22196 @opindex mcmodel=medium
22197 Generate PowerPC64 code for the medium model: The TOC and other static
22198 data may be up to a total of 4G in size.  This is the default for 64-bit
22199 Linux.
22201 @item -mcmodel=large
22202 @opindex mcmodel=large
22203 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22204 in size.  Other data and code is only limited by the 64-bit address
22205 space.
22207 @item -maltivec
22208 @itemx -mno-altivec
22209 @opindex maltivec
22210 @opindex mno-altivec
22211 Generate code that uses (does not use) AltiVec instructions, and also
22212 enable the use of built-in functions that allow more direct access to
22213 the AltiVec instruction set.  You may also need to set
22214 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22215 enhancements.
22217 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22218 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22219 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22220 match array element order corresponding to the endianness of the
22221 target.  That is, element zero identifies the leftmost element in a
22222 vector register when targeting a big-endian platform, and identifies
22223 the rightmost element in a vector register when targeting a
22224 little-endian platform.
22226 @item -maltivec=be
22227 @opindex maltivec=be
22228 Generate AltiVec instructions using big-endian element order,
22229 regardless of whether the target is big- or little-endian.  This is
22230 the default when targeting a big-endian platform.
22232 The element order is used to interpret element numbers in AltiVec
22233 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22234 @code{vec_insert}.  By default, these match array element order
22235 corresponding to the endianness for the target.
22237 @item -maltivec=le
22238 @opindex maltivec=le
22239 Generate AltiVec instructions using little-endian element order,
22240 regardless of whether the target is big- or little-endian.  This is
22241 the default when targeting a little-endian platform.  This option is
22242 currently ignored when targeting a big-endian platform.
22244 The element order is used to interpret element numbers in AltiVec
22245 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22246 @code{vec_insert}.  By default, these match array element order
22247 corresponding to the endianness for the target.
22249 @item -mvrsave
22250 @itemx -mno-vrsave
22251 @opindex mvrsave
22252 @opindex mno-vrsave
22253 Generate VRSAVE instructions when generating AltiVec code.
22255 @item -msecure-plt
22256 @opindex msecure-plt
22257 Generate code that allows @command{ld} and @command{ld.so}
22258 to build executables and shared
22259 libraries with non-executable @code{.plt} and @code{.got} sections.
22260 This is a PowerPC
22261 32-bit SYSV ABI option.
22263 @item -mbss-plt
22264 @opindex mbss-plt
22265 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22266 fills in, and
22267 requires @code{.plt} and @code{.got}
22268 sections that are both writable and executable.
22269 This is a PowerPC 32-bit SYSV ABI option.
22271 @item -misel
22272 @itemx -mno-isel
22273 @opindex misel
22274 @opindex mno-isel
22275 This switch enables or disables the generation of ISEL instructions.
22277 @item -misel=@var{yes/no}
22278 This switch has been deprecated.  Use @option{-misel} and
22279 @option{-mno-isel} instead.
22281 @item -mspe
22282 @itemx -mno-spe
22283 @opindex mspe
22284 @opindex mno-spe
22285 This switch enables or disables the generation of SPE simd
22286 instructions.
22288 @item -mpaired
22289 @itemx -mno-paired
22290 @opindex mpaired
22291 @opindex mno-paired
22292 This switch enables or disables the generation of PAIRED simd
22293 instructions.
22295 @item -mspe=@var{yes/no}
22296 This option has been deprecated.  Use @option{-mspe} and
22297 @option{-mno-spe} instead.
22299 @item -mvsx
22300 @itemx -mno-vsx
22301 @opindex mvsx
22302 @opindex mno-vsx
22303 Generate code that uses (does not use) vector/scalar (VSX)
22304 instructions, and also enable the use of built-in functions that allow
22305 more direct access to the VSX instruction set.
22307 @item -mcrypto
22308 @itemx -mno-crypto
22309 @opindex mcrypto
22310 @opindex mno-crypto
22311 Enable the use (disable) of the built-in functions that allow direct
22312 access to the cryptographic instructions that were added in version
22313 2.07 of the PowerPC ISA.
22315 @item -mdirect-move
22316 @itemx -mno-direct-move
22317 @opindex mdirect-move
22318 @opindex mno-direct-move
22319 Generate code that uses (does not use) the instructions to move data
22320 between the general purpose registers and the vector/scalar (VSX)
22321 registers that were added in version 2.07 of the PowerPC ISA.
22323 @item -mhtm
22324 @itemx -mno-htm
22325 @opindex mhtm
22326 @opindex mno-htm
22327 Enable (disable) the use of the built-in functions that allow direct
22328 access to the Hardware Transactional Memory (HTM) instructions that
22329 were added in version 2.07 of the PowerPC ISA.
22331 @item -mpower8-fusion
22332 @itemx -mno-power8-fusion
22333 @opindex mpower8-fusion
22334 @opindex mno-power8-fusion
22335 Generate code that keeps (does not keeps) some integer operations
22336 adjacent so that the instructions can be fused together on power8 and
22337 later processors.
22339 @item -mpower8-vector
22340 @itemx -mno-power8-vector
22341 @opindex mpower8-vector
22342 @opindex mno-power8-vector
22343 Generate code that uses (does not use) the vector and scalar
22344 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22345 enable the use of built-in functions that allow more direct access to
22346 the vector instructions.
22348 @item -mquad-memory
22349 @itemx -mno-quad-memory
22350 @opindex mquad-memory
22351 @opindex mno-quad-memory
22352 Generate code that uses (does not use) the non-atomic quad word memory
22353 instructions.  The @option{-mquad-memory} option requires use of
22354 64-bit mode.
22356 @item -mquad-memory-atomic
22357 @itemx -mno-quad-memory-atomic
22358 @opindex mquad-memory-atomic
22359 @opindex mno-quad-memory-atomic
22360 Generate code that uses (does not use) the atomic quad word memory
22361 instructions.  The @option{-mquad-memory-atomic} option requires use of
22362 64-bit mode.
22364 @item -mfloat128
22365 @itemx -mno-float128
22366 @opindex mfloat128
22367 @opindex mno-float128
22368 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22369 and use either software emulation for IEEE 128-bit floating point or
22370 hardware instructions.
22372 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22373 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22374 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22375 floating point support only works on PowerPC Linux systems.
22377 The default for @option{-mfloat128} is enabled on PowerPC Linux
22378 systems using the VSX instruction set, and disabled on other systems.
22380 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22381 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22382 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22383 floating point instructions.  Otherwise, if you do not specify to
22384 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22385 system, IEEE 128-bit floating point will be done with software
22386 emulation.
22388 @item -mfloat128-hardware
22389 @itemx -mno-float128-hardware
22390 @opindex mfloat128-hardware
22391 @opindex mno-float128-hardware
22392 Enable/disable using ISA 3.0 hardware instructions to support the
22393 @var{__float128} data type.
22395 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22396 Linux systems using the ISA 3.0 instruction set, and disabled on other
22397 systems.
22399 @item -mfloat-gprs=@var{yes/single/double/no}
22400 @itemx -mfloat-gprs
22401 @opindex mfloat-gprs
22402 This switch enables or disables the generation of floating-point
22403 operations on the general-purpose registers for architectures that
22404 support it.
22406 The argument @samp{yes} or @samp{single} enables the use of
22407 single-precision floating-point operations.
22409 The argument @samp{double} enables the use of single and
22410 double-precision floating-point operations.
22412 The argument @samp{no} disables floating-point operations on the
22413 general-purpose registers.
22415 This option is currently only available on the MPC854x.
22417 @item -m32
22418 @itemx -m64
22419 @opindex m32
22420 @opindex m64
22421 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22422 targets (including GNU/Linux).  The 32-bit environment sets int, long
22423 and pointer to 32 bits and generates code that runs on any PowerPC
22424 variant.  The 64-bit environment sets int to 32 bits and long and
22425 pointer to 64 bits, and generates code for PowerPC64, as for
22426 @option{-mpowerpc64}.
22428 @item -mfull-toc
22429 @itemx -mno-fp-in-toc
22430 @itemx -mno-sum-in-toc
22431 @itemx -mminimal-toc
22432 @opindex mfull-toc
22433 @opindex mno-fp-in-toc
22434 @opindex mno-sum-in-toc
22435 @opindex mminimal-toc
22436 Modify generation of the TOC (Table Of Contents), which is created for
22437 every executable file.  The @option{-mfull-toc} option is selected by
22438 default.  In that case, GCC allocates at least one TOC entry for
22439 each unique non-automatic variable reference in your program.  GCC
22440 also places floating-point constants in the TOC@.  However, only
22441 16,384 entries are available in the TOC@.
22443 If you receive a linker error message that saying you have overflowed
22444 the available TOC space, you can reduce the amount of TOC space used
22445 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22446 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22447 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22448 generate code to calculate the sum of an address and a constant at
22449 run time instead of putting that sum into the TOC@.  You may specify one
22450 or both of these options.  Each causes GCC to produce very slightly
22451 slower and larger code at the expense of conserving TOC space.
22453 If you still run out of space in the TOC even when you specify both of
22454 these options, specify @option{-mminimal-toc} instead.  This option causes
22455 GCC to make only one TOC entry for every file.  When you specify this
22456 option, GCC produces code that is slower and larger but which
22457 uses extremely little TOC space.  You may wish to use this option
22458 only on files that contain less frequently-executed code.
22460 @item -maix64
22461 @itemx -maix32
22462 @opindex maix64
22463 @opindex maix32
22464 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22465 @code{long} type, and the infrastructure needed to support them.
22466 Specifying @option{-maix64} implies @option{-mpowerpc64},
22467 while @option{-maix32} disables the 64-bit ABI and
22468 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22470 @item -mxl-compat
22471 @itemx -mno-xl-compat
22472 @opindex mxl-compat
22473 @opindex mno-xl-compat
22474 Produce code that conforms more closely to IBM XL compiler semantics
22475 when using AIX-compatible ABI@.  Pass floating-point arguments to
22476 prototyped functions beyond the register save area (RSA) on the stack
22477 in addition to argument FPRs.  Do not assume that most significant
22478 double in 128-bit long double value is properly rounded when comparing
22479 values and converting to double.  Use XL symbol names for long double
22480 support routines.
22482 The AIX calling convention was extended but not initially documented to
22483 handle an obscure K&R C case of calling a function that takes the
22484 address of its arguments with fewer arguments than declared.  IBM XL
22485 compilers access floating-point arguments that do not fit in the
22486 RSA from the stack when a subroutine is compiled without
22487 optimization.  Because always storing floating-point arguments on the
22488 stack is inefficient and rarely needed, this option is not enabled by
22489 default and only is necessary when calling subroutines compiled by IBM
22490 XL compilers without optimization.
22492 @item -mpe
22493 @opindex mpe
22494 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22495 application written to use message passing with special startup code to
22496 enable the application to run.  The system must have PE installed in the
22497 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22498 must be overridden with the @option{-specs=} option to specify the
22499 appropriate directory location.  The Parallel Environment does not
22500 support threads, so the @option{-mpe} option and the @option{-pthread}
22501 option are incompatible.
22503 @item -malign-natural
22504 @itemx -malign-power
22505 @opindex malign-natural
22506 @opindex malign-power
22507 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22508 @option{-malign-natural} overrides the ABI-defined alignment of larger
22509 types, such as floating-point doubles, on their natural size-based boundary.
22510 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22511 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22513 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22514 is not supported.
22516 @item -msoft-float
22517 @itemx -mhard-float
22518 @opindex msoft-float
22519 @opindex mhard-float
22520 Generate code that does not use (uses) the floating-point register set.
22521 Software floating-point emulation is provided if you use the
22522 @option{-msoft-float} option, and pass the option to GCC when linking.
22524 @item -msingle-float
22525 @itemx -mdouble-float
22526 @opindex msingle-float
22527 @opindex mdouble-float
22528 Generate code for single- or double-precision floating-point operations.
22529 @option{-mdouble-float} implies @option{-msingle-float}.
22531 @item -msimple-fpu
22532 @opindex msimple-fpu
22533 Do not generate @code{sqrt} and @code{div} instructions for hardware
22534 floating-point unit.
22536 @item -mfpu=@var{name}
22537 @opindex mfpu
22538 Specify type of floating-point unit.  Valid values for @var{name} are
22539 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22540 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22541 @samp{sp_full} (equivalent to @option{-msingle-float}),
22542 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22544 @item -mxilinx-fpu
22545 @opindex mxilinx-fpu
22546 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22548 @item -mmultiple
22549 @itemx -mno-multiple
22550 @opindex mmultiple
22551 @opindex mno-multiple
22552 Generate code that uses (does not use) the load multiple word
22553 instructions and the store multiple word instructions.  These
22554 instructions are generated by default on POWER systems, and not
22555 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22556 PowerPC systems, since those instructions do not work when the
22557 processor is in little-endian mode.  The exceptions are PPC740 and
22558 PPC750 which permit these instructions in little-endian mode.
22560 @item -mstring
22561 @itemx -mno-string
22562 @opindex mstring
22563 @opindex mno-string
22564 Generate code that uses (does not use) the load string instructions
22565 and the store string word instructions to save multiple registers and
22566 do small block moves.  These instructions are generated by default on
22567 POWER systems, and not generated on PowerPC systems.  Do not use
22568 @option{-mstring} on little-endian PowerPC systems, since those
22569 instructions do not work when the processor is in little-endian mode.
22570 The exceptions are PPC740 and PPC750 which permit these instructions
22571 in little-endian mode.
22573 @item -mupdate
22574 @itemx -mno-update
22575 @opindex mupdate
22576 @opindex mno-update
22577 Generate code that uses (does not use) the load or store instructions
22578 that update the base register to the address of the calculated memory
22579 location.  These instructions are generated by default.  If you use
22580 @option{-mno-update}, there is a small window between the time that the
22581 stack pointer is updated and the address of the previous frame is
22582 stored, which means code that walks the stack frame across interrupts or
22583 signals may get corrupted data.
22585 @item -mavoid-indexed-addresses
22586 @itemx -mno-avoid-indexed-addresses
22587 @opindex mavoid-indexed-addresses
22588 @opindex mno-avoid-indexed-addresses
22589 Generate code that tries to avoid (not avoid) the use of indexed load
22590 or store instructions. These instructions can incur a performance
22591 penalty on Power6 processors in certain situations, such as when
22592 stepping through large arrays that cross a 16M boundary.  This option
22593 is enabled by default when targeting Power6 and disabled otherwise.
22595 @item -mfused-madd
22596 @itemx -mno-fused-madd
22597 @opindex mfused-madd
22598 @opindex mno-fused-madd
22599 Generate code that uses (does not use) the floating-point multiply and
22600 accumulate instructions.  These instructions are generated by default
22601 if hardware floating point is used.  The machine-dependent
22602 @option{-mfused-madd} option is now mapped to the machine-independent
22603 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22604 mapped to @option{-ffp-contract=off}.
22606 @item -mmulhw
22607 @itemx -mno-mulhw
22608 @opindex mmulhw
22609 @opindex mno-mulhw
22610 Generate code that uses (does not use) the half-word multiply and
22611 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22612 These instructions are generated by default when targeting those
22613 processors.
22615 @item -mdlmzb
22616 @itemx -mno-dlmzb
22617 @opindex mdlmzb
22618 @opindex mno-dlmzb
22619 Generate code that uses (does not use) the string-search @samp{dlmzb}
22620 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22621 generated by default when targeting those processors.
22623 @item -mno-bit-align
22624 @itemx -mbit-align
22625 @opindex mno-bit-align
22626 @opindex mbit-align
22627 On System V.4 and embedded PowerPC systems do not (do) force structures
22628 and unions that contain bit-fields to be aligned to the base type of the
22629 bit-field.
22631 For example, by default a structure containing nothing but 8
22632 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22633 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22634 the structure is aligned to a 1-byte boundary and is 1 byte in
22635 size.
22637 @item -mno-strict-align
22638 @itemx -mstrict-align
22639 @opindex mno-strict-align
22640 @opindex mstrict-align
22641 On System V.4 and embedded PowerPC systems do not (do) assume that
22642 unaligned memory references are handled by the system.
22644 @item -mrelocatable
22645 @itemx -mno-relocatable
22646 @opindex mrelocatable
22647 @opindex mno-relocatable
22648 Generate code that allows (does not allow) a static executable to be
22649 relocated to a different address at run time.  A simple embedded
22650 PowerPC system loader should relocate the entire contents of
22651 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22652 a table of 32-bit addresses generated by this option.  For this to
22653 work, all objects linked together must be compiled with
22654 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22655 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22657 @item -mrelocatable-lib
22658 @itemx -mno-relocatable-lib
22659 @opindex mrelocatable-lib
22660 @opindex mno-relocatable-lib
22661 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22662 @code{.fixup} section to allow static executables to be relocated at
22663 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22664 alignment of @option{-mrelocatable}.  Objects compiled with
22665 @option{-mrelocatable-lib} may be linked with objects compiled with
22666 any combination of the @option{-mrelocatable} options.
22668 @item -mno-toc
22669 @itemx -mtoc
22670 @opindex mno-toc
22671 @opindex mtoc
22672 On System V.4 and embedded PowerPC systems do not (do) assume that
22673 register 2 contains a pointer to a global area pointing to the addresses
22674 used in the program.
22676 @item -mlittle
22677 @itemx -mlittle-endian
22678 @opindex mlittle
22679 @opindex mlittle-endian
22680 On System V.4 and embedded PowerPC systems compile code for the
22681 processor in little-endian mode.  The @option{-mlittle-endian} option is
22682 the same as @option{-mlittle}.
22684 @item -mbig
22685 @itemx -mbig-endian
22686 @opindex mbig
22687 @opindex mbig-endian
22688 On System V.4 and embedded PowerPC systems compile code for the
22689 processor in big-endian mode.  The @option{-mbig-endian} option is
22690 the same as @option{-mbig}.
22692 @item -mdynamic-no-pic
22693 @opindex mdynamic-no-pic
22694 On Darwin and Mac OS X systems, compile code so that it is not
22695 relocatable, but that its external references are relocatable.  The
22696 resulting code is suitable for applications, but not shared
22697 libraries.
22699 @item -msingle-pic-base
22700 @opindex msingle-pic-base
22701 Treat the register used for PIC addressing as read-only, rather than
22702 loading it in the prologue for each function.  The runtime system is
22703 responsible for initializing this register with an appropriate value
22704 before execution begins.
22706 @item -mprioritize-restricted-insns=@var{priority}
22707 @opindex mprioritize-restricted-insns
22708 This option controls the priority that is assigned to
22709 dispatch-slot restricted instructions during the second scheduling
22710 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22711 or @samp{2} to assign no, highest, or second-highest (respectively) 
22712 priority to dispatch-slot restricted
22713 instructions.
22715 @item -msched-costly-dep=@var{dependence_type}
22716 @opindex msched-costly-dep
22717 This option controls which dependences are considered costly
22718 by the target during instruction scheduling.  The argument
22719 @var{dependence_type} takes one of the following values:
22721 @table @asis
22722 @item @samp{no}
22723 No dependence is costly.
22725 @item @samp{all}
22726 All dependences are costly.
22728 @item @samp{true_store_to_load}
22729 A true dependence from store to load is costly.
22731 @item @samp{store_to_load}
22732 Any dependence from store to load is costly.
22734 @item @var{number}
22735 Any dependence for which the latency is greater than or equal to 
22736 @var{number} is costly.
22737 @end table
22739 @item -minsert-sched-nops=@var{scheme}
22740 @opindex minsert-sched-nops
22741 This option controls which NOP insertion scheme is used during
22742 the second scheduling pass.  The argument @var{scheme} takes one of the
22743 following values:
22745 @table @asis
22746 @item @samp{no}
22747 Don't insert NOPs.
22749 @item @samp{pad}
22750 Pad with NOPs any dispatch group that has vacant issue slots,
22751 according to the scheduler's grouping.
22753 @item @samp{regroup_exact}
22754 Insert NOPs to force costly dependent insns into
22755 separate groups.  Insert exactly as many NOPs as needed to force an insn
22756 to a new group, according to the estimated processor grouping.
22758 @item @var{number}
22759 Insert NOPs to force costly dependent insns into
22760 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22761 @end table
22763 @item -mcall-sysv
22764 @opindex mcall-sysv
22765 On System V.4 and embedded PowerPC systems compile code using calling
22766 conventions that adhere to the March 1995 draft of the System V
22767 Application Binary Interface, PowerPC processor supplement.  This is the
22768 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22770 @item -mcall-sysv-eabi
22771 @itemx -mcall-eabi
22772 @opindex mcall-sysv-eabi
22773 @opindex mcall-eabi
22774 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22776 @item -mcall-sysv-noeabi
22777 @opindex mcall-sysv-noeabi
22778 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22780 @item -mcall-aixdesc
22781 @opindex m
22782 On System V.4 and embedded PowerPC systems compile code for the AIX
22783 operating system.
22785 @item -mcall-linux
22786 @opindex mcall-linux
22787 On System V.4 and embedded PowerPC systems compile code for the
22788 Linux-based GNU system.
22790 @item -mcall-freebsd
22791 @opindex mcall-freebsd
22792 On System V.4 and embedded PowerPC systems compile code for the
22793 FreeBSD operating system.
22795 @item -mcall-netbsd
22796 @opindex mcall-netbsd
22797 On System V.4 and embedded PowerPC systems compile code for the
22798 NetBSD operating system.
22800 @item -mcall-openbsd
22801 @opindex mcall-netbsd
22802 On System V.4 and embedded PowerPC systems compile code for the
22803 OpenBSD operating system.
22805 @item -maix-struct-return
22806 @opindex maix-struct-return
22807 Return all structures in memory (as specified by the AIX ABI)@.
22809 @item -msvr4-struct-return
22810 @opindex msvr4-struct-return
22811 Return structures smaller than 8 bytes in registers (as specified by the
22812 SVR4 ABI)@.
22814 @item -mabi=@var{abi-type}
22815 @opindex mabi
22816 Extend the current ABI with a particular extension, or remove such extension.
22817 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22818 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22819 @samp{elfv1}, @samp{elfv2}@.
22821 @item -mabi=spe
22822 @opindex mabi=spe
22823 Extend the current ABI with SPE ABI extensions.  This does not change
22824 the default ABI, instead it adds the SPE ABI extensions to the current
22825 ABI@.
22827 @item -mabi=no-spe
22828 @opindex mabi=no-spe
22829 Disable Book-E SPE ABI extensions for the current ABI@.
22831 @item -mabi=ibmlongdouble
22832 @opindex mabi=ibmlongdouble
22833 Change the current ABI to use IBM extended-precision long double.
22834 This is not likely to work if your system defaults to using IEEE
22835 extended-precision long double.  If you change the long double type
22836 from IEEE extended-precision, the compiler will issue a warning unless
22837 you use the @option{-Wno-psabi} option.
22839 @item -mabi=ieeelongdouble
22840 @opindex mabi=ieeelongdouble
22841 Change the current ABI to use IEEE extended-precision long double.
22842 This is not likely to work if your system defaults to using IBM
22843 extended-precision long double.  If you change the long double type
22844 from IBM extended-precision, the compiler will issue a warning unless
22845 you use the @option{-Wno-psabi} option.
22847 @item -mabi=elfv1
22848 @opindex mabi=elfv1
22849 Change the current ABI to use the ELFv1 ABI.
22850 This is the default ABI for big-endian PowerPC 64-bit Linux.
22851 Overriding the default ABI requires special system support and is
22852 likely to fail in spectacular ways.
22854 @item -mabi=elfv2
22855 @opindex mabi=elfv2
22856 Change the current ABI to use the ELFv2 ABI.
22857 This is the default ABI for little-endian PowerPC 64-bit Linux.
22858 Overriding the default ABI requires special system support and is
22859 likely to fail in spectacular ways.
22861 @item -mgnu-attribute
22862 @itemx -mno-gnu-attribute
22863 @opindex mgnu-attribute
22864 @opindex mno-gnu-attribute
22865 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22866 .gnu.attributes section that specify ABI variations in function
22867 parameters or return values.
22869 @item -mprototype
22870 @itemx -mno-prototype
22871 @opindex mprototype
22872 @opindex mno-prototype
22873 On System V.4 and embedded PowerPC systems assume that all calls to
22874 variable argument functions are properly prototyped.  Otherwise, the
22875 compiler must insert an instruction before every non-prototyped call to
22876 set or clear bit 6 of the condition code register (@code{CR}) to
22877 indicate whether floating-point values are passed in the floating-point
22878 registers in case the function takes variable arguments.  With
22879 @option{-mprototype}, only calls to prototyped variable argument functions
22880 set or clear the bit.
22882 @item -msim
22883 @opindex msim
22884 On embedded PowerPC systems, assume that the startup module is called
22885 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22886 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22887 configurations.
22889 @item -mmvme
22890 @opindex mmvme
22891 On embedded PowerPC systems, assume that the startup module is called
22892 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22893 @file{libc.a}.
22895 @item -mads
22896 @opindex mads
22897 On embedded PowerPC systems, assume that the startup module is called
22898 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22899 @file{libc.a}.
22901 @item -myellowknife
22902 @opindex myellowknife
22903 On embedded PowerPC systems, assume that the startup module is called
22904 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22905 @file{libc.a}.
22907 @item -mvxworks
22908 @opindex mvxworks
22909 On System V.4 and embedded PowerPC systems, specify that you are
22910 compiling for a VxWorks system.
22912 @item -memb
22913 @opindex memb
22914 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22915 header to indicate that @samp{eabi} extended relocations are used.
22917 @item -meabi
22918 @itemx -mno-eabi
22919 @opindex meabi
22920 @opindex mno-eabi
22921 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22922 Embedded Applications Binary Interface (EABI), which is a set of
22923 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22924 means that the stack is aligned to an 8-byte boundary, a function
22925 @code{__eabi} is called from @code{main} to set up the EABI
22926 environment, and the @option{-msdata} option can use both @code{r2} and
22927 @code{r13} to point to two separate small data areas.  Selecting
22928 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22929 no EABI initialization function is called from @code{main}, and the
22930 @option{-msdata} option only uses @code{r13} to point to a single
22931 small data area.  The @option{-meabi} option is on by default if you
22932 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22934 @item -msdata=eabi
22935 @opindex msdata=eabi
22936 On System V.4 and embedded PowerPC systems, put small initialized
22937 @code{const} global and static data in the @code{.sdata2} section, which
22938 is pointed to by register @code{r2}.  Put small initialized
22939 non-@code{const} global and static data in the @code{.sdata} section,
22940 which is pointed to by register @code{r13}.  Put small uninitialized
22941 global and static data in the @code{.sbss} section, which is adjacent to
22942 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22943 incompatible with the @option{-mrelocatable} option.  The
22944 @option{-msdata=eabi} option also sets the @option{-memb} option.
22946 @item -msdata=sysv
22947 @opindex msdata=sysv
22948 On System V.4 and embedded PowerPC systems, put small global and static
22949 data in the @code{.sdata} section, which is pointed to by register
22950 @code{r13}.  Put small uninitialized global and static data in the
22951 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22952 The @option{-msdata=sysv} option is incompatible with the
22953 @option{-mrelocatable} option.
22955 @item -msdata=default
22956 @itemx -msdata
22957 @opindex msdata=default
22958 @opindex msdata
22959 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22960 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22961 same as @option{-msdata=sysv}.
22963 @item -msdata=data
22964 @opindex msdata=data
22965 On System V.4 and embedded PowerPC systems, put small global
22966 data in the @code{.sdata} section.  Put small uninitialized global
22967 data in the @code{.sbss} section.  Do not use register @code{r13}
22968 to address small data however.  This is the default behavior unless
22969 other @option{-msdata} options are used.
22971 @item -msdata=none
22972 @itemx -mno-sdata
22973 @opindex msdata=none
22974 @opindex mno-sdata
22975 On embedded PowerPC systems, put all initialized global and static data
22976 in the @code{.data} section, and all uninitialized data in the
22977 @code{.bss} section.
22979 @item -mblock-move-inline-limit=@var{num}
22980 @opindex mblock-move-inline-limit
22981 Inline all block moves (such as calls to @code{memcpy} or structure
22982 copies) less than or equal to @var{num} bytes.  The minimum value for
22983 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22984 targets.  The default value is target-specific.
22986 @item -G @var{num}
22987 @opindex G
22988 @cindex smaller data references (PowerPC)
22989 @cindex .sdata/.sdata2 references (PowerPC)
22990 On embedded PowerPC systems, put global and static items less than or
22991 equal to @var{num} bytes into the small data or BSS sections instead of
22992 the normal data or BSS section.  By default, @var{num} is 8.  The
22993 @option{-G @var{num}} switch is also passed to the linker.
22994 All modules should be compiled with the same @option{-G @var{num}} value.
22996 @item -mregnames
22997 @itemx -mno-regnames
22998 @opindex mregnames
22999 @opindex mno-regnames
23000 On System V.4 and embedded PowerPC systems do (do not) emit register
23001 names in the assembly language output using symbolic forms.
23003 @item -mlongcall
23004 @itemx -mno-longcall
23005 @opindex mlongcall
23006 @opindex mno-longcall
23007 By default assume that all calls are far away so that a longer and more
23008 expensive calling sequence is required.  This is required for calls
23009 farther than 32 megabytes (33,554,432 bytes) from the current location.
23010 A short call is generated if the compiler knows
23011 the call cannot be that far away.  This setting can be overridden by
23012 the @code{shortcall} function attribute, or by @code{#pragma
23013 longcall(0)}.
23015 Some linkers are capable of detecting out-of-range calls and generating
23016 glue code on the fly.  On these systems, long calls are unnecessary and
23017 generate slower code.  As of this writing, the AIX linker can do this,
23018 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23019 to the GNU linker for 32-bit PowerPC systems as well.
23021 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23022 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23023 addresses represent the callee and the branch island.  The
23024 Darwin/PPC linker prefers the first address and generates a @code{bl
23025 callee} if the PPC @code{bl} instruction reaches the callee directly;
23026 otherwise, the linker generates @code{bl L42} to call the branch
23027 island.  The branch island is appended to the body of the
23028 calling function; it computes the full 32-bit address of the callee
23029 and jumps to it.
23031 On Mach-O (Darwin) systems, this option directs the compiler emit to
23032 the glue for every direct call, and the Darwin linker decides whether
23033 to use or discard it.
23035 In the future, GCC may ignore all longcall specifications
23036 when the linker is known to generate glue.
23038 @item -mtls-markers
23039 @itemx -mno-tls-markers
23040 @opindex mtls-markers
23041 @opindex mno-tls-markers
23042 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23043 specifying the function argument.  The relocation allows the linker to
23044 reliably associate function call with argument setup instructions for
23045 TLS optimization, which in turn allows GCC to better schedule the
23046 sequence.
23048 @item -mrecip
23049 @itemx -mno-recip
23050 @opindex mrecip
23051 This option enables use of the reciprocal estimate and
23052 reciprocal square root estimate instructions with additional
23053 Newton-Raphson steps to increase precision instead of doing a divide or
23054 square root and divide for floating-point arguments.  You should use
23055 the @option{-ffast-math} option when using @option{-mrecip} (or at
23056 least @option{-funsafe-math-optimizations},
23057 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23058 @option{-fno-trapping-math}).  Note that while the throughput of the
23059 sequence is generally higher than the throughput of the non-reciprocal
23060 instruction, the precision of the sequence can be decreased by up to 2
23061 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23062 roots.
23064 @item -mrecip=@var{opt}
23065 @opindex mrecip=opt
23066 This option controls which reciprocal estimate instructions
23067 may be used.  @var{opt} is a comma-separated list of options, which may
23068 be preceded by a @code{!} to invert the option:
23070 @table @samp
23072 @item all
23073 Enable all estimate instructions.
23075 @item default 
23076 Enable the default instructions, equivalent to @option{-mrecip}.
23078 @item none 
23079 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23081 @item div 
23082 Enable the reciprocal approximation instructions for both 
23083 single and double precision.
23085 @item divf 
23086 Enable the single-precision reciprocal approximation instructions.
23088 @item divd 
23089 Enable the double-precision reciprocal approximation instructions.
23091 @item rsqrt 
23092 Enable the reciprocal square root approximation instructions for both
23093 single and double precision.
23095 @item rsqrtf 
23096 Enable the single-precision reciprocal square root approximation instructions.
23098 @item rsqrtd 
23099 Enable the double-precision reciprocal square root approximation instructions.
23101 @end table
23103 So, for example, @option{-mrecip=all,!rsqrtd} enables
23104 all of the reciprocal estimate instructions, except for the
23105 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23106 which handle the double-precision reciprocal square root calculations.
23108 @item -mrecip-precision
23109 @itemx -mno-recip-precision
23110 @opindex mrecip-precision
23111 Assume (do not assume) that the reciprocal estimate instructions
23112 provide higher-precision estimates than is mandated by the PowerPC
23113 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23114 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23115 The double-precision square root estimate instructions are not generated by
23116 default on low-precision machines, since they do not provide an
23117 estimate that converges after three steps.
23119 @item -mveclibabi=@var{type}
23120 @opindex mveclibabi
23121 Specifies the ABI type to use for vectorizing intrinsics using an
23122 external library.  The only type supported at present is @samp{mass},
23123 which specifies to use IBM's Mathematical Acceleration Subsystem
23124 (MASS) libraries for vectorizing intrinsics using external libraries.
23125 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23126 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23127 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23128 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23129 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23130 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23131 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23132 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23133 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23134 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23135 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23136 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23137 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23138 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23139 for power7.  Both @option{-ftree-vectorize} and
23140 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23141 libraries must be specified at link time.
23143 @item -mfriz
23144 @itemx -mno-friz
23145 @opindex mfriz
23146 Generate (do not generate) the @code{friz} instruction when the
23147 @option{-funsafe-math-optimizations} option is used to optimize
23148 rounding of floating-point values to 64-bit integer and back to floating
23149 point.  The @code{friz} instruction does not return the same value if
23150 the floating-point number is too large to fit in an integer.
23152 @item -mpointers-to-nested-functions
23153 @itemx -mno-pointers-to-nested-functions
23154 @opindex mpointers-to-nested-functions
23155 Generate (do not generate) code to load up the static chain register
23156 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23157 systems where a function pointer points to a 3-word descriptor giving
23158 the function address, TOC value to be loaded in register @code{r2}, and
23159 static chain value to be loaded in register @code{r11}.  The
23160 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23161 call through pointers to nested functions or pointers
23162 to functions compiled in other languages that use the static chain if
23163 you use @option{-mno-pointers-to-nested-functions}.
23165 @item -msave-toc-indirect
23166 @itemx -mno-save-toc-indirect
23167 @opindex msave-toc-indirect
23168 Generate (do not generate) code to save the TOC value in the reserved
23169 stack location in the function prologue if the function calls through
23170 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23171 saved in the prologue, it is saved just before the call through the
23172 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23174 @item -mcompat-align-parm
23175 @itemx -mno-compat-align-parm
23176 @opindex mcompat-align-parm
23177 Generate (do not generate) code to pass structure parameters with a
23178 maximum alignment of 64 bits, for compatibility with older versions
23179 of GCC.
23181 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23182 structure parameter on a 128-bit boundary when that structure contained
23183 a member requiring 128-bit alignment.  This is corrected in more
23184 recent versions of GCC.  This option may be used to generate code
23185 that is compatible with functions compiled with older versions of
23186 GCC.
23188 The @option{-mno-compat-align-parm} option is the default.
23190 @item -mstack-protector-guard=@var{guard}
23191 @itemx -mstack-protector-guard-reg=@var{reg}
23192 @itemx -mstack-protector-guard-offset=@var{offset}
23193 @itemx -mstack-protector-guard-symbol=@var{symbol}
23194 @opindex mstack-protector-guard
23195 @opindex mstack-protector-guard-reg
23196 @opindex mstack-protector-guard-offset
23197 @opindex mstack-protector-guard-symbol
23198 Generate stack protection code using canary at @var{guard}.  Supported
23199 locations are @samp{global} for global canary or @samp{tls} for per-thread
23200 canary in the TLS block (the default with GNU libc version 2.4 or later).
23202 With the latter choice the options
23203 @option{-mstack-protector-guard-reg=@var{reg}} and
23204 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23205 which register to use as base register for reading the canary, and from what
23206 offset from that base register. The default for those is as specified in the
23207 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23208 the offset with a symbol reference to a canary in the TLS block.
23209 @end table
23211 @node RX Options
23212 @subsection RX Options
23213 @cindex RX Options
23215 These command-line options are defined for RX targets:
23217 @table @gcctabopt
23218 @item -m64bit-doubles
23219 @itemx -m32bit-doubles
23220 @opindex m64bit-doubles
23221 @opindex m32bit-doubles
23222 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23223 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23224 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23225 works on 32-bit values, which is why the default is
23226 @option{-m32bit-doubles}.
23228 @item -fpu
23229 @itemx -nofpu
23230 @opindex fpu
23231 @opindex nofpu
23232 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23233 floating-point hardware.  The default is enabled for the RX600
23234 series and disabled for the RX200 series.
23236 Floating-point instructions are only generated for 32-bit floating-point 
23237 values, however, so the FPU hardware is not used for doubles if the
23238 @option{-m64bit-doubles} option is used.
23240 @emph{Note} If the @option{-fpu} option is enabled then
23241 @option{-funsafe-math-optimizations} is also enabled automatically.
23242 This is because the RX FPU instructions are themselves unsafe.
23244 @item -mcpu=@var{name}
23245 @opindex mcpu
23246 Selects the type of RX CPU to be targeted.  Currently three types are
23247 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23248 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23250 The only difference between @samp{RX600} and @samp{RX610} is that the
23251 @samp{RX610} does not support the @code{MVTIPL} instruction.
23253 The @samp{RX200} series does not have a hardware floating-point unit
23254 and so @option{-nofpu} is enabled by default when this type is
23255 selected.
23257 @item -mbig-endian-data
23258 @itemx -mlittle-endian-data
23259 @opindex mbig-endian-data
23260 @opindex mlittle-endian-data
23261 Store data (but not code) in the big-endian format.  The default is
23262 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23263 format.
23265 @item -msmall-data-limit=@var{N}
23266 @opindex msmall-data-limit
23267 Specifies the maximum size in bytes of global and static variables
23268 which can be placed into the small data area.  Using the small data
23269 area can lead to smaller and faster code, but the size of area is
23270 limited and it is up to the programmer to ensure that the area does
23271 not overflow.  Also when the small data area is used one of the RX's
23272 registers (usually @code{r13}) is reserved for use pointing to this
23273 area, so it is no longer available for use by the compiler.  This
23274 could result in slower and/or larger code if variables are pushed onto
23275 the stack instead of being held in this register.
23277 Note, common variables (variables that have not been initialized) and
23278 constants are not placed into the small data area as they are assigned
23279 to other sections in the output executable.
23281 The default value is zero, which disables this feature.  Note, this
23282 feature is not enabled by default with higher optimization levels
23283 (@option{-O2} etc) because of the potentially detrimental effects of
23284 reserving a register.  It is up to the programmer to experiment and
23285 discover whether this feature is of benefit to their program.  See the
23286 description of the @option{-mpid} option for a description of how the
23287 actual register to hold the small data area pointer is chosen.
23289 @item -msim
23290 @itemx -mno-sim
23291 @opindex msim
23292 @opindex mno-sim
23293 Use the simulator runtime.  The default is to use the libgloss
23294 board-specific runtime.
23296 @item -mas100-syntax
23297 @itemx -mno-as100-syntax
23298 @opindex mas100-syntax
23299 @opindex mno-as100-syntax
23300 When generating assembler output use a syntax that is compatible with
23301 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23302 assembler, but it has some restrictions so it is not generated by default.
23304 @item -mmax-constant-size=@var{N}
23305 @opindex mmax-constant-size
23306 Specifies the maximum size, in bytes, of a constant that can be used as
23307 an operand in a RX instruction.  Although the RX instruction set does
23308 allow constants of up to 4 bytes in length to be used in instructions,
23309 a longer value equates to a longer instruction.  Thus in some
23310 circumstances it can be beneficial to restrict the size of constants
23311 that are used in instructions.  Constants that are too big are instead
23312 placed into a constant pool and referenced via register indirection.
23314 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23315 or 4 means that constants of any size are allowed.
23317 @item -mrelax
23318 @opindex mrelax
23319 Enable linker relaxation.  Linker relaxation is a process whereby the
23320 linker attempts to reduce the size of a program by finding shorter
23321 versions of various instructions.  Disabled by default.
23323 @item -mint-register=@var{N}
23324 @opindex mint-register
23325 Specify the number of registers to reserve for fast interrupt handler
23326 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23327 means that register @code{r13} is reserved for the exclusive use
23328 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23329 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23330 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23331 A value of 0, the default, does not reserve any registers.
23333 @item -msave-acc-in-interrupts
23334 @opindex msave-acc-in-interrupts
23335 Specifies that interrupt handler functions should preserve the
23336 accumulator register.  This is only necessary if normal code might use
23337 the accumulator register, for example because it performs 64-bit
23338 multiplications.  The default is to ignore the accumulator as this
23339 makes the interrupt handlers faster.
23341 @item -mpid
23342 @itemx -mno-pid
23343 @opindex mpid
23344 @opindex mno-pid
23345 Enables the generation of position independent data.  When enabled any
23346 access to constant data is done via an offset from a base address
23347 held in a register.  This allows the location of constant data to be
23348 determined at run time without requiring the executable to be
23349 relocated, which is a benefit to embedded applications with tight
23350 memory constraints.  Data that can be modified is not affected by this
23351 option.
23353 Note, using this feature reserves a register, usually @code{r13}, for
23354 the constant data base address.  This can result in slower and/or
23355 larger code, especially in complicated functions.
23357 The actual register chosen to hold the constant data base address
23358 depends upon whether the @option{-msmall-data-limit} and/or the
23359 @option{-mint-register} command-line options are enabled.  Starting
23360 with register @code{r13} and proceeding downwards, registers are
23361 allocated first to satisfy the requirements of @option{-mint-register},
23362 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23363 is possible for the small data area register to be @code{r8} if both
23364 @option{-mint-register=4} and @option{-mpid} are specified on the
23365 command line.
23367 By default this feature is not enabled.  The default can be restored
23368 via the @option{-mno-pid} command-line option.
23370 @item -mno-warn-multiple-fast-interrupts
23371 @itemx -mwarn-multiple-fast-interrupts
23372 @opindex mno-warn-multiple-fast-interrupts
23373 @opindex mwarn-multiple-fast-interrupts
23374 Prevents GCC from issuing a warning message if it finds more than one
23375 fast interrupt handler when it is compiling a file.  The default is to
23376 issue a warning for each extra fast interrupt handler found, as the RX
23377 only supports one such interrupt.
23379 @item -mallow-string-insns
23380 @itemx -mno-allow-string-insns
23381 @opindex mallow-string-insns
23382 @opindex mno-allow-string-insns
23383 Enables or disables the use of the string manipulation instructions
23384 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23385 @code{SWHILE} and also the @code{RMPA} instruction.  These
23386 instructions may prefetch data, which is not safe to do if accessing
23387 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23388 for more information).
23390 The default is to allow these instructions, but it is not possible for
23391 GCC to reliably detect all circumstances where a string instruction
23392 might be used to access an I/O register, so their use cannot be
23393 disabled automatically.  Instead it is reliant upon the programmer to
23394 use the @option{-mno-allow-string-insns} option if their program
23395 accesses I/O space.
23397 When the instructions are enabled GCC defines the C preprocessor
23398 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23399 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23401 @item -mjsr
23402 @itemx -mno-jsr
23403 @opindex mjsr
23404 @opindex mno-jsr
23405 Use only (or not only) @code{JSR} instructions to access functions.
23406 This option can be used when code size exceeds the range of @code{BSR}
23407 instructions.  Note that @option{-mno-jsr} does not mean to not use
23408 @code{JSR} but instead means that any type of branch may be used.
23409 @end table
23411 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23412 has special significance to the RX port when used with the
23413 @code{interrupt} function attribute.  This attribute indicates a
23414 function intended to process fast interrupts.  GCC ensures
23415 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23416 and/or @code{r13} and only provided that the normal use of the
23417 corresponding registers have been restricted via the
23418 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23419 options.
23421 @node S/390 and zSeries Options
23422 @subsection S/390 and zSeries Options
23423 @cindex S/390 and zSeries Options
23425 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23427 @table @gcctabopt
23428 @item -mhard-float
23429 @itemx -msoft-float
23430 @opindex mhard-float
23431 @opindex msoft-float
23432 Use (do not use) the hardware floating-point instructions and registers
23433 for floating-point operations.  When @option{-msoft-float} is specified,
23434 functions in @file{libgcc.a} are used to perform floating-point
23435 operations.  When @option{-mhard-float} is specified, the compiler
23436 generates IEEE floating-point instructions.  This is the default.
23438 @item -mhard-dfp
23439 @itemx -mno-hard-dfp
23440 @opindex mhard-dfp
23441 @opindex mno-hard-dfp
23442 Use (do not use) the hardware decimal-floating-point instructions for
23443 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23444 specified, functions in @file{libgcc.a} are used to perform
23445 decimal-floating-point operations.  When @option{-mhard-dfp} is
23446 specified, the compiler generates decimal-floating-point hardware
23447 instructions.  This is the default for @option{-march=z9-ec} or higher.
23449 @item -mlong-double-64
23450 @itemx -mlong-double-128
23451 @opindex mlong-double-64
23452 @opindex mlong-double-128
23453 These switches control the size of @code{long double} type. A size
23454 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23455 type. This is the default.
23457 @item -mbackchain
23458 @itemx -mno-backchain
23459 @opindex mbackchain
23460 @opindex mno-backchain
23461 Store (do not store) the address of the caller's frame as backchain pointer
23462 into the callee's stack frame.
23463 A backchain may be needed to allow debugging using tools that do not understand
23464 DWARF call frame information.
23465 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23466 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23467 the backchain is placed into the topmost word of the 96/160 byte register
23468 save area.
23470 In general, code compiled with @option{-mbackchain} is call-compatible with
23471 code compiled with @option{-mmo-backchain}; however, use of the backchain
23472 for debugging purposes usually requires that the whole binary is built with
23473 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23474 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23475 to build a linux kernel use @option{-msoft-float}.
23477 The default is to not maintain the backchain.
23479 @item -mpacked-stack
23480 @itemx -mno-packed-stack
23481 @opindex mpacked-stack
23482 @opindex mno-packed-stack
23483 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23484 specified, the compiler uses the all fields of the 96/160 byte register save
23485 area only for their default purpose; unused fields still take up stack space.
23486 When @option{-mpacked-stack} is specified, register save slots are densely
23487 packed at the top of the register save area; unused space is reused for other
23488 purposes, allowing for more efficient use of the available stack space.
23489 However, when @option{-mbackchain} is also in effect, the topmost word of
23490 the save area is always used to store the backchain, and the return address
23491 register is always saved two words below the backchain.
23493 As long as the stack frame backchain is not used, code generated with
23494 @option{-mpacked-stack} is call-compatible with code generated with
23495 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23496 S/390 or zSeries generated code that uses the stack frame backchain at run
23497 time, not just for debugging purposes.  Such code is not call-compatible
23498 with code compiled with @option{-mpacked-stack}.  Also, note that the
23499 combination of @option{-mbackchain},
23500 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23501 to build a linux kernel use @option{-msoft-float}.
23503 The default is to not use the packed stack layout.
23505 @item -msmall-exec
23506 @itemx -mno-small-exec
23507 @opindex msmall-exec
23508 @opindex mno-small-exec
23509 Generate (or do not generate) code using the @code{bras} instruction
23510 to do subroutine calls.
23511 This only works reliably if the total executable size does not
23512 exceed 64k.  The default is to use the @code{basr} instruction instead,
23513 which does not have this limitation.
23515 @item -m64
23516 @itemx -m31
23517 @opindex m64
23518 @opindex m31
23519 When @option{-m31} is specified, generate code compliant to the
23520 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23521 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23522 particular to generate 64-bit instructions.  For the @samp{s390}
23523 targets, the default is @option{-m31}, while the @samp{s390x}
23524 targets default to @option{-m64}.
23526 @item -mzarch
23527 @itemx -mesa
23528 @opindex mzarch
23529 @opindex mesa
23530 When @option{-mzarch} is specified, generate code using the
23531 instructions available on z/Architecture.
23532 When @option{-mesa} is specified, generate code using the
23533 instructions available on ESA/390.  Note that @option{-mesa} is
23534 not possible with @option{-m64}.
23535 When generating code compliant to the GNU/Linux for S/390 ABI,
23536 the default is @option{-mesa}.  When generating code compliant
23537 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23539 @item -mhtm
23540 @itemx -mno-htm
23541 @opindex mhtm
23542 @opindex mno-htm
23543 The @option{-mhtm} option enables a set of builtins making use of
23544 instructions available with the transactional execution facility
23545 introduced with the IBM zEnterprise EC12 machine generation
23546 @ref{S/390 System z Built-in Functions}.
23547 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23549 @item -mvx
23550 @itemx -mno-vx
23551 @opindex mvx
23552 @opindex mno-vx
23553 When @option{-mvx} is specified, generate code using the instructions
23554 available with the vector extension facility introduced with the IBM
23555 z13 machine generation.
23556 This option changes the ABI for some vector type values with regard to
23557 alignment and calling conventions.  In case vector type values are
23558 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23559 command will be added to mark the resulting binary with the ABI used.
23560 @option{-mvx} is enabled by default when using @option{-march=z13}.
23562 @item -mzvector
23563 @itemx -mno-zvector
23564 @opindex mzvector
23565 @opindex mno-zvector
23566 The @option{-mzvector} option enables vector language extensions and
23567 builtins using instructions available with the vector extension
23568 facility introduced with the IBM z13 machine generation.
23569 This option adds support for @samp{vector} to be used as a keyword to
23570 define vector type variables and arguments.  @samp{vector} is only
23571 available when GNU extensions are enabled.  It will not be expanded
23572 when requesting strict standard compliance e.g. with @option{-std=c99}.
23573 In addition to the GCC low-level builtins @option{-mzvector} enables
23574 a set of builtins added for compatibility with AltiVec-style
23575 implementations like Power and Cell.  In order to make use of these
23576 builtins the header file @file{vecintrin.h} needs to be included.
23577 @option{-mzvector} is disabled by default.
23579 @item -mmvcle
23580 @itemx -mno-mvcle
23581 @opindex mmvcle
23582 @opindex mno-mvcle
23583 Generate (or do not generate) code using the @code{mvcle} instruction
23584 to perform block moves.  When @option{-mno-mvcle} is specified,
23585 use a @code{mvc} loop instead.  This is the default unless optimizing for
23586 size.
23588 @item -mdebug
23589 @itemx -mno-debug
23590 @opindex mdebug
23591 @opindex mno-debug
23592 Print (or do not print) additional debug information when compiling.
23593 The default is to not print debug information.
23595 @item -march=@var{cpu-type}
23596 @opindex march
23597 Generate code that runs on @var{cpu-type}, which is the name of a
23598 system representing a certain processor type.  Possible values for
23599 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23600 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23601 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23602 @samp{native}.
23604 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23605 @samp{g6} are deprecated and will be removed with future releases.
23607 Specifying @samp{native} as cpu type can be used to select the best
23608 architecture option for the host processor.
23609 @option{-march=native} has no effect if GCC does not recognize the
23610 processor.
23612 @item -mtune=@var{cpu-type}
23613 @opindex mtune
23614 Tune to @var{cpu-type} everything applicable about the generated code,
23615 except for the ABI and the set of available instructions.
23616 The list of @var{cpu-type} values is the same as for @option{-march}.
23617 The default is the value used for @option{-march}.
23619 @item -mtpf-trace
23620 @itemx -mno-tpf-trace
23621 @opindex mtpf-trace
23622 @opindex mno-tpf-trace
23623 Generate code that adds (does not add) in TPF OS specific branches to trace
23624 routines in the operating system.  This option is off by default, even
23625 when compiling for the TPF OS@.
23627 @item -mfused-madd
23628 @itemx -mno-fused-madd
23629 @opindex mfused-madd
23630 @opindex mno-fused-madd
23631 Generate code that uses (does not use) the floating-point multiply and
23632 accumulate instructions.  These instructions are generated by default if
23633 hardware floating point is used.
23635 @item -mwarn-framesize=@var{framesize}
23636 @opindex mwarn-framesize
23637 Emit a warning if the current function exceeds the given frame size.  Because
23638 this is a compile-time check it doesn't need to be a real problem when the program
23639 runs.  It is intended to identify functions that most probably cause
23640 a stack overflow.  It is useful to be used in an environment with limited stack
23641 size e.g.@: the linux kernel.
23643 @item -mwarn-dynamicstack
23644 @opindex mwarn-dynamicstack
23645 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23646 arrays.  This is generally a bad idea with a limited stack size.
23648 @item -mstack-guard=@var{stack-guard}
23649 @itemx -mstack-size=@var{stack-size}
23650 @opindex mstack-guard
23651 @opindex mstack-size
23652 If these options are provided the S/390 back end emits additional instructions in
23653 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23654 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23655 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23656 the frame size of the compiled function is chosen.
23657 These options are intended to be used to help debugging stack overflow problems.
23658 The additionally emitted code causes only little overhead and hence can also be
23659 used in production-like systems without greater performance degradation.  The given
23660 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23661 @var{stack-guard} without exceeding 64k.
23662 In order to be efficient the extra code makes the assumption that the stack starts
23663 at an address aligned to the value given by @var{stack-size}.
23664 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23666 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23667 @opindex mhotpatch
23668 If the hotpatch option is enabled, a ``hot-patching'' function
23669 prologue is generated for all functions in the compilation unit.
23670 The funtion label is prepended with the given number of two-byte
23671 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23672 the label, 2 * @var{post-halfwords} bytes are appended, using the
23673 largest NOP like instructions the architecture allows (maximum
23674 1000000).
23676 If both arguments are zero, hotpatching is disabled.
23678 This option can be overridden for individual functions with the
23679 @code{hotpatch} attribute.
23680 @end table
23682 @node Score Options
23683 @subsection Score Options
23684 @cindex Score Options
23686 These options are defined for Score implementations:
23688 @table @gcctabopt
23689 @item -meb
23690 @opindex meb
23691 Compile code for big-endian mode.  This is the default.
23693 @item -mel
23694 @opindex mel
23695 Compile code for little-endian mode.
23697 @item -mnhwloop
23698 @opindex mnhwloop
23699 Disable generation of @code{bcnz} instructions.
23701 @item -muls
23702 @opindex muls
23703 Enable generation of unaligned load and store instructions.
23705 @item -mmac
23706 @opindex mmac
23707 Enable the use of multiply-accumulate instructions. Disabled by default.
23709 @item -mscore5
23710 @opindex mscore5
23711 Specify the SCORE5 as the target architecture.
23713 @item -mscore5u
23714 @opindex mscore5u
23715 Specify the SCORE5U of the target architecture.
23717 @item -mscore7
23718 @opindex mscore7
23719 Specify the SCORE7 as the target architecture. This is the default.
23721 @item -mscore7d
23722 @opindex mscore7d
23723 Specify the SCORE7D as the target architecture.
23724 @end table
23726 @node SH Options
23727 @subsection SH Options
23729 These @samp{-m} options are defined for the SH implementations:
23731 @table @gcctabopt
23732 @item -m1
23733 @opindex m1
23734 Generate code for the SH1.
23736 @item -m2
23737 @opindex m2
23738 Generate code for the SH2.
23740 @item -m2e
23741 Generate code for the SH2e.
23743 @item -m2a-nofpu
23744 @opindex m2a-nofpu
23745 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23746 that the floating-point unit is not used.
23748 @item -m2a-single-only
23749 @opindex m2a-single-only
23750 Generate code for the SH2a-FPU, in such a way that no double-precision
23751 floating-point operations are used.
23753 @item -m2a-single
23754 @opindex m2a-single
23755 Generate code for the SH2a-FPU assuming the floating-point unit is in
23756 single-precision mode by default.
23758 @item -m2a
23759 @opindex m2a
23760 Generate code for the SH2a-FPU assuming the floating-point unit is in
23761 double-precision mode by default.
23763 @item -m3
23764 @opindex m3
23765 Generate code for the SH3.
23767 @item -m3e
23768 @opindex m3e
23769 Generate code for the SH3e.
23771 @item -m4-nofpu
23772 @opindex m4-nofpu
23773 Generate code for the SH4 without a floating-point unit.
23775 @item -m4-single-only
23776 @opindex m4-single-only
23777 Generate code for the SH4 with a floating-point unit that only
23778 supports single-precision arithmetic.
23780 @item -m4-single
23781 @opindex m4-single
23782 Generate code for the SH4 assuming the floating-point unit is in
23783 single-precision mode by default.
23785 @item -m4
23786 @opindex m4
23787 Generate code for the SH4.
23789 @item -m4-100
23790 @opindex m4-100
23791 Generate code for SH4-100.
23793 @item -m4-100-nofpu
23794 @opindex m4-100-nofpu
23795 Generate code for SH4-100 in such a way that the
23796 floating-point unit is not used.
23798 @item -m4-100-single
23799 @opindex m4-100-single
23800 Generate code for SH4-100 assuming the floating-point unit is in
23801 single-precision mode by default.
23803 @item -m4-100-single-only
23804 @opindex m4-100-single-only
23805 Generate code for SH4-100 in such a way that no double-precision
23806 floating-point operations are used.
23808 @item -m4-200
23809 @opindex m4-200
23810 Generate code for SH4-200.
23812 @item -m4-200-nofpu
23813 @opindex m4-200-nofpu
23814 Generate code for SH4-200 without in such a way that the
23815 floating-point unit is not used.
23817 @item -m4-200-single
23818 @opindex m4-200-single
23819 Generate code for SH4-200 assuming the floating-point unit is in
23820 single-precision mode by default.
23822 @item -m4-200-single-only
23823 @opindex m4-200-single-only
23824 Generate code for SH4-200 in such a way that no double-precision
23825 floating-point operations are used.
23827 @item -m4-300
23828 @opindex m4-300
23829 Generate code for SH4-300.
23831 @item -m4-300-nofpu
23832 @opindex m4-300-nofpu
23833 Generate code for SH4-300 without in such a way that the
23834 floating-point unit is not used.
23836 @item -m4-300-single
23837 @opindex m4-300-single
23838 Generate code for SH4-300 in such a way that no double-precision
23839 floating-point operations are used.
23841 @item -m4-300-single-only
23842 @opindex m4-300-single-only
23843 Generate code for SH4-300 in such a way that no double-precision
23844 floating-point operations are used.
23846 @item -m4-340
23847 @opindex m4-340
23848 Generate code for SH4-340 (no MMU, no FPU).
23850 @item -m4-500
23851 @opindex m4-500
23852 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23853 assembler.
23855 @item -m4a-nofpu
23856 @opindex m4a-nofpu
23857 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23858 floating-point unit is not used.
23860 @item -m4a-single-only
23861 @opindex m4a-single-only
23862 Generate code for the SH4a, in such a way that no double-precision
23863 floating-point operations are used.
23865 @item -m4a-single
23866 @opindex m4a-single
23867 Generate code for the SH4a assuming the floating-point unit is in
23868 single-precision mode by default.
23870 @item -m4a
23871 @opindex m4a
23872 Generate code for the SH4a.
23874 @item -m4al
23875 @opindex m4al
23876 Same as @option{-m4a-nofpu}, except that it implicitly passes
23877 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23878 instructions at the moment.
23880 @item -mb
23881 @opindex mb
23882 Compile code for the processor in big-endian mode.
23884 @item -ml
23885 @opindex ml
23886 Compile code for the processor in little-endian mode.
23888 @item -mdalign
23889 @opindex mdalign
23890 Align doubles at 64-bit boundaries.  Note that this changes the calling
23891 conventions, and thus some functions from the standard C library do
23892 not work unless you recompile it first with @option{-mdalign}.
23894 @item -mrelax
23895 @opindex mrelax
23896 Shorten some address references at link time, when possible; uses the
23897 linker option @option{-relax}.
23899 @item -mbigtable
23900 @opindex mbigtable
23901 Use 32-bit offsets in @code{switch} tables.  The default is to use
23902 16-bit offsets.
23904 @item -mbitops
23905 @opindex mbitops
23906 Enable the use of bit manipulation instructions on SH2A.
23908 @item -mfmovd
23909 @opindex mfmovd
23910 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23911 alignment constraints.
23913 @item -mrenesas
23914 @opindex mrenesas
23915 Comply with the calling conventions defined by Renesas.
23917 @item -mno-renesas
23918 @opindex mno-renesas
23919 Comply with the calling conventions defined for GCC before the Renesas
23920 conventions were available.  This option is the default for all
23921 targets of the SH toolchain.
23923 @item -mnomacsave
23924 @opindex mnomacsave
23925 Mark the @code{MAC} register as call-clobbered, even if
23926 @option{-mrenesas} is given.
23928 @item -mieee
23929 @itemx -mno-ieee
23930 @opindex mieee
23931 @opindex mno-ieee
23932 Control the IEEE compliance of floating-point comparisons, which affects the
23933 handling of cases where the result of a comparison is unordered.  By default
23934 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23935 enabled @option{-mno-ieee} is implicitly set, which results in faster
23936 floating-point greater-equal and less-equal comparisons.  The implicit settings
23937 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23939 @item -minline-ic_invalidate
23940 @opindex minline-ic_invalidate
23941 Inline code to invalidate instruction cache entries after setting up
23942 nested function trampolines.
23943 This option has no effect if @option{-musermode} is in effect and the selected
23944 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23945 instruction.
23946 If the selected code generation option does not allow the use of the @code{icbi}
23947 instruction, and @option{-musermode} is not in effect, the inlined code
23948 manipulates the instruction cache address array directly with an associative
23949 write.  This not only requires privileged mode at run time, but it also
23950 fails if the cache line had been mapped via the TLB and has become unmapped.
23952 @item -misize
23953 @opindex misize
23954 Dump instruction size and location in the assembly code.
23956 @item -mpadstruct
23957 @opindex mpadstruct
23958 This option is deprecated.  It pads structures to multiple of 4 bytes,
23959 which is incompatible with the SH ABI@.
23961 @item -matomic-model=@var{model}
23962 @opindex matomic-model=@var{model}
23963 Sets the model of atomic operations and additional parameters as a comma
23964 separated list.  For details on the atomic built-in functions see
23965 @ref{__atomic Builtins}.  The following models and parameters are supported:
23967 @table @samp
23969 @item none
23970 Disable compiler generated atomic sequences and emit library calls for atomic
23971 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23973 @item soft-gusa
23974 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23975 built-in functions.  The generated atomic sequences require additional support
23976 from the interrupt/exception handling code of the system and are only suitable
23977 for SH3* and SH4* single-core systems.  This option is enabled by default when
23978 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23979 this option also partially utilizes the hardware atomic instructions
23980 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23981 @samp{strict} is specified.  
23983 @item soft-tcb
23984 Generate software atomic sequences that use a variable in the thread control
23985 block.  This is a variation of the gUSA sequences which can also be used on
23986 SH1* and SH2* targets.  The generated atomic sequences require additional
23987 support from the interrupt/exception handling code of the system and are only
23988 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23989 parameter has to be specified as well.
23991 @item soft-imask
23992 Generate software atomic sequences that temporarily disable interrupts by
23993 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23994 in privileged mode and is only suitable for single-core systems.  Additional
23995 support from the interrupt/exception handling code of the system is not
23996 required.  This model is enabled by default when the target is
23997 @code{sh*-*-linux*} and SH1* or SH2*.
23999 @item hard-llcs
24000 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24001 instructions only.  This is only available on SH4A and is suitable for
24002 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24003 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24004 Code compiled with this option is also compatible with other software
24005 atomic model interrupt/exception handling systems if executed on an SH4A
24006 system.  Additional support from the interrupt/exception handling code of the
24007 system is not required for this model.
24009 @item gbr-offset=
24010 This parameter specifies the offset in bytes of the variable in the thread
24011 control block structure that should be used by the generated atomic sequences
24012 when the @samp{soft-tcb} model has been selected.  For other models this
24013 parameter is ignored.  The specified value must be an integer multiple of four
24014 and in the range 0-1020.
24016 @item strict
24017 This parameter prevents mixed usage of multiple atomic models, even if they
24018 are compatible, and makes the compiler generate atomic sequences of the
24019 specified model only.
24021 @end table
24023 @item -mtas
24024 @opindex mtas
24025 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24026 Notice that depending on the particular hardware and software configuration
24027 this can degrade overall performance due to the operand cache line flushes
24028 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24029 processors the @code{tas.b} instruction must be used with caution since it
24030 can result in data corruption for certain cache configurations.
24032 @item -mprefergot
24033 @opindex mprefergot
24034 When generating position-independent code, emit function calls using
24035 the Global Offset Table instead of the Procedure Linkage Table.
24037 @item -musermode
24038 @itemx -mno-usermode
24039 @opindex musermode
24040 @opindex mno-usermode
24041 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24042 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24043 inlined code would not work in user mode.  @option{-musermode} is the default
24044 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24045 @option{-musermode} has no effect, since there is no user mode.
24047 @item -multcost=@var{number}
24048 @opindex multcost=@var{number}
24049 Set the cost to assume for a multiply insn.
24051 @item -mdiv=@var{strategy}
24052 @opindex mdiv=@var{strategy}
24053 Set the division strategy to be used for integer division operations.
24054 @var{strategy} can be one of: 
24056 @table @samp
24058 @item call-div1
24059 Calls a library function that uses the single-step division instruction
24060 @code{div1} to perform the operation.  Division by zero calculates an
24061 unspecified result and does not trap.  This is the default except for SH4,
24062 SH2A and SHcompact.
24064 @item call-fp
24065 Calls a library function that performs the operation in double precision
24066 floating point.  Division by zero causes a floating-point exception.  This is
24067 the default for SHcompact with FPU.  Specifying this for targets that do not
24068 have a double precision FPU defaults to @code{call-div1}.
24070 @item call-table
24071 Calls a library function that uses a lookup table for small divisors and
24072 the @code{div1} instruction with case distinction for larger divisors.  Division
24073 by zero calculates an unspecified result and does not trap.  This is the default
24074 for SH4.  Specifying this for targets that do not have dynamic shift
24075 instructions defaults to @code{call-div1}.
24077 @end table
24079 When a division strategy has not been specified the default strategy is
24080 selected based on the current target.  For SH2A the default strategy is to
24081 use the @code{divs} and @code{divu} instructions instead of library function
24082 calls.
24084 @item -maccumulate-outgoing-args
24085 @opindex maccumulate-outgoing-args
24086 Reserve space once for outgoing arguments in the function prologue rather
24087 than around each call.  Generally beneficial for performance and size.  Also
24088 needed for unwinding to avoid changing the stack frame around conditional code.
24090 @item -mdivsi3_libfunc=@var{name}
24091 @opindex mdivsi3_libfunc=@var{name}
24092 Set the name of the library function used for 32-bit signed division to
24093 @var{name}.
24094 This only affects the name used in the @samp{call} division strategies, and
24095 the compiler still expects the same sets of input/output/clobbered registers as
24096 if this option were not present.
24098 @item -mfixed-range=@var{register-range}
24099 @opindex mfixed-range
24100 Generate code treating the given register range as fixed registers.
24101 A fixed register is one that the register allocator can not use.  This is
24102 useful when compiling kernel code.  A register range is specified as
24103 two registers separated by a dash.  Multiple register ranges can be
24104 specified separated by a comma.
24106 @item -mbranch-cost=@var{num}
24107 @opindex mbranch-cost=@var{num}
24108 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24109 make the compiler try to generate more branch-free code if possible.  
24110 If not specified the value is selected depending on the processor type that
24111 is being compiled for.
24113 @item -mzdcbranch
24114 @itemx -mno-zdcbranch
24115 @opindex mzdcbranch
24116 @opindex mno-zdcbranch
24117 Assume (do not assume) that zero displacement conditional branch instructions
24118 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24119 compiler prefers zero displacement branch code sequences.  This is
24120 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24121 disabled by specifying @option{-mno-zdcbranch}.
24123 @item -mcbranch-force-delay-slot
24124 @opindex mcbranch-force-delay-slot
24125 Force the usage of delay slots for conditional branches, which stuffs the delay
24126 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24127 this option is disabled.  It can be enabled to work around hardware bugs as
24128 found in the original SH7055.
24130 @item -mfused-madd
24131 @itemx -mno-fused-madd
24132 @opindex mfused-madd
24133 @opindex mno-fused-madd
24134 Generate code that uses (does not use) the floating-point multiply and
24135 accumulate instructions.  These instructions are generated by default
24136 if hardware floating point is used.  The machine-dependent
24137 @option{-mfused-madd} option is now mapped to the machine-independent
24138 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24139 mapped to @option{-ffp-contract=off}.
24141 @item -mfsca
24142 @itemx -mno-fsca
24143 @opindex mfsca
24144 @opindex mno-fsca
24145 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24146 and cosine approximations.  The option @option{-mfsca} must be used in
24147 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24148 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24149 approximations even if @option{-funsafe-math-optimizations} is in effect.
24151 @item -mfsrra
24152 @itemx -mno-fsrra
24153 @opindex mfsrra
24154 @opindex mno-fsrra
24155 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24156 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24157 in combination with @option{-funsafe-math-optimizations} and
24158 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24159 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24160 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24161 in effect.
24163 @item -mpretend-cmove
24164 @opindex mpretend-cmove
24165 Prefer zero-displacement conditional branches for conditional move instruction
24166 patterns.  This can result in faster code on the SH4 processor.
24168 @item -mfdpic
24169 @opindex fdpic
24170 Generate code using the FDPIC ABI.
24172 @end table
24174 @node Solaris 2 Options
24175 @subsection Solaris 2 Options
24176 @cindex Solaris 2 options
24178 These @samp{-m} options are supported on Solaris 2:
24180 @table @gcctabopt
24181 @item -mclear-hwcap
24182 @opindex mclear-hwcap
24183 @option{-mclear-hwcap} tells the compiler to remove the hardware
24184 capabilities generated by the Solaris assembler.  This is only necessary
24185 when object files use ISA extensions not supported by the current
24186 machine, but check at runtime whether or not to use them.
24188 @item -mimpure-text
24189 @opindex mimpure-text
24190 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24191 the compiler to not pass @option{-z text} to the linker when linking a
24192 shared object.  Using this option, you can link position-dependent
24193 code into a shared object.
24195 @option{-mimpure-text} suppresses the ``relocations remain against
24196 allocatable but non-writable sections'' linker error message.
24197 However, the necessary relocations trigger copy-on-write, and the
24198 shared object is not actually shared across processes.  Instead of
24199 using @option{-mimpure-text}, you should compile all source code with
24200 @option{-fpic} or @option{-fPIC}.
24202 @end table
24204 These switches are supported in addition to the above on Solaris 2:
24206 @table @gcctabopt
24207 @item -pthreads
24208 @opindex pthreads
24209 This is a synonym for @option{-pthread}.
24210 @end table
24212 @node SPARC Options
24213 @subsection SPARC Options
24214 @cindex SPARC options
24216 These @samp{-m} options are supported on the SPARC:
24218 @table @gcctabopt
24219 @item -mno-app-regs
24220 @itemx -mapp-regs
24221 @opindex mno-app-regs
24222 @opindex mapp-regs
24223 Specify @option{-mapp-regs} to generate output using the global registers
24224 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24225 global register 1, each global register 2 through 4 is then treated as an
24226 allocable register that is clobbered by function calls.  This is the default.
24228 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24229 specify @option{-mno-app-regs}.  You should compile libraries and system
24230 software with this option.
24232 @item -mflat
24233 @itemx -mno-flat
24234 @opindex mflat
24235 @opindex mno-flat
24236 With @option{-mflat}, the compiler does not generate save/restore instructions
24237 and uses a ``flat'' or single register window model.  This model is compatible
24238 with the regular register window model.  The local registers and the input
24239 registers (0--5) are still treated as ``call-saved'' registers and are
24240 saved on the stack as needed.
24242 With @option{-mno-flat} (the default), the compiler generates save/restore
24243 instructions (except for leaf functions).  This is the normal operating mode.
24245 @item -mfpu
24246 @itemx -mhard-float
24247 @opindex mfpu
24248 @opindex mhard-float
24249 Generate output containing floating-point instructions.  This is the
24250 default.
24252 @item -mno-fpu
24253 @itemx -msoft-float
24254 @opindex mno-fpu
24255 @opindex msoft-float
24256 Generate output containing library calls for floating point.
24257 @strong{Warning:} the requisite libraries are not available for all SPARC
24258 targets.  Normally the facilities of the machine's usual C compiler are
24259 used, but this cannot be done directly in cross-compilation.  You must make
24260 your own arrangements to provide suitable library functions for
24261 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24262 @samp{sparclite-*-*} do provide software floating-point support.
24264 @option{-msoft-float} changes the calling convention in the output file;
24265 therefore, it is only useful if you compile @emph{all} of a program with
24266 this option.  In particular, you need to compile @file{libgcc.a}, the
24267 library that comes with GCC, with @option{-msoft-float} in order for
24268 this to work.
24270 @item -mhard-quad-float
24271 @opindex mhard-quad-float
24272 Generate output containing quad-word (long double) floating-point
24273 instructions.
24275 @item -msoft-quad-float
24276 @opindex msoft-quad-float
24277 Generate output containing library calls for quad-word (long double)
24278 floating-point instructions.  The functions called are those specified
24279 in the SPARC ABI@.  This is the default.
24281 As of this writing, there are no SPARC implementations that have hardware
24282 support for the quad-word floating-point instructions.  They all invoke
24283 a trap handler for one of these instructions, and then the trap handler
24284 emulates the effect of the instruction.  Because of the trap handler overhead,
24285 this is much slower than calling the ABI library routines.  Thus the
24286 @option{-msoft-quad-float} option is the default.
24288 @item -mno-unaligned-doubles
24289 @itemx -munaligned-doubles
24290 @opindex mno-unaligned-doubles
24291 @opindex munaligned-doubles
24292 Assume that doubles have 8-byte alignment.  This is the default.
24294 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24295 alignment only if they are contained in another type, or if they have an
24296 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24297 Specifying this option avoids some rare compatibility problems with code
24298 generated by other compilers.  It is not the default because it results
24299 in a performance loss, especially for floating-point code.
24301 @item -muser-mode
24302 @itemx -mno-user-mode
24303 @opindex muser-mode
24304 @opindex mno-user-mode
24305 Do not generate code that can only run in supervisor mode.  This is relevant
24306 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24307 is the default.
24309 @item -mfaster-structs
24310 @itemx -mno-faster-structs
24311 @opindex mfaster-structs
24312 @opindex mno-faster-structs
24313 With @option{-mfaster-structs}, the compiler assumes that structures
24314 should have 8-byte alignment.  This enables the use of pairs of
24315 @code{ldd} and @code{std} instructions for copies in structure
24316 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24317 However, the use of this changed alignment directly violates the SPARC
24318 ABI@.  Thus, it's intended only for use on targets where the developer
24319 acknowledges that their resulting code is not directly in line with
24320 the rules of the ABI@.
24322 @item -mstd-struct-return
24323 @itemx -mno-std-struct-return
24324 @opindex mstd-struct-return
24325 @opindex mno-std-struct-return
24326 With @option{-mstd-struct-return}, the compiler generates checking code
24327 in functions returning structures or unions to detect size mismatches
24328 between the two sides of function calls, as per the 32-bit ABI@.
24330 The default is @option{-mno-std-struct-return}.  This option has no effect
24331 in 64-bit mode.
24333 @item -mlra
24334 @itemx -mno-lra
24335 @opindex mlra
24336 @opindex mno-lra
24337 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24338 so @option{-mno-lra} needs to be passed to get old Reload.
24340 @item -mcpu=@var{cpu_type}
24341 @opindex mcpu
24342 Set the instruction set, register set, and instruction scheduling parameters
24343 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24344 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24345 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24346 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24347 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24348 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24350 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24351 which selects the best architecture option for the host processor.
24352 @option{-mcpu=native} has no effect if GCC does not recognize
24353 the processor.
24355 Default instruction scheduling parameters are used for values that select
24356 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24357 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24359 Here is a list of each supported architecture and their supported
24360 implementations.
24362 @table @asis
24363 @item v7
24364 cypress, leon3v7
24366 @item v8
24367 supersparc, hypersparc, leon, leon3
24369 @item sparclite
24370 f930, f934, sparclite86x
24372 @item sparclet
24373 tsc701
24375 @item v9
24376 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24377 niagara7, m8
24378 @end table
24380 By default (unless configured otherwise), GCC generates code for the V7
24381 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24382 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24383 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24384 SPARCStation 1, 2, IPX etc.
24386 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24387 architecture.  The only difference from V7 code is that the compiler emits
24388 the integer multiply and integer divide instructions which exist in SPARC-V8
24389 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24390 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24391 2000 series.
24393 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24394 the SPARC architecture.  This adds the integer multiply, integer divide step
24395 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24396 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24397 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24398 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24399 MB86934 chip, which is the more recent SPARClite with FPU@.
24401 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24402 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24403 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24404 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24405 optimizes it for the TEMIC SPARClet chip.
24407 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24408 architecture.  This adds 64-bit integer and floating-point move instructions,
24409 3 additional floating-point condition code registers and conditional move
24410 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24411 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24412 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24413 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24414 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24415 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24416 additionally optimizes it for Sun UltraSPARC T2 chips. With
24417 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24418 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24419 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24420 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24421 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24422 additionally optimizes it for Oracle M8 chips.
24424 @item -mtune=@var{cpu_type}
24425 @opindex mtune
24426 Set the instruction scheduling parameters for machine type
24427 @var{cpu_type}, but do not set the instruction set or register set that the
24428 option @option{-mcpu=@var{cpu_type}} does.
24430 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24431 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24432 that select a particular CPU implementation.  Those are
24433 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24434 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24435 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24436 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24437 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24438 and GNU/Linux toolchains, @samp{native} can also be used.
24440 @item -mv8plus
24441 @itemx -mno-v8plus
24442 @opindex mv8plus
24443 @opindex mno-v8plus
24444 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24445 difference from the V8 ABI is that the global and out registers are
24446 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24447 mode for all SPARC-V9 processors.
24449 @item -mvis
24450 @itemx -mno-vis
24451 @opindex mvis
24452 @opindex mno-vis
24453 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24454 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24456 @item -mvis2
24457 @itemx -mno-vis2
24458 @opindex mvis2
24459 @opindex mno-vis2
24460 With @option{-mvis2}, GCC generates code that takes advantage of
24461 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24462 default is @option{-mvis2} when targeting a cpu that supports such
24463 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24464 also sets @option{-mvis}.
24466 @item -mvis3
24467 @itemx -mno-vis3
24468 @opindex mvis3
24469 @opindex mno-vis3
24470 With @option{-mvis3}, GCC generates code that takes advantage of
24471 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24472 default is @option{-mvis3} when targeting a cpu that supports such
24473 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24474 also sets @option{-mvis2} and @option{-mvis}.
24476 @item -mvis4
24477 @itemx -mno-vis4
24478 @opindex mvis4
24479 @opindex mno-vis4
24480 With @option{-mvis4}, GCC generates code that takes advantage of
24481 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24482 default is @option{-mvis4} when targeting a cpu that supports such
24483 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24484 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24486 @item -mvis4b
24487 @itemx -mno-vis4b
24488 @opindex mvis4b
24489 @opindex mno-vis4b
24490 With @option{-mvis4b}, GCC generates code that takes advantage of
24491 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24492 the additional VIS instructions introduced in the Oracle SPARC
24493 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24494 cpu that supports such instructions, such as m8 and later.  Setting
24495 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24496 @option{-mvis2} and @option{-mvis}.
24498 @item -mcbcond
24499 @itemx -mno-cbcond
24500 @opindex mcbcond
24501 @opindex mno-cbcond
24502 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24503 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24504 when targeting a CPU that supports such instructions, such as Niagara-4 and
24505 later.
24507 @item -mfmaf
24508 @itemx -mno-fmaf
24509 @opindex mfmaf
24510 @opindex mno-fmaf
24511 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24512 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24513 when targeting a CPU that supports such instructions, such as Niagara-3 and
24514 later.
24516 @item -mfsmuld
24517 @itemx -mno-fsmuld
24518 @opindex mfsmuld
24519 @opindex mno-fsmuld
24520 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24521 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24522 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24523 or V9 with FPU except @option{-mcpu=leon}.
24525 @item -mpopc
24526 @itemx -mno-popc
24527 @opindex mpopc
24528 @opindex mno-popc
24529 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24530 Population Count instruction.  The default is @option{-mpopc}
24531 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24532 later.
24534 @item -msubxc
24535 @itemx -mno-subxc
24536 @opindex msubxc
24537 @opindex mno-subxc
24538 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24539 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24540 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24541 later.
24543 @item -mfix-at697f
24544 @opindex mfix-at697f
24545 Enable the documented workaround for the single erratum of the Atmel AT697F
24546 processor (which corresponds to erratum #13 of the AT697E processor).
24548 @item -mfix-ut699
24549 @opindex mfix-ut699
24550 Enable the documented workarounds for the floating-point errata and the data
24551 cache nullify errata of the UT699 processor.
24553 @item -mfix-ut700
24554 @opindex mfix-ut700
24555 Enable the documented workaround for the back-to-back store errata of
24556 the UT699E/UT700 processor.
24558 @item -mfix-gr712rc
24559 @opindex mfix-gr712rc
24560 Enable the documented workaround for the back-to-back store errata of
24561 the GR712RC processor.
24562 @end table
24564 These @samp{-m} options are supported in addition to the above
24565 on SPARC-V9 processors in 64-bit environments:
24567 @table @gcctabopt
24568 @item -m32
24569 @itemx -m64
24570 @opindex m32
24571 @opindex m64
24572 Generate code for a 32-bit or 64-bit environment.
24573 The 32-bit environment sets int, long and pointer to 32 bits.
24574 The 64-bit environment sets int to 32 bits and long and pointer
24575 to 64 bits.
24577 @item -mcmodel=@var{which}
24578 @opindex mcmodel
24579 Set the code model to one of
24581 @table @samp
24582 @item medlow
24583 The Medium/Low code model: 64-bit addresses, programs
24584 must be linked in the low 32 bits of memory.  Programs can be statically
24585 or dynamically linked.
24587 @item medmid
24588 The Medium/Middle code model: 64-bit addresses, programs
24589 must be linked in the low 44 bits of memory, the text and data segments must
24590 be less than 2GB in size and the data segment must be located within 2GB of
24591 the text segment.
24593 @item medany
24594 The Medium/Anywhere code model: 64-bit addresses, programs
24595 may be linked anywhere in memory, the text and data segments must be less
24596 than 2GB in size and the data segment must be located within 2GB of the
24597 text segment.
24599 @item embmedany
24600 The Medium/Anywhere code model for embedded systems:
24601 64-bit addresses, the text and data segments must be less than 2GB in
24602 size, both starting anywhere in memory (determined at link time).  The
24603 global register %g4 points to the base of the data segment.  Programs
24604 are statically linked and PIC is not supported.
24605 @end table
24607 @item -mmemory-model=@var{mem-model}
24608 @opindex mmemory-model
24609 Set the memory model in force on the processor to one of
24611 @table @samp
24612 @item default
24613 The default memory model for the processor and operating system.
24615 @item rmo
24616 Relaxed Memory Order
24618 @item pso
24619 Partial Store Order
24621 @item tso
24622 Total Store Order
24624 @item sc
24625 Sequential Consistency
24626 @end table
24628 These memory models are formally defined in Appendix D of the SPARC-V9
24629 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24631 @item -mstack-bias
24632 @itemx -mno-stack-bias
24633 @opindex mstack-bias
24634 @opindex mno-stack-bias
24635 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24636 frame pointer if present, are offset by @minus{}2047 which must be added back
24637 when making stack frame references.  This is the default in 64-bit mode.
24638 Otherwise, assume no such offset is present.
24639 @end table
24641 @node SPU Options
24642 @subsection SPU Options
24643 @cindex SPU options
24645 These @samp{-m} options are supported on the SPU:
24647 @table @gcctabopt
24648 @item -mwarn-reloc
24649 @itemx -merror-reloc
24650 @opindex mwarn-reloc
24651 @opindex merror-reloc
24653 The loader for SPU does not handle dynamic relocations.  By default, GCC
24654 gives an error when it generates code that requires a dynamic
24655 relocation.  @option{-mno-error-reloc} disables the error,
24656 @option{-mwarn-reloc} generates a warning instead.
24658 @item -msafe-dma
24659 @itemx -munsafe-dma
24660 @opindex msafe-dma
24661 @opindex munsafe-dma
24663 Instructions that initiate or test completion of DMA must not be
24664 reordered with respect to loads and stores of the memory that is being
24665 accessed.
24666 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24667 memory accesses, but that can lead to inefficient code in places where the
24668 memory is known to not change.  Rather than mark the memory as volatile,
24669 you can use @option{-msafe-dma} to tell the compiler to treat
24670 the DMA instructions as potentially affecting all memory.  
24672 @item -mbranch-hints
24673 @opindex mbranch-hints
24675 By default, GCC generates a branch hint instruction to avoid
24676 pipeline stalls for always-taken or probably-taken branches.  A hint
24677 is not generated closer than 8 instructions away from its branch.
24678 There is little reason to disable them, except for debugging purposes,
24679 or to make an object a little bit smaller.
24681 @item -msmall-mem
24682 @itemx -mlarge-mem
24683 @opindex msmall-mem
24684 @opindex mlarge-mem
24686 By default, GCC generates code assuming that addresses are never larger
24687 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24688 a full 32-bit address.
24690 @item -mstdmain
24691 @opindex mstdmain
24693 By default, GCC links against startup code that assumes the SPU-style
24694 main function interface (which has an unconventional parameter list).
24695 With @option{-mstdmain}, GCC links your program against startup
24696 code that assumes a C99-style interface to @code{main}, including a
24697 local copy of @code{argv} strings.
24699 @item -mfixed-range=@var{register-range}
24700 @opindex mfixed-range
24701 Generate code treating the given register range as fixed registers.
24702 A fixed register is one that the register allocator cannot use.  This is
24703 useful when compiling kernel code.  A register range is specified as
24704 two registers separated by a dash.  Multiple register ranges can be
24705 specified separated by a comma.
24707 @item -mea32
24708 @itemx -mea64
24709 @opindex mea32
24710 @opindex mea64
24711 Compile code assuming that pointers to the PPU address space accessed
24712 via the @code{__ea} named address space qualifier are either 32 or 64
24713 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24714 all object code in an executable must be compiled with the same setting.
24716 @item -maddress-space-conversion
24717 @itemx -mno-address-space-conversion
24718 @opindex maddress-space-conversion
24719 @opindex mno-address-space-conversion
24720 Allow/disallow treating the @code{__ea} address space as superset
24721 of the generic address space.  This enables explicit type casts
24722 between @code{__ea} and generic pointer as well as implicit
24723 conversions of generic pointers to @code{__ea} pointers.  The
24724 default is to allow address space pointer conversions.
24726 @item -mcache-size=@var{cache-size}
24727 @opindex mcache-size
24728 This option controls the version of libgcc that the compiler links to an
24729 executable and selects a software-managed cache for accessing variables
24730 in the @code{__ea} address space with a particular cache size.  Possible
24731 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24732 and @samp{128}.  The default cache size is 64KB.
24734 @item -matomic-updates
24735 @itemx -mno-atomic-updates
24736 @opindex matomic-updates
24737 @opindex mno-atomic-updates
24738 This option controls the version of libgcc that the compiler links to an
24739 executable and selects whether atomic updates to the software-managed
24740 cache of PPU-side variables are used.  If you use atomic updates, changes
24741 to a PPU variable from SPU code using the @code{__ea} named address space
24742 qualifier do not interfere with changes to other PPU variables residing
24743 in the same cache line from PPU code.  If you do not use atomic updates,
24744 such interference may occur; however, writing back cache lines is
24745 more efficient.  The default behavior is to use atomic updates.
24747 @item -mdual-nops
24748 @itemx -mdual-nops=@var{n}
24749 @opindex mdual-nops
24750 By default, GCC inserts NOPs to increase dual issue when it expects
24751 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24752 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24753 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24755 @item -mhint-max-nops=@var{n}
24756 @opindex mhint-max-nops
24757 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24758 be at least 8 instructions away from the branch it is affecting.  GCC
24759 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24760 generate the branch hint.
24762 @item -mhint-max-distance=@var{n}
24763 @opindex mhint-max-distance
24764 The encoding of the branch hint instruction limits the hint to be within
24765 256 instructions of the branch it is affecting.  By default, GCC makes
24766 sure it is within 125.
24768 @item -msafe-hints
24769 @opindex msafe-hints
24770 Work around a hardware bug that causes the SPU to stall indefinitely.
24771 By default, GCC inserts the @code{hbrp} instruction to make sure
24772 this stall won't happen.
24774 @end table
24776 @node System V Options
24777 @subsection Options for System V
24779 These additional options are available on System V Release 4 for
24780 compatibility with other compilers on those systems:
24782 @table @gcctabopt
24783 @item -G
24784 @opindex G
24785 Create a shared object.
24786 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24788 @item -Qy
24789 @opindex Qy
24790 Identify the versions of each tool used by the compiler, in a
24791 @code{.ident} assembler directive in the output.
24793 @item -Qn
24794 @opindex Qn
24795 Refrain from adding @code{.ident} directives to the output file (this is
24796 the default).
24798 @item -YP,@var{dirs}
24799 @opindex YP
24800 Search the directories @var{dirs}, and no others, for libraries
24801 specified with @option{-l}.
24803 @item -Ym,@var{dir}
24804 @opindex Ym
24805 Look in the directory @var{dir} to find the M4 preprocessor.
24806 The assembler uses this option.
24807 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24808 @c the generic assembler that comes with Solaris takes just -Ym.
24809 @end table
24811 @node TILE-Gx Options
24812 @subsection TILE-Gx Options
24813 @cindex TILE-Gx options
24815 These @samp{-m} options are supported on the TILE-Gx:
24817 @table @gcctabopt
24818 @item -mcmodel=small
24819 @opindex mcmodel=small
24820 Generate code for the small model.  The distance for direct calls is
24821 limited to 500M in either direction.  PC-relative addresses are 32
24822 bits.  Absolute addresses support the full address range.
24824 @item -mcmodel=large
24825 @opindex mcmodel=large
24826 Generate code for the large model.  There is no limitation on call
24827 distance, pc-relative addresses, or absolute addresses.
24829 @item -mcpu=@var{name}
24830 @opindex mcpu
24831 Selects the type of CPU to be targeted.  Currently the only supported
24832 type is @samp{tilegx}.
24834 @item -m32
24835 @itemx -m64
24836 @opindex m32
24837 @opindex m64
24838 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24839 environment sets int, long, and pointer to 32 bits.  The 64-bit
24840 environment sets int to 32 bits and long and pointer to 64 bits.
24842 @item -mbig-endian
24843 @itemx -mlittle-endian
24844 @opindex mbig-endian
24845 @opindex mlittle-endian
24846 Generate code in big/little endian mode, respectively.
24847 @end table
24849 @node TILEPro Options
24850 @subsection TILEPro Options
24851 @cindex TILEPro options
24853 These @samp{-m} options are supported on the TILEPro:
24855 @table @gcctabopt
24856 @item -mcpu=@var{name}
24857 @opindex mcpu
24858 Selects the type of CPU to be targeted.  Currently the only supported
24859 type is @samp{tilepro}.
24861 @item -m32
24862 @opindex m32
24863 Generate code for a 32-bit environment, which sets int, long, and
24864 pointer to 32 bits.  This is the only supported behavior so the flag
24865 is essentially ignored.
24866 @end table
24868 @node V850 Options
24869 @subsection V850 Options
24870 @cindex V850 Options
24872 These @samp{-m} options are defined for V850 implementations:
24874 @table @gcctabopt
24875 @item -mlong-calls
24876 @itemx -mno-long-calls
24877 @opindex mlong-calls
24878 @opindex mno-long-calls
24879 Treat all calls as being far away (near).  If calls are assumed to be
24880 far away, the compiler always loads the function's address into a
24881 register, and calls indirect through the pointer.
24883 @item -mno-ep
24884 @itemx -mep
24885 @opindex mno-ep
24886 @opindex mep
24887 Do not optimize (do optimize) basic blocks that use the same index
24888 pointer 4 or more times to copy pointer into the @code{ep} register, and
24889 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24890 option is on by default if you optimize.
24892 @item -mno-prolog-function
24893 @itemx -mprolog-function
24894 @opindex mno-prolog-function
24895 @opindex mprolog-function
24896 Do not use (do use) external functions to save and restore registers
24897 at the prologue and epilogue of a function.  The external functions
24898 are slower, but use less code space if more than one function saves
24899 the same number of registers.  The @option{-mprolog-function} option
24900 is on by default if you optimize.
24902 @item -mspace
24903 @opindex mspace
24904 Try to make the code as small as possible.  At present, this just turns
24905 on the @option{-mep} and @option{-mprolog-function} options.
24907 @item -mtda=@var{n}
24908 @opindex mtda
24909 Put static or global variables whose size is @var{n} bytes or less into
24910 the tiny data area that register @code{ep} points to.  The tiny data
24911 area can hold up to 256 bytes in total (128 bytes for byte references).
24913 @item -msda=@var{n}
24914 @opindex msda
24915 Put static or global variables whose size is @var{n} bytes or less into
24916 the small data area that register @code{gp} points to.  The small data
24917 area can hold up to 64 kilobytes.
24919 @item -mzda=@var{n}
24920 @opindex mzda
24921 Put static or global variables whose size is @var{n} bytes or less into
24922 the first 32 kilobytes of memory.
24924 @item -mv850
24925 @opindex mv850
24926 Specify that the target processor is the V850.
24928 @item -mv850e3v5
24929 @opindex mv850e3v5
24930 Specify that the target processor is the V850E3V5.  The preprocessor
24931 constant @code{__v850e3v5__} is defined if this option is used.
24933 @item -mv850e2v4
24934 @opindex mv850e2v4
24935 Specify that the target processor is the V850E3V5.  This is an alias for
24936 the @option{-mv850e3v5} option.
24938 @item -mv850e2v3
24939 @opindex mv850e2v3
24940 Specify that the target processor is the V850E2V3.  The preprocessor
24941 constant @code{__v850e2v3__} is defined if this option is used.
24943 @item -mv850e2
24944 @opindex mv850e2
24945 Specify that the target processor is the V850E2.  The preprocessor
24946 constant @code{__v850e2__} is defined if this option is used.
24948 @item -mv850e1
24949 @opindex mv850e1
24950 Specify that the target processor is the V850E1.  The preprocessor
24951 constants @code{__v850e1__} and @code{__v850e__} are defined if
24952 this option is used.
24954 @item -mv850es
24955 @opindex mv850es
24956 Specify that the target processor is the V850ES.  This is an alias for
24957 the @option{-mv850e1} option.
24959 @item -mv850e
24960 @opindex mv850e
24961 Specify that the target processor is the V850E@.  The preprocessor
24962 constant @code{__v850e__} is defined if this option is used.
24964 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24965 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24966 are defined then a default target processor is chosen and the
24967 relevant @samp{__v850*__} preprocessor constant is defined.
24969 The preprocessor constants @code{__v850} and @code{__v851__} are always
24970 defined, regardless of which processor variant is the target.
24972 @item -mdisable-callt
24973 @itemx -mno-disable-callt
24974 @opindex mdisable-callt
24975 @opindex mno-disable-callt
24976 This option suppresses generation of the @code{CALLT} instruction for the
24977 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24978 architecture.
24980 This option is enabled by default when the RH850 ABI is
24981 in use (see @option{-mrh850-abi}), and disabled by default when the
24982 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24983 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24985 @item -mrelax
24986 @itemx -mno-relax
24987 @opindex mrelax
24988 @opindex mno-relax
24989 Pass on (or do not pass on) the @option{-mrelax} command-line option
24990 to the assembler.
24992 @item -mlong-jumps
24993 @itemx -mno-long-jumps
24994 @opindex mlong-jumps
24995 @opindex mno-long-jumps
24996 Disable (or re-enable) the generation of PC-relative jump instructions.
24998 @item -msoft-float
24999 @itemx -mhard-float
25000 @opindex msoft-float
25001 @opindex mhard-float
25002 Disable (or re-enable) the generation of hardware floating point
25003 instructions.  This option is only significant when the target
25004 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25005 instructions are being generated then the C preprocessor symbol
25006 @code{__FPU_OK__} is defined, otherwise the symbol
25007 @code{__NO_FPU__} is defined.
25009 @item -mloop
25010 @opindex mloop
25011 Enables the use of the e3v5 LOOP instruction.  The use of this
25012 instruction is not enabled by default when the e3v5 architecture is
25013 selected because its use is still experimental.
25015 @item -mrh850-abi
25016 @itemx -mghs
25017 @opindex mrh850-abi
25018 @opindex mghs
25019 Enables support for the RH850 version of the V850 ABI.  This is the
25020 default.  With this version of the ABI the following rules apply:
25022 @itemize
25023 @item
25024 Integer sized structures and unions are returned via a memory pointer
25025 rather than a register.
25027 @item
25028 Large structures and unions (more than 8 bytes in size) are passed by
25029 value.
25031 @item
25032 Functions are aligned to 16-bit boundaries.
25034 @item
25035 The @option{-m8byte-align} command-line option is supported.
25037 @item
25038 The @option{-mdisable-callt} command-line option is enabled by
25039 default.  The @option{-mno-disable-callt} command-line option is not
25040 supported.
25041 @end itemize
25043 When this version of the ABI is enabled the C preprocessor symbol
25044 @code{__V850_RH850_ABI__} is defined.
25046 @item -mgcc-abi
25047 @opindex mgcc-abi
25048 Enables support for the old GCC version of the V850 ABI.  With this
25049 version of the ABI the following rules apply:
25051 @itemize
25052 @item
25053 Integer sized structures and unions are returned in register @code{r10}.
25055 @item
25056 Large structures and unions (more than 8 bytes in size) are passed by
25057 reference.
25059 @item
25060 Functions are aligned to 32-bit boundaries, unless optimizing for
25061 size.
25063 @item
25064 The @option{-m8byte-align} command-line option is not supported.
25066 @item
25067 The @option{-mdisable-callt} command-line option is supported but not
25068 enabled by default.
25069 @end itemize
25071 When this version of the ABI is enabled the C preprocessor symbol
25072 @code{__V850_GCC_ABI__} is defined.
25074 @item -m8byte-align
25075 @itemx -mno-8byte-align
25076 @opindex m8byte-align
25077 @opindex mno-8byte-align
25078 Enables support for @code{double} and @code{long long} types to be
25079 aligned on 8-byte boundaries.  The default is to restrict the
25080 alignment of all objects to at most 4-bytes.  When
25081 @option{-m8byte-align} is in effect the C preprocessor symbol
25082 @code{__V850_8BYTE_ALIGN__} is defined.
25084 @item -mbig-switch
25085 @opindex mbig-switch
25086 Generate code suitable for big switch tables.  Use this option only if
25087 the assembler/linker complain about out of range branches within a switch
25088 table.
25090 @item -mapp-regs
25091 @opindex mapp-regs
25092 This option causes r2 and r5 to be used in the code generated by
25093 the compiler.  This setting is the default.
25095 @item -mno-app-regs
25096 @opindex mno-app-regs
25097 This option causes r2 and r5 to be treated as fixed registers.
25099 @end table
25101 @node VAX Options
25102 @subsection VAX Options
25103 @cindex VAX options
25105 These @samp{-m} options are defined for the VAX:
25107 @table @gcctabopt
25108 @item -munix
25109 @opindex munix
25110 Do not output certain jump instructions (@code{aobleq} and so on)
25111 that the Unix assembler for the VAX cannot handle across long
25112 ranges.
25114 @item -mgnu
25115 @opindex mgnu
25116 Do output those jump instructions, on the assumption that the
25117 GNU assembler is being used.
25119 @item -mg
25120 @opindex mg
25121 Output code for G-format floating-point numbers instead of D-format.
25122 @end table
25124 @node Visium Options
25125 @subsection Visium Options
25126 @cindex Visium options
25128 @table @gcctabopt
25130 @item -mdebug
25131 @opindex mdebug
25132 A program which performs file I/O and is destined to run on an MCM target
25133 should be linked with this option.  It causes the libraries libc.a and
25134 libdebug.a to be linked.  The program should be run on the target under
25135 the control of the GDB remote debugging stub.
25137 @item -msim
25138 @opindex msim
25139 A program which performs file I/O and is destined to run on the simulator
25140 should be linked with option.  This causes libraries libc.a and libsim.a to
25141 be linked.
25143 @item -mfpu
25144 @itemx -mhard-float
25145 @opindex mfpu
25146 @opindex mhard-float
25147 Generate code containing floating-point instructions.  This is the
25148 default.
25150 @item -mno-fpu
25151 @itemx -msoft-float
25152 @opindex mno-fpu
25153 @opindex msoft-float
25154 Generate code containing library calls for floating-point.
25156 @option{-msoft-float} changes the calling convention in the output file;
25157 therefore, it is only useful if you compile @emph{all} of a program with
25158 this option.  In particular, you need to compile @file{libgcc.a}, the
25159 library that comes with GCC, with @option{-msoft-float} in order for
25160 this to work.
25162 @item -mcpu=@var{cpu_type}
25163 @opindex mcpu
25164 Set the instruction set, register set, and instruction scheduling parameters
25165 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25166 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25168 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25170 By default (unless configured otherwise), GCC generates code for the GR5
25171 variant of the Visium architecture.  
25173 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25174 architecture.  The only difference from GR5 code is that the compiler will
25175 generate block move instructions.
25177 @item -mtune=@var{cpu_type}
25178 @opindex mtune
25179 Set the instruction scheduling parameters for machine type @var{cpu_type},
25180 but do not set the instruction set or register set that the option
25181 @option{-mcpu=@var{cpu_type}} would.
25183 @item -msv-mode
25184 @opindex msv-mode
25185 Generate code for the supervisor mode, where there are no restrictions on
25186 the access to general registers.  This is the default.
25188 @item -muser-mode
25189 @opindex muser-mode
25190 Generate code for the user mode, where the access to some general registers
25191 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25192 mode; on the GR6, only registers r29 to r31 are affected.
25193 @end table
25195 @node VMS Options
25196 @subsection VMS Options
25198 These @samp{-m} options are defined for the VMS implementations:
25200 @table @gcctabopt
25201 @item -mvms-return-codes
25202 @opindex mvms-return-codes
25203 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25204 condition (e.g.@ error) codes.
25206 @item -mdebug-main=@var{prefix}
25207 @opindex mdebug-main=@var{prefix}
25208 Flag the first routine whose name starts with @var{prefix} as the main
25209 routine for the debugger.
25211 @item -mmalloc64
25212 @opindex mmalloc64
25213 Default to 64-bit memory allocation routines.
25215 @item -mpointer-size=@var{size}
25216 @opindex mpointer-size=@var{size}
25217 Set the default size of pointers. Possible options for @var{size} are
25218 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25219 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25220 The later option disables @code{pragma pointer_size}.
25221 @end table
25223 @node VxWorks Options
25224 @subsection VxWorks Options
25225 @cindex VxWorks Options
25227 The options in this section are defined for all VxWorks targets.
25228 Options specific to the target hardware are listed with the other
25229 options for that target.
25231 @table @gcctabopt
25232 @item -mrtp
25233 @opindex mrtp
25234 GCC can generate code for both VxWorks kernels and real time processes
25235 (RTPs).  This option switches from the former to the latter.  It also
25236 defines the preprocessor macro @code{__RTP__}.
25238 @item -non-static
25239 @opindex non-static
25240 Link an RTP executable against shared libraries rather than static
25241 libraries.  The options @option{-static} and @option{-shared} can
25242 also be used for RTPs (@pxref{Link Options}); @option{-static}
25243 is the default.
25245 @item -Bstatic
25246 @itemx -Bdynamic
25247 @opindex Bstatic
25248 @opindex Bdynamic
25249 These options are passed down to the linker.  They are defined for
25250 compatibility with Diab.
25252 @item -Xbind-lazy
25253 @opindex Xbind-lazy
25254 Enable lazy binding of function calls.  This option is equivalent to
25255 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25257 @item -Xbind-now
25258 @opindex Xbind-now
25259 Disable lazy binding of function calls.  This option is the default and
25260 is defined for compatibility with Diab.
25261 @end table
25263 @node x86 Options
25264 @subsection x86 Options
25265 @cindex x86 Options
25267 These @samp{-m} options are defined for the x86 family of computers.
25269 @table @gcctabopt
25271 @item -march=@var{cpu-type}
25272 @opindex march
25273 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25274 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25275 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25276 to generate code that may not run at all on processors other than the one
25277 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25278 @option{-mtune=@var{cpu-type}}.
25280 The choices for @var{cpu-type} are:
25282 @table @samp
25283 @item native
25284 This selects the CPU to generate code for at compilation time by determining
25285 the processor type of the compiling machine.  Using @option{-march=native}
25286 enables all instruction subsets supported by the local machine (hence
25287 the result might not run on different machines).  Using @option{-mtune=native}
25288 produces code optimized for the local machine under the constraints
25289 of the selected instruction set.  
25291 @item i386
25292 Original Intel i386 CPU@.
25294 @item i486
25295 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25297 @item i586
25298 @itemx pentium
25299 Intel Pentium CPU with no MMX support.
25301 @item lakemont
25302 Intel Lakemont MCU, based on Intel Pentium CPU.
25304 @item pentium-mmx
25305 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25307 @item pentiumpro
25308 Intel Pentium Pro CPU@.
25310 @item i686
25311 When used with @option{-march}, the Pentium Pro
25312 instruction set is used, so the code runs on all i686 family chips.
25313 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25315 @item pentium2
25316 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25317 support.
25319 @item pentium3
25320 @itemx pentium3m
25321 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25322 set support.
25324 @item pentium-m
25325 Intel Pentium M; low-power version of Intel Pentium III CPU
25326 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25328 @item pentium4
25329 @itemx pentium4m
25330 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25332 @item prescott
25333 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25334 set support.
25336 @item nocona
25337 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25338 SSE2 and SSE3 instruction set support.
25340 @item core2
25341 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25342 instruction set support.
25344 @item nehalem
25345 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25346 SSE4.1, SSE4.2 and POPCNT instruction set support.
25348 @item westmere
25349 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25350 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25352 @item sandybridge
25353 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25354 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25356 @item ivybridge
25357 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25358 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25359 instruction set support.
25361 @item haswell
25362 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25363 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25364 BMI, BMI2 and F16C instruction set support.
25366 @item broadwell
25367 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25368 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25369 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25371 @item skylake
25372 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25373 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25374 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25375 XSAVES instruction set support.
25377 @item bonnell
25378 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25379 instruction set support.
25381 @item silvermont
25382 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25383 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25385 @item knl
25386 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25387 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25388 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25389 AVX512CD instruction set support.
25391 @item knm
25392 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25393 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25394 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25395 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25397 @item skylake-avx512
25398 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25399 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25400 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25401 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25403 @item cannonlake
25404 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25405 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25406 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25407 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25408 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25410 @item k6
25411 AMD K6 CPU with MMX instruction set support.
25413 @item k6-2
25414 @itemx k6-3
25415 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25417 @item athlon
25418 @itemx athlon-tbird
25419 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25420 support.
25422 @item athlon-4
25423 @itemx athlon-xp
25424 @itemx athlon-mp
25425 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25426 instruction set support.
25428 @item k8
25429 @itemx opteron
25430 @itemx athlon64
25431 @itemx athlon-fx
25432 Processors based on the AMD K8 core with x86-64 instruction set support,
25433 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25434 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25435 instruction set extensions.)
25437 @item k8-sse3
25438 @itemx opteron-sse3
25439 @itemx athlon64-sse3
25440 Improved versions of AMD K8 cores with SSE3 instruction set support.
25442 @item amdfam10
25443 @itemx barcelona
25444 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25445 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25446 instruction set extensions.)
25448 @item bdver1
25449 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25450 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25451 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25452 @item bdver2
25453 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25454 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25455 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25456 extensions.)
25457 @item bdver3
25458 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25459 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25460 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25461 64-bit instruction set extensions.
25462 @item bdver4
25463 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25464 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25465 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25466 SSE4.2, ABM and 64-bit instruction set extensions.
25468 @item znver1
25469 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25470 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25471 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25472 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25473 instruction set extensions.
25475 @item btver1
25476 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25477 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25478 instruction set extensions.)
25480 @item btver2
25481 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25482 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25483 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25485 @item winchip-c6
25486 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25487 set support.
25489 @item winchip2
25490 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25491 instruction set support.
25493 @item c3
25494 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25495 (No scheduling is implemented for this chip.)
25497 @item c3-2
25498 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25499 (No scheduling is implemented for this chip.)
25501 @item c7
25502 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25503 (No scheduling is implemented for this chip.)
25505 @item samuel-2
25506 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25507 (No scheduling is implemented for this chip.)
25509 @item nehemiah
25510 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25511 (No scheduling is implemented for this chip.)
25513 @item esther
25514 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25515 (No scheduling is implemented for this chip.)
25517 @item eden-x2
25518 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25519 (No scheduling is implemented for this chip.)
25521 @item eden-x4
25522 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25523 AVX and AVX2 instruction set support.
25524 (No scheduling is implemented for this chip.)
25526 @item nano
25527 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25528 instruction set support.
25529 (No scheduling is implemented for this chip.)
25531 @item nano-1000
25532 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25533 instruction set support.
25534 (No scheduling is implemented for this chip.)
25536 @item nano-2000
25537 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25538 instruction set support.
25539 (No scheduling is implemented for this chip.)
25541 @item nano-3000
25542 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25543 instruction set support.
25544 (No scheduling is implemented for this chip.)
25546 @item nano-x2
25547 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25548 instruction set support.
25549 (No scheduling is implemented for this chip.)
25551 @item nano-x4
25552 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25553 instruction set support.
25554 (No scheduling is implemented for this chip.)
25556 @item geode
25557 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25558 @end table
25560 @item -mtune=@var{cpu-type}
25561 @opindex mtune
25562 Tune to @var{cpu-type} everything applicable about the generated code, except
25563 for the ABI and the set of available instructions.  
25564 While picking a specific @var{cpu-type} schedules things appropriately
25565 for that particular chip, the compiler does not generate any code that
25566 cannot run on the default machine type unless you use a
25567 @option{-march=@var{cpu-type}} option.
25568 For example, if GCC is configured for i686-pc-linux-gnu
25569 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25570 but still runs on i686 machines.
25572 The choices for @var{cpu-type} are the same as for @option{-march}.
25573 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25575 @table @samp
25576 @item generic
25577 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25578 If you know the CPU on which your code will run, then you should use
25579 the corresponding @option{-mtune} or @option{-march} option instead of
25580 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25581 of your application will have, then you should use this option.
25583 As new processors are deployed in the marketplace, the behavior of this
25584 option will change.  Therefore, if you upgrade to a newer version of
25585 GCC, code generation controlled by this option will change to reflect
25586 the processors
25587 that are most common at the time that version of GCC is released.
25589 There is no @option{-march=generic} option because @option{-march}
25590 indicates the instruction set the compiler can use, and there is no
25591 generic instruction set applicable to all processors.  In contrast,
25592 @option{-mtune} indicates the processor (or, in this case, collection of
25593 processors) for which the code is optimized.
25595 @item intel
25596 Produce code optimized for the most current Intel processors, which are
25597 Haswell and Silvermont for this version of GCC.  If you know the CPU
25598 on which your code will run, then you should use the corresponding
25599 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25600 But, if you want your application performs better on both Haswell and
25601 Silvermont, then you should use this option.
25603 As new Intel processors are deployed in the marketplace, the behavior of
25604 this option will change.  Therefore, if you upgrade to a newer version of
25605 GCC, code generation controlled by this option will change to reflect
25606 the most current Intel processors at the time that version of GCC is
25607 released.
25609 There is no @option{-march=intel} option because @option{-march} indicates
25610 the instruction set the compiler can use, and there is no common
25611 instruction set applicable to all processors.  In contrast,
25612 @option{-mtune} indicates the processor (or, in this case, collection of
25613 processors) for which the code is optimized.
25614 @end table
25616 @item -mcpu=@var{cpu-type}
25617 @opindex mcpu
25618 A deprecated synonym for @option{-mtune}.
25620 @item -mfpmath=@var{unit}
25621 @opindex mfpmath
25622 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25623 for @var{unit} are:
25625 @table @samp
25626 @item 387
25627 Use the standard 387 floating-point coprocessor present on the majority of chips and
25628 emulated otherwise.  Code compiled with this option runs almost everywhere.
25629 The temporary results are computed in 80-bit precision instead of the precision
25630 specified by the type, resulting in slightly different results compared to most
25631 of other chips.  See @option{-ffloat-store} for more detailed description.
25633 This is the default choice for non-Darwin x86-32 targets.
25635 @item sse
25636 Use scalar floating-point instructions present in the SSE instruction set.
25637 This instruction set is supported by Pentium III and newer chips,
25638 and in the AMD line
25639 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25640 instruction set supports only single-precision arithmetic, thus the double and
25641 extended-precision arithmetic are still done using 387.  A later version, present
25642 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25643 arithmetic too.
25645 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25646 or @option{-msse2} switches to enable SSE extensions and make this option
25647 effective.  For the x86-64 compiler, these extensions are enabled by default.
25649 The resulting code should be considerably faster in the majority of cases and avoid
25650 the numerical instability problems of 387 code, but may break some existing
25651 code that expects temporaries to be 80 bits.
25653 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25654 and the default choice for x86-32 targets with the SSE2 instruction set
25655 when @option{-ffast-math} is enabled.
25657 @item sse,387
25658 @itemx sse+387
25659 @itemx both
25660 Attempt to utilize both instruction sets at once.  This effectively doubles the
25661 amount of available registers, and on chips with separate execution units for
25662 387 and SSE the execution resources too.  Use this option with care, as it is
25663 still experimental, because the GCC register allocator does not model separate
25664 functional units well, resulting in unstable performance.
25665 @end table
25667 @item -masm=@var{dialect}
25668 @opindex masm=@var{dialect}
25669 Output assembly instructions using selected @var{dialect}.  Also affects
25670 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25671 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25672 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25673 not support @samp{intel}.
25675 @item -mieee-fp
25676 @itemx -mno-ieee-fp
25677 @opindex mieee-fp
25678 @opindex mno-ieee-fp
25679 Control whether or not the compiler uses IEEE floating-point
25680 comparisons.  These correctly handle the case where the result of a
25681 comparison is unordered.
25683 @item -m80387
25684 @item -mhard-float
25685 @opindex 80387
25686 @opindex mhard-float
25687 Generate output containing 80387 instructions for floating point.
25689 @item -mno-80387
25690 @item -msoft-float
25691 @opindex no-80387
25692 @opindex msoft-float
25693 Generate output containing library calls for floating point.
25695 @strong{Warning:} the requisite libraries are not part of GCC@.
25696 Normally the facilities of the machine's usual C compiler are used, but
25697 this cannot be done directly in cross-compilation.  You must make your
25698 own arrangements to provide suitable library functions for
25699 cross-compilation.
25701 On machines where a function returns floating-point results in the 80387
25702 register stack, some floating-point opcodes may be emitted even if
25703 @option{-msoft-float} is used.
25705 @item -mno-fp-ret-in-387
25706 @opindex mno-fp-ret-in-387
25707 Do not use the FPU registers for return values of functions.
25709 The usual calling convention has functions return values of types
25710 @code{float} and @code{double} in an FPU register, even if there
25711 is no FPU@.  The idea is that the operating system should emulate
25712 an FPU@.
25714 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25715 in ordinary CPU registers instead.
25717 @item -mno-fancy-math-387
25718 @opindex mno-fancy-math-387
25719 Some 387 emulators do not support the @code{sin}, @code{cos} and
25720 @code{sqrt} instructions for the 387.  Specify this option to avoid
25721 generating those instructions.  This option is the default on
25722 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25723 indicates that the target CPU always has an FPU and so the
25724 instruction does not need emulation.  These
25725 instructions are not generated unless you also use the
25726 @option{-funsafe-math-optimizations} switch.
25728 @item -malign-double
25729 @itemx -mno-align-double
25730 @opindex malign-double
25731 @opindex mno-align-double
25732 Control whether GCC aligns @code{double}, @code{long double}, and
25733 @code{long long} variables on a two-word boundary or a one-word
25734 boundary.  Aligning @code{double} variables on a two-word boundary
25735 produces code that runs somewhat faster on a Pentium at the
25736 expense of more memory.
25738 On x86-64, @option{-malign-double} is enabled by default.
25740 @strong{Warning:} if you use the @option{-malign-double} switch,
25741 structures containing the above types are aligned differently than
25742 the published application binary interface specifications for the x86-32
25743 and are not binary compatible with structures in code compiled
25744 without that switch.
25746 @item -m96bit-long-double
25747 @itemx -m128bit-long-double
25748 @opindex m96bit-long-double
25749 @opindex m128bit-long-double
25750 These switches control the size of @code{long double} type.  The x86-32
25751 application binary interface specifies the size to be 96 bits,
25752 so @option{-m96bit-long-double} is the default in 32-bit mode.
25754 Modern architectures (Pentium and newer) prefer @code{long double}
25755 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25756 conforming to the ABI, this is not possible.  So specifying
25757 @option{-m128bit-long-double} aligns @code{long double}
25758 to a 16-byte boundary by padding the @code{long double} with an additional
25759 32-bit zero.
25761 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25762 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25764 Notice that neither of these options enable any extra precision over the x87
25765 standard of 80 bits for a @code{long double}.
25767 @strong{Warning:} if you override the default value for your target ABI, this
25768 changes the size of 
25769 structures and arrays containing @code{long double} variables,
25770 as well as modifying the function calling convention for functions taking
25771 @code{long double}.  Hence they are not binary-compatible
25772 with code compiled without that switch.
25774 @item -mlong-double-64
25775 @itemx -mlong-double-80
25776 @itemx -mlong-double-128
25777 @opindex mlong-double-64
25778 @opindex mlong-double-80
25779 @opindex mlong-double-128
25780 These switches control the size of @code{long double} type. A size
25781 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25782 type. This is the default for 32-bit Bionic C library.  A size
25783 of 128 bits makes the @code{long double} type equivalent to the
25784 @code{__float128} type. This is the default for 64-bit Bionic C library.
25786 @strong{Warning:} if you override the default value for your target ABI, this
25787 changes the size of
25788 structures and arrays containing @code{long double} variables,
25789 as well as modifying the function calling convention for functions taking
25790 @code{long double}.  Hence they are not binary-compatible
25791 with code compiled without that switch.
25793 @item -malign-data=@var{type}
25794 @opindex malign-data
25795 Control how GCC aligns variables.  Supported values for @var{type} are
25796 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25797 and earlier, @samp{abi} uses alignment value as specified by the
25798 psABI, and @samp{cacheline} uses increased alignment value to match
25799 the cache line size.  @samp{compat} is the default.
25801 @item -mlarge-data-threshold=@var{threshold}
25802 @opindex mlarge-data-threshold
25803 When @option{-mcmodel=medium} is specified, data objects larger than
25804 @var{threshold} are placed in the large data section.  This value must be the
25805 same across all objects linked into the binary, and defaults to 65535.
25807 @item -mrtd
25808 @opindex mrtd
25809 Use a different function-calling convention, in which functions that
25810 take a fixed number of arguments return with the @code{ret @var{num}}
25811 instruction, which pops their arguments while returning.  This saves one
25812 instruction in the caller since there is no need to pop the arguments
25813 there.
25815 You can specify that an individual function is called with this calling
25816 sequence with the function attribute @code{stdcall}.  You can also
25817 override the @option{-mrtd} option by using the function attribute
25818 @code{cdecl}.  @xref{Function Attributes}.
25820 @strong{Warning:} this calling convention is incompatible with the one
25821 normally used on Unix, so you cannot use it if you need to call
25822 libraries compiled with the Unix compiler.
25824 Also, you must provide function prototypes for all functions that
25825 take variable numbers of arguments (including @code{printf});
25826 otherwise incorrect code is generated for calls to those
25827 functions.
25829 In addition, seriously incorrect code results if you call a
25830 function with too many arguments.  (Normally, extra arguments are
25831 harmlessly ignored.)
25833 @item -mregparm=@var{num}
25834 @opindex mregparm
25835 Control how many registers are used to pass integer arguments.  By
25836 default, no registers are used to pass arguments, and at most 3
25837 registers can be used.  You can control this behavior for a specific
25838 function by using the function attribute @code{regparm}.
25839 @xref{Function Attributes}.
25841 @strong{Warning:} if you use this switch, and
25842 @var{num} is nonzero, then you must build all modules with the same
25843 value, including any libraries.  This includes the system libraries and
25844 startup modules.
25846 @item -msseregparm
25847 @opindex msseregparm
25848 Use SSE register passing conventions for float and double arguments
25849 and return values.  You can control this behavior for a specific
25850 function by using the function attribute @code{sseregparm}.
25851 @xref{Function Attributes}.
25853 @strong{Warning:} if you use this switch then you must build all
25854 modules with the same value, including any libraries.  This includes
25855 the system libraries and startup modules.
25857 @item -mvect8-ret-in-mem
25858 @opindex mvect8-ret-in-mem
25859 Return 8-byte vectors in memory instead of MMX registers.  This is the
25860 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25861 Studio compilers until version 12.  Later compiler versions (starting
25862 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25863 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25864 you need to remain compatible with existing code produced by those
25865 previous compiler versions or older versions of GCC@.
25867 @item -mpc32
25868 @itemx -mpc64
25869 @itemx -mpc80
25870 @opindex mpc32
25871 @opindex mpc64
25872 @opindex mpc80
25874 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25875 is specified, the significands of results of floating-point operations are
25876 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25877 significands of results of floating-point operations to 53 bits (double
25878 precision) and @option{-mpc80} rounds the significands of results of
25879 floating-point operations to 64 bits (extended double precision), which is
25880 the default.  When this option is used, floating-point operations in higher
25881 precisions are not available to the programmer without setting the FPU
25882 control word explicitly.
25884 Setting the rounding of floating-point operations to less than the default
25885 80 bits can speed some programs by 2% or more.  Note that some mathematical
25886 libraries assume that extended-precision (80-bit) floating-point operations
25887 are enabled by default; routines in such libraries could suffer significant
25888 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25889 when this option is used to set the precision to less than extended precision.
25891 @item -mstackrealign
25892 @opindex mstackrealign
25893 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25894 option generates an alternate prologue and epilogue that realigns the
25895 run-time stack if necessary.  This supports mixing legacy codes that keep
25896 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25897 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25898 applicable to individual functions.
25900 @item -mpreferred-stack-boundary=@var{num}
25901 @opindex mpreferred-stack-boundary
25902 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25903 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25904 the default is 4 (16 bytes or 128 bits).
25906 @strong{Warning:} When generating code for the x86-64 architecture with
25907 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25908 used to keep the stack boundary aligned to 8 byte boundary.  Since
25909 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25910 intended to be used in controlled environment where stack space is
25911 important limitation.  This option leads to wrong code when functions
25912 compiled with 16 byte stack alignment (such as functions from a standard
25913 library) are called with misaligned stack.  In this case, SSE
25914 instructions may lead to misaligned memory access traps.  In addition,
25915 variable arguments are handled incorrectly for 16 byte aligned
25916 objects (including x87 long double and __int128), leading to wrong
25917 results.  You must build all modules with
25918 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25919 includes the system libraries and startup modules.
25921 @item -mincoming-stack-boundary=@var{num}
25922 @opindex mincoming-stack-boundary
25923 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25924 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25925 the one specified by @option{-mpreferred-stack-boundary} is used.
25927 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25928 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25929 suffer significant run time performance penalties.  On Pentium III, the
25930 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25931 properly if it is not 16-byte aligned.
25933 To ensure proper alignment of this values on the stack, the stack boundary
25934 must be as aligned as that required by any value stored on the stack.
25935 Further, every function must be generated such that it keeps the stack
25936 aligned.  Thus calling a function compiled with a higher preferred
25937 stack boundary from a function compiled with a lower preferred stack
25938 boundary most likely misaligns the stack.  It is recommended that
25939 libraries that use callbacks always use the default setting.
25941 This extra alignment does consume extra stack space, and generally
25942 increases code size.  Code that is sensitive to stack space usage, such
25943 as embedded systems and operating system kernels, may want to reduce the
25944 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25946 @need 200
25947 @item -mmmx
25948 @opindex mmmx
25949 @need 200
25950 @itemx -msse
25951 @opindex msse
25952 @need 200
25953 @itemx -msse2
25954 @opindex msse2
25955 @need 200
25956 @itemx -msse3
25957 @opindex msse3
25958 @need 200
25959 @itemx -mssse3
25960 @opindex mssse3
25961 @need 200
25962 @itemx -msse4
25963 @opindex msse4
25964 @need 200
25965 @itemx -msse4a
25966 @opindex msse4a
25967 @need 200
25968 @itemx -msse4.1
25969 @opindex msse4.1
25970 @need 200
25971 @itemx -msse4.2
25972 @opindex msse4.2
25973 @need 200
25974 @itemx -mavx
25975 @opindex mavx
25976 @need 200
25977 @itemx -mavx2
25978 @opindex mavx2
25979 @need 200
25980 @itemx -mavx512f
25981 @opindex mavx512f
25982 @need 200
25983 @itemx -mavx512pf
25984 @opindex mavx512pf
25985 @need 200
25986 @itemx -mavx512er
25987 @opindex mavx512er
25988 @need 200
25989 @itemx -mavx512cd
25990 @opindex mavx512cd
25991 @need 200
25992 @itemx -mavx512vl
25993 @opindex mavx512vl
25994 @need 200
25995 @itemx -mavx512bw
25996 @opindex mavx512bw
25997 @need 200
25998 @itemx -mavx512dq
25999 @opindex mavx512dq
26000 @need 200
26001 @itemx -mavx512ifma
26002 @opindex mavx512ifma
26003 @need 200
26004 @itemx -mavx512vbmi
26005 @opindex mavx512vbmi
26006 @need 200
26007 @itemx -msha
26008 @opindex msha
26009 @need 200
26010 @itemx -maes
26011 @opindex maes
26012 @need 200
26013 @itemx -mpclmul
26014 @opindex mpclmul
26015 @need 200
26016 @itemx -mclfushopt
26017 @opindex mclfushopt
26018 @need 200
26019 @itemx -mfsgsbase
26020 @opindex mfsgsbase
26021 @need 200
26022 @itemx -mrdrnd
26023 @opindex mrdrnd
26024 @need 200
26025 @itemx -mf16c
26026 @opindex mf16c
26027 @need 200
26028 @itemx -mfma
26029 @opindex mfma
26030 @need 200
26031 @itemx -mfma4
26032 @opindex mfma4
26033 @need 200
26034 @itemx -mprefetchwt1
26035 @opindex mprefetchwt1
26036 @need 200
26037 @itemx -mxop
26038 @opindex mxop
26039 @need 200
26040 @itemx -mlwp
26041 @opindex mlwp
26042 @need 200
26043 @itemx -m3dnow
26044 @opindex m3dnow
26045 @need 200
26046 @itemx -m3dnowa
26047 @opindex m3dnowa
26048 @need 200
26049 @itemx -mpopcnt
26050 @opindex mpopcnt
26051 @need 200
26052 @itemx -mabm
26053 @opindex mabm
26054 @need 200
26055 @itemx -mbmi
26056 @opindex mbmi
26057 @need 200
26058 @itemx -mbmi2
26059 @need 200
26060 @itemx -mlzcnt
26061 @opindex mlzcnt
26062 @need 200
26063 @itemx -mfxsr
26064 @opindex mfxsr
26065 @need 200
26066 @itemx -mxsave
26067 @opindex mxsave
26068 @need 200
26069 @itemx -mxsaveopt
26070 @opindex mxsaveopt
26071 @need 200
26072 @itemx -mxsavec
26073 @opindex mxsavec
26074 @need 200
26075 @itemx -mxsaves
26076 @opindex mxsaves
26077 @need 200
26078 @itemx -mrtm
26079 @opindex mrtm
26080 @need 200
26081 @itemx -mtbm
26082 @opindex mtbm
26083 @need 200
26084 @itemx -mmpx
26085 @opindex mmpx
26086 @need 200
26087 @itemx -mmwaitx
26088 @opindex mmwaitx
26089 @need 200
26090 @itemx -mclzero
26091 @opindex mclzero
26092 @need 200
26093 @itemx -mpku
26094 @opindex mpku
26095 @need 200
26096 @itemx -mcet
26097 @opindex mcet
26098 @need 200
26099 @itemx -mavx512vbmi2
26100 @opindex mavx512vbmi2
26101 @need 200
26102 @itemx -mgfni
26103 @opindex mgfni
26104 These switches enable the use of instructions in the MMX, SSE,
26105 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26106 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26107 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2,
26108 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26109 GFNI, 3DNow!@: or enhanced 3DNow!@: extended instruction sets.  Each has a
26110 corresponding @option{-mno-} option to disable use of these instructions.
26112 These extensions are also available as built-in functions: see
26113 @ref{x86 Built-in Functions}, for details of the functions enabled and
26114 disabled by these switches.
26116 To generate SSE/SSE2 instructions automatically from floating-point
26117 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26119 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26120 generates new AVX instructions or AVX equivalence for all SSEx instructions
26121 when needed.
26123 These options enable GCC to use these extended instructions in
26124 generated code, even without @option{-mfpmath=sse}.  Applications that
26125 perform run-time CPU detection must compile separate files for each
26126 supported architecture, using the appropriate flags.  In particular,
26127 the file containing the CPU detection code should be compiled without
26128 these options.
26130 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26131 options.  The @option{-mibt} option enables indirect branch tracking support
26132 and the @option{-mshstk} option enables shadow stack support from
26133 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26134 a number of built-in functions for fine-grained control in a CET-based
26135 application.  See @xref{x86 Built-in Functions}, for more information.
26137 @item -mdump-tune-features
26138 @opindex mdump-tune-features
26139 This option instructs GCC to dump the names of the x86 performance 
26140 tuning features and default settings. The names can be used in 
26141 @option{-mtune-ctrl=@var{feature-list}}.
26143 @item -mtune-ctrl=@var{feature-list}
26144 @opindex mtune-ctrl=@var{feature-list}
26145 This option is used to do fine grain control of x86 code generation features.
26146 @var{feature-list} is a comma separated list of @var{feature} names. See also
26147 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26148 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26149 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26150 developers. Using it may lead to code paths not covered by testing and can
26151 potentially result in compiler ICEs or runtime errors.
26153 @item -mno-default
26154 @opindex mno-default
26155 This option instructs GCC to turn off all tunable features. See also 
26156 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26158 @item -mcld
26159 @opindex mcld
26160 This option instructs GCC to emit a @code{cld} instruction in the prologue
26161 of functions that use string instructions.  String instructions depend on
26162 the DF flag to select between autoincrement or autodecrement mode.  While the
26163 ABI specifies the DF flag to be cleared on function entry, some operating
26164 systems violate this specification by not clearing the DF flag in their
26165 exception dispatchers.  The exception handler can be invoked with the DF flag
26166 set, which leads to wrong direction mode when string instructions are used.
26167 This option can be enabled by default on 32-bit x86 targets by configuring
26168 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26169 instructions can be suppressed with the @option{-mno-cld} compiler option
26170 in this case.
26172 @item -mvzeroupper
26173 @opindex mvzeroupper
26174 This option instructs GCC to emit a @code{vzeroupper} instruction
26175 before a transfer of control flow out of the function to minimize
26176 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26177 intrinsics.
26179 @item -mprefer-avx128
26180 @opindex mprefer-avx128
26181 This option instructs GCC to use 128-bit AVX instructions instead of
26182 256-bit AVX instructions in the auto-vectorizer.
26184 @item -mprefer-vector-width=@var{opt}
26185 @opindex mprefer-vector-width
26186 This option instructs GCC to use @var{opt}-bit vector width in instructions
26187 instead of default on the selected platform.
26189 @table @samp
26190 @item none
26191 No extra limitations applied to GCC other than defined by the selected platform.
26193 @item 128
26194 Prefer 128-bit vector width for instructions.
26196 @item 256
26197 Prefer 256-bit vector width for instructions.
26199 @item 512
26200 Prefer 512-bit vector width for instructions.
26201 @end table
26203 @item -mcx16
26204 @opindex mcx16
26205 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26206 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26207 objects.  This is useful for atomic updates of data structures exceeding one
26208 machine word in size.  The compiler uses this instruction to implement
26209 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26210 128-bit integers, a library call is always used.
26212 @item -msahf
26213 @opindex msahf
26214 This option enables generation of @code{SAHF} instructions in 64-bit code.
26215 Early Intel Pentium 4 CPUs with Intel 64 support,
26216 prior to the introduction of Pentium 4 G1 step in December 2005,
26217 lacked the @code{LAHF} and @code{SAHF} instructions
26218 which are supported by AMD64.
26219 These are load and store instructions, respectively, for certain status flags.
26220 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26221 @code{drem}, and @code{remainder} built-in functions;
26222 see @ref{Other Builtins} for details.
26224 @item -mmovbe
26225 @opindex mmovbe
26226 This option enables use of the @code{movbe} instruction to implement
26227 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26229 @item -mibt
26230 @opindex mibt
26231 This option tells the compiler to use indirect branch tracking support
26232 (for indirect calls and jumps) from x86 Control-flow Enforcement
26233 Technology (CET).  The option has effect only if the
26234 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26235 is specified. The option @option{-mibt} is on by default when the
26236 @code{-mcet} option is specified.
26238 @item -mshstk
26239 @opindex mshstk
26240 This option tells the compiler to use shadow stack support (return
26241 address tracking) from x86 Control-flow Enforcement Technology (CET).
26242 The option has effect only if the @option{-fcf-protection=full} or
26243 @option{-fcf-protection=return} option is specified.  The option
26244 @option{-mshstk} is on by default when the @option{-mcet} option is
26245 specified.
26247 @item -mcrc32
26248 @opindex mcrc32
26249 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26250 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26251 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26253 @item -mrecip
26254 @opindex mrecip
26255 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26256 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26257 with an additional Newton-Raphson step
26258 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26259 (and their vectorized
26260 variants) for single-precision floating-point arguments.  These instructions
26261 are generated only when @option{-funsafe-math-optimizations} is enabled
26262 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26263 Note that while the throughput of the sequence is higher than the throughput
26264 of the non-reciprocal instruction, the precision of the sequence can be
26265 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26267 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26268 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26269 combination), and doesn't need @option{-mrecip}.
26271 Also note that GCC emits the above sequence with additional Newton-Raphson step
26272 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26273 already with @option{-ffast-math} (or the above option combination), and
26274 doesn't need @option{-mrecip}.
26276 @item -mrecip=@var{opt}
26277 @opindex mrecip=opt
26278 This option controls which reciprocal estimate instructions
26279 may be used.  @var{opt} is a comma-separated list of options, which may
26280 be preceded by a @samp{!} to invert the option:
26282 @table @samp
26283 @item all
26284 Enable all estimate instructions.
26286 @item default
26287 Enable the default instructions, equivalent to @option{-mrecip}.
26289 @item none
26290 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26292 @item div
26293 Enable the approximation for scalar division.
26295 @item vec-div
26296 Enable the approximation for vectorized division.
26298 @item sqrt
26299 Enable the approximation for scalar square root.
26301 @item vec-sqrt
26302 Enable the approximation for vectorized square root.
26303 @end table
26305 So, for example, @option{-mrecip=all,!sqrt} enables
26306 all of the reciprocal approximations, except for square root.
26308 @item -mveclibabi=@var{type}
26309 @opindex mveclibabi
26310 Specifies the ABI type to use for vectorizing intrinsics using an
26311 external library.  Supported values for @var{type} are @samp{svml} 
26312 for the Intel short
26313 vector math library and @samp{acml} for the AMD math core library.
26314 To use this option, both @option{-ftree-vectorize} and
26315 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26316 ABI-compatible library must be specified at link time.
26318 GCC currently emits calls to @code{vmldExp2},
26319 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26320 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26321 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26322 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26323 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26324 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26325 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26326 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26327 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26328 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26329 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26330 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26331 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26332 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26333 when @option{-mveclibabi=acml} is used.  
26335 @item -mabi=@var{name}
26336 @opindex mabi
26337 Generate code for the specified calling convention.  Permissible values
26338 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26339 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26340 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26341 You can control this behavior for specific functions by
26342 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26343 @xref{Function Attributes}.
26345 @item -mforce-indirect-call
26346 @opindex mforce-indirect-call
26347 Force all calls to functions to be indirect. This is useful
26348 when using Intel Processor Trace where it generates more precise timing
26349 information for function calls.
26351 @item -mcall-ms2sysv-xlogues
26352 @opindex mcall-ms2sysv-xlogues
26353 @opindex mno-call-ms2sysv-xlogues
26354 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26355 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26356 default, the code for saving and restoring these registers is emitted inline,
26357 resulting in fairly lengthy prologues and epilogues.  Using
26358 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26359 use stubs in the static portion of libgcc to perform these saves and restores,
26360 thus reducing function size at the cost of a few extra instructions.
26362 @item -mtls-dialect=@var{type}
26363 @opindex mtls-dialect
26364 Generate code to access thread-local storage using the @samp{gnu} or
26365 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26366 @samp{gnu2} is more efficient, but it may add compile- and run-time
26367 requirements that cannot be satisfied on all systems.
26369 @item -mpush-args
26370 @itemx -mno-push-args
26371 @opindex mpush-args
26372 @opindex mno-push-args
26373 Use PUSH operations to store outgoing parameters.  This method is shorter
26374 and usually equally fast as method using SUB/MOV operations and is enabled
26375 by default.  In some cases disabling it may improve performance because of
26376 improved scheduling and reduced dependencies.
26378 @item -maccumulate-outgoing-args
26379 @opindex maccumulate-outgoing-args
26380 If enabled, the maximum amount of space required for outgoing arguments is
26381 computed in the function prologue.  This is faster on most modern CPUs
26382 because of reduced dependencies, improved scheduling and reduced stack usage
26383 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26384 increase in code size.  This switch implies @option{-mno-push-args}.
26386 @item -mthreads
26387 @opindex mthreads
26388 Support thread-safe exception handling on MinGW.  Programs that rely
26389 on thread-safe exception handling must compile and link all code with the
26390 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26391 @option{-D_MT}; when linking, it links in a special thread helper library
26392 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26394 @item -mms-bitfields
26395 @itemx -mno-ms-bitfields
26396 @opindex mms-bitfields
26397 @opindex mno-ms-bitfields
26399 Enable/disable bit-field layout compatible with the native Microsoft
26400 Windows compiler.  
26402 If @code{packed} is used on a structure, or if bit-fields are used,
26403 it may be that the Microsoft ABI lays out the structure differently
26404 than the way GCC normally does.  Particularly when moving packed
26405 data between functions compiled with GCC and the native Microsoft compiler
26406 (either via function call or as data in a file), it may be necessary to access
26407 either format.
26409 This option is enabled by default for Microsoft Windows
26410 targets.  This behavior can also be controlled locally by use of variable
26411 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26412 and @ref{x86 Type Attributes}.
26414 The Microsoft structure layout algorithm is fairly simple with the exception
26415 of the bit-field packing.  
26416 The padding and alignment of members of structures and whether a bit-field 
26417 can straddle a storage-unit boundary are determine by these rules:
26419 @enumerate
26420 @item Structure members are stored sequentially in the order in which they are
26421 declared: the first member has the lowest memory address and the last member
26422 the highest.
26424 @item Every data object has an alignment requirement.  The alignment requirement
26425 for all data except structures, unions, and arrays is either the size of the
26426 object or the current packing size (specified with either the
26427 @code{aligned} attribute or the @code{pack} pragma),
26428 whichever is less.  For structures, unions, and arrays,
26429 the alignment requirement is the largest alignment requirement of its members.
26430 Every object is allocated an offset so that:
26432 @smallexample
26433 offset % alignment_requirement == 0
26434 @end smallexample
26436 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26437 unit if the integral types are the same size and if the next bit-field fits
26438 into the current allocation unit without crossing the boundary imposed by the
26439 common alignment requirements of the bit-fields.
26440 @end enumerate
26442 MSVC interprets zero-length bit-fields in the following ways:
26444 @enumerate
26445 @item If a zero-length bit-field is inserted between two bit-fields that
26446 are normally coalesced, the bit-fields are not coalesced.
26448 For example:
26450 @smallexample
26451 struct
26452  @{
26453    unsigned long bf_1 : 12;
26454    unsigned long : 0;
26455    unsigned long bf_2 : 12;
26456  @} t1;
26457 @end smallexample
26459 @noindent
26460 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26461 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26463 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26464 alignment of the zero-length bit-field is greater than the member that follows it,
26465 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26467 For example:
26469 @smallexample
26470 struct
26471  @{
26472    char foo : 4;
26473    short : 0;
26474    char bar;
26475  @} t2;
26477 struct
26478  @{
26479    char foo : 4;
26480    short : 0;
26481    double bar;
26482  @} t3;
26483 @end smallexample
26485 @noindent
26486 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26487 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26488 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26489 of the structure.
26491 Taking this into account, it is important to note the following:
26493 @enumerate
26494 @item If a zero-length bit-field follows a normal bit-field, the type of the
26495 zero-length bit-field may affect the alignment of the structure as whole. For
26496 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26497 normal bit-field, and is of type short.
26499 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26500 still affect the alignment of the structure:
26502 @smallexample
26503 struct
26504  @{
26505    char foo : 6;
26506    long : 0;
26507  @} t4;
26508 @end smallexample
26510 @noindent
26511 Here, @code{t4} takes up 4 bytes.
26512 @end enumerate
26514 @item Zero-length bit-fields following non-bit-field members are ignored:
26516 @smallexample
26517 struct
26518  @{
26519    char foo;
26520    long : 0;
26521    char bar;
26522  @} t5;
26523 @end smallexample
26525 @noindent
26526 Here, @code{t5} takes up 2 bytes.
26527 @end enumerate
26530 @item -mno-align-stringops
26531 @opindex mno-align-stringops
26532 Do not align the destination of inlined string operations.  This switch reduces
26533 code size and improves performance in case the destination is already aligned,
26534 but GCC doesn't know about it.
26536 @item -minline-all-stringops
26537 @opindex minline-all-stringops
26538 By default GCC inlines string operations only when the destination is 
26539 known to be aligned to least a 4-byte boundary.  
26540 This enables more inlining and increases code
26541 size, but may improve performance of code that depends on fast
26542 @code{memcpy}, @code{strlen},
26543 and @code{memset} for short lengths.
26545 @item -minline-stringops-dynamically
26546 @opindex minline-stringops-dynamically
26547 For string operations of unknown size, use run-time checks with
26548 inline code for small blocks and a library call for large blocks.
26550 @item -mstringop-strategy=@var{alg}
26551 @opindex mstringop-strategy=@var{alg}
26552 Override the internal decision heuristic for the particular algorithm to use
26553 for inlining string operations.  The allowed values for @var{alg} are:
26555 @table @samp
26556 @item rep_byte
26557 @itemx rep_4byte
26558 @itemx rep_8byte
26559 Expand using i386 @code{rep} prefix of the specified size.
26561 @item byte_loop
26562 @itemx loop
26563 @itemx unrolled_loop
26564 Expand into an inline loop.
26566 @item libcall
26567 Always use a library call.
26568 @end table
26570 @item -mmemcpy-strategy=@var{strategy}
26571 @opindex mmemcpy-strategy=@var{strategy}
26572 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26573 should be inlined and what inline algorithm to use when the expected size
26574 of the copy operation is known. @var{strategy} 
26575 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26576 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26577 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26578 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26579 in the list must be specified in increasing order.  The minimal byte size for 
26580 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26581 preceding range.
26583 @item -mmemset-strategy=@var{strategy}
26584 @opindex mmemset-strategy=@var{strategy}
26585 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26586 @code{__builtin_memset} expansion.
26588 @item -momit-leaf-frame-pointer
26589 @opindex momit-leaf-frame-pointer
26590 Don't keep the frame pointer in a register for leaf functions.  This
26591 avoids the instructions to save, set up, and restore frame pointers and
26592 makes an extra register available in leaf functions.  The option
26593 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26594 which might make debugging harder.
26596 @item -mtls-direct-seg-refs
26597 @itemx -mno-tls-direct-seg-refs
26598 @opindex mtls-direct-seg-refs
26599 Controls whether TLS variables may be accessed with offsets from the
26600 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26601 or whether the thread base pointer must be added.  Whether or not this
26602 is valid depends on the operating system, and whether it maps the
26603 segment to cover the entire TLS area.
26605 For systems that use the GNU C Library, the default is on.
26607 @item -msse2avx
26608 @itemx -mno-sse2avx
26609 @opindex msse2avx
26610 Specify that the assembler should encode SSE instructions with VEX
26611 prefix.  The option @option{-mavx} turns this on by default.
26613 @item -mfentry
26614 @itemx -mno-fentry
26615 @opindex mfentry
26616 If profiling is active (@option{-pg}), put the profiling
26617 counter call before the prologue.
26618 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26619 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26621 @item -mrecord-mcount
26622 @itemx -mno-record-mcount
26623 @opindex mrecord-mcount
26624 If profiling is active (@option{-pg}), generate a __mcount_loc section
26625 that contains pointers to each profiling call. This is useful for
26626 automatically patching and out calls.
26628 @item -mnop-mcount
26629 @itemx -mno-nop-mcount
26630 @opindex mnop-mcount
26631 If profiling is active (@option{-pg}), generate the calls to
26632 the profiling functions as NOPs. This is useful when they
26633 should be patched in later dynamically. This is likely only
26634 useful together with @option{-mrecord-mcount}.
26636 @item -mskip-rax-setup
26637 @itemx -mno-skip-rax-setup
26638 @opindex mskip-rax-setup
26639 When generating code for the x86-64 architecture with SSE extensions
26640 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26641 register when there are no variable arguments passed in vector registers.
26643 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26644 saving vector registers on stack when passing variable arguments, the
26645 impacts of this option are callees may waste some stack space,
26646 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26647 those issues, regardless the RAX register value.
26649 @item -m8bit-idiv
26650 @itemx -mno-8bit-idiv
26651 @opindex m8bit-idiv
26652 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26653 much faster than 32-bit/64-bit integer divide.  This option generates a
26654 run-time check.  If both dividend and divisor are within range of 0
26655 to 255, 8-bit unsigned integer divide is used instead of
26656 32-bit/64-bit integer divide.
26658 @item -mavx256-split-unaligned-load
26659 @itemx -mavx256-split-unaligned-store
26660 @opindex mavx256-split-unaligned-load
26661 @opindex mavx256-split-unaligned-store
26662 Split 32-byte AVX unaligned load and store.
26664 @item -mstack-protector-guard=@var{guard}
26665 @itemx -mstack-protector-guard-reg=@var{reg}
26666 @itemx -mstack-protector-guard-offset=@var{offset}
26667 @opindex mstack-protector-guard
26668 @opindex mstack-protector-guard-reg
26669 @opindex mstack-protector-guard-offset
26670 Generate stack protection code using canary at @var{guard}.  Supported
26671 locations are @samp{global} for global canary or @samp{tls} for per-thread
26672 canary in the TLS block (the default).  This option has effect only when
26673 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26675 With the latter choice the options
26676 @option{-mstack-protector-guard-reg=@var{reg}} and
26677 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26678 which segment register (@code{%fs} or @code{%gs}) to use as base register
26679 for reading the canary, and from what offset from that base register.
26680 The default for those is as specified in the relevant ABI.
26682 @item -mmitigate-rop
26683 @opindex mmitigate-rop
26684 Try to avoid generating code sequences that contain unintended return
26685 opcodes, to mitigate against certain forms of attack. At the moment,
26686 this option is limited in what it can do and should not be relied
26687 on to provide serious protection.
26689 @item -mgeneral-regs-only
26690 @opindex mgeneral-regs-only
26691 Generate code that uses only the general-purpose registers.  This
26692 prevents the compiler from using floating-point, vector, mask and bound
26693 registers.
26695 @end table
26697 These @samp{-m} switches are supported in addition to the above
26698 on x86-64 processors in 64-bit environments.
26700 @table @gcctabopt
26701 @item -m32
26702 @itemx -m64
26703 @itemx -mx32
26704 @itemx -m16
26705 @itemx -miamcu
26706 @opindex m32
26707 @opindex m64
26708 @opindex mx32
26709 @opindex m16
26710 @opindex miamcu
26711 Generate code for a 16-bit, 32-bit or 64-bit environment.
26712 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26713 to 32 bits, and
26714 generates code that runs on any i386 system.
26716 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26717 types to 64 bits, and generates code for the x86-64 architecture.
26718 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26719 and @option{-mdynamic-no-pic} options.
26721 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26722 to 32 bits, and
26723 generates code for the x86-64 architecture.
26725 The @option{-m16} option is the same as @option{-m32}, except for that
26726 it outputs the @code{.code16gcc} assembly directive at the beginning of
26727 the assembly output so that the binary can run in 16-bit mode.
26729 The @option{-miamcu} option generates code which conforms to Intel MCU
26730 psABI.  It requires the @option{-m32} option to be turned on.
26732 @item -mno-red-zone
26733 @opindex mno-red-zone
26734 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26735 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26736 stack pointer that is not modified by signal or interrupt handlers
26737 and therefore can be used for temporary data without adjusting the stack
26738 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26740 @item -mcmodel=small
26741 @opindex mcmodel=small
26742 Generate code for the small code model: the program and its symbols must
26743 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26744 Programs can be statically or dynamically linked.  This is the default
26745 code model.
26747 @item -mcmodel=kernel
26748 @opindex mcmodel=kernel
26749 Generate code for the kernel code model.  The kernel runs in the
26750 negative 2 GB of the address space.
26751 This model has to be used for Linux kernel code.
26753 @item -mcmodel=medium
26754 @opindex mcmodel=medium
26755 Generate code for the medium model: the program is linked in the lower 2
26756 GB of the address space.  Small symbols are also placed there.  Symbols
26757 with sizes larger than @option{-mlarge-data-threshold} are put into
26758 large data or BSS sections and can be located above 2GB.  Programs can
26759 be statically or dynamically linked.
26761 @item -mcmodel=large
26762 @opindex mcmodel=large
26763 Generate code for the large model.  This model makes no assumptions
26764 about addresses and sizes of sections.
26766 @item -maddress-mode=long
26767 @opindex maddress-mode=long
26768 Generate code for long address mode.  This is only supported for 64-bit
26769 and x32 environments.  It is the default address mode for 64-bit
26770 environments.
26772 @item -maddress-mode=short
26773 @opindex maddress-mode=short
26774 Generate code for short address mode.  This is only supported for 32-bit
26775 and x32 environments.  It is the default address mode for 32-bit and
26776 x32 environments.
26777 @end table
26779 @node x86 Windows Options
26780 @subsection x86 Windows Options
26781 @cindex x86 Windows Options
26782 @cindex Windows Options for x86
26784 These additional options are available for Microsoft Windows targets:
26786 @table @gcctabopt
26787 @item -mconsole
26788 @opindex mconsole
26789 This option
26790 specifies that a console application is to be generated, by
26791 instructing the linker to set the PE header subsystem type
26792 required for console applications.
26793 This option is available for Cygwin and MinGW targets and is
26794 enabled by default on those targets.
26796 @item -mdll
26797 @opindex mdll
26798 This option is available for Cygwin and MinGW targets.  It
26799 specifies that a DLL---a dynamic link library---is to be
26800 generated, enabling the selection of the required runtime
26801 startup object and entry point.
26803 @item -mnop-fun-dllimport
26804 @opindex mnop-fun-dllimport
26805 This option is available for Cygwin and MinGW targets.  It
26806 specifies that the @code{dllimport} attribute should be ignored.
26808 @item -mthread
26809 @opindex mthread
26810 This option is available for MinGW targets. It specifies
26811 that MinGW-specific thread support is to be used.
26813 @item -municode
26814 @opindex municode
26815 This option is available for MinGW-w64 targets.  It causes
26816 the @code{UNICODE} preprocessor macro to be predefined, and
26817 chooses Unicode-capable runtime startup code.
26819 @item -mwin32
26820 @opindex mwin32
26821 This option is available for Cygwin and MinGW targets.  It
26822 specifies that the typical Microsoft Windows predefined macros are to
26823 be set in the pre-processor, but does not influence the choice
26824 of runtime library/startup code.
26826 @item -mwindows
26827 @opindex mwindows
26828 This option is available for Cygwin and MinGW targets.  It
26829 specifies that a GUI application is to be generated by
26830 instructing the linker to set the PE header subsystem type
26831 appropriately.
26833 @item -fno-set-stack-executable
26834 @opindex fno-set-stack-executable
26835 This option is available for MinGW targets. It specifies that
26836 the executable flag for the stack used by nested functions isn't
26837 set. This is necessary for binaries running in kernel mode of
26838 Microsoft Windows, as there the User32 API, which is used to set executable
26839 privileges, isn't available.
26841 @item -fwritable-relocated-rdata
26842 @opindex fno-writable-relocated-rdata
26843 This option is available for MinGW and Cygwin targets.  It specifies
26844 that relocated-data in read-only section is put into the @code{.data}
26845 section.  This is a necessary for older runtimes not supporting
26846 modification of @code{.rdata} sections for pseudo-relocation.
26848 @item -mpe-aligned-commons
26849 @opindex mpe-aligned-commons
26850 This option is available for Cygwin and MinGW targets.  It
26851 specifies that the GNU extension to the PE file format that
26852 permits the correct alignment of COMMON variables should be
26853 used when generating code.  It is enabled by default if
26854 GCC detects that the target assembler found during configuration
26855 supports the feature.
26856 @end table
26858 See also under @ref{x86 Options} for standard options.
26860 @node Xstormy16 Options
26861 @subsection Xstormy16 Options
26862 @cindex Xstormy16 Options
26864 These options are defined for Xstormy16:
26866 @table @gcctabopt
26867 @item -msim
26868 @opindex msim
26869 Choose startup files and linker script suitable for the simulator.
26870 @end table
26872 @node Xtensa Options
26873 @subsection Xtensa Options
26874 @cindex Xtensa Options
26876 These options are supported for Xtensa targets:
26878 @table @gcctabopt
26879 @item -mconst16
26880 @itemx -mno-const16
26881 @opindex mconst16
26882 @opindex mno-const16
26883 Enable or disable use of @code{CONST16} instructions for loading
26884 constant values.  The @code{CONST16} instruction is currently not a
26885 standard option from Tensilica.  When enabled, @code{CONST16}
26886 instructions are always used in place of the standard @code{L32R}
26887 instructions.  The use of @code{CONST16} is enabled by default only if
26888 the @code{L32R} instruction is not available.
26890 @item -mfused-madd
26891 @itemx -mno-fused-madd
26892 @opindex mfused-madd
26893 @opindex mno-fused-madd
26894 Enable or disable use of fused multiply/add and multiply/subtract
26895 instructions in the floating-point option.  This has no effect if the
26896 floating-point option is not also enabled.  Disabling fused multiply/add
26897 and multiply/subtract instructions forces the compiler to use separate
26898 instructions for the multiply and add/subtract operations.  This may be
26899 desirable in some cases where strict IEEE 754-compliant results are
26900 required: the fused multiply add/subtract instructions do not round the
26901 intermediate result, thereby producing results with @emph{more} bits of
26902 precision than specified by the IEEE standard.  Disabling fused multiply
26903 add/subtract instructions also ensures that the program output is not
26904 sensitive to the compiler's ability to combine multiply and add/subtract
26905 operations.
26907 @item -mserialize-volatile
26908 @itemx -mno-serialize-volatile
26909 @opindex mserialize-volatile
26910 @opindex mno-serialize-volatile
26911 When this option is enabled, GCC inserts @code{MEMW} instructions before
26912 @code{volatile} memory references to guarantee sequential consistency.
26913 The default is @option{-mserialize-volatile}.  Use
26914 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26916 @item -mforce-no-pic
26917 @opindex mforce-no-pic
26918 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26919 position-independent code (PIC), this option disables PIC for compiling
26920 kernel code.
26922 @item -mtext-section-literals
26923 @itemx -mno-text-section-literals
26924 @opindex mtext-section-literals
26925 @opindex mno-text-section-literals
26926 These options control the treatment of literal pools.  The default is
26927 @option{-mno-text-section-literals}, which places literals in a separate
26928 section in the output file.  This allows the literal pool to be placed
26929 in a data RAM/ROM, and it also allows the linker to combine literal
26930 pools from separate object files to remove redundant literals and
26931 improve code size.  With @option{-mtext-section-literals}, the literals
26932 are interspersed in the text section in order to keep them as close as
26933 possible to their references.  This may be necessary for large assembly
26934 files.  Literals for each function are placed right before that function.
26936 @item -mauto-litpools
26937 @itemx -mno-auto-litpools
26938 @opindex mauto-litpools
26939 @opindex mno-auto-litpools
26940 These options control the treatment of literal pools.  The default is
26941 @option{-mno-auto-litpools}, which places literals in a separate
26942 section in the output file unless @option{-mtext-section-literals} is
26943 used.  With @option{-mauto-litpools} the literals are interspersed in
26944 the text section by the assembler.  Compiler does not produce explicit
26945 @code{.literal} directives and loads literals into registers with
26946 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26947 do relaxation and place literals as necessary.  This option allows
26948 assembler to create several literal pools per function and assemble
26949 very big functions, which may not be possible with
26950 @option{-mtext-section-literals}.
26952 @item -mtarget-align
26953 @itemx -mno-target-align
26954 @opindex mtarget-align
26955 @opindex mno-target-align
26956 When this option is enabled, GCC instructs the assembler to
26957 automatically align instructions to reduce branch penalties at the
26958 expense of some code density.  The assembler attempts to widen density
26959 instructions to align branch targets and the instructions following call
26960 instructions.  If there are not enough preceding safe density
26961 instructions to align a target, no widening is performed.  The
26962 default is @option{-mtarget-align}.  These options do not affect the
26963 treatment of auto-aligned instructions like @code{LOOP}, which the
26964 assembler always aligns, either by widening density instructions or
26965 by inserting NOP instructions.
26967 @item -mlongcalls
26968 @itemx -mno-longcalls
26969 @opindex mlongcalls
26970 @opindex mno-longcalls
26971 When this option is enabled, GCC instructs the assembler to translate
26972 direct calls to indirect calls unless it can determine that the target
26973 of a direct call is in the range allowed by the call instruction.  This
26974 translation typically occurs for calls to functions in other source
26975 files.  Specifically, the assembler translates a direct @code{CALL}
26976 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26977 The default is @option{-mno-longcalls}.  This option should be used in
26978 programs where the call target can potentially be out of range.  This
26979 option is implemented in the assembler, not the compiler, so the
26980 assembly code generated by GCC still shows direct call
26981 instructions---look at the disassembled object code to see the actual
26982 instructions.  Note that the assembler uses an indirect call for
26983 every cross-file call, not just those that really are out of range.
26984 @end table
26986 @node zSeries Options
26987 @subsection zSeries Options
26988 @cindex zSeries options
26990 These are listed under @xref{S/390 and zSeries Options}.
26993 @c man end
26995 @node Spec Files
26996 @section Specifying Subprocesses and the Switches to Pass to Them
26997 @cindex Spec Files
26999 @command{gcc} is a driver program.  It performs its job by invoking a
27000 sequence of other programs to do the work of compiling, assembling and
27001 linking.  GCC interprets its command-line parameters and uses these to
27002 deduce which programs it should invoke, and which command-line options
27003 it ought to place on their command lines.  This behavior is controlled
27004 by @dfn{spec strings}.  In most cases there is one spec string for each
27005 program that GCC can invoke, but a few programs have multiple spec
27006 strings to control their behavior.  The spec strings built into GCC can
27007 be overridden by using the @option{-specs=} command-line switch to specify
27008 a spec file.
27010 @dfn{Spec files} are plain-text files that are used to construct spec
27011 strings.  They consist of a sequence of directives separated by blank
27012 lines.  The type of directive is determined by the first non-whitespace
27013 character on the line, which can be one of the following:
27015 @table @code
27016 @item %@var{command}
27017 Issues a @var{command} to the spec file processor.  The commands that can
27018 appear here are:
27020 @table @code
27021 @item %include <@var{file}>
27022 @cindex @code{%include}
27023 Search for @var{file} and insert its text at the current point in the
27024 specs file.
27026 @item %include_noerr <@var{file}>
27027 @cindex @code{%include_noerr}
27028 Just like @samp{%include}, but do not generate an error message if the include
27029 file cannot be found.
27031 @item %rename @var{old_name} @var{new_name}
27032 @cindex @code{%rename}
27033 Rename the spec string @var{old_name} to @var{new_name}.
27035 @end table
27037 @item *[@var{spec_name}]:
27038 This tells the compiler to create, override or delete the named spec
27039 string.  All lines after this directive up to the next directive or
27040 blank line are considered to be the text for the spec string.  If this
27041 results in an empty string then the spec is deleted.  (Or, if the
27042 spec did not exist, then nothing happens.)  Otherwise, if the spec
27043 does not currently exist a new spec is created.  If the spec does
27044 exist then its contents are overridden by the text of this
27045 directive, unless the first character of that text is the @samp{+}
27046 character, in which case the text is appended to the spec.
27048 @item [@var{suffix}]:
27049 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27050 and up to the next directive or blank line are considered to make up the
27051 spec string for the indicated suffix.  When the compiler encounters an
27052 input file with the named suffix, it processes the spec string in
27053 order to work out how to compile that file.  For example:
27055 @smallexample
27056 .ZZ:
27057 z-compile -input %i
27058 @end smallexample
27060 This says that any input file whose name ends in @samp{.ZZ} should be
27061 passed to the program @samp{z-compile}, which should be invoked with the
27062 command-line switch @option{-input} and with the result of performing the
27063 @samp{%i} substitution.  (See below.)
27065 As an alternative to providing a spec string, the text following a
27066 suffix directive can be one of the following:
27068 @table @code
27069 @item @@@var{language}
27070 This says that the suffix is an alias for a known @var{language}.  This is
27071 similar to using the @option{-x} command-line switch to GCC to specify a
27072 language explicitly.  For example:
27074 @smallexample
27075 .ZZ:
27076 @@c++
27077 @end smallexample
27079 Says that .ZZ files are, in fact, C++ source files.
27081 @item #@var{name}
27082 This causes an error messages saying:
27084 @smallexample
27085 @var{name} compiler not installed on this system.
27086 @end smallexample
27087 @end table
27089 GCC already has an extensive list of suffixes built into it.
27090 This directive adds an entry to the end of the list of suffixes, but
27091 since the list is searched from the end backwards, it is effectively
27092 possible to override earlier entries using this technique.
27094 @end table
27096 GCC has the following spec strings built into it.  Spec files can
27097 override these strings or create their own.  Note that individual
27098 targets can also add their own spec strings to this list.
27100 @smallexample
27101 asm          Options to pass to the assembler
27102 asm_final    Options to pass to the assembler post-processor
27103 cpp          Options to pass to the C preprocessor
27104 cc1          Options to pass to the C compiler
27105 cc1plus      Options to pass to the C++ compiler
27106 endfile      Object files to include at the end of the link
27107 link         Options to pass to the linker
27108 lib          Libraries to include on the command line to the linker
27109 libgcc       Decides which GCC support library to pass to the linker
27110 linker       Sets the name of the linker
27111 predefines   Defines to be passed to the C preprocessor
27112 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27113              by default
27114 startfile    Object files to include at the start of the link
27115 @end smallexample
27117 Here is a small example of a spec file:
27119 @smallexample
27120 %rename lib                 old_lib
27122 *lib:
27123 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27124 @end smallexample
27126 This example renames the spec called @samp{lib} to @samp{old_lib} and
27127 then overrides the previous definition of @samp{lib} with a new one.
27128 The new definition adds in some extra command-line options before
27129 including the text of the old definition.
27131 @dfn{Spec strings} are a list of command-line options to be passed to their
27132 corresponding program.  In addition, the spec strings can contain
27133 @samp{%}-prefixed sequences to substitute variable text or to
27134 conditionally insert text into the command line.  Using these constructs
27135 it is possible to generate quite complex command lines.
27137 Here is a table of all defined @samp{%}-sequences for spec
27138 strings.  Note that spaces are not generated automatically around the
27139 results of expanding these sequences.  Therefore you can concatenate them
27140 together or combine them with constant text in a single argument.
27142 @table @code
27143 @item %%
27144 Substitute one @samp{%} into the program name or argument.
27146 @item %i
27147 Substitute the name of the input file being processed.
27149 @item %b
27150 Substitute the basename of the input file being processed.
27151 This is the substring up to (and not including) the last period
27152 and not including the directory.
27154 @item %B
27155 This is the same as @samp{%b}, but include the file suffix (text after
27156 the last period).
27158 @item %d
27159 Marks the argument containing or following the @samp{%d} as a
27160 temporary file name, so that that file is deleted if GCC exits
27161 successfully.  Unlike @samp{%g}, this contributes no text to the
27162 argument.
27164 @item %g@var{suffix}
27165 Substitute a file name that has suffix @var{suffix} and is chosen
27166 once per compilation, and mark the argument in the same way as
27167 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27168 name is now chosen in a way that is hard to predict even when previously
27169 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27170 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27171 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27172 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27173 was simply substituted with a file name chosen once per compilation,
27174 without regard to any appended suffix (which was therefore treated
27175 just like ordinary text), making such attacks more likely to succeed.
27177 @item %u@var{suffix}
27178 Like @samp{%g}, but generates a new temporary file name
27179 each time it appears instead of once per compilation.
27181 @item %U@var{suffix}
27182 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27183 new one if there is no such last file name.  In the absence of any
27184 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27185 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27186 involves the generation of two distinct file names, one
27187 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27188 simply substituted with a file name chosen for the previous @samp{%u},
27189 without regard to any appended suffix.
27191 @item %j@var{suffix}
27192 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27193 writable, and if @option{-save-temps} is not used; 
27194 otherwise, substitute the name
27195 of a temporary file, just like @samp{%u}.  This temporary file is not
27196 meant for communication between processes, but rather as a junk
27197 disposal mechanism.
27199 @item %|@var{suffix}
27200 @itemx %m@var{suffix}
27201 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27202 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27203 all.  These are the two most common ways to instruct a program that it
27204 should read from standard input or write to standard output.  If you
27205 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27206 construct: see for example @file{f/lang-specs.h}.
27208 @item %.@var{SUFFIX}
27209 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27210 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27211 terminated by the next space or %.
27213 @item %w
27214 Marks the argument containing or following the @samp{%w} as the
27215 designated output file of this compilation.  This puts the argument
27216 into the sequence of arguments that @samp{%o} substitutes.
27218 @item %o
27219 Substitutes the names of all the output files, with spaces
27220 automatically placed around them.  You should write spaces
27221 around the @samp{%o} as well or the results are undefined.
27222 @samp{%o} is for use in the specs for running the linker.
27223 Input files whose names have no recognized suffix are not compiled
27224 at all, but they are included among the output files, so they are
27225 linked.
27227 @item %O
27228 Substitutes the suffix for object files.  Note that this is
27229 handled specially when it immediately follows @samp{%g, %u, or %U},
27230 because of the need for those to form complete file names.  The
27231 handling is such that @samp{%O} is treated exactly as if it had already
27232 been substituted, except that @samp{%g, %u, and %U} do not currently
27233 support additional @var{suffix} characters following @samp{%O} as they do
27234 following, for example, @samp{.o}.
27236 @item %p
27237 Substitutes the standard macro predefinitions for the
27238 current target machine.  Use this when running @command{cpp}.
27240 @item %P
27241 Like @samp{%p}, but puts @samp{__} before and after the name of each
27242 predefined macro, except for macros that start with @samp{__} or with
27243 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27246 @item %I
27247 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27248 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27249 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27250 and @option{-imultilib} as necessary.
27252 @item %s
27253 Current argument is the name of a library or startup file of some sort.
27254 Search for that file in a standard list of directories and substitute
27255 the full name found.  The current working directory is included in the
27256 list of directories scanned.
27258 @item %T
27259 Current argument is the name of a linker script.  Search for that file
27260 in the current list of directories to scan for libraries. If the file
27261 is located insert a @option{--script} option into the command line
27262 followed by the full path name found.  If the file is not found then
27263 generate an error message.  Note: the current working directory is not
27264 searched.
27266 @item %e@var{str}
27267 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27268 Use this when inconsistent options are detected.
27270 @item %(@var{name})
27271 Substitute the contents of spec string @var{name} at this point.
27273 @item %x@{@var{option}@}
27274 Accumulate an option for @samp{%X}.
27276 @item %X
27277 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27278 spec string.
27280 @item %Y
27281 Output the accumulated assembler options specified by @option{-Wa}.
27283 @item %Z
27284 Output the accumulated preprocessor options specified by @option{-Wp}.
27286 @item %a
27287 Process the @code{asm} spec.  This is used to compute the
27288 switches to be passed to the assembler.
27290 @item %A
27291 Process the @code{asm_final} spec.  This is a spec string for
27292 passing switches to an assembler post-processor, if such a program is
27293 needed.
27295 @item %l
27296 Process the @code{link} spec.  This is the spec for computing the
27297 command line passed to the linker.  Typically it makes use of the
27298 @samp{%L %G %S %D and %E} sequences.
27300 @item %D
27301 Dump out a @option{-L} option for each directory that GCC believes might
27302 contain startup files.  If the target supports multilibs then the
27303 current multilib directory is prepended to each of these paths.
27305 @item %L
27306 Process the @code{lib} spec.  This is a spec string for deciding which
27307 libraries are included on the command line to the linker.
27309 @item %G
27310 Process the @code{libgcc} spec.  This is a spec string for deciding
27311 which GCC support library is included on the command line to the linker.
27313 @item %S
27314 Process the @code{startfile} spec.  This is a spec for deciding which
27315 object files are the first ones passed to the linker.  Typically
27316 this might be a file named @file{crt0.o}.
27318 @item %E
27319 Process the @code{endfile} spec.  This is a spec string that specifies
27320 the last object files that are passed to the linker.
27322 @item %C
27323 Process the @code{cpp} spec.  This is used to construct the arguments
27324 to be passed to the C preprocessor.
27326 @item %1
27327 Process the @code{cc1} spec.  This is used to construct the options to be
27328 passed to the actual C compiler (@command{cc1}).
27330 @item %2
27331 Process the @code{cc1plus} spec.  This is used to construct the options to be
27332 passed to the actual C++ compiler (@command{cc1plus}).
27334 @item %*
27335 Substitute the variable part of a matched option.  See below.
27336 Note that each comma in the substituted string is replaced by
27337 a single space.
27339 @item %<S
27340 Remove all occurrences of @code{-S} from the command line.  Note---this
27341 command is position dependent.  @samp{%} commands in the spec string
27342 before this one see @code{-S}, @samp{%} commands in the spec string
27343 after this one do not.
27345 @item %:@var{function}(@var{args})
27346 Call the named function @var{function}, passing it @var{args}.
27347 @var{args} is first processed as a nested spec string, then split
27348 into an argument vector in the usual fashion.  The function returns
27349 a string which is processed as if it had appeared literally as part
27350 of the current spec.
27352 The following built-in spec functions are provided:
27354 @table @code
27355 @item @code{getenv}
27356 The @code{getenv} spec function takes two arguments: an environment
27357 variable name and a string.  If the environment variable is not
27358 defined, a fatal error is issued.  Otherwise, the return value is the
27359 value of the environment variable concatenated with the string.  For
27360 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27362 @smallexample
27363 %:getenv(TOPDIR /include)
27364 @end smallexample
27366 expands to @file{/path/to/top/include}.
27368 @item @code{if-exists}
27369 The @code{if-exists} spec function takes one argument, an absolute
27370 pathname to a file.  If the file exists, @code{if-exists} returns the
27371 pathname.  Here is a small example of its usage:
27373 @smallexample
27374 *startfile:
27375 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27376 @end smallexample
27378 @item @code{if-exists-else}
27379 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27380 spec function, except that it takes two arguments.  The first argument is
27381 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27382 returns the pathname.  If it does not exist, it returns the second argument.
27383 This way, @code{if-exists-else} can be used to select one file or another,
27384 based on the existence of the first.  Here is a small example of its usage:
27386 @smallexample
27387 *startfile:
27388 crt0%O%s %:if-exists(crti%O%s) \
27389 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27390 @end smallexample
27392 @item @code{replace-outfile}
27393 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27394 first argument in the outfiles array and replaces it with the second argument.  Here
27395 is a small example of its usage:
27397 @smallexample
27398 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27399 @end smallexample
27401 @item @code{remove-outfile}
27402 The @code{remove-outfile} spec function takes one argument.  It looks for the
27403 first argument in the outfiles array and removes it.  Here is a small example
27404 its usage:
27406 @smallexample
27407 %:remove-outfile(-lm)
27408 @end smallexample
27410 @item @code{pass-through-libs}
27411 The @code{pass-through-libs} spec function takes any number of arguments.  It
27412 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27413 assumes are the names of linker input library archive files) and returns a
27414 result containing all the found arguments each prepended by
27415 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27416 intended to be passed to the LTO linker plugin.
27418 @smallexample
27419 %:pass-through-libs(%G %L %G)
27420 @end smallexample
27422 @item @code{print-asm-header}
27423 The @code{print-asm-header} function takes no arguments and simply
27424 prints a banner like:
27426 @smallexample
27427 Assembler options
27428 =================
27430 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27431 @end smallexample
27433 It is used to separate compiler options from assembler options
27434 in the @option{--target-help} output.
27435 @end table
27437 @item %@{S@}
27438 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27439 If that switch is not specified, this substitutes nothing.  Note that
27440 the leading dash is omitted when specifying this option, and it is
27441 automatically inserted if the substitution is performed.  Thus the spec
27442 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27443 and outputs the command-line option @option{-foo}.
27445 @item %W@{S@}
27446 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27447 deleted on failure.
27449 @item %@{S*@}
27450 Substitutes all the switches specified to GCC whose names start
27451 with @code{-S}, but which also take an argument.  This is used for
27452 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27453 GCC considers @option{-o foo} as being
27454 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27455 text, including the space.  Thus two arguments are generated.
27457 @item %@{S*&T*@}
27458 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27459 (the order of @code{S} and @code{T} in the spec is not significant).
27460 There can be any number of ampersand-separated variables; for each the
27461 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27463 @item %@{S:X@}
27464 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27466 @item %@{!S:X@}
27467 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27469 @item %@{S*:X@}
27470 Substitutes @code{X} if one or more switches whose names start with
27471 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27472 once, no matter how many such switches appeared.  However, if @code{%*}
27473 appears somewhere in @code{X}, then @code{X} is substituted once
27474 for each matching switch, with the @code{%*} replaced by the part of
27475 that switch matching the @code{*}.
27477 If @code{%*} appears as the last part of a spec sequence then a space
27478 is added after the end of the last substitution.  If there is more
27479 text in the sequence, however, then a space is not generated.  This
27480 allows the @code{%*} substitution to be used as part of a larger
27481 string.  For example, a spec string like this:
27483 @smallexample
27484 %@{mcu=*:--script=%*/memory.ld@}
27485 @end smallexample
27487 @noindent
27488 when matching an option like @option{-mcu=newchip} produces:
27490 @smallexample
27491 --script=newchip/memory.ld
27492 @end smallexample
27494 @item %@{.S:X@}
27495 Substitutes @code{X}, if processing a file with suffix @code{S}.
27497 @item %@{!.S:X@}
27498 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27500 @item %@{,S:X@}
27501 Substitutes @code{X}, if processing a file for language @code{S}.
27503 @item %@{!,S:X@}
27504 Substitutes @code{X}, if not processing a file for language @code{S}.
27506 @item %@{S|P:X@}
27507 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27508 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27509 @code{*} sequences as well, although they have a stronger binding than
27510 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27511 alternatives must be starred, and only the first matching alternative
27512 is substituted.
27514 For example, a spec string like this:
27516 @smallexample
27517 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27518 @end smallexample
27520 @noindent
27521 outputs the following command-line options from the following input
27522 command-line options:
27524 @smallexample
27525 fred.c        -foo -baz
27526 jim.d         -bar -boggle
27527 -d fred.c     -foo -baz -boggle
27528 -d jim.d      -bar -baz -boggle
27529 @end smallexample
27531 @item %@{S:X; T:Y; :D@}
27533 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27534 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27535 be as many clauses as you need.  This may be combined with @code{.},
27536 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27539 @end table
27541 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27542 or similar construct can use a backslash to ignore the special meaning
27543 of the character following it, thus allowing literal matching of a
27544 character that is otherwise specially treated.  For example,
27545 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27546 @option{-std=iso9899:1999} option is given.
27548 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27549 construct may contain other nested @samp{%} constructs or spaces, or
27550 even newlines.  They are processed as usual, as described above.
27551 Trailing white space in @code{X} is ignored.  White space may also
27552 appear anywhere on the left side of the colon in these constructs,
27553 except between @code{.} or @code{*} and the corresponding word.
27555 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27556 handled specifically in these constructs.  If another value of
27557 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27558 @option{-W} switch is found later in the command line, the earlier
27559 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27560 just one letter, which passes all matching options.
27562 The character @samp{|} at the beginning of the predicate text is used to
27563 indicate that a command should be piped to the following command, but
27564 only if @option{-pipe} is specified.
27566 It is built into GCC which switches take arguments and which do not.
27567 (You might think it would be useful to generalize this to allow each
27568 compiler's spec to say which switches take arguments.  But this cannot
27569 be done in a consistent fashion.  GCC cannot even decide which input
27570 files have been specified without knowing which switches take arguments,
27571 and it must know which input files to compile in order to tell which
27572 compilers to run).
27574 GCC also knows implicitly that arguments starting in @option{-l} are to be
27575 treated as compiler output files, and passed to the linker in their
27576 proper position among the other output files.
27578 @node Environment Variables
27579 @section Environment Variables Affecting GCC
27580 @cindex environment variables
27582 @c man begin ENVIRONMENT
27583 This section describes several environment variables that affect how GCC
27584 operates.  Some of them work by specifying directories or prefixes to use
27585 when searching for various kinds of files.  Some are used to specify other
27586 aspects of the compilation environment.
27588 Note that you can also specify places to search using options such as
27589 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27590 take precedence over places specified using environment variables, which
27591 in turn take precedence over those specified by the configuration of GCC@.
27592 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27593 GNU Compiler Collection (GCC) Internals}.
27595 @table @env
27596 @item LANG
27597 @itemx LC_CTYPE
27598 @c @itemx LC_COLLATE
27599 @itemx LC_MESSAGES
27600 @c @itemx LC_MONETARY
27601 @c @itemx LC_NUMERIC
27602 @c @itemx LC_TIME
27603 @itemx LC_ALL
27604 @findex LANG
27605 @findex LC_CTYPE
27606 @c @findex LC_COLLATE
27607 @findex LC_MESSAGES
27608 @c @findex LC_MONETARY
27609 @c @findex LC_NUMERIC
27610 @c @findex LC_TIME
27611 @findex LC_ALL
27612 @cindex locale
27613 These environment variables control the way that GCC uses
27614 localization information which allows GCC to work with different
27615 national conventions.  GCC inspects the locale categories
27616 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27617 so.  These locale categories can be set to any value supported by your
27618 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27619 Kingdom encoded in UTF-8.
27621 The @env{LC_CTYPE} environment variable specifies character
27622 classification.  GCC uses it to determine the character boundaries in
27623 a string; this is needed for some multibyte encodings that contain quote
27624 and escape characters that are otherwise interpreted as a string
27625 end or escape.
27627 The @env{LC_MESSAGES} environment variable specifies the language to
27628 use in diagnostic messages.
27630 If the @env{LC_ALL} environment variable is set, it overrides the value
27631 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27632 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27633 environment variable.  If none of these variables are set, GCC
27634 defaults to traditional C English behavior.
27636 @item TMPDIR
27637 @findex TMPDIR
27638 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27639 files.  GCC uses temporary files to hold the output of one stage of
27640 compilation which is to be used as input to the next stage: for example,
27641 the output of the preprocessor, which is the input to the compiler
27642 proper.
27644 @item GCC_COMPARE_DEBUG
27645 @findex GCC_COMPARE_DEBUG
27646 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27647 @option{-fcompare-debug} to the compiler driver.  See the documentation
27648 of this option for more details.
27650 @item GCC_EXEC_PREFIX
27651 @findex GCC_EXEC_PREFIX
27652 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27653 names of the subprograms executed by the compiler.  No slash is added
27654 when this prefix is combined with the name of a subprogram, but you can
27655 specify a prefix that ends with a slash if you wish.
27657 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27658 an appropriate prefix to use based on the pathname it is invoked with.
27660 If GCC cannot find the subprogram using the specified prefix, it
27661 tries looking in the usual places for the subprogram.
27663 The default value of @env{GCC_EXEC_PREFIX} is
27664 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27665 the installed compiler. In many cases @var{prefix} is the value
27666 of @code{prefix} when you ran the @file{configure} script.
27668 Other prefixes specified with @option{-B} take precedence over this prefix.
27670 This prefix is also used for finding files such as @file{crt0.o} that are
27671 used for linking.
27673 In addition, the prefix is used in an unusual way in finding the
27674 directories to search for header files.  For each of the standard
27675 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27676 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27677 replacing that beginning with the specified prefix to produce an
27678 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27679 @file{foo/bar} just before it searches the standard directory 
27680 @file{/usr/local/lib/bar}.
27681 If a standard directory begins with the configured
27682 @var{prefix} then the value of @var{prefix} is replaced by
27683 @env{GCC_EXEC_PREFIX} when looking for header files.
27685 @item COMPILER_PATH
27686 @findex COMPILER_PATH
27687 The value of @env{COMPILER_PATH} is a colon-separated list of
27688 directories, much like @env{PATH}.  GCC tries the directories thus
27689 specified when searching for subprograms, if it cannot find the
27690 subprograms using @env{GCC_EXEC_PREFIX}.
27692 @item LIBRARY_PATH
27693 @findex LIBRARY_PATH
27694 The value of @env{LIBRARY_PATH} is a colon-separated list of
27695 directories, much like @env{PATH}.  When configured as a native compiler,
27696 GCC tries the directories thus specified when searching for special
27697 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27698 using GCC also uses these directories when searching for ordinary
27699 libraries for the @option{-l} option (but directories specified with
27700 @option{-L} come first).
27702 @item LANG
27703 @findex LANG
27704 @cindex locale definition
27705 This variable is used to pass locale information to the compiler.  One way in
27706 which this information is used is to determine the character set to be used
27707 when character literals, string literals and comments are parsed in C and C++.
27708 When the compiler is configured to allow multibyte characters,
27709 the following values for @env{LANG} are recognized:
27711 @table @samp
27712 @item C-JIS
27713 Recognize JIS characters.
27714 @item C-SJIS
27715 Recognize SJIS characters.
27716 @item C-EUCJP
27717 Recognize EUCJP characters.
27718 @end table
27720 If @env{LANG} is not defined, or if it has some other value, then the
27721 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27722 recognize and translate multibyte characters.
27723 @end table
27725 @noindent
27726 Some additional environment variables affect the behavior of the
27727 preprocessor.
27729 @include cppenv.texi
27731 @c man end
27733 @node Precompiled Headers
27734 @section Using Precompiled Headers
27735 @cindex precompiled headers
27736 @cindex speed of compilation
27738 Often large projects have many header files that are included in every
27739 source file.  The time the compiler takes to process these header files
27740 over and over again can account for nearly all of the time required to
27741 build the project.  To make builds faster, GCC allows you to
27742 @dfn{precompile} a header file.
27744 To create a precompiled header file, simply compile it as you would any
27745 other file, if necessary using the @option{-x} option to make the driver
27746 treat it as a C or C++ header file.  You may want to use a
27747 tool like @command{make} to keep the precompiled header up-to-date when
27748 the headers it contains change.
27750 A precompiled header file is searched for when @code{#include} is
27751 seen in the compilation.  As it searches for the included file
27752 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27753 compiler looks for a precompiled header in each directory just before it
27754 looks for the include file in that directory.  The name searched for is
27755 the name specified in the @code{#include} with @samp{.gch} appended.  If
27756 the precompiled header file cannot be used, it is ignored.
27758 For instance, if you have @code{#include "all.h"}, and you have
27759 @file{all.h.gch} in the same directory as @file{all.h}, then the
27760 precompiled header file is used if possible, and the original
27761 header is used otherwise.
27763 Alternatively, you might decide to put the precompiled header file in a
27764 directory and use @option{-I} to ensure that directory is searched
27765 before (or instead of) the directory containing the original header.
27766 Then, if you want to check that the precompiled header file is always
27767 used, you can put a file of the same name as the original header in this
27768 directory containing an @code{#error} command.
27770 This also works with @option{-include}.  So yet another way to use
27771 precompiled headers, good for projects not designed with precompiled
27772 header files in mind, is to simply take most of the header files used by
27773 a project, include them from another header file, precompile that header
27774 file, and @option{-include} the precompiled header.  If the header files
27775 have guards against multiple inclusion, they are skipped because
27776 they've already been included (in the precompiled header).
27778 If you need to precompile the same header file for different
27779 languages, targets, or compiler options, you can instead make a
27780 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27781 header in the directory, perhaps using @option{-o}.  It doesn't matter
27782 what you call the files in the directory; every precompiled header in
27783 the directory is considered.  The first precompiled header
27784 encountered in the directory that is valid for this compilation is
27785 used; they're searched in no particular order.
27787 There are many other possibilities, limited only by your imagination,
27788 good sense, and the constraints of your build system.
27790 A precompiled header file can be used only when these conditions apply:
27792 @itemize
27793 @item
27794 Only one precompiled header can be used in a particular compilation.
27796 @item
27797 A precompiled header cannot be used once the first C token is seen.  You
27798 can have preprocessor directives before a precompiled header; you cannot
27799 include a precompiled header from inside another header.
27801 @item
27802 The precompiled header file must be produced for the same language as
27803 the current compilation.  You cannot use a C precompiled header for a C++
27804 compilation.
27806 @item
27807 The precompiled header file must have been produced by the same compiler
27808 binary as the current compilation is using.
27810 @item
27811 Any macros defined before the precompiled header is included must
27812 either be defined in the same way as when the precompiled header was
27813 generated, or must not affect the precompiled header, which usually
27814 means that they don't appear in the precompiled header at all.
27816 The @option{-D} option is one way to define a macro before a
27817 precompiled header is included; using a @code{#define} can also do it.
27818 There are also some options that define macros implicitly, like
27819 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27820 defined this way.
27822 @item If debugging information is output when using the precompiled
27823 header, using @option{-g} or similar, the same kind of debugging information
27824 must have been output when building the precompiled header.  However,
27825 a precompiled header built using @option{-g} can be used in a compilation
27826 when no debugging information is being output.
27828 @item The same @option{-m} options must generally be used when building
27829 and using the precompiled header.  @xref{Submodel Options},
27830 for any cases where this rule is relaxed.
27832 @item Each of the following options must be the same when building and using
27833 the precompiled header:
27835 @gccoptlist{-fexceptions}
27837 @item
27838 Some other command-line options starting with @option{-f},
27839 @option{-p}, or @option{-O} must be defined in the same way as when
27840 the precompiled header was generated.  At present, it's not clear
27841 which options are safe to change and which are not; the safest choice
27842 is to use exactly the same options when generating and using the
27843 precompiled header.  The following are known to be safe:
27845 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27846 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27847 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27848 -pedantic-errors}
27850 @end itemize
27852 For all of these except the last, the compiler automatically
27853 ignores the precompiled header if the conditions aren't met.  If you
27854 find an option combination that doesn't work and doesn't cause the
27855 precompiled header to be ignored, please consider filing a bug report,
27856 see @ref{Bugs}.
27858 If you do use differing options when generating and using the
27859 precompiled header, the actual behavior is a mixture of the
27860 behavior for the options.  For instance, if you use @option{-g} to
27861 generate the precompiled header but not when using it, you may or may
27862 not get debugging information for routines in the precompiled header.