Daily bump.
[official-gcc.git] / gcc / doc / invoke.texi
blob98b73db17afb6e39b4e1ae585223df87a6655139
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gstatement-frontiers  -gno-statement-frontiers @gol
350 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
351 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
352 -fno-eliminate-unused-debug-types @gol
353 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
354 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
355 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
356 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
357 -fvar-tracking  -fvar-tracking-assignments}
359 @item Optimization Options
360 @xref{Optimize Options,,Options that Control Optimization}.
361 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
362 -falign-jumps[=@var{n}] @gol
363 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
364 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
365 -fauto-inc-dec  -fbranch-probabilities @gol
366 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
367 -fbtr-bb-exclusive  -fcaller-saves @gol
368 -fcombine-stack-adjustments  -fconserve-stack @gol
369 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
370 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
371 -fcx-limited-range @gol
372 -fdata-sections  -fdce  -fdelayed-branch @gol
373 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
374 -fdevirtualize-at-ltrans  -fdse @gol
375 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
376 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
377 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
378 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
379 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
380 -fif-conversion2  -findirect-inlining @gol
381 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
382 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
383 -fipa-bit-cp -fipa-vrp @gol
384 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
385 -fira-algorithm=@var{algorithm} @gol
386 -fira-region=@var{region}  -fira-hoist-pressure @gol
387 -fira-loop-pressure  -fno-ira-share-save-slots @gol
388 -fno-ira-share-spill-slots @gol
389 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
390 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
391 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
392 -floop-block  -floop-interchange  -floop-strip-mine @gol
393 -floop-unroll-and-jam  -floop-nest-optimize @gol
394 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
395 -flto-partition=@var{alg}  -fmerge-all-constants @gol
396 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
397 -fmove-loop-invariants  -fno-branch-count-reg @gol
398 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
399 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
400 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
401 -fno-sched-spec  -fno-signed-zeros @gol
402 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
403 -fomit-frame-pointer  -foptimize-sibling-calls @gol
404 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
405 -fprefetch-loop-arrays @gol
406 -fprofile-correction @gol
407 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
408 -fprofile-reorder-functions @gol
409 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
410 -freorder-blocks-algorithm=@var{algorithm} @gol
411 -freorder-blocks-and-partition  -freorder-functions @gol
412 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
413 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
414 -fsched-spec-load  -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
419 -fschedule-fusion @gol
420 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
421 -fselective-scheduling  -fselective-scheduling2 @gol
422 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
424 -fsignaling-nans @gol
425 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
426 -fsplit-paths @gol
427 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
428 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
429 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
431 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
432 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
433 -ftree-loop-if-convert  -ftree-loop-im @gol
434 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
438 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
439 -ftree-switch-conversion  -ftree-tail-merge @gol
440 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
441 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
442 -funsafe-math-optimizations  -funswitch-loops @gol
443 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
444 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
448 @item Program Instrumentation Options
449 @xref{Instrumentation Options,,Program Instrumentation Options}.
450 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
451 -fprofile-abs-path @gol
452 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
453 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
454 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
455 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
456 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
457 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
458 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
459 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
460 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
461 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
462 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
463 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
464 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
465 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
466 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
467 -fstack-protector-explicit  -fstack-check @gol
468 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
469 -fno-stack-limit  -fsplit-stack @gol
470 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
471 -fvtv-counts  -fvtv-debug @gol
472 -finstrument-functions @gol
473 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
474 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
476 @item Preprocessor Options
477 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
478 @gccoptlist{-A@var{question}=@var{answer} @gol
479 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
480 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
481 -dD  -dI  -dM  -dN  -dU @gol
482 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
483 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
484 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
485 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
486 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
487 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
488 -H  -imacros @var{file}  -include @var{file} @gol
489 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
490 -no-integrated-cpp  -P  -pthread  -remap @gol
491 -traditional  -traditional-cpp  -trigraphs @gol
492 -U@var{macro}  -undef  @gol
493 -Wp,@var{option}  -Xpreprocessor @var{option}}
495 @item Assembler Options
496 @xref{Assembler Options,,Passing Options to the Assembler}.
497 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
499 @item Linker Options
500 @xref{Link Options,,Options for Linking}.
501 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
502 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
503 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
504 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
505 -static-libmpx  -static-libmpxwrappers @gol
506 -shared  -shared-libgcc  -symbolic @gol
507 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
508 -u @var{symbol}  -z @var{keyword}}
510 @item Directory Options
511 @xref{Directory Options,,Options for Directory Search}.
512 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
513 -idirafter @var{dir} @gol
514 -imacros @var{file}  -imultilib @var{dir} @gol
515 -iplugindir=@var{dir}  -iprefix @var{file} @gol
516 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
517 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
518 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
519 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
521 @item Code Generation Options
522 @xref{Code Gen Options,,Options for Code Generation Conventions}.
523 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
524 -ffixed-@var{reg}  -fexceptions @gol
525 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
526 -fasynchronous-unwind-tables @gol
527 -fno-gnu-unique @gol
528 -finhibit-size-directive  -fno-common  -fno-ident @gol
529 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
530 -fno-jump-tables @gol
531 -frecord-gcc-switches @gol
532 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
533 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
534 -fleading-underscore  -ftls-model=@var{model} @gol
535 -fstack-reuse=@var{reuse_level} @gol
536 -ftrampolines  -ftrapv  -fwrapv @gol
537 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
538 -fstrict-volatile-bitfields  -fsync-libcalls}
540 @item Developer Options
541 @xref{Developer Options,,GCC Developer Options}.
542 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
543 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
544 -fdbg-cnt=@var{counter-value-list} @gol
545 -fdisable-ipa-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass_name} @gol
547 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
548 -fdisable-tree-@var{pass_name} @gol
549 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
550 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
551 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
552 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
553 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
554 -fdump-lang-all @gol
555 -fdump-lang-@var{switch} @gol
556 -fdump-lang-@var{switch}-@var{options} @gol
557 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
558 -fdump-passes @gol
559 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
560 -fdump-statistics @gol
561 -fdump-tree-all @gol
562 -fdump-tree-@var{switch} @gol
563 -fdump-tree-@var{switch}-@var{options} @gol
564 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
565 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
566 -fenable-@var{kind}-@var{pass} @gol
567 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
568 -fira-verbose=@var{n} @gol
569 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
570 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
571 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
572 -fprofile-report @gol
573 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
574 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
575 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
576 -fvar-tracking-assignments-toggle  -gtoggle @gol
577 -print-file-name=@var{library}  -print-libgcc-file-name @gol
578 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
579 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
580 -print-sysroot  -print-sysroot-headers-suffix @gol
581 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
583 @item Machine-Dependent Options
584 @xref{Submodel Options,,Machine-Dependent Options}.
585 @c This list is ordered alphanumerically by subsection name.
586 @c Try and put the significant identifier (CPU or system) first,
587 @c so users have a clue at guessing where the ones they want will be.
589 @emph{AArch64 Options}
590 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
591 -mgeneral-regs-only @gol
592 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
593 -mstrict-align @gol
594 -momit-leaf-frame-pointer @gol
595 -mtls-dialect=desc  -mtls-dialect=traditional @gol
596 -mtls-size=@var{size} @gol
597 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
598 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
599 -mpc-relative-literal-loads @gol
600 -msign-return-address=@var{scope} @gol
601 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
602 -moverride=@var{string}  -mverbose-cost-dump}
604 @emph{Adapteva Epiphany Options}
605 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
606 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
607 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
608 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
609 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
610 -msplit-vecmove-early  -m1reg-@var{reg}}
612 @emph{ARC Options}
613 @gccoptlist{-mbarrel-shifter @gol
614 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
615 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
616 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
617 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
618 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
619 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
620 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
621 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
622 -mvolatile-cache  -mtp-regno=@var{regno} @gol
623 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
624 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
625 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
626 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
627 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
628 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
629 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
630 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
632 @emph{ARM Options}
633 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
634 -mabi=@var{name} @gol
635 -mapcs-stack-check  -mno-apcs-stack-check @gol
636 -mapcs-reentrant  -mno-apcs-reentrant @gol
637 -msched-prolog  -mno-sched-prolog @gol
638 -mlittle-endian  -mbig-endian @gol
639 -mbe8 -mbe32 @gol
640 -mfloat-abi=@var{name} @gol
641 -mfp16-format=@var{name}
642 -mthumb-interwork  -mno-thumb-interwork @gol
643 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
644 -mtune=@var{name}  -mprint-tune-info @gol
645 -mstructure-size-boundary=@var{n} @gol
646 -mabort-on-noreturn @gol
647 -mlong-calls  -mno-long-calls @gol
648 -msingle-pic-base  -mno-single-pic-base @gol
649 -mpic-register=@var{reg} @gol
650 -mnop-fun-dllimport @gol
651 -mpoke-function-name @gol
652 -mthumb  -marm  -mflip-thumb @gol
653 -mtpcs-frame  -mtpcs-leaf-frame @gol
654 -mcaller-super-interworking  -mcallee-super-interworking @gol
655 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
656 -mword-relocations @gol
657 -mfix-cortex-m3-ldrd @gol
658 -munaligned-access @gol
659 -mneon-for-64bits @gol
660 -mslow-flash-data @gol
661 -masm-syntax-unified @gol
662 -mrestrict-it @gol
663 -mverbose-cost-dump @gol
664 -mpure-code @gol
665 -mcmse}
667 @emph{AVR Options}
668 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
669 -mbranch-cost=@var{cost} @gol
670 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
671 -mn_flash=@var{size}  -mno-interrupts @gol
672 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
673 -mfract-convert-truncate @gol
674 -mshort-calls  -nodevicelib @gol
675 -Waddr-space-convert  -Wmisspelled-isr}
677 @emph{Blackfin Options}
678 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
679 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
680 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
681 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
682 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
683 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
684 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
685 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
686 -micplb}
688 @emph{C6X Options}
689 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
690 -msim  -msdata=@var{sdata-type}}
692 @emph{CRIS Options}
693 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
694 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
695 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
696 -mstack-align  -mdata-align  -mconst-align @gol
697 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
698 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
699 -mmul-bug-workaround  -mno-mul-bug-workaround}
701 @emph{CR16 Options}
702 @gccoptlist{-mmac @gol
703 -mcr16cplus  -mcr16c @gol
704 -msim  -mint32  -mbit-ops
705 -mdata-model=@var{model}}
707 @emph{Darwin Options}
708 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
709 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
710 -client_name  -compatibility_version  -current_version @gol
711 -dead_strip @gol
712 -dependency-file  -dylib_file  -dylinker_install_name @gol
713 -dynamic  -dynamiclib  -exported_symbols_list @gol
714 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
715 -force_flat_namespace  -headerpad_max_install_names @gol
716 -iframework @gol
717 -image_base  -init  -install_name  -keep_private_externs @gol
718 -multi_module  -multiply_defined  -multiply_defined_unused @gol
719 -noall_load   -no_dead_strip_inits_and_terms @gol
720 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
721 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
722 -private_bundle  -read_only_relocs  -sectalign @gol
723 -sectobjectsymbols  -whyload  -seg1addr @gol
724 -sectcreate  -sectobjectsymbols  -sectorder @gol
725 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
726 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
727 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
728 -single_module  -static  -sub_library  -sub_umbrella @gol
729 -twolevel_namespace  -umbrella  -undefined @gol
730 -unexported_symbols_list  -weak_reference_mismatches @gol
731 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
732 -mkernel  -mone-byte-bool}
734 @emph{DEC Alpha Options}
735 @gccoptlist{-mno-fp-regs  -msoft-float @gol
736 -mieee  -mieee-with-inexact  -mieee-conformant @gol
737 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
738 -mtrap-precision=@var{mode}  -mbuild-constants @gol
739 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
740 -mbwx  -mmax  -mfix  -mcix @gol
741 -mfloat-vax  -mfloat-ieee @gol
742 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
743 -msmall-text  -mlarge-text @gol
744 -mmemory-latency=@var{time}}
746 @emph{FR30 Options}
747 @gccoptlist{-msmall-model  -mno-lsim}
749 @emph{FT32 Options}
750 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
752 @emph{FRV Options}
753 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
754 -mhard-float  -msoft-float @gol
755 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
756 -mdouble  -mno-double @gol
757 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
758 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
759 -mlinked-fp  -mlong-calls  -malign-labels @gol
760 -mlibrary-pic  -macc-4  -macc-8 @gol
761 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
762 -moptimize-membar  -mno-optimize-membar @gol
763 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
764 -mvliw-branch  -mno-vliw-branch @gol
765 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
766 -mno-nested-cond-exec  -mtomcat-stats @gol
767 -mTLS  -mtls @gol
768 -mcpu=@var{cpu}}
770 @emph{GNU/Linux Options}
771 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
772 -tno-android-cc  -tno-android-ld}
774 @emph{H8/300 Options}
775 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
777 @emph{HPPA Options}
778 @gccoptlist{-march=@var{architecture-type} @gol
779 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
780 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
781 -mfixed-range=@var{register-range} @gol
782 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
783 -mlong-load-store  -mno-disable-fpregs @gol
784 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
785 -mno-jump-in-delay  -mno-long-load-store @gol
786 -mno-portable-runtime  -mno-soft-float @gol
787 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
788 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
789 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
790 -munix=@var{unix-std}  -nolibdld  -static  -threads}
792 @emph{IA-64 Options}
793 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
794 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
795 -mconstant-gp  -mauto-pic  -mfused-madd @gol
796 -minline-float-divide-min-latency @gol
797 -minline-float-divide-max-throughput @gol
798 -mno-inline-float-divide @gol
799 -minline-int-divide-min-latency @gol
800 -minline-int-divide-max-throughput  @gol
801 -mno-inline-int-divide @gol
802 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
803 -mno-inline-sqrt @gol
804 -mdwarf2-asm  -mearly-stop-bits @gol
805 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
806 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
807 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
808 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
809 -msched-spec-ldc  -msched-spec-control-ldc @gol
810 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
811 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
812 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
813 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
815 @emph{LM32 Options}
816 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
817 -msign-extend-enabled  -muser-enabled}
819 @emph{M32R/D Options}
820 @gccoptlist{-m32r2  -m32rx  -m32r @gol
821 -mdebug @gol
822 -malign-loops  -mno-align-loops @gol
823 -missue-rate=@var{number} @gol
824 -mbranch-cost=@var{number} @gol
825 -mmodel=@var{code-size-model-type} @gol
826 -msdata=@var{sdata-type} @gol
827 -mno-flush-func  -mflush-func=@var{name} @gol
828 -mno-flush-trap  -mflush-trap=@var{number} @gol
829 -G @var{num}}
831 @emph{M32C Options}
832 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
834 @emph{M680x0 Options}
835 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
836 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
837 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
838 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
839 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
840 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
841 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
842 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
843 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
845 @emph{MCore Options}
846 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
847 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
848 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
849 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
850 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
852 @emph{MeP Options}
853 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
854 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
855 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
856 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
857 -mtiny=@var{n}}
859 @emph{MicroBlaze Options}
860 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
861 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
862 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
863 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
864 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
866 @emph{MIPS Options}
867 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
868 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
869 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
870 -mips16  -mno-mips16  -mflip-mips16 @gol
871 -minterlink-compressed  -mno-interlink-compressed @gol
872 -minterlink-mips16  -mno-interlink-mips16 @gol
873 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
874 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
875 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
876 -mno-float  -msingle-float  -mdouble-float @gol
877 -modd-spreg  -mno-odd-spreg @gol
878 -mabs=@var{mode}  -mnan=@var{encoding} @gol
879 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
880 -mmcu  -mmno-mcu @gol
881 -meva  -mno-eva @gol
882 -mvirt  -mno-virt @gol
883 -mxpa  -mno-xpa @gol
884 -mmicromips  -mno-micromips @gol
885 -mmsa  -mno-msa @gol
886 -mfpu=@var{fpu-type} @gol
887 -msmartmips  -mno-smartmips @gol
888 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
889 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
890 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
891 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
892 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
893 -membedded-data  -mno-embedded-data @gol
894 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
895 -mcode-readable=@var{setting} @gol
896 -msplit-addresses  -mno-split-addresses @gol
897 -mexplicit-relocs  -mno-explicit-relocs @gol
898 -mcheck-zero-division  -mno-check-zero-division @gol
899 -mdivide-traps  -mdivide-breaks @gol
900 -mload-store-pairs  -mno-load-store-pairs @gol
901 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
902 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
903 -mfix-24k  -mno-fix-24k @gol
904 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
905 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
906 -mfix-vr4120  -mno-fix-vr4120 @gol
907 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
908 -mflush-func=@var{func}  -mno-flush-func @gol
909 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
910 -mcompact-branches=@var{policy} @gol
911 -mfp-exceptions  -mno-fp-exceptions @gol
912 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
913 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
914 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
915 -mframe-header-opt  -mno-frame-header-opt}
917 @emph{MMIX Options}
918 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
919 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
920 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
921 -mno-base-addresses  -msingle-exit  -mno-single-exit}
923 @emph{MN10300 Options}
924 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
925 -mno-am33  -mam33  -mam33-2  -mam34 @gol
926 -mtune=@var{cpu-type} @gol
927 -mreturn-pointer-on-d0 @gol
928 -mno-crt0  -mrelax  -mliw  -msetlb}
930 @emph{Moxie Options}
931 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
933 @emph{MSP430 Options}
934 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
935 -mwarn-mcu @gol
936 -mcode-region=  -mdata-region= @gol
937 -msilicon-errata=  -msilicon-errata-warn= @gol
938 -mhwmult=  -minrt}
940 @emph{NDS32 Options}
941 @gccoptlist{-mbig-endian  -mlittle-endian @gol
942 -mreduced-regs  -mfull-regs @gol
943 -mcmov  -mno-cmov @gol
944 -mext-perf  -mno-ext-perf @gol
945 -mext-perf2  -mno-ext-perf2 @gol
946 -mext-string  -mno-ext-string @gol
947 -mv3push  -mno-v3push @gol
948 -m16bit  -mno-16bit @gol
949 -misr-vector-size=@var{num} @gol
950 -mcache-block-size=@var{num} @gol
951 -march=@var{arch} @gol
952 -mcmodel=@var{code-model} @gol
953 -mctor-dtor  -mrelax}
955 @emph{Nios II Options}
956 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
957 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
958 -mel  -meb @gol
959 -mno-bypass-cache  -mbypass-cache @gol
960 -mno-cache-volatile  -mcache-volatile @gol
961 -mno-fast-sw-div  -mfast-sw-div @gol
962 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
963 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
964 -mcustom-fpu-cfg=@var{name} @gol
965 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
966 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
968 @emph{Nvidia PTX Options}
969 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
971 @emph{PDP-11 Options}
972 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
973 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
974 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
975 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
976 -mbranch-expensive  -mbranch-cheap @gol
977 -munix-asm  -mdec-asm}
979 @emph{picoChip Options}
980 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
981 -msymbol-as-address  -mno-inefficient-warnings}
983 @emph{PowerPC Options}
984 See RS/6000 and PowerPC Options.
986 @emph{RISC-V Options}
987 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
988 -mplt  -mno-plt @gol
989 -mabi=@var{ABI-string} @gol
990 -mfdiv  -mno-fdiv @gol
991 -mdiv  -mno-div @gol
992 -march=@var{ISA-string} @gol
993 -mtune=@var{processor-string} @gol
994 -msmall-data-limit=@var{N-bytes} @gol
995 -msave-restore  -mno-save-restore @gol
996 -mstrict-align -mno-strict-align @gol
997 -mcmodel=medlow -mcmodel=medany @gol
998 -mexplicit-relocs  -mno-explicit-relocs @gol}
1000 @emph{RL78 Options}
1001 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1002 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1003 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1005 @emph{RS/6000 and PowerPC Options}
1006 @gccoptlist{-mcpu=@var{cpu-type} @gol
1007 -mtune=@var{cpu-type} @gol
1008 -mcmodel=@var{code-model} @gol
1009 -mpowerpc64 @gol
1010 -maltivec  -mno-altivec @gol
1011 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1012 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1013 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1014 -mfprnd  -mno-fprnd @gol
1015 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1016 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1017 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1018 -malign-power  -malign-natural @gol
1019 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1020 -msingle-float  -mdouble-float  -msimple-fpu @gol
1021 -mupdate  -mno-update @gol
1022 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1023 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1024 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1025 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1026 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1027 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1028 -mprioritize-restricted-insns=@var{priority} @gol
1029 -msched-costly-dep=@var{dependence_type} @gol
1030 -minsert-sched-nops=@var{scheme} @gol
1031 -mcall-sysv  -mcall-netbsd @gol
1032 -maix-struct-return  -msvr4-struct-return @gol
1033 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1034 -mblock-move-inline-limit=@var{num} @gol
1035 -misel  -mno-isel @gol
1036 -misel=yes  -misel=no @gol
1037 -mspe  -mno-spe @gol
1038 -mspe=yes  -mspe=no @gol
1039 -mpaired @gol
1040 -mvrsave  -mno-vrsave @gol
1041 -mmulhw  -mno-mulhw @gol
1042 -mdlmzb  -mno-dlmzb @gol
1043 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1044 -mprototype  -mno-prototype @gol
1045 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1046 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1047 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1048 -mno-recip-precision @gol
1049 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1050 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1051 -msave-toc-indirect  -mno-save-toc-indirect @gol
1052 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1053 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1054 -mquad-memory  -mno-quad-memory @gol
1055 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1056 -mcompat-align-parm  -mno-compat-align-parm @gol
1057 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1058 -mgnu-attribute  -mno-gnu-attribute @gol
1059 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1060 -mstack-protector-guard-offset=@var{offset}}
1062 @emph{RX Options}
1063 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1064 -mcpu=@gol
1065 -mbig-endian-data  -mlittle-endian-data @gol
1066 -msmall-data @gol
1067 -msim  -mno-sim@gol
1068 -mas100-syntax  -mno-as100-syntax@gol
1069 -mrelax@gol
1070 -mmax-constant-size=@gol
1071 -mint-register=@gol
1072 -mpid@gol
1073 -mallow-string-insns  -mno-allow-string-insns@gol
1074 -mjsr@gol
1075 -mno-warn-multiple-fast-interrupts@gol
1076 -msave-acc-in-interrupts}
1078 @emph{S/390 and zSeries Options}
1079 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1080 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1081 -mlong-double-64  -mlong-double-128 @gol
1082 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1083 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1084 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1085 -mhtm  -mvx  -mzvector @gol
1086 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1087 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1088 -mhotpatch=@var{halfwords},@var{halfwords}}
1090 @emph{Score Options}
1091 @gccoptlist{-meb  -mel @gol
1092 -mnhwloop @gol
1093 -muls @gol
1094 -mmac @gol
1095 -mscore5  -mscore5u  -mscore7  -mscore7d}
1097 @emph{SH Options}
1098 @gccoptlist{-m1  -m2  -m2e @gol
1099 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1100 -m3  -m3e @gol
1101 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1102 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1103 -mb  -ml  -mdalign  -mrelax @gol
1104 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1105 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1106 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1107 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1108 -maccumulate-outgoing-args @gol
1109 -matomic-model=@var{atomic-model} @gol
1110 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1111 -mcbranch-force-delay-slot @gol
1112 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1113 -mpretend-cmove  -mtas}
1115 @emph{Solaris 2 Options}
1116 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1117 -pthreads}
1119 @emph{SPARC Options}
1120 @gccoptlist{-mcpu=@var{cpu-type} @gol
1121 -mtune=@var{cpu-type} @gol
1122 -mcmodel=@var{code-model} @gol
1123 -mmemory-model=@var{mem-model} @gol
1124 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1125 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1126 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1127 -mhard-quad-float  -msoft-quad-float @gol
1128 -mstack-bias  -mno-stack-bias @gol
1129 -mstd-struct-return  -mno-std-struct-return @gol
1130 -munaligned-doubles  -mno-unaligned-doubles @gol
1131 -muser-mode  -mno-user-mode @gol
1132 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1133 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1134 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1135 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1136 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1137 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1138 -mlra  -mno-lra}
1140 @emph{SPU Options}
1141 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1142 -msafe-dma  -munsafe-dma @gol
1143 -mbranch-hints @gol
1144 -msmall-mem  -mlarge-mem  -mstdmain @gol
1145 -mfixed-range=@var{register-range} @gol
1146 -mea32  -mea64 @gol
1147 -maddress-space-conversion  -mno-address-space-conversion @gol
1148 -mcache-size=@var{cache-size} @gol
1149 -matomic-updates  -mno-atomic-updates}
1151 @emph{System V Options}
1152 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1154 @emph{TILE-Gx Options}
1155 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1156 -mcmodel=@var{code-model}}
1158 @emph{TILEPro Options}
1159 @gccoptlist{-mcpu=@var{cpu}  -m32}
1161 @emph{V850 Options}
1162 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1163 -mprolog-function  -mno-prolog-function  -mspace @gol
1164 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1165 -mapp-regs  -mno-app-regs @gol
1166 -mdisable-callt  -mno-disable-callt @gol
1167 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1168 -mv850e  -mv850  -mv850e3v5 @gol
1169 -mloop @gol
1170 -mrelax @gol
1171 -mlong-jumps @gol
1172 -msoft-float @gol
1173 -mhard-float @gol
1174 -mgcc-abi @gol
1175 -mrh850-abi @gol
1176 -mbig-switch}
1178 @emph{VAX Options}
1179 @gccoptlist{-mg  -mgnu  -munix}
1181 @emph{Visium Options}
1182 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1183 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1185 @emph{VMS Options}
1186 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1187 -mpointer-size=@var{size}}
1189 @emph{VxWorks Options}
1190 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1191 -Xbind-lazy  -Xbind-now}
1193 @emph{x86 Options}
1194 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1195 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1196 -mfpmath=@var{unit} @gol
1197 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1198 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1199 -mno-wide-multiply  -mrtd  -malign-double @gol
1200 -mpreferred-stack-boundary=@var{num} @gol
1201 -mincoming-stack-boundary=@var{num} @gol
1202 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1203 -mrecip  -mrecip=@var{opt} @gol
1204 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1205 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1206 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1207 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1208 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1209 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1210 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1211 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1212 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1213 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1214 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1215 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1216 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1217 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1218 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1219 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1220 -mregparm=@var{num}  -msseregparm @gol
1221 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1222 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1223 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1224 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1225 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1226 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1227 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1228 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1229 -mstack-protector-guard-reg=@var{reg} @gol
1230 -mstack-protector-guard-offset=@var{offset} @gol
1231 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1232 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1233 -mindirect-branch=@var{choice} -mfunction-return==@var{choice} @gol
1234 -mindirect-branch-register}
1236 @emph{x86 Windows Options}
1237 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1238 -mnop-fun-dllimport  -mthread @gol
1239 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1241 @emph{Xstormy16 Options}
1242 @gccoptlist{-msim}
1244 @emph{Xtensa Options}
1245 @gccoptlist{-mconst16  -mno-const16 @gol
1246 -mfused-madd  -mno-fused-madd @gol
1247 -mforce-no-pic @gol
1248 -mserialize-volatile  -mno-serialize-volatile @gol
1249 -mtext-section-literals  -mno-text-section-literals @gol
1250 -mauto-litpools  -mno-auto-litpools @gol
1251 -mtarget-align  -mno-target-align @gol
1252 -mlongcalls  -mno-longcalls}
1254 @emph{zSeries Options}
1255 See S/390 and zSeries Options.
1256 @end table
1259 @node Overall Options
1260 @section Options Controlling the Kind of Output
1262 Compilation can involve up to four stages: preprocessing, compilation
1263 proper, assembly and linking, always in that order.  GCC is capable of
1264 preprocessing and compiling several files either into several
1265 assembler input files, or into one assembler input file; then each
1266 assembler input file produces an object file, and linking combines all
1267 the object files (those newly compiled, and those specified as input)
1268 into an executable file.
1270 @cindex file name suffix
1271 For any given input file, the file name suffix determines what kind of
1272 compilation is done:
1274 @table @gcctabopt
1275 @item @var{file}.c
1276 C source code that must be preprocessed.
1278 @item @var{file}.i
1279 C source code that should not be preprocessed.
1281 @item @var{file}.ii
1282 C++ source code that should not be preprocessed.
1284 @item @var{file}.m
1285 Objective-C source code.  Note that you must link with the @file{libobjc}
1286 library to make an Objective-C program work.
1288 @item @var{file}.mi
1289 Objective-C source code that should not be preprocessed.
1291 @item @var{file}.mm
1292 @itemx @var{file}.M
1293 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1294 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1295 to a literal capital M@.
1297 @item @var{file}.mii
1298 Objective-C++ source code that should not be preprocessed.
1300 @item @var{file}.h
1301 C, C++, Objective-C or Objective-C++ header file to be turned into a
1302 precompiled header (default), or C, C++ header file to be turned into an
1303 Ada spec (via the @option{-fdump-ada-spec} switch).
1305 @item @var{file}.cc
1306 @itemx @var{file}.cp
1307 @itemx @var{file}.cxx
1308 @itemx @var{file}.cpp
1309 @itemx @var{file}.CPP
1310 @itemx @var{file}.c++
1311 @itemx @var{file}.C
1312 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1313 the last two letters must both be literally @samp{x}.  Likewise,
1314 @samp{.C} refers to a literal capital C@.
1316 @item @var{file}.mm
1317 @itemx @var{file}.M
1318 Objective-C++ source code that must be preprocessed.
1320 @item @var{file}.mii
1321 Objective-C++ source code that should not be preprocessed.
1323 @item @var{file}.hh
1324 @itemx @var{file}.H
1325 @itemx @var{file}.hp
1326 @itemx @var{file}.hxx
1327 @itemx @var{file}.hpp
1328 @itemx @var{file}.HPP
1329 @itemx @var{file}.h++
1330 @itemx @var{file}.tcc
1331 C++ header file to be turned into a precompiled header or Ada spec.
1333 @item @var{file}.f
1334 @itemx @var{file}.for
1335 @itemx @var{file}.ftn
1336 Fixed form Fortran source code that should not be preprocessed.
1338 @item @var{file}.F
1339 @itemx @var{file}.FOR
1340 @itemx @var{file}.fpp
1341 @itemx @var{file}.FPP
1342 @itemx @var{file}.FTN
1343 Fixed form Fortran source code that must be preprocessed (with the traditional
1344 preprocessor).
1346 @item @var{file}.f90
1347 @itemx @var{file}.f95
1348 @itemx @var{file}.f03
1349 @itemx @var{file}.f08
1350 Free form Fortran source code that should not be preprocessed.
1352 @item @var{file}.F90
1353 @itemx @var{file}.F95
1354 @itemx @var{file}.F03
1355 @itemx @var{file}.F08
1356 Free form Fortran source code that must be preprocessed (with the
1357 traditional preprocessor).
1359 @item @var{file}.go
1360 Go source code.
1362 @item @var{file}.brig
1363 BRIG files (binary representation of HSAIL).
1365 @item @var{file}.ads
1366 Ada source code file that contains a library unit declaration (a
1367 declaration of a package, subprogram, or generic, or a generic
1368 instantiation), or a library unit renaming declaration (a package,
1369 generic, or subprogram renaming declaration).  Such files are also
1370 called @dfn{specs}.
1372 @item @var{file}.adb
1373 Ada source code file containing a library unit body (a subprogram or
1374 package body).  Such files are also called @dfn{bodies}.
1376 @c GCC also knows about some suffixes for languages not yet included:
1377 @c Pascal:
1378 @c @var{file}.p
1379 @c @var{file}.pas
1380 @c Ratfor:
1381 @c @var{file}.r
1383 @item @var{file}.s
1384 Assembler code.
1386 @item @var{file}.S
1387 @itemx @var{file}.sx
1388 Assembler code that must be preprocessed.
1390 @item @var{other}
1391 An object file to be fed straight into linking.
1392 Any file name with no recognized suffix is treated this way.
1393 @end table
1395 @opindex x
1396 You can specify the input language explicitly with the @option{-x} option:
1398 @table @gcctabopt
1399 @item -x @var{language}
1400 Specify explicitly the @var{language} for the following input files
1401 (rather than letting the compiler choose a default based on the file
1402 name suffix).  This option applies to all following input files until
1403 the next @option{-x} option.  Possible values for @var{language} are:
1404 @smallexample
1405 c  c-header  cpp-output
1406 c++  c++-header  c++-cpp-output
1407 objective-c  objective-c-header  objective-c-cpp-output
1408 objective-c++ objective-c++-header objective-c++-cpp-output
1409 assembler  assembler-with-cpp
1411 f77  f77-cpp-input f95  f95-cpp-input
1413 brig
1414 @end smallexample
1416 @item -x none
1417 Turn off any specification of a language, so that subsequent files are
1418 handled according to their file name suffixes (as they are if @option{-x}
1419 has not been used at all).
1420 @end table
1422 If you only want some of the stages of compilation, you can use
1423 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1424 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1425 @command{gcc} is to stop.  Note that some combinations (for example,
1426 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1428 @table @gcctabopt
1429 @item -c
1430 @opindex c
1431 Compile or assemble the source files, but do not link.  The linking
1432 stage simply is not done.  The ultimate output is in the form of an
1433 object file for each source file.
1435 By default, the object file name for a source file is made by replacing
1436 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1438 Unrecognized input files, not requiring compilation or assembly, are
1439 ignored.
1441 @item -S
1442 @opindex S
1443 Stop after the stage of compilation proper; do not assemble.  The output
1444 is in the form of an assembler code file for each non-assembler input
1445 file specified.
1447 By default, the assembler file name for a source file is made by
1448 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1450 Input files that don't require compilation are ignored.
1452 @item -E
1453 @opindex E
1454 Stop after the preprocessing stage; do not run the compiler proper.  The
1455 output is in the form of preprocessed source code, which is sent to the
1456 standard output.
1458 Input files that don't require preprocessing are ignored.
1460 @cindex output file option
1461 @item -o @var{file}
1462 @opindex o
1463 Place output in file @var{file}.  This applies to whatever
1464 sort of output is being produced, whether it be an executable file,
1465 an object file, an assembler file or preprocessed C code.
1467 If @option{-o} is not specified, the default is to put an executable
1468 file in @file{a.out}, the object file for
1469 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1470 assembler file in @file{@var{source}.s}, a precompiled header file in
1471 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1472 standard output.
1474 @item -v
1475 @opindex v
1476 Print (on standard error output) the commands executed to run the stages
1477 of compilation.  Also print the version number of the compiler driver
1478 program and of the preprocessor and the compiler proper.
1480 @item -###
1481 @opindex ###
1482 Like @option{-v} except the commands are not executed and arguments
1483 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1484 This is useful for shell scripts to capture the driver-generated command lines.
1486 @item --help
1487 @opindex help
1488 Print (on the standard output) a description of the command-line options
1489 understood by @command{gcc}.  If the @option{-v} option is also specified
1490 then @option{--help} is also passed on to the various processes
1491 invoked by @command{gcc}, so that they can display the command-line options
1492 they accept.  If the @option{-Wextra} option has also been specified
1493 (prior to the @option{--help} option), then command-line options that
1494 have no documentation associated with them are also displayed.
1496 @item --target-help
1497 @opindex target-help
1498 Print (on the standard output) a description of target-specific command-line
1499 options for each tool.  For some targets extra target-specific
1500 information may also be printed.
1502 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1503 Print (on the standard output) a description of the command-line
1504 options understood by the compiler that fit into all specified classes
1505 and qualifiers.  These are the supported classes:
1507 @table @asis
1508 @item @samp{optimizers}
1509 Display all of the optimization options supported by the
1510 compiler.
1512 @item @samp{warnings}
1513 Display all of the options controlling warning messages
1514 produced by the compiler.
1516 @item @samp{target}
1517 Display target-specific options.  Unlike the
1518 @option{--target-help} option however, target-specific options of the
1519 linker and assembler are not displayed.  This is because those
1520 tools do not currently support the extended @option{--help=} syntax.
1522 @item @samp{params}
1523 Display the values recognized by the @option{--param}
1524 option.
1526 @item @var{language}
1527 Display the options supported for @var{language}, where
1528 @var{language} is the name of one of the languages supported in this
1529 version of GCC@.
1531 @item @samp{common}
1532 Display the options that are common to all languages.
1533 @end table
1535 These are the supported qualifiers:
1537 @table @asis
1538 @item @samp{undocumented}
1539 Display only those options that are undocumented.
1541 @item @samp{joined}
1542 Display options taking an argument that appears after an equal
1543 sign in the same continuous piece of text, such as:
1544 @samp{--help=target}.
1546 @item @samp{separate}
1547 Display options taking an argument that appears as a separate word
1548 following the original option, such as: @samp{-o output-file}.
1549 @end table
1551 Thus for example to display all the undocumented target-specific
1552 switches supported by the compiler, use:
1554 @smallexample
1555 --help=target,undocumented
1556 @end smallexample
1558 The sense of a qualifier can be inverted by prefixing it with the
1559 @samp{^} character, so for example to display all binary warning
1560 options (i.e., ones that are either on or off and that do not take an
1561 argument) that have a description, use:
1563 @smallexample
1564 --help=warnings,^joined,^undocumented
1565 @end smallexample
1567 The argument to @option{--help=} should not consist solely of inverted
1568 qualifiers.
1570 Combining several classes is possible, although this usually
1571 restricts the output so much that there is nothing to display.  One
1572 case where it does work, however, is when one of the classes is
1573 @var{target}.  For example, to display all the target-specific
1574 optimization options, use:
1576 @smallexample
1577 --help=target,optimizers
1578 @end smallexample
1580 The @option{--help=} option can be repeated on the command line.  Each
1581 successive use displays its requested class of options, skipping
1582 those that have already been displayed.
1584 If the @option{-Q} option appears on the command line before the
1585 @option{--help=} option, then the descriptive text displayed by
1586 @option{--help=} is changed.  Instead of describing the displayed
1587 options, an indication is given as to whether the option is enabled,
1588 disabled or set to a specific value (assuming that the compiler
1589 knows this at the point where the @option{--help=} option is used).
1591 Here is a truncated example from the ARM port of @command{gcc}:
1593 @smallexample
1594   % gcc -Q -mabi=2 --help=target -c
1595   The following options are target specific:
1596   -mabi=                                2
1597   -mabort-on-noreturn                   [disabled]
1598   -mapcs                                [disabled]
1599 @end smallexample
1601 The output is sensitive to the effects of previous command-line
1602 options, so for example it is possible to find out which optimizations
1603 are enabled at @option{-O2} by using:
1605 @smallexample
1606 -Q -O2 --help=optimizers
1607 @end smallexample
1609 Alternatively you can discover which binary optimizations are enabled
1610 by @option{-O3} by using:
1612 @smallexample
1613 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1614 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1615 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1616 @end smallexample
1618 @item --version
1619 @opindex version
1620 Display the version number and copyrights of the invoked GCC@.
1622 @item -pass-exit-codes
1623 @opindex pass-exit-codes
1624 Normally the @command{gcc} program exits with the code of 1 if any
1625 phase of the compiler returns a non-success return code.  If you specify
1626 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1627 the numerically highest error produced by any phase returning an error
1628 indication.  The C, C++, and Fortran front ends return 4 if an internal
1629 compiler error is encountered.
1631 @item -pipe
1632 @opindex pipe
1633 Use pipes rather than temporary files for communication between the
1634 various stages of compilation.  This fails to work on some systems where
1635 the assembler is unable to read from a pipe; but the GNU assembler has
1636 no trouble.
1638 @item -specs=@var{file}
1639 @opindex specs
1640 Process @var{file} after the compiler reads in the standard @file{specs}
1641 file, in order to override the defaults which the @command{gcc} driver
1642 program uses when determining what switches to pass to @command{cc1},
1643 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1644 @option{-specs=@var{file}} can be specified on the command line, and they
1645 are processed in order, from left to right.  @xref{Spec Files}, for
1646 information about the format of the @var{file}.
1648 @item -wrapper
1649 @opindex wrapper
1650 Invoke all subcommands under a wrapper program.  The name of the
1651 wrapper program and its parameters are passed as a comma separated
1652 list.
1654 @smallexample
1655 gcc -c t.c -wrapper gdb,--args
1656 @end smallexample
1658 @noindent
1659 This invokes all subprograms of @command{gcc} under
1660 @samp{gdb --args}, thus the invocation of @command{cc1} is
1661 @samp{gdb --args cc1 @dots{}}.
1663 @item -fplugin=@var{name}.so
1664 @opindex fplugin
1665 Load the plugin code in file @var{name}.so, assumed to be a
1666 shared object to be dlopen'd by the compiler.  The base name of
1667 the shared object file is used to identify the plugin for the
1668 purposes of argument parsing (See
1669 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1670 Each plugin should define the callback functions specified in the
1671 Plugins API.
1673 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1674 @opindex fplugin-arg
1675 Define an argument called @var{key} with a value of @var{value}
1676 for the plugin called @var{name}.
1678 @item -fdump-ada-spec@r{[}-slim@r{]}
1679 @opindex fdump-ada-spec
1680 For C and C++ source and include files, generate corresponding Ada specs.
1681 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1682 GNAT User's Guide}, which provides detailed documentation on this feature.
1684 @item -fada-spec-parent=@var{unit}
1685 @opindex fada-spec-parent
1686 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1687 Ada specs as child units of parent @var{unit}.
1689 @item -fdump-go-spec=@var{file}
1690 @opindex fdump-go-spec
1691 For input files in any language, generate corresponding Go
1692 declarations in @var{file}.  This generates Go @code{const},
1693 @code{type}, @code{var}, and @code{func} declarations which may be a
1694 useful way to start writing a Go interface to code written in some
1695 other language.
1697 @include @value{srcdir}/../libiberty/at-file.texi
1698 @end table
1700 @node Invoking G++
1701 @section Compiling C++ Programs
1703 @cindex suffixes for C++ source
1704 @cindex C++ source file suffixes
1705 C++ source files conventionally use one of the suffixes @samp{.C},
1706 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1707 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1708 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1709 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1710 files with these names and compiles them as C++ programs even if you
1711 call the compiler the same way as for compiling C programs (usually
1712 with the name @command{gcc}).
1714 @findex g++
1715 @findex c++
1716 However, the use of @command{gcc} does not add the C++ library.
1717 @command{g++} is a program that calls GCC and automatically specifies linking
1718 against the C++ library.  It treats @samp{.c},
1719 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1720 files unless @option{-x} is used.  This program is also useful when
1721 precompiling a C header file with a @samp{.h} extension for use in C++
1722 compilations.  On many systems, @command{g++} is also installed with
1723 the name @command{c++}.
1725 @cindex invoking @command{g++}
1726 When you compile C++ programs, you may specify many of the same
1727 command-line options that you use for compiling programs in any
1728 language; or command-line options meaningful for C and related
1729 languages; or options that are meaningful only for C++ programs.
1730 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1731 explanations of options for languages related to C@.
1732 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1733 explanations of options that are meaningful only for C++ programs.
1735 @node C Dialect Options
1736 @section Options Controlling C Dialect
1737 @cindex dialect options
1738 @cindex language dialect options
1739 @cindex options, dialect
1741 The following options control the dialect of C (or languages derived
1742 from C, such as C++, Objective-C and Objective-C++) that the compiler
1743 accepts:
1745 @table @gcctabopt
1746 @cindex ANSI support
1747 @cindex ISO support
1748 @item -ansi
1749 @opindex ansi
1750 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1751 equivalent to @option{-std=c++98}.
1753 This turns off certain features of GCC that are incompatible with ISO
1754 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1755 such as the @code{asm} and @code{typeof} keywords, and
1756 predefined macros such as @code{unix} and @code{vax} that identify the
1757 type of system you are using.  It also enables the undesirable and
1758 rarely used ISO trigraph feature.  For the C compiler,
1759 it disables recognition of C++ style @samp{//} comments as well as
1760 the @code{inline} keyword.
1762 The alternate keywords @code{__asm__}, @code{__extension__},
1763 @code{__inline__} and @code{__typeof__} continue to work despite
1764 @option{-ansi}.  You would not want to use them in an ISO C program, of
1765 course, but it is useful to put them in header files that might be included
1766 in compilations done with @option{-ansi}.  Alternate predefined macros
1767 such as @code{__unix__} and @code{__vax__} are also available, with or
1768 without @option{-ansi}.
1770 The @option{-ansi} option does not cause non-ISO programs to be
1771 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1772 addition to @option{-ansi}.  @xref{Warning Options}.
1774 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1775 option is used.  Some header files may notice this macro and refrain
1776 from declaring certain functions or defining certain macros that the
1777 ISO standard doesn't call for; this is to avoid interfering with any
1778 programs that might use these names for other things.
1780 Functions that are normally built in but do not have semantics
1781 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1782 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1783 built-in functions provided by GCC}, for details of the functions
1784 affected.
1786 @item -std=
1787 @opindex std
1788 Determine the language standard. @xref{Standards,,Language Standards
1789 Supported by GCC}, for details of these standard versions.  This option
1790 is currently only supported when compiling C or C++.
1792 The compiler can accept several base standards, such as @samp{c90} or
1793 @samp{c++98}, and GNU dialects of those standards, such as
1794 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1795 compiler accepts all programs following that standard plus those
1796 using GNU extensions that do not contradict it.  For example,
1797 @option{-std=c90} turns off certain features of GCC that are
1798 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1799 keywords, but not other GNU extensions that do not have a meaning in
1800 ISO C90, such as omitting the middle term of a @code{?:}
1801 expression. On the other hand, when a GNU dialect of a standard is
1802 specified, all features supported by the compiler are enabled, even when
1803 those features change the meaning of the base standard.  As a result, some
1804 strict-conforming programs may be rejected.  The particular standard
1805 is used by @option{-Wpedantic} to identify which features are GNU
1806 extensions given that version of the standard. For example
1807 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1808 comments, while @option{-std=gnu99 -Wpedantic} does not.
1810 A value for this option must be provided; possible values are
1812 @table @samp
1813 @item c90
1814 @itemx c89
1815 @itemx iso9899:1990
1816 Support all ISO C90 programs (certain GNU extensions that conflict
1817 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1819 @item iso9899:199409
1820 ISO C90 as modified in amendment 1.
1822 @item c99
1823 @itemx c9x
1824 @itemx iso9899:1999
1825 @itemx iso9899:199x
1826 ISO C99.  This standard is substantially completely supported, modulo
1827 bugs and floating-point issues
1828 (mainly but not entirely relating to optional C99 features from
1829 Annexes F and G).  See
1830 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1831 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1833 @item c11
1834 @itemx c1x
1835 @itemx iso9899:2011
1836 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1837 substantially completely supported, modulo bugs, floating-point issues
1838 (mainly but not entirely relating to optional C11 features from
1839 Annexes F and G) and the optional Annexes K (Bounds-checking
1840 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1842 @item c17
1843 @itemx c18
1844 @itemx iso9899:2017
1845 @itemx iso9899:2018
1846 ISO C17, the 2017 revision of the ISO C standard (expected to be
1847 published in 2018).  This standard is
1848 same as C11 except for corrections of defects (all of which are also
1849 applied with @option{-std=c11}) and a new value of
1850 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1852 @item gnu90
1853 @itemx gnu89
1854 GNU dialect of ISO C90 (including some C99 features).
1856 @item gnu99
1857 @itemx gnu9x
1858 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1860 @item gnu11
1861 @itemx gnu1x
1862 GNU dialect of ISO C11.
1863 The name @samp{gnu1x} is deprecated.
1865 @item gnu17
1866 @itemx gnu18
1867 GNU dialect of ISO C17.  This is the default for C code.
1869 @item c++98
1870 @itemx c++03
1871 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1872 additional defect reports. Same as @option{-ansi} for C++ code.
1874 @item gnu++98
1875 @itemx gnu++03
1876 GNU dialect of @option{-std=c++98}.
1878 @item c++11
1879 @itemx c++0x
1880 The 2011 ISO C++ standard plus amendments.
1881 The name @samp{c++0x} is deprecated.
1883 @item gnu++11
1884 @itemx gnu++0x
1885 GNU dialect of @option{-std=c++11}.
1886 The name @samp{gnu++0x} is deprecated.
1888 @item c++14
1889 @itemx c++1y
1890 The 2014 ISO C++ standard plus amendments.
1891 The name @samp{c++1y} is deprecated.
1893 @item gnu++14
1894 @itemx gnu++1y
1895 GNU dialect of @option{-std=c++14}.
1896 This is the default for C++ code.
1897 The name @samp{gnu++1y} is deprecated.
1899 @item c++17
1900 @itemx c++1z
1901 The 2017 ISO C++ standard plus amendments.
1902 The name @samp{c++1z} is deprecated.
1904 @item gnu++17
1905 @itemx gnu++1z
1906 GNU dialect of @option{-std=c++17}.
1907 The name @samp{gnu++1z} is deprecated.
1909 @item c++2a
1910 The next revision of the ISO C++ standard, tentatively planned for
1911 2020.  Support is highly experimental, and will almost certainly
1912 change in incompatible ways in future releases.
1914 @item gnu++2a
1915 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1916 and will almost certainly change in incompatible ways in future
1917 releases.
1918 @end table
1920 @item -fgnu89-inline
1921 @opindex fgnu89-inline
1922 The option @option{-fgnu89-inline} tells GCC to use the traditional
1923 GNU semantics for @code{inline} functions when in C99 mode.
1924 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1925 Using this option is roughly equivalent to adding the
1926 @code{gnu_inline} function attribute to all inline functions
1927 (@pxref{Function Attributes}).
1929 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1930 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1931 specifies the default behavior).
1932 This option is not supported in @option{-std=c90} or
1933 @option{-std=gnu90} mode.
1935 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1936 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1937 in effect for @code{inline} functions.  @xref{Common Predefined
1938 Macros,,,cpp,The C Preprocessor}.
1940 @item -fpermitted-flt-eval-methods=@var{style}
1941 @opindex fpermitted-flt-eval-methods
1942 @opindex fpermitted-flt-eval-methods=c11
1943 @opindex fpermitted-flt-eval-methods=ts-18661-3
1944 ISO/IEC TS 18661-3 defines new permissible values for
1945 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1946 a semantic type that is an interchange or extended format should be
1947 evaluated to the precision and range of that type.  These new values are
1948 a superset of those permitted under C99/C11, which does not specify the
1949 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1950 conforming to C11 may not have been written expecting the possibility of
1951 the new values.
1953 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1954 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1955 or the extended set of values specified in ISO/IEC TS 18661-3.
1957 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1959 The default when in a standards compliant mode (@option{-std=c11} or similar)
1960 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1961 dialect (@option{-std=gnu11} or similar) is
1962 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1964 @item -aux-info @var{filename}
1965 @opindex aux-info
1966 Output to the given filename prototyped declarations for all functions
1967 declared and/or defined in a translation unit, including those in header
1968 files.  This option is silently ignored in any language other than C@.
1970 Besides declarations, the file indicates, in comments, the origin of
1971 each declaration (source file and line), whether the declaration was
1972 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1973 @samp{O} for old, respectively, in the first character after the line
1974 number and the colon), and whether it came from a declaration or a
1975 definition (@samp{C} or @samp{F}, respectively, in the following
1976 character).  In the case of function definitions, a K&R-style list of
1977 arguments followed by their declarations is also provided, inside
1978 comments, after the declaration.
1980 @item -fallow-parameterless-variadic-functions
1981 @opindex fallow-parameterless-variadic-functions
1982 Accept variadic functions without named parameters.
1984 Although it is possible to define such a function, this is not very
1985 useful as it is not possible to read the arguments.  This is only
1986 supported for C as this construct is allowed by C++.
1988 @item -fno-asm
1989 @opindex fno-asm
1990 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1991 keyword, so that code can use these words as identifiers.  You can use
1992 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1993 instead.  @option{-ansi} implies @option{-fno-asm}.
1995 In C++, this switch only affects the @code{typeof} keyword, since
1996 @code{asm} and @code{inline} are standard keywords.  You may want to
1997 use the @option{-fno-gnu-keywords} flag instead, which has the same
1998 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1999 switch only affects the @code{asm} and @code{typeof} keywords, since
2000 @code{inline} is a standard keyword in ISO C99.
2002 @item -fno-builtin
2003 @itemx -fno-builtin-@var{function}
2004 @opindex fno-builtin
2005 @cindex built-in functions
2006 Don't recognize built-in functions that do not begin with
2007 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2008 functions provided by GCC}, for details of the functions affected,
2009 including those which are not built-in functions when @option{-ansi} or
2010 @option{-std} options for strict ISO C conformance are used because they
2011 do not have an ISO standard meaning.
2013 GCC normally generates special code to handle certain built-in functions
2014 more efficiently; for instance, calls to @code{alloca} may become single
2015 instructions which adjust the stack directly, and calls to @code{memcpy}
2016 may become inline copy loops.  The resulting code is often both smaller
2017 and faster, but since the function calls no longer appear as such, you
2018 cannot set a breakpoint on those calls, nor can you change the behavior
2019 of the functions by linking with a different library.  In addition,
2020 when a function is recognized as a built-in function, GCC may use
2021 information about that function to warn about problems with calls to
2022 that function, or to generate more efficient code, even if the
2023 resulting code still contains calls to that function.  For example,
2024 warnings are given with @option{-Wformat} for bad calls to
2025 @code{printf} when @code{printf} is built in and @code{strlen} is
2026 known not to modify global memory.
2028 With the @option{-fno-builtin-@var{function}} option
2029 only the built-in function @var{function} is
2030 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2031 function is named that is not built-in in this version of GCC, this
2032 option is ignored.  There is no corresponding
2033 @option{-fbuiltin-@var{function}} option; if you wish to enable
2034 built-in functions selectively when using @option{-fno-builtin} or
2035 @option{-ffreestanding}, you may define macros such as:
2037 @smallexample
2038 #define abs(n)          __builtin_abs ((n))
2039 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2040 @end smallexample
2042 @item -fgimple
2043 @opindex fgimple
2045 Enable parsing of function definitions marked with @code{__GIMPLE}.
2046 This is an experimental feature that allows unit testing of GIMPLE
2047 passes.
2049 @item -fhosted
2050 @opindex fhosted
2051 @cindex hosted environment
2053 Assert that compilation targets a hosted environment.  This implies
2054 @option{-fbuiltin}.  A hosted environment is one in which the
2055 entire standard library is available, and in which @code{main} has a return
2056 type of @code{int}.  Examples are nearly everything except a kernel.
2057 This is equivalent to @option{-fno-freestanding}.
2059 @item -ffreestanding
2060 @opindex ffreestanding
2061 @cindex hosted environment
2063 Assert that compilation targets a freestanding environment.  This
2064 implies @option{-fno-builtin}.  A freestanding environment
2065 is one in which the standard library may not exist, and program startup may
2066 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2067 This is equivalent to @option{-fno-hosted}.
2069 @xref{Standards,,Language Standards Supported by GCC}, for details of
2070 freestanding and hosted environments.
2072 @item -fopenacc
2073 @opindex fopenacc
2074 @cindex OpenACC accelerator programming
2075 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2076 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2077 compiler generates accelerated code according to the OpenACC Application
2078 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2079 implies @option{-pthread}, and thus is only supported on targets that
2080 have support for @option{-pthread}.
2082 @item -fopenacc-dim=@var{geom}
2083 @opindex fopenacc-dim
2084 @cindex OpenACC accelerator programming
2085 Specify default compute dimensions for parallel offload regions that do
2086 not explicitly specify.  The @var{geom} value is a triple of
2087 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2088 can be omitted, to use a target-specific default value.
2090 @item -fopenmp
2091 @opindex fopenmp
2092 @cindex OpenMP parallel
2093 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2094 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2095 compiler generates parallel code according to the OpenMP Application
2096 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2097 implies @option{-pthread}, and thus is only supported on targets that
2098 have support for @option{-pthread}. @option{-fopenmp} implies
2099 @option{-fopenmp-simd}.
2101 @item -fopenmp-simd
2102 @opindex fopenmp-simd
2103 @cindex OpenMP SIMD
2104 @cindex SIMD
2105 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2106 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2107 are ignored.
2109 @item -fgnu-tm
2110 @opindex fgnu-tm
2111 When the option @option{-fgnu-tm} is specified, the compiler
2112 generates code for the Linux variant of Intel's current Transactional
2113 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2114 an experimental feature whose interface may change in future versions
2115 of GCC, as the official specification changes.  Please note that not
2116 all architectures are supported for this feature.
2118 For more information on GCC's support for transactional memory,
2119 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2120 Transactional Memory Library}.
2122 Note that the transactional memory feature is not supported with
2123 non-call exceptions (@option{-fnon-call-exceptions}).
2125 @item -fms-extensions
2126 @opindex fms-extensions
2127 Accept some non-standard constructs used in Microsoft header files.
2129 In C++ code, this allows member names in structures to be similar
2130 to previous types declarations.
2132 @smallexample
2133 typedef int UOW;
2134 struct ABC @{
2135   UOW UOW;
2137 @end smallexample
2139 Some cases of unnamed fields in structures and unions are only
2140 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2141 fields within structs/unions}, for details.
2143 Note that this option is off for all targets but x86 
2144 targets using ms-abi.
2146 @item -fplan9-extensions
2147 @opindex fplan9-extensions
2148 Accept some non-standard constructs used in Plan 9 code.
2150 This enables @option{-fms-extensions}, permits passing pointers to
2151 structures with anonymous fields to functions that expect pointers to
2152 elements of the type of the field, and permits referring to anonymous
2153 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2154 struct/union fields within structs/unions}, for details.  This is only
2155 supported for C, not C++.
2157 @item -fcond-mismatch
2158 @opindex fcond-mismatch
2159 Allow conditional expressions with mismatched types in the second and
2160 third arguments.  The value of such an expression is void.  This option
2161 is not supported for C++.
2163 @item -flax-vector-conversions
2164 @opindex flax-vector-conversions
2165 Allow implicit conversions between vectors with differing numbers of
2166 elements and/or incompatible element types.  This option should not be
2167 used for new code.
2169 @item -funsigned-char
2170 @opindex funsigned-char
2171 Let the type @code{char} be unsigned, like @code{unsigned char}.
2173 Each kind of machine has a default for what @code{char} should
2174 be.  It is either like @code{unsigned char} by default or like
2175 @code{signed char} by default.
2177 Ideally, a portable program should always use @code{signed char} or
2178 @code{unsigned char} when it depends on the signedness of an object.
2179 But many programs have been written to use plain @code{char} and
2180 expect it to be signed, or expect it to be unsigned, depending on the
2181 machines they were written for.  This option, and its inverse, let you
2182 make such a program work with the opposite default.
2184 The type @code{char} is always a distinct type from each of
2185 @code{signed char} or @code{unsigned char}, even though its behavior
2186 is always just like one of those two.
2188 @item -fsigned-char
2189 @opindex fsigned-char
2190 Let the type @code{char} be signed, like @code{signed char}.
2192 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2193 the negative form of @option{-funsigned-char}.  Likewise, the option
2194 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2196 @item -fsigned-bitfields
2197 @itemx -funsigned-bitfields
2198 @itemx -fno-signed-bitfields
2199 @itemx -fno-unsigned-bitfields
2200 @opindex fsigned-bitfields
2201 @opindex funsigned-bitfields
2202 @opindex fno-signed-bitfields
2203 @opindex fno-unsigned-bitfields
2204 These options control whether a bit-field is signed or unsigned, when the
2205 declaration does not use either @code{signed} or @code{unsigned}.  By
2206 default, such a bit-field is signed, because this is consistent: the
2207 basic integer types such as @code{int} are signed types.
2209 @item -fsso-struct=@var{endianness}
2210 @opindex fsso-struct
2211 Set the default scalar storage order of structures and unions to the
2212 specified endianness.  The accepted values are @samp{big-endian},
2213 @samp{little-endian} and @samp{native} for the native endianness of
2214 the target (the default).  This option is not supported for C++.
2216 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2217 code that is not binary compatible with code generated without it if the
2218 specified endianness is not the native endianness of the target.
2219 @end table
2221 @node C++ Dialect Options
2222 @section Options Controlling C++ Dialect
2224 @cindex compiler options, C++
2225 @cindex C++ options, command-line
2226 @cindex options, C++
2227 This section describes the command-line options that are only meaningful
2228 for C++ programs.  You can also use most of the GNU compiler options
2229 regardless of what language your program is in.  For example, you
2230 might compile a file @file{firstClass.C} like this:
2232 @smallexample
2233 g++ -g -fstrict-enums -O -c firstClass.C
2234 @end smallexample
2236 @noindent
2237 In this example, only @option{-fstrict-enums} is an option meant
2238 only for C++ programs; you can use the other options with any
2239 language supported by GCC@.
2241 Some options for compiling C programs, such as @option{-std}, are also
2242 relevant for C++ programs.
2243 @xref{C Dialect Options,,Options Controlling C Dialect}.
2245 Here is a list of options that are @emph{only} for compiling C++ programs:
2247 @table @gcctabopt
2249 @item -fabi-version=@var{n}
2250 @opindex fabi-version
2251 Use version @var{n} of the C++ ABI@.  The default is version 0.
2253 Version 0 refers to the version conforming most closely to
2254 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2255 will change in different versions of G++ as ABI bugs are fixed.
2257 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2259 Version 2 is the version of the C++ ABI that first appeared in G++
2260 3.4, and was the default through G++ 4.9.
2262 Version 3 corrects an error in mangling a constant address as a
2263 template argument.
2265 Version 4, which first appeared in G++ 4.5, implements a standard
2266 mangling for vector types.
2268 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2269 attribute const/volatile on function pointer types, decltype of a
2270 plain decl, and use of a function parameter in the declaration of
2271 another parameter.
2273 Version 6, which first appeared in G++ 4.7, corrects the promotion
2274 behavior of C++11 scoped enums and the mangling of template argument
2275 packs, const/static_cast, prefix ++ and --, and a class scope function
2276 used as a template argument.
2278 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2279 builtin type and corrects the mangling of lambdas in default argument
2280 scope.
2282 Version 8, which first appeared in G++ 4.9, corrects the substitution
2283 behavior of function types with function-cv-qualifiers.
2285 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2286 @code{nullptr_t}.
2288 Version 10, which first appeared in G++ 6.1, adds mangling of
2289 attributes that affect type identity, such as ia32 calling convention
2290 attributes (e.g. @samp{stdcall}).
2292 Version 11, which first appeared in G++ 7, corrects the mangling of
2293 sizeof... expressions and operator names.  For multiple entities with
2294 the same name within a function, that are declared in different scopes,
2295 the mangling now changes starting with the twelfth occurrence.  It also
2296 implies @option{-fnew-inheriting-ctors}.
2298 See also @option{-Wabi}.
2300 @item -fabi-compat-version=@var{n}
2301 @opindex fabi-compat-version
2302 On targets that support strong aliases, G++
2303 works around mangling changes by creating an alias with the correct
2304 mangled name when defining a symbol with an incorrect mangled name.
2305 This switch specifies which ABI version to use for the alias.
2307 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2308 compatibility).  If another ABI version is explicitly selected, this
2309 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2310 use @option{-fabi-compat-version=2}.
2312 If this option is not provided but @option{-Wabi=@var{n}} is, that
2313 version is used for compatibility aliases.  If this option is provided
2314 along with @option{-Wabi} (without the version), the version from this
2315 option is used for the warning.
2317 @item -fno-access-control
2318 @opindex fno-access-control
2319 Turn off all access checking.  This switch is mainly useful for working
2320 around bugs in the access control code.
2322 @item -faligned-new
2323 @opindex faligned-new
2324 Enable support for C++17 @code{new} of types that require more
2325 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2326 numeric argument such as @code{-faligned-new=32} can be used to
2327 specify how much alignment (in bytes) is provided by that function,
2328 but few users will need to override the default of
2329 @code{alignof(std::max_align_t)}.
2331 This flag is enabled by default for @option{-std=c++17}.
2333 @item -fcheck-new
2334 @opindex fcheck-new
2335 Check that the pointer returned by @code{operator new} is non-null
2336 before attempting to modify the storage allocated.  This check is
2337 normally unnecessary because the C++ standard specifies that
2338 @code{operator new} only returns @code{0} if it is declared
2339 @code{throw()}, in which case the compiler always checks the
2340 return value even without this option.  In all other cases, when
2341 @code{operator new} has a non-empty exception specification, memory
2342 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2343 @samp{new (nothrow)}.
2345 @item -fconcepts
2346 @opindex fconcepts
2347 Enable support for the C++ Extensions for Concepts Technical
2348 Specification, ISO 19217 (2015), which allows code like
2350 @smallexample
2351 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2352 template <Addable T> T add (T a, T b) @{ return a + b; @}
2353 @end smallexample
2355 @item -fconstexpr-depth=@var{n}
2356 @opindex fconstexpr-depth
2357 Set the maximum nested evaluation depth for C++11 constexpr functions
2358 to @var{n}.  A limit is needed to detect endless recursion during
2359 constant expression evaluation.  The minimum specified by the standard
2360 is 512.
2362 @item -fconstexpr-loop-limit=@var{n}
2363 @opindex fconstexpr-loop-limit
2364 Set the maximum number of iterations for a loop in C++14 constexpr functions
2365 to @var{n}.  A limit is needed to detect infinite loops during
2366 constant expression evaluation.  The default is 262144 (1<<18).
2368 @item -fdeduce-init-list
2369 @opindex fdeduce-init-list
2370 Enable deduction of a template type parameter as
2371 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2373 @smallexample
2374 template <class T> auto forward(T t) -> decltype (realfn (t))
2376   return realfn (t);
2379 void f()
2381   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2383 @end smallexample
2385 This deduction was implemented as a possible extension to the
2386 originally proposed semantics for the C++11 standard, but was not part
2387 of the final standard, so it is disabled by default.  This option is
2388 deprecated, and may be removed in a future version of G++.
2390 @item -ffriend-injection
2391 @opindex ffriend-injection
2392 Inject friend functions into the enclosing namespace, so that they are
2393 visible outside the scope of the class in which they are declared.
2394 Friend functions were documented to work this way in the old Annotated
2395 C++ Reference Manual.  
2396 However, in ISO C++ a friend function that is not declared
2397 in an enclosing scope can only be found using argument dependent
2398 lookup.  GCC defaults to the standard behavior.
2400 This option is for compatibility, and may be removed in a future
2401 release of G++.
2403 @item -fno-elide-constructors
2404 @opindex fno-elide-constructors
2405 The C++ standard allows an implementation to omit creating a temporary
2406 that is only used to initialize another object of the same type.
2407 Specifying this option disables that optimization, and forces G++ to
2408 call the copy constructor in all cases.  This option also causes G++
2409 to call trivial member functions which otherwise would be expanded inline.
2411 In C++17, the compiler is required to omit these temporaries, but this
2412 option still affects trivial member functions.
2414 @item -fno-enforce-eh-specs
2415 @opindex fno-enforce-eh-specs
2416 Don't generate code to check for violation of exception specifications
2417 at run time.  This option violates the C++ standard, but may be useful
2418 for reducing code size in production builds, much like defining
2419 @code{NDEBUG}.  This does not give user code permission to throw
2420 exceptions in violation of the exception specifications; the compiler
2421 still optimizes based on the specifications, so throwing an
2422 unexpected exception results in undefined behavior at run time.
2424 @item -fextern-tls-init
2425 @itemx -fno-extern-tls-init
2426 @opindex fextern-tls-init
2427 @opindex fno-extern-tls-init
2428 The C++11 and OpenMP standards allow @code{thread_local} and
2429 @code{threadprivate} variables to have dynamic (runtime)
2430 initialization.  To support this, any use of such a variable goes
2431 through a wrapper function that performs any necessary initialization.
2432 When the use and definition of the variable are in the same
2433 translation unit, this overhead can be optimized away, but when the
2434 use is in a different translation unit there is significant overhead
2435 even if the variable doesn't actually need dynamic initialization.  If
2436 the programmer can be sure that no use of the variable in a
2437 non-defining TU needs to trigger dynamic initialization (either
2438 because the variable is statically initialized, or a use of the
2439 variable in the defining TU will be executed before any uses in
2440 another TU), they can avoid this overhead with the
2441 @option{-fno-extern-tls-init} option.
2443 On targets that support symbol aliases, the default is
2444 @option{-fextern-tls-init}.  On targets that do not support symbol
2445 aliases, the default is @option{-fno-extern-tls-init}.
2447 @item -ffor-scope
2448 @itemx -fno-for-scope
2449 @opindex ffor-scope
2450 @opindex fno-for-scope
2451 If @option{-ffor-scope} is specified, the scope of variables declared in
2452 a @i{for-init-statement} is limited to the @code{for} loop itself,
2453 as specified by the C++ standard.
2454 If @option{-fno-for-scope} is specified, the scope of variables declared in
2455 a @i{for-init-statement} extends to the end of the enclosing scope,
2456 as was the case in old versions of G++, and other (traditional)
2457 implementations of C++.
2459 If neither flag is given, the default is to follow the standard,
2460 but to allow and give a warning for old-style code that would
2461 otherwise be invalid, or have different behavior.
2463 @item -fno-gnu-keywords
2464 @opindex fno-gnu-keywords
2465 Do not recognize @code{typeof} as a keyword, so that code can use this
2466 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2467 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2468 @option{-std=c++98}, @option{-std=c++11}, etc.
2470 @item -fno-implicit-templates
2471 @opindex fno-implicit-templates
2472 Never emit code for non-inline templates that are instantiated
2473 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2474 @xref{Template Instantiation}, for more information.
2476 @item -fno-implicit-inline-templates
2477 @opindex fno-implicit-inline-templates
2478 Don't emit code for implicit instantiations of inline templates, either.
2479 The default is to handle inlines differently so that compiles with and
2480 without optimization need the same set of explicit instantiations.
2482 @item -fno-implement-inlines
2483 @opindex fno-implement-inlines
2484 To save space, do not emit out-of-line copies of inline functions
2485 controlled by @code{#pragma implementation}.  This causes linker
2486 errors if these functions are not inlined everywhere they are called.
2488 @item -fms-extensions
2489 @opindex fms-extensions
2490 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2491 int and getting a pointer to member function via non-standard syntax.
2493 @item -fnew-inheriting-ctors
2494 @opindex fnew-inheriting-ctors
2495 Enable the P0136 adjustment to the semantics of C++11 constructor
2496 inheritance.  This is part of C++17 but also considered to be a Defect
2497 Report against C++11 and C++14.  This flag is enabled by default
2498 unless @option{-fabi-version=10} or lower is specified.
2500 @item -fnew-ttp-matching
2501 @opindex fnew-ttp-matching
2502 Enable the P0522 resolution to Core issue 150, template template
2503 parameters and default arguments: this allows a template with default
2504 template arguments as an argument for a template template parameter
2505 with fewer template parameters.  This flag is enabled by default for
2506 @option{-std=c++17}.
2508 @item -fno-nonansi-builtins
2509 @opindex fno-nonansi-builtins
2510 Disable built-in declarations of functions that are not mandated by
2511 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2512 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2514 @item -fnothrow-opt
2515 @opindex fnothrow-opt
2516 Treat a @code{throw()} exception specification as if it were a
2517 @code{noexcept} specification to reduce or eliminate the text size
2518 overhead relative to a function with no exception specification.  If
2519 the function has local variables of types with non-trivial
2520 destructors, the exception specification actually makes the
2521 function smaller because the EH cleanups for those variables can be
2522 optimized away.  The semantic effect is that an exception thrown out of
2523 a function with such an exception specification results in a call
2524 to @code{terminate} rather than @code{unexpected}.
2526 @item -fno-operator-names
2527 @opindex fno-operator-names
2528 Do not treat the operator name keywords @code{and}, @code{bitand},
2529 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2530 synonyms as keywords.
2532 @item -fno-optional-diags
2533 @opindex fno-optional-diags
2534 Disable diagnostics that the standard says a compiler does not need to
2535 issue.  Currently, the only such diagnostic issued by G++ is the one for
2536 a name having multiple meanings within a class.
2538 @item -fpermissive
2539 @opindex fpermissive
2540 Downgrade some diagnostics about nonconformant code from errors to
2541 warnings.  Thus, using @option{-fpermissive} allows some
2542 nonconforming code to compile.
2544 @item -fno-pretty-templates
2545 @opindex fno-pretty-templates
2546 When an error message refers to a specialization of a function
2547 template, the compiler normally prints the signature of the
2548 template followed by the template arguments and any typedefs or
2549 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2550 rather than @code{void f(int)}) so that it's clear which template is
2551 involved.  When an error message refers to a specialization of a class
2552 template, the compiler omits any template arguments that match
2553 the default template arguments for that template.  If either of these
2554 behaviors make it harder to understand the error message rather than
2555 easier, you can use @option{-fno-pretty-templates} to disable them.
2557 @item -frepo
2558 @opindex frepo
2559 Enable automatic template instantiation at link time.  This option also
2560 implies @option{-fno-implicit-templates}.  @xref{Template
2561 Instantiation}, for more information.
2563 @item -fno-rtti
2564 @opindex fno-rtti
2565 Disable generation of information about every class with virtual
2566 functions for use by the C++ run-time type identification features
2567 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2568 of the language, you can save some space by using this flag.  Note that
2569 exception handling uses the same information, but G++ generates it as
2570 needed. The @code{dynamic_cast} operator can still be used for casts that
2571 do not require run-time type information, i.e.@: casts to @code{void *} or to
2572 unambiguous base classes.
2574 @item -fsized-deallocation
2575 @opindex fsized-deallocation
2576 Enable the built-in global declarations
2577 @smallexample
2578 void operator delete (void *, std::size_t) noexcept;
2579 void operator delete[] (void *, std::size_t) noexcept;
2580 @end smallexample
2581 as introduced in C++14.  This is useful for user-defined replacement
2582 deallocation functions that, for example, use the size of the object
2583 to make deallocation faster.  Enabled by default under
2584 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2585 warns about places that might want to add a definition.
2587 @item -fstrict-enums
2588 @opindex fstrict-enums
2589 Allow the compiler to optimize using the assumption that a value of
2590 enumerated type can only be one of the values of the enumeration (as
2591 defined in the C++ standard; basically, a value that can be
2592 represented in the minimum number of bits needed to represent all the
2593 enumerators).  This assumption may not be valid if the program uses a
2594 cast to convert an arbitrary integer value to the enumerated type.
2596 @item -fstrong-eval-order
2597 @opindex fstrong-eval-order
2598 Evaluate member access, array subscripting, and shift expressions in
2599 left-to-right order, and evaluate assignment in right-to-left order,
2600 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2601 @option{-fstrong-eval-order=some} enables just the ordering of member
2602 access and shift expressions, and is the default without
2603 @option{-std=c++17}.
2605 @item -ftemplate-backtrace-limit=@var{n}
2606 @opindex ftemplate-backtrace-limit
2607 Set the maximum number of template instantiation notes for a single
2608 warning or error to @var{n}.  The default value is 10.
2610 @item -ftemplate-depth=@var{n}
2611 @opindex ftemplate-depth
2612 Set the maximum instantiation depth for template classes to @var{n}.
2613 A limit on the template instantiation depth is needed to detect
2614 endless recursions during template class instantiation.  ANSI/ISO C++
2615 conforming programs must not rely on a maximum depth greater than 17
2616 (changed to 1024 in C++11).  The default value is 900, as the compiler
2617 can run out of stack space before hitting 1024 in some situations.
2619 @item -fno-threadsafe-statics
2620 @opindex fno-threadsafe-statics
2621 Do not emit the extra code to use the routines specified in the C++
2622 ABI for thread-safe initialization of local statics.  You can use this
2623 option to reduce code size slightly in code that doesn't need to be
2624 thread-safe.
2626 @item -fuse-cxa-atexit
2627 @opindex fuse-cxa-atexit
2628 Register destructors for objects with static storage duration with the
2629 @code{__cxa_atexit} function rather than the @code{atexit} function.
2630 This option is required for fully standards-compliant handling of static
2631 destructors, but only works if your C library supports
2632 @code{__cxa_atexit}.
2634 @item -fno-use-cxa-get-exception-ptr
2635 @opindex fno-use-cxa-get-exception-ptr
2636 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2637 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2638 if the runtime routine is not available.
2640 @item -fvisibility-inlines-hidden
2641 @opindex fvisibility-inlines-hidden
2642 This switch declares that the user does not attempt to compare
2643 pointers to inline functions or methods where the addresses of the two functions
2644 are taken in different shared objects.
2646 The effect of this is that GCC may, effectively, mark inline methods with
2647 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2648 appear in the export table of a DSO and do not require a PLT indirection
2649 when used within the DSO@.  Enabling this option can have a dramatic effect
2650 on load and link times of a DSO as it massively reduces the size of the
2651 dynamic export table when the library makes heavy use of templates.
2653 The behavior of this switch is not quite the same as marking the
2654 methods as hidden directly, because it does not affect static variables
2655 local to the function or cause the compiler to deduce that
2656 the function is defined in only one shared object.
2658 You may mark a method as having a visibility explicitly to negate the
2659 effect of the switch for that method.  For example, if you do want to
2660 compare pointers to a particular inline method, you might mark it as
2661 having default visibility.  Marking the enclosing class with explicit
2662 visibility has no effect.
2664 Explicitly instantiated inline methods are unaffected by this option
2665 as their linkage might otherwise cross a shared library boundary.
2666 @xref{Template Instantiation}.
2668 @item -fvisibility-ms-compat
2669 @opindex fvisibility-ms-compat
2670 This flag attempts to use visibility settings to make GCC's C++
2671 linkage model compatible with that of Microsoft Visual Studio.
2673 The flag makes these changes to GCC's linkage model:
2675 @enumerate
2676 @item
2677 It sets the default visibility to @code{hidden}, like
2678 @option{-fvisibility=hidden}.
2680 @item
2681 Types, but not their members, are not hidden by default.
2683 @item
2684 The One Definition Rule is relaxed for types without explicit
2685 visibility specifications that are defined in more than one
2686 shared object: those declarations are permitted if they are
2687 permitted when this option is not used.
2688 @end enumerate
2690 In new code it is better to use @option{-fvisibility=hidden} and
2691 export those classes that are intended to be externally visible.
2692 Unfortunately it is possible for code to rely, perhaps accidentally,
2693 on the Visual Studio behavior.
2695 Among the consequences of these changes are that static data members
2696 of the same type with the same name but defined in different shared
2697 objects are different, so changing one does not change the other;
2698 and that pointers to function members defined in different shared
2699 objects may not compare equal.  When this flag is given, it is a
2700 violation of the ODR to define types with the same name differently.
2702 @item -fno-weak
2703 @opindex fno-weak
2704 Do not use weak symbol support, even if it is provided by the linker.
2705 By default, G++ uses weak symbols if they are available.  This
2706 option exists only for testing, and should not be used by end-users;
2707 it results in inferior code and has no benefits.  This option may
2708 be removed in a future release of G++.
2710 @item -nostdinc++
2711 @opindex nostdinc++
2712 Do not search for header files in the standard directories specific to
2713 C++, but do still search the other standard directories.  (This option
2714 is used when building the C++ library.)
2715 @end table
2717 In addition, these optimization, warning, and code generation options
2718 have meanings only for C++ programs:
2720 @table @gcctabopt
2721 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2722 @opindex Wabi
2723 @opindex Wno-abi
2724 Warn when G++ it generates code that is probably not compatible with
2725 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2726 ABI with each major release, normally @option{-Wabi} will warn only if
2727 there is a check added later in a release series for an ABI issue
2728 discovered since the initial release.  @option{-Wabi} will warn about
2729 more things if an older ABI version is selected (with
2730 @option{-fabi-version=@var{n}}).
2732 @option{-Wabi} can also be used with an explicit version number to
2733 warn about compatibility with a particular @option{-fabi-version}
2734 level, e.g. @option{-Wabi=2} to warn about changes relative to
2735 @option{-fabi-version=2}.
2737 If an explicit version number is provided and
2738 @option{-fabi-compat-version} is not specified, the version number
2739 from this option is used for compatibility aliases.  If no explicit
2740 version number is provided with this option, but
2741 @option{-fabi-compat-version} is specified, that version number is
2742 used for ABI warnings.
2744 Although an effort has been made to warn about
2745 all such cases, there are probably some cases that are not warned about,
2746 even though G++ is generating incompatible code.  There may also be
2747 cases where warnings are emitted even though the code that is generated
2748 is compatible.
2750 You should rewrite your code to avoid these warnings if you are
2751 concerned about the fact that code generated by G++ may not be binary
2752 compatible with code generated by other compilers.
2754 Known incompatibilities in @option{-fabi-version=2} (which was the
2755 default from GCC 3.4 to 4.9) include:
2757 @itemize @bullet
2759 @item
2760 A template with a non-type template parameter of reference type was
2761 mangled incorrectly:
2762 @smallexample
2763 extern int N;
2764 template <int &> struct S @{@};
2765 void n (S<N>) @{2@}
2766 @end smallexample
2768 This was fixed in @option{-fabi-version=3}.
2770 @item
2771 SIMD vector types declared using @code{__attribute ((vector_size))} were
2772 mangled in a non-standard way that does not allow for overloading of
2773 functions taking vectors of different sizes.
2775 The mangling was changed in @option{-fabi-version=4}.
2777 @item
2778 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2779 qualifiers, and @code{decltype} of a plain declaration was folded away.
2781 These mangling issues were fixed in @option{-fabi-version=5}.
2783 @item
2784 Scoped enumerators passed as arguments to a variadic function are
2785 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2786 On most targets this does not actually affect the parameter passing
2787 ABI, as there is no way to pass an argument smaller than @code{int}.
2789 Also, the ABI changed the mangling of template argument packs,
2790 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2791 a class scope function used as a template argument.
2793 These issues were corrected in @option{-fabi-version=6}.
2795 @item
2796 Lambdas in default argument scope were mangled incorrectly, and the
2797 ABI changed the mangling of @code{nullptr_t}.
2799 These issues were corrected in @option{-fabi-version=7}.
2801 @item
2802 When mangling a function type with function-cv-qualifiers, the
2803 un-qualified function type was incorrectly treated as a substitution
2804 candidate.
2806 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2808 @item
2809 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2810 unaligned accesses.  Note that this did not affect the ABI of a
2811 function with a @code{nullptr_t} parameter, as parameters have a
2812 minimum alignment.
2814 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2816 @item
2817 Target-specific attributes that affect the identity of a type, such as
2818 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2819 did not affect the mangled name, leading to name collisions when
2820 function pointers were used as template arguments.
2822 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2824 @end itemize
2826 It also warns about psABI-related changes.  The known psABI changes at this
2827 point include:
2829 @itemize @bullet
2831 @item
2832 For SysV/x86-64, unions with @code{long double} members are 
2833 passed in memory as specified in psABI.  For example:
2835 @smallexample
2836 union U @{
2837   long double ld;
2838   int i;
2840 @end smallexample
2842 @noindent
2843 @code{union U} is always passed in memory.
2845 @end itemize
2847 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2848 @opindex Wabi-tag
2849 @opindex -Wabi-tag
2850 Warn when a type with an ABI tag is used in a context that does not
2851 have that ABI tag.  See @ref{C++ Attributes} for more information
2852 about ABI tags.
2854 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2855 @opindex Wctor-dtor-privacy
2856 @opindex Wno-ctor-dtor-privacy
2857 Warn when a class seems unusable because all the constructors or
2858 destructors in that class are private, and it has neither friends nor
2859 public static member functions.  Also warn if there are no non-private
2860 methods, and there's at least one private member function that isn't
2861 a constructor or destructor.
2863 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2864 @opindex Wdelete-non-virtual-dtor
2865 @opindex Wno-delete-non-virtual-dtor
2866 Warn when @code{delete} is used to destroy an instance of a class that
2867 has virtual functions and non-virtual destructor. It is unsafe to delete
2868 an instance of a derived class through a pointer to a base class if the
2869 base class does not have a virtual destructor.  This warning is enabled
2870 by @option{-Wall}.
2872 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2873 @opindex Wliteral-suffix
2874 @opindex Wno-literal-suffix
2875 Warn when a string or character literal is followed by a ud-suffix which does
2876 not begin with an underscore.  As a conforming extension, GCC treats such
2877 suffixes as separate preprocessing tokens in order to maintain backwards
2878 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2879 For example:
2881 @smallexample
2882 #define __STDC_FORMAT_MACROS
2883 #include <inttypes.h>
2884 #include <stdio.h>
2886 int main() @{
2887   int64_t i64 = 123;
2888   printf("My int64: %" PRId64"\n", i64);
2890 @end smallexample
2892 In this case, @code{PRId64} is treated as a separate preprocessing token.
2894 Additionally, warn when a user-defined literal operator is declared with
2895 a literal suffix identifier that doesn't begin with an underscore. Literal
2896 suffix identifiers that don't begin with an underscore are reserved for
2897 future standardization.
2899 This warning is enabled by default.
2901 @item -Wlto-type-mismatch
2902 @opindex Wlto-type-mismatch
2903 @opindex Wno-lto-type-mismatch
2905 During the link-time optimization warn about type mismatches in
2906 global declarations from different compilation units.
2907 Requires @option{-flto} to be enabled.  Enabled by default.
2909 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2910 @opindex Wnarrowing
2911 @opindex Wno-narrowing
2912 For C++11 and later standards, narrowing conversions are diagnosed by default,
2913 as required by the standard.  A narrowing conversion from a constant produces
2914 an error, and a narrowing conversion from a non-constant produces a warning,
2915 but @option{-Wno-narrowing} suppresses the diagnostic.
2916 Note that this does not affect the meaning of well-formed code;
2917 narrowing conversions are still considered ill-formed in SFINAE contexts.
2919 With @option{-Wnarrowing} in C++98, warn when a narrowing
2920 conversion prohibited by C++11 occurs within
2921 @samp{@{ @}}, e.g.
2923 @smallexample
2924 int i = @{ 2.2 @}; // error: narrowing from double to int
2925 @end smallexample
2927 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2929 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2930 @opindex Wnoexcept
2931 @opindex Wno-noexcept
2932 Warn when a noexcept-expression evaluates to false because of a call
2933 to a function that does not have a non-throwing exception
2934 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2935 the compiler to never throw an exception.
2937 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2938 @opindex Wnoexcept-type
2939 @opindex Wno-noexcept-type
2940 Warn if the C++17 feature making @code{noexcept} part of a function
2941 type changes the mangled name of a symbol relative to C++14.  Enabled
2942 by @option{-Wabi} and @option{-Wc++17-compat}.
2944 As an example:
2946 @smallexample
2947 template <class T> void f(T t) @{ t(); @};
2948 void g() noexcept;
2949 void h() @{ f(g); @} 
2950 @end smallexample
2952 @noindent
2953 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2954 C++17 it calls @code{f<void(*)()noexcept>}.
2956 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2957 @opindex Wclass-memaccess
2958 Warn when the destination of a call to a raw memory function such as
2959 @code{memset} or @code{memcpy} is an object of class type, and when writing
2960 into such an object might bypass the class non-trivial or deleted constructor
2961 or copy assignment, violate const-correctness or encapsulation, or corrupt
2962 the virtual table.  Modifying the representation of such objects may violate
2963 invariants maintained by member functions of the class.  For example, the call
2964 to @code{memset} below is undefined because it modifies a non-trivial class
2965 object and is, therefore, diagnosed.  The safe way to either initialize or
2966 clear the storage of objects of such types is by using the appropriate
2967 constructor or assignment operator, if one is available.
2968 @smallexample
2969 std::string str = "abc";
2970 memset (&str, 0, sizeof str);
2971 @end smallexample
2972 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2973 Explicitly casting the pointer to the class object to @code{void *} or
2974 to a type that can be safely accessed by the raw memory function suppresses
2975 the warning.
2977 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2978 @opindex Wnon-virtual-dtor
2979 @opindex Wno-non-virtual-dtor
2980 Warn when a class has virtual functions and an accessible non-virtual
2981 destructor itself or in an accessible polymorphic base class, in which
2982 case it is possible but unsafe to delete an instance of a derived
2983 class through a pointer to the class itself or base class.  This
2984 warning is automatically enabled if @option{-Weffc++} is specified.
2986 @item -Wregister @r{(C++ and Objective-C++ only)}
2987 @opindex Wregister
2988 @opindex Wno-register
2989 Warn on uses of the @code{register} storage class specifier, except
2990 when it is part of the GNU @ref{Explicit Register Variables} extension.
2991 The use of the @code{register} keyword as storage class specifier has
2992 been deprecated in C++11 and removed in C++17.
2993 Enabled by default with @option{-std=c++17}.
2995 @item -Wreorder @r{(C++ and Objective-C++ only)}
2996 @opindex Wreorder
2997 @opindex Wno-reorder
2998 @cindex reordering, warning
2999 @cindex warning for reordering of member initializers
3000 Warn when the order of member initializers given in the code does not
3001 match the order in which they must be executed.  For instance:
3003 @smallexample
3004 struct A @{
3005   int i;
3006   int j;
3007   A(): j (0), i (1) @{ @}
3009 @end smallexample
3011 @noindent
3012 The compiler rearranges the member initializers for @code{i}
3013 and @code{j} to match the declaration order of the members, emitting
3014 a warning to that effect.  This warning is enabled by @option{-Wall}.
3016 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3017 @opindex fext-numeric-literals
3018 @opindex fno-ext-numeric-literals
3019 Accept imaginary, fixed-point, or machine-defined
3020 literal number suffixes as GNU extensions.
3021 When this option is turned off these suffixes are treated
3022 as C++11 user-defined literal numeric suffixes.
3023 This is on by default for all pre-C++11 dialects and all GNU dialects:
3024 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3025 @option{-std=gnu++14}.
3026 This option is off by default
3027 for ISO C++11 onwards (@option{-std=c++11}, ...).
3028 @end table
3030 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3032 @table @gcctabopt
3033 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3034 @opindex Weffc++
3035 @opindex Wno-effc++
3036 Warn about violations of the following style guidelines from Scott Meyers'
3037 @cite{Effective C++} series of books:
3039 @itemize @bullet
3040 @item
3041 Define a copy constructor and an assignment operator for classes
3042 with dynamically-allocated memory.
3044 @item
3045 Prefer initialization to assignment in constructors.
3047 @item
3048 Have @code{operator=} return a reference to @code{*this}.
3050 @item
3051 Don't try to return a reference when you must return an object.
3053 @item
3054 Distinguish between prefix and postfix forms of increment and
3055 decrement operators.
3057 @item
3058 Never overload @code{&&}, @code{||}, or @code{,}.
3060 @end itemize
3062 This option also enables @option{-Wnon-virtual-dtor}, which is also
3063 one of the effective C++ recommendations.  However, the check is
3064 extended to warn about the lack of virtual destructor in accessible
3065 non-polymorphic bases classes too.
3067 When selecting this option, be aware that the standard library
3068 headers do not obey all of these guidelines; use @samp{grep -v}
3069 to filter out those warnings.
3071 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3072 @opindex Wstrict-null-sentinel
3073 @opindex Wno-strict-null-sentinel
3074 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3075 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3076 to @code{__null}.  Although it is a null pointer constant rather than a
3077 null pointer, it is guaranteed to be of the same size as a pointer.
3078 But this use is not portable across different compilers.
3080 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3081 @opindex Wno-non-template-friend
3082 @opindex Wnon-template-friend
3083 Disable warnings when non-template friend functions are declared
3084 within a template.  In very old versions of GCC that predate implementation
3085 of the ISO standard, declarations such as 
3086 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3087 could be interpreted as a particular specialization of a template
3088 function; the warning exists to diagnose compatibility problems, 
3089 and is enabled by default.
3091 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3092 @opindex Wold-style-cast
3093 @opindex Wno-old-style-cast
3094 Warn if an old-style (C-style) cast to a non-void type is used within
3095 a C++ program.  The new-style casts (@code{dynamic_cast},
3096 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3097 less vulnerable to unintended effects and much easier to search for.
3099 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3100 @opindex Woverloaded-virtual
3101 @opindex Wno-overloaded-virtual
3102 @cindex overloaded virtual function, warning
3103 @cindex warning for overloaded virtual function
3104 Warn when a function declaration hides virtual functions from a
3105 base class.  For example, in:
3107 @smallexample
3108 struct A @{
3109   virtual void f();
3112 struct B: public A @{
3113   void f(int);
3115 @end smallexample
3117 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3118 like:
3120 @smallexample
3121 B* b;
3122 b->f();
3123 @end smallexample
3125 @noindent
3126 fails to compile.
3128 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3129 @opindex Wno-pmf-conversions
3130 @opindex Wpmf-conversions
3131 Disable the diagnostic for converting a bound pointer to member function
3132 to a plain pointer.
3134 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3135 @opindex Wsign-promo
3136 @opindex Wno-sign-promo
3137 Warn when overload resolution chooses a promotion from unsigned or
3138 enumerated type to a signed type, over a conversion to an unsigned type of
3139 the same size.  Previous versions of G++ tried to preserve
3140 unsignedness, but the standard mandates the current behavior.
3142 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3143 @opindex Wtemplates
3144 Warn when a primary template declaration is encountered.  Some coding
3145 rules disallow templates, and this may be used to enforce that rule.
3146 The warning is inactive inside a system header file, such as the STL, so
3147 one can still use the STL.  One may also instantiate or specialize
3148 templates.
3150 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3151 @opindex Wmultiple-inheritance
3152 Warn when a class is defined with multiple direct base classes.  Some
3153 coding rules disallow multiple inheritance, and this may be used to
3154 enforce that rule.  The warning is inactive inside a system header file,
3155 such as the STL, so one can still use the STL.  One may also define
3156 classes that indirectly use multiple inheritance.
3158 @item -Wvirtual-inheritance
3159 @opindex Wvirtual-inheritance
3160 Warn when a class is defined with a virtual direct base class.  Some
3161 coding rules disallow multiple inheritance, and this may be used to
3162 enforce that rule.  The warning is inactive inside a system header file,
3163 such as the STL, so one can still use the STL.  One may also define
3164 classes that indirectly use virtual inheritance.
3166 @item -Wnamespaces
3167 @opindex Wnamespaces
3168 Warn when a namespace definition is opened.  Some coding rules disallow
3169 namespaces, and this may be used to enforce that rule.  The warning is
3170 inactive inside a system header file, such as the STL, so one can still
3171 use the STL.  One may also use using directives and qualified names.
3173 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3174 @opindex Wterminate
3175 @opindex Wno-terminate
3176 Disable the warning about a throw-expression that will immediately
3177 result in a call to @code{terminate}.
3178 @end table
3180 @node Objective-C and Objective-C++ Dialect Options
3181 @section Options Controlling Objective-C and Objective-C++ Dialects
3183 @cindex compiler options, Objective-C and Objective-C++
3184 @cindex Objective-C and Objective-C++ options, command-line
3185 @cindex options, Objective-C and Objective-C++
3186 (NOTE: This manual does not describe the Objective-C and Objective-C++
3187 languages themselves.  @xref{Standards,,Language Standards
3188 Supported by GCC}, for references.)
3190 This section describes the command-line options that are only meaningful
3191 for Objective-C and Objective-C++ programs.  You can also use most of
3192 the language-independent GNU compiler options.
3193 For example, you might compile a file @file{some_class.m} like this:
3195 @smallexample
3196 gcc -g -fgnu-runtime -O -c some_class.m
3197 @end smallexample
3199 @noindent
3200 In this example, @option{-fgnu-runtime} is an option meant only for
3201 Objective-C and Objective-C++ programs; you can use the other options with
3202 any language supported by GCC@.
3204 Note that since Objective-C is an extension of the C language, Objective-C
3205 compilations may also use options specific to the C front-end (e.g.,
3206 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3207 C++-specific options (e.g., @option{-Wabi}).
3209 Here is a list of options that are @emph{only} for compiling Objective-C
3210 and Objective-C++ programs:
3212 @table @gcctabopt
3213 @item -fconstant-string-class=@var{class-name}
3214 @opindex fconstant-string-class
3215 Use @var{class-name} as the name of the class to instantiate for each
3216 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3217 class name is @code{NXConstantString} if the GNU runtime is being used, and
3218 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3219 @option{-fconstant-cfstrings} option, if also present, overrides the
3220 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3221 to be laid out as constant CoreFoundation strings.
3223 @item -fgnu-runtime
3224 @opindex fgnu-runtime
3225 Generate object code compatible with the standard GNU Objective-C
3226 runtime.  This is the default for most types of systems.
3228 @item -fnext-runtime
3229 @opindex fnext-runtime
3230 Generate output compatible with the NeXT runtime.  This is the default
3231 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3232 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3233 used.
3235 @item -fno-nil-receivers
3236 @opindex fno-nil-receivers
3237 Assume that all Objective-C message dispatches (@code{[receiver
3238 message:arg]}) in this translation unit ensure that the receiver is
3239 not @code{nil}.  This allows for more efficient entry points in the
3240 runtime to be used.  This option is only available in conjunction with
3241 the NeXT runtime and ABI version 0 or 1.
3243 @item -fobjc-abi-version=@var{n}
3244 @opindex fobjc-abi-version
3245 Use version @var{n} of the Objective-C ABI for the selected runtime.
3246 This option is currently supported only for the NeXT runtime.  In that
3247 case, Version 0 is the traditional (32-bit) ABI without support for
3248 properties and other Objective-C 2.0 additions.  Version 1 is the
3249 traditional (32-bit) ABI with support for properties and other
3250 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3251 nothing is specified, the default is Version 0 on 32-bit target
3252 machines, and Version 2 on 64-bit target machines.
3254 @item -fobjc-call-cxx-cdtors
3255 @opindex fobjc-call-cxx-cdtors
3256 For each Objective-C class, check if any of its instance variables is a
3257 C++ object with a non-trivial default constructor.  If so, synthesize a
3258 special @code{- (id) .cxx_construct} instance method which runs
3259 non-trivial default constructors on any such instance variables, in order,
3260 and then return @code{self}.  Similarly, check if any instance variable
3261 is a C++ object with a non-trivial destructor, and if so, synthesize a
3262 special @code{- (void) .cxx_destruct} method which runs
3263 all such default destructors, in reverse order.
3265 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3266 methods thusly generated only operate on instance variables
3267 declared in the current Objective-C class, and not those inherited
3268 from superclasses.  It is the responsibility of the Objective-C
3269 runtime to invoke all such methods in an object's inheritance
3270 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3271 by the runtime immediately after a new object instance is allocated;
3272 the @code{- (void) .cxx_destruct} methods are invoked immediately
3273 before the runtime deallocates an object instance.
3275 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3276 support for invoking the @code{- (id) .cxx_construct} and
3277 @code{- (void) .cxx_destruct} methods.
3279 @item -fobjc-direct-dispatch
3280 @opindex fobjc-direct-dispatch
3281 Allow fast jumps to the message dispatcher.  On Darwin this is
3282 accomplished via the comm page.
3284 @item -fobjc-exceptions
3285 @opindex fobjc-exceptions
3286 Enable syntactic support for structured exception handling in
3287 Objective-C, similar to what is offered by C++.  This option
3288 is required to use the Objective-C keywords @code{@@try},
3289 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3290 @code{@@synchronized}.  This option is available with both the GNU
3291 runtime and the NeXT runtime (but not available in conjunction with
3292 the NeXT runtime on Mac OS X 10.2 and earlier).
3294 @item -fobjc-gc
3295 @opindex fobjc-gc
3296 Enable garbage collection (GC) in Objective-C and Objective-C++
3297 programs.  This option is only available with the NeXT runtime; the
3298 GNU runtime has a different garbage collection implementation that
3299 does not require special compiler flags.
3301 @item -fobjc-nilcheck
3302 @opindex fobjc-nilcheck
3303 For the NeXT runtime with version 2 of the ABI, check for a nil
3304 receiver in method invocations before doing the actual method call.
3305 This is the default and can be disabled using
3306 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3307 checked for nil in this way no matter what this flag is set to.
3308 Currently this flag does nothing when the GNU runtime, or an older
3309 version of the NeXT runtime ABI, is used.
3311 @item -fobjc-std=objc1
3312 @opindex fobjc-std
3313 Conform to the language syntax of Objective-C 1.0, the language
3314 recognized by GCC 4.0.  This only affects the Objective-C additions to
3315 the C/C++ language; it does not affect conformance to C/C++ standards,
3316 which is controlled by the separate C/C++ dialect option flags.  When
3317 this option is used with the Objective-C or Objective-C++ compiler,
3318 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3319 This is useful if you need to make sure that your Objective-C code can
3320 be compiled with older versions of GCC@.
3322 @item -freplace-objc-classes
3323 @opindex freplace-objc-classes
3324 Emit a special marker instructing @command{ld(1)} not to statically link in
3325 the resulting object file, and allow @command{dyld(1)} to load it in at
3326 run time instead.  This is used in conjunction with the Fix-and-Continue
3327 debugging mode, where the object file in question may be recompiled and
3328 dynamically reloaded in the course of program execution, without the need
3329 to restart the program itself.  Currently, Fix-and-Continue functionality
3330 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3331 and later.
3333 @item -fzero-link
3334 @opindex fzero-link
3335 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3336 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3337 compile time) with static class references that get initialized at load time,
3338 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3339 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3340 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3341 for individual class implementations to be modified during program execution.
3342 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3343 regardless of command-line options.
3345 @item -fno-local-ivars
3346 @opindex fno-local-ivars
3347 @opindex flocal-ivars
3348 By default instance variables in Objective-C can be accessed as if
3349 they were local variables from within the methods of the class they're
3350 declared in.  This can lead to shadowing between instance variables
3351 and other variables declared either locally inside a class method or
3352 globally with the same name.  Specifying the @option{-fno-local-ivars}
3353 flag disables this behavior thus avoiding variable shadowing issues.
3355 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3356 @opindex fivar-visibility
3357 Set the default instance variable visibility to the specified option
3358 so that instance variables declared outside the scope of any access
3359 modifier directives default to the specified visibility.
3361 @item -gen-decls
3362 @opindex gen-decls
3363 Dump interface declarations for all classes seen in the source file to a
3364 file named @file{@var{sourcename}.decl}.
3366 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3367 @opindex Wassign-intercept
3368 @opindex Wno-assign-intercept
3369 Warn whenever an Objective-C assignment is being intercepted by the
3370 garbage collector.
3372 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3373 @opindex Wno-protocol
3374 @opindex Wprotocol
3375 If a class is declared to implement a protocol, a warning is issued for
3376 every method in the protocol that is not implemented by the class.  The
3377 default behavior is to issue a warning for every method not explicitly
3378 implemented in the class, even if a method implementation is inherited
3379 from the superclass.  If you use the @option{-Wno-protocol} option, then
3380 methods inherited from the superclass are considered to be implemented,
3381 and no warning is issued for them.
3383 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3384 @opindex Wselector
3385 @opindex Wno-selector
3386 Warn if multiple methods of different types for the same selector are
3387 found during compilation.  The check is performed on the list of methods
3388 in the final stage of compilation.  Additionally, a check is performed
3389 for each selector appearing in a @code{@@selector(@dots{})}
3390 expression, and a corresponding method for that selector has been found
3391 during compilation.  Because these checks scan the method table only at
3392 the end of compilation, these warnings are not produced if the final
3393 stage of compilation is not reached, for example because an error is
3394 found during compilation, or because the @option{-fsyntax-only} option is
3395 being used.
3397 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3398 @opindex Wstrict-selector-match
3399 @opindex Wno-strict-selector-match
3400 Warn if multiple methods with differing argument and/or return types are
3401 found for a given selector when attempting to send a message using this
3402 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3403 is off (which is the default behavior), the compiler omits such warnings
3404 if any differences found are confined to types that share the same size
3405 and alignment.
3407 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3408 @opindex Wundeclared-selector
3409 @opindex Wno-undeclared-selector
3410 Warn if a @code{@@selector(@dots{})} expression referring to an
3411 undeclared selector is found.  A selector is considered undeclared if no
3412 method with that name has been declared before the
3413 @code{@@selector(@dots{})} expression, either explicitly in an
3414 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3415 an @code{@@implementation} section.  This option always performs its
3416 checks as soon as a @code{@@selector(@dots{})} expression is found,
3417 while @option{-Wselector} only performs its checks in the final stage of
3418 compilation.  This also enforces the coding style convention
3419 that methods and selectors must be declared before being used.
3421 @item -print-objc-runtime-info
3422 @opindex print-objc-runtime-info
3423 Generate C header describing the largest structure that is passed by
3424 value, if any.
3426 @end table
3428 @node Diagnostic Message Formatting Options
3429 @section Options to Control Diagnostic Messages Formatting
3430 @cindex options to control diagnostics formatting
3431 @cindex diagnostic messages
3432 @cindex message formatting
3434 Traditionally, diagnostic messages have been formatted irrespective of
3435 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3436 options described below
3437 to control the formatting algorithm for diagnostic messages, 
3438 e.g.@: how many characters per line, how often source location
3439 information should be reported.  Note that some language front ends may not
3440 honor these options.
3442 @table @gcctabopt
3443 @item -fmessage-length=@var{n}
3444 @opindex fmessage-length
3445 Try to format error messages so that they fit on lines of about
3446 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3447 done; each error message appears on a single line.  This is the
3448 default for all front ends.
3450 @item -fdiagnostics-show-location=once
3451 @opindex fdiagnostics-show-location
3452 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3453 reporter to emit source location information @emph{once}; that is, in
3454 case the message is too long to fit on a single physical line and has to
3455 be wrapped, the source location won't be emitted (as prefix) again,
3456 over and over, in subsequent continuation lines.  This is the default
3457 behavior.
3459 @item -fdiagnostics-show-location=every-line
3460 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3461 messages reporter to emit the same source location information (as
3462 prefix) for physical lines that result from the process of breaking
3463 a message which is too long to fit on a single line.
3465 @item -fdiagnostics-color[=@var{WHEN}]
3466 @itemx -fno-diagnostics-color
3467 @opindex fdiagnostics-color
3468 @cindex highlight, color
3469 @vindex GCC_COLORS @r{environment variable}
3470 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3471 or @samp{auto}.  The default depends on how the compiler has been configured,
3472 it can be any of the above @var{WHEN} options or also @samp{never}
3473 if @env{GCC_COLORS} environment variable isn't present in the environment,
3474 and @samp{auto} otherwise.
3475 @samp{auto} means to use color only when the standard error is a terminal.
3476 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3477 aliases for @option{-fdiagnostics-color=always} and
3478 @option{-fdiagnostics-color=never}, respectively.
3480 The colors are defined by the environment variable @env{GCC_COLORS}.
3481 Its value is a colon-separated list of capabilities and Select Graphic
3482 Rendition (SGR) substrings. SGR commands are interpreted by the
3483 terminal or terminal emulator.  (See the section in the documentation
3484 of your text terminal for permitted values and their meanings as
3485 character attributes.)  These substring values are integers in decimal
3486 representation and can be concatenated with semicolons.
3487 Common values to concatenate include
3488 @samp{1} for bold,
3489 @samp{4} for underline,
3490 @samp{5} for blink,
3491 @samp{7} for inverse,
3492 @samp{39} for default foreground color,
3493 @samp{30} to @samp{37} for foreground colors,
3494 @samp{90} to @samp{97} for 16-color mode foreground colors,
3495 @samp{38;5;0} to @samp{38;5;255}
3496 for 88-color and 256-color modes foreground colors,
3497 @samp{49} for default background color,
3498 @samp{40} to @samp{47} for background colors,
3499 @samp{100} to @samp{107} for 16-color mode background colors,
3500 and @samp{48;5;0} to @samp{48;5;255}
3501 for 88-color and 256-color modes background colors.
3503 The default @env{GCC_COLORS} is
3504 @smallexample
3505 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3506 quote=01:fixit-insert=32:fixit-delete=31:\
3507 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3508 type-diff=01;32
3509 @end smallexample
3510 @noindent
3511 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3512 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3513 @samp{01} is bold, and @samp{31} is red.
3514 Setting @env{GCC_COLORS} to the empty string disables colors.
3515 Supported capabilities are as follows.
3517 @table @code
3518 @item error=
3519 @vindex error GCC_COLORS @r{capability}
3520 SGR substring for error: markers.
3522 @item warning=
3523 @vindex warning GCC_COLORS @r{capability}
3524 SGR substring for warning: markers.
3526 @item note=
3527 @vindex note GCC_COLORS @r{capability}
3528 SGR substring for note: markers.
3530 @item range1=
3531 @vindex range1 GCC_COLORS @r{capability}
3532 SGR substring for first additional range.
3534 @item range2=
3535 @vindex range2 GCC_COLORS @r{capability}
3536 SGR substring for second additional range.
3538 @item locus=
3539 @vindex locus GCC_COLORS @r{capability}
3540 SGR substring for location information, @samp{file:line} or
3541 @samp{file:line:column} etc.
3543 @item quote=
3544 @vindex quote GCC_COLORS @r{capability}
3545 SGR substring for information printed within quotes.
3547 @item fixit-insert=
3548 @vindex fixit-insert GCC_COLORS @r{capability}
3549 SGR substring for fix-it hints suggesting text to
3550 be inserted or replaced.
3552 @item fixit-delete=
3553 @vindex fixit-delete GCC_COLORS @r{capability}
3554 SGR substring for fix-it hints suggesting text to
3555 be deleted.
3557 @item diff-filename=
3558 @vindex diff-filename GCC_COLORS @r{capability}
3559 SGR substring for filename headers within generated patches.
3561 @item diff-hunk=
3562 @vindex diff-hunk GCC_COLORS @r{capability}
3563 SGR substring for the starts of hunks within generated patches.
3565 @item diff-delete=
3566 @vindex diff-delete GCC_COLORS @r{capability}
3567 SGR substring for deleted lines within generated patches.
3569 @item diff-insert=
3570 @vindex diff-insert GCC_COLORS @r{capability}
3571 SGR substring for inserted lines within generated patches.
3573 @item type-diff=
3574 @vindex type-diff GCC_COLORS @r{capability}
3575 SGR substring for highlighting mismatching types within template
3576 arguments in the C++ frontend.
3577 @end table
3579 @item -fno-diagnostics-show-option
3580 @opindex fno-diagnostics-show-option
3581 @opindex fdiagnostics-show-option
3582 By default, each diagnostic emitted includes text indicating the
3583 command-line option that directly controls the diagnostic (if such an
3584 option is known to the diagnostic machinery).  Specifying the
3585 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3587 @item -fno-diagnostics-show-caret
3588 @opindex fno-diagnostics-show-caret
3589 @opindex fdiagnostics-show-caret
3590 By default, each diagnostic emitted includes the original source line
3591 and a caret @samp{^} indicating the column.  This option suppresses this
3592 information.  The source line is truncated to @var{n} characters, if
3593 the @option{-fmessage-length=n} option is given.  When the output is done
3594 to the terminal, the width is limited to the width given by the
3595 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3597 @item -fdiagnostics-parseable-fixits
3598 @opindex fdiagnostics-parseable-fixits
3599 Emit fix-it hints in a machine-parseable format, suitable for consumption
3600 by IDEs.  For each fix-it, a line will be printed after the relevant
3601 diagnostic, starting with the string ``fix-it:''.  For example:
3603 @smallexample
3604 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3605 @end smallexample
3607 The location is expressed as a half-open range, expressed as a count of
3608 bytes, starting at byte 1 for the initial column.  In the above example,
3609 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3610 given string:
3612 @smallexample
3613 00000000011111111112222222222
3614 12345678901234567890123456789
3615   gtk_widget_showall (dlg);
3616   ^^^^^^^^^^^^^^^^^^
3617   gtk_widget_show_all
3618 @end smallexample
3620 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3621 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3622 (e.g. vertical tab as ``\013'').
3624 An empty replacement string indicates that the given range is to be removed.
3625 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3626 be inserted at the given position.
3628 @item -fdiagnostics-generate-patch
3629 @opindex fdiagnostics-generate-patch
3630 Print fix-it hints to stderr in unified diff format, after any diagnostics
3631 are printed.  For example:
3633 @smallexample
3634 --- test.c
3635 +++ test.c
3636 @@ -42,5 +42,5 @@
3638  void show_cb(GtkDialog *dlg)
3639  @{
3640 -  gtk_widget_showall(dlg);
3641 +  gtk_widget_show_all(dlg);
3642  @}
3644 @end smallexample
3646 The diff may or may not be colorized, following the same rules
3647 as for diagnostics (see @option{-fdiagnostics-color}).
3649 @item -fdiagnostics-show-template-tree
3650 @opindex fdiagnostics-show-template-tree
3652 In the C++ frontend, when printing diagnostics showing mismatching
3653 template types, such as:
3655 @smallexample
3656   could not convert 'std::map<int, std::vector<double> >()'
3657     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3658 @end smallexample
3660 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3661 tree-like structure showing the common and differing parts of the types,
3662 such as:
3664 @smallexample
3665   map<
3666     [...],
3667     vector<
3668       [double != float]>>
3669 @end smallexample
3671 The parts that differ are highlighted with color (``double'' and
3672 ``float'' in this case).
3674 @item -fno-elide-type
3675 @opindex fno-elide-type
3676 @opindex felide-type
3677 By default when the C++ frontend prints diagnostics showing mismatching
3678 template types, common parts of the types are printed as ``[...]'' to
3679 simplify the error message.  For example:
3681 @smallexample
3682   could not convert 'std::map<int, std::vector<double> >()'
3683     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3684 @end smallexample
3686 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3687 This flag also affects the output of the
3688 @option{-fdiagnostics-show-template-tree} flag.
3690 @item -fno-show-column
3691 @opindex fno-show-column
3692 Do not print column numbers in diagnostics.  This may be necessary if
3693 diagnostics are being scanned by a program that does not understand the
3694 column numbers, such as @command{dejagnu}.
3696 @end table
3698 @node Warning Options
3699 @section Options to Request or Suppress Warnings
3700 @cindex options to control warnings
3701 @cindex warning messages
3702 @cindex messages, warning
3703 @cindex suppressing warnings
3705 Warnings are diagnostic messages that report constructions that
3706 are not inherently erroneous but that are risky or suggest there
3707 may have been an error.
3709 The following language-independent options do not enable specific
3710 warnings but control the kinds of diagnostics produced by GCC@.
3712 @table @gcctabopt
3713 @cindex syntax checking
3714 @item -fsyntax-only
3715 @opindex fsyntax-only
3716 Check the code for syntax errors, but don't do anything beyond that.
3718 @item -fmax-errors=@var{n}
3719 @opindex fmax-errors
3720 Limits the maximum number of error messages to @var{n}, at which point
3721 GCC bails out rather than attempting to continue processing the source
3722 code.  If @var{n} is 0 (the default), there is no limit on the number
3723 of error messages produced.  If @option{-Wfatal-errors} is also
3724 specified, then @option{-Wfatal-errors} takes precedence over this
3725 option.
3727 @item -w
3728 @opindex w
3729 Inhibit all warning messages.
3731 @item -Werror
3732 @opindex Werror
3733 @opindex Wno-error
3734 Make all warnings into errors.
3736 @item -Werror=
3737 @opindex Werror=
3738 @opindex Wno-error=
3739 Make the specified warning into an error.  The specifier for a warning
3740 is appended; for example @option{-Werror=switch} turns the warnings
3741 controlled by @option{-Wswitch} into errors.  This switch takes a
3742 negative form, to be used to negate @option{-Werror} for specific
3743 warnings; for example @option{-Wno-error=switch} makes
3744 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3745 is in effect.
3747 The warning message for each controllable warning includes the
3748 option that controls the warning.  That option can then be used with
3749 @option{-Werror=} and @option{-Wno-error=} as described above.
3750 (Printing of the option in the warning message can be disabled using the
3751 @option{-fno-diagnostics-show-option} flag.)
3753 Note that specifying @option{-Werror=}@var{foo} automatically implies
3754 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3755 imply anything.
3757 @item -Wfatal-errors
3758 @opindex Wfatal-errors
3759 @opindex Wno-fatal-errors
3760 This option causes the compiler to abort compilation on the first error
3761 occurred rather than trying to keep going and printing further error
3762 messages.
3764 @end table
3766 You can request many specific warnings with options beginning with
3767 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3768 implicit declarations.  Each of these specific warning options also
3769 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3770 example, @option{-Wno-implicit}.  This manual lists only one of the
3771 two forms, whichever is not the default.  For further
3772 language-specific options also refer to @ref{C++ Dialect Options} and
3773 @ref{Objective-C and Objective-C++ Dialect Options}.
3775 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3776 options, such as @option{-Wunused}, which may turn on further options,
3777 such as @option{-Wunused-value}. The combined effect of positive and
3778 negative forms is that more specific options have priority over less
3779 specific ones, independently of their position in the command-line. For
3780 options of the same specificity, the last one takes effect. Options
3781 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3782 as if they appeared at the end of the command-line.
3784 When an unrecognized warning option is requested (e.g.,
3785 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3786 that the option is not recognized.  However, if the @option{-Wno-} form
3787 is used, the behavior is slightly different: no diagnostic is
3788 produced for @option{-Wno-unknown-warning} unless other diagnostics
3789 are being produced.  This allows the use of new @option{-Wno-} options
3790 with old compilers, but if something goes wrong, the compiler
3791 warns that an unrecognized option is present.
3793 @table @gcctabopt
3794 @item -Wpedantic
3795 @itemx -pedantic
3796 @opindex pedantic
3797 @opindex Wpedantic
3798 Issue all the warnings demanded by strict ISO C and ISO C++;
3799 reject all programs that use forbidden extensions, and some other
3800 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3801 version of the ISO C standard specified by any @option{-std} option used.
3803 Valid ISO C and ISO C++ programs should compile properly with or without
3804 this option (though a rare few require @option{-ansi} or a
3805 @option{-std} option specifying the required version of ISO C)@.  However,
3806 without this option, certain GNU extensions and traditional C and C++
3807 features are supported as well.  With this option, they are rejected.
3809 @option{-Wpedantic} does not cause warning messages for use of the
3810 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3811 warnings are also disabled in the expression that follows
3812 @code{__extension__}.  However, only system header files should use
3813 these escape routes; application programs should avoid them.
3814 @xref{Alternate Keywords}.
3816 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3817 C conformance.  They soon find that it does not do quite what they want:
3818 it finds some non-ISO practices, but not all---only those for which
3819 ISO C @emph{requires} a diagnostic, and some others for which
3820 diagnostics have been added.
3822 A feature to report any failure to conform to ISO C might be useful in
3823 some instances, but would require considerable additional work and would
3824 be quite different from @option{-Wpedantic}.  We don't have plans to
3825 support such a feature in the near future.
3827 Where the standard specified with @option{-std} represents a GNU
3828 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3829 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3830 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3831 where they are required by the base standard.  (It does not make sense
3832 for such warnings to be given only for features not in the specified GNU
3833 C dialect, since by definition the GNU dialects of C include all
3834 features the compiler supports with the given option, and there would be
3835 nothing to warn about.)
3837 @item -pedantic-errors
3838 @opindex pedantic-errors
3839 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3840 requires a diagnostic, in some cases where there is undefined behavior
3841 at compile-time and in some other cases that do not prevent compilation
3842 of programs that are valid according to the standard. This is not
3843 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3844 by this option and not enabled by the latter and vice versa.
3846 @item -Wall
3847 @opindex Wall
3848 @opindex Wno-all
3849 This enables all the warnings about constructions that some users
3850 consider questionable, and that are easy to avoid (or modify to
3851 prevent the warning), even in conjunction with macros.  This also
3852 enables some language-specific warnings described in @ref{C++ Dialect
3853 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3855 @option{-Wall} turns on the following warning flags:
3857 @gccoptlist{-Waddress   @gol
3858 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3859 -Wbool-compare  @gol
3860 -Wbool-operation  @gol
3861 -Wc++11-compat  -Wc++14-compat  @gol
3862 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3863 -Wchar-subscripts  @gol
3864 -Wcomment  @gol
3865 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3866 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3867 -Wformat   @gol
3868 -Wint-in-bool-context  @gol
3869 -Wimplicit @r{(C and Objective-C only)} @gol
3870 -Wimplicit-int @r{(C and Objective-C only)} @gol
3871 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3872 -Winit-self @r{(only for C++)} @gol
3873 -Wlogical-not-parentheses @gol
3874 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3875 -Wmaybe-uninitialized @gol
3876 -Wmemset-elt-size @gol
3877 -Wmemset-transposed-args @gol
3878 -Wmisleading-indentation @r{(only for C/C++)} @gol
3879 -Wmissing-braces @r{(only for C/ObjC)} @gol
3880 -Wmultistatement-macros  @gol
3881 -Wnarrowing @r{(only for C++)}  @gol
3882 -Wnonnull  @gol
3883 -Wnonnull-compare  @gol
3884 -Wopenmp-simd @gol
3885 -Wparentheses  @gol
3886 -Wpointer-sign  @gol
3887 -Wreorder   @gol
3888 -Wrestrict   @gol
3889 -Wreturn-type  @gol
3890 -Wsequence-point  @gol
3891 -Wsign-compare @r{(only in C++)}  @gol
3892 -Wsizeof-pointer-div @gol
3893 -Wsizeof-pointer-memaccess @gol
3894 -Wstrict-aliasing  @gol
3895 -Wstrict-overflow=1  @gol
3896 -Wswitch  @gol
3897 -Wtautological-compare  @gol
3898 -Wtrigraphs  @gol
3899 -Wuninitialized  @gol
3900 -Wunknown-pragmas  @gol
3901 -Wunused-function  @gol
3902 -Wunused-label     @gol
3903 -Wunused-value     @gol
3904 -Wunused-variable  @gol
3905 -Wvolatile-register-var @gol
3908 Note that some warning flags are not implied by @option{-Wall}.  Some of
3909 them warn about constructions that users generally do not consider
3910 questionable, but which occasionally you might wish to check for;
3911 others warn about constructions that are necessary or hard to avoid in
3912 some cases, and there is no simple way to modify the code to suppress
3913 the warning. Some of them are enabled by @option{-Wextra} but many of
3914 them must be enabled individually.
3916 @item -Wextra
3917 @opindex W
3918 @opindex Wextra
3919 @opindex Wno-extra
3920 This enables some extra warning flags that are not enabled by
3921 @option{-Wall}. (This option used to be called @option{-W}.  The older
3922 name is still supported, but the newer name is more descriptive.)
3924 @gccoptlist{-Wclobbered  @gol
3925 -Wcast-function-type  @gol
3926 -Wempty-body  @gol
3927 -Wignored-qualifiers @gol
3928 -Wimplicit-fallthrough=3 @gol
3929 -Wmissing-field-initializers  @gol
3930 -Wmissing-parameter-type @r{(C only)}  @gol
3931 -Wold-style-declaration @r{(C only)}  @gol
3932 -Woverride-init  @gol
3933 -Wsign-compare @r{(C only)} @gol
3934 -Wtype-limits  @gol
3935 -Wuninitialized  @gol
3936 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3937 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3938 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3941 The option @option{-Wextra} also prints warning messages for the
3942 following cases:
3944 @itemize @bullet
3946 @item
3947 A pointer is compared against integer zero with @code{<}, @code{<=},
3948 @code{>}, or @code{>=}.
3950 @item
3951 (C++ only) An enumerator and a non-enumerator both appear in a
3952 conditional expression.
3954 @item
3955 (C++ only) Ambiguous virtual bases.
3957 @item
3958 (C++ only) Subscripting an array that has been declared @code{register}.
3960 @item
3961 (C++ only) Taking the address of a variable that has been declared
3962 @code{register}.
3964 @item
3965 (C++ only) A base class is not initialized in the copy constructor
3966 of a derived class.
3968 @end itemize
3970 @item -Wchar-subscripts
3971 @opindex Wchar-subscripts
3972 @opindex Wno-char-subscripts
3973 Warn if an array subscript has type @code{char}.  This is a common cause
3974 of error, as programmers often forget that this type is signed on some
3975 machines.
3976 This warning is enabled by @option{-Wall}.
3978 @item -Wchkp
3979 @opindex Wchkp
3980 Warn about an invalid memory access that is found by Pointer Bounds Checker
3981 (@option{-fcheck-pointer-bounds}).
3983 @item -Wno-coverage-mismatch
3984 @opindex Wno-coverage-mismatch
3985 Warn if feedback profiles do not match when using the
3986 @option{-fprofile-use} option.
3987 If a source file is changed between compiling with @option{-fprofile-gen} and
3988 with @option{-fprofile-use}, the files with the profile feedback can fail
3989 to match the source file and GCC cannot use the profile feedback
3990 information.  By default, this warning is enabled and is treated as an
3991 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3992 warning or @option{-Wno-error=coverage-mismatch} can be used to
3993 disable the error.  Disabling the error for this warning can result in
3994 poorly optimized code and is useful only in the
3995 case of very minor changes such as bug fixes to an existing code-base.
3996 Completely disabling the warning is not recommended.
3998 @item -Wno-cpp
3999 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4001 Suppress warning messages emitted by @code{#warning} directives.
4003 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4004 @opindex Wdouble-promotion
4005 @opindex Wno-double-promotion
4006 Give a warning when a value of type @code{float} is implicitly
4007 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4008 floating-point unit implement @code{float} in hardware, but emulate
4009 @code{double} in software.  On such a machine, doing computations
4010 using @code{double} values is much more expensive because of the
4011 overhead required for software emulation.
4013 It is easy to accidentally do computations with @code{double} because
4014 floating-point literals are implicitly of type @code{double}.  For
4015 example, in:
4016 @smallexample
4017 @group
4018 float area(float radius)
4020    return 3.14159 * radius * radius;
4022 @end group
4023 @end smallexample
4024 the compiler performs the entire computation with @code{double}
4025 because the floating-point literal is a @code{double}.
4027 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4028 @opindex Wduplicate-decl-specifier
4029 @opindex Wno-duplicate-decl-specifier
4030 Warn if a declaration has duplicate @code{const}, @code{volatile},
4031 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4032 @option{-Wall}.
4034 @item -Wformat
4035 @itemx -Wformat=@var{n}
4036 @opindex Wformat
4037 @opindex Wno-format
4038 @opindex ffreestanding
4039 @opindex fno-builtin
4040 @opindex Wformat=
4041 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4042 the arguments supplied have types appropriate to the format string
4043 specified, and that the conversions specified in the format string make
4044 sense.  This includes standard functions, and others specified by format
4045 attributes (@pxref{Function Attributes}), in the @code{printf},
4046 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4047 not in the C standard) families (or other target-specific families).
4048 Which functions are checked without format attributes having been
4049 specified depends on the standard version selected, and such checks of
4050 functions without the attribute specified are disabled by
4051 @option{-ffreestanding} or @option{-fno-builtin}.
4053 The formats are checked against the format features supported by GNU
4054 libc version 2.2.  These include all ISO C90 and C99 features, as well
4055 as features from the Single Unix Specification and some BSD and GNU
4056 extensions.  Other library implementations may not support all these
4057 features; GCC does not support warning about features that go beyond a
4058 particular library's limitations.  However, if @option{-Wpedantic} is used
4059 with @option{-Wformat}, warnings are given about format features not
4060 in the selected standard version (but not for @code{strfmon} formats,
4061 since those are not in any version of the C standard).  @xref{C Dialect
4062 Options,,Options Controlling C Dialect}.
4064 @table @gcctabopt
4065 @item -Wformat=1
4066 @itemx -Wformat
4067 @opindex Wformat
4068 @opindex Wformat=1
4069 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4070 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4071 @option{-Wformat} also checks for null format arguments for several
4072 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4073 aspects of this level of format checking can be disabled by the
4074 options: @option{-Wno-format-contains-nul},
4075 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4076 @option{-Wformat} is enabled by @option{-Wall}.
4078 @item -Wno-format-contains-nul
4079 @opindex Wno-format-contains-nul
4080 @opindex Wformat-contains-nul
4081 If @option{-Wformat} is specified, do not warn about format strings that
4082 contain NUL bytes.
4084 @item -Wno-format-extra-args
4085 @opindex Wno-format-extra-args
4086 @opindex Wformat-extra-args
4087 If @option{-Wformat} is specified, do not warn about excess arguments to a
4088 @code{printf} or @code{scanf} format function.  The C standard specifies
4089 that such arguments are ignored.
4091 Where the unused arguments lie between used arguments that are
4092 specified with @samp{$} operand number specifications, normally
4093 warnings are still given, since the implementation could not know what
4094 type to pass to @code{va_arg} to skip the unused arguments.  However,
4095 in the case of @code{scanf} formats, this option suppresses the
4096 warning if the unused arguments are all pointers, since the Single
4097 Unix Specification says that such unused arguments are allowed.
4099 @item -Wformat-overflow
4100 @itemx -Wformat-overflow=@var{level}
4101 @opindex Wformat-overflow
4102 @opindex Wno-format-overflow
4103 Warn about calls to formatted input/output functions such as @code{sprintf}
4104 and @code{vsprintf} that might overflow the destination buffer.  When the
4105 exact number of bytes written by a format directive cannot be determined
4106 at compile-time it is estimated based on heuristics that depend on the
4107 @var{level} argument and on optimization.  While enabling optimization
4108 will in most cases improve the accuracy of the warning, it may also
4109 result in false positives.
4111 @table @gcctabopt
4112 @item -Wformat-overflow
4113 @item -Wformat-overflow=1
4114 @opindex Wformat-overflow
4115 @opindex Wno-format-overflow
4116 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4117 employs a conservative approach that warns only about calls that most
4118 likely overflow the buffer.  At this level, numeric arguments to format
4119 directives with unknown values are assumed to have the value of one, and
4120 strings of unknown length to be empty.  Numeric arguments that are known
4121 to be bounded to a subrange of their type, or string arguments whose output
4122 is bounded either by their directive's precision or by a finite set of
4123 string literals, are assumed to take on the value within the range that
4124 results in the most bytes on output.  For example, the call to @code{sprintf}
4125 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4126 the terminating NUL character (@code{'\0'}) appended by the function
4127 to the destination buffer will be written past its end.  Increasing
4128 the size of the buffer by a single byte is sufficient to avoid the
4129 warning, though it may not be sufficient to avoid the overflow.
4131 @smallexample
4132 void f (int a, int b)
4134   char buf [12];
4135   sprintf (buf, "a = %i, b = %i\n", a, b);
4137 @end smallexample
4139 @item -Wformat-overflow=2
4140 Level @var{2} warns also about calls that might overflow the destination
4141 buffer given an argument of sufficient length or magnitude.  At level
4142 @var{2}, unknown numeric arguments are assumed to have the minimum
4143 representable value for signed types with a precision greater than 1, and
4144 the maximum representable value otherwise.  Unknown string arguments whose
4145 length cannot be assumed to be bounded either by the directive's precision,
4146 or by a finite set of string literals they may evaluate to, or the character
4147 array they may point to, are assumed to be 1 character long.
4149 At level @var{2}, the call in the example above is again diagnosed, but
4150 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4151 @code{%i} directive will write some of its digits beyond the end of
4152 the destination buffer.  To make the call safe regardless of the values
4153 of the two variables, the size of the destination buffer must be increased
4154 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4155 an informational note following the warning.
4157 An alternative to increasing the size of the destination buffer is to
4158 constrain the range of formatted values.  The maximum length of string
4159 arguments can be bounded by specifying the precision in the format
4160 directive.  When numeric arguments of format directives can be assumed
4161 to be bounded by less than the precision of their type, choosing
4162 an appropriate length modifier to the format specifier will reduce
4163 the required buffer size.  For example, if @var{a} and @var{b} in the
4164 example above can be assumed to be within the precision of
4165 the @code{short int} type then using either the @code{%hi} format
4166 directive or casting the argument to @code{short} reduces the maximum
4167 required size of the buffer to 24 bytes.
4169 @smallexample
4170 void f (int a, int b)
4172   char buf [23];
4173   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4175 @end smallexample
4176 @end table
4178 @item -Wno-format-zero-length
4179 @opindex Wno-format-zero-length
4180 @opindex Wformat-zero-length
4181 If @option{-Wformat} is specified, do not warn about zero-length formats.
4182 The C standard specifies that zero-length formats are allowed.
4185 @item -Wformat=2
4186 @opindex Wformat=2
4187 Enable @option{-Wformat} plus additional format checks.  Currently
4188 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4189 -Wformat-y2k}.
4191 @item -Wformat-nonliteral
4192 @opindex Wformat-nonliteral
4193 @opindex Wno-format-nonliteral
4194 If @option{-Wformat} is specified, also warn if the format string is not a
4195 string literal and so cannot be checked, unless the format function
4196 takes its format arguments as a @code{va_list}.
4198 @item -Wformat-security
4199 @opindex Wformat-security
4200 @opindex Wno-format-security
4201 If @option{-Wformat} is specified, also warn about uses of format
4202 functions that represent possible security problems.  At present, this
4203 warns about calls to @code{printf} and @code{scanf} functions where the
4204 format string is not a string literal and there are no format arguments,
4205 as in @code{printf (foo);}.  This may be a security hole if the format
4206 string came from untrusted input and contains @samp{%n}.  (This is
4207 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4208 in future warnings may be added to @option{-Wformat-security} that are not
4209 included in @option{-Wformat-nonliteral}.)
4211 @item -Wformat-signedness
4212 @opindex Wformat-signedness
4213 @opindex Wno-format-signedness
4214 If @option{-Wformat} is specified, also warn if the format string
4215 requires an unsigned argument and the argument is signed and vice versa.
4217 @item -Wformat-truncation
4218 @itemx -Wformat-truncation=@var{level}
4219 @opindex Wformat-truncation
4220 @opindex Wno-format-truncation
4221 Warn about calls to formatted input/output functions such as @code{snprintf}
4222 and @code{vsnprintf} that might result in output truncation.  When the exact
4223 number of bytes written by a format directive cannot be determined at
4224 compile-time it is estimated based on heuristics that depend on
4225 the @var{level} argument and on optimization.  While enabling optimization
4226 will in most cases improve the accuracy of the warning, it may also result
4227 in false positives.  Except as noted otherwise, the option uses the same
4228 logic @option{-Wformat-overflow}.
4230 @table @gcctabopt
4231 @item -Wformat-truncation
4232 @item -Wformat-truncation=1
4233 @opindex Wformat-truncation
4234 @opindex Wno-format-overflow
4235 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4236 employs a conservative approach that warns only about calls to bounded
4237 functions whose return value is unused and that will most likely result
4238 in output truncation.
4240 @item -Wformat-truncation=2
4241 Level @var{2} warns also about calls to bounded functions whose return
4242 value is used and that might result in truncation given an argument of
4243 sufficient length or magnitude.
4244 @end table
4246 @item -Wformat-y2k
4247 @opindex Wformat-y2k
4248 @opindex Wno-format-y2k
4249 If @option{-Wformat} is specified, also warn about @code{strftime}
4250 formats that may yield only a two-digit year.
4251 @end table
4253 @item -Wnonnull
4254 @opindex Wnonnull
4255 @opindex Wno-nonnull
4256 Warn about passing a null pointer for arguments marked as
4257 requiring a non-null value by the @code{nonnull} function attribute.
4259 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4260 can be disabled with the @option{-Wno-nonnull} option.
4262 @item -Wnonnull-compare
4263 @opindex Wnonnull-compare
4264 @opindex Wno-nonnull-compare
4265 Warn when comparing an argument marked with the @code{nonnull}
4266 function attribute against null inside the function.
4268 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4269 can be disabled with the @option{-Wno-nonnull-compare} option.
4271 @item -Wnull-dereference
4272 @opindex Wnull-dereference
4273 @opindex Wno-null-dereference
4274 Warn if the compiler detects paths that trigger erroneous or
4275 undefined behavior due to dereferencing a null pointer.  This option
4276 is only active when @option{-fdelete-null-pointer-checks} is active,
4277 which is enabled by optimizations in most targets.  The precision of
4278 the warnings depends on the optimization options used.
4280 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4281 @opindex Winit-self
4282 @opindex Wno-init-self
4283 Warn about uninitialized variables that are initialized with themselves.
4284 Note this option can only be used with the @option{-Wuninitialized} option.
4286 For example, GCC warns about @code{i} being uninitialized in the
4287 following snippet only when @option{-Winit-self} has been specified:
4288 @smallexample
4289 @group
4290 int f()
4292   int i = i;
4293   return i;
4295 @end group
4296 @end smallexample
4298 This warning is enabled by @option{-Wall} in C++.
4300 @item -Wimplicit-int @r{(C and Objective-C only)}
4301 @opindex Wimplicit-int
4302 @opindex Wno-implicit-int
4303 Warn when a declaration does not specify a type.
4304 This warning is enabled by @option{-Wall}.
4306 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4307 @opindex Wimplicit-function-declaration
4308 @opindex Wno-implicit-function-declaration
4309 Give a warning whenever a function is used before being declared. In
4310 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4311 enabled by default and it is made into an error by
4312 @option{-pedantic-errors}. This warning is also enabled by
4313 @option{-Wall}.
4315 @item -Wimplicit @r{(C and Objective-C only)}
4316 @opindex Wimplicit
4317 @opindex Wno-implicit
4318 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4319 This warning is enabled by @option{-Wall}.
4321 @item -Wimplicit-fallthrough
4322 @opindex Wimplicit-fallthrough
4323 @opindex Wno-implicit-fallthrough
4324 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4325 and @option{-Wno-implicit-fallthrough} is the same as
4326 @option{-Wimplicit-fallthrough=0}.
4328 @item -Wimplicit-fallthrough=@var{n}
4329 @opindex Wimplicit-fallthrough=
4330 Warn when a switch case falls through.  For example:
4332 @smallexample
4333 @group
4334 switch (cond)
4335   @{
4336   case 1:
4337     a = 1;
4338     break;
4339   case 2:
4340     a = 2;
4341   case 3:
4342     a = 3;
4343     break;
4344   @}
4345 @end group
4346 @end smallexample
4348 This warning does not warn when the last statement of a case cannot
4349 fall through, e.g. when there is a return statement or a call to function
4350 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4351 also takes into account control flow statements, such as ifs, and only
4352 warns when appropriate.  E.g.@:
4354 @smallexample
4355 @group
4356 switch (cond)
4357   @{
4358   case 1:
4359     if (i > 3) @{
4360       bar (5);
4361       break;
4362     @} else if (i < 1) @{
4363       bar (0);
4364     @} else
4365       return;
4366   default:
4367     @dots{}
4368   @}
4369 @end group
4370 @end smallexample
4372 Since there are occasions where a switch case fall through is desirable,
4373 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4374 to be used along with a null statement to suppress this warning that
4375 would normally occur:
4377 @smallexample
4378 @group
4379 switch (cond)
4380   @{
4381   case 1:
4382     bar (0);
4383     __attribute__ ((fallthrough));
4384   default:
4385     @dots{}
4386   @}
4387 @end group
4388 @end smallexample
4390 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4391 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4392 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4393 Instead of these attributes, it is also possible to add a fallthrough comment
4394 to silence the warning.  The whole body of the C or C++ style comment should
4395 match the given regular expressions listed below.  The option argument @var{n}
4396 specifies what kind of comments are accepted:
4398 @itemize @bullet
4400 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4402 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4403 expression, any comment is used as fallthrough comment.
4405 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4406 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4408 @item @option{-Wimplicit-fallthrough=3} 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.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4421 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4423 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4425 @end itemize
4427 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4428 following regular expressions:
4430 @itemize @bullet
4432 @item @code{-fallthrough}
4434 @item @code{@@fallthrough@@}
4436 @item @code{lint -fallthrough[ \t]*}
4438 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4440 @end itemize
4442 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4443 fallthrough comments, only attributes disable the warning.
4445 @end itemize
4447 The comment needs to be followed after optional whitespace and other comments
4448 by @code{case} or @code{default} keywords or by a user label that precedes some
4449 @code{case} or @code{default} label.
4451 @smallexample
4452 @group
4453 switch (cond)
4454   @{
4455   case 1:
4456     bar (0);
4457     /* FALLTHRU */
4458   default:
4459     @dots{}
4460   @}
4461 @end group
4462 @end smallexample
4464 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4466 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4467 @opindex Wif-not-aligned
4468 @opindex Wno-if-not-aligned
4469 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4470 should be issued.  This is is enabled by default.
4471 Use @option{-Wno-if-not-aligned} to disable it.
4473 @item -Wignored-qualifiers @r{(C and C++ only)}
4474 @opindex Wignored-qualifiers
4475 @opindex Wno-ignored-qualifiers
4476 Warn if the return type of a function has a type qualifier
4477 such as @code{const}.  For ISO C such a type qualifier has no effect,
4478 since the value returned by a function is not an lvalue.
4479 For C++, the warning is only emitted for scalar types or @code{void}.
4480 ISO C prohibits qualified @code{void} return types on function
4481 definitions, so such return types always receive a warning
4482 even without this option.
4484 This warning is also enabled by @option{-Wextra}.
4486 @item -Wignored-attributes @r{(C and C++ only)}
4487 @opindex Wignored-attributes
4488 @opindex Wno-ignored-attributes
4489 Warn when an attribute is ignored.  This is different from the
4490 @option{-Wattributes} option in that it warns whenever the compiler decides
4491 to drop an attribute, not that the attribute is either unknown, used in a
4492 wrong place, etc.  This warning is enabled by default.
4494 @item -Wmain
4495 @opindex Wmain
4496 @opindex Wno-main
4497 Warn if the type of @code{main} is suspicious.  @code{main} should be
4498 a function with external linkage, returning int, taking either zero
4499 arguments, two, or three arguments of appropriate types.  This warning
4500 is enabled by default in C++ and is enabled by either @option{-Wall}
4501 or @option{-Wpedantic}.
4503 @item -Wmisleading-indentation @r{(C and C++ only)}
4504 @opindex Wmisleading-indentation
4505 @opindex Wno-misleading-indentation
4506 Warn when the indentation of the code does not reflect the block structure.
4507 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4508 @code{for} clauses with a guarded statement that does not use braces,
4509 followed by an unguarded statement with the same indentation.
4511 In the following example, the call to ``bar'' is misleadingly indented as
4512 if it were guarded by the ``if'' conditional.
4514 @smallexample
4515   if (some_condition ())
4516     foo ();
4517     bar ();  /* Gotcha: this is not guarded by the "if".  */
4518 @end smallexample
4520 In the case of mixed tabs and spaces, the warning uses the
4521 @option{-ftabstop=} option to determine if the statements line up
4522 (defaulting to 8).
4524 The warning is not issued for code involving multiline preprocessor logic
4525 such as the following example.
4527 @smallexample
4528   if (flagA)
4529     foo (0);
4530 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4531   if (flagB)
4532 #endif
4533     foo (1);
4534 @end smallexample
4536 The warning is not issued after a @code{#line} directive, since this
4537 typically indicates autogenerated code, and no assumptions can be made
4538 about the layout of the file that the directive references.
4540 This warning is enabled by @option{-Wall} in C and C++.
4542 @item -Wmissing-braces
4543 @opindex Wmissing-braces
4544 @opindex Wno-missing-braces
4545 Warn if an aggregate or union initializer is not fully bracketed.  In
4546 the following example, the initializer for @code{a} is not fully
4547 bracketed, but that for @code{b} is fully bracketed.  This warning is
4548 enabled by @option{-Wall} in C.
4550 @smallexample
4551 int a[2][2] = @{ 0, 1, 2, 3 @};
4552 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4553 @end smallexample
4555 This warning is enabled by @option{-Wall}.
4557 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4558 @opindex Wmissing-include-dirs
4559 @opindex Wno-missing-include-dirs
4560 Warn if a user-supplied include directory does not exist.
4562 @item -Wmultistatement-macros
4563 @opindex Wmultistatement-macros
4564 @opindex Wno-multistatement-macros
4565 Warn about unsafe multiple statement macros that appear to be guarded
4566 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4567 @code{while}, in which only the first statement is actually guarded after
4568 the macro is expanded.
4570 For example:
4572 @smallexample
4573 #define DOIT x++; y++
4574 if (c)
4575   DOIT;
4576 @end smallexample
4578 will increment @code{y} unconditionally, not just when @code{c} holds.
4579 The can usually be fixed by wrapping the macro in a do-while loop:
4580 @smallexample
4581 #define DOIT do @{ x++; y++; @} while (0)
4582 if (c)
4583   DOIT;
4584 @end smallexample
4586 This warning is enabled by @option{-Wall} in C and C++.
4588 @item -Wparentheses
4589 @opindex Wparentheses
4590 @opindex Wno-parentheses
4591 Warn if parentheses are omitted in certain contexts, such
4592 as when there is an assignment in a context where a truth value
4593 is expected, or when operators are nested whose precedence people
4594 often get confused about.
4596 Also warn if a comparison like @code{x<=y<=z} appears; this is
4597 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4598 interpretation from that of ordinary mathematical notation.
4600 Also warn for dangerous uses of the GNU extension to
4601 @code{?:} with omitted middle operand. When the condition
4602 in the @code{?}: operator is a boolean expression, the omitted value is
4603 always 1.  Often programmers expect it to be a value computed
4604 inside the conditional expression instead.
4606 For C++ this also warns for some cases of unnecessary parentheses in
4607 declarations, which can indicate an attempt at a function call instead
4608 of a declaration:
4609 @smallexample
4611   // Declares a local variable called mymutex.
4612   std::unique_lock<std::mutex> (mymutex);
4613   // User meant std::unique_lock<std::mutex> lock (mymutex);
4615 @end smallexample
4617 This warning is enabled by @option{-Wall}.
4619 @item -Wsequence-point
4620 @opindex Wsequence-point
4621 @opindex Wno-sequence-point
4622 Warn about code that may have undefined semantics because of violations
4623 of sequence point rules in the C and C++ standards.
4625 The C and C++ standards define the order in which expressions in a C/C++
4626 program are evaluated in terms of @dfn{sequence points}, which represent
4627 a partial ordering between the execution of parts of the program: those
4628 executed before the sequence point, and those executed after it.  These
4629 occur after the evaluation of a full expression (one which is not part
4630 of a larger expression), after the evaluation of the first operand of a
4631 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4632 function is called (but after the evaluation of its arguments and the
4633 expression denoting the called function), and in certain other places.
4634 Other than as expressed by the sequence point rules, the order of
4635 evaluation of subexpressions of an expression is not specified.  All
4636 these rules describe only a partial order rather than a total order,
4637 since, for example, if two functions are called within one expression
4638 with no sequence point between them, the order in which the functions
4639 are called is not specified.  However, the standards committee have
4640 ruled that function calls do not overlap.
4642 It is not specified when between sequence points modifications to the
4643 values of objects take effect.  Programs whose behavior depends on this
4644 have undefined behavior; the C and C++ standards specify that ``Between
4645 the previous and next sequence point an object shall have its stored
4646 value modified at most once by the evaluation of an expression.
4647 Furthermore, the prior value shall be read only to determine the value
4648 to be stored.''.  If a program breaks these rules, the results on any
4649 particular implementation are entirely unpredictable.
4651 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4652 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4653 diagnosed by this option, and it may give an occasional false positive
4654 result, but in general it has been found fairly effective at detecting
4655 this sort of problem in programs.
4657 The C++17 standard will define the order of evaluation of operands in
4658 more cases: in particular it requires that the right-hand side of an
4659 assignment be evaluated before the left-hand side, so the above
4660 examples are no longer undefined.  But this warning will still warn
4661 about them, to help people avoid writing code that is undefined in C
4662 and earlier revisions of C++.
4664 The standard is worded confusingly, therefore there is some debate
4665 over the precise meaning of the sequence point rules in subtle cases.
4666 Links to discussions of the problem, including proposed formal
4667 definitions, may be found on the GCC readings page, at
4668 @uref{http://gcc.gnu.org/@/readings.html}.
4670 This warning is enabled by @option{-Wall} for C and C++.
4672 @item -Wno-return-local-addr
4673 @opindex Wno-return-local-addr
4674 @opindex Wreturn-local-addr
4675 Do not warn about returning a pointer (or in C++, a reference) to a
4676 variable that goes out of scope after the function returns.
4678 @item -Wreturn-type
4679 @opindex Wreturn-type
4680 @opindex Wno-return-type
4681 Warn whenever a function is defined with a return type that defaults
4682 to @code{int}.  Also warn about any @code{return} statement with no
4683 return value in a function whose return type is not @code{void}
4684 (falling off the end of the function body is considered returning
4685 without a value).
4687 For C only, warn about a @code{return} statement with an expression in a
4688 function whose return type is @code{void}, unless the expression type is
4689 also @code{void}.  As a GNU extension, the latter case is accepted
4690 without a warning unless @option{-Wpedantic} is used.
4692 For C++, a function without return type always produces a diagnostic
4693 message, even when @option{-Wno-return-type} is specified.  The only
4694 exceptions are @code{main} and functions defined in system headers.
4696 This warning is enabled by @option{-Wall}.
4698 @item -Wshift-count-negative
4699 @opindex Wshift-count-negative
4700 @opindex Wno-shift-count-negative
4701 Warn if shift count is negative. This warning is enabled by default.
4703 @item -Wshift-count-overflow
4704 @opindex Wshift-count-overflow
4705 @opindex Wno-shift-count-overflow
4706 Warn if shift count >= width of type. This warning is enabled by default.
4708 @item -Wshift-negative-value
4709 @opindex Wshift-negative-value
4710 @opindex Wno-shift-negative-value
4711 Warn if left shifting a negative value.  This warning is enabled by
4712 @option{-Wextra} in C99 and C++11 modes (and newer).
4714 @item -Wshift-overflow
4715 @itemx -Wshift-overflow=@var{n}
4716 @opindex Wshift-overflow
4717 @opindex Wno-shift-overflow
4718 Warn about left shift overflows.  This warning is enabled by
4719 default in C99 and C++11 modes (and newer).
4721 @table @gcctabopt
4722 @item -Wshift-overflow=1
4723 This is the warning level of @option{-Wshift-overflow} and is enabled
4724 by default in C99 and C++11 modes (and newer).  This warning level does
4725 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4726 an overflow is still rejected in contexts where an integer constant expression
4727 is required.)
4729 @item -Wshift-overflow=2
4730 This warning level also warns about left-shifting 1 into the sign bit,
4731 unless C++14 mode is active.
4732 @end table
4734 @item -Wswitch
4735 @opindex Wswitch
4736 @opindex Wno-switch
4737 Warn whenever a @code{switch} statement has an index of enumerated type
4738 and lacks a @code{case} for one or more of the named codes of that
4739 enumeration.  (The presence of a @code{default} label prevents this
4740 warning.)  @code{case} labels outside the enumeration range also
4741 provoke warnings when this option is used (even if there is a
4742 @code{default} label).
4743 This warning is enabled by @option{-Wall}.
4745 @item -Wswitch-default
4746 @opindex Wswitch-default
4747 @opindex Wno-switch-default
4748 Warn whenever a @code{switch} statement does not have a @code{default}
4749 case.
4751 @item -Wswitch-enum
4752 @opindex Wswitch-enum
4753 @opindex Wno-switch-enum
4754 Warn whenever a @code{switch} statement has an index of enumerated type
4755 and lacks a @code{case} for one or more of the named codes of that
4756 enumeration.  @code{case} labels outside the enumeration range also
4757 provoke warnings when this option is used.  The only difference
4758 between @option{-Wswitch} and this option is that this option gives a
4759 warning about an omitted enumeration code even if there is a
4760 @code{default} label.
4762 @item -Wswitch-bool
4763 @opindex Wswitch-bool
4764 @opindex Wno-switch-bool
4765 Warn whenever a @code{switch} statement has an index of boolean type
4766 and the case values are outside the range of a boolean type.
4767 It is possible to suppress this warning by casting the controlling
4768 expression to a type other than @code{bool}.  For example:
4769 @smallexample
4770 @group
4771 switch ((int) (a == 4))
4772   @{
4773   @dots{}
4774   @}
4775 @end group
4776 @end smallexample
4777 This warning is enabled by default for C and C++ programs.
4779 @item -Wswitch-unreachable
4780 @opindex Wswitch-unreachable
4781 @opindex Wno-switch-unreachable
4782 Warn whenever a @code{switch} statement contains statements between the
4783 controlling expression and the first case label, which will never be
4784 executed.  For example:
4785 @smallexample
4786 @group
4787 switch (cond)
4788   @{
4789    i = 15;
4790   @dots{}
4791    case 5:
4792   @dots{}
4793   @}
4794 @end group
4795 @end smallexample
4796 @option{-Wswitch-unreachable} does not warn if the statement between the
4797 controlling expression and the first case label is just a declaration:
4798 @smallexample
4799 @group
4800 switch (cond)
4801   @{
4802    int i;
4803   @dots{}
4804    case 5:
4805    i = 5;
4806   @dots{}
4807   @}
4808 @end group
4809 @end smallexample
4810 This warning is enabled by default for C and C++ programs.
4812 @item -Wsync-nand @r{(C and C++ only)}
4813 @opindex Wsync-nand
4814 @opindex Wno-sync-nand
4815 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4816 built-in functions are used.  These functions changed semantics in GCC 4.4.
4818 @item -Wunused-but-set-parameter
4819 @opindex Wunused-but-set-parameter
4820 @opindex Wno-unused-but-set-parameter
4821 Warn whenever a function parameter is assigned to, but otherwise unused
4822 (aside from its declaration).
4824 To suppress this warning use the @code{unused} attribute
4825 (@pxref{Variable Attributes}).
4827 This warning is also enabled by @option{-Wunused} together with
4828 @option{-Wextra}.
4830 @item -Wunused-but-set-variable
4831 @opindex Wunused-but-set-variable
4832 @opindex Wno-unused-but-set-variable
4833 Warn whenever a local variable is assigned to, but otherwise unused
4834 (aside from its declaration).
4835 This warning is enabled by @option{-Wall}.
4837 To suppress this warning use the @code{unused} attribute
4838 (@pxref{Variable Attributes}).
4840 This warning is also enabled by @option{-Wunused}, which is enabled
4841 by @option{-Wall}.
4843 @item -Wunused-function
4844 @opindex Wunused-function
4845 @opindex Wno-unused-function
4846 Warn whenever a static function is declared but not defined or a
4847 non-inline static function is unused.
4848 This warning is enabled by @option{-Wall}.
4850 @item -Wunused-label
4851 @opindex Wunused-label
4852 @opindex Wno-unused-label
4853 Warn whenever a label is declared but not used.
4854 This warning is enabled by @option{-Wall}.
4856 To suppress this warning use the @code{unused} attribute
4857 (@pxref{Variable Attributes}).
4859 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4860 @opindex Wunused-local-typedefs
4861 Warn when a typedef locally defined in a function is not used.
4862 This warning is enabled by @option{-Wall}.
4864 @item -Wunused-parameter
4865 @opindex Wunused-parameter
4866 @opindex Wno-unused-parameter
4867 Warn whenever a function parameter is unused aside from its declaration.
4869 To suppress this warning use the @code{unused} attribute
4870 (@pxref{Variable Attributes}).
4872 @item -Wno-unused-result
4873 @opindex Wunused-result
4874 @opindex Wno-unused-result
4875 Do not warn if a caller of a function marked with attribute
4876 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4877 its return value. The default is @option{-Wunused-result}.
4879 @item -Wunused-variable
4880 @opindex Wunused-variable
4881 @opindex Wno-unused-variable
4882 Warn whenever a local or static variable is unused aside from its
4883 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4884 but not for C++. This warning is enabled by @option{-Wall}.
4886 To suppress this warning use the @code{unused} attribute
4887 (@pxref{Variable Attributes}).
4889 @item -Wunused-const-variable
4890 @itemx -Wunused-const-variable=@var{n}
4891 @opindex Wunused-const-variable
4892 @opindex Wno-unused-const-variable
4893 Warn whenever a constant static variable is unused aside from its declaration.
4894 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4895 for C, but not for C++. In C this declares variable storage, but in C++ this
4896 is not an error since const variables take the place of @code{#define}s.
4898 To suppress this warning use the @code{unused} attribute
4899 (@pxref{Variable Attributes}).
4901 @table @gcctabopt
4902 @item -Wunused-const-variable=1
4903 This is the warning level that is enabled by @option{-Wunused-variable} for
4904 C.  It warns only about unused static const variables defined in the main
4905 compilation unit, but not about static const variables declared in any
4906 header included.
4908 @item -Wunused-const-variable=2
4909 This warning level also warns for unused constant static variables in
4910 headers (excluding system headers).  This is the warning level of
4911 @option{-Wunused-const-variable} and must be explicitly requested since
4912 in C++ this isn't an error and in C it might be harder to clean up all
4913 headers included.
4914 @end table
4916 @item -Wunused-value
4917 @opindex Wunused-value
4918 @opindex Wno-unused-value
4919 Warn whenever a statement computes a result that is explicitly not
4920 used. To suppress this warning cast the unused expression to
4921 @code{void}. This includes an expression-statement or the left-hand
4922 side of a comma expression that contains no side effects. For example,
4923 an expression such as @code{x[i,j]} causes a warning, while
4924 @code{x[(void)i,j]} does not.
4926 This warning is enabled by @option{-Wall}.
4928 @item -Wunused
4929 @opindex Wunused
4930 @opindex Wno-unused
4931 All the above @option{-Wunused} options combined.
4933 In order to get a warning about an unused function parameter, you must
4934 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4935 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4937 @item -Wuninitialized
4938 @opindex Wuninitialized
4939 @opindex Wno-uninitialized
4940 Warn if an automatic variable is used without first being initialized
4941 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4942 warn if a non-static reference or non-static @code{const} member
4943 appears in a class without constructors.
4945 If you want to warn about code that uses the uninitialized value of the
4946 variable in its own initializer, use the @option{-Winit-self} option.
4948 These warnings occur for individual uninitialized or clobbered
4949 elements of structure, union or array variables as well as for
4950 variables that are uninitialized or clobbered as a whole.  They do
4951 not occur for variables or elements declared @code{volatile}.  Because
4952 these warnings depend on optimization, the exact variables or elements
4953 for which there are warnings depends on the precise optimization
4954 options and version of GCC used.
4956 Note that there may be no warning about a variable that is used only
4957 to compute a value that itself is never used, because such
4958 computations may be deleted by data flow analysis before the warnings
4959 are printed.
4961 @item -Winvalid-memory-model
4962 @opindex Winvalid-memory-model
4963 @opindex Wno-invalid-memory-model
4964 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4965 and the C11 atomic generic functions with a memory consistency argument
4966 that is either invalid for the operation or outside the range of values
4967 of the @code{memory_order} enumeration.  For example, since the
4968 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4969 defined for the relaxed, release, and sequentially consistent memory
4970 orders the following code is diagnosed:
4972 @smallexample
4973 void store (int *i)
4975   __atomic_store_n (i, 0, memory_order_consume);
4977 @end smallexample
4979 @option{-Winvalid-memory-model} is enabled by default.
4981 @item -Wmaybe-uninitialized
4982 @opindex Wmaybe-uninitialized
4983 @opindex Wno-maybe-uninitialized
4984 For an automatic (i.e.@ local) variable, if there exists a path from the
4985 function entry to a use of the variable that is initialized, but there exist
4986 some other paths for which the variable is not initialized, the compiler
4987 emits a warning if it cannot prove the uninitialized paths are not
4988 executed at run time.
4990 These warnings are only possible in optimizing compilation, because otherwise
4991 GCC does not keep track of the state of variables.
4993 These warnings are made optional because GCC may not be able to determine when
4994 the code is correct in spite of appearing to have an error.  Here is one
4995 example of how this can happen:
4997 @smallexample
4998 @group
5000   int x;
5001   switch (y)
5002     @{
5003     case 1: x = 1;
5004       break;
5005     case 2: x = 4;
5006       break;
5007     case 3: x = 5;
5008     @}
5009   foo (x);
5011 @end group
5012 @end smallexample
5014 @noindent
5015 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5016 always initialized, but GCC doesn't know this. To suppress the
5017 warning, you need to provide a default case with assert(0) or
5018 similar code.
5020 @cindex @code{longjmp} warnings
5021 This option also warns when a non-volatile automatic variable might be
5022 changed by a call to @code{longjmp}.
5023 The compiler sees only the calls to @code{setjmp}.  It cannot know
5024 where @code{longjmp} will be called; in fact, a signal handler could
5025 call it at any point in the code.  As a result, you may get a warning
5026 even when there is in fact no problem because @code{longjmp} cannot
5027 in fact be called at the place that would cause a problem.
5029 Some spurious warnings can be avoided if you declare all the functions
5030 you use that never return as @code{noreturn}.  @xref{Function
5031 Attributes}.
5033 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5035 @item -Wunknown-pragmas
5036 @opindex Wunknown-pragmas
5037 @opindex Wno-unknown-pragmas
5038 @cindex warning for unknown pragmas
5039 @cindex unknown pragmas, warning
5040 @cindex pragmas, warning of unknown
5041 Warn when a @code{#pragma} directive is encountered that is not understood by 
5042 GCC@.  If this command-line option is used, warnings are even issued
5043 for unknown pragmas in system header files.  This is not the case if
5044 the warnings are only enabled by the @option{-Wall} command-line option.
5046 @item -Wno-pragmas
5047 @opindex Wno-pragmas
5048 @opindex Wpragmas
5049 Do not warn about misuses of pragmas, such as incorrect parameters,
5050 invalid syntax, or conflicts between pragmas.  See also
5051 @option{-Wunknown-pragmas}.
5053 @item -Wstrict-aliasing
5054 @opindex Wstrict-aliasing
5055 @opindex Wno-strict-aliasing
5056 This option is only active when @option{-fstrict-aliasing} is active.
5057 It warns about code that might break the strict aliasing rules that the
5058 compiler is using for optimization.  The warning does not catch all
5059 cases, but does attempt to catch the more common pitfalls.  It is
5060 included in @option{-Wall}.
5061 It is equivalent to @option{-Wstrict-aliasing=3}
5063 @item -Wstrict-aliasing=n
5064 @opindex Wstrict-aliasing=n
5065 This option is only active when @option{-fstrict-aliasing} is active.
5066 It warns about code that might break the strict aliasing rules that the
5067 compiler is using for optimization.
5068 Higher levels correspond to higher accuracy (fewer false positives).
5069 Higher levels also correspond to more effort, similar to the way @option{-O} 
5070 works.
5071 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5073 Level 1: Most aggressive, quick, least accurate.
5074 Possibly useful when higher levels
5075 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5076 false negatives.  However, it has many false positives.
5077 Warns for all pointer conversions between possibly incompatible types,
5078 even if never dereferenced.  Runs in the front end only.
5080 Level 2: Aggressive, quick, not too precise.
5081 May still have many false positives (not as many as level 1 though),
5082 and few false negatives (but possibly more than level 1).
5083 Unlike level 1, it only warns when an address is taken.  Warns about
5084 incomplete types.  Runs in the front end only.
5086 Level 3 (default for @option{-Wstrict-aliasing}):
5087 Should have very few false positives and few false
5088 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5089 Takes care of the common pun+dereference pattern in the front end:
5090 @code{*(int*)&some_float}.
5091 If optimization is enabled, it also runs in the back end, where it deals
5092 with multiple statement cases using flow-sensitive points-to information.
5093 Only warns when the converted pointer is dereferenced.
5094 Does not warn about incomplete types.
5096 @item -Wstrict-overflow
5097 @itemx -Wstrict-overflow=@var{n}
5098 @opindex Wstrict-overflow
5099 @opindex Wno-strict-overflow
5100 This option is only active when signed overflow is undefined.
5101 It warns about cases where the compiler optimizes based on the
5102 assumption that signed overflow does not occur.  Note that it does not
5103 warn about all cases where the code might overflow: it only warns
5104 about cases where the compiler implements some optimization.  Thus
5105 this warning depends on the optimization level.
5107 An optimization that assumes that signed overflow does not occur is
5108 perfectly safe if the values of the variables involved are such that
5109 overflow never does, in fact, occur.  Therefore this warning can
5110 easily give a false positive: a warning about code that is not
5111 actually a problem.  To help focus on important issues, several
5112 warning levels are defined.  No warnings are issued for the use of
5113 undefined signed overflow when estimating how many iterations a loop
5114 requires, in particular when determining whether a loop will be
5115 executed at all.
5117 @table @gcctabopt
5118 @item -Wstrict-overflow=1
5119 Warn about cases that are both questionable and easy to avoid.  For
5120 example the compiler simplifies
5121 @code{x + 1 > x} to @code{1}.  This level of
5122 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5123 are not, and must be explicitly requested.
5125 @item -Wstrict-overflow=2
5126 Also warn about other cases where a comparison is simplified to a
5127 constant.  For example: @code{abs (x) >= 0}.  This can only be
5128 simplified when signed integer overflow is undefined, because
5129 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5130 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5131 @option{-Wstrict-overflow=2}.
5133 @item -Wstrict-overflow=3
5134 Also warn about other cases where a comparison is simplified.  For
5135 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5137 @item -Wstrict-overflow=4
5138 Also warn about other simplifications not covered by the above cases.
5139 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5141 @item -Wstrict-overflow=5
5142 Also warn about cases where the compiler reduces the magnitude of a
5143 constant involved in a comparison.  For example: @code{x + 2 > y} is
5144 simplified to @code{x + 1 >= y}.  This is reported only at the
5145 highest warning level because this simplification applies to many
5146 comparisons, so this warning level gives a very large number of
5147 false positives.
5148 @end table
5150 @item -Wstringop-overflow
5151 @itemx -Wstringop-overflow=@var{type}
5152 @opindex Wstringop-overflow
5153 @opindex Wno-stringop-overflow
5154 Warn for calls to string manipulation functions such as @code{memcpy} and
5155 @code{strcpy} that are determined to overflow the destination buffer.  The
5156 optional argument is one greater than the type of Object Size Checking to
5157 perform to determine the size of the destination.  @xref{Object Size Checking}.
5158 The argument is meaningful only for functions that operate on character arrays
5159 but not for raw memory functions like @code{memcpy} which always make use
5160 of Object Size type-0.  The option also warns for calls that specify a size
5161 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5162 The option produces the best results with optimization enabled but can detect
5163 a small subset of simple buffer overflows even without optimization in
5164 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5165 correspond to the standard functions.  In any case, the option warns about
5166 just a subset of buffer overflows detected by the corresponding overflow
5167 checking built-ins.  For example, the option will issue a warning for
5168 the @code{strcpy} call below because it copies at least 5 characters
5169 (the string @code{"blue"} including the terminating NUL) into the buffer
5170 of size 4.
5172 @smallexample
5173 enum Color @{ blue, purple, yellow @};
5174 const char* f (enum Color clr)
5176   static char buf [4];
5177   const char *str;
5178   switch (clr)
5179     @{
5180       case blue: str = "blue"; break;
5181       case purple: str = "purple"; break;
5182       case yellow: str = "yellow"; break;
5183     @}
5185   return strcpy (buf, str);   // warning here
5187 @end smallexample
5189 Option @option{-Wstringop-overflow=2} is enabled by default.
5191 @table @gcctabopt
5192 @item -Wstringop-overflow
5193 @item -Wstringop-overflow=1
5194 @opindex Wstringop-overflow
5195 @opindex Wno-stringop-overflow
5196 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5197 to determine the sizes of destination objects.  This is the default setting
5198 of the option.  At this setting the option will not warn for writes past
5199 the end of subobjects of larger objects accessed by pointers unless the
5200 size of the largest surrounding object is known.  When the destination may
5201 be one of several objects it is assumed to be the largest one of them.  On
5202 Linux systems, when optimization is enabled at this setting the option warns
5203 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5204 a non-zero value.
5206 @item -Wstringop-overflow=2
5207 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5208 to determine the sizes of destination objects.  At this setting the option
5209 will warn about overflows when writing to members of the largest complete
5210 objects whose exact size is known.  It will, however, not warn for excessive
5211 writes to the same members of unknown objects referenced by pointers since
5212 they may point to arrays containing unknown numbers of elements.
5214 @item -Wstringop-overflow=3
5215 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5216 to determine the sizes of destination objects.  At this setting the option
5217 warns about overflowing the smallest object or data member.  This is the
5218 most restrictive setting of the option that may result in warnings for safe
5219 code.
5221 @item -Wstringop-overflow=4
5222 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5223 to determine the sizes of destination objects.  At this setting the option
5224 will warn about overflowing any data members, and when the destination is
5225 one of several objects it uses the size of the largest of them to decide
5226 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5227 setting of the option may result in warnings for benign code.
5228 @end table
5230 @item -Wstringop-truncation
5231 @opindex Wstringop-truncation
5232 @opindex Wno-stringop-truncation
5233 Warn for calls to bounded string manipulation functions such as @code{strncat},
5234 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5235 or leave the destination unchanged.
5237 In the following example, the call to @code{strncat} specifies a bound that
5238 is less than the length of the source string.  As a result, the copy of
5239 the source will be truncated and so the call is diagnosed.  To avoid the
5240 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5242 @smallexample
5243 void append (char *buf, size_t bufsize)
5245   strncat (buf, ".txt", 3);
5247 @end smallexample
5249 As another example, the following call to @code{strncpy} results in copying
5250 to @code{d} just the characters preceding the terminating NUL, without
5251 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5252 necessarily a NUL-terminated string is a common mistake, and so the call
5253 is diagnosed.  To avoid the warning when the result is not expected to be
5254 NUL-terminated, call @code{memcpy} instead.
5256 @smallexample
5257 void copy (char *d, const char *s)
5259   strncpy (d, s, strlen (s));
5261 @end smallexample
5263 In the following example, the call to @code{strncpy} specifies the size
5264 of the destination buffer as the bound.  If the length of the source
5265 string is equal to or greater than this size the result of the copy will
5266 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5267 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5268 element of the buffer to @code{NUL}.
5270 @smallexample
5271 void copy (const char *s)
5273   char buf[80];
5274   strncpy (buf, s, sizeof buf);
5275   @dots{}
5277 @end smallexample
5279 In situations where a character array is intended to store a sequence
5280 of bytes with no terminating @code{NUL} such an array may be annotated
5281 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5282 however, are not suitable arguments to functions that expect
5283 @code{NUL}-terminated strings.  To help detect accidental misuses of
5284 such arrays GCC issues warnings unless it can prove that the use is
5285 safe.  @xref{Common Variable Attributes}.
5287 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5288 @opindex Wsuggest-attribute=
5289 @opindex Wno-suggest-attribute=
5290 Warn for cases where adding an attribute may be beneficial. The
5291 attributes currently supported are listed below.
5293 @table @gcctabopt
5294 @item -Wsuggest-attribute=pure
5295 @itemx -Wsuggest-attribute=const
5296 @itemx -Wsuggest-attribute=noreturn
5297 @itemx -Wsuggest-attribute=malloc
5298 @opindex Wsuggest-attribute=pure
5299 @opindex Wno-suggest-attribute=pure
5300 @opindex Wsuggest-attribute=const
5301 @opindex Wno-suggest-attribute=const
5302 @opindex Wsuggest-attribute=noreturn
5303 @opindex Wno-suggest-attribute=noreturn
5304 @opindex Wsuggest-attribute=malloc
5305 @opindex Wno-suggest-attribute=malloc
5307 Warn about functions that might be candidates for attributes
5308 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5309 only warns for functions visible in other compilation units or (in the case of
5310 @code{pure} and @code{const}) if it cannot prove that the function returns
5311 normally. A function returns normally if it doesn't contain an infinite loop or
5312 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5313 requires option @option{-fipa-pure-const}, which is enabled by default at
5314 @option{-O} and higher.  Higher optimization levels improve the accuracy
5315 of the analysis.
5317 @item -Wsuggest-attribute=format
5318 @itemx -Wmissing-format-attribute
5319 @opindex Wsuggest-attribute=format
5320 @opindex Wmissing-format-attribute
5321 @opindex Wno-suggest-attribute=format
5322 @opindex Wno-missing-format-attribute
5323 @opindex Wformat
5324 @opindex Wno-format
5326 Warn about function pointers that might be candidates for @code{format}
5327 attributes.  Note these are only possible candidates, not absolute ones.
5328 GCC guesses that function pointers with @code{format} attributes that
5329 are used in assignment, initialization, parameter passing or return
5330 statements should have a corresponding @code{format} attribute in the
5331 resulting type.  I.e.@: the left-hand side of the assignment or
5332 initialization, the type of the parameter variable, or the return type
5333 of the containing function respectively should also have a @code{format}
5334 attribute to avoid the warning.
5336 GCC also warns about function definitions that might be
5337 candidates for @code{format} attributes.  Again, these are only
5338 possible candidates.  GCC guesses that @code{format} attributes
5339 might be appropriate for any function that calls a function like
5340 @code{vprintf} or @code{vscanf}, but this might not always be the
5341 case, and some functions for which @code{format} attributes are
5342 appropriate may not be detected.
5344 @item -Wsuggest-attribute=cold
5345 @opindex Wsuggest-attribute=cold
5346 @opindex Wno-suggest-attribute=cold
5348 Warn about functions that might be candidates for @code{cold} attribute.  This
5349 is based on static detection and generally will only warn about functions which
5350 always leads to a call to another @code{cold} function such as wrappers of
5351 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5352 @end table
5354 @item -Wsuggest-final-types
5355 @opindex Wno-suggest-final-types
5356 @opindex Wsuggest-final-types
5357 Warn about types with virtual methods where code quality would be improved
5358 if the type were declared with the C++11 @code{final} specifier, 
5359 or, if possible,
5360 declared in an anonymous namespace. This allows GCC to more aggressively
5361 devirtualize the polymorphic calls. This warning is more effective with link
5362 time optimization, where the information about the class hierarchy graph is
5363 more complete.
5365 @item -Wsuggest-final-methods
5366 @opindex Wno-suggest-final-methods
5367 @opindex Wsuggest-final-methods
5368 Warn about virtual methods where code quality would be improved if the method
5369 were declared with the C++11 @code{final} specifier, 
5370 or, if possible, its type were
5371 declared in an anonymous namespace or with the @code{final} specifier.
5372 This warning is
5373 more effective with link-time optimization, where the information about the
5374 class hierarchy graph is more complete. It is recommended to first consider
5375 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5376 annotations.
5378 @item -Wsuggest-override
5379 Warn about overriding virtual functions that are not marked with the override
5380 keyword.
5382 @item -Walloc-zero
5383 @opindex Wno-alloc-zero
5384 @opindex Walloc-zero
5385 Warn about calls to allocation functions decorated with attribute
5386 @code{alloc_size} that specify zero bytes, including those to the built-in
5387 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5388 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5389 when called with a zero size differs among implementations (and in the case
5390 of @code{realloc} has been deprecated) relying on it may result in subtle
5391 portability bugs and should be avoided.
5393 @item -Walloc-size-larger-than=@var{n}
5394 Warn about calls to functions decorated with attribute @code{alloc_size}
5395 that attempt to allocate objects larger than the specified number of bytes,
5396 or where the result of the size computation in an integer type with infinite
5397 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5398 may end in one of the standard suffixes designating a multiple of bytes
5399 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5400 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5401 @xref{Function Attributes}.
5403 @item -Walloca
5404 @opindex Wno-alloca
5405 @opindex Walloca
5406 This option warns on all uses of @code{alloca} in the source.
5408 @item -Walloca-larger-than=@var{n}
5409 This option warns on calls to @code{alloca} that are not bounded by a
5410 controlling predicate limiting its argument of integer type to at most
5411 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5412 Arguments of non-integer types are considered unbounded even if they
5413 appear to be constrained to the expected range.
5415 For example, a bounded case of @code{alloca} could be:
5417 @smallexample
5418 void func (size_t n)
5420   void *p;
5421   if (n <= 1000)
5422     p = alloca (n);
5423   else
5424     p = malloc (n);
5425   f (p);
5427 @end smallexample
5429 In the above example, passing @code{-Walloca-larger-than=1000} would not
5430 issue a warning because the call to @code{alloca} is known to be at most
5431 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5432 the compiler would emit a warning.
5434 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5435 controlling predicate constraining its integer argument.  For example:
5437 @smallexample
5438 void func ()
5440   void *p = alloca (n);
5441   f (p);
5443 @end smallexample
5445 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5446 a warning, but this time because of the lack of bounds checking.
5448 Note, that even seemingly correct code involving signed integers could
5449 cause a warning:
5451 @smallexample
5452 void func (signed int n)
5454   if (n < 500)
5455     @{
5456       p = alloca (n);
5457       f (p);
5458     @}
5460 @end smallexample
5462 In the above example, @var{n} could be negative, causing a larger than
5463 expected argument to be implicitly cast into the @code{alloca} call.
5465 This option also warns when @code{alloca} is used in a loop.
5467 This warning is not enabled by @option{-Wall}, and is only active when
5468 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5470 See also @option{-Wvla-larger-than=@var{n}}.
5472 @item -Warray-bounds
5473 @itemx -Warray-bounds=@var{n}
5474 @opindex Wno-array-bounds
5475 @opindex Warray-bounds
5476 This option is only active when @option{-ftree-vrp} is active
5477 (default for @option{-O2} and above). It warns about subscripts to arrays
5478 that are always out of bounds. This warning is enabled by @option{-Wall}.
5480 @table @gcctabopt
5481 @item -Warray-bounds=1
5482 This is the warning level of @option{-Warray-bounds} and is enabled
5483 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5485 @item -Warray-bounds=2
5486 This warning level also warns about out of bounds access for
5487 arrays at the end of a struct and for arrays accessed through
5488 pointers. This warning level may give a larger number of
5489 false positives and is deactivated by default.
5490 @end table
5492 @item -Wattribute-alias
5493 Warn about declarations using the @code{alias} and similar attributes whose
5494 target is incompatible with the type of the alias.  @xref{Function Attributes,
5495 ,Declaring Attributes of Functions}.
5497 @item -Wbool-compare
5498 @opindex Wno-bool-compare
5499 @opindex Wbool-compare
5500 Warn about boolean expression compared with an integer value different from
5501 @code{true}/@code{false}.  For instance, the following comparison is
5502 always false:
5503 @smallexample
5504 int n = 5;
5505 @dots{}
5506 if ((n > 1) == 2) @{ @dots{} @}
5507 @end smallexample
5508 This warning is enabled by @option{-Wall}.
5510 @item -Wbool-operation
5511 @opindex Wno-bool-operation
5512 @opindex Wbool-operation
5513 Warn about suspicious operations on expressions of a boolean type.  For
5514 instance, bitwise negation of a boolean is very likely a bug in the program.
5515 For C, this warning also warns about incrementing or decrementing a boolean,
5516 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5517 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5519 This warning is enabled by @option{-Wall}.
5521 @item -Wduplicated-branches
5522 @opindex Wno-duplicated-branches
5523 @opindex Wduplicated-branches
5524 Warn when an if-else has identical branches.  This warning detects cases like
5525 @smallexample
5526 if (p != NULL)
5527   return 0;
5528 else
5529   return 0;
5530 @end smallexample
5531 It doesn't warn when both branches contain just a null statement.  This warning
5532 also warn for conditional operators:
5533 @smallexample
5534   int i = x ? *p : *p;
5535 @end smallexample
5537 @item -Wduplicated-cond
5538 @opindex Wno-duplicated-cond
5539 @opindex Wduplicated-cond
5540 Warn about duplicated conditions in an if-else-if chain.  For instance,
5541 warn for the following code:
5542 @smallexample
5543 if (p->q != NULL) @{ @dots{} @}
5544 else if (p->q != NULL) @{ @dots{} @}
5545 @end smallexample
5547 @item -Wframe-address
5548 @opindex Wno-frame-address
5549 @opindex Wframe-address
5550 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5551 is called with an argument greater than 0.  Such calls may return indeterminate
5552 values or crash the program.  The warning is included in @option{-Wall}.
5554 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5555 @opindex Wno-discarded-qualifiers
5556 @opindex Wdiscarded-qualifiers
5557 Do not warn if type qualifiers on pointers are being discarded.
5558 Typically, the compiler warns if a @code{const char *} variable is
5559 passed to a function that takes a @code{char *} parameter.  This option
5560 can be used to suppress such a warning.
5562 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5563 @opindex Wno-discarded-array-qualifiers
5564 @opindex Wdiscarded-array-qualifiers
5565 Do not warn if type qualifiers on arrays which are pointer targets
5566 are being discarded. Typically, the compiler warns if a
5567 @code{const int (*)[]} variable is passed to a function that
5568 takes a @code{int (*)[]} parameter.  This option can be used to
5569 suppress such a warning.
5571 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5572 @opindex Wno-incompatible-pointer-types
5573 @opindex Wincompatible-pointer-types
5574 Do not warn when there is a conversion between pointers that have incompatible
5575 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5576 which warns for pointer argument passing or assignment with different
5577 signedness.
5579 @item -Wno-int-conversion @r{(C and Objective-C only)}
5580 @opindex Wno-int-conversion
5581 @opindex Wint-conversion
5582 Do not warn about incompatible integer to pointer and pointer to integer
5583 conversions.  This warning is about implicit conversions; for explicit
5584 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5585 @option{-Wno-pointer-to-int-cast} may be used.
5587 @item -Wno-div-by-zero
5588 @opindex Wno-div-by-zero
5589 @opindex Wdiv-by-zero
5590 Do not warn about compile-time integer division by zero.  Floating-point
5591 division by zero is not warned about, as it can be a legitimate way of
5592 obtaining infinities and NaNs.
5594 @item -Wsystem-headers
5595 @opindex Wsystem-headers
5596 @opindex Wno-system-headers
5597 @cindex warnings from system headers
5598 @cindex system headers, warnings from
5599 Print warning messages for constructs found in system header files.
5600 Warnings from system headers are normally suppressed, on the assumption
5601 that they usually do not indicate real problems and would only make the
5602 compiler output harder to read.  Using this command-line option tells
5603 GCC to emit warnings from system headers as if they occurred in user
5604 code.  However, note that using @option{-Wall} in conjunction with this
5605 option does @emph{not} warn about unknown pragmas in system
5606 headers---for that, @option{-Wunknown-pragmas} must also be used.
5608 @item -Wtautological-compare
5609 @opindex Wtautological-compare
5610 @opindex Wno-tautological-compare
5611 Warn if a self-comparison always evaluates to true or false.  This
5612 warning detects various mistakes such as:
5613 @smallexample
5614 int i = 1;
5615 @dots{}
5616 if (i > i) @{ @dots{} @}
5617 @end smallexample
5619 This warning also warns about bitwise comparisons that always evaluate
5620 to true or false, for instance:
5621 @smallexample
5622 if ((a & 16) == 10) @{ @dots{} @}
5623 @end smallexample
5624 will always be false.
5626 This warning is enabled by @option{-Wall}.
5628 @item -Wtrampolines
5629 @opindex Wtrampolines
5630 @opindex Wno-trampolines
5631 Warn about trampolines generated for pointers to nested functions.
5632 A trampoline is a small piece of data or code that is created at run
5633 time on the stack when the address of a nested function is taken, and is
5634 used to call the nested function indirectly.  For some targets, it is
5635 made up of data only and thus requires no special treatment.  But, for
5636 most targets, it is made up of code and thus requires the stack to be
5637 made executable in order for the program to work properly.
5639 @item -Wfloat-equal
5640 @opindex Wfloat-equal
5641 @opindex Wno-float-equal
5642 Warn if floating-point values are used in equality comparisons.
5644 The idea behind this is that sometimes it is convenient (for the
5645 programmer) to consider floating-point values as approximations to
5646 infinitely precise real numbers.  If you are doing this, then you need
5647 to compute (by analyzing the code, or in some other way) the maximum or
5648 likely maximum error that the computation introduces, and allow for it
5649 when performing comparisons (and when producing output, but that's a
5650 different problem).  In particular, instead of testing for equality, you
5651 should check to see whether the two values have ranges that overlap; and
5652 this is done with the relational operators, so equality comparisons are
5653 probably mistaken.
5655 @item -Wtraditional @r{(C and Objective-C only)}
5656 @opindex Wtraditional
5657 @opindex Wno-traditional
5658 Warn about certain constructs that behave differently in traditional and
5659 ISO C@.  Also warn about ISO C constructs that have no traditional C
5660 equivalent, and/or problematic constructs that should be avoided.
5662 @itemize @bullet
5663 @item
5664 Macro parameters that appear within string literals in the macro body.
5665 In traditional C macro replacement takes place within string literals,
5666 but in ISO C it does not.
5668 @item
5669 In traditional C, some preprocessor directives did not exist.
5670 Traditional preprocessors only considered a line to be a directive
5671 if the @samp{#} appeared in column 1 on the line.  Therefore
5672 @option{-Wtraditional} warns about directives that traditional C
5673 understands but ignores because the @samp{#} does not appear as the
5674 first character on the line.  It also suggests you hide directives like
5675 @code{#pragma} not understood by traditional C by indenting them.  Some
5676 traditional implementations do not recognize @code{#elif}, so this option
5677 suggests avoiding it altogether.
5679 @item
5680 A function-like macro that appears without arguments.
5682 @item
5683 The unary plus operator.
5685 @item
5686 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5687 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5688 constants.)  Note, these suffixes appear in macros defined in the system
5689 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5690 Use of these macros in user code might normally lead to spurious
5691 warnings, however GCC's integrated preprocessor has enough context to
5692 avoid warning in these cases.
5694 @item
5695 A function declared external in one block and then used after the end of
5696 the block.
5698 @item
5699 A @code{switch} statement has an operand of type @code{long}.
5701 @item
5702 A non-@code{static} function declaration follows a @code{static} one.
5703 This construct is not accepted by some traditional C compilers.
5705 @item
5706 The ISO type of an integer constant has a different width or
5707 signedness from its traditional type.  This warning is only issued if
5708 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5709 typically represent bit patterns, are not warned about.
5711 @item
5712 Usage of ISO string concatenation is detected.
5714 @item
5715 Initialization of automatic aggregates.
5717 @item
5718 Identifier conflicts with labels.  Traditional C lacks a separate
5719 namespace for labels.
5721 @item
5722 Initialization of unions.  If the initializer is zero, the warning is
5723 omitted.  This is done under the assumption that the zero initializer in
5724 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5725 initializer warnings and relies on default initialization to zero in the
5726 traditional C case.
5728 @item
5729 Conversions by prototypes between fixed/floating-point values and vice
5730 versa.  The absence of these prototypes when compiling with traditional
5731 C causes serious problems.  This is a subset of the possible
5732 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5734 @item
5735 Use of ISO C style function definitions.  This warning intentionally is
5736 @emph{not} issued for prototype declarations or variadic functions
5737 because these ISO C features appear in your code when using
5738 libiberty's traditional C compatibility macros, @code{PARAMS} and
5739 @code{VPARAMS}.  This warning is also bypassed for nested functions
5740 because that feature is already a GCC extension and thus not relevant to
5741 traditional C compatibility.
5742 @end itemize
5744 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5745 @opindex Wtraditional-conversion
5746 @opindex Wno-traditional-conversion
5747 Warn if a prototype causes a type conversion that is different from what
5748 would happen to the same argument in the absence of a prototype.  This
5749 includes conversions of fixed point to floating and vice versa, and
5750 conversions changing the width or signedness of a fixed-point argument
5751 except when the same as the default promotion.
5753 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5754 @opindex Wdeclaration-after-statement
5755 @opindex Wno-declaration-after-statement
5756 Warn when a declaration is found after a statement in a block.  This
5757 construct, known from C++, was introduced with ISO C99 and is by default
5758 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5760 @item -Wshadow
5761 @opindex Wshadow
5762 @opindex Wno-shadow
5763 Warn whenever a local variable or type declaration shadows another
5764 variable, parameter, type, class member (in C++), or instance variable
5765 (in Objective-C) or whenever a built-in function is shadowed. Note
5766 that in C++, the compiler warns if a local variable shadows an
5767 explicit typedef, but not if it shadows a struct/class/enum.
5768 Same as @option{-Wshadow=global}.
5770 @item -Wno-shadow-ivar @r{(Objective-C only)}
5771 @opindex Wno-shadow-ivar
5772 @opindex Wshadow-ivar
5773 Do not warn whenever a local variable shadows an instance variable in an
5774 Objective-C method.
5776 @item -Wshadow=global
5777 @opindex Wshadow=local
5778 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5780 @item -Wshadow=local
5781 @opindex Wshadow=local
5782 Warn when a local variable shadows another local variable or parameter.
5783 This warning is enabled by @option{-Wshadow=global}.
5785 @item -Wshadow=compatible-local
5786 @opindex Wshadow=compatible-local
5787 Warn when a local variable shadows another local variable or parameter
5788 whose type is compatible with that of the shadowing variable. In C++,
5789 type compatibility here means the type of the shadowing variable can be
5790 converted to that of the shadowed variable. The creation of this flag
5791 (in addition to @option{-Wshadow=local}) is based on the idea that when
5792 a local variable shadows another one of incompatible type, it is most
5793 likely intentional, not a bug or typo, as shown in the following example:
5795 @smallexample
5796 @group
5797 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5799   for (int i = 0; i < N; ++i)
5800   @{
5801     ...
5802   @}
5803   ...
5805 @end group
5806 @end smallexample
5808 Since the two variable @code{i} in the example above have incompatible types,
5809 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5810 Because their types are incompatible, if a programmer accidentally uses one
5811 in place of the other, type checking will catch that and emit an error or
5812 warning. So not warning (about shadowing) in this case will not lead to
5813 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5814 possibly reduce the number of warnings triggered by intentional shadowing.
5816 This warning is enabled by @option{-Wshadow=local}.
5818 @item -Wlarger-than=@var{len}
5819 @opindex Wlarger-than=@var{len}
5820 @opindex Wlarger-than-@var{len}
5821 Warn whenever an object of larger than @var{len} bytes is defined.
5823 @item -Wframe-larger-than=@var{len}
5824 @opindex Wframe-larger-than
5825 Warn if the size of a function frame is larger than @var{len} bytes.
5826 The computation done to determine the stack frame size is approximate
5827 and not conservative.
5828 The actual requirements may be somewhat greater than @var{len}
5829 even if you do not get a warning.  In addition, any space allocated
5830 via @code{alloca}, variable-length arrays, or related constructs
5831 is not included by the compiler when determining
5832 whether or not to issue a warning.
5834 @item -Wno-free-nonheap-object
5835 @opindex Wno-free-nonheap-object
5836 @opindex Wfree-nonheap-object
5837 Do not warn when attempting to free an object that was not allocated
5838 on the heap.
5840 @item -Wstack-usage=@var{len}
5841 @opindex Wstack-usage
5842 Warn if the stack usage of a function might be larger than @var{len} bytes.
5843 The computation done to determine the stack usage is conservative.
5844 Any space allocated via @code{alloca}, variable-length arrays, or related
5845 constructs is included by the compiler when determining whether or not to
5846 issue a warning.
5848 The message is in keeping with the output of @option{-fstack-usage}.
5850 @itemize
5851 @item
5852 If the stack usage is fully static but exceeds the specified amount, it's:
5854 @smallexample
5855   warning: stack usage is 1120 bytes
5856 @end smallexample
5857 @item
5858 If the stack usage is (partly) dynamic but bounded, it's:
5860 @smallexample
5861   warning: stack usage might be 1648 bytes
5862 @end smallexample
5863 @item
5864 If the stack usage is (partly) dynamic and not bounded, it's:
5866 @smallexample
5867   warning: stack usage might be unbounded
5868 @end smallexample
5869 @end itemize
5871 @item -Wunsafe-loop-optimizations
5872 @opindex Wunsafe-loop-optimizations
5873 @opindex Wno-unsafe-loop-optimizations
5874 Warn if the loop cannot be optimized because the compiler cannot
5875 assume anything on the bounds of the loop indices.  With
5876 @option{-funsafe-loop-optimizations} warn if the compiler makes
5877 such assumptions.
5879 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5880 @opindex Wno-pedantic-ms-format
5881 @opindex Wpedantic-ms-format
5882 When used in combination with @option{-Wformat}
5883 and @option{-pedantic} without GNU extensions, this option
5884 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5885 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5886 which depend on the MS runtime.
5888 @item -Waligned-new
5889 @opindex Waligned-new
5890 @opindex Wno-aligned-new
5891 Warn about a new-expression of a type that requires greater alignment
5892 than the @code{alignof(std::max_align_t)} but uses an allocation
5893 function without an explicit alignment parameter. This option is
5894 enabled by @option{-Wall}.
5896 Normally this only warns about global allocation functions, but
5897 @option{-Waligned-new=all} also warns about class member allocation
5898 functions.
5900 @item -Wplacement-new
5901 @itemx -Wplacement-new=@var{n}
5902 @opindex Wplacement-new
5903 @opindex Wno-placement-new
5904 Warn about placement new expressions with undefined behavior, such as
5905 constructing an object in a buffer that is smaller than the type of
5906 the object.  For example, the placement new expression below is diagnosed
5907 because it attempts to construct an array of 64 integers in a buffer only
5908 64 bytes large.
5909 @smallexample
5910 char buf [64];
5911 new (buf) int[64];
5912 @end smallexample
5913 This warning is enabled by default.
5915 @table @gcctabopt
5916 @item -Wplacement-new=1
5917 This is the default warning level of @option{-Wplacement-new}.  At this
5918 level the warning is not issued for some strictly undefined constructs that
5919 GCC allows as extensions for compatibility with legacy code.  For example,
5920 the following @code{new} expression is not diagnosed at this level even
5921 though it has undefined behavior according to the C++ standard because
5922 it writes past the end of the one-element array.
5923 @smallexample
5924 struct S @{ int n, a[1]; @};
5925 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5926 new (s->a)int [32]();
5927 @end smallexample
5929 @item -Wplacement-new=2
5930 At this level, in addition to diagnosing all the same constructs as at level
5931 1, a diagnostic is also issued for placement new expressions that construct
5932 an object in the last member of structure whose type is an array of a single
5933 element and whose size is less than the size of the object being constructed.
5934 While the previous example would be diagnosed, the following construct makes
5935 use of the flexible member array extension to avoid the warning at level 2.
5936 @smallexample
5937 struct S @{ int n, a[]; @};
5938 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5939 new (s->a)int [32]();
5940 @end smallexample
5942 @end table
5944 @item -Wpointer-arith
5945 @opindex Wpointer-arith
5946 @opindex Wno-pointer-arith
5947 Warn about anything that depends on the ``size of'' a function type or
5948 of @code{void}.  GNU C assigns these types a size of 1, for
5949 convenience in calculations with @code{void *} pointers and pointers
5950 to functions.  In C++, warn also when an arithmetic operation involves
5951 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5953 @item -Wpointer-compare
5954 @opindex Wpointer-compare
5955 @opindex Wno-pointer-compare
5956 Warn if a pointer is compared with a zero character constant.  This usually
5957 means that the pointer was meant to be dereferenced.  For example:
5959 @smallexample
5960 const char *p = foo ();
5961 if (p == '\0')
5962   return 42;
5963 @end smallexample
5965 Note that the code above is invalid in C++11.
5967 This warning is enabled by default.
5969 @item -Wtype-limits
5970 @opindex Wtype-limits
5971 @opindex Wno-type-limits
5972 Warn if a comparison is always true or always false due to the limited
5973 range of the data type, but do not warn for constant expressions.  For
5974 example, warn if an unsigned variable is compared against zero with
5975 @code{<} or @code{>=}.  This warning is also enabled by
5976 @option{-Wextra}.
5978 @include cppwarnopts.texi
5980 @item -Wbad-function-cast @r{(C and Objective-C only)}
5981 @opindex Wbad-function-cast
5982 @opindex Wno-bad-function-cast
5983 Warn when a function call is cast to a non-matching type.
5984 For example, warn if a call to a function returning an integer type 
5985 is cast to a pointer type.
5987 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5988 @opindex Wc90-c99-compat
5989 @opindex Wno-c90-c99-compat
5990 Warn about features not present in ISO C90, but present in ISO C99.
5991 For instance, warn about use of variable length arrays, @code{long long}
5992 type, @code{bool} type, compound literals, designated initializers, and so
5993 on.  This option is independent of the standards mode.  Warnings are disabled
5994 in the expression that follows @code{__extension__}.
5996 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5997 @opindex Wc99-c11-compat
5998 @opindex Wno-c99-c11-compat
5999 Warn about features not present in ISO C99, but present in ISO C11.
6000 For instance, warn about use of anonymous structures and unions,
6001 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6002 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6003 and so on.  This option is independent of the standards mode.  Warnings are
6004 disabled in the expression that follows @code{__extension__}.
6006 @item -Wc++-compat @r{(C and Objective-C only)}
6007 @opindex Wc++-compat
6008 Warn about ISO C constructs that are outside of the common subset of
6009 ISO C and ISO C++, e.g.@: request for implicit conversion from
6010 @code{void *} to a pointer to non-@code{void} type.
6012 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6013 @opindex Wc++11-compat
6014 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6015 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6016 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6017 enabled by @option{-Wall}.
6019 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6020 @opindex Wc++14-compat
6021 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6022 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6024 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6025 @opindex Wc++17-compat
6026 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6027 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6029 @item -Wcast-qual
6030 @opindex Wcast-qual
6031 @opindex Wno-cast-qual
6032 Warn whenever a pointer is cast so as to remove a type qualifier from
6033 the target type.  For example, warn if a @code{const char *} is cast
6034 to an ordinary @code{char *}.
6036 Also warn when making a cast that introduces a type qualifier in an
6037 unsafe way.  For example, casting @code{char **} to @code{const char **}
6038 is unsafe, as in this example:
6040 @smallexample
6041   /* p is char ** value.  */
6042   const char **q = (const char **) p;
6043   /* Assignment of readonly string to const char * is OK.  */
6044   *q = "string";
6045   /* Now char** pointer points to read-only memory.  */
6046   **p = 'b';
6047 @end smallexample
6049 @item -Wcast-align
6050 @opindex Wcast-align
6051 @opindex Wno-cast-align
6052 Warn whenever a pointer is cast such that the required alignment of the
6053 target is increased.  For example, warn if a @code{char *} is cast to
6054 an @code{int *} on machines where integers can only be accessed at
6055 two- or four-byte boundaries.
6057 @item -Wcast-align=strict
6058 @opindex Wcast-align=strict
6059 Warn whenever a pointer is cast such that the required alignment of the
6060 target is increased.  For example, warn if a @code{char *} is cast to
6061 an @code{int *} regardless of the target machine.
6063 @item -Wcast-function-type
6064 @opindex Wcast-function-type
6065 @opindex Wno-cast-function-type
6066 Warn when a function pointer is cast to an incompatible function pointer.
6067 In a cast involving function types with a variable argument list only
6068 the types of initial arguments that are provided are considered.
6069 Any parameter of pointer-type matches any other pointer-type.  Any benign
6070 differences in integral types are ignored, like @code{int} vs. @code{long}
6071 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6072 type @code{void (*) (void)} is special and matches everything, which can
6073 be used to suppress this warning.
6074 In a cast involving pointer to member types this warning warns whenever
6075 the type cast is changing the pointer to member type.
6076 This warning is enabled by @option{-Wextra}.
6078 @item -Wwrite-strings
6079 @opindex Wwrite-strings
6080 @opindex Wno-write-strings
6081 When compiling C, give string constants the type @code{const
6082 char[@var{length}]} so that copying the address of one into a
6083 non-@code{const} @code{char *} pointer produces a warning.  These
6084 warnings help you find at compile time code that can try to write
6085 into a string constant, but only if you have been very careful about
6086 using @code{const} in declarations and prototypes.  Otherwise, it is
6087 just a nuisance. This is why we did not make @option{-Wall} request
6088 these warnings.
6090 When compiling C++, warn about the deprecated conversion from string
6091 literals to @code{char *}.  This warning is enabled by default for C++
6092 programs.
6094 @item -Wcatch-value
6095 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6096 @opindex Wcatch-value
6097 @opindex Wno-catch-value
6098 Warn about catch handlers that do not catch via reference.
6099 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6100 warn about polymorphic class types that are caught by value.
6101 With @option{-Wcatch-value=2} warn about all class types that are caught
6102 by value. With @option{-Wcatch-value=3} warn about all types that are
6103 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6105 @item -Wclobbered
6106 @opindex Wclobbered
6107 @opindex Wno-clobbered
6108 Warn for variables that might be changed by @code{longjmp} or
6109 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6111 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6112 @opindex Wconditionally-supported
6113 @opindex Wno-conditionally-supported
6114 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6116 @item -Wconversion
6117 @opindex Wconversion
6118 @opindex Wno-conversion
6119 Warn for implicit conversions that may alter a value. This includes
6120 conversions between real and integer, like @code{abs (x)} when
6121 @code{x} is @code{double}; conversions between signed and unsigned,
6122 like @code{unsigned ui = -1}; and conversions to smaller types, like
6123 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6124 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6125 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6126 conversions between signed and unsigned integers can be disabled by
6127 using @option{-Wno-sign-conversion}.
6129 For C++, also warn for confusing overload resolution for user-defined
6130 conversions; and conversions that never use a type conversion
6131 operator: conversions to @code{void}, the same type, a base class or a
6132 reference to them. Warnings about conversions between signed and
6133 unsigned integers are disabled by default in C++ unless
6134 @option{-Wsign-conversion} is explicitly enabled.
6136 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6137 @opindex Wconversion-null
6138 @opindex Wno-conversion-null
6139 Do not warn for conversions between @code{NULL} and non-pointer
6140 types. @option{-Wconversion-null} is enabled by default.
6142 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6143 @opindex Wzero-as-null-pointer-constant
6144 @opindex Wno-zero-as-null-pointer-constant
6145 Warn when a literal @samp{0} is used as null pointer constant.  This can
6146 be useful to facilitate the conversion to @code{nullptr} in C++11.
6148 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6149 @opindex Wsubobject-linkage
6150 @opindex Wno-subobject-linkage
6151 Warn if a class type has a base or a field whose type uses the anonymous
6152 namespace or depends on a type with no linkage.  If a type A depends on
6153 a type B with no or internal linkage, defining it in multiple
6154 translation units would be an ODR violation because the meaning of B
6155 is different in each translation unit.  If A only appears in a single
6156 translation unit, the best way to silence the warning is to give it
6157 internal linkage by putting it in an anonymous namespace as well.  The
6158 compiler doesn't give this warning for types defined in the main .C
6159 file, as those are unlikely to have multiple definitions.
6160 @option{-Wsubobject-linkage} is enabled by default.
6162 @item -Wdangling-else
6163 @opindex Wdangling-else
6164 @opindex Wno-dangling-else
6165 Warn about constructions where there may be confusion to which
6166 @code{if} statement an @code{else} branch belongs.  Here is an example of
6167 such a case:
6169 @smallexample
6170 @group
6172   if (a)
6173     if (b)
6174       foo ();
6175   else
6176     bar ();
6178 @end group
6179 @end smallexample
6181 In C/C++, every @code{else} branch belongs to the innermost possible
6182 @code{if} statement, which in this example is @code{if (b)}.  This is
6183 often not what the programmer expected, as illustrated in the above
6184 example by indentation the programmer chose.  When there is the
6185 potential for this confusion, GCC issues a warning when this flag
6186 is specified.  To eliminate the warning, add explicit braces around
6187 the innermost @code{if} statement so there is no way the @code{else}
6188 can belong to the enclosing @code{if}.  The resulting code
6189 looks like this:
6191 @smallexample
6192 @group
6194   if (a)
6195     @{
6196       if (b)
6197         foo ();
6198       else
6199         bar ();
6200     @}
6202 @end group
6203 @end smallexample
6205 This warning is enabled by @option{-Wparentheses}.
6207 @item -Wdate-time
6208 @opindex Wdate-time
6209 @opindex Wno-date-time
6210 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6211 are encountered as they might prevent bit-wise-identical reproducible
6212 compilations.
6214 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6215 @opindex Wdelete-incomplete
6216 @opindex Wno-delete-incomplete
6217 Warn when deleting a pointer to incomplete type, which may cause
6218 undefined behavior at runtime.  This warning is enabled by default.
6220 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6221 @opindex Wuseless-cast
6222 @opindex Wno-useless-cast
6223 Warn when an expression is casted to its own type.
6225 @item -Wempty-body
6226 @opindex Wempty-body
6227 @opindex Wno-empty-body
6228 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6229 while} statement.  This warning is also enabled by @option{-Wextra}.
6231 @item -Wenum-compare
6232 @opindex Wenum-compare
6233 @opindex Wno-enum-compare
6234 Warn about a comparison between values of different enumerated types.
6235 In C++ enumerated type mismatches in conditional expressions are also
6236 diagnosed and the warning is enabled by default.  In C this warning is 
6237 enabled by @option{-Wall}.
6239 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6240 @opindex Wextra-semi
6241 @opindex Wno-extra-semi
6242 Warn about redundant semicolon after in-class function definition.
6244 @item -Wjump-misses-init @r{(C, Objective-C only)}
6245 @opindex Wjump-misses-init
6246 @opindex Wno-jump-misses-init
6247 Warn if a @code{goto} statement or a @code{switch} statement jumps
6248 forward across the initialization of a variable, or jumps backward to a
6249 label after the variable has been initialized.  This only warns about
6250 variables that are initialized when they are declared.  This warning is
6251 only supported for C and Objective-C; in C++ this sort of branch is an
6252 error in any case.
6254 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6255 can be disabled with the @option{-Wno-jump-misses-init} option.
6257 @item -Wsign-compare
6258 @opindex Wsign-compare
6259 @opindex Wno-sign-compare
6260 @cindex warning for comparison of signed and unsigned values
6261 @cindex comparison of signed and unsigned values, warning
6262 @cindex signed and unsigned values, comparison warning
6263 Warn when a comparison between signed and unsigned values could produce
6264 an incorrect result when the signed value is converted to unsigned.
6265 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6266 also enabled by @option{-Wextra}.
6268 @item -Wsign-conversion
6269 @opindex Wsign-conversion
6270 @opindex Wno-sign-conversion
6271 Warn for implicit conversions that may change the sign of an integer
6272 value, like assigning a signed integer expression to an unsigned
6273 integer variable. An explicit cast silences the warning. In C, this
6274 option is enabled also by @option{-Wconversion}.
6276 @item -Wfloat-conversion
6277 @opindex Wfloat-conversion
6278 @opindex Wno-float-conversion
6279 Warn for implicit conversions that reduce the precision of a real value.
6280 This includes conversions from real to integer, and from higher precision
6281 real to lower precision real values.  This option is also enabled by
6282 @option{-Wconversion}.
6284 @item -Wno-scalar-storage-order
6285 @opindex -Wno-scalar-storage-order
6286 @opindex -Wscalar-storage-order
6287 Do not warn on suspicious constructs involving reverse scalar storage order.
6289 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6290 @opindex Wsized-deallocation
6291 @opindex Wno-sized-deallocation
6292 Warn about a definition of an unsized deallocation function
6293 @smallexample
6294 void operator delete (void *) noexcept;
6295 void operator delete[] (void *) noexcept;
6296 @end smallexample
6297 without a definition of the corresponding sized deallocation function
6298 @smallexample
6299 void operator delete (void *, std::size_t) noexcept;
6300 void operator delete[] (void *, std::size_t) noexcept;
6301 @end smallexample
6302 or vice versa.  Enabled by @option{-Wextra} along with
6303 @option{-fsized-deallocation}.
6305 @item -Wsizeof-pointer-div
6306 @opindex Wsizeof-pointer-div
6307 @opindex Wno-sizeof-pointer-div
6308 Warn for suspicious divisions of two sizeof expressions that divide
6309 the pointer size by the element size, which is the usual way to compute
6310 the array size but won't work out correctly with pointers.  This warning
6311 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6312 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6314 @item -Wsizeof-pointer-memaccess
6315 @opindex Wsizeof-pointer-memaccess
6316 @opindex Wno-sizeof-pointer-memaccess
6317 Warn for suspicious length parameters to certain string and memory built-in
6318 functions if the argument uses @code{sizeof}.  This warning triggers for
6319 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6320 an array, but a pointer, and suggests a possible fix, or about
6321 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6322 also warns about calls to bounded string copy functions like @code{strncat}
6323 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6324 the source array.  For example, in the following function the call to
6325 @code{strncat} specifies the size of the source string as the bound.  That
6326 is almost certainly a mistake and so the call is diagnosed.
6327 @smallexample
6328 void make_file (const char *name)
6330   char path[PATH_MAX];
6331   strncpy (path, name, sizeof path - 1);
6332   strncat (path, ".text", sizeof ".text");
6333   @dots{}
6335 @end smallexample
6337 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6339 @item -Wsizeof-array-argument
6340 @opindex Wsizeof-array-argument
6341 @opindex Wno-sizeof-array-argument
6342 Warn when the @code{sizeof} operator is applied to a parameter that is
6343 declared as an array in a function definition.  This warning is enabled by
6344 default for C and C++ programs.
6346 @item -Wmemset-elt-size
6347 @opindex Wmemset-elt-size
6348 @opindex Wno-memset-elt-size
6349 Warn for suspicious calls to the @code{memset} built-in function, if the
6350 first argument references an array, and the third argument is a number
6351 equal to the number of elements, but not equal to the size of the array
6352 in memory.  This indicates that the user has omitted a multiplication by
6353 the element size.  This warning is enabled by @option{-Wall}.
6355 @item -Wmemset-transposed-args
6356 @opindex Wmemset-transposed-args
6357 @opindex Wno-memset-transposed-args
6358 Warn for suspicious calls to the @code{memset} built-in function, if the
6359 second argument is not zero and the third argument is zero.  This warns e.g.@
6360 about @code{memset (buf, sizeof buf, 0)} where most probably
6361 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6362 is only emitted if the third argument is literal zero.  If it is some
6363 expression that is folded to zero, a cast of zero to some type, etc., 
6364 it is far less likely that the user has mistakenly exchanged the arguments 
6365 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6367 @item -Waddress
6368 @opindex Waddress
6369 @opindex Wno-address
6370 Warn about suspicious uses of memory addresses. These include using
6371 the address of a function in a conditional expression, such as
6372 @code{void func(void); if (func)}, and comparisons against the memory
6373 address of a string literal, such as @code{if (x == "abc")}.  Such
6374 uses typically indicate a programmer error: the address of a function
6375 always evaluates to true, so their use in a conditional usually
6376 indicate that the programmer forgot the parentheses in a function
6377 call; and comparisons against string literals result in unspecified
6378 behavior and are not portable in C, so they usually indicate that the
6379 programmer intended to use @code{strcmp}.  This warning is enabled by
6380 @option{-Wall}.
6382 @item -Wlogical-op
6383 @opindex Wlogical-op
6384 @opindex Wno-logical-op
6385 Warn about suspicious uses of logical operators in expressions.
6386 This includes using logical operators in contexts where a
6387 bit-wise operator is likely to be expected.  Also warns when
6388 the operands of a logical operator are the same:
6389 @smallexample
6390 extern int a;
6391 if (a < 0 && a < 0) @{ @dots{} @}
6392 @end smallexample
6394 @item -Wlogical-not-parentheses
6395 @opindex Wlogical-not-parentheses
6396 @opindex Wno-logical-not-parentheses
6397 Warn about logical not used on the left hand side operand of a comparison.
6398 This option does not warn if the right operand is considered to be a boolean
6399 expression.  Its purpose is to detect suspicious code like the following:
6400 @smallexample
6401 int a;
6402 @dots{}
6403 if (!a > 1) @{ @dots{} @}
6404 @end smallexample
6406 It is possible to suppress the warning by wrapping the LHS into
6407 parentheses:
6408 @smallexample
6409 if ((!a) > 1) @{ @dots{} @}
6410 @end smallexample
6412 This warning is enabled by @option{-Wall}.
6414 @item -Waggregate-return
6415 @opindex Waggregate-return
6416 @opindex Wno-aggregate-return
6417 Warn if any functions that return structures or unions are defined or
6418 called.  (In languages where you can return an array, this also elicits
6419 a warning.)
6421 @item -Wno-aggressive-loop-optimizations
6422 @opindex Wno-aggressive-loop-optimizations
6423 @opindex Waggressive-loop-optimizations
6424 Warn if in a loop with constant number of iterations the compiler detects
6425 undefined behavior in some statement during one or more of the iterations.
6427 @item -Wno-attributes
6428 @opindex Wno-attributes
6429 @opindex Wattributes
6430 Do not warn if an unexpected @code{__attribute__} is used, such as
6431 unrecognized attributes, function attributes applied to variables,
6432 etc.  This does not stop errors for incorrect use of supported
6433 attributes.
6435 @item -Wno-builtin-declaration-mismatch
6436 @opindex Wno-builtin-declaration-mismatch
6437 @opindex Wbuiltin-declaration-mismatch
6438 Warn if a built-in function is declared with the wrong signature or 
6439 as non-function.
6440 This warning is enabled by default.
6442 @item -Wno-builtin-macro-redefined
6443 @opindex Wno-builtin-macro-redefined
6444 @opindex Wbuiltin-macro-redefined
6445 Do not warn if certain built-in macros are redefined.  This suppresses
6446 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6447 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6449 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6450 @opindex Wstrict-prototypes
6451 @opindex Wno-strict-prototypes
6452 Warn if a function is declared or defined without specifying the
6453 argument types.  (An old-style function definition is permitted without
6454 a warning if preceded by a declaration that specifies the argument
6455 types.)
6457 @item -Wold-style-declaration @r{(C and Objective-C only)}
6458 @opindex Wold-style-declaration
6459 @opindex Wno-old-style-declaration
6460 Warn for obsolescent usages, according to the C Standard, in a
6461 declaration. For example, warn if storage-class specifiers like
6462 @code{static} are not the first things in a declaration.  This warning
6463 is also enabled by @option{-Wextra}.
6465 @item -Wold-style-definition @r{(C and Objective-C only)}
6466 @opindex Wold-style-definition
6467 @opindex Wno-old-style-definition
6468 Warn if an old-style function definition is used.  A warning is given
6469 even if there is a previous prototype.
6471 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6472 @opindex Wmissing-parameter-type
6473 @opindex Wno-missing-parameter-type
6474 A function parameter is declared without a type specifier in K&R-style
6475 functions:
6477 @smallexample
6478 void foo(bar) @{ @}
6479 @end smallexample
6481 This warning is also enabled by @option{-Wextra}.
6483 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6484 @opindex Wmissing-prototypes
6485 @opindex Wno-missing-prototypes
6486 Warn if a global function is defined without a previous prototype
6487 declaration.  This warning is issued even if the definition itself
6488 provides a prototype.  Use this option to detect global functions
6489 that do not have a matching prototype declaration in a header file.
6490 This option is not valid for C++ because all function declarations
6491 provide prototypes and a non-matching declaration declares an
6492 overload rather than conflict with an earlier declaration.
6493 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6495 @item -Wmissing-declarations
6496 @opindex Wmissing-declarations
6497 @opindex Wno-missing-declarations
6498 Warn if a global function is defined without a previous declaration.
6499 Do so even if the definition itself provides a prototype.
6500 Use this option to detect global functions that are not declared in
6501 header files.  In C, no warnings are issued for functions with previous
6502 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6503 missing prototypes.  In C++, no warnings are issued for function templates,
6504 or for inline functions, or for functions in anonymous namespaces.
6506 @item -Wmissing-field-initializers
6507 @opindex Wmissing-field-initializers
6508 @opindex Wno-missing-field-initializers
6509 @opindex W
6510 @opindex Wextra
6511 @opindex Wno-extra
6512 Warn if a structure's initializer has some fields missing.  For
6513 example, the following code causes such a warning, because
6514 @code{x.h} is implicitly zero:
6516 @smallexample
6517 struct s @{ int f, g, h; @};
6518 struct s x = @{ 3, 4 @};
6519 @end smallexample
6521 This option does not warn about designated initializers, so the following
6522 modification does not trigger a warning:
6524 @smallexample
6525 struct s @{ int f, g, h; @};
6526 struct s x = @{ .f = 3, .g = 4 @};
6527 @end smallexample
6529 In C this option does not warn about the universal zero initializer
6530 @samp{@{ 0 @}}:
6532 @smallexample
6533 struct s @{ int f, g, h; @};
6534 struct s x = @{ 0 @};
6535 @end smallexample
6537 Likewise, in C++ this option does not warn about the empty @{ @}
6538 initializer, for example:
6540 @smallexample
6541 struct s @{ int f, g, h; @};
6542 s x = @{ @};
6543 @end smallexample
6545 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6546 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6548 @item -Wno-multichar
6549 @opindex Wno-multichar
6550 @opindex Wmultichar
6551 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6552 Usually they indicate a typo in the user's code, as they have
6553 implementation-defined values, and should not be used in portable code.
6555 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6556 @opindex Wnormalized=
6557 @opindex Wnormalized
6558 @opindex Wno-normalized
6559 @cindex NFC
6560 @cindex NFKC
6561 @cindex character set, input normalization
6562 In ISO C and ISO C++, two identifiers are different if they are
6563 different sequences of characters.  However, sometimes when characters
6564 outside the basic ASCII character set are used, you can have two
6565 different character sequences that look the same.  To avoid confusion,
6566 the ISO 10646 standard sets out some @dfn{normalization rules} which
6567 when applied ensure that two sequences that look the same are turned into
6568 the same sequence.  GCC can warn you if you are using identifiers that
6569 have not been normalized; this option controls that warning.
6571 There are four levels of warning supported by GCC@.  The default is
6572 @option{-Wnormalized=nfc}, which warns about any identifier that is
6573 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6574 recommended form for most uses.  It is equivalent to
6575 @option{-Wnormalized}.
6577 Unfortunately, there are some characters allowed in identifiers by
6578 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6579 identifiers.  That is, there's no way to use these symbols in portable
6580 ISO C or C++ and have all your identifiers in NFC@.
6581 @option{-Wnormalized=id} suppresses the warning for these characters.
6582 It is hoped that future versions of the standards involved will correct
6583 this, which is why this option is not the default.
6585 You can switch the warning off for all characters by writing
6586 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6587 only do this if you are using some other normalization scheme (like
6588 ``D''), because otherwise you can easily create bugs that are
6589 literally impossible to see.
6591 Some characters in ISO 10646 have distinct meanings but look identical
6592 in some fonts or display methodologies, especially once formatting has
6593 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6594 LETTER N'', displays just like a regular @code{n} that has been
6595 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6596 normalization scheme to convert all these into a standard form as
6597 well, and GCC warns if your code is not in NFKC if you use
6598 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6599 about every identifier that contains the letter O because it might be
6600 confused with the digit 0, and so is not the default, but may be
6601 useful as a local coding convention if the programming environment 
6602 cannot be fixed to display these characters distinctly.
6604 @item -Wno-deprecated
6605 @opindex Wno-deprecated
6606 @opindex Wdeprecated
6607 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6609 @item -Wno-deprecated-declarations
6610 @opindex Wno-deprecated-declarations
6611 @opindex Wdeprecated-declarations
6612 Do not warn about uses of functions (@pxref{Function Attributes}),
6613 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6614 Attributes}) marked as deprecated by using the @code{deprecated}
6615 attribute.
6617 @item -Wno-overflow
6618 @opindex Wno-overflow
6619 @opindex Woverflow
6620 Do not warn about compile-time overflow in constant expressions.
6622 @item -Wno-odr
6623 @opindex Wno-odr
6624 @opindex Wodr
6625 Warn about One Definition Rule violations during link-time optimization.
6626 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6628 @item -Wopenmp-simd
6629 @opindex Wopenm-simd
6630 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6631 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6632 option can be used to relax the cost model.
6634 @item -Woverride-init @r{(C and Objective-C only)}
6635 @opindex Woverride-init
6636 @opindex Wno-override-init
6637 @opindex W
6638 @opindex Wextra
6639 @opindex Wno-extra
6640 Warn if an initialized field without side effects is overridden when
6641 using designated initializers (@pxref{Designated Inits, , Designated
6642 Initializers}).
6644 This warning is included in @option{-Wextra}.  To get other
6645 @option{-Wextra} warnings without this one, use @option{-Wextra
6646 -Wno-override-init}.
6648 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6649 @opindex Woverride-init-side-effects
6650 @opindex Wno-override-init-side-effects
6651 Warn if an initialized field with side effects is overridden when
6652 using designated initializers (@pxref{Designated Inits, , Designated
6653 Initializers}).  This warning is enabled by default.
6655 @item -Wpacked
6656 @opindex Wpacked
6657 @opindex Wno-packed
6658 Warn if a structure is given the packed attribute, but the packed
6659 attribute has no effect on the layout or size of the structure.
6660 Such structures may be mis-aligned for little benefit.  For
6661 instance, in this code, the variable @code{f.x} in @code{struct bar}
6662 is misaligned even though @code{struct bar} does not itself
6663 have the packed attribute:
6665 @smallexample
6666 @group
6667 struct foo @{
6668   int x;
6669   char a, b, c, d;
6670 @} __attribute__((packed));
6671 struct bar @{
6672   char z;
6673   struct foo f;
6675 @end group
6676 @end smallexample
6678 @item -Wpacked-bitfield-compat
6679 @opindex Wpacked-bitfield-compat
6680 @opindex Wno-packed-bitfield-compat
6681 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6682 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6683 the change can lead to differences in the structure layout.  GCC
6684 informs you when the offset of such a field has changed in GCC 4.4.
6685 For example there is no longer a 4-bit padding between field @code{a}
6686 and @code{b} in this structure:
6688 @smallexample
6689 struct foo
6691   char a:4;
6692   char b:8;
6693 @} __attribute__ ((packed));
6694 @end smallexample
6696 This warning is enabled by default.  Use
6697 @option{-Wno-packed-bitfield-compat} to disable this warning.
6699 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6700 @opindex Wpacked-not-aligned
6701 @opindex Wno-packed-not-aligned
6702 Warn if a structure field with explicitly specified alignment in a
6703 packed struct or union is misaligned.  For example, a warning will
6704 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6705 'struct S' is less than 8}, in this code:
6707 @smallexample
6708 @group
6709 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6710 struct __attribute__ ((packed)) S @{
6711   struct S8 s8;
6713 @end group
6714 @end smallexample
6716 This warning is enabled by @option{-Wall}.
6718 @item -Wpadded
6719 @opindex Wpadded
6720 @opindex Wno-padded
6721 Warn if padding is included in a structure, either to align an element
6722 of the structure or to align the whole structure.  Sometimes when this
6723 happens it is possible to rearrange the fields of the structure to
6724 reduce the padding and so make the structure smaller.
6726 @item -Wredundant-decls
6727 @opindex Wredundant-decls
6728 @opindex Wno-redundant-decls
6729 Warn if anything is declared more than once in the same scope, even in
6730 cases where multiple declaration is valid and changes nothing.
6732 @item -Wno-restrict
6733 @opindex Wrestrict
6734 @opindex Wno-restrict
6735 Warn when an object referenced by a @code{restrict}-qualified parameter
6736 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6737 argument, or when copies between such objects overlap.  For example,
6738 the call to the @code{strcpy} function below attempts to truncate the string
6739 by replacing its initial characters with the last four.  However, because
6740 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6741 the call is diagnosed.
6743 @smallexample
6744 struct foo
6746   char a[] = "abcd1234";
6747   strcpy (a, a + 4);
6749 @end smallexample
6750 The @option{-Wrestrict} is included in @option{-Wall}.
6752 @item -Wnested-externs @r{(C and Objective-C only)}
6753 @opindex Wnested-externs
6754 @opindex Wno-nested-externs
6755 Warn if an @code{extern} declaration is encountered within a function.
6757 @item -Wno-inherited-variadic-ctor
6758 @opindex Winherited-variadic-ctor
6759 @opindex Wno-inherited-variadic-ctor
6760 Suppress warnings about use of C++11 inheriting constructors when the
6761 base class inherited from has a C variadic constructor; the warning is
6762 on by default because the ellipsis is not inherited.
6764 @item -Winline
6765 @opindex Winline
6766 @opindex Wno-inline
6767 Warn if a function that is declared as inline cannot be inlined.
6768 Even with this option, the compiler does not warn about failures to
6769 inline functions declared in system headers.
6771 The compiler uses a variety of heuristics to determine whether or not
6772 to inline a function.  For example, the compiler takes into account
6773 the size of the function being inlined and the amount of inlining
6774 that has already been done in the current function.  Therefore,
6775 seemingly insignificant changes in the source program can cause the
6776 warnings produced by @option{-Winline} to appear or disappear.
6778 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6779 @opindex Wno-invalid-offsetof
6780 @opindex Winvalid-offsetof
6781 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6782 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6783 to a non-standard-layout type is undefined.  In existing C++ implementations,
6784 however, @code{offsetof} typically gives meaningful results.
6785 This flag is for users who are aware that they are
6786 writing nonportable code and who have deliberately chosen to ignore the
6787 warning about it.
6789 The restrictions on @code{offsetof} may be relaxed in a future version
6790 of the C++ standard.
6792 @item -Wint-in-bool-context
6793 @opindex Wint-in-bool-context
6794 @opindex Wno-int-in-bool-context
6795 Warn for suspicious use of integer values where boolean values are expected,
6796 such as conditional expressions (?:) using non-boolean integer constants in
6797 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6798 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6799 for all kinds of multiplications regardless of the data type.
6800 This warning is enabled by @option{-Wall}.
6802 @item -Wno-int-to-pointer-cast
6803 @opindex Wno-int-to-pointer-cast
6804 @opindex Wint-to-pointer-cast
6805 Suppress warnings from casts to pointer type of an integer of a
6806 different size. In C++, casting to a pointer type of smaller size is
6807 an error. @option{Wint-to-pointer-cast} is enabled by default.
6810 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6811 @opindex Wno-pointer-to-int-cast
6812 @opindex Wpointer-to-int-cast
6813 Suppress warnings from casts from a pointer to an integer type of a
6814 different size.
6816 @item -Winvalid-pch
6817 @opindex Winvalid-pch
6818 @opindex Wno-invalid-pch
6819 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6820 the search path but cannot be used.
6822 @item -Wlong-long
6823 @opindex Wlong-long
6824 @opindex Wno-long-long
6825 Warn if @code{long long} type is used.  This is enabled by either
6826 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6827 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6829 @item -Wvariadic-macros
6830 @opindex Wvariadic-macros
6831 @opindex Wno-variadic-macros
6832 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6833 alternate syntax is used in ISO C99 mode.  This is enabled by either
6834 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6835 messages, use @option{-Wno-variadic-macros}.
6837 @item -Wvarargs
6838 @opindex Wvarargs
6839 @opindex Wno-varargs
6840 Warn upon questionable usage of the macros used to handle variable
6841 arguments like @code{va_start}.  This is default.  To inhibit the
6842 warning messages, use @option{-Wno-varargs}.
6844 @item -Wvector-operation-performance
6845 @opindex Wvector-operation-performance
6846 @opindex Wno-vector-operation-performance
6847 Warn if vector operation is not implemented via SIMD capabilities of the
6848 architecture.  Mainly useful for the performance tuning.
6849 Vector operation can be implemented @code{piecewise}, which means that the
6850 scalar operation is performed on every vector element; 
6851 @code{in parallel}, which means that the vector operation is implemented
6852 using scalars of wider type, which normally is more performance efficient;
6853 and @code{as a single scalar}, which means that vector fits into a
6854 scalar type.
6856 @item -Wno-virtual-move-assign
6857 @opindex Wvirtual-move-assign
6858 @opindex Wno-virtual-move-assign
6859 Suppress warnings about inheriting from a virtual base with a
6860 non-trivial C++11 move assignment operator.  This is dangerous because
6861 if the virtual base is reachable along more than one path, it is
6862 moved multiple times, which can mean both objects end up in the
6863 moved-from state.  If the move assignment operator is written to avoid
6864 moving from a moved-from object, this warning can be disabled.
6866 @item -Wvla
6867 @opindex Wvla
6868 @opindex Wno-vla
6869 Warn if a variable-length array is used in the code.
6870 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6871 the variable-length array.
6873 @item -Wvla-larger-than=@var{n}
6874 If this option is used, the compiler will warn on uses of
6875 variable-length arrays where the size is either unbounded, or bounded
6876 by an argument that can be larger than @var{n} bytes.  This is similar
6877 to how @option{-Walloca-larger-than=@var{n}} works, but with
6878 variable-length arrays.
6880 Note that GCC may optimize small variable-length arrays of a known
6881 value into plain arrays, so this warning may not get triggered for
6882 such arrays.
6884 This warning is not enabled by @option{-Wall}, and is only active when
6885 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6887 See also @option{-Walloca-larger-than=@var{n}}.
6889 @item -Wvolatile-register-var
6890 @opindex Wvolatile-register-var
6891 @opindex Wno-volatile-register-var
6892 Warn if a register variable is declared volatile.  The volatile
6893 modifier does not inhibit all optimizations that may eliminate reads
6894 and/or writes to register variables.  This warning is enabled by
6895 @option{-Wall}.
6897 @item -Wdisabled-optimization
6898 @opindex Wdisabled-optimization
6899 @opindex Wno-disabled-optimization
6900 Warn if a requested optimization pass is disabled.  This warning does
6901 not generally indicate that there is anything wrong with your code; it
6902 merely indicates that GCC's optimizers are unable to handle the code
6903 effectively.  Often, the problem is that your code is too big or too
6904 complex; GCC refuses to optimize programs when the optimization
6905 itself is likely to take inordinate amounts of time.
6907 @item -Wpointer-sign @r{(C and Objective-C only)}
6908 @opindex Wpointer-sign
6909 @opindex Wno-pointer-sign
6910 Warn for pointer argument passing or assignment with different signedness.
6911 This option is only supported for C and Objective-C@.  It is implied by
6912 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6913 @option{-Wno-pointer-sign}.
6915 @item -Wstack-protector
6916 @opindex Wstack-protector
6917 @opindex Wno-stack-protector
6918 This option is only active when @option{-fstack-protector} is active.  It
6919 warns about functions that are not protected against stack smashing.
6921 @item -Woverlength-strings
6922 @opindex Woverlength-strings
6923 @opindex Wno-overlength-strings
6924 Warn about string constants that are longer than the ``minimum
6925 maximum'' length specified in the C standard.  Modern compilers
6926 generally allow string constants that are much longer than the
6927 standard's minimum limit, but very portable programs should avoid
6928 using longer strings.
6930 The limit applies @emph{after} string constant concatenation, and does
6931 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6932 C99, it was raised to 4095.  C++98 does not specify a normative
6933 minimum maximum, so we do not diagnose overlength strings in C++@.
6935 This option is implied by @option{-Wpedantic}, and can be disabled with
6936 @option{-Wno-overlength-strings}.
6938 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6939 @opindex Wunsuffixed-float-constants
6941 Issue a warning for any floating constant that does not have
6942 a suffix.  When used together with @option{-Wsystem-headers} it
6943 warns about such constants in system header files.  This can be useful
6944 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6945 from the decimal floating-point extension to C99.
6947 @item -Wno-designated-init @r{(C and Objective-C only)}
6948 Suppress warnings when a positional initializer is used to initialize
6949 a structure that has been marked with the @code{designated_init}
6950 attribute.
6952 @item -Whsa
6953 Issue a warning when HSAIL cannot be emitted for the compiled function or
6954 OpenMP construct.
6956 @end table
6958 @node Debugging Options
6959 @section Options for Debugging Your Program
6960 @cindex options, debugging
6961 @cindex debugging information options
6963 To tell GCC to emit extra information for use by a debugger, in almost 
6964 all cases you need only to add @option{-g} to your other options.
6966 GCC allows you to use @option{-g} with
6967 @option{-O}.  The shortcuts taken by optimized code may occasionally
6968 be surprising: some variables you declared may not exist
6969 at all; flow of control may briefly move where you did not expect it;
6970 some statements may not be executed because they compute constant
6971 results or their values are already at hand; some statements may
6972 execute in different places because they have been moved out of loops.
6973 Nevertheless it is possible to debug optimized output.  This makes
6974 it reasonable to use the optimizer for programs that might have bugs.
6976 If you are not using some other optimization option, consider
6977 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6978 With no @option{-O} option at all, some compiler passes that collect
6979 information useful for debugging do not run at all, so that
6980 @option{-Og} may result in a better debugging experience.
6982 @table @gcctabopt
6983 @item -g
6984 @opindex g
6985 Produce debugging information in the operating system's native format
6986 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6987 information.
6989 On most systems that use stabs format, @option{-g} enables use of extra
6990 debugging information that only GDB can use; this extra information
6991 makes debugging work better in GDB but probably makes other debuggers
6992 crash or
6993 refuse to read the program.  If you want to control for certain whether
6994 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6995 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6997 @item -ggdb
6998 @opindex ggdb
6999 Produce debugging information for use by GDB@.  This means to use the
7000 most expressive format available (DWARF, stabs, or the native format
7001 if neither of those are supported), including GDB extensions if at all
7002 possible.
7004 @item -gdwarf
7005 @itemx -gdwarf-@var{version}
7006 @opindex gdwarf
7007 Produce debugging information in DWARF format (if that is supported).
7008 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7009 for most targets is 4.  DWARF Version 5 is only experimental.
7011 Note that with DWARF Version 2, some ports require and always
7012 use some non-conflicting DWARF 3 extensions in the unwind tables.
7014 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7015 for maximum benefit.
7017 GCC no longer supports DWARF Version 1, which is substantially
7018 different than Version 2 and later.  For historical reasons, some
7019 other DWARF-related options such as
7020 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7021 in their names, but apply to all currently-supported versions of DWARF.
7023 @item -gstabs
7024 @opindex gstabs
7025 Produce debugging information in stabs format (if that is supported),
7026 without GDB extensions.  This is the format used by DBX on most BSD
7027 systems.  On MIPS, Alpha and System V Release 4 systems this option
7028 produces stabs debugging output that is not understood by DBX@.
7029 On System V Release 4 systems this option requires the GNU assembler.
7031 @item -gstabs+
7032 @opindex gstabs+
7033 Produce debugging information in stabs format (if that is supported),
7034 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7035 use of these extensions is likely to make other debuggers crash or
7036 refuse to read the program.
7038 @item -gxcoff
7039 @opindex gxcoff
7040 Produce debugging information in XCOFF format (if that is supported).
7041 This is the format used by the DBX debugger on IBM RS/6000 systems.
7043 @item -gxcoff+
7044 @opindex gxcoff+
7045 Produce debugging information in XCOFF format (if that is supported),
7046 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7047 use of these extensions is likely to make other debuggers crash or
7048 refuse to read the program, and may cause assemblers other than the GNU
7049 assembler (GAS) to fail with an error.
7051 @item -gvms
7052 @opindex gvms
7053 Produce debugging information in Alpha/VMS debug format (if that is
7054 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7056 @item -g@var{level}
7057 @itemx -ggdb@var{level}
7058 @itemx -gstabs@var{level}
7059 @itemx -gxcoff@var{level}
7060 @itemx -gvms@var{level}
7061 Request debugging information and also use @var{level} to specify how
7062 much information.  The default level is 2.
7064 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7065 @option{-g}.
7067 Level 1 produces minimal information, enough for making backtraces in
7068 parts of the program that you don't plan to debug.  This includes
7069 descriptions of functions and external variables, and line number
7070 tables, but no information about local variables.
7072 Level 3 includes extra information, such as all the macro definitions
7073 present in the program.  Some debuggers support macro expansion when
7074 you use @option{-g3}.
7076 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7077 confusion with @option{-gdwarf-@var{level}}.
7078 Instead use an additional @option{-g@var{level}} option to change the
7079 debug level for DWARF.
7081 @item -feliminate-unused-debug-symbols
7082 @opindex feliminate-unused-debug-symbols
7083 Produce debugging information in stabs format (if that is supported),
7084 for only symbols that are actually used.
7086 @item -femit-class-debug-always
7087 @opindex femit-class-debug-always
7088 Instead of emitting debugging information for a C++ class in only one
7089 object file, emit it in all object files using the class.  This option
7090 should be used only with debuggers that are unable to handle the way GCC
7091 normally emits debugging information for classes because using this
7092 option increases the size of debugging information by as much as a
7093 factor of two.
7095 @item -fno-merge-debug-strings
7096 @opindex fmerge-debug-strings
7097 @opindex fno-merge-debug-strings
7098 Direct the linker to not merge together strings in the debugging
7099 information that are identical in different object files.  Merging is
7100 not supported by all assemblers or linkers.  Merging decreases the size
7101 of the debug information in the output file at the cost of increasing
7102 link processing time.  Merging is enabled by default.
7104 @item -fdebug-prefix-map=@var{old}=@var{new}
7105 @opindex fdebug-prefix-map
7106 When compiling files in directory @file{@var{old}}, record debugging
7107 information describing them as in @file{@var{new}} instead.  This can be
7108 used to replace a build-time path with an install-time path in the debug info.
7109 It can also be used to change an absolute path to a relative path by using
7110 @file{.} for @var{new}.  This can give more reproducible builds, which are
7111 location independent, but may require an extra command to tell GDB where to
7112 find the source files.
7114 @item -fvar-tracking
7115 @opindex fvar-tracking
7116 Run variable tracking pass.  It computes where variables are stored at each
7117 position in code.  Better debugging information is then generated
7118 (if the debugging information format supports this information).
7120 It is enabled by default when compiling with optimization (@option{-Os},
7121 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7122 the debug info format supports it.
7124 @item -fvar-tracking-assignments
7125 @opindex fvar-tracking-assignments
7126 @opindex fno-var-tracking-assignments
7127 Annotate assignments to user variables early in the compilation and
7128 attempt to carry the annotations over throughout the compilation all the
7129 way to the end, in an attempt to improve debug information while
7130 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7132 It can be enabled even if var-tracking is disabled, in which case
7133 annotations are created and maintained, but discarded at the end.
7134 By default, this flag is enabled together with @option{-fvar-tracking},
7135 except when selective scheduling is enabled.
7137 @item -gsplit-dwarf
7138 @opindex gsplit-dwarf
7139 Separate as much DWARF debugging information as possible into a
7140 separate output file with the extension @file{.dwo}.  This option allows
7141 the build system to avoid linking files with debug information.  To
7142 be useful, this option requires a debugger capable of reading @file{.dwo}
7143 files.
7145 @item -gpubnames
7146 @opindex gpubnames
7147 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7149 @item -ggnu-pubnames
7150 @opindex ggnu-pubnames
7151 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7152 suitable for conversion into a GDB@ index.  This option is only useful
7153 with a linker that can produce GDB@ index version 7.
7155 @item -fdebug-types-section
7156 @opindex fdebug-types-section
7157 @opindex fno-debug-types-section
7158 When using DWARF Version 4 or higher, type DIEs can be put into
7159 their own @code{.debug_types} section instead of making them part of the
7160 @code{.debug_info} section.  It is more efficient to put them in a separate
7161 comdat sections since the linker can then remove duplicates.
7162 But not all DWARF consumers support @code{.debug_types} sections yet
7163 and on some objects @code{.debug_types} produces larger instead of smaller
7164 debugging information.
7166 @item -grecord-gcc-switches
7167 @item -gno-record-gcc-switches
7168 @opindex grecord-gcc-switches
7169 @opindex gno-record-gcc-switches
7170 This switch causes the command-line options used to invoke the
7171 compiler that may affect code generation to be appended to the
7172 DW_AT_producer attribute in DWARF debugging information.  The options
7173 are concatenated with spaces separating them from each other and from
7174 the compiler version.  
7175 It is enabled by default.
7176 See also @option{-frecord-gcc-switches} for another
7177 way of storing compiler options into the object file.  
7179 @item -gstrict-dwarf
7180 @opindex gstrict-dwarf
7181 Disallow using extensions of later DWARF standard version than selected
7182 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7183 DWARF extensions from later standard versions is allowed.
7185 @item -gno-strict-dwarf
7186 @opindex gno-strict-dwarf
7187 Allow using extensions of later DWARF standard version than selected with
7188 @option{-gdwarf-@var{version}}.
7190 @item -gcolumn-info
7191 @item -gno-column-info
7192 @opindex gcolumn-info
7193 @opindex gno-column-info
7194 Emit location column information into DWARF debugging information, rather
7195 than just file and line.
7196 This option is enabled by default.
7198 @item -gstatement-frontiers
7199 @item -gno-statement-frontiers
7200 @opindex gstatement-frontiers
7201 @opindex gno-statement-frontiers
7202 This option causes GCC to create markers in the internal representation
7203 at the beginning of statements, and to keep them roughly in place
7204 throughout compilation, using them to guide the output of @code{is_stmt}
7205 markers in the line number table.  This is enabled by default when
7206 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7207 @dots{}), and outputting DWARF 2 debug information at the normal level.
7209 @item -gz@r{[}=@var{type}@r{]}
7210 @opindex gz
7211 Produce compressed debug sections in DWARF format, if that is supported.
7212 If @var{type} is not given, the default type depends on the capabilities
7213 of the assembler and linker used.  @var{type} may be one of
7214 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7215 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7216 compression in traditional GNU format).  If the linker doesn't support
7217 writing compressed debug sections, the option is rejected.  Otherwise,
7218 if the assembler does not support them, @option{-gz} is silently ignored
7219 when producing object files.
7221 @item -femit-struct-debug-baseonly
7222 @opindex femit-struct-debug-baseonly
7223 Emit debug information for struct-like types
7224 only when the base name of the compilation source file
7225 matches the base name of file in which the struct is defined.
7227 This option substantially reduces the size of debugging information,
7228 but at significant potential loss in type information to the debugger.
7229 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7230 See @option{-femit-struct-debug-detailed} for more detailed control.
7232 This option works only with DWARF debug output.
7234 @item -femit-struct-debug-reduced
7235 @opindex femit-struct-debug-reduced
7236 Emit debug information for struct-like types
7237 only when the base name of the compilation source file
7238 matches the base name of file in which the type is defined,
7239 unless the struct is a template or defined in a system header.
7241 This option significantly reduces the size of debugging information,
7242 with some potential loss in type information to the debugger.
7243 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7244 See @option{-femit-struct-debug-detailed} for more detailed control.
7246 This option works only with DWARF debug output.
7248 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7249 @opindex femit-struct-debug-detailed
7250 Specify the struct-like types
7251 for which the compiler generates debug information.
7252 The intent is to reduce duplicate struct debug information
7253 between different object files within the same program.
7255 This option is a detailed version of
7256 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7257 which serves for most needs.
7259 A specification has the syntax@*
7260 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7262 The optional first word limits the specification to
7263 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7264 A struct type is used directly when it is the type of a variable, member.
7265 Indirect uses arise through pointers to structs.
7266 That is, when use of an incomplete struct is valid, the use is indirect.
7267 An example is
7268 @samp{struct one direct; struct two * indirect;}.
7270 The optional second word limits the specification to
7271 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7272 Generic structs are a bit complicated to explain.
7273 For C++, these are non-explicit specializations of template classes,
7274 or non-template classes within the above.
7275 Other programming languages have generics,
7276 but @option{-femit-struct-debug-detailed} does not yet implement them.
7278 The third word specifies the source files for those
7279 structs for which the compiler should emit debug information.
7280 The values @samp{none} and @samp{any} have the normal meaning.
7281 The value @samp{base} means that
7282 the base of name of the file in which the type declaration appears
7283 must match the base of the name of the main compilation file.
7284 In practice, this means that when compiling @file{foo.c}, debug information
7285 is generated for types declared in that file and @file{foo.h},
7286 but not other header files.
7287 The value @samp{sys} means those types satisfying @samp{base}
7288 or declared in system or compiler headers.
7290 You may need to experiment to determine the best settings for your application.
7292 The default is @option{-femit-struct-debug-detailed=all}.
7294 This option works only with DWARF debug output.
7296 @item -fno-dwarf2-cfi-asm
7297 @opindex fdwarf2-cfi-asm
7298 @opindex fno-dwarf2-cfi-asm
7299 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7300 instead of using GAS @code{.cfi_*} directives.
7302 @item -fno-eliminate-unused-debug-types
7303 @opindex feliminate-unused-debug-types
7304 @opindex fno-eliminate-unused-debug-types
7305 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7306 output for types that are nowhere used in the source file being compiled.
7307 Sometimes it is useful to have GCC emit debugging
7308 information for all types declared in a compilation
7309 unit, regardless of whether or not they are actually used
7310 in that compilation unit, for example 
7311 if, in the debugger, you want to cast a value to a type that is
7312 not actually used in your program (but is declared).  More often,
7313 however, this results in a significant amount of wasted space.
7314 @end table
7316 @node Optimize Options
7317 @section Options That Control Optimization
7318 @cindex optimize options
7319 @cindex options, optimization
7321 These options control various sorts of optimizations.
7323 Without any optimization option, the compiler's goal is to reduce the
7324 cost of compilation and to make debugging produce the expected
7325 results.  Statements are independent: if you stop the program with a
7326 breakpoint between statements, you can then assign a new value to any
7327 variable or change the program counter to any other statement in the
7328 function and get exactly the results you expect from the source
7329 code.
7331 Turning on optimization flags makes the compiler attempt to improve
7332 the performance and/or code size at the expense of compilation time
7333 and possibly the ability to debug the program.
7335 The compiler performs optimization based on the knowledge it has of the
7336 program.  Compiling multiple files at once to a single output file mode allows
7337 the compiler to use information gained from all of the files when compiling
7338 each of them.
7340 Not all optimizations are controlled directly by a flag.  Only
7341 optimizations that have a flag are listed in this section.
7343 Most optimizations are only enabled if an @option{-O} level is set on
7344 the command line.  Otherwise they are disabled, even if individual
7345 optimization flags are specified.
7347 Depending on the target and how GCC was configured, a slightly different
7348 set of optimizations may be enabled at each @option{-O} level than
7349 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7350 to find out the exact set of optimizations that are enabled at each level.
7351 @xref{Overall Options}, for examples.
7353 @table @gcctabopt
7354 @item -O
7355 @itemx -O1
7356 @opindex O
7357 @opindex O1
7358 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7359 more memory for a large function.
7361 With @option{-O}, the compiler tries to reduce code size and execution
7362 time, without performing any optimizations that take a great deal of
7363 compilation time.
7365 @option{-O} turns on the following optimization flags:
7366 @gccoptlist{
7367 -fauto-inc-dec @gol
7368 -fbranch-count-reg @gol
7369 -fcombine-stack-adjustments @gol
7370 -fcompare-elim @gol
7371 -fcprop-registers @gol
7372 -fdce @gol
7373 -fdefer-pop @gol
7374 -fdelayed-branch @gol
7375 -fdse @gol
7376 -fforward-propagate @gol
7377 -fguess-branch-probability @gol
7378 -fif-conversion2 @gol
7379 -fif-conversion @gol
7380 -finline-functions-called-once @gol
7381 -fipa-pure-const @gol
7382 -fipa-profile @gol
7383 -fipa-reference @gol
7384 -fmerge-constants @gol
7385 -fmove-loop-invariants @gol
7386 -fomit-frame-pointer @gol
7387 -freorder-blocks @gol
7388 -fshrink-wrap @gol
7389 -fshrink-wrap-separate @gol
7390 -fsplit-wide-types @gol
7391 -fssa-backprop @gol
7392 -fssa-phiopt @gol
7393 -ftree-bit-ccp @gol
7394 -ftree-ccp @gol
7395 -ftree-ch @gol
7396 -ftree-coalesce-vars @gol
7397 -ftree-copy-prop @gol
7398 -ftree-dce @gol
7399 -ftree-dominator-opts @gol
7400 -ftree-dse @gol
7401 -ftree-forwprop @gol
7402 -ftree-fre @gol
7403 -ftree-phiprop @gol
7404 -ftree-sink @gol
7405 -ftree-slsr @gol
7406 -ftree-sra @gol
7407 -ftree-pta @gol
7408 -ftree-ter @gol
7409 -funit-at-a-time}
7411 @item -O2
7412 @opindex O2
7413 Optimize even more.  GCC performs nearly all supported optimizations
7414 that do not involve a space-speed tradeoff.
7415 As compared to @option{-O}, this option increases both compilation time
7416 and the performance of the generated code.
7418 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7419 also turns on the following optimization flags:
7420 @gccoptlist{-fthread-jumps @gol
7421 -falign-functions  -falign-jumps @gol
7422 -falign-loops  -falign-labels @gol
7423 -fcaller-saves @gol
7424 -fcrossjumping @gol
7425 -fcse-follow-jumps  -fcse-skip-blocks @gol
7426 -fdelete-null-pointer-checks @gol
7427 -fdevirtualize -fdevirtualize-speculatively @gol
7428 -fexpensive-optimizations @gol
7429 -fgcse  -fgcse-lm  @gol
7430 -fhoist-adjacent-loads @gol
7431 -finline-small-functions @gol
7432 -findirect-inlining @gol
7433 -fipa-cp @gol
7434 -fipa-bit-cp @gol
7435 -fipa-vrp @gol
7436 -fipa-sra @gol
7437 -fipa-icf @gol
7438 -fisolate-erroneous-paths-dereference @gol
7439 -flra-remat @gol
7440 -foptimize-sibling-calls @gol
7441 -foptimize-strlen @gol
7442 -fpartial-inlining @gol
7443 -fpeephole2 @gol
7444 -freorder-blocks-algorithm=stc @gol
7445 -freorder-blocks-and-partition -freorder-functions @gol
7446 -frerun-cse-after-loop  @gol
7447 -fsched-interblock  -fsched-spec @gol
7448 -fschedule-insns  -fschedule-insns2 @gol
7449 -fstore-merging @gol
7450 -fstrict-aliasing @gol
7451 -ftree-builtin-call-dce @gol
7452 -ftree-switch-conversion -ftree-tail-merge @gol
7453 -fcode-hoisting @gol
7454 -ftree-pre @gol
7455 -ftree-vrp @gol
7456 -fipa-ra}
7458 Please note the warning under @option{-fgcse} about
7459 invoking @option{-O2} on programs that use computed gotos.
7461 @item -O3
7462 @opindex O3
7463 Optimize yet more.  @option{-O3} turns on all optimizations specified
7464 by @option{-O2} and also turns on the following optimization flags:
7465 @gccoptlist{-finline-functions @gol
7466 -funswitch-loops @gol
7467 -fpredictive-commoning @gol
7468 -fgcse-after-reload @gol
7469 -ftree-loop-vectorize @gol
7470 -ftree-loop-distribution @gol
7471 -ftree-loop-distribute-patterns @gol
7472 -floop-interchange @gol
7473 -fsplit-paths @gol
7474 -ftree-slp-vectorize @gol
7475 -fvect-cost-model @gol
7476 -ftree-partial-pre @gol
7477 -fpeel-loops @gol
7478 -fipa-cp-clone}
7480 @item -O0
7481 @opindex O0
7482 Reduce compilation time and make debugging produce the expected
7483 results.  This is the default.
7485 @item -Os
7486 @opindex Os
7487 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7488 do not typically increase code size.  It also performs further
7489 optimizations designed to reduce code size.
7491 @option{-Os} disables the following optimization flags:
7492 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7493 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7494 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7496 @item -Ofast
7497 @opindex Ofast
7498 Disregard strict standards compliance.  @option{-Ofast} enables all
7499 @option{-O3} optimizations.  It also enables optimizations that are not
7500 valid for all standard-compliant programs.
7501 It turns on @option{-ffast-math} and the Fortran-specific
7502 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7503 specified, and @option{-fno-protect-parens}.
7505 @item -Og
7506 @opindex Og
7507 Optimize debugging experience.  @option{-Og} enables optimizations
7508 that do not interfere with debugging. It should be the optimization
7509 level of choice for the standard edit-compile-debug cycle, offering
7510 a reasonable level of optimization while maintaining fast compilation
7511 and a good debugging experience.
7512 @end table
7514 If you use multiple @option{-O} options, with or without level numbers,
7515 the last such option is the one that is effective.
7517 Options of the form @option{-f@var{flag}} specify machine-independent
7518 flags.  Most flags have both positive and negative forms; the negative
7519 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7520 below, only one of the forms is listed---the one you typically 
7521 use.  You can figure out the other form by either removing @samp{no-}
7522 or adding it.
7524 The following options control specific optimizations.  They are either
7525 activated by @option{-O} options or are related to ones that are.  You
7526 can use the following flags in the rare cases when ``fine-tuning'' of
7527 optimizations to be performed is desired.
7529 @table @gcctabopt
7530 @item -fno-defer-pop
7531 @opindex fno-defer-pop
7532 Always pop the arguments to each function call as soon as that function
7533 returns.  For machines that must pop arguments after a function call,
7534 the compiler normally lets arguments accumulate on the stack for several
7535 function calls and pops them all at once.
7537 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7539 @item -fforward-propagate
7540 @opindex fforward-propagate
7541 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7542 instructions and checks if the result can be simplified.  If loop unrolling
7543 is active, two passes are performed and the second is scheduled after
7544 loop unrolling.
7546 This option is enabled by default at optimization levels @option{-O},
7547 @option{-O2}, @option{-O3}, @option{-Os}.
7549 @item -ffp-contract=@var{style}
7550 @opindex ffp-contract
7551 @option{-ffp-contract=off} disables floating-point expression contraction.
7552 @option{-ffp-contract=fast} enables floating-point expression contraction
7553 such as forming of fused multiply-add operations if the target has
7554 native support for them.
7555 @option{-ffp-contract=on} enables floating-point expression contraction
7556 if allowed by the language standard.  This is currently not implemented
7557 and treated equal to @option{-ffp-contract=off}.
7559 The default is @option{-ffp-contract=fast}.
7561 @item -fomit-frame-pointer
7562 @opindex fomit-frame-pointer
7563 Omit the frame pointer in functions that don't need one.  This avoids the
7564 instructions to save, set up and restore the frame pointer; on many targets
7565 it also makes an extra register available.
7567 On some targets this flag has no effect because the standard calling sequence
7568 always uses a frame pointer, so it cannot be omitted.
7570 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7571 is used in all functions.  Several targets always omit the frame pointer in
7572 leaf functions.
7574 Enabled by default at @option{-O} and higher.
7576 @item -foptimize-sibling-calls
7577 @opindex foptimize-sibling-calls
7578 Optimize sibling and tail recursive calls.
7580 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7582 @item -foptimize-strlen
7583 @opindex foptimize-strlen
7584 Optimize various standard C string functions (e.g. @code{strlen},
7585 @code{strchr} or @code{strcpy}) and
7586 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7588 Enabled at levels @option{-O2}, @option{-O3}.
7590 @item -fno-inline
7591 @opindex fno-inline
7592 Do not expand any functions inline apart from those marked with
7593 the @code{always_inline} attribute.  This is the default when not
7594 optimizing.
7596 Single functions can be exempted from inlining by marking them
7597 with the @code{noinline} attribute.
7599 @item -finline-small-functions
7600 @opindex finline-small-functions
7601 Integrate functions into their callers when their body is smaller than expected
7602 function call code (so overall size of program gets smaller).  The compiler
7603 heuristically decides which functions are simple enough to be worth integrating
7604 in this way.  This inlining applies to all functions, even those not declared
7605 inline.
7607 Enabled at level @option{-O2}.
7609 @item -findirect-inlining
7610 @opindex findirect-inlining
7611 Inline also indirect calls that are discovered to be known at compile
7612 time thanks to previous inlining.  This option has any effect only
7613 when inlining itself is turned on by the @option{-finline-functions}
7614 or @option{-finline-small-functions} options.
7616 Enabled at level @option{-O2}.
7618 @item -finline-functions
7619 @opindex finline-functions
7620 Consider all functions for inlining, even if they are not declared inline.
7621 The compiler heuristically decides which functions are worth integrating
7622 in this way.
7624 If all calls to a given function are integrated, and the function is
7625 declared @code{static}, then the function is normally not output as
7626 assembler code in its own right.
7628 Enabled at level @option{-O3}.
7630 @item -finline-functions-called-once
7631 @opindex finline-functions-called-once
7632 Consider all @code{static} functions called once for inlining into their
7633 caller even if they are not marked @code{inline}.  If a call to a given
7634 function is integrated, then the function is not output as assembler code
7635 in its own right.
7637 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7639 @item -fearly-inlining
7640 @opindex fearly-inlining
7641 Inline functions marked by @code{always_inline} and functions whose body seems
7642 smaller than the function call overhead early before doing
7643 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7644 makes profiling significantly cheaper and usually inlining faster on programs
7645 having large chains of nested wrapper functions.
7647 Enabled by default.
7649 @item -fipa-sra
7650 @opindex fipa-sra
7651 Perform interprocedural scalar replacement of aggregates, removal of
7652 unused parameters and replacement of parameters passed by reference
7653 by parameters passed by value.
7655 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7657 @item -finline-limit=@var{n}
7658 @opindex finline-limit
7659 By default, GCC limits the size of functions that can be inlined.  This flag
7660 allows coarse control of this limit.  @var{n} is the size of functions that
7661 can be inlined in number of pseudo instructions.
7663 Inlining is actually controlled by a number of parameters, which may be
7664 specified individually by using @option{--param @var{name}=@var{value}}.
7665 The @option{-finline-limit=@var{n}} option sets some of these parameters
7666 as follows:
7668 @table @gcctabopt
7669 @item max-inline-insns-single
7670 is set to @var{n}/2.
7671 @item max-inline-insns-auto
7672 is set to @var{n}/2.
7673 @end table
7675 See below for a documentation of the individual
7676 parameters controlling inlining and for the defaults of these parameters.
7678 @emph{Note:} there may be no value to @option{-finline-limit} that results
7679 in default behavior.
7681 @emph{Note:} pseudo instruction represents, in this particular context, an
7682 abstract measurement of function's size.  In no way does it represent a count
7683 of assembly instructions and as such its exact meaning might change from one
7684 release to an another.
7686 @item -fno-keep-inline-dllexport
7687 @opindex fno-keep-inline-dllexport
7688 This is a more fine-grained version of @option{-fkeep-inline-functions},
7689 which applies only to functions that are declared using the @code{dllexport}
7690 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7691 Functions}.
7693 @item -fkeep-inline-functions
7694 @opindex fkeep-inline-functions
7695 In C, emit @code{static} functions that are declared @code{inline}
7696 into the object file, even if the function has been inlined into all
7697 of its callers.  This switch does not affect functions using the
7698 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7699 inline functions into the object file.
7701 @item -fkeep-static-functions
7702 @opindex fkeep-static-functions
7703 Emit @code{static} functions into the object file, even if the function
7704 is never used.
7706 @item -fkeep-static-consts
7707 @opindex fkeep-static-consts
7708 Emit variables declared @code{static const} when optimization isn't turned
7709 on, even if the variables aren't referenced.
7711 GCC enables this option by default.  If you want to force the compiler to
7712 check if a variable is referenced, regardless of whether or not
7713 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7715 @item -fmerge-constants
7716 @opindex fmerge-constants
7717 Attempt to merge identical constants (string constants and floating-point
7718 constants) across compilation units.
7720 This option is the default for optimized compilation if the assembler and
7721 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7722 behavior.
7724 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7726 @item -fmerge-all-constants
7727 @opindex fmerge-all-constants
7728 Attempt to merge identical constants and identical variables.
7730 This option implies @option{-fmerge-constants}.  In addition to
7731 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7732 arrays or initialized constant variables with integral or floating-point
7733 types.  Languages like C or C++ require each variable, including multiple
7734 instances of the same variable in recursive calls, to have distinct locations,
7735 so using this option results in non-conforming
7736 behavior.
7738 @item -fmodulo-sched
7739 @opindex fmodulo-sched
7740 Perform swing modulo scheduling immediately before the first scheduling
7741 pass.  This pass looks at innermost loops and reorders their
7742 instructions by overlapping different iterations.
7744 @item -fmodulo-sched-allow-regmoves
7745 @opindex fmodulo-sched-allow-regmoves
7746 Perform more aggressive SMS-based modulo scheduling with register moves
7747 allowed.  By setting this flag certain anti-dependences edges are
7748 deleted, which triggers the generation of reg-moves based on the
7749 life-range analysis.  This option is effective only with
7750 @option{-fmodulo-sched} enabled.
7752 @item -fno-branch-count-reg
7753 @opindex fno-branch-count-reg
7754 Avoid running a pass scanning for opportunities to use ``decrement and
7755 branch'' instructions on a count register instead of generating sequences
7756 of instructions that decrement a register, compare it against zero, and
7757 then branch based upon the result.  This option is only meaningful on
7758 architectures that support such instructions, which include x86, PowerPC,
7759 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7760 doesn't remove the decrement and branch instructions from the generated
7761 instruction stream introduced by other optimization passes.
7763 Enabled by default at @option{-O1} and higher.
7765 The default is @option{-fbranch-count-reg}.
7767 @item -fno-function-cse
7768 @opindex fno-function-cse
7769 Do not put function addresses in registers; make each instruction that
7770 calls a constant function contain the function's address explicitly.
7772 This option results in less efficient code, but some strange hacks
7773 that alter the assembler output may be confused by the optimizations
7774 performed when this option is not used.
7776 The default is @option{-ffunction-cse}
7778 @item -fno-zero-initialized-in-bss
7779 @opindex fno-zero-initialized-in-bss
7780 If the target supports a BSS section, GCC by default puts variables that
7781 are initialized to zero into BSS@.  This can save space in the resulting
7782 code.
7784 This option turns off this behavior because some programs explicitly
7785 rely on variables going to the data section---e.g., so that the
7786 resulting executable can find the beginning of that section and/or make
7787 assumptions based on that.
7789 The default is @option{-fzero-initialized-in-bss}.
7791 @item -fthread-jumps
7792 @opindex fthread-jumps
7793 Perform optimizations that check to see if a jump branches to a
7794 location where another comparison subsumed by the first is found.  If
7795 so, the first branch is redirected to either the destination of the
7796 second branch or a point immediately following it, depending on whether
7797 the condition is known to be true or false.
7799 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7801 @item -fsplit-wide-types
7802 @opindex fsplit-wide-types
7803 When using a type that occupies multiple registers, such as @code{long
7804 long} on a 32-bit system, split the registers apart and allocate them
7805 independently.  This normally generates better code for those types,
7806 but may make debugging more difficult.
7808 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7809 @option{-Os}.
7811 @item -fcse-follow-jumps
7812 @opindex fcse-follow-jumps
7813 In common subexpression elimination (CSE), scan through jump instructions
7814 when the target of the jump is not reached by any other path.  For
7815 example, when CSE encounters an @code{if} statement with an
7816 @code{else} clause, CSE follows the jump when the condition
7817 tested is false.
7819 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7821 @item -fcse-skip-blocks
7822 @opindex fcse-skip-blocks
7823 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7824 follow jumps that conditionally skip over blocks.  When CSE
7825 encounters a simple @code{if} statement with no else clause,
7826 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7827 body of the @code{if}.
7829 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7831 @item -frerun-cse-after-loop
7832 @opindex frerun-cse-after-loop
7833 Re-run common subexpression elimination after loop optimizations are
7834 performed.
7836 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7838 @item -fgcse
7839 @opindex fgcse
7840 Perform a global common subexpression elimination pass.
7841 This pass also performs global constant and copy propagation.
7843 @emph{Note:} When compiling a program using computed gotos, a GCC
7844 extension, you may get better run-time performance if you disable
7845 the global common subexpression elimination pass by adding
7846 @option{-fno-gcse} to the command line.
7848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7850 @item -fgcse-lm
7851 @opindex fgcse-lm
7852 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7853 attempts to move loads that are only killed by stores into themselves.  This
7854 allows a loop containing a load/store sequence to be changed to a load outside
7855 the loop, and a copy/store within the loop.
7857 Enabled by default when @option{-fgcse} is enabled.
7859 @item -fgcse-sm
7860 @opindex fgcse-sm
7861 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7862 global common subexpression elimination.  This pass attempts to move
7863 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7864 loops containing a load/store sequence can be changed to a load before
7865 the loop and a store after the loop.
7867 Not enabled at any optimization level.
7869 @item -fgcse-las
7870 @opindex fgcse-las
7871 When @option{-fgcse-las} is enabled, the global common subexpression
7872 elimination pass eliminates redundant loads that come after stores to the
7873 same memory location (both partial and full redundancies).
7875 Not enabled at any optimization level.
7877 @item -fgcse-after-reload
7878 @opindex fgcse-after-reload
7879 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7880 pass is performed after reload.  The purpose of this pass is to clean up
7881 redundant spilling.
7883 @item -faggressive-loop-optimizations
7884 @opindex faggressive-loop-optimizations
7885 This option tells the loop optimizer to use language constraints to
7886 derive bounds for the number of iterations of a loop.  This assumes that
7887 loop code does not invoke undefined behavior by for example causing signed
7888 integer overflows or out-of-bound array accesses.  The bounds for the
7889 number of iterations of a loop are used to guide loop unrolling and peeling
7890 and loop exit test optimizations.
7891 This option is enabled by default.
7893 @item -funconstrained-commons
7894 @opindex funconstrained-commons
7895 This option tells the compiler that variables declared in common blocks
7896 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7897 prevents certain optimizations that depend on knowing the array bounds.
7899 @item -fcrossjumping
7900 @opindex fcrossjumping
7901 Perform cross-jumping transformation.
7902 This transformation unifies equivalent code and saves code size.  The
7903 resulting code may or may not perform better than without cross-jumping.
7905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7907 @item -fauto-inc-dec
7908 @opindex fauto-inc-dec
7909 Combine increments or decrements of addresses with memory accesses.
7910 This pass is always skipped on architectures that do not have
7911 instructions to support this.  Enabled by default at @option{-O} and
7912 higher on architectures that support this.
7914 @item -fdce
7915 @opindex fdce
7916 Perform dead code elimination (DCE) on RTL@.
7917 Enabled by default at @option{-O} and higher.
7919 @item -fdse
7920 @opindex fdse
7921 Perform dead store elimination (DSE) on RTL@.
7922 Enabled by default at @option{-O} and higher.
7924 @item -fif-conversion
7925 @opindex fif-conversion
7926 Attempt to transform conditional jumps into branch-less equivalents.  This
7927 includes use of conditional moves, min, max, set flags and abs instructions, and
7928 some tricks doable by standard arithmetics.  The use of conditional execution
7929 on chips where it is available is controlled by @option{-fif-conversion2}.
7931 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7933 @item -fif-conversion2
7934 @opindex fif-conversion2
7935 Use conditional execution (where available) to transform conditional jumps into
7936 branch-less equivalents.
7938 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7940 @item -fdeclone-ctor-dtor
7941 @opindex fdeclone-ctor-dtor
7942 The C++ ABI requires multiple entry points for constructors and
7943 destructors: one for a base subobject, one for a complete object, and
7944 one for a virtual destructor that calls operator delete afterwards.
7945 For a hierarchy with virtual bases, the base and complete variants are
7946 clones, which means two copies of the function.  With this option, the
7947 base and complete variants are changed to be thunks that call a common
7948 implementation.
7950 Enabled by @option{-Os}.
7952 @item -fdelete-null-pointer-checks
7953 @opindex fdelete-null-pointer-checks
7954 Assume that programs cannot safely dereference null pointers, and that
7955 no code or data element resides at address zero.
7956 This option enables simple constant
7957 folding optimizations at all optimization levels.  In addition, other
7958 optimization passes in GCC use this flag to control global dataflow
7959 analyses that eliminate useless checks for null pointers; these assume
7960 that a memory access to address zero always results in a trap, so
7961 that if a pointer is checked after it has already been dereferenced,
7962 it cannot be null.
7964 Note however that in some environments this assumption is not true.
7965 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7966 for programs that depend on that behavior.
7968 This option is enabled by default on most targets.  On Nios II ELF, it
7969 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7971 Passes that use the dataflow information
7972 are enabled independently at different optimization levels.
7974 @item -fdevirtualize
7975 @opindex fdevirtualize
7976 Attempt to convert calls to virtual functions to direct calls.  This
7977 is done both within a procedure and interprocedurally as part of
7978 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7979 propagation (@option{-fipa-cp}).
7980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7982 @item -fdevirtualize-speculatively
7983 @opindex fdevirtualize-speculatively
7984 Attempt to convert calls to virtual functions to speculative direct calls.
7985 Based on the analysis of the type inheritance graph, determine for a given call
7986 the set of likely targets. If the set is small, preferably of size 1, change
7987 the call into a conditional deciding between direct and indirect calls.  The
7988 speculative calls enable more optimizations, such as inlining.  When they seem
7989 useless after further optimization, they are converted back into original form.
7991 @item -fdevirtualize-at-ltrans
7992 @opindex fdevirtualize-at-ltrans
7993 Stream extra information needed for aggressive devirtualization when running
7994 the link-time optimizer in local transformation mode.  
7995 This option enables more devirtualization but
7996 significantly increases the size of streamed data. For this reason it is
7997 disabled by default.
7999 @item -fexpensive-optimizations
8000 @opindex fexpensive-optimizations
8001 Perform a number of minor optimizations that are relatively expensive.
8003 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8005 @item -free
8006 @opindex free
8007 Attempt to remove redundant extension instructions.  This is especially
8008 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8009 registers after writing to their lower 32-bit half.
8011 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8012 @option{-O3}, @option{-Os}.
8014 @item -fno-lifetime-dse
8015 @opindex fno-lifetime-dse
8016 In C++ the value of an object is only affected by changes within its
8017 lifetime: when the constructor begins, the object has an indeterminate
8018 value, and any changes during the lifetime of the object are dead when
8019 the object is destroyed.  Normally dead store elimination will take
8020 advantage of this; if your code relies on the value of the object
8021 storage persisting beyond the lifetime of the object, you can use this
8022 flag to disable this optimization.  To preserve stores before the
8023 constructor starts (e.g. because your operator new clears the object
8024 storage) but still treat the object as dead after the destructor you,
8025 can use @option{-flifetime-dse=1}.  The default behavior can be
8026 explicitly selected with @option{-flifetime-dse=2}.
8027 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8029 @item -flive-range-shrinkage
8030 @opindex flive-range-shrinkage
8031 Attempt to decrease register pressure through register live range
8032 shrinkage.  This is helpful for fast processors with small or moderate
8033 size register sets.
8035 @item -fira-algorithm=@var{algorithm}
8036 @opindex fira-algorithm
8037 Use the specified coloring algorithm for the integrated register
8038 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8039 specifies Chow's priority coloring, or @samp{CB}, which specifies
8040 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8041 for all architectures, but for those targets that do support it, it is
8042 the default because it generates better code.
8044 @item -fira-region=@var{region}
8045 @opindex fira-region
8046 Use specified regions for the integrated register allocator.  The
8047 @var{region} argument should be one of the following:
8049 @table @samp
8051 @item all
8052 Use all loops as register allocation regions.
8053 This can give the best results for machines with a small and/or
8054 irregular register set.
8056 @item mixed
8057 Use all loops except for loops with small register pressure 
8058 as the regions.  This value usually gives
8059 the best results in most cases and for most architectures,
8060 and is enabled by default when compiling with optimization for speed
8061 (@option{-O}, @option{-O2}, @dots{}).
8063 @item one
8064 Use all functions as a single region.  
8065 This typically results in the smallest code size, and is enabled by default for
8066 @option{-Os} or @option{-O0}.
8068 @end table
8070 @item -fira-hoist-pressure
8071 @opindex fira-hoist-pressure
8072 Use IRA to evaluate register pressure in the code hoisting pass for
8073 decisions to hoist expressions.  This option usually results in smaller
8074 code, but it can slow the compiler down.
8076 This option is enabled at level @option{-Os} for all targets.
8078 @item -fira-loop-pressure
8079 @opindex fira-loop-pressure
8080 Use IRA to evaluate register pressure in loops for decisions to move
8081 loop invariants.  This option usually results in generation
8082 of faster and smaller code on machines with large register files (>= 32
8083 registers), but it can slow the compiler down.
8085 This option is enabled at level @option{-O3} for some targets.
8087 @item -fno-ira-share-save-slots
8088 @opindex fno-ira-share-save-slots
8089 Disable sharing of stack slots used for saving call-used hard
8090 registers living through a call.  Each hard register gets a
8091 separate stack slot, and as a result function stack frames are
8092 larger.
8094 @item -fno-ira-share-spill-slots
8095 @opindex fno-ira-share-spill-slots
8096 Disable sharing of stack slots allocated for pseudo-registers.  Each
8097 pseudo-register that does not get a hard register gets a separate
8098 stack slot, and as a result function stack frames are larger.
8100 @item -flra-remat
8101 @opindex flra-remat
8102 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8103 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8104 values if it is profitable.
8106 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8108 @item -fdelayed-branch
8109 @opindex fdelayed-branch
8110 If supported for the target machine, attempt to reorder instructions
8111 to exploit instruction slots available after delayed branch
8112 instructions.
8114 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8116 @item -fschedule-insns
8117 @opindex fschedule-insns
8118 If supported for the target machine, attempt to reorder instructions to
8119 eliminate execution stalls due to required data being unavailable.  This
8120 helps machines that have slow floating point or memory load instructions
8121 by allowing other instructions to be issued until the result of the load
8122 or floating-point instruction is required.
8124 Enabled at levels @option{-O2}, @option{-O3}.
8126 @item -fschedule-insns2
8127 @opindex fschedule-insns2
8128 Similar to @option{-fschedule-insns}, but requests an additional pass of
8129 instruction scheduling after register allocation has been done.  This is
8130 especially useful on machines with a relatively small number of
8131 registers and where memory load instructions take more than one cycle.
8133 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8135 @item -fno-sched-interblock
8136 @opindex fno-sched-interblock
8137 Don't schedule instructions across basic blocks.  This is normally
8138 enabled by default when scheduling before register allocation, i.e.@:
8139 with @option{-fschedule-insns} or at @option{-O2} or higher.
8141 @item -fno-sched-spec
8142 @opindex fno-sched-spec
8143 Don't allow speculative motion of non-load instructions.  This is normally
8144 enabled by default when scheduling before register allocation, i.e.@:
8145 with @option{-fschedule-insns} or at @option{-O2} or higher.
8147 @item -fsched-pressure
8148 @opindex fsched-pressure
8149 Enable register pressure sensitive insn scheduling before register
8150 allocation.  This only makes sense when scheduling before register
8151 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8152 @option{-O2} or higher.  Usage of this option can improve the
8153 generated code and decrease its size by preventing register pressure
8154 increase above the number of available hard registers and subsequent
8155 spills in register allocation.
8157 @item -fsched-spec-load
8158 @opindex fsched-spec-load
8159 Allow speculative motion of some load instructions.  This only makes
8160 sense when scheduling before register allocation, i.e.@: with
8161 @option{-fschedule-insns} or at @option{-O2} or higher.
8163 @item -fsched-spec-load-dangerous
8164 @opindex fsched-spec-load-dangerous
8165 Allow speculative motion of more load instructions.  This only makes
8166 sense when scheduling before register allocation, i.e.@: with
8167 @option{-fschedule-insns} or at @option{-O2} or higher.
8169 @item -fsched-stalled-insns
8170 @itemx -fsched-stalled-insns=@var{n}
8171 @opindex fsched-stalled-insns
8172 Define how many insns (if any) can be moved prematurely from the queue
8173 of stalled insns into the ready list during the second scheduling pass.
8174 @option{-fno-sched-stalled-insns} means that no insns are moved
8175 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8176 on how many queued insns can be moved prematurely.
8177 @option{-fsched-stalled-insns} without a value is equivalent to
8178 @option{-fsched-stalled-insns=1}.
8180 @item -fsched-stalled-insns-dep
8181 @itemx -fsched-stalled-insns-dep=@var{n}
8182 @opindex fsched-stalled-insns-dep
8183 Define how many insn groups (cycles) are examined for a dependency
8184 on a stalled insn that is a candidate for premature removal from the queue
8185 of stalled insns.  This has an effect only during the second scheduling pass,
8186 and only if @option{-fsched-stalled-insns} is used.
8187 @option{-fno-sched-stalled-insns-dep} is equivalent to
8188 @option{-fsched-stalled-insns-dep=0}.
8189 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8190 @option{-fsched-stalled-insns-dep=1}.
8192 @item -fsched2-use-superblocks
8193 @opindex fsched2-use-superblocks
8194 When scheduling after register allocation, use superblock scheduling.
8195 This allows motion across basic block boundaries,
8196 resulting in faster schedules.  This option is experimental, as not all machine
8197 descriptions used by GCC model the CPU closely enough to avoid unreliable
8198 results from the algorithm.
8200 This only makes sense when scheduling after register allocation, i.e.@: with
8201 @option{-fschedule-insns2} or at @option{-O2} or higher.
8203 @item -fsched-group-heuristic
8204 @opindex fsched-group-heuristic
8205 Enable the group heuristic in the scheduler.  This heuristic favors
8206 the instruction that belongs to a schedule group.  This is enabled
8207 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8208 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8210 @item -fsched-critical-path-heuristic
8211 @opindex fsched-critical-path-heuristic
8212 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8213 instructions on the critical path.  This is enabled by default when
8214 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8215 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8217 @item -fsched-spec-insn-heuristic
8218 @opindex fsched-spec-insn-heuristic
8219 Enable the speculative instruction heuristic in the scheduler.  This
8220 heuristic favors speculative instructions with greater dependency weakness.
8221 This is enabled by default when scheduling is enabled, i.e.@:
8222 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8223 or at @option{-O2} or higher.
8225 @item -fsched-rank-heuristic
8226 @opindex fsched-rank-heuristic
8227 Enable the rank heuristic in the scheduler.  This heuristic favors
8228 the instruction belonging to a basic block with greater size or frequency.
8229 This is enabled by default when scheduling is enabled, i.e.@:
8230 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8231 at @option{-O2} or higher.
8233 @item -fsched-last-insn-heuristic
8234 @opindex fsched-last-insn-heuristic
8235 Enable the last-instruction heuristic in the scheduler.  This heuristic
8236 favors the instruction that is less dependent on the last instruction
8237 scheduled.  This is enabled by default when scheduling is enabled,
8238 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8239 at @option{-O2} or higher.
8241 @item -fsched-dep-count-heuristic
8242 @opindex fsched-dep-count-heuristic
8243 Enable the dependent-count heuristic in the scheduler.  This heuristic
8244 favors the instruction that has more instructions depending on it.
8245 This is enabled by default when scheduling is enabled, i.e.@:
8246 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8247 at @option{-O2} or higher.
8249 @item -freschedule-modulo-scheduled-loops
8250 @opindex freschedule-modulo-scheduled-loops
8251 Modulo scheduling is performed before traditional scheduling.  If a loop
8252 is modulo scheduled, later scheduling passes may change its schedule.  
8253 Use this option to control that behavior.
8255 @item -fselective-scheduling
8256 @opindex fselective-scheduling
8257 Schedule instructions using selective scheduling algorithm.  Selective
8258 scheduling runs instead of the first scheduler pass.
8260 @item -fselective-scheduling2
8261 @opindex fselective-scheduling2
8262 Schedule instructions using selective scheduling algorithm.  Selective
8263 scheduling runs instead of the second scheduler pass.
8265 @item -fsel-sched-pipelining
8266 @opindex fsel-sched-pipelining
8267 Enable software pipelining of innermost loops during selective scheduling.
8268 This option has no effect unless one of @option{-fselective-scheduling} or
8269 @option{-fselective-scheduling2} is turned on.
8271 @item -fsel-sched-pipelining-outer-loops
8272 @opindex fsel-sched-pipelining-outer-loops
8273 When pipelining loops during selective scheduling, also pipeline outer loops.
8274 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8276 @item -fsemantic-interposition
8277 @opindex fsemantic-interposition
8278 Some object formats, like ELF, allow interposing of symbols by the 
8279 dynamic linker.
8280 This means that for symbols exported from the DSO, the compiler cannot perform
8281 interprocedural propagation, inlining and other optimizations in anticipation
8282 that the function or variable in question may change. While this feature is
8283 useful, for example, to rewrite memory allocation functions by a debugging
8284 implementation, it is expensive in the terms of code quality.
8285 With @option{-fno-semantic-interposition} the compiler assumes that 
8286 if interposition happens for functions the overwriting function will have 
8287 precisely the same semantics (and side effects). 
8288 Similarly if interposition happens
8289 for variables, the constructor of the variable will be the same. The flag
8290 has no effect for functions explicitly declared inline 
8291 (where it is never allowed for interposition to change semantics) 
8292 and for symbols explicitly declared weak.
8294 @item -fshrink-wrap
8295 @opindex fshrink-wrap
8296 Emit function prologues only before parts of the function that need it,
8297 rather than at the top of the function.  This flag is enabled by default at
8298 @option{-O} and higher.
8300 @item -fshrink-wrap-separate
8301 @opindex fshrink-wrap-separate
8302 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8303 those parts are only executed when needed.
8304 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8305 is also turned on and the target supports this.
8307 @item -fcaller-saves
8308 @opindex fcaller-saves
8309 Enable allocation of values to registers that are clobbered by
8310 function calls, by emitting extra instructions to save and restore the
8311 registers around such calls.  Such allocation is done only when it
8312 seems to result in better code.
8314 This option is always enabled by default on certain machines, usually
8315 those which have no call-preserved registers to use instead.
8317 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8319 @item -fcombine-stack-adjustments
8320 @opindex fcombine-stack-adjustments
8321 Tracks stack adjustments (pushes and pops) and stack memory references
8322 and then tries to find ways to combine them.
8324 Enabled by default at @option{-O1} and higher.
8326 @item -fipa-ra
8327 @opindex fipa-ra
8328 Use caller save registers for allocation if those registers are not used by
8329 any called function.  In that case it is not necessary to save and restore
8330 them around calls.  This is only possible if called functions are part of
8331 same compilation unit as current function and they are compiled before it.
8333 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8334 is disabled if generated code will be instrumented for profiling
8335 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8336 exactly (this happens on targets that do not expose prologues
8337 and epilogues in RTL).
8339 @item -fconserve-stack
8340 @opindex fconserve-stack
8341 Attempt to minimize stack usage.  The compiler attempts to use less
8342 stack space, even if that makes the program slower.  This option
8343 implies setting the @option{large-stack-frame} parameter to 100
8344 and the @option{large-stack-frame-growth} parameter to 400.
8346 @item -ftree-reassoc
8347 @opindex ftree-reassoc
8348 Perform reassociation on trees.  This flag is enabled by default
8349 at @option{-O} and higher.
8351 @item -fcode-hoisting
8352 @opindex fcode-hoisting
8353 Perform code hoisting.  Code hoisting tries to move the
8354 evaluation of expressions executed on all paths to the function exit
8355 as early as possible.  This is especially useful as a code size
8356 optimization, but it often helps for code speed as well.
8357 This flag is enabled by default at @option{-O2} and higher.
8359 @item -ftree-pre
8360 @opindex ftree-pre
8361 Perform partial redundancy elimination (PRE) on trees.  This flag is
8362 enabled by default at @option{-O2} and @option{-O3}.
8364 @item -ftree-partial-pre
8365 @opindex ftree-partial-pre
8366 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8367 enabled by default at @option{-O3}.
8369 @item -ftree-forwprop
8370 @opindex ftree-forwprop
8371 Perform forward propagation on trees.  This flag is enabled by default
8372 at @option{-O} and higher.
8374 @item -ftree-fre
8375 @opindex ftree-fre
8376 Perform full redundancy elimination (FRE) on trees.  The difference
8377 between FRE and PRE is that FRE only considers expressions
8378 that are computed on all paths leading to the redundant computation.
8379 This analysis is faster than PRE, though it exposes fewer redundancies.
8380 This flag is enabled by default at @option{-O} and higher.
8382 @item -ftree-phiprop
8383 @opindex ftree-phiprop
8384 Perform hoisting of loads from conditional pointers on trees.  This
8385 pass is enabled by default at @option{-O} and higher.
8387 @item -fhoist-adjacent-loads
8388 @opindex fhoist-adjacent-loads
8389 Speculatively hoist loads from both branches of an if-then-else if the
8390 loads are from adjacent locations in the same structure and the target
8391 architecture has a conditional move instruction.  This flag is enabled
8392 by default at @option{-O2} and higher.
8394 @item -ftree-copy-prop
8395 @opindex ftree-copy-prop
8396 Perform copy propagation on trees.  This pass eliminates unnecessary
8397 copy operations.  This flag is enabled by default at @option{-O} and
8398 higher.
8400 @item -fipa-pure-const
8401 @opindex fipa-pure-const
8402 Discover which functions are pure or constant.
8403 Enabled by default at @option{-O} and higher.
8405 @item -fipa-reference
8406 @opindex fipa-reference
8407 Discover which static variables do not escape the
8408 compilation unit.
8409 Enabled by default at @option{-O} and higher.
8411 @item -fipa-pta
8412 @opindex fipa-pta
8413 Perform interprocedural pointer analysis and interprocedural modification
8414 and reference analysis.  This option can cause excessive memory and
8415 compile-time usage on large compilation units.  It is not enabled by
8416 default at any optimization level.
8418 @item -fipa-profile
8419 @opindex fipa-profile
8420 Perform interprocedural profile propagation.  The functions called only from
8421 cold functions are marked as cold. Also functions executed once (such as
8422 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8423 functions and loop less parts of functions executed once are then optimized for
8424 size.
8425 Enabled by default at @option{-O} and higher.
8427 @item -fipa-cp
8428 @opindex fipa-cp
8429 Perform interprocedural constant propagation.
8430 This optimization analyzes the program to determine when values passed
8431 to functions are constants and then optimizes accordingly.
8432 This optimization can substantially increase performance
8433 if the application has constants passed to functions.
8434 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8436 @item -fipa-cp-clone
8437 @opindex fipa-cp-clone
8438 Perform function cloning to make interprocedural constant propagation stronger.
8439 When enabled, interprocedural constant propagation performs function cloning
8440 when externally visible function can be called with constant arguments.
8441 Because this optimization can create multiple copies of functions,
8442 it may significantly increase code size
8443 (see @option{--param ipcp-unit-growth=@var{value}}).
8444 This flag is enabled by default at @option{-O3}.
8446 @item -fipa-bit-cp
8447 @opindex -fipa-bit-cp
8448 When enabled, perform interprocedural bitwise constant
8449 propagation. This flag is enabled by default at @option{-O2}. It
8450 requires that @option{-fipa-cp} is enabled.
8452 @item -fipa-vrp
8453 @opindex -fipa-vrp
8454 When enabled, perform interprocedural propagation of value
8455 ranges. This flag is enabled by default at @option{-O2}. It requires
8456 that @option{-fipa-cp} is enabled.
8458 @item -fipa-icf
8459 @opindex fipa-icf
8460 Perform Identical Code Folding for functions and read-only variables.
8461 The optimization reduces code size and may disturb unwind stacks by replacing
8462 a function by equivalent one with a different name. The optimization works
8463 more effectively with link-time optimization enabled.
8465 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8466 works on different levels and thus the optimizations are not same - there are
8467 equivalences that are found only by GCC and equivalences found only by Gold.
8469 This flag is enabled by default at @option{-O2} and @option{-Os}.
8471 @item -fisolate-erroneous-paths-dereference
8472 @opindex fisolate-erroneous-paths-dereference
8473 Detect paths that trigger erroneous or undefined behavior due to
8474 dereferencing a null pointer.  Isolate those paths from the main control
8475 flow and turn the statement with erroneous or undefined behavior into a trap.
8476 This flag is enabled by default at @option{-O2} and higher and depends on
8477 @option{-fdelete-null-pointer-checks} also being enabled.
8479 @item -fisolate-erroneous-paths-attribute
8480 @opindex fisolate-erroneous-paths-attribute
8481 Detect paths that trigger erroneous or undefined behavior due a null value
8482 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8483 attribute.  Isolate those paths from the main control flow and turn the
8484 statement with erroneous or undefined behavior into a trap.  This is not
8485 currently enabled, but may be enabled by @option{-O2} in the future.
8487 @item -ftree-sink
8488 @opindex ftree-sink
8489 Perform forward store motion on trees.  This flag is
8490 enabled by default at @option{-O} and higher.
8492 @item -ftree-bit-ccp
8493 @opindex ftree-bit-ccp
8494 Perform sparse conditional bit constant propagation on trees and propagate
8495 pointer alignment information.
8496 This pass only operates on local scalar variables and is enabled by default
8497 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8499 @item -ftree-ccp
8500 @opindex ftree-ccp
8501 Perform sparse conditional constant propagation (CCP) on trees.  This
8502 pass only operates on local scalar variables and is enabled by default
8503 at @option{-O} and higher.
8505 @item -fssa-backprop
8506 @opindex fssa-backprop
8507 Propagate information about uses of a value up the definition chain
8508 in order to simplify the definitions.  For example, this pass strips
8509 sign operations if the sign of a value never matters.  The flag is
8510 enabled by default at @option{-O} and higher.
8512 @item -fssa-phiopt
8513 @opindex fssa-phiopt
8514 Perform pattern matching on SSA PHI nodes to optimize conditional
8515 code.  This pass is enabled by default at @option{-O} and higher.
8517 @item -ftree-switch-conversion
8518 @opindex ftree-switch-conversion
8519 Perform conversion of simple initializations in a switch to
8520 initializations from a scalar array.  This flag is enabled by default
8521 at @option{-O2} and higher.
8523 @item -ftree-tail-merge
8524 @opindex ftree-tail-merge
8525 Look for identical code sequences.  When found, replace one with a jump to the
8526 other.  This optimization is known as tail merging or cross jumping.  This flag
8527 is enabled by default at @option{-O2} and higher.  The compilation time
8528 in this pass can
8529 be limited using @option{max-tail-merge-comparisons} parameter and
8530 @option{max-tail-merge-iterations} parameter.
8532 @item -ftree-dce
8533 @opindex ftree-dce
8534 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8535 default at @option{-O} and higher.
8537 @item -ftree-builtin-call-dce
8538 @opindex ftree-builtin-call-dce
8539 Perform conditional dead code elimination (DCE) for calls to built-in functions
8540 that may set @code{errno} but are otherwise side-effect free.  This flag is
8541 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8542 specified.
8544 @item -ftree-dominator-opts
8545 @opindex ftree-dominator-opts
8546 Perform a variety of simple scalar cleanups (constant/copy
8547 propagation, redundancy elimination, range propagation and expression
8548 simplification) based on a dominator tree traversal.  This also
8549 performs jump threading (to reduce jumps to jumps). This flag is
8550 enabled by default at @option{-O} and higher.
8552 @item -ftree-dse
8553 @opindex ftree-dse
8554 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8555 a memory location that is later overwritten by another store without
8556 any intervening loads.  In this case the earlier store can be deleted.  This
8557 flag is enabled by default at @option{-O} and higher.
8559 @item -ftree-ch
8560 @opindex ftree-ch
8561 Perform loop header copying on trees.  This is beneficial since it increases
8562 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8563 is enabled by default at @option{-O} and higher.  It is not enabled
8564 for @option{-Os}, since it usually increases code size.
8566 @item -ftree-loop-optimize
8567 @opindex ftree-loop-optimize
8568 Perform loop optimizations on trees.  This flag is enabled by default
8569 at @option{-O} and higher.
8571 @item -ftree-loop-linear
8572 @itemx -floop-strip-mine
8573 @itemx -floop-block
8574 @opindex ftree-loop-linear
8575 @opindex floop-strip-mine
8576 @opindex floop-block
8577 Perform loop nest optimizations.  Same as
8578 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8579 to be configured with @option{--with-isl} to enable the Graphite loop
8580 transformation infrastructure.
8582 @item -fgraphite-identity
8583 @opindex fgraphite-identity
8584 Enable the identity transformation for graphite.  For every SCoP we generate
8585 the polyhedral representation and transform it back to gimple.  Using
8586 @option{-fgraphite-identity} we can check the costs or benefits of the
8587 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8588 are also performed by the code generator isl, like index splitting and
8589 dead code elimination in loops.
8591 @item -floop-nest-optimize
8592 @opindex floop-nest-optimize
8593 Enable the isl based loop nest optimizer.  This is a generic loop nest
8594 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8595 structure optimized for data-locality and parallelism.  This option
8596 is experimental.
8598 @item -floop-parallelize-all
8599 @opindex floop-parallelize-all
8600 Use the Graphite data dependence analysis to identify loops that can
8601 be parallelized.  Parallelize all the loops that can be analyzed to
8602 not contain loop carried dependences without checking that it is
8603 profitable to parallelize the loops.
8605 @item -ftree-coalesce-vars
8606 @opindex ftree-coalesce-vars
8607 While transforming the program out of the SSA representation, attempt to
8608 reduce copying by coalescing versions of different user-defined
8609 variables, instead of just compiler temporaries.  This may severely
8610 limit the ability to debug an optimized program compiled with
8611 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8612 prevents SSA coalescing of user variables.  This option is enabled by
8613 default if optimization is enabled, and it does very little otherwise.
8615 @item -ftree-loop-if-convert
8616 @opindex ftree-loop-if-convert
8617 Attempt to transform conditional jumps in the innermost loops to
8618 branch-less equivalents.  The intent is to remove control-flow from
8619 the innermost loops in order to improve the ability of the
8620 vectorization pass to handle these loops.  This is enabled by default
8621 if vectorization is enabled.
8623 @item -ftree-loop-distribution
8624 @opindex ftree-loop-distribution
8625 Perform loop distribution.  This flag can improve cache performance on
8626 big loop bodies and allow further loop optimizations, like
8627 parallelization or vectorization, to take place.  For example, the loop
8628 @smallexample
8629 DO I = 1, N
8630   A(I) = B(I) + C
8631   D(I) = E(I) * F
8632 ENDDO
8633 @end smallexample
8634 is transformed to
8635 @smallexample
8636 DO I = 1, N
8637    A(I) = B(I) + C
8638 ENDDO
8639 DO I = 1, N
8640    D(I) = E(I) * F
8641 ENDDO
8642 @end smallexample
8644 @item -ftree-loop-distribute-patterns
8645 @opindex ftree-loop-distribute-patterns
8646 Perform loop distribution of patterns that can be code generated with
8647 calls to a library.  This flag is enabled by default at @option{-O3}.
8649 This pass distributes the initialization loops and generates a call to
8650 memset zero.  For example, the loop
8651 @smallexample
8652 DO I = 1, N
8653   A(I) = 0
8654   B(I) = A(I) + I
8655 ENDDO
8656 @end smallexample
8657 is transformed to
8658 @smallexample
8659 DO I = 1, N
8660    A(I) = 0
8661 ENDDO
8662 DO I = 1, N
8663    B(I) = A(I) + I
8664 ENDDO
8665 @end smallexample
8666 and the initialization loop is transformed into a call to memset zero.
8668 @item -floop-interchange
8669 @opindex floop-interchange
8670 Perform loop interchange outside of graphite.  This flag can improve cache
8671 performance on loop nest and allow further loop optimizations, like
8672 vectorization, to take place.  For example, the loop
8673 @smallexample
8674 for (int i = 0; i < N; i++)
8675   for (int j = 0; j < N; j++)
8676     for (int k = 0; k < N; k++)
8677       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8678 @end smallexample
8679 is transformed to
8680 @smallexample
8681 for (int i = 0; i < N; i++)
8682   for (int k = 0; k < N; k++)
8683     for (int j = 0; j < N; j++)
8684       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8685 @end smallexample
8687 @item -ftree-loop-im
8688 @opindex ftree-loop-im
8689 Perform loop invariant motion on trees.  This pass moves only invariants that
8690 are hard to handle at RTL level (function calls, operations that expand to
8691 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8692 operands of conditions that are invariant out of the loop, so that we can use
8693 just trivial invariantness analysis in loop unswitching.  The pass also includes
8694 store motion.
8696 @item -ftree-loop-ivcanon
8697 @opindex ftree-loop-ivcanon
8698 Create a canonical counter for number of iterations in loops for which
8699 determining number of iterations requires complicated analysis.  Later
8700 optimizations then may determine the number easily.  Useful especially
8701 in connection with unrolling.
8703 @item -fivopts
8704 @opindex fivopts
8705 Perform induction variable optimizations (strength reduction, induction
8706 variable merging and induction variable elimination) on trees.
8708 @item -ftree-parallelize-loops=n
8709 @opindex ftree-parallelize-loops
8710 Parallelize loops, i.e., split their iteration space to run in n threads.
8711 This is only possible for loops whose iterations are independent
8712 and can be arbitrarily reordered.  The optimization is only
8713 profitable on multiprocessor machines, for loops that are CPU-intensive,
8714 rather than constrained e.g.@: by memory bandwidth.  This option
8715 implies @option{-pthread}, and thus is only supported on targets
8716 that have support for @option{-pthread}.
8718 @item -ftree-pta
8719 @opindex ftree-pta
8720 Perform function-local points-to analysis on trees.  This flag is
8721 enabled by default at @option{-O} and higher.
8723 @item -ftree-sra
8724 @opindex ftree-sra
8725 Perform scalar replacement of aggregates.  This pass replaces structure
8726 references with scalars to prevent committing structures to memory too
8727 early.  This flag is enabled by default at @option{-O} and higher.
8729 @item -fstore-merging
8730 @opindex fstore-merging
8731 Perform merging of narrow stores to consecutive memory addresses.  This pass
8732 merges contiguous stores of immediate values narrower than a word into fewer
8733 wider stores to reduce the number of instructions.  This is enabled by default
8734 at @option{-O2} and higher as well as @option{-Os}.
8736 @item -ftree-ter
8737 @opindex ftree-ter
8738 Perform temporary expression replacement during the SSA->normal phase.  Single
8739 use/single def temporaries are replaced at their use location with their
8740 defining expression.  This results in non-GIMPLE code, but gives the expanders
8741 much more complex trees to work on resulting in better RTL generation.  This is
8742 enabled by default at @option{-O} and higher.
8744 @item -ftree-slsr
8745 @opindex ftree-slsr
8746 Perform straight-line strength reduction on trees.  This recognizes related
8747 expressions involving multiplications and replaces them by less expensive
8748 calculations when possible.  This is enabled by default at @option{-O} and
8749 higher.
8751 @item -ftree-vectorize
8752 @opindex ftree-vectorize
8753 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8754 and @option{-ftree-slp-vectorize} if not explicitly specified.
8756 @item -ftree-loop-vectorize
8757 @opindex ftree-loop-vectorize
8758 Perform loop vectorization on trees. This flag is enabled by default at
8759 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8761 @item -ftree-slp-vectorize
8762 @opindex ftree-slp-vectorize
8763 Perform basic block vectorization on trees. This flag is enabled by default at
8764 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8766 @item -fvect-cost-model=@var{model}
8767 @opindex fvect-cost-model
8768 Alter the cost model used for vectorization.  The @var{model} argument
8769 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8770 With the @samp{unlimited} model the vectorized code-path is assumed
8771 to be profitable while with the @samp{dynamic} model a runtime check
8772 guards the vectorized code-path to enable it only for iteration
8773 counts that will likely execute faster than when executing the original
8774 scalar loop.  The @samp{cheap} model disables vectorization of
8775 loops where doing so would be cost prohibitive for example due to
8776 required runtime checks for data dependence or alignment but otherwise
8777 is equal to the @samp{dynamic} model.
8778 The default cost model depends on other optimization flags and is
8779 either @samp{dynamic} or @samp{cheap}.
8781 @item -fsimd-cost-model=@var{model}
8782 @opindex fsimd-cost-model
8783 Alter the cost model used for vectorization of loops marked with the OpenMP
8784 or Cilk Plus simd directive.  The @var{model} argument should be one of
8785 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8786 have the same meaning as described in @option{-fvect-cost-model} and by
8787 default a cost model defined with @option{-fvect-cost-model} is used.
8789 @item -ftree-vrp
8790 @opindex ftree-vrp
8791 Perform Value Range Propagation on trees.  This is similar to the
8792 constant propagation pass, but instead of values, ranges of values are
8793 propagated.  This allows the optimizers to remove unnecessary range
8794 checks like array bound checks and null pointer checks.  This is
8795 enabled by default at @option{-O2} and higher.  Null pointer check
8796 elimination is only done if @option{-fdelete-null-pointer-checks} is
8797 enabled.
8799 @item -fsplit-paths
8800 @opindex fsplit-paths
8801 Split paths leading to loop backedges.  This can improve dead code
8802 elimination and common subexpression elimination.  This is enabled by
8803 default at @option{-O2} and above.
8805 @item -fsplit-ivs-in-unroller
8806 @opindex fsplit-ivs-in-unroller
8807 Enables expression of values of induction variables in later iterations
8808 of the unrolled loop using the value in the first iteration.  This breaks
8809 long dependency chains, thus improving efficiency of the scheduling passes.
8811 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8812 same effect.  However, that is not reliable in cases where the loop body
8813 is more complicated than a single basic block.  It also does not work at all
8814 on some architectures due to restrictions in the CSE pass.
8816 This optimization is enabled by default.
8818 @item -fvariable-expansion-in-unroller
8819 @opindex fvariable-expansion-in-unroller
8820 With this option, the compiler creates multiple copies of some
8821 local variables when unrolling a loop, which can result in superior code.
8823 @item -fpartial-inlining
8824 @opindex fpartial-inlining
8825 Inline parts of functions.  This option has any effect only
8826 when inlining itself is turned on by the @option{-finline-functions}
8827 or @option{-finline-small-functions} options.
8829 Enabled at level @option{-O2}.
8831 @item -fpredictive-commoning
8832 @opindex fpredictive-commoning
8833 Perform predictive commoning optimization, i.e., reusing computations
8834 (especially memory loads and stores) performed in previous
8835 iterations of loops.
8837 This option is enabled at level @option{-O3}.
8839 @item -fprefetch-loop-arrays
8840 @opindex fprefetch-loop-arrays
8841 If supported by the target machine, generate instructions to prefetch
8842 memory to improve the performance of loops that access large arrays.
8844 This option may generate better or worse code; results are highly
8845 dependent on the structure of loops within the source code.
8847 Disabled at level @option{-Os}.
8849 @item -fno-printf-return-value
8850 @opindex fno-printf-return-value
8851 Do not substitute constants for known return value of formatted output
8852 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8853 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8854 transformation allows GCC to optimize or even eliminate branches based
8855 on the known return value of these functions called with arguments that
8856 are either constant, or whose values are known to be in a range that
8857 makes determining the exact return value possible.  For example, when
8858 @option{-fprintf-return-value} is in effect, both the branch and the
8859 body of the @code{if} statement (but not the call to @code{snprint})
8860 can be optimized away when @code{i} is a 32-bit or smaller integer
8861 because the return value is guaranteed to be at most 8.
8863 @smallexample
8864 char buf[9];
8865 if (snprintf (buf, "%08x", i) >= sizeof buf)
8866   @dots{}
8867 @end smallexample
8869 The @option{-fprintf-return-value} option relies on other optimizations
8870 and yields best results with @option{-O2}.  It works in tandem with the
8871 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8872 The @option{-fprintf-return-value} option is enabled by default.
8874 @item -fno-peephole
8875 @itemx -fno-peephole2
8876 @opindex fno-peephole
8877 @opindex fno-peephole2
8878 Disable any machine-specific peephole optimizations.  The difference
8879 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8880 are implemented in the compiler; some targets use one, some use the
8881 other, a few use both.
8883 @option{-fpeephole} is enabled by default.
8884 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8886 @item -fno-guess-branch-probability
8887 @opindex fno-guess-branch-probability
8888 Do not guess branch probabilities using heuristics.
8890 GCC uses heuristics to guess branch probabilities if they are
8891 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8892 heuristics are based on the control flow graph.  If some branch probabilities
8893 are specified by @code{__builtin_expect}, then the heuristics are
8894 used to guess branch probabilities for the rest of the control flow graph,
8895 taking the @code{__builtin_expect} info into account.  The interactions
8896 between the heuristics and @code{__builtin_expect} can be complex, and in
8897 some cases, it may be useful to disable the heuristics so that the effects
8898 of @code{__builtin_expect} are easier to understand.
8900 The default is @option{-fguess-branch-probability} at levels
8901 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8903 @item -freorder-blocks
8904 @opindex freorder-blocks
8905 Reorder basic blocks in the compiled function in order to reduce number of
8906 taken branches and improve code locality.
8908 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8910 @item -freorder-blocks-algorithm=@var{algorithm}
8911 @opindex freorder-blocks-algorithm
8912 Use the specified algorithm for basic block reordering.  The
8913 @var{algorithm} argument can be @samp{simple}, which does not increase
8914 code size (except sometimes due to secondary effects like alignment),
8915 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8916 put all often executed code together, minimizing the number of branches
8917 executed by making extra copies of code.
8919 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8920 @samp{stc} at levels @option{-O2}, @option{-O3}.
8922 @item -freorder-blocks-and-partition
8923 @opindex freorder-blocks-and-partition
8924 In addition to reordering basic blocks in the compiled function, in order
8925 to reduce number of taken branches, partitions hot and cold basic blocks
8926 into separate sections of the assembly and @file{.o} files, to improve
8927 paging and cache locality performance.
8929 This optimization is automatically turned off in the presence of
8930 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8931 section attribute and on any architecture that does not support named
8932 sections.  When @option{-fsplit-stack} is used this option is not
8933 enabled by default (to avoid linker errors), but may be enabled
8934 explicitly (if using a working linker).
8936 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8938 @item -freorder-functions
8939 @opindex freorder-functions
8940 Reorder functions in the object file in order to
8941 improve code locality.  This is implemented by using special
8942 subsections @code{.text.hot} for most frequently executed functions and
8943 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8944 the linker so object file format must support named sections and linker must
8945 place them in a reasonable way.
8947 Also profile feedback must be available to make this option effective.  See
8948 @option{-fprofile-arcs} for details.
8950 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8952 @item -fstrict-aliasing
8953 @opindex fstrict-aliasing
8954 Allow the compiler to assume the strictest aliasing rules applicable to
8955 the language being compiled.  For C (and C++), this activates
8956 optimizations based on the type of expressions.  In particular, an
8957 object of one type is assumed never to reside at the same address as an
8958 object of a different type, unless the types are almost the same.  For
8959 example, an @code{unsigned int} can alias an @code{int}, but not a
8960 @code{void*} or a @code{double}.  A character type may alias any other
8961 type.
8963 @anchor{Type-punning}Pay special attention to code like this:
8964 @smallexample
8965 union a_union @{
8966   int i;
8967   double d;
8970 int f() @{
8971   union a_union t;
8972   t.d = 3.0;
8973   return t.i;
8975 @end smallexample
8976 The practice of reading from a different union member than the one most
8977 recently written to (called ``type-punning'') is common.  Even with
8978 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8979 is accessed through the union type.  So, the code above works as
8980 expected.  @xref{Structures unions enumerations and bit-fields
8981 implementation}.  However, this code might not:
8982 @smallexample
8983 int f() @{
8984   union a_union t;
8985   int* ip;
8986   t.d = 3.0;
8987   ip = &t.i;
8988   return *ip;
8990 @end smallexample
8992 Similarly, access by taking the address, casting the resulting pointer
8993 and dereferencing the result has undefined behavior, even if the cast
8994 uses a union type, e.g.:
8995 @smallexample
8996 int f() @{
8997   double d = 3.0;
8998   return ((union a_union *) &d)->i;
9000 @end smallexample
9002 The @option{-fstrict-aliasing} option is enabled at levels
9003 @option{-O2}, @option{-O3}, @option{-Os}.
9005 @item -falign-functions
9006 @itemx -falign-functions=@var{n}
9007 @opindex falign-functions
9008 Align the start of functions to the next power-of-two greater than
9009 @var{n}, skipping up to @var{n} bytes.  For instance,
9010 @option{-falign-functions=32} aligns functions to the next 32-byte
9011 boundary, but @option{-falign-functions=24} aligns to the next
9012 32-byte boundary only if this can be done by skipping 23 bytes or less.
9014 @option{-fno-align-functions} and @option{-falign-functions=1} are
9015 equivalent and mean that functions are not aligned.
9017 Some assemblers only support this flag when @var{n} is a power of two;
9018 in that case, it is rounded up.
9020 If @var{n} is not specified or is zero, use a machine-dependent default.
9022 Enabled at levels @option{-O2}, @option{-O3}.
9024 @item -flimit-function-alignment
9025 If this option is enabled, the compiler tries to avoid unnecessarily
9026 overaligning functions. It attempts to instruct the assembler to align
9027 by the amount specified by @option{-falign-functions}, but not to
9028 skip more bytes than the size of the function.
9030 @item -falign-labels
9031 @itemx -falign-labels=@var{n}
9032 @opindex falign-labels
9033 Align all branch targets to a power-of-two boundary, skipping up to
9034 @var{n} bytes like @option{-falign-functions}.  This option can easily
9035 make code slower, because it must insert dummy operations for when the
9036 branch target is reached in the usual flow of the code.
9038 @option{-fno-align-labels} and @option{-falign-labels=1} are
9039 equivalent and mean that labels are not aligned.
9041 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9042 are greater than this value, then their values are used instead.
9044 If @var{n} is not specified or is zero, use a machine-dependent default
9045 which is very likely to be @samp{1}, meaning no alignment.
9047 Enabled at levels @option{-O2}, @option{-O3}.
9049 @item -falign-loops
9050 @itemx -falign-loops=@var{n}
9051 @opindex falign-loops
9052 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9053 like @option{-falign-functions}.  If the loops are
9054 executed many times, this makes up for any execution of the dummy
9055 operations.
9057 @option{-fno-align-loops} and @option{-falign-loops=1} are
9058 equivalent and mean that loops are not aligned.
9060 If @var{n} is not specified or is zero, use a machine-dependent default.
9062 Enabled at levels @option{-O2}, @option{-O3}.
9064 @item -falign-jumps
9065 @itemx -falign-jumps=@var{n}
9066 @opindex falign-jumps
9067 Align branch targets to a power-of-two boundary, for branch targets
9068 where the targets can only be reached by jumping, skipping up to @var{n}
9069 bytes like @option{-falign-functions}.  In this case, no dummy operations
9070 need be executed.
9072 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9073 equivalent and mean that loops are not aligned.
9075 If @var{n} is not specified or is zero, use a machine-dependent default.
9077 Enabled at levels @option{-O2}, @option{-O3}.
9079 @item -funit-at-a-time
9080 @opindex funit-at-a-time
9081 This option is left for compatibility reasons. @option{-funit-at-a-time}
9082 has no effect, while @option{-fno-unit-at-a-time} implies
9083 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9085 Enabled by default.
9087 @item -fno-toplevel-reorder
9088 @opindex fno-toplevel-reorder
9089 Do not reorder top-level functions, variables, and @code{asm}
9090 statements.  Output them in the same order that they appear in the
9091 input file.  When this option is used, unreferenced static variables
9092 are not removed.  This option is intended to support existing code
9093 that relies on a particular ordering.  For new code, it is better to
9094 use attributes when possible.
9096 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9097 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9098 targets.
9100 @item -fweb
9101 @opindex fweb
9102 Constructs webs as commonly used for register allocation purposes and assign
9103 each web individual pseudo register.  This allows the register allocation pass
9104 to operate on pseudos directly, but also strengthens several other optimization
9105 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9106 however, make debugging impossible, since variables no longer stay in a
9107 ``home register''.
9109 Enabled by default with @option{-funroll-loops}.
9111 @item -fwhole-program
9112 @opindex fwhole-program
9113 Assume that the current compilation unit represents the whole program being
9114 compiled.  All public functions and variables with the exception of @code{main}
9115 and those merged by attribute @code{externally_visible} become static functions
9116 and in effect are optimized more aggressively by interprocedural optimizers.
9118 This option should not be used in combination with @option{-flto}.
9119 Instead relying on a linker plugin should provide safer and more precise
9120 information.
9122 @item -flto[=@var{n}]
9123 @opindex flto
9124 This option runs the standard link-time optimizer.  When invoked
9125 with source code, it generates GIMPLE (one of GCC's internal
9126 representations) and writes it to special ELF sections in the object
9127 file.  When the object files are linked together, all the function
9128 bodies are read from these ELF sections and instantiated as if they
9129 had been part of the same translation unit.
9131 To use the link-time optimizer, @option{-flto} and optimization
9132 options should be specified at compile time and during the final link.
9133 It is recommended that you compile all the files participating in the
9134 same link with the same options and also specify those options at
9135 link time.  
9136 For example:
9138 @smallexample
9139 gcc -c -O2 -flto foo.c
9140 gcc -c -O2 -flto bar.c
9141 gcc -o myprog -flto -O2 foo.o bar.o
9142 @end smallexample
9144 The first two invocations to GCC save a bytecode representation
9145 of GIMPLE into special ELF sections inside @file{foo.o} and
9146 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9147 @file{foo.o} and @file{bar.o}, merges the two files into a single
9148 internal image, and compiles the result as usual.  Since both
9149 @file{foo.o} and @file{bar.o} are merged into a single image, this
9150 causes all the interprocedural analyses and optimizations in GCC to
9151 work across the two files as if they were a single one.  This means,
9152 for example, that the inliner is able to inline functions in
9153 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9155 Another (simpler) way to enable link-time optimization is:
9157 @smallexample
9158 gcc -o myprog -flto -O2 foo.c bar.c
9159 @end smallexample
9161 The above generates bytecode for @file{foo.c} and @file{bar.c},
9162 merges them together into a single GIMPLE representation and optimizes
9163 them as usual to produce @file{myprog}.
9165 The only important thing to keep in mind is that to enable link-time
9166 optimizations you need to use the GCC driver to perform the link step.
9167 GCC then automatically performs link-time optimization if any of the
9168 objects involved were compiled with the @option{-flto} command-line option.  
9169 You generally
9170 should specify the optimization options to be used for link-time
9171 optimization though GCC tries to be clever at guessing an
9172 optimization level to use from the options used at compile time
9173 if you fail to specify one at link time.  You can always override
9174 the automatic decision to do link-time optimization
9175 by passing @option{-fno-lto} to the link command.
9177 To make whole program optimization effective, it is necessary to make
9178 certain whole program assumptions.  The compiler needs to know
9179 what functions and variables can be accessed by libraries and runtime
9180 outside of the link-time optimized unit.  When supported by the linker,
9181 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9182 to the compiler about used and externally visible symbols.  When
9183 the linker plugin is not available, @option{-fwhole-program} should be
9184 used to allow the compiler to make these assumptions, which leads
9185 to more aggressive optimization decisions.
9187 When @option{-fuse-linker-plugin} is not enabled, when a file is
9188 compiled with @option{-flto}, the generated object file is larger than
9189 a regular object file because it contains GIMPLE bytecodes and the usual
9190 final code (see @option{-ffat-lto-objects}.  This means that
9191 object files with LTO information can be linked as normal object
9192 files; if @option{-fno-lto} is passed to the linker, no
9193 interprocedural optimizations are applied.  Note that when
9194 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9195 but you cannot perform a regular, non-LTO link on them.
9197 Additionally, the optimization flags used to compile individual files
9198 are not necessarily related to those used at link time.  For instance,
9200 @smallexample
9201 gcc -c -O0 -ffat-lto-objects -flto foo.c
9202 gcc -c -O0 -ffat-lto-objects -flto bar.c
9203 gcc -o myprog -O3 foo.o bar.o
9204 @end smallexample
9206 This produces individual object files with unoptimized assembler
9207 code, but the resulting binary @file{myprog} is optimized at
9208 @option{-O3}.  If, instead, the final binary is generated with
9209 @option{-fno-lto}, then @file{myprog} is not optimized.
9211 When producing the final binary, GCC only
9212 applies link-time optimizations to those files that contain bytecode.
9213 Therefore, you can mix and match object files and libraries with
9214 GIMPLE bytecodes and final object code.  GCC automatically selects
9215 which files to optimize in LTO mode and which files to link without
9216 further processing.
9218 There are some code generation flags preserved by GCC when
9219 generating bytecodes, as they need to be used during the final link
9220 stage.  Generally options specified at link time override those
9221 specified at compile time.
9223 If you do not specify an optimization level option @option{-O} at
9224 link time, then GCC uses the highest optimization level 
9225 used when compiling the object files.
9227 Currently, the following options and their settings are taken from
9228 the first object file that explicitly specifies them: 
9229 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9230 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9231 and all the @option{-m} target flags.
9233 Certain ABI-changing flags are required to match in all compilation units,
9234 and trying to override this at link time with a conflicting value
9235 is ignored.  This includes options such as @option{-freg-struct-return}
9236 and @option{-fpcc-struct-return}. 
9238 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9239 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9240 are passed through to the link stage and merged conservatively for
9241 conflicting translation units.  Specifically
9242 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9243 precedence; and for example @option{-ffp-contract=off} takes precedence
9244 over @option{-ffp-contract=fast}.  You can override them at link time.
9246 If LTO encounters objects with C linkage declared with incompatible
9247 types in separate translation units to be linked together (undefined
9248 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9249 issued.  The behavior is still undefined at run time.  Similar
9250 diagnostics may be raised for other languages.
9252 Another feature of LTO is that it is possible to apply interprocedural
9253 optimizations on files written in different languages:
9255 @smallexample
9256 gcc -c -flto foo.c
9257 g++ -c -flto bar.cc
9258 gfortran -c -flto baz.f90
9259 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9260 @end smallexample
9262 Notice that the final link is done with @command{g++} to get the C++
9263 runtime libraries and @option{-lgfortran} is added to get the Fortran
9264 runtime libraries.  In general, when mixing languages in LTO mode, you
9265 should use the same link command options as when mixing languages in a
9266 regular (non-LTO) compilation.
9268 If object files containing GIMPLE bytecode are stored in a library archive, say
9269 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9270 are using a linker with plugin support.  To create static libraries suitable
9271 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9272 and @command{ranlib}; 
9273 to show the symbols of object files with GIMPLE bytecode, use
9274 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9275 and @command{nm} have been compiled with plugin support.  At link time, use the the
9276 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9277 the LTO optimization process:
9279 @smallexample
9280 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9281 @end smallexample
9283 With the linker plugin enabled, the linker extracts the needed
9284 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9285 to make them part of the aggregated GIMPLE image to be optimized.
9287 If you are not using a linker with plugin support and/or do not
9288 enable the linker plugin, then the objects inside @file{libfoo.a}
9289 are extracted and linked as usual, but they do not participate
9290 in the LTO optimization process.  In order to make a static library suitable
9291 for both LTO optimization and usual linkage, compile its object files with
9292 @option{-flto} @option{-ffat-lto-objects}.
9294 Link-time optimizations do not require the presence of the whole program to
9295 operate.  If the program does not require any symbols to be exported, it is
9296 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9297 the interprocedural optimizers to use more aggressive assumptions which may
9298 lead to improved optimization opportunities.
9299 Use of @option{-fwhole-program} is not needed when linker plugin is
9300 active (see @option{-fuse-linker-plugin}).
9302 The current implementation of LTO makes no
9303 attempt to generate bytecode that is portable between different
9304 types of hosts.  The bytecode files are versioned and there is a
9305 strict version check, so bytecode files generated in one version of
9306 GCC do not work with an older or newer version of GCC.
9308 Link-time optimization does not work well with generation of debugging
9309 information.  Combining @option{-flto} with
9310 @option{-g} is currently experimental and expected to produce unexpected
9311 results.
9313 If you specify the optional @var{n}, the optimization and code
9314 generation done at link time is executed in parallel using @var{n}
9315 parallel jobs by utilizing an installed @command{make} program.  The
9316 environment variable @env{MAKE} may be used to override the program
9317 used.  The default value for @var{n} is 1.
9319 You can also specify @option{-flto=jobserver} to use GNU make's
9320 job server mode to determine the number of parallel jobs. This
9321 is useful when the Makefile calling GCC is already executing in parallel.
9322 You must prepend a @samp{+} to the command recipe in the parent Makefile
9323 for this to work.  This option likely only works if @env{MAKE} is
9324 GNU make.
9326 @item -flto-partition=@var{alg}
9327 @opindex flto-partition
9328 Specify the partitioning algorithm used by the link-time optimizer.
9329 The value is either @samp{1to1} to specify a partitioning mirroring
9330 the original source files or @samp{balanced} to specify partitioning
9331 into equally sized chunks (whenever possible) or @samp{max} to create
9332 new partition for every symbol where possible.  Specifying @samp{none}
9333 as an algorithm disables partitioning and streaming completely. 
9334 The default value is @samp{balanced}. While @samp{1to1} can be used
9335 as an workaround for various code ordering issues, the @samp{max}
9336 partitioning is intended for internal testing only.
9337 The value @samp{one} specifies that exactly one partition should be
9338 used while the value @samp{none} bypasses partitioning and executes
9339 the link-time optimization step directly from the WPA phase.
9341 @item -flto-odr-type-merging
9342 @opindex flto-odr-type-merging
9343 Enable streaming of mangled types names of C++ types and their unification
9344 at link time.  This increases size of LTO object files, but enables
9345 diagnostics about One Definition Rule violations.
9347 @item -flto-compression-level=@var{n}
9348 @opindex flto-compression-level
9349 This option specifies the level of compression used for intermediate
9350 language written to LTO object files, and is only meaningful in
9351 conjunction with LTO mode (@option{-flto}).  Valid
9352 values are 0 (no compression) to 9 (maximum compression).  Values
9353 outside this range are clamped to either 0 or 9.  If the option is not
9354 given, a default balanced compression setting is used.
9356 @item -fuse-linker-plugin
9357 @opindex fuse-linker-plugin
9358 Enables the use of a linker plugin during link-time optimization.  This
9359 option relies on plugin support in the linker, which is available in gold
9360 or in GNU ld 2.21 or newer.
9362 This option enables the extraction of object files with GIMPLE bytecode out
9363 of library archives. This improves the quality of optimization by exposing
9364 more code to the link-time optimizer.  This information specifies what
9365 symbols can be accessed externally (by non-LTO object or during dynamic
9366 linking).  Resulting code quality improvements on binaries (and shared
9367 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9368 See @option{-flto} for a description of the effect of this flag and how to
9369 use it.
9371 This option is enabled by default when LTO support in GCC is enabled
9372 and GCC was configured for use with
9373 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9375 @item -ffat-lto-objects
9376 @opindex ffat-lto-objects
9377 Fat LTO objects are object files that contain both the intermediate language
9378 and the object code. This makes them usable for both LTO linking and normal
9379 linking. This option is effective only when compiling with @option{-flto}
9380 and is ignored at link time.
9382 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9383 requires the complete toolchain to be aware of LTO. It requires a linker with
9384 linker plugin support for basic functionality.  Additionally,
9385 @command{nm}, @command{ar} and @command{ranlib}
9386 need to support linker plugins to allow a full-featured build environment
9387 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9388 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9389 to these tools. With non fat LTO makefiles need to be modified to use them.
9391 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9392 support.
9394 @item -fcompare-elim
9395 @opindex fcompare-elim
9396 After register allocation and post-register allocation instruction splitting,
9397 identify arithmetic instructions that compute processor flags similar to a
9398 comparison operation based on that arithmetic.  If possible, eliminate the
9399 explicit comparison operation.
9401 This pass only applies to certain targets that cannot explicitly represent
9402 the comparison operation before register allocation is complete.
9404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9406 @item -fcprop-registers
9407 @opindex fcprop-registers
9408 After register allocation and post-register allocation instruction splitting,
9409 perform a copy-propagation pass to try to reduce scheduling dependencies
9410 and occasionally eliminate the copy.
9412 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9414 @item -fprofile-correction
9415 @opindex fprofile-correction
9416 Profiles collected using an instrumented binary for multi-threaded programs may
9417 be inconsistent due to missed counter updates. When this option is specified,
9418 GCC uses heuristics to correct or smooth out such inconsistencies. By
9419 default, GCC emits an error message when an inconsistent profile is detected.
9421 @item -fprofile-use
9422 @itemx -fprofile-use=@var{path}
9423 @opindex fprofile-use
9424 Enable profile feedback-directed optimizations, 
9425 and the following optimizations
9426 which are generally profitable only with profile feedback available:
9427 @option{-fbranch-probabilities}, @option{-fvpt},
9428 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9429 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9431 Before you can use this option, you must first generate profiling information.
9432 @xref{Instrumentation Options}, for information about the
9433 @option{-fprofile-generate} option.
9435 By default, GCC emits an error message if the feedback profiles do not
9436 match the source code.  This error can be turned into a warning by using
9437 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9438 code.
9440 If @var{path} is specified, GCC looks at the @var{path} to find
9441 the profile feedback data files. See @option{-fprofile-dir}.
9443 @item -fauto-profile
9444 @itemx -fauto-profile=@var{path}
9445 @opindex fauto-profile
9446 Enable sampling-based feedback-directed optimizations, 
9447 and the following optimizations
9448 which are generally profitable only with profile feedback available:
9449 @option{-fbranch-probabilities}, @option{-fvpt},
9450 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9451 @option{-ftree-vectorize},
9452 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9453 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9454 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9456 @var{path} is the name of a file containing AutoFDO profile information.
9457 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9459 Producing an AutoFDO profile data file requires running your program
9460 with the @command{perf} utility on a supported GNU/Linux target system.
9461 For more information, see @uref{https://perf.wiki.kernel.org/}.
9463 E.g.
9464 @smallexample
9465 perf record -e br_inst_retired:near_taken -b -o perf.data \
9466     -- your_program
9467 @end smallexample
9469 Then use the @command{create_gcov} tool to convert the raw profile data
9470 to a format that can be used by GCC.@  You must also supply the 
9471 unstripped binary for your program to this tool.  
9472 See @uref{https://github.com/google/autofdo}.
9474 E.g.
9475 @smallexample
9476 create_gcov --binary=your_program.unstripped --profile=perf.data \
9477     --gcov=profile.afdo
9478 @end smallexample
9479 @end table
9481 The following options control compiler behavior regarding floating-point 
9482 arithmetic.  These options trade off between speed and
9483 correctness.  All must be specifically enabled.
9485 @table @gcctabopt
9486 @item -ffloat-store
9487 @opindex ffloat-store
9488 Do not store floating-point variables in registers, and inhibit other
9489 options that might change whether a floating-point value is taken from a
9490 register or memory.
9492 @cindex floating-point precision
9493 This option prevents undesirable excess precision on machines such as
9494 the 68000 where the floating registers (of the 68881) keep more
9495 precision than a @code{double} is supposed to have.  Similarly for the
9496 x86 architecture.  For most programs, the excess precision does only
9497 good, but a few programs rely on the precise definition of IEEE floating
9498 point.  Use @option{-ffloat-store} for such programs, after modifying
9499 them to store all pertinent intermediate computations into variables.
9501 @item -fexcess-precision=@var{style}
9502 @opindex fexcess-precision
9503 This option allows further control over excess precision on machines
9504 where floating-point operations occur in a format with more precision or
9505 range than the IEEE standard and interchange floating-point types.  By
9506 default, @option{-fexcess-precision=fast} is in effect; this means that
9507 operations may be carried out in a wider precision than the types specified
9508 in the source if that would result in faster code, and it is unpredictable
9509 when rounding to the types specified in the source code takes place.
9510 When compiling C, if @option{-fexcess-precision=standard} is specified then
9511 excess precision follows the rules specified in ISO C99; in particular,
9512 both casts and assignments cause values to be rounded to their
9513 semantic types (whereas @option{-ffloat-store} only affects
9514 assignments).  This option is enabled by default for C if a strict
9515 conformance option such as @option{-std=c99} is used.
9516 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9517 regardless of whether a strict conformance option is used.
9519 @opindex mfpmath
9520 @option{-fexcess-precision=standard} is not implemented for languages
9521 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9522 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9523 semantics apply without excess precision, and in the latter, rounding
9524 is unpredictable.
9526 @item -ffast-math
9527 @opindex ffast-math
9528 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9529 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9530 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9531 @option{-fexcess-precision=fast}.
9533 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9535 This option is not turned on by any @option{-O} option besides
9536 @option{-Ofast} since it can result in incorrect output for programs
9537 that depend on an exact implementation of IEEE or ISO rules/specifications
9538 for math functions. It may, however, yield faster code for programs
9539 that do not require the guarantees of these specifications.
9541 @item -fno-math-errno
9542 @opindex fno-math-errno
9543 Do not set @code{errno} after calling math functions that are executed
9544 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9545 IEEE exceptions for math error handling may want to use this flag
9546 for speed while maintaining IEEE arithmetic compatibility.
9548 This option is not turned on by any @option{-O} option since
9549 it can result in incorrect output for programs that depend on
9550 an exact implementation of IEEE or ISO rules/specifications for
9551 math functions. It may, however, yield faster code for programs
9552 that do not require the guarantees of these specifications.
9554 The default is @option{-fmath-errno}.
9556 On Darwin systems, the math library never sets @code{errno}.  There is
9557 therefore no reason for the compiler to consider the possibility that
9558 it might, and @option{-fno-math-errno} is the default.
9560 @item -funsafe-math-optimizations
9561 @opindex funsafe-math-optimizations
9563 Allow optimizations for floating-point arithmetic that (a) assume
9564 that arguments and results are valid and (b) may violate IEEE or
9565 ANSI standards.  When used at link time, it may include libraries
9566 or startup files that change the default FPU control word or other
9567 similar optimizations.
9569 This option is not turned on by any @option{-O} option since
9570 it can result in incorrect output for programs that depend on
9571 an exact implementation of IEEE or ISO rules/specifications for
9572 math functions. It may, however, yield faster code for programs
9573 that do not require the guarantees of these specifications.
9574 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9575 @option{-fassociative-math} and @option{-freciprocal-math}.
9577 The default is @option{-fno-unsafe-math-optimizations}.
9579 @item -fassociative-math
9580 @opindex fassociative-math
9582 Allow re-association of operands in series of floating-point operations.
9583 This violates the ISO C and C++ language standard by possibly changing
9584 computation result.  NOTE: re-ordering may change the sign of zero as
9585 well as ignore NaNs and inhibit or create underflow or overflow (and
9586 thus cannot be used on code that relies on rounding behavior like
9587 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9588 and thus may not be used when ordered comparisons are required.
9589 This option requires that both @option{-fno-signed-zeros} and
9590 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9591 much sense with @option{-frounding-math}. For Fortran the option
9592 is automatically enabled when both @option{-fno-signed-zeros} and
9593 @option{-fno-trapping-math} are in effect.
9595 The default is @option{-fno-associative-math}.
9597 @item -freciprocal-math
9598 @opindex freciprocal-math
9600 Allow the reciprocal of a value to be used instead of dividing by
9601 the value if this enables optimizations.  For example @code{x / y}
9602 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9603 is subject to common subexpression elimination.  Note that this loses
9604 precision and increases the number of flops operating on the value.
9606 The default is @option{-fno-reciprocal-math}.
9608 @item -ffinite-math-only
9609 @opindex ffinite-math-only
9610 Allow optimizations for floating-point arithmetic that assume
9611 that arguments and results are not NaNs or +-Infs.
9613 This option is not turned on by any @option{-O} option since
9614 it can result in incorrect output for programs that depend on
9615 an exact implementation of IEEE or ISO rules/specifications for
9616 math functions. It may, however, yield faster code for programs
9617 that do not require the guarantees of these specifications.
9619 The default is @option{-fno-finite-math-only}.
9621 @item -fno-signed-zeros
9622 @opindex fno-signed-zeros
9623 Allow optimizations for floating-point arithmetic that ignore the
9624 signedness of zero.  IEEE arithmetic specifies the behavior of
9625 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9626 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9627 This option implies that the sign of a zero result isn't significant.
9629 The default is @option{-fsigned-zeros}.
9631 @item -fno-trapping-math
9632 @opindex fno-trapping-math
9633 Compile code assuming that floating-point operations cannot generate
9634 user-visible traps.  These traps include division by zero, overflow,
9635 underflow, inexact result and invalid operation.  This option requires
9636 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9637 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9639 This option should never be turned on by any @option{-O} option since
9640 it can result in incorrect output for programs that depend on
9641 an exact implementation of IEEE or ISO rules/specifications for
9642 math functions.
9644 The default is @option{-ftrapping-math}.
9646 @item -frounding-math
9647 @opindex frounding-math
9648 Disable transformations and optimizations that assume default floating-point
9649 rounding behavior.  This is round-to-zero for all floating point
9650 to integer conversions, and round-to-nearest for all other arithmetic
9651 truncations.  This option should be specified for programs that change
9652 the FP rounding mode dynamically, or that may be executed with a
9653 non-default rounding mode.  This option disables constant folding of
9654 floating-point expressions at compile time (which may be affected by
9655 rounding mode) and arithmetic transformations that are unsafe in the
9656 presence of sign-dependent rounding modes.
9658 The default is @option{-fno-rounding-math}.
9660 This option is experimental and does not currently guarantee to
9661 disable all GCC optimizations that are affected by rounding mode.
9662 Future versions of GCC may provide finer control of this setting
9663 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9664 will be used to specify the default state for @code{FENV_ACCESS}.
9666 @item -fsignaling-nans
9667 @opindex fsignaling-nans
9668 Compile code assuming that IEEE signaling NaNs may generate user-visible
9669 traps during floating-point operations.  Setting this option disables
9670 optimizations that may change the number of exceptions visible with
9671 signaling NaNs.  This option implies @option{-ftrapping-math}.
9673 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9674 be defined.
9676 The default is @option{-fno-signaling-nans}.
9678 This option is experimental and does not currently guarantee to
9679 disable all GCC optimizations that affect signaling NaN behavior.
9681 @item -fno-fp-int-builtin-inexact
9682 @opindex fno-fp-int-builtin-inexact
9683 Do not allow the built-in functions @code{ceil}, @code{floor},
9684 @code{round} and @code{trunc}, and their @code{float} and @code{long
9685 double} variants, to generate code that raises the ``inexact''
9686 floating-point exception for noninteger arguments.  ISO C99 and C11
9687 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9688 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9689 functions to do so.
9691 The default is @option{-ffp-int-builtin-inexact}, allowing the
9692 exception to be raised.  This option does nothing unless
9693 @option{-ftrapping-math} is in effect.
9695 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9696 generate a call to a library function then the ``inexact'' exception
9697 may be raised if the library implementation does not follow TS 18661.
9699 @item -fsingle-precision-constant
9700 @opindex fsingle-precision-constant
9701 Treat floating-point constants as single precision instead of
9702 implicitly converting them to double-precision constants.
9704 @item -fcx-limited-range
9705 @opindex fcx-limited-range
9706 When enabled, this option states that a range reduction step is not
9707 needed when performing complex division.  Also, there is no checking
9708 whether the result of a complex multiplication or division is @code{NaN
9709 + I*NaN}, with an attempt to rescue the situation in that case.  The
9710 default is @option{-fno-cx-limited-range}, but is enabled by
9711 @option{-ffast-math}.
9713 This option controls the default setting of the ISO C99
9714 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9715 all languages.
9717 @item -fcx-fortran-rules
9718 @opindex fcx-fortran-rules
9719 Complex multiplication and division follow Fortran rules.  Range
9720 reduction is done as part of complex division, but there is no checking
9721 whether the result of a complex multiplication or division is @code{NaN
9722 + I*NaN}, with an attempt to rescue the situation in that case.
9724 The default is @option{-fno-cx-fortran-rules}.
9726 @end table
9728 The following options control optimizations that may improve
9729 performance, but are not enabled by any @option{-O} options.  This
9730 section includes experimental options that may produce broken code.
9732 @table @gcctabopt
9733 @item -fbranch-probabilities
9734 @opindex fbranch-probabilities
9735 After running a program compiled with @option{-fprofile-arcs}
9736 (@pxref{Instrumentation Options}),
9737 you can compile it a second time using
9738 @option{-fbranch-probabilities}, to improve optimizations based on
9739 the number of times each branch was taken.  When a program
9740 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9741 counts to a file called @file{@var{sourcename}.gcda} for each source
9742 file.  The information in this data file is very dependent on the
9743 structure of the generated code, so you must use the same source code
9744 and the same optimization options for both compilations.
9746 With @option{-fbranch-probabilities}, GCC puts a
9747 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9748 These can be used to improve optimization.  Currently, they are only
9749 used in one place: in @file{reorg.c}, instead of guessing which path a
9750 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9751 exactly determine which path is taken more often.
9753 @item -fprofile-values
9754 @opindex fprofile-values
9755 If combined with @option{-fprofile-arcs}, it adds code so that some
9756 data about values of expressions in the program is gathered.
9758 With @option{-fbranch-probabilities}, it reads back the data gathered
9759 from profiling values of expressions for usage in optimizations.
9761 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9763 @item -fprofile-reorder-functions
9764 @opindex fprofile-reorder-functions
9765 Function reordering based on profile instrumentation collects
9766 first time of execution of a function and orders these functions
9767 in ascending order.
9769 Enabled with @option{-fprofile-use}.
9771 @item -fvpt
9772 @opindex fvpt
9773 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9774 to add code to gather information about values of expressions.
9776 With @option{-fbranch-probabilities}, it reads back the data gathered
9777 and actually performs the optimizations based on them.
9778 Currently the optimizations include specialization of division operations
9779 using the knowledge about the value of the denominator.
9781 @item -frename-registers
9782 @opindex frename-registers
9783 Attempt to avoid false dependencies in scheduled code by making use
9784 of registers left over after register allocation.  This optimization
9785 most benefits processors with lots of registers.  Depending on the
9786 debug information format adopted by the target, however, it can
9787 make debugging impossible, since variables no longer stay in
9788 a ``home register''.
9790 Enabled by default with @option{-funroll-loops}.
9792 @item -fschedule-fusion
9793 @opindex fschedule-fusion
9794 Performs a target dependent pass over the instruction stream to schedule
9795 instructions of same type together because target machine can execute them
9796 more efficiently if they are adjacent to each other in the instruction flow.
9798 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9800 @item -ftracer
9801 @opindex ftracer
9802 Perform tail duplication to enlarge superblock size.  This transformation
9803 simplifies the control flow of the function allowing other optimizations to do
9804 a better job.
9806 Enabled with @option{-fprofile-use}.
9808 @item -funroll-loops
9809 @opindex funroll-loops
9810 Unroll loops whose number of iterations can be determined at compile time or
9811 upon entry to the loop.  @option{-funroll-loops} implies
9812 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9813 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9814 a small constant number of iterations).  This option makes code larger, and may
9815 or may not make it run faster.
9817 Enabled with @option{-fprofile-use}.
9819 @item -funroll-all-loops
9820 @opindex funroll-all-loops
9821 Unroll all loops, even if their number of iterations is uncertain when
9822 the loop is entered.  This usually makes programs run more slowly.
9823 @option{-funroll-all-loops} implies the same options as
9824 @option{-funroll-loops}.
9826 @item -fpeel-loops
9827 @opindex fpeel-loops
9828 Peels loops for which there is enough information that they do not
9829 roll much (from profile feedback or static analysis).  It also turns on
9830 complete loop peeling (i.e.@: complete removal of loops with small constant
9831 number of iterations).
9833 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9835 @item -fmove-loop-invariants
9836 @opindex fmove-loop-invariants
9837 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9838 at level @option{-O1}
9840 @item -fsplit-loops
9841 @opindex fsplit-loops
9842 Split a loop into two if it contains a condition that's always true
9843 for one side of the iteration space and false for the other.
9845 @item -funswitch-loops
9846 @opindex funswitch-loops
9847 Move branches with loop invariant conditions out of the loop, with duplicates
9848 of the loop on both branches (modified according to result of the condition).
9850 @item -floop-unroll-and-jam
9851 @opindex floop-unroll-and-jam
9852 Apply unroll and jam transformations on feasible loops.  In a loop
9853 nest this unrolls the outer loop by some factor and fuses the resulting
9854 multiple inner loops.
9856 @item -ffunction-sections
9857 @itemx -fdata-sections
9858 @opindex ffunction-sections
9859 @opindex fdata-sections
9860 Place each function or data item into its own section in the output
9861 file if the target supports arbitrary sections.  The name of the
9862 function or the name of the data item determines the section's name
9863 in the output file.
9865 Use these options on systems where the linker can perform optimizations to
9866 improve locality of reference in the instruction space.  Most systems using the
9867 ELF object format have linkers with such optimizations.  On AIX, the linker
9868 rearranges sections (CSECTs) based on the call graph.  The performance impact
9869 varies.
9871 Together with a linker garbage collection (linker @option{--gc-sections}
9872 option) these options may lead to smaller statically-linked executables (after
9873 stripping).
9875 On ELF/DWARF systems these options do not degenerate the quality of the debug
9876 information.  There could be issues with other object files/debug info formats.
9878 Only use these options when there are significant benefits from doing so.  When
9879 you specify these options, the assembler and linker create larger object and
9880 executable files and are also slower.  These options affect code generation.
9881 They prevent optimizations by the compiler and assembler using relative
9882 locations inside a translation unit since the locations are unknown until
9883 link time.  An example of such an optimization is relaxing calls to short call
9884 instructions.
9886 @item -fbranch-target-load-optimize
9887 @opindex fbranch-target-load-optimize
9888 Perform branch target register load optimization before prologue / epilogue
9889 threading.
9890 The use of target registers can typically be exposed only during reload,
9891 thus hoisting loads out of loops and doing inter-block scheduling needs
9892 a separate optimization pass.
9894 @item -fbranch-target-load-optimize2
9895 @opindex fbranch-target-load-optimize2
9896 Perform branch target register load optimization after prologue / epilogue
9897 threading.
9899 @item -fbtr-bb-exclusive
9900 @opindex fbtr-bb-exclusive
9901 When performing branch target register load optimization, don't reuse
9902 branch target registers within any basic block.
9904 @item -fstdarg-opt
9905 @opindex fstdarg-opt
9906 Optimize the prologue of variadic argument functions with respect to usage of
9907 those arguments.
9909 @item -fsection-anchors
9910 @opindex fsection-anchors
9911 Try to reduce the number of symbolic address calculations by using
9912 shared ``anchor'' symbols to address nearby objects.  This transformation
9913 can help to reduce the number of GOT entries and GOT accesses on some
9914 targets.
9916 For example, the implementation of the following function @code{foo}:
9918 @smallexample
9919 static int a, b, c;
9920 int foo (void) @{ return a + b + c; @}
9921 @end smallexample
9923 @noindent
9924 usually calculates the addresses of all three variables, but if you
9925 compile it with @option{-fsection-anchors}, it accesses the variables
9926 from a common anchor point instead.  The effect is similar to the
9927 following pseudocode (which isn't valid C):
9929 @smallexample
9930 int foo (void)
9932   register int *xr = &x;
9933   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9935 @end smallexample
9937 Not all targets support this option.
9939 @item --param @var{name}=@var{value}
9940 @opindex param
9941 In some places, GCC uses various constants to control the amount of
9942 optimization that is done.  For example, GCC does not inline functions
9943 that contain more than a certain number of instructions.  You can
9944 control some of these constants on the command line using the
9945 @option{--param} option.
9947 The names of specific parameters, and the meaning of the values, are
9948 tied to the internals of the compiler, and are subject to change
9949 without notice in future releases.
9951 In each case, the @var{value} is an integer.  The allowable choices for
9952 @var{name} are:
9954 @table @gcctabopt
9955 @item predictable-branch-outcome
9956 When branch is predicted to be taken with probability lower than this threshold
9957 (in percent), then it is considered well predictable. The default is 10.
9959 @item max-rtl-if-conversion-insns
9960 RTL if-conversion tries to remove conditional branches around a block and
9961 replace them with conditionally executed instructions.  This parameter
9962 gives the maximum number of instructions in a block which should be
9963 considered for if-conversion.  The default is 10, though the compiler will
9964 also use other heuristics to decide whether if-conversion is likely to be
9965 profitable.
9967 @item max-rtl-if-conversion-predictable-cost
9968 @item max-rtl-if-conversion-unpredictable-cost
9969 RTL if-conversion will try to remove conditional branches around a block
9970 and replace them with conditionally executed instructions.  These parameters
9971 give the maximum permissible cost for the sequence that would be generated
9972 by if-conversion depending on whether the branch is statically determined
9973 to be predictable or not.  The units for this parameter are the same as
9974 those for the GCC internal seq_cost metric.  The compiler will try to
9975 provide a reasonable default for this parameter using the BRANCH_COST
9976 target macro.
9978 @item max-crossjump-edges
9979 The maximum number of incoming edges to consider for cross-jumping.
9980 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9981 the number of edges incoming to each block.  Increasing values mean
9982 more aggressive optimization, making the compilation time increase with
9983 probably small improvement in executable size.
9985 @item min-crossjump-insns
9986 The minimum number of instructions that must be matched at the end
9987 of two blocks before cross-jumping is performed on them.  This
9988 value is ignored in the case where all instructions in the block being
9989 cross-jumped from are matched.  The default value is 5.
9991 @item max-grow-copy-bb-insns
9992 The maximum code size expansion factor when copying basic blocks
9993 instead of jumping.  The expansion is relative to a jump instruction.
9994 The default value is 8.
9996 @item max-goto-duplication-insns
9997 The maximum number of instructions to duplicate to a block that jumps
9998 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9999 passes, GCC factors computed gotos early in the compilation process,
10000 and unfactors them as late as possible.  Only computed jumps at the
10001 end of a basic blocks with no more than max-goto-duplication-insns are
10002 unfactored.  The default value is 8.
10004 @item max-delay-slot-insn-search
10005 The maximum number of instructions to consider when looking for an
10006 instruction to fill a delay slot.  If more than this arbitrary number of
10007 instructions are searched, the time savings from filling the delay slot
10008 are minimal, so stop searching.  Increasing values mean more
10009 aggressive optimization, making the compilation time increase with probably
10010 small improvement in execution time.
10012 @item max-delay-slot-live-search
10013 When trying to fill delay slots, the maximum number of instructions to
10014 consider when searching for a block with valid live register
10015 information.  Increasing this arbitrarily chosen value means more
10016 aggressive optimization, increasing the compilation time.  This parameter
10017 should be removed when the delay slot code is rewritten to maintain the
10018 control-flow graph.
10020 @item max-gcse-memory
10021 The approximate maximum amount of memory that can be allocated in
10022 order to perform the global common subexpression elimination
10023 optimization.  If more memory than specified is required, the
10024 optimization is not done.
10026 @item max-gcse-insertion-ratio
10027 If the ratio of expression insertions to deletions is larger than this value
10028 for any expression, then RTL PRE inserts or removes the expression and thus
10029 leaves partially redundant computations in the instruction stream.  The default value is 20.
10031 @item max-pending-list-length
10032 The maximum number of pending dependencies scheduling allows
10033 before flushing the current state and starting over.  Large functions
10034 with few branches or calls can create excessively large lists which
10035 needlessly consume memory and resources.
10037 @item max-modulo-backtrack-attempts
10038 The maximum number of backtrack attempts the scheduler should make
10039 when modulo scheduling a loop.  Larger values can exponentially increase
10040 compilation time.
10042 @item max-inline-insns-single
10043 Several parameters control the tree inliner used in GCC@.
10044 This number sets the maximum number of instructions (counted in GCC's
10045 internal representation) in a single function that the tree inliner
10046 considers for inlining.  This only affects functions declared
10047 inline and methods implemented in a class declaration (C++).
10048 The default value is 400.
10050 @item max-inline-insns-auto
10051 When you use @option{-finline-functions} (included in @option{-O3}),
10052 a lot of functions that would otherwise not be considered for inlining
10053 by the compiler are investigated.  To those functions, a different
10054 (more restrictive) limit compared to functions declared inline can
10055 be applied.
10056 The default value is 40.
10058 @item inline-min-speedup
10059 When estimated performance improvement of caller + callee runtime exceeds this
10060 threshold (in percent), the function can be inlined regardless of the limit on
10061 @option{--param max-inline-insns-single} and @option{--param
10062 max-inline-insns-auto}.
10064 @item large-function-insns
10065 The limit specifying really large functions.  For functions larger than this
10066 limit after inlining, inlining is constrained by
10067 @option{--param large-function-growth}.  This parameter is useful primarily
10068 to avoid extreme compilation time caused by non-linear algorithms used by the
10069 back end.
10070 The default value is 2700.
10072 @item large-function-growth
10073 Specifies maximal growth of large function caused by inlining in percents.
10074 The default value is 100 which limits large function growth to 2.0 times
10075 the original size.
10077 @item large-unit-insns
10078 The limit specifying large translation unit.  Growth caused by inlining of
10079 units larger than this limit is limited by @option{--param inline-unit-growth}.
10080 For small units this might be too tight.
10081 For example, consider a unit consisting of function A
10082 that is inline and B that just calls A three times.  If B is small relative to
10083 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10084 large units consisting of small inlineable functions, however, the overall unit
10085 growth limit is needed to avoid exponential explosion of code size.  Thus for
10086 smaller units, the size is increased to @option{--param large-unit-insns}
10087 before applying @option{--param inline-unit-growth}.  The default is 10000.
10089 @item inline-unit-growth
10090 Specifies maximal overall growth of the compilation unit caused by inlining.
10091 The default value is 20 which limits unit growth to 1.2 times the original
10092 size. Cold functions (either marked cold via an attribute or by profile
10093 feedback) are not accounted into the unit size.
10095 @item ipcp-unit-growth
10096 Specifies maximal overall growth of the compilation unit caused by
10097 interprocedural constant propagation.  The default value is 10 which limits
10098 unit growth to 1.1 times the original size.
10100 @item large-stack-frame
10101 The limit specifying large stack frames.  While inlining the algorithm is trying
10102 to not grow past this limit too much.  The default value is 256 bytes.
10104 @item large-stack-frame-growth
10105 Specifies maximal growth of large stack frames caused by inlining in percents.
10106 The default value is 1000 which limits large stack frame growth to 11 times
10107 the original size.
10109 @item max-inline-insns-recursive
10110 @itemx max-inline-insns-recursive-auto
10111 Specifies the maximum number of instructions an out-of-line copy of a
10112 self-recursive inline
10113 function can grow into by performing recursive inlining.
10115 @option{--param max-inline-insns-recursive} applies to functions
10116 declared inline.
10117 For functions not declared inline, recursive inlining
10118 happens only when @option{-finline-functions} (included in @option{-O3}) is
10119 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10120 default value is 450.
10122 @item max-inline-recursive-depth
10123 @itemx max-inline-recursive-depth-auto
10124 Specifies the maximum recursion depth used for recursive inlining.
10126 @option{--param max-inline-recursive-depth} applies to functions
10127 declared inline.  For functions not declared inline, recursive inlining
10128 happens only when @option{-finline-functions} (included in @option{-O3}) is
10129 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10130 default value is 8.
10132 @item min-inline-recursive-probability
10133 Recursive inlining is profitable only for function having deep recursion
10134 in average and can hurt for function having little recursion depth by
10135 increasing the prologue size or complexity of function body to other
10136 optimizers.
10138 When profile feedback is available (see @option{-fprofile-generate}) the actual
10139 recursion depth can be guessed from the probability that function recurses
10140 via a given call expression.  This parameter limits inlining only to call
10141 expressions whose probability exceeds the given threshold (in percents).
10142 The default value is 10.
10144 @item early-inlining-insns
10145 Specify growth that the early inliner can make.  In effect it increases
10146 the amount of inlining for code having a large abstraction penalty.
10147 The default value is 14.
10149 @item max-early-inliner-iterations
10150 Limit of iterations of the early inliner.  This basically bounds
10151 the number of nested indirect calls the early inliner can resolve.
10152 Deeper chains are still handled by late inlining.
10154 @item comdat-sharing-probability
10155 Probability (in percent) that C++ inline function with comdat visibility
10156 are shared across multiple compilation units.  The default value is 20.
10158 @item profile-func-internal-id
10159 A parameter to control whether to use function internal id in profile
10160 database lookup. If the value is 0, the compiler uses an id that
10161 is based on function assembler name and filename, which makes old profile
10162 data more tolerant to source changes such as function reordering etc.
10163 The default value is 0.
10165 @item min-vect-loop-bound
10166 The minimum number of iterations under which loops are not vectorized
10167 when @option{-ftree-vectorize} is used.  The number of iterations after
10168 vectorization needs to be greater than the value specified by this option
10169 to allow vectorization.  The default value is 0.
10171 @item gcse-cost-distance-ratio
10172 Scaling factor in calculation of maximum distance an expression
10173 can be moved by GCSE optimizations.  This is currently supported only in the
10174 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10175 is with simple expressions, i.e., the expressions that have cost
10176 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10177 hoisting of simple expressions.  The default value is 10.
10179 @item gcse-unrestricted-cost
10180 Cost, roughly measured as the cost of a single typical machine
10181 instruction, at which GCSE optimizations do not constrain
10182 the distance an expression can travel.  This is currently
10183 supported only in the code hoisting pass.  The lesser the cost,
10184 the more aggressive code hoisting is.  Specifying 0 
10185 allows all expressions to travel unrestricted distances.
10186 The default value is 3.
10188 @item max-hoist-depth
10189 The depth of search in the dominator tree for expressions to hoist.
10190 This is used to avoid quadratic behavior in hoisting algorithm.
10191 The value of 0 does not limit on the search, but may slow down compilation
10192 of huge functions.  The default value is 30.
10194 @item max-tail-merge-comparisons
10195 The maximum amount of similar bbs to compare a bb with.  This is used to
10196 avoid quadratic behavior in tree tail merging.  The default value is 10.
10198 @item max-tail-merge-iterations
10199 The maximum amount of iterations of the pass over the function.  This is used to
10200 limit compilation time in tree tail merging.  The default value is 2.
10202 @item store-merging-allow-unaligned
10203 Allow the store merging pass to introduce unaligned stores if it is legal to
10204 do so.  The default value is 1.
10206 @item max-stores-to-merge
10207 The maximum number of stores to attempt to merge into wider stores in the store
10208 merging pass.  The minimum value is 2 and the default is 64.
10210 @item max-unrolled-insns
10211 The maximum number of instructions that a loop may have to be unrolled.
10212 If a loop is unrolled, this parameter also determines how many times
10213 the loop code is unrolled.
10215 @item max-average-unrolled-insns
10216 The maximum number of instructions biased by probabilities of their execution
10217 that a loop may have to be unrolled.  If a loop is unrolled,
10218 this parameter also determines how many times the loop code is unrolled.
10220 @item max-unroll-times
10221 The maximum number of unrollings of a single loop.
10223 @item max-peeled-insns
10224 The maximum number of instructions that a loop may have to be peeled.
10225 If a loop is peeled, this parameter also determines how many times
10226 the loop code is peeled.
10228 @item max-peel-times
10229 The maximum number of peelings of a single loop.
10231 @item max-peel-branches
10232 The maximum number of branches on the hot path through the peeled sequence.
10234 @item max-completely-peeled-insns
10235 The maximum number of insns of a completely peeled loop.
10237 @item max-completely-peel-times
10238 The maximum number of iterations of a loop to be suitable for complete peeling.
10240 @item max-completely-peel-loop-nest-depth
10241 The maximum depth of a loop nest suitable for complete peeling.
10243 @item max-unswitch-insns
10244 The maximum number of insns of an unswitched loop.
10246 @item max-unswitch-level
10247 The maximum number of branches unswitched in a single loop.
10249 @item max-loop-headers-insns
10250 The maximum number of insns in loop header duplicated by the copy loop headers
10251 pass.
10253 @item lim-expensive
10254 The minimum cost of an expensive expression in the loop invariant motion.
10256 @item iv-consider-all-candidates-bound
10257 Bound on number of candidates for induction variables, below which
10258 all candidates are considered for each use in induction variable
10259 optimizations.  If there are more candidates than this,
10260 only the most relevant ones are considered to avoid quadratic time complexity.
10262 @item iv-max-considered-uses
10263 The induction variable optimizations give up on loops that contain more
10264 induction variable uses.
10266 @item iv-always-prune-cand-set-bound
10267 If the number of candidates in the set is smaller than this value,
10268 always try to remove unnecessary ivs from the set
10269 when adding a new one.
10271 @item avg-loop-niter
10272 Average number of iterations of a loop.
10274 @item dse-max-object-size
10275 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10276 Larger values may result in larger compilation times.
10278 @item scev-max-expr-size
10279 Bound on size of expressions used in the scalar evolutions analyzer.
10280 Large expressions slow the analyzer.
10282 @item scev-max-expr-complexity
10283 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10284 Complex expressions slow the analyzer.
10286 @item max-tree-if-conversion-phi-args
10287 Maximum number of arguments in a PHI supported by TREE if conversion
10288 unless the loop is marked with simd pragma.
10290 @item vect-max-version-for-alignment-checks
10291 The maximum number of run-time checks that can be performed when
10292 doing loop versioning for alignment in the vectorizer.
10294 @item vect-max-version-for-alias-checks
10295 The maximum number of run-time checks that can be performed when
10296 doing loop versioning for alias in the vectorizer.
10298 @item vect-max-peeling-for-alignment
10299 The maximum number of loop peels to enhance access alignment
10300 for vectorizer. Value -1 means no limit.
10302 @item max-iterations-to-track
10303 The maximum number of iterations of a loop the brute-force algorithm
10304 for analysis of the number of iterations of the loop tries to evaluate.
10306 @item hot-bb-count-ws-permille
10307 A basic block profile count is considered hot if it contributes to 
10308 the given permillage (i.e. 0...1000) of the entire profiled execution.
10310 @item hot-bb-frequency-fraction
10311 Select fraction of the entry block frequency of executions of basic block in
10312 function given basic block needs to have to be considered hot.
10314 @item max-predicted-iterations
10315 The maximum number of loop iterations we predict statically.  This is useful
10316 in cases where a function contains a single loop with known bound and
10317 another loop with unknown bound.
10318 The known number of iterations is predicted correctly, while
10319 the unknown number of iterations average to roughly 10.  This means that the
10320 loop without bounds appears artificially cold relative to the other one.
10322 @item builtin-expect-probability
10323 Control the probability of the expression having the specified value. This
10324 parameter takes a percentage (i.e. 0 ... 100) as input.
10325 The default probability of 90 is obtained empirically.
10327 @item align-threshold
10329 Select fraction of the maximal frequency of executions of a basic block in
10330 a function to align the basic block.
10332 @item align-loop-iterations
10334 A loop expected to iterate at least the selected number of iterations is
10335 aligned.
10337 @item tracer-dynamic-coverage
10338 @itemx tracer-dynamic-coverage-feedback
10340 This value is used to limit superblock formation once the given percentage of
10341 executed instructions is covered.  This limits unnecessary code size
10342 expansion.
10344 The @option{tracer-dynamic-coverage-feedback} parameter
10345 is used only when profile
10346 feedback is available.  The real profiles (as opposed to statically estimated
10347 ones) are much less balanced allowing the threshold to be larger value.
10349 @item tracer-max-code-growth
10350 Stop tail duplication once code growth has reached given percentage.  This is
10351 a rather artificial limit, as most of the duplicates are eliminated later in
10352 cross jumping, so it may be set to much higher values than is the desired code
10353 growth.
10355 @item tracer-min-branch-ratio
10357 Stop reverse growth when the reverse probability of best edge is less than this
10358 threshold (in percent).
10360 @item tracer-min-branch-probability
10361 @itemx tracer-min-branch-probability-feedback
10363 Stop forward growth if the best edge has probability lower than this
10364 threshold.
10366 Similarly to @option{tracer-dynamic-coverage} two parameters are
10367 provided.  @option{tracer-min-branch-probability-feedback} is used for
10368 compilation with profile feedback and @option{tracer-min-branch-probability}
10369 compilation without.  The value for compilation with profile feedback
10370 needs to be more conservative (higher) in order to make tracer
10371 effective.
10373 @item stack-clash-protection-guard-size
10374 Specify the size of the operating system provided stack guard as
10375 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10376 Acceptable values are between 12 and 30.  Higher values may reduce the
10377 number of explicit probes, but a value larger than the operating system
10378 provided guard will leave code vulnerable to stack clash style attacks.
10380 @item stack-clash-protection-probe-interval
10381 Stack clash protection involves probing stack space as it is allocated.  This
10382 param controls the maximum distance between probes into the stack as 2 raised
10383 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10384 12.  Higher values may reduce the number of explicit probes, but a value
10385 larger than the operating system provided guard will leave code vulnerable to
10386 stack clash style attacks.
10388 @item max-cse-path-length
10390 The maximum number of basic blocks on path that CSE considers.
10391 The default is 10.
10393 @item max-cse-insns
10394 The maximum number of instructions CSE processes before flushing.
10395 The default is 1000.
10397 @item ggc-min-expand
10399 GCC uses a garbage collector to manage its own memory allocation.  This
10400 parameter specifies the minimum percentage by which the garbage
10401 collector's heap should be allowed to expand between collections.
10402 Tuning this may improve compilation speed; it has no effect on code
10403 generation.
10405 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10406 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10407 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10408 GCC is not able to calculate RAM on a particular platform, the lower
10409 bound of 30% is used.  Setting this parameter and
10410 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10411 every opportunity.  This is extremely slow, but can be useful for
10412 debugging.
10414 @item ggc-min-heapsize
10416 Minimum size of the garbage collector's heap before it begins bothering
10417 to collect garbage.  The first collection occurs after the heap expands
10418 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10419 tuning this may improve compilation speed, and has no effect on code
10420 generation.
10422 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10423 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10424 with a lower bound of 4096 (four megabytes) and an upper bound of
10425 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10426 particular platform, the lower bound is used.  Setting this parameter
10427 very large effectively disables garbage collection.  Setting this
10428 parameter and @option{ggc-min-expand} to zero causes a full collection
10429 to occur at every opportunity.
10431 @item max-reload-search-insns
10432 The maximum number of instruction reload should look backward for equivalent
10433 register.  Increasing values mean more aggressive optimization, making the
10434 compilation time increase with probably slightly better performance.
10435 The default value is 100.
10437 @item max-cselib-memory-locations
10438 The maximum number of memory locations cselib should take into account.
10439 Increasing values mean more aggressive optimization, making the compilation time
10440 increase with probably slightly better performance.  The default value is 500.
10442 @item max-sched-ready-insns
10443 The maximum number of instructions ready to be issued the scheduler should
10444 consider at any given time during the first scheduling pass.  Increasing
10445 values mean more thorough searches, making the compilation time increase
10446 with probably little benefit.  The default value is 100.
10448 @item max-sched-region-blocks
10449 The maximum number of blocks in a region to be considered for
10450 interblock scheduling.  The default value is 10.
10452 @item max-pipeline-region-blocks
10453 The maximum number of blocks in a region to be considered for
10454 pipelining in the selective scheduler.  The default value is 15.
10456 @item max-sched-region-insns
10457 The maximum number of insns in a region to be considered for
10458 interblock scheduling.  The default value is 100.
10460 @item max-pipeline-region-insns
10461 The maximum number of insns in a region to be considered for
10462 pipelining in the selective scheduler.  The default value is 200.
10464 @item min-spec-prob
10465 The minimum probability (in percents) of reaching a source block
10466 for interblock speculative scheduling.  The default value is 40.
10468 @item max-sched-extend-regions-iters
10469 The maximum number of iterations through CFG to extend regions.
10470 A value of 0 (the default) disables region extensions.
10472 @item max-sched-insn-conflict-delay
10473 The maximum conflict delay for an insn to be considered for speculative motion.
10474 The default value is 3.
10476 @item sched-spec-prob-cutoff
10477 The minimal probability of speculation success (in percents), so that
10478 speculative insns are scheduled.
10479 The default value is 40.
10481 @item sched-state-edge-prob-cutoff
10482 The minimum probability an edge must have for the scheduler to save its
10483 state across it.
10484 The default value is 10.
10486 @item sched-mem-true-dep-cost
10487 Minimal distance (in CPU cycles) between store and load targeting same
10488 memory locations.  The default value is 1.
10490 @item selsched-max-lookahead
10491 The maximum size of the lookahead window of selective scheduling.  It is a
10492 depth of search for available instructions.
10493 The default value is 50.
10495 @item selsched-max-sched-times
10496 The maximum number of times that an instruction is scheduled during
10497 selective scheduling.  This is the limit on the number of iterations
10498 through which the instruction may be pipelined.  The default value is 2.
10500 @item selsched-insns-to-rename
10501 The maximum number of best instructions in the ready list that are considered
10502 for renaming in the selective scheduler.  The default value is 2.
10504 @item sms-min-sc
10505 The minimum value of stage count that swing modulo scheduler
10506 generates.  The default value is 2.
10508 @item max-last-value-rtl
10509 The maximum size measured as number of RTLs that can be recorded in an expression
10510 in combiner for a pseudo register as last known value of that register.  The default
10511 is 10000.
10513 @item max-combine-insns
10514 The maximum number of instructions the RTL combiner tries to combine.
10515 The default value is 2 at @option{-Og} and 4 otherwise.
10517 @item integer-share-limit
10518 Small integer constants can use a shared data structure, reducing the
10519 compiler's memory usage and increasing its speed.  This sets the maximum
10520 value of a shared integer constant.  The default value is 256.
10522 @item ssp-buffer-size
10523 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10524 protection when @option{-fstack-protection} is used.
10526 @item min-size-for-stack-sharing
10527 The minimum size of variables taking part in stack slot sharing when not
10528 optimizing. The default value is 32.
10530 @item max-jump-thread-duplication-stmts
10531 Maximum number of statements allowed in a block that needs to be
10532 duplicated when threading jumps.
10534 @item max-fields-for-field-sensitive
10535 Maximum number of fields in a structure treated in
10536 a field sensitive manner during pointer analysis.  The default is zero
10537 for @option{-O0} and @option{-O1},
10538 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10540 @item prefetch-latency
10541 Estimate on average number of instructions that are executed before
10542 prefetch finishes.  The distance prefetched ahead is proportional
10543 to this constant.  Increasing this number may also lead to less
10544 streams being prefetched (see @option{simultaneous-prefetches}).
10546 @item simultaneous-prefetches
10547 Maximum number of prefetches that can run at the same time.
10549 @item l1-cache-line-size
10550 The size of cache line in L1 cache, in bytes.
10552 @item l1-cache-size
10553 The size of L1 cache, in kilobytes.
10555 @item l2-cache-size
10556 The size of L2 cache, in kilobytes.
10558 @item loop-interchange-max-num-stmts
10559 The maximum number of stmts in a loop to be interchanged.
10561 @item loop-interchange-stride-ratio
10562 The minimum ratio between stride of two loops for interchange to be profitable.
10564 @item min-insn-to-prefetch-ratio
10565 The minimum ratio between the number of instructions and the
10566 number of prefetches to enable prefetching in a loop.
10568 @item prefetch-min-insn-to-mem-ratio
10569 The minimum ratio between the number of instructions and the
10570 number of memory references to enable prefetching in a loop.
10572 @item use-canonical-types
10573 Whether the compiler should use the ``canonical'' type system.  By
10574 default, this should always be 1, which uses a more efficient internal
10575 mechanism for comparing types in C++ and Objective-C++.  However, if
10576 bugs in the canonical type system are causing compilation failures,
10577 set this value to 0 to disable canonical types.
10579 @item switch-conversion-max-branch-ratio
10580 Switch initialization conversion refuses to create arrays that are
10581 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10582 branches in the switch.
10584 @item max-partial-antic-length
10585 Maximum length of the partial antic set computed during the tree
10586 partial redundancy elimination optimization (@option{-ftree-pre}) when
10587 optimizing at @option{-O3} and above.  For some sorts of source code
10588 the enhanced partial redundancy elimination optimization can run away,
10589 consuming all of the memory available on the host machine.  This
10590 parameter sets a limit on the length of the sets that are computed,
10591 which prevents the runaway behavior.  Setting a value of 0 for
10592 this parameter allows an unlimited set length.
10594 @item sccvn-max-scc-size
10595 Maximum size of a strongly connected component (SCC) during SCCVN
10596 processing.  If this limit is hit, SCCVN processing for the whole
10597 function is not done and optimizations depending on it are
10598 disabled.  The default maximum SCC size is 10000.
10600 @item sccvn-max-alias-queries-per-access
10601 Maximum number of alias-oracle queries we perform when looking for
10602 redundancies for loads and stores.  If this limit is hit the search
10603 is aborted and the load or store is not considered redundant.  The
10604 number of queries is algorithmically limited to the number of
10605 stores on all paths from the load to the function entry.
10606 The default maximum number of queries is 1000.
10608 @item ira-max-loops-num
10609 IRA uses regional register allocation by default.  If a function
10610 contains more loops than the number given by this parameter, only at most
10611 the given number of the most frequently-executed loops form regions
10612 for regional register allocation.  The default value of the
10613 parameter is 100.
10615 @item ira-max-conflict-table-size 
10616 Although IRA uses a sophisticated algorithm to compress the conflict
10617 table, the table can still require excessive amounts of memory for
10618 huge functions.  If the conflict table for a function could be more
10619 than the size in MB given by this parameter, the register allocator
10620 instead uses a faster, simpler, and lower-quality
10621 algorithm that does not require building a pseudo-register conflict table.  
10622 The default value of the parameter is 2000.
10624 @item ira-loop-reserved-regs
10625 IRA can be used to evaluate more accurate register pressure in loops
10626 for decisions to move loop invariants (see @option{-O3}).  The number
10627 of available registers reserved for some other purposes is given
10628 by this parameter.  The default value of the parameter is 2, which is
10629 the minimal number of registers needed by typical instructions.
10630 This value is the best found from numerous experiments.
10632 @item lra-inheritance-ebb-probability-cutoff
10633 LRA tries to reuse values reloaded in registers in subsequent insns.
10634 This optimization is called inheritance.  EBB is used as a region to
10635 do this optimization.  The parameter defines a minimal fall-through
10636 edge probability in percentage used to add BB to inheritance EBB in
10637 LRA.  The default value of the parameter is 40.  The value was chosen
10638 from numerous runs of SPEC2000 on x86-64.
10640 @item loop-invariant-max-bbs-in-loop
10641 Loop invariant motion can be very expensive, both in compilation time and
10642 in amount of needed compile-time memory, with very large loops.  Loops
10643 with more basic blocks than this parameter won't have loop invariant
10644 motion optimization performed on them.  The default value of the
10645 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10647 @item loop-max-datarefs-for-datadeps
10648 Building data dependencies is expensive for very large loops.  This
10649 parameter limits the number of data references in loops that are
10650 considered for data dependence analysis.  These large loops are no
10651 handled by the optimizations using loop data dependencies.
10652 The default value is 1000.
10654 @item max-vartrack-size
10655 Sets a maximum number of hash table slots to use during variable
10656 tracking dataflow analysis of any function.  If this limit is exceeded
10657 with variable tracking at assignments enabled, analysis for that
10658 function is retried without it, after removing all debug insns from
10659 the function.  If the limit is exceeded even without debug insns, var
10660 tracking analysis is completely disabled for the function.  Setting
10661 the parameter to zero makes it unlimited.
10663 @item max-vartrack-expr-depth
10664 Sets a maximum number of recursion levels when attempting to map
10665 variable names or debug temporaries to value expressions.  This trades
10666 compilation time for more complete debug information.  If this is set too
10667 low, value expressions that are available and could be represented in
10668 debug information may end up not being used; setting this higher may
10669 enable the compiler to find more complex debug expressions, but compile
10670 time and memory use may grow.  The default is 12.
10672 @item max-debug-marker-count
10673 Sets a threshold on the number of debug markers (e.g. begin stmt
10674 markers) to avoid complexity explosion at inlining or expanding to RTL.
10675 If a function has more such gimple stmts than the set limit, such stmts
10676 will be dropped from the inlined copy of a function, and from its RTL
10677 expansion.  The default is 100000.
10679 @item min-nondebug-insn-uid
10680 Use uids starting at this parameter for nondebug insns.  The range below
10681 the parameter is reserved exclusively for debug insns created by
10682 @option{-fvar-tracking-assignments}, but debug insns may get
10683 (non-overlapping) uids above it if the reserved range is exhausted.
10685 @item ipa-sra-ptr-growth-factor
10686 IPA-SRA replaces a pointer to an aggregate with one or more new
10687 parameters only when their cumulative size is less or equal to
10688 @option{ipa-sra-ptr-growth-factor} times the size of the original
10689 pointer parameter.
10691 @item sra-max-scalarization-size-Ospeed
10692 @item sra-max-scalarization-size-Osize
10693 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10694 replace scalar parts of aggregates with uses of independent scalar
10695 variables.  These parameters control the maximum size, in storage units,
10696 of aggregate which is considered for replacement when compiling for
10697 speed
10698 (@option{sra-max-scalarization-size-Ospeed}) or size
10699 (@option{sra-max-scalarization-size-Osize}) respectively.
10701 @item tm-max-aggregate-size
10702 When making copies of thread-local variables in a transaction, this
10703 parameter specifies the size in bytes after which variables are
10704 saved with the logging functions as opposed to save/restore code
10705 sequence pairs.  This option only applies when using
10706 @option{-fgnu-tm}.
10708 @item graphite-max-nb-scop-params
10709 To avoid exponential effects in the Graphite loop transforms, the
10710 number of parameters in a Static Control Part (SCoP) is bounded.  The
10711 default value is 10 parameters, a value of zero can be used to lift
10712 the bound.  A variable whose value is unknown at compilation time and
10713 defined outside a SCoP is a parameter of the SCoP.
10715 @item loop-block-tile-size
10716 Loop blocking or strip mining transforms, enabled with
10717 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10718 loop in the loop nest by a given number of iterations.  The strip
10719 length can be changed using the @option{loop-block-tile-size}
10720 parameter.  The default value is 51 iterations.
10722 @item loop-unroll-jam-size
10723 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10724 default value is 4.
10726 @item loop-unroll-jam-depth
10727 Specify the dimension to be unrolled (counting from the most inner loop)
10728 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10730 @item ipa-cp-value-list-size
10731 IPA-CP attempts to track all possible values and types passed to a function's
10732 parameter in order to propagate them and perform devirtualization.
10733 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10734 stores per one formal parameter of a function.
10736 @item ipa-cp-eval-threshold
10737 IPA-CP calculates its own score of cloning profitability heuristics
10738 and performs those cloning opportunities with scores that exceed
10739 @option{ipa-cp-eval-threshold}.
10741 @item ipa-cp-recursion-penalty
10742 Percentage penalty the recursive functions will receive when they
10743 are evaluated for cloning.
10745 @item ipa-cp-single-call-penalty
10746 Percentage penalty functions containing a single call to another
10747 function will receive when they are evaluated for cloning.
10750 @item ipa-max-agg-items
10751 IPA-CP is also capable to propagate a number of scalar values passed
10752 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10753 number of such values per one parameter.
10755 @item ipa-cp-loop-hint-bonus
10756 When IPA-CP determines that a cloning candidate would make the number
10757 of iterations of a loop known, it adds a bonus of
10758 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10759 the candidate.
10761 @item ipa-cp-array-index-hint-bonus
10762 When IPA-CP determines that a cloning candidate would make the index of
10763 an array access known, it adds a bonus of
10764 @option{ipa-cp-array-index-hint-bonus} to the profitability
10765 score of the candidate.
10767 @item ipa-max-aa-steps
10768 During its analysis of function bodies, IPA-CP employs alias analysis
10769 in order to track values pointed to by function parameters.  In order
10770 not spend too much time analyzing huge functions, it gives up and
10771 consider all memory clobbered after examining
10772 @option{ipa-max-aa-steps} statements modifying memory.
10774 @item lto-partitions
10775 Specify desired number of partitions produced during WHOPR compilation.
10776 The number of partitions should exceed the number of CPUs used for compilation.
10777 The default value is 32.
10779 @item lto-min-partition
10780 Size of minimal partition for WHOPR (in estimated instructions).
10781 This prevents expenses of splitting very small programs into too many
10782 partitions.
10784 @item lto-max-partition
10785 Size of max partition for WHOPR (in estimated instructions).
10786 to provide an upper bound for individual size of partition.
10787 Meant to be used only with balanced partitioning.
10789 @item cxx-max-namespaces-for-diagnostic-help
10790 The maximum number of namespaces to consult for suggestions when C++
10791 name lookup fails for an identifier.  The default is 1000.
10793 @item sink-frequency-threshold
10794 The maximum relative execution frequency (in percents) of the target block
10795 relative to a statement's original block to allow statement sinking of a
10796 statement.  Larger numbers result in more aggressive statement sinking.
10797 The default value is 75.  A small positive adjustment is applied for
10798 statements with memory operands as those are even more profitable so sink.
10800 @item max-stores-to-sink
10801 The maximum number of conditional store pairs that can be sunk.  Set to 0
10802 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10803 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10805 @item allow-store-data-races
10806 Allow optimizers to introduce new data races on stores.
10807 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10808 at optimization level @option{-Ofast}.
10810 @item case-values-threshold
10811 The smallest number of different values for which it is best to use a
10812 jump-table instead of a tree of conditional branches.  If the value is
10813 0, use the default for the machine.  The default is 0.
10815 @item tree-reassoc-width
10816 Set the maximum number of instructions executed in parallel in
10817 reassociated tree. This parameter overrides target dependent
10818 heuristics used by default if has non zero value.
10820 @item sched-pressure-algorithm
10821 Choose between the two available implementations of
10822 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10823 and is the more likely to prevent instructions from being reordered.
10824 Algorithm 2 was designed to be a compromise between the relatively
10825 conservative approach taken by algorithm 1 and the rather aggressive
10826 approach taken by the default scheduler.  It relies more heavily on
10827 having a regular register file and accurate register pressure classes.
10828 See @file{haifa-sched.c} in the GCC sources for more details.
10830 The default choice depends on the target.
10832 @item max-slsr-cand-scan
10833 Set the maximum number of existing candidates that are considered when
10834 seeking a basis for a new straight-line strength reduction candidate.
10836 @item asan-globals
10837 Enable buffer overflow detection for global objects.  This kind
10838 of protection is enabled by default if you are using
10839 @option{-fsanitize=address} option.
10840 To disable global objects protection use @option{--param asan-globals=0}.
10842 @item asan-stack
10843 Enable buffer overflow detection for stack objects.  This kind of
10844 protection is enabled by default when using @option{-fsanitize=address}.
10845 To disable stack protection use @option{--param asan-stack=0} option.
10847 @item asan-instrument-reads
10848 Enable buffer overflow detection for memory reads.  This kind of
10849 protection is enabled by default when using @option{-fsanitize=address}.
10850 To disable memory reads protection use
10851 @option{--param asan-instrument-reads=0}.
10853 @item asan-instrument-writes
10854 Enable buffer overflow detection for memory writes.  This kind of
10855 protection is enabled by default when using @option{-fsanitize=address}.
10856 To disable memory writes protection use
10857 @option{--param asan-instrument-writes=0} option.
10859 @item asan-memintrin
10860 Enable detection for built-in functions.  This kind of protection
10861 is enabled by default when using @option{-fsanitize=address}.
10862 To disable built-in functions protection use
10863 @option{--param asan-memintrin=0}.
10865 @item asan-use-after-return
10866 Enable detection of use-after-return.  This kind of protection
10867 is enabled by default when using the @option{-fsanitize=address} option.
10868 To disable it use @option{--param asan-use-after-return=0}.
10870 Note: By default the check is disabled at run time.  To enable it,
10871 add @code{detect_stack_use_after_return=1} to the environment variable
10872 @env{ASAN_OPTIONS}.
10874 @item asan-instrumentation-with-call-threshold
10875 If number of memory accesses in function being instrumented
10876 is greater or equal to this number, use callbacks instead of inline checks.
10877 E.g. to disable inline code use
10878 @option{--param asan-instrumentation-with-call-threshold=0}.
10880 @item use-after-scope-direct-emission-threshold
10881 If the size of a local variable in bytes is smaller or equal to this
10882 number, directly poison (or unpoison) shadow memory instead of using
10883 run-time callbacks.  The default value is 256.
10885 @item chkp-max-ctor-size
10886 Static constructors generated by Pointer Bounds Checker may become very
10887 large and significantly increase compile time at optimization level
10888 @option{-O1} and higher.  This parameter is a maximum number of statements
10889 in a single generated constructor.  Default value is 5000.
10891 @item max-fsm-thread-path-insns
10892 Maximum number of instructions to copy when duplicating blocks on a
10893 finite state automaton jump thread path.  The default is 100.
10895 @item max-fsm-thread-length
10896 Maximum number of basic blocks on a finite state automaton jump thread
10897 path.  The default is 10.
10899 @item max-fsm-thread-paths
10900 Maximum number of new jump thread paths to create for a finite state
10901 automaton.  The default is 50.
10903 @item parloops-chunk-size
10904 Chunk size of omp schedule for loops parallelized by parloops.  The default
10905 is 0.
10907 @item parloops-schedule
10908 Schedule type of omp schedule for loops parallelized by parloops (static,
10909 dynamic, guided, auto, runtime).  The default is static.
10911 @item parloops-min-per-thread
10912 The minimum number of iterations per thread of an innermost parallelized
10913 loop for which the parallelized variant is prefered over the single threaded
10914 one.  The default is 100.  Note that for a parallelized loop nest the
10915 minimum number of iterations of the outermost loop per thread is two.
10917 @item max-ssa-name-query-depth
10918 Maximum depth of recursion when querying properties of SSA names in things
10919 like fold routines.  One level of recursion corresponds to following a
10920 use-def chain.
10922 @item hsa-gen-debug-stores
10923 Enable emission of special debug stores within HSA kernels which are
10924 then read and reported by libgomp plugin.  Generation of these stores
10925 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10926 enable it.
10928 @item max-speculative-devirt-maydefs
10929 The maximum number of may-defs we analyze when looking for a must-def
10930 specifying the dynamic type of an object that invokes a virtual call
10931 we may be able to devirtualize speculatively.
10933 @item max-vrp-switch-assertions
10934 The maximum number of assertions to add along the default edge of a switch
10935 statement during VRP.  The default is 10.
10937 @item unroll-jam-min-percent
10938 The minimum percentage of memory references that must be optimized
10939 away for the unroll-and-jam transformation to be considered profitable.
10941 @item unroll-jam-max-unroll
10942 The maximum number of times the outer loop should be unrolled by
10943 the unroll-and-jam transformation.
10944 @end table
10945 @end table
10947 @node Instrumentation Options
10948 @section Program Instrumentation Options
10949 @cindex instrumentation options
10950 @cindex program instrumentation options
10951 @cindex run-time error checking options
10952 @cindex profiling options
10953 @cindex options, program instrumentation
10954 @cindex options, run-time error checking
10955 @cindex options, profiling
10957 GCC supports a number of command-line options that control adding
10958 run-time instrumentation to the code it normally generates.  
10959 For example, one purpose of instrumentation is collect profiling
10960 statistics for use in finding program hot spots, code coverage
10961 analysis, or profile-guided optimizations.
10962 Another class of program instrumentation is adding run-time checking 
10963 to detect programming errors like invalid pointer
10964 dereferences or out-of-bounds array accesses, as well as deliberately
10965 hostile attacks such as stack smashing or C++ vtable hijacking.
10966 There is also a general hook which can be used to implement other
10967 forms of tracing or function-level instrumentation for debug or
10968 program analysis purposes.
10970 @table @gcctabopt
10971 @cindex @command{prof}
10972 @item -p
10973 @opindex p
10974 Generate extra code to write profile information suitable for the
10975 analysis program @command{prof}.  You must use this option when compiling
10976 the source files you want data about, and you must also use it when
10977 linking.
10979 @cindex @command{gprof}
10980 @item -pg
10981 @opindex pg
10982 Generate extra code to write profile information suitable for the
10983 analysis program @command{gprof}.  You must use this option when compiling
10984 the source files you want data about, and you must also use it when
10985 linking.
10987 @item -fprofile-arcs
10988 @opindex fprofile-arcs
10989 Add code so that program flow @dfn{arcs} are instrumented.  During
10990 execution the program records how many times each branch and call is
10991 executed and how many times it is taken or returns.  On targets that support
10992 constructors with priority support, profiling properly handles constructors,
10993 destructors and C++ constructors (and destructors) of classes which are used
10994 as a type of a global variable.
10996 When the compiled
10997 program exits it saves this data to a file called
10998 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10999 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11000 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11001 @var{auxname} is generated from the name of the output file, if
11002 explicitly specified and it is not the final executable, otherwise it is
11003 the basename of the source file.  In both cases any suffix is removed
11004 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11005 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11006 @xref{Cross-profiling}.
11008 @cindex @command{gcov}
11009 @item --coverage
11010 @opindex coverage
11012 This option is used to compile and link code instrumented for coverage
11013 analysis.  The option is a synonym for @option{-fprofile-arcs}
11014 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11015 linking).  See the documentation for those options for more details.
11017 @itemize
11019 @item
11020 Compile the source files with @option{-fprofile-arcs} plus optimization
11021 and code generation options.  For test coverage analysis, use the
11022 additional @option{-ftest-coverage} option.  You do not need to profile
11023 every source file in a program.
11025 @item
11026 Compile the source files additionally with @option{-fprofile-abs-path}
11027 to create absolute path names in the @file{.gcno} files.  This allows
11028 @command{gcov} to find the correct sources in projects where compilations
11029 occur with different working directories.
11031 @item
11032 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11033 (the latter implies the former).
11035 @item
11036 Run the program on a representative workload to generate the arc profile
11037 information.  This may be repeated any number of times.  You can run
11038 concurrent instances of your program, and provided that the file system
11039 supports locking, the data files will be correctly updated.  Unless
11040 a strict ISO C dialect option is in effect, @code{fork} calls are
11041 detected and correctly handled without double counting.
11043 @item
11044 For profile-directed optimizations, compile the source files again with
11045 the same optimization and code generation options plus
11046 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11047 Control Optimization}).
11049 @item
11050 For test coverage analysis, use @command{gcov} to produce human readable
11051 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11052 @command{gcov} documentation for further information.
11054 @end itemize
11056 With @option{-fprofile-arcs}, for each function of your program GCC
11057 creates a program flow graph, then finds a spanning tree for the graph.
11058 Only arcs that are not on the spanning tree have to be instrumented: the
11059 compiler adds code to count the number of times that these arcs are
11060 executed.  When an arc is the only exit or only entrance to a block, the
11061 instrumentation code can be added to the block; otherwise, a new basic
11062 block must be created to hold the instrumentation code.
11064 @need 2000
11065 @item -ftest-coverage
11066 @opindex ftest-coverage
11067 Produce a notes file that the @command{gcov} code-coverage utility
11068 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11069 show program coverage.  Each source file's note file is called
11070 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11071 above for a description of @var{auxname} and instructions on how to
11072 generate test coverage data.  Coverage data matches the source files
11073 more closely if you do not optimize.
11075 @item -fprofile-abs-path
11076 @opindex fprofile-abs-path
11077 Automatically convert relative source file names to absolute path names
11078 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11079 sources in projects where compilations occur with different working
11080 directories.
11082 @item -fprofile-dir=@var{path}
11083 @opindex fprofile-dir
11085 Set the directory to search for the profile data files in to @var{path}.
11086 This option affects only the profile data generated by
11087 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11088 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11089 and its related options.  Both absolute and relative paths can be used.
11090 By default, GCC uses the current directory as @var{path}, thus the
11091 profile data file appears in the same directory as the object file.
11093 @item -fprofile-generate
11094 @itemx -fprofile-generate=@var{path}
11095 @opindex fprofile-generate
11097 Enable options usually used for instrumenting application to produce
11098 profile useful for later recompilation with profile feedback based
11099 optimization.  You must use @option{-fprofile-generate} both when
11100 compiling and when linking your program.
11102 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11104 If @var{path} is specified, GCC looks at the @var{path} to find
11105 the profile feedback data files. See @option{-fprofile-dir}.
11107 To optimize the program based on the collected profile information, use
11108 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11110 @item -fprofile-update=@var{method}
11111 @opindex fprofile-update
11113 Alter the update method for an application instrumented for profile
11114 feedback based optimization.  The @var{method} argument should be one of
11115 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11116 The first one is useful for single-threaded applications,
11117 while the second one prevents profile corruption by emitting thread-safe code.
11119 @strong{Warning:} When an application does not properly join all threads
11120 (or creates an detached thread), a profile file can be still corrupted.
11122 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11123 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11124 automatically selects @samp{prefer-atomic} when @option{-pthread}
11125 is present in the command line.
11127 @item -fsanitize=address
11128 @opindex fsanitize=address
11129 Enable AddressSanitizer, a fast memory error detector.
11130 Memory access instructions are instrumented to detect
11131 out-of-bounds and use-after-free bugs.
11132 The option enables @option{-fsanitize-address-use-after-scope}.
11133 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11134 more details.  The run-time behavior can be influenced using the
11135 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11136 the available options are shown at startup of the instrumented program.  See
11137 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11138 for a list of supported options.
11139 The option cannot be combined with @option{-fsanitize=thread}
11140 and/or @option{-fcheck-pointer-bounds}.
11142 @item -fsanitize=kernel-address
11143 @opindex fsanitize=kernel-address
11144 Enable AddressSanitizer for Linux kernel.
11145 See @uref{https://github.com/google/kasan/wiki} for more details.
11146 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11148 @item -fsanitize=pointer-compare
11149 @opindex fsanitize=pointer-compare
11150 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11151 The option must be combined with either @option{-fsanitize=kernel-address} or
11152 @option{-fsanitize=address}
11153 The option cannot be combined with @option{-fsanitize=thread}
11154 and/or @option{-fcheck-pointer-bounds}.
11155 Note: By default the check is disabled at run time.  To enable it,
11156 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11157 @env{ASAN_OPTIONS}.
11159 @item -fsanitize=pointer-subtract
11160 @opindex fsanitize=pointer-subtract
11161 Instrument subtraction with pointer operands.
11162 The option must be combined with either @option{-fsanitize=kernel-address} or
11163 @option{-fsanitize=address}
11164 The option cannot be combined with @option{-fsanitize=thread}
11165 and/or @option{-fcheck-pointer-bounds}.
11166 Note: By default the check is disabled at run time.  To enable it,
11167 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11168 @env{ASAN_OPTIONS}.
11170 @item -fsanitize=thread
11171 @opindex fsanitize=thread
11172 Enable ThreadSanitizer, a fast data race detector.
11173 Memory access instructions are instrumented to detect
11174 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11175 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11176 environment variable; see
11177 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11178 supported options.
11179 The option cannot be combined with @option{-fsanitize=address},
11180 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11182 Note that sanitized atomic builtins cannot throw exceptions when
11183 operating on invalid memory addresses with non-call exceptions
11184 (@option{-fnon-call-exceptions}).
11186 @item -fsanitize=leak
11187 @opindex fsanitize=leak
11188 Enable LeakSanitizer, a memory leak detector.
11189 This option only matters for linking of executables and
11190 the executable is linked against a library that overrides @code{malloc}
11191 and other allocator functions.  See
11192 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11193 details.  The run-time behavior can be influenced using the
11194 @env{LSAN_OPTIONS} environment variable.
11195 The option cannot be combined with @option{-fsanitize=thread}.
11197 @item -fsanitize=undefined
11198 @opindex fsanitize=undefined
11199 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11200 Various computations are instrumented to detect undefined behavior
11201 at runtime.  Current suboptions are:
11203 @table @gcctabopt
11205 @item -fsanitize=shift
11206 @opindex fsanitize=shift
11207 This option enables checking that the result of a shift operation is
11208 not undefined.  Note that what exactly is considered undefined differs
11209 slightly between C and C++, as well as between ISO C90 and C99, etc.
11210 This option has two suboptions, @option{-fsanitize=shift-base} and
11211 @option{-fsanitize=shift-exponent}.
11213 @item -fsanitize=shift-exponent
11214 @opindex fsanitize=shift-exponent
11215 This option enables checking that the second argument of a shift operation
11216 is not negative and is smaller than the precision of the promoted first
11217 argument.
11219 @item -fsanitize=shift-base
11220 @opindex fsanitize=shift-base
11221 If the second argument of a shift operation is within range, check that the
11222 result of a shift operation is not undefined.  Note that what exactly is
11223 considered undefined differs slightly between C and C++, as well as between
11224 ISO C90 and C99, etc.
11226 @item -fsanitize=integer-divide-by-zero
11227 @opindex fsanitize=integer-divide-by-zero
11228 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11230 @item -fsanitize=unreachable
11231 @opindex fsanitize=unreachable
11232 With this option, the compiler turns the @code{__builtin_unreachable}
11233 call into a diagnostics message call instead.  When reaching the
11234 @code{__builtin_unreachable} call, the behavior is undefined.
11236 @item -fsanitize=vla-bound
11237 @opindex fsanitize=vla-bound
11238 This option instructs the compiler to check that the size of a variable
11239 length array is positive.
11241 @item -fsanitize=null
11242 @opindex fsanitize=null
11243 This option enables pointer checking.  Particularly, the application
11244 built with this option turned on will issue an error message when it
11245 tries to dereference a NULL pointer, or if a reference (possibly an
11246 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11247 on an object pointed by a NULL pointer.
11249 @item -fsanitize=return
11250 @opindex fsanitize=return
11251 This option enables return statement checking.  Programs
11252 built with this option turned on will issue an error message
11253 when the end of a non-void function is reached without actually
11254 returning a value.  This option works in C++ only.
11256 @item -fsanitize=signed-integer-overflow
11257 @opindex fsanitize=signed-integer-overflow
11258 This option enables signed integer overflow checking.  We check that
11259 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11260 does not overflow in the signed arithmetics.  Note, integer promotion
11261 rules must be taken into account.  That is, the following is not an
11262 overflow:
11263 @smallexample
11264 signed char a = SCHAR_MAX;
11265 a++;
11266 @end smallexample
11268 @item -fsanitize=bounds
11269 @opindex fsanitize=bounds
11270 This option enables instrumentation of array bounds.  Various out of bounds
11271 accesses are detected.  Flexible array members, flexible array member-like
11272 arrays, and initializers of variables with static storage are not instrumented.
11273 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11275 @item -fsanitize=bounds-strict
11276 @opindex fsanitize=bounds-strict
11277 This option enables strict instrumentation of array bounds.  Most out of bounds
11278 accesses are detected, including flexible array members and flexible array
11279 member-like arrays.  Initializers of variables with static storage are not
11280 instrumented.  The option cannot be combined
11281 with @option{-fcheck-pointer-bounds}.
11283 @item -fsanitize=alignment
11284 @opindex fsanitize=alignment
11286 This option enables checking of alignment of pointers when they are
11287 dereferenced, or when a reference is bound to insufficiently aligned target,
11288 or when a method or constructor is invoked on insufficiently aligned object.
11290 @item -fsanitize=object-size
11291 @opindex fsanitize=object-size
11292 This option enables instrumentation of memory references using the
11293 @code{__builtin_object_size} function.  Various out of bounds pointer
11294 accesses are detected.
11296 @item -fsanitize=float-divide-by-zero
11297 @opindex fsanitize=float-divide-by-zero
11298 Detect floating-point division by zero.  Unlike other similar options,
11299 @option{-fsanitize=float-divide-by-zero} is not enabled by
11300 @option{-fsanitize=undefined}, since floating-point division by zero can
11301 be a legitimate way of obtaining infinities and NaNs.
11303 @item -fsanitize=float-cast-overflow
11304 @opindex fsanitize=float-cast-overflow
11305 This option enables floating-point type to integer conversion checking.
11306 We check that the result of the conversion does not overflow.
11307 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11308 not enabled by @option{-fsanitize=undefined}.
11309 This option does not work well with @code{FE_INVALID} exceptions enabled.
11311 @item -fsanitize=nonnull-attribute
11312 @opindex fsanitize=nonnull-attribute
11314 This option enables instrumentation of calls, checking whether null values
11315 are not passed to arguments marked as requiring a non-null value by the
11316 @code{nonnull} function attribute.
11318 @item -fsanitize=returns-nonnull-attribute
11319 @opindex fsanitize=returns-nonnull-attribute
11321 This option enables instrumentation of return statements in functions
11322 marked with @code{returns_nonnull} function attribute, to detect returning
11323 of null values from such functions.
11325 @item -fsanitize=bool
11326 @opindex fsanitize=bool
11328 This option enables instrumentation of loads from bool.  If a value other
11329 than 0/1 is loaded, a run-time error is issued.
11331 @item -fsanitize=enum
11332 @opindex fsanitize=enum
11334 This option enables instrumentation of loads from an enum type.  If
11335 a value outside the range of values for the enum type is loaded,
11336 a run-time error is issued.
11338 @item -fsanitize=vptr
11339 @opindex fsanitize=vptr
11341 This option enables instrumentation of C++ member function calls, member
11342 accesses and some conversions between pointers to base and derived classes,
11343 to verify the referenced object has the correct dynamic type.
11345 @item -fsanitize=pointer-overflow
11346 @opindex fsanitize=pointer-overflow
11348 This option enables instrumentation of pointer arithmetics.  If the pointer
11349 arithmetics overflows, a run-time error is issued.
11351 @item -fsanitize=builtin
11352 @opindex fsanitize=builtin
11354 This option enables instrumentation of arguments to selected builtin
11355 functions.  If an invalid value is passed to such arguments, a run-time
11356 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11357 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11358 by this option.
11360 @end table
11362 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11363 @option{-fsanitize=undefined} gives a diagnostic message.
11364 This currently works only for the C family of languages.
11366 @item -fno-sanitize=all
11367 @opindex fno-sanitize=all
11369 This option disables all previously enabled sanitizers.
11370 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11371 together.
11373 @item -fasan-shadow-offset=@var{number}
11374 @opindex fasan-shadow-offset
11375 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11376 It is useful for experimenting with different shadow memory layouts in
11377 Kernel AddressSanitizer.
11379 @item -fsanitize-sections=@var{s1},@var{s2},...
11380 @opindex fsanitize-sections
11381 Sanitize global variables in selected user-defined sections.  @var{si} may
11382 contain wildcards.
11384 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11385 @opindex fsanitize-recover
11386 @opindex fno-sanitize-recover
11387 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11388 mentioned in comma-separated list of @var{opts}.  Enabling this option
11389 for a sanitizer component causes it to attempt to continue
11390 running the program as if no error happened.  This means multiple
11391 runtime errors can be reported in a single program run, and the exit
11392 code of the program may indicate success even when errors
11393 have been reported.  The @option{-fno-sanitize-recover=} option
11394 can be used to alter
11395 this behavior: only the first detected error is reported
11396 and program then exits with a non-zero exit code.
11398 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11399 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11400 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11401 @option{-fsanitize=bounds-strict},
11402 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11403 For these sanitizers error recovery is turned on by default,
11404 except @option{-fsanitize=address}, for which this feature is experimental.
11405 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11406 accepted, the former enables recovery for all sanitizers that support it,
11407 the latter disables recovery for all sanitizers that support it.
11409 Even if a recovery mode is turned on the compiler side, it needs to be also
11410 enabled on the runtime library side, otherwise the failures are still fatal.
11411 The runtime library defaults to @code{halt_on_error=0} for
11412 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11413 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11414 setting the @code{halt_on_error} flag in the corresponding environment variable.
11416 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11417 equivalent to specifying an @var{opts} list of:
11419 @smallexample
11420 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11421 @end smallexample
11423 @item -fsanitize-address-use-after-scope
11424 @opindex fsanitize-address-use-after-scope
11425 Enable sanitization of local variables to detect use-after-scope bugs.
11426 The option sets @option{-fstack-reuse} to @samp{none}.
11428 @item -fsanitize-undefined-trap-on-error
11429 @opindex fsanitize-undefined-trap-on-error
11430 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11431 report undefined behavior using @code{__builtin_trap} rather than
11432 a @code{libubsan} library routine.  The advantage of this is that the
11433 @code{libubsan} library is not needed and is not linked in, so this
11434 is usable even in freestanding environments.
11436 @item -fsanitize-coverage=trace-pc
11437 @opindex fsanitize-coverage=trace-pc
11438 Enable coverage-guided fuzzing code instrumentation.
11439 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11441 @item -fsanitize-coverage=trace-cmp
11442 @opindex fsanitize-coverage=trace-cmp
11443 Enable dataflow guided fuzzing code instrumentation.
11444 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11445 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11446 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11447 variable or @code{__sanitizer_cov_trace_const_cmp1},
11448 @code{__sanitizer_cov_trace_const_cmp2},
11449 @code{__sanitizer_cov_trace_const_cmp4} or
11450 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11451 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11452 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11453 @code{__sanitizer_cov_trace_switch} for switch statements.
11455 @item -fbounds-check
11456 @opindex fbounds-check
11457 For front ends that support it, generate additional code to check that
11458 indices used to access arrays are within the declared range.  This is
11459 currently only supported by the Fortran front end, where this option
11460 defaults to false.
11462 @item -fcheck-pointer-bounds
11463 @opindex fcheck-pointer-bounds
11464 @opindex fno-check-pointer-bounds
11465 @cindex Pointer Bounds Checker options
11466 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11467 is instrumented with checks of the pointer used for memory access against
11468 bounds associated with that pointer.  
11470 Currently there
11471 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11472 and @option{-mmpx} are required to enable this feature.  
11473 MPX-based instrumentation requires
11474 a runtime library to enable MPX in hardware and handle bounds
11475 violation signals.  By default when @option{-fcheck-pointer-bounds}
11476 and @option{-mmpx} options are used to link a program, the GCC driver
11477 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11478 Bounds checking on calls to dynamic libraries requires a linker
11479 with @option{-z bndplt} support; if GCC was configured with a linker
11480 without support for this option (including the Gold linker and older
11481 versions of ld), a warning is given if you link with @option{-mmpx}
11482 without also specifying @option{-static}, since the overall effectiveness
11483 of the bounds checking protection is reduced.
11484 See also @option{-static-libmpxwrappers}.
11486 MPX-based instrumentation
11487 may be used for debugging and also may be included in production code
11488 to increase program security.  Depending on usage, you may
11489 have different requirements for the runtime library.  The current version
11490 of the MPX runtime library is more oriented for use as a debugging
11491 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11492 also @option{-static-libmpx}.  The runtime library  behavior can be
11493 influenced using various @env{CHKP_RT_*} environment variables.  See
11494 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11495 for more details.
11497 Generated instrumentation may be controlled by various
11498 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11499 structure field attribute (@pxref{Type Attributes}) and
11500 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11501 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11502 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11503 Bounds Checker builtins}, for more information.
11505 @item -fchkp-check-incomplete-type
11506 @opindex fchkp-check-incomplete-type
11507 @opindex fno-chkp-check-incomplete-type
11508 Generate pointer bounds checks for variables with incomplete type.
11509 Enabled by default.
11511 @item -fchkp-narrow-bounds
11512 @opindex fchkp-narrow-bounds
11513 @opindex fno-chkp-narrow-bounds
11514 Controls bounds used by Pointer Bounds Checker for pointers to object
11515 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11516 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11517 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11519 @item -fchkp-first-field-has-own-bounds
11520 @opindex fchkp-first-field-has-own-bounds
11521 @opindex fno-chkp-first-field-has-own-bounds
11522 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11523 first field in the structure.  By default a pointer to the first field has
11524 the same bounds as a pointer to the whole structure.
11526 @item -fchkp-flexible-struct-trailing-arrays
11527 @opindex fchkp-flexible-struct-trailing-arrays
11528 @opindex fno-chkp-flexible-struct-trailing-arrays
11529 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11530 possibly flexible.  By default only array fields with zero length or that are
11531 marked with attribute bnd_variable_size are treated as flexible.
11533 @item -fchkp-narrow-to-innermost-array
11534 @opindex fchkp-narrow-to-innermost-array
11535 @opindex fno-chkp-narrow-to-innermost-array
11536 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11537 case of nested static array access.  By default this option is disabled and
11538 bounds of the outermost array are used.
11540 @item -fchkp-optimize
11541 @opindex fchkp-optimize
11542 @opindex fno-chkp-optimize
11543 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11544 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11546 @item -fchkp-use-fast-string-functions
11547 @opindex fchkp-use-fast-string-functions
11548 @opindex fno-chkp-use-fast-string-functions
11549 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11550 by Pointer Bounds Checker.  Disabled by default.
11552 @item -fchkp-use-nochk-string-functions
11553 @opindex fchkp-use-nochk-string-functions
11554 @opindex fno-chkp-use-nochk-string-functions
11555 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11556 by Pointer Bounds Checker.  Disabled by default.
11558 @item -fchkp-use-static-bounds
11559 @opindex fchkp-use-static-bounds
11560 @opindex fno-chkp-use-static-bounds
11561 Allow Pointer Bounds Checker to generate static bounds holding
11562 bounds of static variables.  Enabled by default.
11564 @item -fchkp-use-static-const-bounds
11565 @opindex fchkp-use-static-const-bounds
11566 @opindex fno-chkp-use-static-const-bounds
11567 Use statically-initialized bounds for constant bounds instead of
11568 generating them each time they are required.  By default enabled when
11569 @option{-fchkp-use-static-bounds} is enabled.
11571 @item -fchkp-treat-zero-dynamic-size-as-infinite
11572 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11573 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11574 With this option, objects with incomplete type whose
11575 dynamically-obtained size is zero are treated as having infinite size
11576 instead by Pointer Bounds
11577 Checker.  This option may be helpful if a program is linked with a library
11578 missing size information for some symbols.  Disabled by default.
11580 @item -fchkp-check-read
11581 @opindex fchkp-check-read
11582 @opindex fno-chkp-check-read
11583 Instructs Pointer Bounds Checker to generate checks for all read
11584 accesses to memory.  Enabled by default.
11586 @item -fchkp-check-write
11587 @opindex fchkp-check-write
11588 @opindex fno-chkp-check-write
11589 Instructs Pointer Bounds Checker to generate checks for all write
11590 accesses to memory.  Enabled by default.
11592 @item -fchkp-store-bounds
11593 @opindex fchkp-store-bounds
11594 @opindex fno-chkp-store-bounds
11595 Instructs Pointer Bounds Checker to generate bounds stores for
11596 pointer writes.  Enabled by default.
11598 @item -fchkp-instrument-calls
11599 @opindex fchkp-instrument-calls
11600 @opindex fno-chkp-instrument-calls
11601 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11602 Enabled by default.
11604 @item -fchkp-instrument-marked-only
11605 @opindex fchkp-instrument-marked-only
11606 @opindex fno-chkp-instrument-marked-only
11607 Instructs Pointer Bounds Checker to instrument only functions
11608 marked with the @code{bnd_instrument} attribute
11609 (@pxref{Function Attributes}).  Disabled by default.
11611 @item -fchkp-use-wrappers
11612 @opindex fchkp-use-wrappers
11613 @opindex fno-chkp-use-wrappers
11614 Allows Pointer Bounds Checker to replace calls to built-in functions
11615 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11616 is used to link a program, the GCC driver automatically links
11617 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11618 Enabled by default.
11620 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11621 @opindex fcf-protection
11622 Enable code instrumentation of control-flow transfers to increase
11623 program security by checking that target addresses of control-flow
11624 transfer instructions (such as indirect function call, function return,
11625 indirect jump) are valid.  This prevents diverting the flow of control
11626 to an unexpected target.  This is intended to protect against such
11627 threats as Return-oriented Programming (ROP), and similarly
11628 call/jmp-oriented programming (COP/JOP).
11630 The value @code{branch} tells the compiler to implement checking of
11631 validity of control-flow transfer at the point of indirect branch
11632 instructions, i.e. call/jmp instructions.  The value @code{return}
11633 implements checking of validity at the point of returning from a
11634 function.  The value @code{full} is an alias for specifying both
11635 @code{branch} and @code{return}. The value @code{none} turns off
11636 instrumentation.
11638 You can also use the @code{nocf_check} attribute to identify
11639 which functions and calls should be skipped from instrumentation
11640 (@pxref{Function Attributes}).
11642 Currently the x86 GNU/Linux target provides an implementation based
11643 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11644 for x86 is controlled by target-specific options @option{-mcet},
11645 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11647 @item -fstack-protector
11648 @opindex fstack-protector
11649 Emit extra code to check for buffer overflows, such as stack smashing
11650 attacks.  This is done by adding a guard variable to functions with
11651 vulnerable objects.  This includes functions that call @code{alloca}, and
11652 functions with buffers larger than 8 bytes.  The guards are initialized
11653 when a function is entered and then checked when the function exits.
11654 If a guard check fails, an error message is printed and the program exits.
11656 @item -fstack-protector-all
11657 @opindex fstack-protector-all
11658 Like @option{-fstack-protector} except that all functions are protected.
11660 @item -fstack-protector-strong
11661 @opindex fstack-protector-strong
11662 Like @option{-fstack-protector} but includes additional functions to
11663 be protected --- those that have local array definitions, or have
11664 references to local frame addresses.
11666 @item -fstack-protector-explicit
11667 @opindex fstack-protector-explicit
11668 Like @option{-fstack-protector} but only protects those functions which
11669 have the @code{stack_protect} attribute.
11671 @item -fstack-check
11672 @opindex fstack-check
11673 Generate code to verify that you do not go beyond the boundary of the
11674 stack.  You should specify this flag if you are running in an
11675 environment with multiple threads, but you only rarely need to specify it in
11676 a single-threaded environment since stack overflow is automatically
11677 detected on nearly all systems if there is only one stack.
11679 Note that this switch does not actually cause checking to be done; the
11680 operating system or the language runtime must do that.  The switch causes
11681 generation of code to ensure that they see the stack being extended.
11683 You can additionally specify a string parameter: @samp{no} means no
11684 checking, @samp{generic} means force the use of old-style checking,
11685 @samp{specific} means use the best checking method and is equivalent
11686 to bare @option{-fstack-check}.
11688 Old-style checking is a generic mechanism that requires no specific
11689 target support in the compiler but comes with the following drawbacks:
11691 @enumerate
11692 @item
11693 Modified allocation strategy for large objects: they are always
11694 allocated dynamically if their size exceeds a fixed threshold.  Note this
11695 may change the semantics of some code.
11697 @item
11698 Fixed limit on the size of the static frame of functions: when it is
11699 topped by a particular function, stack checking is not reliable and
11700 a warning is issued by the compiler.
11702 @item
11703 Inefficiency: because of both the modified allocation strategy and the
11704 generic implementation, code performance is hampered.
11705 @end enumerate
11707 Note that old-style stack checking is also the fallback method for
11708 @samp{specific} if no target support has been added in the compiler.
11710 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11711 and stack overflows.  @samp{specific} is an excellent choice when compiling
11712 Ada code.  It is not generally sufficient to protect against stack-clash
11713 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11715 @item -fstack-clash-protection
11716 @opindex fstack-clash-protection
11717 Generate code to prevent stack clash style attacks.  When this option is
11718 enabled, the compiler will only allocate one page of stack space at a time
11719 and each page is accessed immediately after allocation.  Thus, it prevents
11720 allocations from jumping over any stack guard page provided by the
11721 operating system.
11723 Most targets do not fully support stack clash protection.  However, on
11724 those targets @option{-fstack-clash-protection} will protect dynamic stack
11725 allocations.  @option{-fstack-clash-protection} may also provide limited
11726 protection for static stack allocations if the target supports
11727 @option{-fstack-check=specific}.
11729 @item -fstack-limit-register=@var{reg}
11730 @itemx -fstack-limit-symbol=@var{sym}
11731 @itemx -fno-stack-limit
11732 @opindex fstack-limit-register
11733 @opindex fstack-limit-symbol
11734 @opindex fno-stack-limit
11735 Generate code to ensure that the stack does not grow beyond a certain value,
11736 either the value of a register or the address of a symbol.  If a larger
11737 stack is required, a signal is raised at run time.  For most targets,
11738 the signal is raised before the stack overruns the boundary, so
11739 it is possible to catch the signal without taking special precautions.
11741 For instance, if the stack starts at absolute address @samp{0x80000000}
11742 and grows downwards, you can use the flags
11743 @option{-fstack-limit-symbol=__stack_limit} and
11744 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11745 of 128KB@.  Note that this may only work with the GNU linker.
11747 You can locally override stack limit checking by using the
11748 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11750 @item -fsplit-stack
11751 @opindex fsplit-stack
11752 Generate code to automatically split the stack before it overflows.
11753 The resulting program has a discontiguous stack which can only
11754 overflow if the program is unable to allocate any more memory.  This
11755 is most useful when running threaded programs, as it is no longer
11756 necessary to calculate a good stack size to use for each thread.  This
11757 is currently only implemented for the x86 targets running
11758 GNU/Linux.
11760 When code compiled with @option{-fsplit-stack} calls code compiled
11761 without @option{-fsplit-stack}, there may not be much stack space
11762 available for the latter code to run.  If compiling all code,
11763 including library code, with @option{-fsplit-stack} is not an option,
11764 then the linker can fix up these calls so that the code compiled
11765 without @option{-fsplit-stack} always has a large stack.  Support for
11766 this is implemented in the gold linker in GNU binutils release 2.21
11767 and later.
11769 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11770 @opindex fvtable-verify
11771 This option is only available when compiling C++ code.
11772 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11773 feature that verifies at run time, for every virtual call, that
11774 the vtable pointer through which the call is made is valid for the type of
11775 the object, and has not been corrupted or overwritten.  If an invalid vtable
11776 pointer is detected at run time, an error is reported and execution of the
11777 program is immediately halted.
11779 This option causes run-time data structures to be built at program startup,
11780 which are used for verifying the vtable pointers.  
11781 The options @samp{std} and @samp{preinit}
11782 control the timing of when these data structures are built.  In both cases the
11783 data structures are built before execution reaches @code{main}.  Using
11784 @option{-fvtable-verify=std} causes the data structures to be built after
11785 shared libraries have been loaded and initialized.
11786 @option{-fvtable-verify=preinit} causes them to be built before shared
11787 libraries have been loaded and initialized.
11789 If this option appears multiple times in the command line with different
11790 values specified, @samp{none} takes highest priority over both @samp{std} and
11791 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11793 @item -fvtv-debug
11794 @opindex fvtv-debug
11795 When used in conjunction with @option{-fvtable-verify=std} or 
11796 @option{-fvtable-verify=preinit}, causes debug versions of the 
11797 runtime functions for the vtable verification feature to be called.  
11798 This flag also causes the compiler to log information about which 
11799 vtable pointers it finds for each class.
11800 This information is written to a file named @file{vtv_set_ptr_data.log} 
11801 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11802 if that is defined or the current working directory otherwise.
11804 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11805 file, be sure to delete any existing one.
11807 @item -fvtv-counts
11808 @opindex fvtv-counts
11809 This is a debugging flag.  When used in conjunction with
11810 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11811 causes the compiler to keep track of the total number of virtual calls
11812 it encounters and the number of verifications it inserts.  It also
11813 counts the number of calls to certain run-time library functions
11814 that it inserts and logs this information for each compilation unit.
11815 The compiler writes this information to a file named
11816 @file{vtv_count_data.log} in the directory named by the environment
11817 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11818 directory otherwise.  It also counts the size of the vtable pointer sets
11819 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11820 in the same directory.
11822 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11823 files, be sure to delete any existing ones.
11825 @item -finstrument-functions
11826 @opindex finstrument-functions
11827 Generate instrumentation calls for entry and exit to functions.  Just
11828 after function entry and just before function exit, the following
11829 profiling functions are called with the address of the current
11830 function and its call site.  (On some platforms,
11831 @code{__builtin_return_address} does not work beyond the current
11832 function, so the call site information may not be available to the
11833 profiling functions otherwise.)
11835 @smallexample
11836 void __cyg_profile_func_enter (void *this_fn,
11837                                void *call_site);
11838 void __cyg_profile_func_exit  (void *this_fn,
11839                                void *call_site);
11840 @end smallexample
11842 The first argument is the address of the start of the current function,
11843 which may be looked up exactly in the symbol table.
11845 This instrumentation is also done for functions expanded inline in other
11846 functions.  The profiling calls indicate where, conceptually, the
11847 inline function is entered and exited.  This means that addressable
11848 versions of such functions must be available.  If all your uses of a
11849 function are expanded inline, this may mean an additional expansion of
11850 code size.  If you use @code{extern inline} in your C code, an
11851 addressable version of such functions must be provided.  (This is
11852 normally the case anyway, but if you get lucky and the optimizer always
11853 expands the functions inline, you might have gotten away without
11854 providing static copies.)
11856 A function may be given the attribute @code{no_instrument_function}, in
11857 which case this instrumentation is not done.  This can be used, for
11858 example, for the profiling functions listed above, high-priority
11859 interrupt routines, and any functions from which the profiling functions
11860 cannot safely be called (perhaps signal handlers, if the profiling
11861 routines generate output or allocate memory).
11863 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11864 @opindex finstrument-functions-exclude-file-list
11866 Set the list of functions that are excluded from instrumentation (see
11867 the description of @option{-finstrument-functions}).  If the file that
11868 contains a function definition matches with one of @var{file}, then
11869 that function is not instrumented.  The match is done on substrings:
11870 if the @var{file} parameter is a substring of the file name, it is
11871 considered to be a match.
11873 For example:
11875 @smallexample
11876 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11877 @end smallexample
11879 @noindent
11880 excludes any inline function defined in files whose pathnames
11881 contain @file{/bits/stl} or @file{include/sys}.
11883 If, for some reason, you want to include letter @samp{,} in one of
11884 @var{sym}, write @samp{\,}. For example,
11885 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11886 (note the single quote surrounding the option).
11888 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11889 @opindex finstrument-functions-exclude-function-list
11891 This is similar to @option{-finstrument-functions-exclude-file-list},
11892 but this option sets the list of function names to be excluded from
11893 instrumentation.  The function name to be matched is its user-visible
11894 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11895 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11896 match is done on substrings: if the @var{sym} parameter is a substring
11897 of the function name, it is considered to be a match.  For C99 and C++
11898 extended identifiers, the function name must be given in UTF-8, not
11899 using universal character names.
11901 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11902 @opindex fpatchable-function-entry
11903 Generate @var{N} NOPs right at the beginning
11904 of each function, with the function entry point before the @var{M}th NOP.
11905 If @var{M} is omitted, it defaults to @code{0} so the
11906 function entry points to the address just at the first NOP.
11907 The NOP instructions reserve extra space which can be used to patch in
11908 any desired instrumentation at run time, provided that the code segment
11909 is writable.  The amount of space is controllable indirectly via
11910 the number of NOPs; the NOP instruction used corresponds to the instruction
11911 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11912 is target-specific and may also depend on the architecture variant and/or
11913 other compilation options.
11915 For run-time identification, the starting addresses of these areas,
11916 which correspond to their respective function entries minus @var{M},
11917 are additionally collected in the @code{__patchable_function_entries}
11918 section of the resulting binary.
11920 Note that the value of @code{__attribute__ ((patchable_function_entry
11921 (N,M)))} takes precedence over command-line option
11922 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11923 the area size or to remove it completely on a single function.
11924 If @code{N=0}, no pad location is recorded.
11926 The NOP instructions are inserted at---and maybe before, depending on
11927 @var{M}---the function entry address, even before the prologue.
11929 @end table
11932 @node Preprocessor Options
11933 @section Options Controlling the Preprocessor
11934 @cindex preprocessor options
11935 @cindex options, preprocessor
11937 These options control the C preprocessor, which is run on each C source
11938 file before actual compilation.
11940 If you use the @option{-E} option, nothing is done except preprocessing.
11941 Some of these options make sense only together with @option{-E} because
11942 they cause the preprocessor output to be unsuitable for actual
11943 compilation.
11945 In addition to the options listed here, there are a number of options 
11946 to control search paths for include files documented in 
11947 @ref{Directory Options}.  
11948 Options to control preprocessor diagnostics are listed in 
11949 @ref{Warning Options}.
11951 @table @gcctabopt
11952 @include cppopts.texi
11954 @item -Wp,@var{option}
11955 @opindex Wp
11956 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11957 and pass @var{option} directly through to the preprocessor.  If
11958 @var{option} contains commas, it is split into multiple options at the
11959 commas.  However, many options are modified, translated or interpreted
11960 by the compiler driver before being passed to the preprocessor, and
11961 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11962 interface is undocumented and subject to change, so whenever possible
11963 you should avoid using @option{-Wp} and let the driver handle the
11964 options instead.
11966 @item -Xpreprocessor @var{option}
11967 @opindex Xpreprocessor
11968 Pass @var{option} as an option to the preprocessor.  You can use this to
11969 supply system-specific preprocessor options that GCC does not 
11970 recognize.
11972 If you want to pass an option that takes an argument, you must use
11973 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11975 @item -no-integrated-cpp
11976 @opindex no-integrated-cpp
11977 Perform preprocessing as a separate pass before compilation.
11978 By default, GCC performs preprocessing as an integrated part of
11979 input tokenization and parsing.
11980 If this option is provided, the appropriate language front end
11981 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11982 and Objective-C, respectively) is instead invoked twice,
11983 once for preprocessing only and once for actual compilation
11984 of the preprocessed input.
11985 This option may be useful in conjunction with the @option{-B} or
11986 @option{-wrapper} options to specify an alternate preprocessor or
11987 perform additional processing of the program source between
11988 normal preprocessing and compilation.
11990 @end table
11992 @node Assembler Options
11993 @section Passing Options to the Assembler
11995 @c prevent bad page break with this line
11996 You can pass options to the assembler.
11998 @table @gcctabopt
11999 @item -Wa,@var{option}
12000 @opindex Wa
12001 Pass @var{option} as an option to the assembler.  If @var{option}
12002 contains commas, it is split into multiple options at the commas.
12004 @item -Xassembler @var{option}
12005 @opindex Xassembler
12006 Pass @var{option} as an option to the assembler.  You can use this to
12007 supply system-specific assembler options that GCC does not
12008 recognize.
12010 If you want to pass an option that takes an argument, you must use
12011 @option{-Xassembler} twice, once for the option and once for the argument.
12013 @end table
12015 @node Link Options
12016 @section Options for Linking
12017 @cindex link options
12018 @cindex options, linking
12020 These options come into play when the compiler links object files into
12021 an executable output file.  They are meaningless if the compiler is
12022 not doing a link step.
12024 @table @gcctabopt
12025 @cindex file names
12026 @item @var{object-file-name}
12027 A file name that does not end in a special recognized suffix is
12028 considered to name an object file or library.  (Object files are
12029 distinguished from libraries by the linker according to the file
12030 contents.)  If linking is done, these object files are used as input
12031 to the linker.
12033 @item -c
12034 @itemx -S
12035 @itemx -E
12036 @opindex c
12037 @opindex S
12038 @opindex E
12039 If any of these options is used, then the linker is not run, and
12040 object file names should not be used as arguments.  @xref{Overall
12041 Options}.
12043 @item -fuse-ld=bfd
12044 @opindex fuse-ld=bfd
12045 Use the @command{bfd} linker instead of the default linker.
12047 @item -fuse-ld=gold
12048 @opindex fuse-ld=gold
12049 Use the @command{gold} linker instead of the default linker.
12051 @cindex Libraries
12052 @item -l@var{library}
12053 @itemx -l @var{library}
12054 @opindex l
12055 Search the library named @var{library} when linking.  (The second
12056 alternative with the library as a separate argument is only for
12057 POSIX compliance and is not recommended.)
12059 It makes a difference where in the command you write this option; the
12060 linker searches and processes libraries and object files in the order they
12061 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12062 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12063 to functions in @samp{z}, those functions may not be loaded.
12065 The linker searches a standard list of directories for the library,
12066 which is actually a file named @file{lib@var{library}.a}.  The linker
12067 then uses this file as if it had been specified precisely by name.
12069 The directories searched include several standard system directories
12070 plus any that you specify with @option{-L}.
12072 Normally the files found this way are library files---archive files
12073 whose members are object files.  The linker handles an archive file by
12074 scanning through it for members which define symbols that have so far
12075 been referenced but not defined.  But if the file that is found is an
12076 ordinary object file, it is linked in the usual fashion.  The only
12077 difference between using an @option{-l} option and specifying a file name
12078 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12079 and searches several directories.
12081 @item -lobjc
12082 @opindex lobjc
12083 You need this special case of the @option{-l} option in order to
12084 link an Objective-C or Objective-C++ program.
12086 @item -nostartfiles
12087 @opindex nostartfiles
12088 Do not use the standard system startup files when linking.
12089 The standard system libraries are used normally, unless @option{-nostdlib}
12090 or @option{-nodefaultlibs} is used.
12092 @item -nodefaultlibs
12093 @opindex nodefaultlibs
12094 Do not use the standard system libraries when linking.
12095 Only the libraries you specify are passed to the linker, and options
12096 specifying linkage of the system libraries, such as @option{-static-libgcc}
12097 or @option{-shared-libgcc}, are ignored.  
12098 The standard startup files are used normally, unless @option{-nostartfiles}
12099 is used.  
12101 The compiler may generate calls to @code{memcmp},
12102 @code{memset}, @code{memcpy} and @code{memmove}.
12103 These entries are usually resolved by entries in
12104 libc.  These entry points should be supplied through some other
12105 mechanism when this option is specified.
12107 @item -nostdlib
12108 @opindex nostdlib
12109 Do not use the standard system startup files or libraries when linking.
12110 No startup files and only the libraries you specify are passed to
12111 the linker, and options specifying linkage of the system libraries, such as
12112 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12114 The compiler may generate calls to @code{memcmp}, @code{memset},
12115 @code{memcpy} and @code{memmove}.
12116 These entries are usually resolved by entries in
12117 libc.  These entry points should be supplied through some other
12118 mechanism when this option is specified.
12120 @cindex @option{-lgcc}, use with @option{-nostdlib}
12121 @cindex @option{-nostdlib} and unresolved references
12122 @cindex unresolved references and @option{-nostdlib}
12123 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12124 @cindex @option{-nodefaultlibs} and unresolved references
12125 @cindex unresolved references and @option{-nodefaultlibs}
12126 One of the standard libraries bypassed by @option{-nostdlib} and
12127 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12128 which GCC uses to overcome shortcomings of particular machines, or special
12129 needs for some languages.
12130 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12131 Collection (GCC) Internals},
12132 for more discussion of @file{libgcc.a}.)
12133 In most cases, you need @file{libgcc.a} even when you want to avoid
12134 other standard libraries.  In other words, when you specify @option{-nostdlib}
12135 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12136 This ensures that you have no unresolved references to internal GCC
12137 library subroutines.
12138 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12139 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12140 GNU Compiler Collection (GCC) Internals}.)
12142 @item -pie
12143 @opindex pie
12144 Produce a dynamically linked position independent executable on targets
12145 that support it.  For predictable results, you must also specify the same
12146 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12147 or model suboptions) when you specify this linker option.
12149 @item -no-pie
12150 @opindex no-pie
12151 Don't produce a dynamically linked position independent executable.
12153 @item -static-pie
12154 @opindex static-pie
12155 Produce a static position independent executable on targets that support
12156 it.  A static position independent executable is similar to a static
12157 executable, but can be loaded at any address without a dynamic linker.
12158 For predictable results, you must also specify the same set of options
12159 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12160 suboptions) when you specify this linker option.
12162 @item -pthread
12163 @opindex pthread
12164 Link with the POSIX threads library.  This option is supported on 
12165 GNU/Linux targets, most other Unix derivatives, and also on 
12166 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12167 flags for the preprocessor, so it should be used consistently for both
12168 compilation and linking.
12170 @item -rdynamic
12171 @opindex rdynamic
12172 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12173 that support it. This instructs the linker to add all symbols, not
12174 only used ones, to the dynamic symbol table. This option is needed
12175 for some uses of @code{dlopen} or to allow obtaining backtraces
12176 from within a program.
12178 @item -s
12179 @opindex s
12180 Remove all symbol table and relocation information from the executable.
12182 @item -static
12183 @opindex static
12184 On systems that support dynamic linking, this overrides @option{-pie}
12185 and prevents linking with the shared libraries.  On other systems, this
12186 option has no effect.
12188 @item -shared
12189 @opindex shared
12190 Produce a shared object which can then be linked with other objects to
12191 form an executable.  Not all systems support this option.  For predictable
12192 results, you must also specify the same set of options used for compilation
12193 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12194 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12195 needs to build supplementary stub code for constructors to work.  On
12196 multi-libbed systems, @samp{gcc -shared} must select the correct support
12197 libraries to link against.  Failing to supply the correct flags may lead
12198 to subtle defects.  Supplying them in cases where they are not necessary
12199 is innocuous.}
12201 @item -shared-libgcc
12202 @itemx -static-libgcc
12203 @opindex shared-libgcc
12204 @opindex static-libgcc
12205 On systems that provide @file{libgcc} as a shared library, these options
12206 force the use of either the shared or static version, respectively.
12207 If no shared version of @file{libgcc} was built when the compiler was
12208 configured, these options have no effect.
12210 There are several situations in which an application should use the
12211 shared @file{libgcc} instead of the static version.  The most common
12212 of these is when the application wishes to throw and catch exceptions
12213 across different shared libraries.  In that case, each of the libraries
12214 as well as the application itself should use the shared @file{libgcc}.
12216 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12217  whenever you build a shared library or a main executable, because C++
12218  programs typically use exceptions, so this is the right thing to do.
12220 If, instead, you use the GCC driver to create shared libraries, you may
12221 find that they are not always linked with the shared @file{libgcc}.
12222 If GCC finds, at its configuration time, that you have a non-GNU linker
12223 or a GNU linker that does not support option @option{--eh-frame-hdr},
12224 it links the shared version of @file{libgcc} into shared libraries
12225 by default.  Otherwise, it takes advantage of the linker and optimizes
12226 away the linking with the shared version of @file{libgcc}, linking with
12227 the static version of libgcc by default.  This allows exceptions to
12228 propagate through such shared libraries, without incurring relocation
12229 costs at library load time.
12231 However, if a library or main executable is supposed to throw or catch
12232 exceptions, you must link it using the G++ driver, as appropriate
12233 for the languages used in the program, or using the option
12234 @option{-shared-libgcc}, such that it is linked with the shared
12235 @file{libgcc}.
12237 @item -static-libasan
12238 @opindex static-libasan
12239 When the @option{-fsanitize=address} option is used to link a program,
12240 the GCC driver automatically links against @option{libasan}.  If
12241 @file{libasan} is available as a shared library, and the @option{-static}
12242 option is not used, then this links against the shared version of
12243 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12244 driver to link @file{libasan} statically, without necessarily linking
12245 other libraries statically.
12247 @item -static-libtsan
12248 @opindex static-libtsan
12249 When the @option{-fsanitize=thread} option is used to link a program,
12250 the GCC driver automatically links against @option{libtsan}.  If
12251 @file{libtsan} is available as a shared library, and the @option{-static}
12252 option is not used, then this links against the shared version of
12253 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12254 driver to link @file{libtsan} statically, without necessarily linking
12255 other libraries statically.
12257 @item -static-liblsan
12258 @opindex static-liblsan
12259 When the @option{-fsanitize=leak} option is used to link a program,
12260 the GCC driver automatically links against @option{liblsan}.  If
12261 @file{liblsan} is available as a shared library, and the @option{-static}
12262 option is not used, then this links against the shared version of
12263 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12264 driver to link @file{liblsan} statically, without necessarily linking
12265 other libraries statically.
12267 @item -static-libubsan
12268 @opindex static-libubsan
12269 When the @option{-fsanitize=undefined} option is used to link a program,
12270 the GCC driver automatically links against @option{libubsan}.  If
12271 @file{libubsan} is available as a shared library, and the @option{-static}
12272 option is not used, then this links against the shared version of
12273 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12274 driver to link @file{libubsan} statically, without necessarily linking
12275 other libraries statically.
12277 @item -static-libmpx
12278 @opindex static-libmpx
12279 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12280 used to link a program, the GCC driver automatically links against
12281 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12282 and the @option{-static} option is not used, then this links against
12283 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12284 option directs the GCC driver to link @file{libmpx} statically,
12285 without necessarily linking other libraries statically.
12287 @item -static-libmpxwrappers
12288 @opindex static-libmpxwrappers
12289 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12290 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12291 GCC driver automatically links against @file{libmpxwrappers}.  If
12292 @file{libmpxwrappers} is available as a shared library, and the
12293 @option{-static} option is not used, then this links against the shared
12294 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12295 option directs the GCC driver to link @file{libmpxwrappers} statically,
12296 without necessarily linking other libraries statically.
12298 @item -static-libstdc++
12299 @opindex static-libstdc++
12300 When the @command{g++} program is used to link a C++ program, it
12301 normally automatically links against @option{libstdc++}.  If
12302 @file{libstdc++} is available as a shared library, and the
12303 @option{-static} option is not used, then this links against the
12304 shared version of @file{libstdc++}.  That is normally fine.  However, it
12305 is sometimes useful to freeze the version of @file{libstdc++} used by
12306 the program without going all the way to a fully static link.  The
12307 @option{-static-libstdc++} option directs the @command{g++} driver to
12308 link @file{libstdc++} statically, without necessarily linking other
12309 libraries statically.
12311 @item -symbolic
12312 @opindex symbolic
12313 Bind references to global symbols when building a shared object.  Warn
12314 about any unresolved references (unless overridden by the link editor
12315 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12316 this option.
12318 @item -T @var{script}
12319 @opindex T
12320 @cindex linker script
12321 Use @var{script} as the linker script.  This option is supported by most
12322 systems using the GNU linker.  On some targets, such as bare-board
12323 targets without an operating system, the @option{-T} option may be required
12324 when linking to avoid references to undefined symbols.
12326 @item -Xlinker @var{option}
12327 @opindex Xlinker
12328 Pass @var{option} as an option to the linker.  You can use this to
12329 supply system-specific linker options that GCC does not recognize.
12331 If you want to pass an option that takes a separate argument, you must use
12332 @option{-Xlinker} twice, once for the option and once for the argument.
12333 For example, to pass @option{-assert definitions}, you must write
12334 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12335 @option{-Xlinker "-assert definitions"}, because this passes the entire
12336 string as a single argument, which is not what the linker expects.
12338 When using the GNU linker, it is usually more convenient to pass
12339 arguments to linker options using the @option{@var{option}=@var{value}}
12340 syntax than as separate arguments.  For example, you can specify
12341 @option{-Xlinker -Map=output.map} rather than
12342 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12343 this syntax for command-line options.
12345 @item -Wl,@var{option}
12346 @opindex Wl
12347 Pass @var{option} as an option to the linker.  If @var{option} contains
12348 commas, it is split into multiple options at the commas.  You can use this
12349 syntax to pass an argument to the option.
12350 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12351 linker.  When using the GNU linker, you can also get the same effect with
12352 @option{-Wl,-Map=output.map}.
12354 @item -u @var{symbol}
12355 @opindex u
12356 Pretend the symbol @var{symbol} is undefined, to force linking of
12357 library modules to define it.  You can use @option{-u} multiple times with
12358 different symbols to force loading of additional library modules.
12360 @item -z @var{keyword}
12361 @opindex z
12362 @option{-z} is passed directly on to the linker along with the keyword
12363 @var{keyword}. See the section in the documentation of your linker for
12364 permitted values and their meanings.
12365 @end table
12367 @node Directory Options
12368 @section Options for Directory Search
12369 @cindex directory options
12370 @cindex options, directory search
12371 @cindex search path
12373 These options specify directories to search for header files, for
12374 libraries and for parts of the compiler:
12376 @table @gcctabopt
12377 @include cppdiropts.texi
12379 @item -iplugindir=@var{dir}
12380 @opindex iplugindir=
12381 Set the directory to search for plugins that are passed
12382 by @option{-fplugin=@var{name}} instead of
12383 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12384 to be used by the user, but only passed by the driver.
12386 @item -L@var{dir}
12387 @opindex L
12388 Add directory @var{dir} to the list of directories to be searched
12389 for @option{-l}.
12391 @item -B@var{prefix}
12392 @opindex B
12393 This option specifies where to find the executables, libraries,
12394 include files, and data files of the compiler itself.
12396 The compiler driver program runs one or more of the subprograms
12397 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12398 @var{prefix} as a prefix for each program it tries to run, both with and
12399 without @samp{@var{machine}/@var{version}/} for the corresponding target
12400 machine and compiler version.
12402 For each subprogram to be run, the compiler driver first tries the
12403 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12404 is not specified, the driver tries two standard prefixes, 
12405 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12406 those results in a file name that is found, the unmodified program
12407 name is searched for using the directories specified in your
12408 @env{PATH} environment variable.
12410 The compiler checks to see if the path provided by @option{-B}
12411 refers to a directory, and if necessary it adds a directory
12412 separator character at the end of the path.
12414 @option{-B} prefixes that effectively specify directory names also apply
12415 to libraries in the linker, because the compiler translates these
12416 options into @option{-L} options for the linker.  They also apply to
12417 include files in the preprocessor, because the compiler translates these
12418 options into @option{-isystem} options for the preprocessor.  In this case,
12419 the compiler appends @samp{include} to the prefix.
12421 The runtime support file @file{libgcc.a} can also be searched for using
12422 the @option{-B} prefix, if needed.  If it is not found there, the two
12423 standard prefixes above are tried, and that is all.  The file is left
12424 out of the link if it is not found by those means.
12426 Another way to specify a prefix much like the @option{-B} prefix is to use
12427 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12428 Variables}.
12430 As a special kludge, if the path provided by @option{-B} is
12431 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12432 9, then it is replaced by @file{[dir/]include}.  This is to help
12433 with boot-strapping the compiler.
12435 @item -no-canonical-prefixes
12436 @opindex no-canonical-prefixes
12437 Do not expand any symbolic links, resolve references to @samp{/../}
12438 or @samp{/./}, or make the path absolute when generating a relative
12439 prefix.
12441 @item --sysroot=@var{dir}
12442 @opindex sysroot
12443 Use @var{dir} as the logical root directory for headers and libraries.
12444 For example, if the compiler normally searches for headers in
12445 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12446 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12448 If you use both this option and the @option{-isysroot} option, then
12449 the @option{--sysroot} option applies to libraries, but the
12450 @option{-isysroot} option applies to header files.
12452 The GNU linker (beginning with version 2.16) has the necessary support
12453 for this option.  If your linker does not support this option, the
12454 header file aspect of @option{--sysroot} still works, but the
12455 library aspect does not.
12457 @item --no-sysroot-suffix
12458 @opindex no-sysroot-suffix
12459 For some targets, a suffix is added to the root directory specified
12460 with @option{--sysroot}, depending on the other options used, so that
12461 headers may for example be found in
12462 @file{@var{dir}/@var{suffix}/usr/include} instead of
12463 @file{@var{dir}/usr/include}.  This option disables the addition of
12464 such a suffix.
12466 @end table
12468 @node Code Gen Options
12469 @section Options for Code Generation Conventions
12470 @cindex code generation conventions
12471 @cindex options, code generation
12472 @cindex run-time options
12474 These machine-independent options control the interface conventions
12475 used in code generation.
12477 Most of them have both positive and negative forms; the negative form
12478 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12479 one of the forms is listed---the one that is not the default.  You
12480 can figure out the other form by either removing @samp{no-} or adding
12483 @table @gcctabopt
12484 @item -fstack-reuse=@var{reuse-level}
12485 @opindex fstack_reuse
12486 This option controls stack space reuse for user declared local/auto variables
12487 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12488 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12489 local variables and temporaries, @samp{named_vars} enables the reuse only for
12490 user defined local variables with names, and @samp{none} disables stack reuse
12491 completely. The default value is @samp{all}. The option is needed when the
12492 program extends the lifetime of a scoped local variable or a compiler generated
12493 temporary beyond the end point defined by the language.  When a lifetime of
12494 a variable ends, and if the variable lives in memory, the optimizing compiler
12495 has the freedom to reuse its stack space with other temporaries or scoped
12496 local variables whose live range does not overlap with it. Legacy code extending
12497 local lifetime is likely to break with the stack reuse optimization.
12499 For example,
12501 @smallexample
12502    int *p;
12503    @{
12504      int local1;
12506      p = &local1;
12507      local1 = 10;
12508      ....
12509    @}
12510    @{
12511       int local2;
12512       local2 = 20;
12513       ...
12514    @}
12516    if (*p == 10)  // out of scope use of local1
12517      @{
12519      @}
12520 @end smallexample
12522 Another example:
12523 @smallexample
12525    struct A
12526    @{
12527        A(int k) : i(k), j(k) @{ @}
12528        int i;
12529        int j;
12530    @};
12532    A *ap;
12534    void foo(const A& ar)
12535    @{
12536       ap = &ar;
12537    @}
12539    void bar()
12540    @{
12541       foo(A(10)); // temp object's lifetime ends when foo returns
12543       @{
12544         A a(20);
12545         ....
12546       @}
12547       ap->i+= 10;  // ap references out of scope temp whose space
12548                    // is reused with a. What is the value of ap->i?
12549    @}
12551 @end smallexample
12553 The lifetime of a compiler generated temporary is well defined by the C++
12554 standard. When a lifetime of a temporary ends, and if the temporary lives
12555 in memory, the optimizing compiler has the freedom to reuse its stack
12556 space with other temporaries or scoped local variables whose live range
12557 does not overlap with it. However some of the legacy code relies on
12558 the behavior of older compilers in which temporaries' stack space is
12559 not reused, the aggressive stack reuse can lead to runtime errors. This
12560 option is used to control the temporary stack reuse optimization.
12562 @item -ftrapv
12563 @opindex ftrapv
12564 This option generates traps for signed overflow on addition, subtraction,
12565 multiplication operations.
12566 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12567 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12568 @option{-fwrapv} being effective.  Note that only active options override, so
12569 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12570 results in @option{-ftrapv} being effective.
12572 @item -fwrapv
12573 @opindex fwrapv
12574 This option instructs the compiler to assume that signed arithmetic
12575 overflow of addition, subtraction and multiplication wraps around
12576 using twos-complement representation.  This flag enables some optimizations
12577 and disables others.
12578 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12579 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12580 @option{-fwrapv} being effective.  Note that only active options override, so
12581 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12582 results in @option{-ftrapv} being effective.
12584 @item -fwrapv-pointer
12585 @opindex fwrapv-pointer
12586 This option instructs the compiler to assume that pointer arithmetic
12587 overflow on addition and subtraction wraps around using twos-complement
12588 representation.  This flag disables some optimizations which assume
12589 pointer overflow is invalid.
12591 @item -fstrict-overflow
12592 @opindex fstrict-overflow
12593 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12594 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12596 @item -fexceptions
12597 @opindex fexceptions
12598 Enable exception handling.  Generates extra code needed to propagate
12599 exceptions.  For some targets, this implies GCC generates frame
12600 unwind information for all functions, which can produce significant data
12601 size overhead, although it does not affect execution.  If you do not
12602 specify this option, GCC enables it by default for languages like
12603 C++ that normally require exception handling, and disables it for
12604 languages like C that do not normally require it.  However, you may need
12605 to enable this option when compiling C code that needs to interoperate
12606 properly with exception handlers written in C++.  You may also wish to
12607 disable this option if you are compiling older C++ programs that don't
12608 use exception handling.
12610 @item -fnon-call-exceptions
12611 @opindex fnon-call-exceptions
12612 Generate code that allows trapping instructions to throw exceptions.
12613 Note that this requires platform-specific runtime support that does
12614 not exist everywhere.  Moreover, it only allows @emph{trapping}
12615 instructions to throw exceptions, i.e.@: memory references or floating-point
12616 instructions.  It does not allow exceptions to be thrown from
12617 arbitrary signal handlers such as @code{SIGALRM}.
12619 @item -fdelete-dead-exceptions
12620 @opindex fdelete-dead-exceptions
12621 Consider that instructions that may throw exceptions but don't otherwise
12622 contribute to the execution of the program can be optimized away.
12623 This option is enabled by default for the Ada front end, as permitted by
12624 the Ada language specification.
12625 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12627 @item -funwind-tables
12628 @opindex funwind-tables
12629 Similar to @option{-fexceptions}, except that it just generates any needed
12630 static data, but does not affect the generated code in any other way.
12631 You normally do not need to enable this option; instead, a language processor
12632 that needs this handling enables it on your behalf.
12634 @item -fasynchronous-unwind-tables
12635 @opindex fasynchronous-unwind-tables
12636 Generate unwind table in DWARF format, if supported by target machine.  The
12637 table is exact at each instruction boundary, so it can be used for stack
12638 unwinding from asynchronous events (such as debugger or garbage collector).
12640 @item -fno-gnu-unique
12641 @opindex fno-gnu-unique
12642 On systems with recent GNU assembler and C library, the C++ compiler
12643 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12644 of template static data members and static local variables in inline
12645 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12646 is necessary to avoid problems with a library used by two different
12647 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12648 therefore disagreeing with the other one about the binding of the
12649 symbol.  But this causes @code{dlclose} to be ignored for affected
12650 DSOs; if your program relies on reinitialization of a DSO via
12651 @code{dlclose} and @code{dlopen}, you can use
12652 @option{-fno-gnu-unique}.
12654 @item -fpcc-struct-return
12655 @opindex fpcc-struct-return
12656 Return ``short'' @code{struct} and @code{union} values in memory like
12657 longer ones, rather than in registers.  This convention is less
12658 efficient, but it has the advantage of allowing intercallability between
12659 GCC-compiled files and files compiled with other compilers, particularly
12660 the Portable C Compiler (pcc).
12662 The precise convention for returning structures in memory depends
12663 on the target configuration macros.
12665 Short structures and unions are those whose size and alignment match
12666 that of some integer type.
12668 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12669 switch is not binary compatible with code compiled with the
12670 @option{-freg-struct-return} switch.
12671 Use it to conform to a non-default application binary interface.
12673 @item -freg-struct-return
12674 @opindex freg-struct-return
12675 Return @code{struct} and @code{union} values in registers when possible.
12676 This is more efficient for small structures than
12677 @option{-fpcc-struct-return}.
12679 If you specify neither @option{-fpcc-struct-return} nor
12680 @option{-freg-struct-return}, GCC defaults to whichever convention is
12681 standard for the target.  If there is no standard convention, GCC
12682 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12683 the principal compiler.  In those cases, we can choose the standard, and
12684 we chose the more efficient register return alternative.
12686 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12687 switch is not binary compatible with code compiled with the
12688 @option{-fpcc-struct-return} switch.
12689 Use it to conform to a non-default application binary interface.
12691 @item -fshort-enums
12692 @opindex fshort-enums
12693 Allocate to an @code{enum} type only as many bytes as it needs for the
12694 declared range of possible values.  Specifically, the @code{enum} type
12695 is equivalent to the smallest integer type that has enough room.
12697 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12698 code that is not binary compatible with code generated without that switch.
12699 Use it to conform to a non-default application binary interface.
12701 @item -fshort-wchar
12702 @opindex fshort-wchar
12703 Override the underlying type for @code{wchar_t} to be @code{short
12704 unsigned int} instead of the default for the target.  This option is
12705 useful for building programs to run under WINE@.
12707 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12708 code that is not binary compatible with code generated without that switch.
12709 Use it to conform to a non-default application binary interface.
12711 @item -fno-common
12712 @opindex fno-common
12713 @cindex tentative definitions
12714 In C code, this option controls the placement of global variables 
12715 defined without an initializer, known as @dfn{tentative definitions} 
12716 in the C standard.  Tentative definitions are distinct from declarations 
12717 of a variable with the @code{extern} keyword, which do not allocate storage.
12719 Unix C compilers have traditionally allocated storage for
12720 uninitialized global variables in a common block.  This allows the
12721 linker to resolve all tentative definitions of the same variable
12722 in different compilation units to the same object, or to a non-tentative
12723 definition.  
12724 This is the behavior specified by @option{-fcommon}, and is the default for 
12725 GCC on most targets.  
12726 On the other hand, this behavior is not required by ISO
12727 C, and on some targets may carry a speed or code size penalty on
12728 variable references.
12730 The @option{-fno-common} option specifies that the compiler should instead
12731 place uninitialized global variables in the data section of the object file.
12732 This inhibits the merging of tentative definitions by the linker so
12733 you get a multiple-definition error if the same 
12734 variable is defined in more than one compilation unit.
12735 Compiling with @option{-fno-common} is useful on targets for which
12736 it provides better performance, or if you wish to verify that the
12737 program will work on other systems that always treat uninitialized
12738 variable definitions this way.
12740 @item -fno-ident
12741 @opindex fno-ident
12742 Ignore the @code{#ident} directive.
12744 @item -finhibit-size-directive
12745 @opindex finhibit-size-directive
12746 Don't output a @code{.size} assembler directive, or anything else that
12747 would cause trouble if the function is split in the middle, and the
12748 two halves are placed at locations far apart in memory.  This option is
12749 used when compiling @file{crtstuff.c}; you should not need to use it
12750 for anything else.
12752 @item -fverbose-asm
12753 @opindex fverbose-asm
12754 Put extra commentary information in the generated assembly code to
12755 make it more readable.  This option is generally only of use to those
12756 who actually need to read the generated assembly code (perhaps while
12757 debugging the compiler itself).
12759 @option{-fno-verbose-asm}, the default, causes the
12760 extra information to be omitted and is useful when comparing two assembler
12761 files.
12763 The added comments include:
12765 @itemize @bullet
12767 @item
12768 information on the compiler version and command-line options,
12770 @item
12771 the source code lines associated with the assembly instructions,
12772 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12774 @item
12775 hints on which high-level expressions correspond to
12776 the various assembly instruction operands.
12778 @end itemize
12780 For example, given this C source file:
12782 @smallexample
12783 int test (int n)
12785   int i;
12786   int total = 0;
12788   for (i = 0; i < n; i++)
12789     total += i * i;
12791   return total;
12793 @end smallexample
12795 compiling to (x86_64) assembly via @option{-S} and emitting the result
12796 direct to stdout via @option{-o} @option{-}
12798 @smallexample
12799 gcc -S test.c -fverbose-asm -Os -o -
12800 @end smallexample
12802 gives output similar to this:
12804 @smallexample
12805         .file   "test.c"
12806 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12807   [...snip...]
12808 # options passed:
12809   [...snip...]
12811         .text
12812         .globl  test
12813         .type   test, @@function
12814 test:
12815 .LFB0:
12816         .cfi_startproc
12817 # test.c:4:   int total = 0;
12818         xorl    %eax, %eax      # <retval>
12819 # test.c:6:   for (i = 0; i < n; i++)
12820         xorl    %edx, %edx      # i
12821 .L2:
12822 # test.c:6:   for (i = 0; i < n; i++)
12823         cmpl    %edi, %edx      # n, i
12824         jge     .L5     #,
12825 # test.c:7:     total += i * i;
12826         movl    %edx, %ecx      # i, tmp92
12827         imull   %edx, %ecx      # i, tmp92
12828 # test.c:6:   for (i = 0; i < n; i++)
12829         incl    %edx    # i
12830 # test.c:7:     total += i * i;
12831         addl    %ecx, %eax      # tmp92, <retval>
12832         jmp     .L2     #
12833 .L5:
12834 # test.c:10: @}
12835         ret
12836         .cfi_endproc
12837 .LFE0:
12838         .size   test, .-test
12839         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12840         .section        .note.GNU-stack,"",@@progbits
12841 @end smallexample
12843 The comments are intended for humans rather than machines and hence the
12844 precise format of the comments is subject to change.
12846 @item -frecord-gcc-switches
12847 @opindex frecord-gcc-switches
12848 This switch causes the command line used to invoke the
12849 compiler to be recorded into the object file that is being created.
12850 This switch is only implemented on some targets and the exact format
12851 of the recording is target and binary file format dependent, but it
12852 usually takes the form of a section containing ASCII text.  This
12853 switch is related to the @option{-fverbose-asm} switch, but that
12854 switch only records information in the assembler output file as
12855 comments, so it never reaches the object file.
12856 See also @option{-grecord-gcc-switches} for another
12857 way of storing compiler options into the object file.
12859 @item -fpic
12860 @opindex fpic
12861 @cindex global offset table
12862 @cindex PIC
12863 Generate position-independent code (PIC) suitable for use in a shared
12864 library, if supported for the target machine.  Such code accesses all
12865 constant addresses through a global offset table (GOT)@.  The dynamic
12866 loader resolves the GOT entries when the program starts (the dynamic
12867 loader is not part of GCC; it is part of the operating system).  If
12868 the GOT size for the linked executable exceeds a machine-specific
12869 maximum size, you get an error message from the linker indicating that
12870 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12871 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12872 on the m68k and RS/6000.  The x86 has no such limit.)
12874 Position-independent code requires special support, and therefore works
12875 only on certain machines.  For the x86, GCC supports PIC for System V
12876 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12877 position-independent.
12879 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12880 are defined to 1.
12882 @item -fPIC
12883 @opindex fPIC
12884 If supported for the target machine, emit position-independent code,
12885 suitable for dynamic linking and avoiding any limit on the size of the
12886 global offset table.  This option makes a difference on AArch64, m68k,
12887 PowerPC and SPARC@.
12889 Position-independent code requires special support, and therefore works
12890 only on certain machines.
12892 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12893 are defined to 2.
12895 @item -fpie
12896 @itemx -fPIE
12897 @opindex fpie
12898 @opindex fPIE
12899 These options are similar to @option{-fpic} and @option{-fPIC}, but
12900 generated position independent code can be only linked into executables.
12901 Usually these options are used when @option{-pie} GCC option is
12902 used during linking.
12904 @option{-fpie} and @option{-fPIE} both define the macros
12905 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12906 for @option{-fpie} and 2 for @option{-fPIE}.
12908 @item -fno-plt
12909 @opindex fno-plt
12910 Do not use the PLT for external function calls in position-independent code.
12911 Instead, load the callee address at call sites from the GOT and branch to it.
12912 This leads to more efficient code by eliminating PLT stubs and exposing
12913 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12914 PLT stubs expect the GOT pointer in a specific register, this gives more
12915 register allocation freedom to the compiler.
12916 Lazy binding requires use of the PLT; 
12917 with @option{-fno-plt} all external symbols are resolved at load time.
12919 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12920 through the PLT for specific external functions.
12922 In position-dependent code, a few targets also convert calls to
12923 functions that are marked to not use the PLT to use the GOT instead.
12925 @item -fno-jump-tables
12926 @opindex fno-jump-tables
12927 Do not use jump tables for switch statements even where it would be
12928 more efficient than other code generation strategies.  This option is
12929 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12930 building code that forms part of a dynamic linker and cannot
12931 reference the address of a jump table.  On some targets, jump tables
12932 do not require a GOT and this option is not needed.
12934 @item -ffixed-@var{reg}
12935 @opindex ffixed
12936 Treat the register named @var{reg} as a fixed register; generated code
12937 should never refer to it (except perhaps as a stack pointer, frame
12938 pointer or in some other fixed role).
12940 @var{reg} must be the name of a register.  The register names accepted
12941 are machine-specific and are defined in the @code{REGISTER_NAMES}
12942 macro in the machine description macro file.
12944 This flag does not have a negative form, because it specifies a
12945 three-way choice.
12947 @item -fcall-used-@var{reg}
12948 @opindex fcall-used
12949 Treat the register named @var{reg} as an allocable register that is
12950 clobbered by function calls.  It may be allocated for temporaries or
12951 variables that do not live across a call.  Functions compiled this way
12952 do not save and restore the register @var{reg}.
12954 It is an error to use this flag with the frame pointer or stack pointer.
12955 Use of this flag for other registers that have fixed pervasive roles in
12956 the machine's execution model produces disastrous results.
12958 This flag does not have a negative form, because it specifies a
12959 three-way choice.
12961 @item -fcall-saved-@var{reg}
12962 @opindex fcall-saved
12963 Treat the register named @var{reg} as an allocable register saved by
12964 functions.  It may be allocated even for temporaries or variables that
12965 live across a call.  Functions compiled this way save and restore
12966 the register @var{reg} if they use it.
12968 It is an error to use this flag with the frame pointer or stack pointer.
12969 Use of this flag for other registers that have fixed pervasive roles in
12970 the machine's execution model produces disastrous results.
12972 A different sort of disaster results from the use of this flag for
12973 a register in which function values may be returned.
12975 This flag does not have a negative form, because it specifies a
12976 three-way choice.
12978 @item -fpack-struct[=@var{n}]
12979 @opindex fpack-struct
12980 Without a value specified, pack all structure members together without
12981 holes.  When a value is specified (which must be a small power of two), pack
12982 structure members according to this value, representing the maximum
12983 alignment (that is, objects with default alignment requirements larger than
12984 this are output potentially unaligned at the next fitting location.
12986 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12987 code that is not binary compatible with code generated without that switch.
12988 Additionally, it makes the code suboptimal.
12989 Use it to conform to a non-default application binary interface.
12991 @item -fleading-underscore
12992 @opindex fleading-underscore
12993 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12994 change the way C symbols are represented in the object file.  One use
12995 is to help link with legacy assembly code.
12997 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12998 generate code that is not binary compatible with code generated without that
12999 switch.  Use it to conform to a non-default application binary interface.
13000 Not all targets provide complete support for this switch.
13002 @item -ftls-model=@var{model}
13003 @opindex ftls-model
13004 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13005 The @var{model} argument should be one of @samp{global-dynamic},
13006 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13007 Note that the choice is subject to optimization: the compiler may use
13008 a more efficient model for symbols not visible outside of the translation
13009 unit, or if @option{-fpic} is not given on the command line.
13011 The default without @option{-fpic} is @samp{initial-exec}; with
13012 @option{-fpic} the default is @samp{global-dynamic}.
13014 @item -ftrampolines
13015 @opindex ftrampolines
13016 For targets that normally need trampolines for nested functions, always
13017 generate them instead of using descriptors.  Otherwise, for targets that
13018 do not need them, like for example HP-PA or IA-64, do nothing.
13020 A trampoline is a small piece of code that is created at run time on the
13021 stack when the address of a nested function is taken, and is used to call
13022 the nested function indirectly.  Therefore, it requires the stack to be
13023 made executable in order for the program to work properly.
13025 @option{-fno-trampolines} is enabled by default on a language by language
13026 basis to let the compiler avoid generating them, if it computes that this
13027 is safe, and replace them with descriptors.  Descriptors are made up of data
13028 only, but the generated code must be prepared to deal with them.  As of this
13029 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13031 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13032 @option{-fno-trampolines} are not binary compatible if nested functions are
13033 present.  This option must therefore be used on a program-wide basis and be
13034 manipulated with extreme care.
13036 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13037 @opindex fvisibility
13038 Set the default ELF image symbol visibility to the specified option---all
13039 symbols are marked with this unless overridden within the code.
13040 Using this feature can very substantially improve linking and
13041 load times of shared object libraries, produce more optimized
13042 code, provide near-perfect API export and prevent symbol clashes.
13043 It is @strong{strongly} recommended that you use this in any shared objects
13044 you distribute.
13046 Despite the nomenclature, @samp{default} always means public; i.e.,
13047 available to be linked against from outside the shared object.
13048 @samp{protected} and @samp{internal} are pretty useless in real-world
13049 usage so the only other commonly used option is @samp{hidden}.
13050 The default if @option{-fvisibility} isn't specified is
13051 @samp{default}, i.e., make every symbol public.
13053 A good explanation of the benefits offered by ensuring ELF
13054 symbols have the correct visibility is given by ``How To Write
13055 Shared Libraries'' by Ulrich Drepper (which can be found at
13056 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13057 solution made possible by this option to marking things hidden when
13058 the default is public is to make the default hidden and mark things
13059 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13060 and @code{__attribute__ ((visibility("default")))} instead of
13061 @code{__declspec(dllexport)} you get almost identical semantics with
13062 identical syntax.  This is a great boon to those working with
13063 cross-platform projects.
13065 For those adding visibility support to existing code, you may find
13066 @code{#pragma GCC visibility} of use.  This works by you enclosing
13067 the declarations you wish to set visibility for with (for example)
13068 @code{#pragma GCC visibility push(hidden)} and
13069 @code{#pragma GCC visibility pop}.
13070 Bear in mind that symbol visibility should be viewed @strong{as
13071 part of the API interface contract} and thus all new code should
13072 always specify visibility when it is not the default; i.e., declarations
13073 only for use within the local DSO should @strong{always} be marked explicitly
13074 as hidden as so to avoid PLT indirection overheads---making this
13075 abundantly clear also aids readability and self-documentation of the code.
13076 Note that due to ISO C++ specification requirements, @code{operator new} and
13077 @code{operator delete} must always be of default visibility.
13079 Be aware that headers from outside your project, in particular system
13080 headers and headers from any other library you use, may not be
13081 expecting to be compiled with visibility other than the default.  You
13082 may need to explicitly say @code{#pragma GCC visibility push(default)}
13083 before including any such headers.
13085 @code{extern} declarations are not affected by @option{-fvisibility}, so
13086 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13087 no modifications.  However, this means that calls to @code{extern}
13088 functions with no explicit visibility use the PLT, so it is more
13089 effective to use @code{__attribute ((visibility))} and/or
13090 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13091 declarations should be treated as hidden.
13093 Note that @option{-fvisibility} does affect C++ vague linkage
13094 entities. This means that, for instance, an exception class that is
13095 be thrown between DSOs must be explicitly marked with default
13096 visibility so that the @samp{type_info} nodes are unified between
13097 the DSOs.
13099 An overview of these techniques, their benefits and how to use them
13100 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13102 @item -fstrict-volatile-bitfields
13103 @opindex fstrict-volatile-bitfields
13104 This option should be used if accesses to volatile bit-fields (or other
13105 structure fields, although the compiler usually honors those types
13106 anyway) should use a single access of the width of the
13107 field's type, aligned to a natural alignment if possible.  For
13108 example, targets with memory-mapped peripheral registers might require
13109 all such accesses to be 16 bits wide; with this flag you can
13110 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13111 is 16 bits on these targets) to force GCC to use 16-bit accesses
13112 instead of, perhaps, a more efficient 32-bit access.
13114 If this option is disabled, the compiler uses the most efficient
13115 instruction.  In the previous example, that might be a 32-bit load
13116 instruction, even though that accesses bytes that do not contain
13117 any portion of the bit-field, or memory-mapped registers unrelated to
13118 the one being updated.
13120 In some cases, such as when the @code{packed} attribute is applied to a 
13121 structure field, it may not be possible to access the field with a single
13122 read or write that is correctly aligned for the target machine.  In this
13123 case GCC falls back to generating multiple accesses rather than code that 
13124 will fault or truncate the result at run time.
13126 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13127 not allowed to touch non bit-field members.  It is therefore recommended
13128 to define all bits of the field's type as bit-field members.
13130 The default value of this option is determined by the application binary
13131 interface for the target processor.
13133 @item -fsync-libcalls
13134 @opindex fsync-libcalls
13135 This option controls whether any out-of-line instance of the @code{__sync}
13136 family of functions may be used to implement the C++11 @code{__atomic}
13137 family of functions.
13139 The default value of this option is enabled, thus the only useful form
13140 of the option is @option{-fno-sync-libcalls}.  This option is used in
13141 the implementation of the @file{libatomic} runtime library.
13143 @end table
13145 @node Developer Options
13146 @section GCC Developer Options
13147 @cindex developer options
13148 @cindex debugging GCC
13149 @cindex debug dump options
13150 @cindex dump options
13151 @cindex compilation statistics
13153 This section describes command-line options that are primarily of
13154 interest to GCC developers, including options to support compiler
13155 testing and investigation of compiler bugs and compile-time
13156 performance problems.  This includes options that produce debug dumps
13157 at various points in the compilation; that print statistics such as
13158 memory use and execution time; and that print information about GCC's
13159 configuration, such as where it searches for libraries.  You should
13160 rarely need to use any of these options for ordinary compilation and
13161 linking tasks.
13163 @table @gcctabopt
13165 @item -d@var{letters}
13166 @itemx -fdump-rtl-@var{pass}
13167 @itemx -fdump-rtl-@var{pass}=@var{filename}
13168 @opindex d
13169 @opindex fdump-rtl-@var{pass}
13170 Says to make debugging dumps during compilation at times specified by
13171 @var{letters}.  This is used for debugging the RTL-based passes of the
13172 compiler.  The file names for most of the dumps are made by appending
13173 a pass number and a word to the @var{dumpname}, and the files are
13174 created in the directory of the output file.  In case of
13175 @option{=@var{filename}} option, the dump is output on the given file
13176 instead of the pass numbered dump files.  Note that the pass number is
13177 assigned as passes are registered into the pass manager.  Most passes
13178 are registered in the order that they will execute and for these passes
13179 the number corresponds to the pass execution order.  However, passes
13180 registered by plugins, passes specific to compilation targets, or
13181 passes that are otherwise registered after all the other passes are
13182 numbered higher than a pass named "final", even if they are executed
13183 earlier.  @var{dumpname} is generated from the name of the output
13184 file if explicitly specified and not an executable, otherwise it is
13185 the basename of the source file.  
13187 Some @option{-d@var{letters}} switches have different meaning when
13188 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13189 for information about preprocessor-specific dump options.
13191 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13192 @option{-d} option @var{letters}.  Here are the possible
13193 letters for use in @var{pass} and @var{letters}, and their meanings:
13195 @table @gcctabopt
13197 @item -fdump-rtl-alignments
13198 @opindex fdump-rtl-alignments
13199 Dump after branch alignments have been computed.
13201 @item -fdump-rtl-asmcons
13202 @opindex fdump-rtl-asmcons
13203 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13205 @item -fdump-rtl-auto_inc_dec
13206 @opindex fdump-rtl-auto_inc_dec
13207 Dump after auto-inc-dec discovery.  This pass is only run on
13208 architectures that have auto inc or auto dec instructions.
13210 @item -fdump-rtl-barriers
13211 @opindex fdump-rtl-barriers
13212 Dump after cleaning up the barrier instructions.
13214 @item -fdump-rtl-bbpart
13215 @opindex fdump-rtl-bbpart
13216 Dump after partitioning hot and cold basic blocks.
13218 @item -fdump-rtl-bbro
13219 @opindex fdump-rtl-bbro
13220 Dump after block reordering.
13222 @item -fdump-rtl-btl1
13223 @itemx -fdump-rtl-btl2
13224 @opindex fdump-rtl-btl2
13225 @opindex fdump-rtl-btl2
13226 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13227 after the two branch
13228 target load optimization passes.
13230 @item -fdump-rtl-bypass
13231 @opindex fdump-rtl-bypass
13232 Dump after jump bypassing and control flow optimizations.
13234 @item -fdump-rtl-combine
13235 @opindex fdump-rtl-combine
13236 Dump after the RTL instruction combination pass.
13238 @item -fdump-rtl-compgotos
13239 @opindex fdump-rtl-compgotos
13240 Dump after duplicating the computed gotos.
13242 @item -fdump-rtl-ce1
13243 @itemx -fdump-rtl-ce2
13244 @itemx -fdump-rtl-ce3
13245 @opindex fdump-rtl-ce1
13246 @opindex fdump-rtl-ce2
13247 @opindex fdump-rtl-ce3
13248 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13249 @option{-fdump-rtl-ce3} enable dumping after the three
13250 if conversion passes.
13252 @item -fdump-rtl-cprop_hardreg
13253 @opindex fdump-rtl-cprop_hardreg
13254 Dump after hard register copy propagation.
13256 @item -fdump-rtl-csa
13257 @opindex fdump-rtl-csa
13258 Dump after combining stack adjustments.
13260 @item -fdump-rtl-cse1
13261 @itemx -fdump-rtl-cse2
13262 @opindex fdump-rtl-cse1
13263 @opindex fdump-rtl-cse2
13264 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13265 the two common subexpression elimination passes.
13267 @item -fdump-rtl-dce
13268 @opindex fdump-rtl-dce
13269 Dump after the standalone dead code elimination passes.
13271 @item -fdump-rtl-dbr
13272 @opindex fdump-rtl-dbr
13273 Dump after delayed branch scheduling.
13275 @item -fdump-rtl-dce1
13276 @itemx -fdump-rtl-dce2
13277 @opindex fdump-rtl-dce1
13278 @opindex fdump-rtl-dce2
13279 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13280 the two dead store elimination passes.
13282 @item -fdump-rtl-eh
13283 @opindex fdump-rtl-eh
13284 Dump after finalization of EH handling code.
13286 @item -fdump-rtl-eh_ranges
13287 @opindex fdump-rtl-eh_ranges
13288 Dump after conversion of EH handling range regions.
13290 @item -fdump-rtl-expand
13291 @opindex fdump-rtl-expand
13292 Dump after RTL generation.
13294 @item -fdump-rtl-fwprop1
13295 @itemx -fdump-rtl-fwprop2
13296 @opindex fdump-rtl-fwprop1
13297 @opindex fdump-rtl-fwprop2
13298 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13299 dumping after the two forward propagation passes.
13301 @item -fdump-rtl-gcse1
13302 @itemx -fdump-rtl-gcse2
13303 @opindex fdump-rtl-gcse1
13304 @opindex fdump-rtl-gcse2
13305 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13306 after global common subexpression elimination.
13308 @item -fdump-rtl-init-regs
13309 @opindex fdump-rtl-init-regs
13310 Dump after the initialization of the registers.
13312 @item -fdump-rtl-initvals
13313 @opindex fdump-rtl-initvals
13314 Dump after the computation of the initial value sets.
13316 @item -fdump-rtl-into_cfglayout
13317 @opindex fdump-rtl-into_cfglayout
13318 Dump after converting to cfglayout mode.
13320 @item -fdump-rtl-ira
13321 @opindex fdump-rtl-ira
13322 Dump after iterated register allocation.
13324 @item -fdump-rtl-jump
13325 @opindex fdump-rtl-jump
13326 Dump after the second jump optimization.
13328 @item -fdump-rtl-loop2
13329 @opindex fdump-rtl-loop2
13330 @option{-fdump-rtl-loop2} enables dumping after the rtl
13331 loop optimization passes.
13333 @item -fdump-rtl-mach
13334 @opindex fdump-rtl-mach
13335 Dump after performing the machine dependent reorganization pass, if that
13336 pass exists.
13338 @item -fdump-rtl-mode_sw
13339 @opindex fdump-rtl-mode_sw
13340 Dump after removing redundant mode switches.
13342 @item -fdump-rtl-rnreg
13343 @opindex fdump-rtl-rnreg
13344 Dump after register renumbering.
13346 @item -fdump-rtl-outof_cfglayout
13347 @opindex fdump-rtl-outof_cfglayout
13348 Dump after converting from cfglayout mode.
13350 @item -fdump-rtl-peephole2
13351 @opindex fdump-rtl-peephole2
13352 Dump after the peephole pass.
13354 @item -fdump-rtl-postreload
13355 @opindex fdump-rtl-postreload
13356 Dump after post-reload optimizations.
13358 @item -fdump-rtl-pro_and_epilogue
13359 @opindex fdump-rtl-pro_and_epilogue
13360 Dump after generating the function prologues and epilogues.
13362 @item -fdump-rtl-sched1
13363 @itemx -fdump-rtl-sched2
13364 @opindex fdump-rtl-sched1
13365 @opindex fdump-rtl-sched2
13366 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13367 after the basic block scheduling passes.
13369 @item -fdump-rtl-ree
13370 @opindex fdump-rtl-ree
13371 Dump after sign/zero extension elimination.
13373 @item -fdump-rtl-seqabstr
13374 @opindex fdump-rtl-seqabstr
13375 Dump after common sequence discovery.
13377 @item -fdump-rtl-shorten
13378 @opindex fdump-rtl-shorten
13379 Dump after shortening branches.
13381 @item -fdump-rtl-sibling
13382 @opindex fdump-rtl-sibling
13383 Dump after sibling call optimizations.
13385 @item -fdump-rtl-split1
13386 @itemx -fdump-rtl-split2
13387 @itemx -fdump-rtl-split3
13388 @itemx -fdump-rtl-split4
13389 @itemx -fdump-rtl-split5
13390 @opindex fdump-rtl-split1
13391 @opindex fdump-rtl-split2
13392 @opindex fdump-rtl-split3
13393 @opindex fdump-rtl-split4
13394 @opindex fdump-rtl-split5
13395 These options enable dumping after five rounds of
13396 instruction splitting.
13398 @item -fdump-rtl-sms
13399 @opindex fdump-rtl-sms
13400 Dump after modulo scheduling.  This pass is only run on some
13401 architectures.
13403 @item -fdump-rtl-stack
13404 @opindex fdump-rtl-stack
13405 Dump after conversion from GCC's ``flat register file'' registers to the
13406 x87's stack-like registers.  This pass is only run on x86 variants.
13408 @item -fdump-rtl-subreg1
13409 @itemx -fdump-rtl-subreg2
13410 @opindex fdump-rtl-subreg1
13411 @opindex fdump-rtl-subreg2
13412 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13413 the two subreg expansion passes.
13415 @item -fdump-rtl-unshare
13416 @opindex fdump-rtl-unshare
13417 Dump after all rtl has been unshared.
13419 @item -fdump-rtl-vartrack
13420 @opindex fdump-rtl-vartrack
13421 Dump after variable tracking.
13423 @item -fdump-rtl-vregs
13424 @opindex fdump-rtl-vregs
13425 Dump after converting virtual registers to hard registers.
13427 @item -fdump-rtl-web
13428 @opindex fdump-rtl-web
13429 Dump after live range splitting.
13431 @item -fdump-rtl-regclass
13432 @itemx -fdump-rtl-subregs_of_mode_init
13433 @itemx -fdump-rtl-subregs_of_mode_finish
13434 @itemx -fdump-rtl-dfinit
13435 @itemx -fdump-rtl-dfinish
13436 @opindex fdump-rtl-regclass
13437 @opindex fdump-rtl-subregs_of_mode_init
13438 @opindex fdump-rtl-subregs_of_mode_finish
13439 @opindex fdump-rtl-dfinit
13440 @opindex fdump-rtl-dfinish
13441 These dumps are defined but always produce empty files.
13443 @item -da
13444 @itemx -fdump-rtl-all
13445 @opindex da
13446 @opindex fdump-rtl-all
13447 Produce all the dumps listed above.
13449 @item -dA
13450 @opindex dA
13451 Annotate the assembler output with miscellaneous debugging information.
13453 @item -dD
13454 @opindex dD
13455 Dump all macro definitions, at the end of preprocessing, in addition to
13456 normal output.
13458 @item -dH
13459 @opindex dH
13460 Produce a core dump whenever an error occurs.
13462 @item -dp
13463 @opindex dp
13464 Annotate the assembler output with a comment indicating which
13465 pattern and alternative is used.  The length and cost of each instruction are
13466 also printed.
13468 @item -dP
13469 @opindex dP
13470 Dump the RTL in the assembler output as a comment before each instruction.
13471 Also turns on @option{-dp} annotation.
13473 @item -dx
13474 @opindex dx
13475 Just generate RTL for a function instead of compiling it.  Usually used
13476 with @option{-fdump-rtl-expand}.
13477 @end table
13479 @item -fdump-noaddr
13480 @opindex fdump-noaddr
13481 When doing debugging dumps, suppress address output.  This makes it more
13482 feasible to use diff on debugging dumps for compiler invocations with
13483 different compiler binaries and/or different
13484 text / bss / data / heap / stack / dso start locations.
13486 @item -freport-bug
13487 @opindex freport-bug
13488 Collect and dump debug information into a temporary file if an
13489 internal compiler error (ICE) occurs.
13491 @item -fdump-unnumbered
13492 @opindex fdump-unnumbered
13493 When doing debugging dumps, suppress instruction numbers and address output.
13494 This makes it more feasible to use diff on debugging dumps for compiler
13495 invocations with different options, in particular with and without
13496 @option{-g}.
13498 @item -fdump-unnumbered-links
13499 @opindex fdump-unnumbered-links
13500 When doing debugging dumps (see @option{-d} option above), suppress
13501 instruction numbers for the links to the previous and next instructions
13502 in a sequence.
13504 @item -fdump-ipa-@var{switch}
13505 @opindex fdump-ipa
13506 Control the dumping at various stages of inter-procedural analysis
13507 language tree to a file.  The file name is generated by appending a
13508 switch specific suffix to the source file name, and the file is created
13509 in the same directory as the output file.  The following dumps are
13510 possible:
13512 @table @samp
13513 @item all
13514 Enables all inter-procedural analysis dumps.
13516 @item cgraph
13517 Dumps information about call-graph optimization, unused function removal,
13518 and inlining decisions.
13520 @item inline
13521 Dump after function inlining.
13523 @end table
13525 @item -fdump-lang-all
13526 @itemx -fdump-lang-@var{switch}
13527 @itemx -fdump-lang-@var{switch}-@var{options}
13528 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13529 @opindex fdump-lang-all
13530 @opindex fdump-lang
13531 Control the dumping of language-specific information.  The @var{options}
13532 and @var{filename} portions behave as described in the
13533 @option{-fdump-tree} option.  The following @var{switch} values are
13534 accepted:
13536 @table @samp
13537 @item all
13539 Enable all language-specific dumps.
13541 @item class
13542 Dump class hierarchy information.  Virtual table information is emitted
13543 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13545 @item raw
13546 Dump the raw internal tree data.  This option is applicable to C++ only.
13548 @end table
13550 @item -fdump-passes
13551 @opindex fdump-passes
13552 Print on @file{stderr} the list of optimization passes that are turned
13553 on and off by the current command-line options.
13555 @item -fdump-statistics-@var{option}
13556 @opindex fdump-statistics
13557 Enable and control dumping of pass statistics in a separate file.  The
13558 file name is generated by appending a suffix ending in
13559 @samp{.statistics} to the source file name, and the file is created in
13560 the same directory as the output file.  If the @samp{-@var{option}}
13561 form is used, @samp{-stats} causes counters to be summed over the
13562 whole compilation unit while @samp{-details} dumps every event as
13563 the passes generate them.  The default with no option is to sum
13564 counters for each function compiled.
13566 @item -fdump-tree-all
13567 @itemx -fdump-tree-@var{switch}
13568 @itemx -fdump-tree-@var{switch}-@var{options}
13569 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13570 @opindex fdump-tree-all
13571 @opindex fdump-tree
13572 Control the dumping at various stages of processing the intermediate
13573 language tree to a file.  The file name is generated by appending a
13574 switch-specific suffix to the source file name, and the file is
13575 created in the same directory as the output file. In case of
13576 @option{=@var{filename}} option, the dump is output on the given file
13577 instead of the auto named dump files.  If the @samp{-@var{options}}
13578 form is used, @var{options} is a list of @samp{-} separated options
13579 which control the details of the dump.  Not all options are applicable
13580 to all dumps; those that are not meaningful are ignored.  The
13581 following options are available
13583 @table @samp
13584 @item address
13585 Print the address of each node.  Usually this is not meaningful as it
13586 changes according to the environment and source file.  Its primary use
13587 is for tying up a dump file with a debug environment.
13588 @item asmname
13589 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13590 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13591 use working backward from mangled names in the assembly file.
13592 @item slim
13593 When dumping front-end intermediate representations, inhibit dumping
13594 of members of a scope or body of a function merely because that scope
13595 has been reached.  Only dump such items when they are directly reachable
13596 by some other path.
13598 When dumping pretty-printed trees, this option inhibits dumping the
13599 bodies of control structures.
13601 When dumping RTL, print the RTL in slim (condensed) form instead of
13602 the default LISP-like representation.
13603 @item raw
13604 Print a raw representation of the tree.  By default, trees are
13605 pretty-printed into a C-like representation.
13606 @item details
13607 Enable more detailed dumps (not honored by every dump option). Also
13608 include information from the optimization passes.
13609 @item stats
13610 Enable dumping various statistics about the pass (not honored by every dump
13611 option).
13612 @item blocks
13613 Enable showing basic block boundaries (disabled in raw dumps).
13614 @item graph
13615 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13616 dump a representation of the control flow graph suitable for viewing with
13617 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13618 the file is pretty-printed as a subgraph, so that GraphViz can render them
13619 all in a single plot.
13621 This option currently only works for RTL dumps, and the RTL is always
13622 dumped in slim form.
13623 @item vops
13624 Enable showing virtual operands for every statement.
13625 @item lineno
13626 Enable showing line numbers for statements.
13627 @item uid
13628 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13629 @item verbose
13630 Enable showing the tree dump for each statement.
13631 @item eh
13632 Enable showing the EH region number holding each statement.
13633 @item scev
13634 Enable showing scalar evolution analysis details.
13635 @item optimized
13636 Enable showing optimization information (only available in certain
13637 passes).
13638 @item missed
13639 Enable showing missed optimization information (only available in certain
13640 passes).
13641 @item note
13642 Enable other detailed optimization information (only available in
13643 certain passes).
13644 @item =@var{filename}
13645 Instead of an auto named dump file, output into the given file
13646 name. The file names @file{stdout} and @file{stderr} are treated
13647 specially and are considered already open standard streams. For
13648 example,
13650 @smallexample
13651 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13652      -fdump-tree-pre=/dev/stderr file.c
13653 @end smallexample
13655 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13656 output on to @file{stderr}. If two conflicting dump filenames are
13657 given for the same pass, then the latter option overrides the earlier
13658 one.
13660 @item all
13661 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13662 and @option{lineno}.
13664 @item optall
13665 Turn on all optimization options, i.e., @option{optimized},
13666 @option{missed}, and @option{note}.
13667 @end table
13669 To determine what tree dumps are available or find the dump for a pass
13670 of interest follow the steps below.
13672 @enumerate
13673 @item
13674 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13675 look for a code that corresponds to the pass you are interested in.
13676 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13677 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13678 The number at the end distinguishes distinct invocations of the same pass.
13679 @item
13680 To enable the creation of the dump file, append the pass code to
13681 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13682 to enable the dump from the Early Value Range Propagation pass, invoke
13683 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13684 specify the name of the dump file.  If you don't specify one, GCC
13685 creates as described below.
13686 @item
13687 Find the pass dump in a file whose name is composed of three components
13688 separated by a period: the name of the source file GCC was invoked to
13689 compile, a numeric suffix indicating the pass number followed by the
13690 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13691 and finally the pass code.  For example, the Early VRP pass dump might
13692 be in a file named @file{myfile.c.038t.evrp} in the current working
13693 directory.  Note that the numeric codes are not stable and may change
13694 from one version of GCC to another.
13695 @end enumerate
13697 @item -fopt-info
13698 @itemx -fopt-info-@var{options}
13699 @itemx -fopt-info-@var{options}=@var{filename}
13700 @opindex fopt-info
13701 Controls optimization dumps from various optimization passes. If the
13702 @samp{-@var{options}} form is used, @var{options} is a list of
13703 @samp{-} separated option keywords to select the dump details and
13704 optimizations.  
13706 The @var{options} can be divided into two groups: options describing the
13707 verbosity of the dump, and options describing which optimizations
13708 should be included. The options from both the groups can be freely
13709 mixed as they are non-overlapping. However, in case of any conflicts,
13710 the later options override the earlier options on the command
13711 line. 
13713 The following options control the dump verbosity:
13715 @table @samp
13716 @item optimized
13717 Print information when an optimization is successfully applied. It is
13718 up to a pass to decide which information is relevant. For example, the
13719 vectorizer passes print the source location of loops which are
13720 successfully vectorized.
13721 @item missed
13722 Print information about missed optimizations. Individual passes
13723 control which information to include in the output. 
13724 @item note
13725 Print verbose information about optimizations, such as certain
13726 transformations, more detailed messages about decisions etc.
13727 @item all
13728 Print detailed optimization information. This includes
13729 @samp{optimized}, @samp{missed}, and @samp{note}.
13730 @end table
13732 One or more of the following option keywords can be used to describe a
13733 group of optimizations:
13735 @table @samp
13736 @item ipa
13737 Enable dumps from all interprocedural optimizations.
13738 @item loop
13739 Enable dumps from all loop optimizations.
13740 @item inline
13741 Enable dumps from all inlining optimizations.
13742 @item omp
13743 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13744 @item vec
13745 Enable dumps from all vectorization optimizations.
13746 @item optall
13747 Enable dumps from all optimizations. This is a superset of
13748 the optimization groups listed above.
13749 @end table
13751 If @var{options} is
13752 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13753 info about successful optimizations from all the passes.  
13755 If the @var{filename} is provided, then the dumps from all the
13756 applicable optimizations are concatenated into the @var{filename}.
13757 Otherwise the dump is output onto @file{stderr}. Though multiple
13758 @option{-fopt-info} options are accepted, only one of them can include
13759 a @var{filename}. If other filenames are provided then all but the
13760 first such option are ignored.
13762 Note that the output @var{filename} is overwritten
13763 in case of multiple translation units. If a combined output from
13764 multiple translation units is desired, @file{stderr} should be used
13765 instead.
13767 In the following example, the optimization info is output to
13768 @file{stderr}:
13770 @smallexample
13771 gcc -O3 -fopt-info
13772 @end smallexample
13774 This example:
13775 @smallexample
13776 gcc -O3 -fopt-info-missed=missed.all
13777 @end smallexample
13779 @noindent
13780 outputs missed optimization report from all the passes into
13781 @file{missed.all}, and this one:
13783 @smallexample
13784 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13785 @end smallexample
13787 @noindent
13788 prints information about missed optimization opportunities from
13789 vectorization passes on @file{stderr}.  
13790 Note that @option{-fopt-info-vec-missed} is equivalent to 
13791 @option{-fopt-info-missed-vec}.  The order of the optimization group
13792 names and message types listed after @option{-fopt-info} does not matter.
13794 As another example,
13795 @smallexample
13796 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13797 @end smallexample
13799 @noindent
13800 outputs information about missed optimizations as well as
13801 optimized locations from all the inlining passes into
13802 @file{inline.txt}.
13804 Finally, consider:
13806 @smallexample
13807 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13808 @end smallexample
13810 @noindent
13811 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13812 in conflict since only one output file is allowed. In this case, only
13813 the first option takes effect and the subsequent options are
13814 ignored. Thus only @file{vec.miss} is produced which contains
13815 dumps from the vectorizer about missed opportunities.
13817 @item -fsched-verbose=@var{n}
13818 @opindex fsched-verbose
13819 On targets that use instruction scheduling, this option controls the
13820 amount of debugging output the scheduler prints to the dump files.
13822 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13823 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13824 For @var{n} greater than one, it also output basic block probabilities,
13825 detailed ready list information and unit/insn info.  For @var{n} greater
13826 than two, it includes RTL at abort point, control-flow and regions info.
13827 And for @var{n} over four, @option{-fsched-verbose} also includes
13828 dependence info.
13832 @item -fenable-@var{kind}-@var{pass}
13833 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13834 @opindex fdisable-
13835 @opindex fenable-
13837 This is a set of options that are used to explicitly disable/enable
13838 optimization passes.  These options are intended for use for debugging GCC.
13839 Compiler users should use regular options for enabling/disabling
13840 passes instead.
13842 @table @gcctabopt
13844 @item -fdisable-ipa-@var{pass}
13845 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13846 statically invoked in the compiler multiple times, the pass name should be
13847 appended with a sequential number starting from 1.
13849 @item -fdisable-rtl-@var{pass}
13850 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13851 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13852 statically invoked in the compiler multiple times, the pass name should be
13853 appended with a sequential number starting from 1.  @var{range-list} is a 
13854 comma-separated list of function ranges or assembler names.  Each range is a number
13855 pair separated by a colon.  The range is inclusive in both ends.  If the range
13856 is trivial, the number pair can be simplified as a single number.  If the
13857 function's call graph node's @var{uid} falls within one of the specified ranges,
13858 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13859 function header of a dump file, and the pass names can be dumped by using
13860 option @option{-fdump-passes}.
13862 @item -fdisable-tree-@var{pass}
13863 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13864 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13865 option arguments.
13867 @item -fenable-ipa-@var{pass}
13868 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13869 statically invoked in the compiler multiple times, the pass name should be
13870 appended with a sequential number starting from 1.
13872 @item -fenable-rtl-@var{pass}
13873 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13874 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13875 description and examples.
13877 @item -fenable-tree-@var{pass}
13878 @itemx -fenable-tree-@var{pass}=@var{range-list}
13879 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13880 of option arguments.
13882 @end table
13884 Here are some examples showing uses of these options.
13886 @smallexample
13888 # disable ccp1 for all functions
13889    -fdisable-tree-ccp1
13890 # disable complete unroll for function whose cgraph node uid is 1
13891    -fenable-tree-cunroll=1
13892 # disable gcse2 for functions at the following ranges [1,1],
13893 # [300,400], and [400,1000]
13894 # disable gcse2 for functions foo and foo2
13895    -fdisable-rtl-gcse2=foo,foo2
13896 # disable early inlining
13897    -fdisable-tree-einline
13898 # disable ipa inlining
13899    -fdisable-ipa-inline
13900 # enable tree full unroll
13901    -fenable-tree-unroll
13903 @end smallexample
13905 @item -fchecking
13906 @itemx -fchecking=@var{n}
13907 @opindex fchecking
13908 @opindex fno-checking
13909 Enable internal consistency checking.  The default depends on
13910 the compiler configuration.  @option{-fchecking=2} enables further
13911 internal consistency checking that might affect code generation.
13913 @item -frandom-seed=@var{string}
13914 @opindex frandom-seed
13915 This option provides a seed that GCC uses in place of
13916 random numbers in generating certain symbol names
13917 that have to be different in every compiled file.  It is also used to
13918 place unique stamps in coverage data files and the object files that
13919 produce them.  You can use the @option{-frandom-seed} option to produce
13920 reproducibly identical object files.
13922 The @var{string} can either be a number (decimal, octal or hex) or an
13923 arbitrary string (in which case it's converted to a number by
13924 computing CRC32).
13926 The @var{string} should be different for every file you compile.
13928 @item -save-temps
13929 @itemx -save-temps=cwd
13930 @opindex save-temps
13931 Store the usual ``temporary'' intermediate files permanently; place them
13932 in the current directory and name them based on the source file.  Thus,
13933 compiling @file{foo.c} with @option{-c -save-temps} produces files
13934 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13935 preprocessed @file{foo.i} output file even though the compiler now
13936 normally uses an integrated preprocessor.
13938 When used in combination with the @option{-x} command-line option,
13939 @option{-save-temps} is sensible enough to avoid over writing an
13940 input source file with the same extension as an intermediate file.
13941 The corresponding intermediate file may be obtained by renaming the
13942 source file before using @option{-save-temps}.
13944 If you invoke GCC in parallel, compiling several different source
13945 files that share a common base name in different subdirectories or the
13946 same source file compiled for multiple output destinations, it is
13947 likely that the different parallel compilers will interfere with each
13948 other, and overwrite the temporary files.  For instance:
13950 @smallexample
13951 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13952 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13953 @end smallexample
13955 may result in @file{foo.i} and @file{foo.o} being written to
13956 simultaneously by both compilers.
13958 @item -save-temps=obj
13959 @opindex save-temps=obj
13960 Store the usual ``temporary'' intermediate files permanently.  If the
13961 @option{-o} option is used, the temporary files are based on the
13962 object file.  If the @option{-o} option is not used, the
13963 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13965 For example:
13967 @smallexample
13968 gcc -save-temps=obj -c foo.c
13969 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13970 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13971 @end smallexample
13973 @noindent
13974 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13975 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13976 @file{dir2/yfoobar.o}.
13978 @item -time@r{[}=@var{file}@r{]}
13979 @opindex time
13980 Report the CPU time taken by each subprocess in the compilation
13981 sequence.  For C source files, this is the compiler proper and assembler
13982 (plus the linker if linking is done).
13984 Without the specification of an output file, the output looks like this:
13986 @smallexample
13987 # cc1 0.12 0.01
13988 # as 0.00 0.01
13989 @end smallexample
13991 The first number on each line is the ``user time'', that is time spent
13992 executing the program itself.  The second number is ``system time'',
13993 time spent executing operating system routines on behalf of the program.
13994 Both numbers are in seconds.
13996 With the specification of an output file, the output is appended to the
13997 named file, and it looks like this:
13999 @smallexample
14000 0.12 0.01 cc1 @var{options}
14001 0.00 0.01 as @var{options}
14002 @end smallexample
14004 The ``user time'' and the ``system time'' are moved before the program
14005 name, and the options passed to the program are displayed, so that one
14006 can later tell what file was being compiled, and with which options.
14008 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14009 @opindex fdump-final-insns
14010 Dump the final internal representation (RTL) to @var{file}.  If the
14011 optional argument is omitted (or if @var{file} is @code{.}), the name
14012 of the dump file is determined by appending @code{.gkd} to the
14013 compilation output file name.
14015 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14016 @opindex fcompare-debug
14017 @opindex fno-compare-debug
14018 If no error occurs during compilation, run the compiler a second time,
14019 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14020 passed to the second compilation.  Dump the final internal
14021 representation in both compilations, and print an error if they differ.
14023 If the equal sign is omitted, the default @option{-gtoggle} is used.
14025 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14026 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14027 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14028 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14029 is used.
14031 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14032 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14033 of the final representation and the second compilation, preventing even
14034 @env{GCC_COMPARE_DEBUG} from taking effect.
14036 To verify full coverage during @option{-fcompare-debug} testing, set
14037 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14038 which GCC rejects as an invalid option in any actual compilation
14039 (rather than preprocessing, assembly or linking).  To get just a
14040 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14041 not overridden} will do.
14043 @item -fcompare-debug-second
14044 @opindex fcompare-debug-second
14045 This option is implicitly passed to the compiler for the second
14046 compilation requested by @option{-fcompare-debug}, along with options to
14047 silence warnings, and omitting other options that would cause
14048 side-effect compiler outputs to files or to the standard output.  Dump
14049 files and preserved temporary files are renamed so as to contain the
14050 @code{.gk} additional extension during the second compilation, to avoid
14051 overwriting those generated by the first.
14053 When this option is passed to the compiler driver, it causes the
14054 @emph{first} compilation to be skipped, which makes it useful for little
14055 other than debugging the compiler proper.
14057 @item -gtoggle
14058 @opindex gtoggle
14059 Turn off generation of debug info, if leaving out this option
14060 generates it, or turn it on at level 2 otherwise.  The position of this
14061 argument in the command line does not matter; it takes effect after all
14062 other options are processed, and it does so only once, no matter how
14063 many times it is given.  This is mainly intended to be used with
14064 @option{-fcompare-debug}.
14066 @item -fvar-tracking-assignments-toggle
14067 @opindex fvar-tracking-assignments-toggle
14068 @opindex fno-var-tracking-assignments-toggle
14069 Toggle @option{-fvar-tracking-assignments}, in the same way that
14070 @option{-gtoggle} toggles @option{-g}.
14072 @item -Q
14073 @opindex Q
14074 Makes the compiler print out each function name as it is compiled, and
14075 print some statistics about each pass when it finishes.
14077 @item -ftime-report
14078 @opindex ftime-report
14079 Makes the compiler print some statistics about the time consumed by each
14080 pass when it finishes.
14082 @item -ftime-report-details
14083 @opindex ftime-report-details
14084 Record the time consumed by infrastructure parts separately for each pass.
14086 @item -fira-verbose=@var{n}
14087 @opindex fira-verbose
14088 Control the verbosity of the dump file for the integrated register allocator.
14089 The default value is 5.  If the value @var{n} is greater or equal to 10,
14090 the dump output is sent to stderr using the same format as @var{n} minus 10.
14092 @item -flto-report
14093 @opindex flto-report
14094 Prints a report with internal details on the workings of the link-time
14095 optimizer.  The contents of this report vary from version to version.
14096 It is meant to be useful to GCC developers when processing object
14097 files in LTO mode (via @option{-flto}).
14099 Disabled by default.
14101 @item -flto-report-wpa
14102 @opindex flto-report-wpa
14103 Like @option{-flto-report}, but only print for the WPA phase of Link
14104 Time Optimization.
14106 @item -fmem-report
14107 @opindex fmem-report
14108 Makes the compiler print some statistics about permanent memory
14109 allocation when it finishes.
14111 @item -fmem-report-wpa
14112 @opindex fmem-report-wpa
14113 Makes the compiler print some statistics about permanent memory
14114 allocation for the WPA phase only.
14116 @item -fpre-ipa-mem-report
14117 @opindex fpre-ipa-mem-report
14118 @item -fpost-ipa-mem-report
14119 @opindex fpost-ipa-mem-report
14120 Makes the compiler print some statistics about permanent memory
14121 allocation before or after interprocedural optimization.
14123 @item -fprofile-report
14124 @opindex fprofile-report
14125 Makes the compiler print some statistics about consistency of the
14126 (estimated) profile and effect of individual passes.
14128 @item -fstack-usage
14129 @opindex fstack-usage
14130 Makes the compiler output stack usage information for the program, on a
14131 per-function basis.  The filename for the dump is made by appending
14132 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14133 the output file, if explicitly specified and it is not an executable,
14134 otherwise it is the basename of the source file.  An entry is made up
14135 of three fields:
14137 @itemize
14138 @item
14139 The name of the function.
14140 @item
14141 A number of bytes.
14142 @item
14143 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14144 @end itemize
14146 The qualifier @code{static} means that the function manipulates the stack
14147 statically: a fixed number of bytes are allocated for the frame on function
14148 entry and released on function exit; no stack adjustments are otherwise made
14149 in the function.  The second field is this fixed number of bytes.
14151 The qualifier @code{dynamic} means that the function manipulates the stack
14152 dynamically: in addition to the static allocation described above, stack
14153 adjustments are made in the body of the function, for example to push/pop
14154 arguments around function calls.  If the qualifier @code{bounded} is also
14155 present, the amount of these adjustments is bounded at compile time and
14156 the second field is an upper bound of the total amount of stack used by
14157 the function.  If it is not present, the amount of these adjustments is
14158 not bounded at compile time and the second field only represents the
14159 bounded part.
14161 @item -fstats
14162 @opindex fstats
14163 Emit statistics about front-end processing at the end of the compilation.
14164 This option is supported only by the C++ front end, and
14165 the information is generally only useful to the G++ development team.
14167 @item -fdbg-cnt-list
14168 @opindex fdbg-cnt-list
14169 Print the name and the counter upper bound for all debug counters.
14172 @item -fdbg-cnt=@var{counter-value-list}
14173 @opindex fdbg-cnt
14174 Set the internal debug counter upper bound.  @var{counter-value-list}
14175 is a comma-separated list of @var{name}:@var{value} pairs
14176 which sets the upper bound of each debug counter @var{name} to @var{value}.
14177 All debug counters have the initial upper bound of @code{UINT_MAX};
14178 thus @code{dbg_cnt} returns true always unless the upper bound
14179 is set by this option.
14180 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14181 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14183 @item -print-file-name=@var{library}
14184 @opindex print-file-name
14185 Print the full absolute name of the library file @var{library} that
14186 would be used when linking---and don't do anything else.  With this
14187 option, GCC does not compile or link anything; it just prints the
14188 file name.
14190 @item -print-multi-directory
14191 @opindex print-multi-directory
14192 Print the directory name corresponding to the multilib selected by any
14193 other switches present in the command line.  This directory is supposed
14194 to exist in @env{GCC_EXEC_PREFIX}.
14196 @item -print-multi-lib
14197 @opindex print-multi-lib
14198 Print the mapping from multilib directory names to compiler switches
14199 that enable them.  The directory name is separated from the switches by
14200 @samp{;}, and each switch starts with an @samp{@@} instead of the
14201 @samp{-}, without spaces between multiple switches.  This is supposed to
14202 ease shell processing.
14204 @item -print-multi-os-directory
14205 @opindex print-multi-os-directory
14206 Print the path to OS libraries for the selected
14207 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14208 present in the @file{lib} subdirectory and no multilibs are used, this is
14209 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14210 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14211 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14212 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14214 @item -print-multiarch
14215 @opindex print-multiarch
14216 Print the path to OS libraries for the selected multiarch,
14217 relative to some @file{lib} subdirectory.
14219 @item -print-prog-name=@var{program}
14220 @opindex print-prog-name
14221 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14223 @item -print-libgcc-file-name
14224 @opindex print-libgcc-file-name
14225 Same as @option{-print-file-name=libgcc.a}.
14227 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14228 but you do want to link with @file{libgcc.a}.  You can do:
14230 @smallexample
14231 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14232 @end smallexample
14234 @item -print-search-dirs
14235 @opindex print-search-dirs
14236 Print the name of the configured installation directory and a list of
14237 program and library directories @command{gcc} searches---and don't do anything else.
14239 This is useful when @command{gcc} prints the error message
14240 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14241 To resolve this you either need to put @file{cpp0} and the other compiler
14242 components where @command{gcc} expects to find them, or you can set the environment
14243 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14244 Don't forget the trailing @samp{/}.
14245 @xref{Environment Variables}.
14247 @item -print-sysroot
14248 @opindex print-sysroot
14249 Print the target sysroot directory that is used during
14250 compilation.  This is the target sysroot specified either at configure
14251 time or using the @option{--sysroot} option, possibly with an extra
14252 suffix that depends on compilation options.  If no target sysroot is
14253 specified, the option prints nothing.
14255 @item -print-sysroot-headers-suffix
14256 @opindex print-sysroot-headers-suffix
14257 Print the suffix added to the target sysroot when searching for
14258 headers, or give an error if the compiler is not configured with such
14259 a suffix---and don't do anything else.
14261 @item -dumpmachine
14262 @opindex dumpmachine
14263 Print the compiler's target machine (for example,
14264 @samp{i686-pc-linux-gnu})---and don't do anything else.
14266 @item -dumpversion
14267 @opindex dumpversion
14268 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14269 anything else.  This is the compiler version used in filesystem paths,
14270 specs, can be depending on how the compiler has been configured just
14271 a single number (major version), two numbers separated by dot (major and
14272 minor version) or three numbers separated by dots (major, minor and patchlevel
14273 version).
14275 @item -dumpfullversion
14276 @opindex dumpfullversion
14277 Print the full compiler version, always 3 numbers separated by dots,
14278 major, minor and patchlevel version.
14280 @item -dumpspecs
14281 @opindex dumpspecs
14282 Print the compiler's built-in specs---and don't do anything else.  (This
14283 is used when GCC itself is being built.)  @xref{Spec Files}.
14284 @end table
14286 @node Submodel Options
14287 @section Machine-Dependent Options
14288 @cindex submodel options
14289 @cindex specifying hardware config
14290 @cindex hardware models and configurations, specifying
14291 @cindex target-dependent options
14292 @cindex machine-dependent options
14294 Each target machine supported by GCC can have its own options---for
14295 example, to allow you to compile for a particular processor variant or
14296 ABI, or to control optimizations specific to that machine.  By
14297 convention, the names of machine-specific options start with
14298 @samp{-m}.
14300 Some configurations of the compiler also support additional target-specific
14301 options, usually for compatibility with other compilers on the same
14302 platform.
14304 @c This list is ordered alphanumerically by subsection name.
14305 @c It should be the same order and spelling as these options are listed
14306 @c in Machine Dependent Options
14308 @menu
14309 * AArch64 Options::
14310 * Adapteva Epiphany Options::
14311 * ARC Options::
14312 * ARM Options::
14313 * AVR Options::
14314 * Blackfin Options::
14315 * C6X Options::
14316 * CRIS Options::
14317 * CR16 Options::
14318 * Darwin Options::
14319 * DEC Alpha Options::
14320 * FR30 Options::
14321 * FT32 Options::
14322 * FRV Options::
14323 * GNU/Linux Options::
14324 * H8/300 Options::
14325 * HPPA Options::
14326 * IA-64 Options::
14327 * LM32 Options::
14328 * M32C Options::
14329 * M32R/D Options::
14330 * M680x0 Options::
14331 * MCore Options::
14332 * MeP Options::
14333 * MicroBlaze Options::
14334 * MIPS Options::
14335 * MMIX Options::
14336 * MN10300 Options::
14337 * Moxie Options::
14338 * MSP430 Options::
14339 * NDS32 Options::
14340 * Nios II Options::
14341 * Nvidia PTX Options::
14342 * PDP-11 Options::
14343 * picoChip Options::
14344 * PowerPC Options::
14345 * RISC-V Options::
14346 * RL78 Options::
14347 * RS/6000 and PowerPC Options::
14348 * RX Options::
14349 * S/390 and zSeries Options::
14350 * Score Options::
14351 * SH Options::
14352 * Solaris 2 Options::
14353 * SPARC Options::
14354 * SPU Options::
14355 * System V Options::
14356 * TILE-Gx Options::
14357 * TILEPro Options::
14358 * V850 Options::
14359 * VAX Options::
14360 * Visium Options::
14361 * VMS Options::
14362 * VxWorks Options::
14363 * x86 Options::
14364 * x86 Windows Options::
14365 * Xstormy16 Options::
14366 * Xtensa Options::
14367 * zSeries Options::
14368 @end menu
14370 @node AArch64 Options
14371 @subsection AArch64 Options
14372 @cindex AArch64 Options
14374 These options are defined for AArch64 implementations:
14376 @table @gcctabopt
14378 @item -mabi=@var{name}
14379 @opindex mabi
14380 Generate code for the specified data model.  Permissible values
14381 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14382 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14383 but long int and pointers are 64 bits.
14385 The default depends on the specific target configuration.  Note that
14386 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14387 entire program with the same ABI, and link with a compatible set of libraries.
14389 @item -mbig-endian
14390 @opindex mbig-endian
14391 Generate big-endian code.  This is the default when GCC is configured for an
14392 @samp{aarch64_be-*-*} target.
14394 @item -mgeneral-regs-only
14395 @opindex mgeneral-regs-only
14396 Generate code which uses only the general-purpose registers.  This will prevent
14397 the compiler from using floating-point and Advanced SIMD registers but will not
14398 impose any restrictions on the assembler.
14400 @item -mlittle-endian
14401 @opindex mlittle-endian
14402 Generate little-endian code.  This is the default when GCC is configured for an
14403 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14405 @item -mcmodel=tiny
14406 @opindex mcmodel=tiny
14407 Generate code for the tiny code model.  The program and its statically defined
14408 symbols must be within 1MB of each other.  Programs can be statically or
14409 dynamically linked.
14411 @item -mcmodel=small
14412 @opindex mcmodel=small
14413 Generate code for the small code model.  The program and its statically defined
14414 symbols must be within 4GB of each other.  Programs can be statically or
14415 dynamically linked.  This is the default code model.
14417 @item -mcmodel=large
14418 @opindex mcmodel=large
14419 Generate code for the large code model.  This makes no assumptions about
14420 addresses and sizes of sections.  Programs can be statically linked only.
14422 @item -mstrict-align
14423 @opindex mstrict-align
14424 Avoid generating memory accesses that may not be aligned on a natural object
14425 boundary as described in the architecture specification.
14427 @item -momit-leaf-frame-pointer
14428 @itemx -mno-omit-leaf-frame-pointer
14429 @opindex momit-leaf-frame-pointer
14430 @opindex mno-omit-leaf-frame-pointer
14431 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14432 default.
14434 @item -mtls-dialect=desc
14435 @opindex mtls-dialect=desc
14436 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14437 of TLS variables.  This is the default.
14439 @item -mtls-dialect=traditional
14440 @opindex mtls-dialect=traditional
14441 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14442 of TLS variables.
14444 @item -mtls-size=@var{size}
14445 @opindex mtls-size
14446 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14447 This option requires binutils 2.26 or newer.
14449 @item -mfix-cortex-a53-835769
14450 @itemx -mno-fix-cortex-a53-835769
14451 @opindex mfix-cortex-a53-835769
14452 @opindex mno-fix-cortex-a53-835769
14453 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14454 This involves inserting a NOP instruction between memory instructions and
14455 64-bit integer multiply-accumulate instructions.
14457 @item -mfix-cortex-a53-843419
14458 @itemx -mno-fix-cortex-a53-843419
14459 @opindex mfix-cortex-a53-843419
14460 @opindex mno-fix-cortex-a53-843419
14461 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14462 This erratum workaround is made at link time and this will only pass the
14463 corresponding flag to the linker.
14465 @item -mlow-precision-recip-sqrt
14466 @item -mno-low-precision-recip-sqrt
14467 @opindex mlow-precision-recip-sqrt
14468 @opindex mno-low-precision-recip-sqrt
14469 Enable or disable the reciprocal square root approximation.
14470 This option only has an effect if @option{-ffast-math} or
14471 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14472 precision of reciprocal square root results to about 16 bits for
14473 single precision and to 32 bits for double precision.
14475 @item -mlow-precision-sqrt
14476 @item -mno-low-precision-sqrt
14477 @opindex -mlow-precision-sqrt
14478 @opindex -mno-low-precision-sqrt
14479 Enable or disable the square root approximation.
14480 This option only has an effect if @option{-ffast-math} or
14481 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14482 precision of square root results to about 16 bits for
14483 single precision and to 32 bits for double precision.
14484 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14486 @item -mlow-precision-div
14487 @item -mno-low-precision-div
14488 @opindex -mlow-precision-div
14489 @opindex -mno-low-precision-div
14490 Enable or disable the division approximation.
14491 This option only has an effect if @option{-ffast-math} or
14492 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14493 precision of division results to about 16 bits for
14494 single precision and to 32 bits for double precision.
14496 @item -march=@var{name}
14497 @opindex march
14498 Specify the name of the target architecture and, optionally, one or
14499 more feature modifiers.  This option has the form
14500 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14502 The permissible values for @var{arch} are @samp{armv8-a},
14503 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14504 or @var{native}.
14506 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14507 support for the ARMv8.4-A architecture extensions.
14509 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14510 support for the ARMv8.3-A architecture extensions.
14512 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14513 support for the ARMv8.2-A architecture extensions.
14515 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14516 support for the ARMv8.1-A architecture extension.  In particular, it
14517 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14519 The value @samp{native} is available on native AArch64 GNU/Linux and
14520 causes the compiler to pick the architecture of the host system.  This
14521 option has no effect if the compiler is unable to recognize the
14522 architecture of the host system,
14524 The permissible values for @var{feature} are listed in the sub-section
14525 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14526 Feature Modifiers}.  Where conflicting feature modifiers are
14527 specified, the right-most feature is used.
14529 GCC uses @var{name} to determine what kind of instructions it can emit
14530 when generating assembly code.  If @option{-march} is specified
14531 without either of @option{-mtune} or @option{-mcpu} also being
14532 specified, the code is tuned to perform well across a range of target
14533 processors implementing the target architecture.
14535 @item -mtune=@var{name}
14536 @opindex mtune
14537 Specify the name of the target processor for which GCC should tune the
14538 performance of the code.  Permissible values for this option are:
14539 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14540 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14541 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14542 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14543 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14544 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14545 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14546 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14547 @samp{native}.
14549 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14550 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14551 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14552 big.LITTLE system.
14554 Additionally on native AArch64 GNU/Linux systems the value
14555 @samp{native} tunes performance to the host system.  This option has no effect
14556 if the compiler is unable to recognize the processor of the host system.
14558 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14559 are specified, the code is tuned to perform well across a range
14560 of target processors.
14562 This option cannot be suffixed by feature modifiers.
14564 @item -mcpu=@var{name}
14565 @opindex mcpu
14566 Specify the name of the target processor, optionally suffixed by one
14567 or more feature modifiers.  This option has the form
14568 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14569 the permissible values for @var{cpu} are the same as those available
14570 for @option{-mtune}.  The permissible values for @var{feature} are
14571 documented in the sub-section on
14572 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14573 Feature Modifiers}.  Where conflicting feature modifiers are
14574 specified, the right-most feature is used.
14576 GCC uses @var{name} to determine what kind of instructions it can emit when
14577 generating assembly code (as if by @option{-march}) and to determine
14578 the target processor for which to tune for performance (as if
14579 by @option{-mtune}).  Where this option is used in conjunction
14580 with @option{-march} or @option{-mtune}, those options take precedence
14581 over the appropriate part of this option.
14583 @item -moverride=@var{string}
14584 @opindex moverride
14585 Override tuning decisions made by the back-end in response to a
14586 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14587 for @var{string} in this option are not guaranteed to be consistent
14588 across releases.
14590 This option is only intended to be useful when developing GCC.
14592 @item -mverbose-cost-dump
14593 @opindex mverbose-cost-dump
14594 Enable verbose cost model dumping in the debug dump files.  This option is
14595 provided for use in debugging the compiler.
14597 @item -mpc-relative-literal-loads
14598 @itemx -mno-pc-relative-literal-loads
14599 @opindex mpc-relative-literal-loads
14600 @opindex mno-pc-relative-literal-loads
14601 Enable or disable PC-relative literal loads.  With this option literal pools are
14602 accessed using a single instruction and emitted after each function.  This
14603 limits the maximum size of functions to 1MB.  This is enabled by default for
14604 @option{-mcmodel=tiny}.
14606 @item -msign-return-address=@var{scope}
14607 @opindex msign-return-address
14608 Select the function scope on which return address signing will be applied.
14609 Permissible values are @samp{none}, which disables return address signing,
14610 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14611 functions, and @samp{all}, which enables pointer signing for all functions.  The
14612 default value is @samp{none}.
14614 @item -msve-vector-bits=@var{bits}
14615 @opindex msve-vector-bits
14616 Specify the number of bits in an SVE vector register.  This option only has
14617 an effect when SVE is enabled.
14619 GCC supports two forms of SVE code generation: ``vector-length
14620 agnostic'' output that works with any size of vector register and
14621 ``vector-length specific'' output that only works when the vector
14622 registers are a particular size.  Replacing @var{bits} with
14623 @samp{scalable} selects vector-length agnostic output while
14624 replacing it with a number selects vector-length specific output.
14625 The possible lengths in the latter case are: 128, 256, 512, 1024
14626 and 2048.  @samp{scalable} is the default.
14628 At present, @samp{-msve-vector-bits=128} produces the same output
14629 as @samp{-msve-vector-bits=scalable}.
14631 @end table
14633 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14634 @anchor{aarch64-feature-modifiers}
14635 @cindex @option{-march} feature modifiers
14636 @cindex @option{-mcpu} feature modifiers
14637 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14638 the following and their inverses @option{no@var{feature}}:
14640 @table @samp
14641 @item crc
14642 Enable CRC extension.  This is on by default for
14643 @option{-march=armv8.1-a}.
14644 @item crypto
14645 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14646 instructions.
14647 @item fp
14648 Enable floating-point instructions.  This is on by default for all possible
14649 values for options @option{-march} and @option{-mcpu}.
14650 @item simd
14651 Enable Advanced SIMD instructions.  This also enables floating-point
14652 instructions.  This is on by default for all possible values for options
14653 @option{-march} and @option{-mcpu}.
14654 @item sve
14655 Enable Scalable Vector Extension instructions.  This also enables Advanced
14656 SIMD and floating-point instructions.
14657 @item lse
14658 Enable Large System Extension instructions.  This is on by default for
14659 @option{-march=armv8.1-a}.
14660 @item rdma
14661 Enable Round Double Multiply Accumulate instructions.  This is on by default
14662 for @option{-march=armv8.1-a}.
14663 @item fp16
14664 Enable FP16 extension.  This also enables floating-point instructions.
14665 @item fp16fml
14666 Enable FP16 fmla extension.  This also enables FP16 extensions and
14667 floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported.
14669 @item rcpc
14670 Enable the RcPc extension.  This does not change code generation from GCC,
14671 but is passed on to the assembler, enabling inline asm statements to use
14672 instructions from the RcPc extension.
14673 @item dotprod
14674 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14675 @item aes
14676 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14677 SIMD instructions.
14678 @item sha2
14679 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14680 @item sha3
14681 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14682 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14683 @item sm4
14684 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14685 Use of this option with architectures prior to Armv8.2-A is not supported.
14687 @end table
14689 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14690 which implies @option{fp}.
14691 Conversely, @option{nofp} implies @option{nosimd}, which implies
14692 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14694 @node Adapteva Epiphany Options
14695 @subsection Adapteva Epiphany Options
14697 These @samp{-m} options are defined for Adapteva Epiphany:
14699 @table @gcctabopt
14700 @item -mhalf-reg-file
14701 @opindex mhalf-reg-file
14702 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14703 That allows code to run on hardware variants that lack these registers.
14705 @item -mprefer-short-insn-regs
14706 @opindex mprefer-short-insn-regs
14707 Preferentially allocate registers that allow short instruction generation.
14708 This can result in increased instruction count, so this may either reduce or
14709 increase overall code size.
14711 @item -mbranch-cost=@var{num}
14712 @opindex mbranch-cost
14713 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14714 This cost is only a heuristic and is not guaranteed to produce
14715 consistent results across releases.
14717 @item -mcmove
14718 @opindex mcmove
14719 Enable the generation of conditional moves.
14721 @item -mnops=@var{num}
14722 @opindex mnops
14723 Emit @var{num} NOPs before every other generated instruction.
14725 @item -mno-soft-cmpsf
14726 @opindex mno-soft-cmpsf
14727 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14728 and test the flags.  This is faster than a software comparison, but can
14729 get incorrect results in the presence of NaNs, or when two different small
14730 numbers are compared such that their difference is calculated as zero.
14731 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14732 software comparisons.
14734 @item -mstack-offset=@var{num}
14735 @opindex mstack-offset
14736 Set the offset between the top of the stack and the stack pointer.
14737 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14738 can be used by leaf functions without stack allocation.
14739 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14740 Note also that this option changes the ABI; compiling a program with a
14741 different stack offset than the libraries have been compiled with
14742 generally does not work.
14743 This option can be useful if you want to evaluate if a different stack
14744 offset would give you better code, but to actually use a different stack
14745 offset to build working programs, it is recommended to configure the
14746 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14748 @item -mno-round-nearest
14749 @opindex mno-round-nearest
14750 Make the scheduler assume that the rounding mode has been set to
14751 truncating.  The default is @option{-mround-nearest}.
14753 @item -mlong-calls
14754 @opindex mlong-calls
14755 If not otherwise specified by an attribute, assume all calls might be beyond
14756 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14757 function address into a register before performing a (otherwise direct) call.
14758 This is the default.
14760 @item -mshort-calls
14761 @opindex short-calls
14762 If not otherwise specified by an attribute, assume all direct calls are
14763 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14764 for direct calls.  The default is @option{-mlong-calls}.
14766 @item -msmall16
14767 @opindex msmall16
14768 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14769 apply to function addresses for which @option{-mlong-calls} semantics
14770 are in effect.
14772 @item -mfp-mode=@var{mode}
14773 @opindex mfp-mode
14774 Set the prevailing mode of the floating-point unit.
14775 This determines the floating-point mode that is provided and expected
14776 at function call and return time.  Making this mode match the mode you
14777 predominantly need at function start can make your programs smaller and
14778 faster by avoiding unnecessary mode switches.
14780 @var{mode} can be set to one the following values:
14782 @table @samp
14783 @item caller
14784 Any mode at function entry is valid, and retained or restored when
14785 the function returns, and when it calls other functions.
14786 This mode is useful for compiling libraries or other compilation units
14787 you might want to incorporate into different programs with different
14788 prevailing FPU modes, and the convenience of being able to use a single
14789 object file outweighs the size and speed overhead for any extra
14790 mode switching that might be needed, compared with what would be needed
14791 with a more specific choice of prevailing FPU mode.
14793 @item truncate
14794 This is the mode used for floating-point calculations with
14795 truncating (i.e.@: round towards zero) rounding mode.  That includes
14796 conversion from floating point to integer.
14798 @item round-nearest
14799 This is the mode used for floating-point calculations with
14800 round-to-nearest-or-even rounding mode.
14802 @item int
14803 This is the mode used to perform integer calculations in the FPU, e.g.@:
14804 integer multiply, or integer multiply-and-accumulate.
14805 @end table
14807 The default is @option{-mfp-mode=caller}
14809 @item -mnosplit-lohi
14810 @itemx -mno-postinc
14811 @itemx -mno-postmodify
14812 @opindex mnosplit-lohi
14813 @opindex mno-postinc
14814 @opindex mno-postmodify
14815 Code generation tweaks that disable, respectively, splitting of 32-bit
14816 loads, generation of post-increment addresses, and generation of
14817 post-modify addresses.  The defaults are @option{msplit-lohi},
14818 @option{-mpost-inc}, and @option{-mpost-modify}.
14820 @item -mnovect-double
14821 @opindex mno-vect-double
14822 Change the preferred SIMD mode to SImode.  The default is
14823 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14825 @item -max-vect-align=@var{num}
14826 @opindex max-vect-align
14827 The maximum alignment for SIMD vector mode types.
14828 @var{num} may be 4 or 8.  The default is 8.
14829 Note that this is an ABI change, even though many library function
14830 interfaces are unaffected if they don't use SIMD vector modes
14831 in places that affect size and/or alignment of relevant types.
14833 @item -msplit-vecmove-early
14834 @opindex msplit-vecmove-early
14835 Split vector moves into single word moves before reload.  In theory this
14836 can give better register allocation, but so far the reverse seems to be
14837 generally the case.
14839 @item -m1reg-@var{reg}
14840 @opindex m1reg-
14841 Specify a register to hold the constant @minus{}1, which makes loading small negative
14842 constants and certain bitmasks faster.
14843 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14844 which specify use of that register as a fixed register,
14845 and @samp{none}, which means that no register is used for this
14846 purpose.  The default is @option{-m1reg-none}.
14848 @end table
14850 @node ARC Options
14851 @subsection ARC Options
14852 @cindex ARC options
14854 The following options control the architecture variant for which code
14855 is being compiled:
14857 @c architecture variants
14858 @table @gcctabopt
14860 @item -mbarrel-shifter
14861 @opindex mbarrel-shifter
14862 Generate instructions supported by barrel shifter.  This is the default
14863 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14865 @item -mcpu=@var{cpu}
14866 @opindex mcpu
14867 Set architecture type, register usage, and instruction scheduling
14868 parameters for @var{cpu}.  There are also shortcut alias options
14869 available for backward compatibility and convenience.  Supported
14870 values for @var{cpu} are
14872 @table @samp
14873 @opindex mA6
14874 @opindex mARC600
14875 @item arc600
14876 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14878 @item arc601
14879 @opindex mARC601
14880 Compile for ARC601.  Alias: @option{-mARC601}.
14882 @item arc700
14883 @opindex mA7
14884 @opindex mARC700
14885 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14886 This is the default when configured with @option{--with-cpu=arc700}@.
14888 @item arcem
14889 Compile for ARC EM.
14891 @item archs
14892 Compile for ARC HS.
14894 @item em
14895 Compile for ARC EM CPU with no hardware extensions.
14897 @item em4
14898 Compile for ARC EM4 CPU.
14900 @item em4_dmips
14901 Compile for ARC EM4 DMIPS CPU.
14903 @item em4_fpus
14904 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14905 extension.
14907 @item em4_fpuda
14908 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14909 double assist instructions.
14911 @item hs
14912 Compile for ARC HS CPU with no hardware extensions except the atomic
14913 instructions.
14915 @item hs34
14916 Compile for ARC HS34 CPU.
14918 @item hs38
14919 Compile for ARC HS38 CPU.
14921 @item hs38_linux
14922 Compile for ARC HS38 CPU with all hardware extensions on.
14924 @item arc600_norm
14925 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14927 @item arc600_mul32x16
14928 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14929 instructions enabled.
14931 @item arc600_mul64
14932 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14933 instructions enabled.
14935 @item arc601_norm
14936 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14938 @item arc601_mul32x16
14939 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14940 instructions enabled.
14942 @item arc601_mul64
14943 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14944 instructions enabled.
14946 @item nps400
14947 Compile for ARC 700 on NPS400 chip.
14949 @end table
14951 @item -mdpfp
14952 @opindex mdpfp
14953 @itemx -mdpfp-compact
14954 @opindex mdpfp-compact
14955 Generate double-precision FPX instructions, tuned for the compact
14956 implementation.
14958 @item -mdpfp-fast
14959 @opindex mdpfp-fast
14960 Generate double-precision FPX instructions, tuned for the fast
14961 implementation.
14963 @item -mno-dpfp-lrsr
14964 @opindex mno-dpfp-lrsr
14965 Disable @code{lr} and @code{sr} instructions from using FPX extension
14966 aux registers.
14968 @item -mea
14969 @opindex mea
14970 Generate extended arithmetic instructions.  Currently only
14971 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14972 supported.  This is always enabled for @option{-mcpu=ARC700}.
14974 @item -mno-mpy
14975 @opindex mno-mpy
14976 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14977 deprecated.
14979 @item -mmul32x16
14980 @opindex mmul32x16
14981 Generate 32x16-bit multiply and multiply-accumulate instructions.
14983 @item -mmul64
14984 @opindex mmul64
14985 Generate @code{mul64} and @code{mulu64} instructions.  
14986 Only valid for @option{-mcpu=ARC600}.
14988 @item -mnorm
14989 @opindex mnorm
14990 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14991 is in effect.
14993 @item -mspfp
14994 @opindex mspfp
14995 @itemx -mspfp-compact
14996 @opindex mspfp-compact
14997 Generate single-precision FPX instructions, tuned for the compact
14998 implementation.
15000 @item -mspfp-fast
15001 @opindex mspfp-fast
15002 Generate single-precision FPX instructions, tuned for the fast
15003 implementation.
15005 @item -msimd
15006 @opindex msimd
15007 Enable generation of ARC SIMD instructions via target-specific
15008 builtins.  Only valid for @option{-mcpu=ARC700}.
15010 @item -msoft-float
15011 @opindex msoft-float
15012 This option ignored; it is provided for compatibility purposes only.
15013 Software floating-point code is emitted by default, and this default
15014 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15015 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15016 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15018 @item -mswap
15019 @opindex mswap
15020 Generate @code{swap} instructions.
15022 @item -matomic
15023 @opindex matomic
15024 This enables use of the locked load/store conditional extension to implement
15025 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15026 EM cores.
15028 @item -mdiv-rem
15029 @opindex mdiv-rem
15030 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15032 @item -mcode-density
15033 @opindex mcode-density
15034 Enable code density instructions for ARC EM.  
15035 This option is on by default for ARC HS.
15037 @item -mll64
15038 @opindex mll64
15039 Enable double load/store operations for ARC HS cores.
15041 @item -mtp-regno=@var{regno}
15042 @opindex mtp-regno
15043 Specify thread pointer register number.
15045 @item -mmpy-option=@var{multo}
15046 @opindex mmpy-option
15047 Compile ARCv2 code with a multiplier design option.  You can specify 
15048 the option using either a string or numeric value for @var{multo}.  
15049 @samp{wlh1} is the default value.  The recognized values are:
15051 @table @samp
15052 @item 0
15053 @itemx none
15054 No multiplier available.
15056 @item 1
15057 @itemx w
15058 16x16 multiplier, fully pipelined.
15059 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15061 @item 2
15062 @itemx wlh1
15063 32x32 multiplier, fully
15064 pipelined (1 stage).  The following instructions are additionally
15065 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15067 @item 3
15068 @itemx wlh2
15069 32x32 multiplier, fully pipelined
15070 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15071 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15073 @item 4
15074 @itemx wlh3
15075 Two 16x16 multipliers, blocking,
15076 sequential.  The following instructions are additionally enabled: @code{mpy},
15077 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15079 @item 5
15080 @itemx wlh4
15081 One 16x16 multiplier, blocking,
15082 sequential.  The following instructions are additionally enabled: @code{mpy},
15083 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15085 @item 6
15086 @itemx wlh5
15087 One 32x4 multiplier, blocking,
15088 sequential.  The following instructions are additionally enabled: @code{mpy},
15089 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15091 @item 7
15092 @itemx plus_dmpy
15093 ARC HS SIMD support.
15095 @item 8
15096 @itemx plus_macd
15097 ARC HS SIMD support.
15099 @item 9
15100 @itemx plus_qmacw
15101 ARC HS SIMD support.
15103 @end table
15105 This option is only available for ARCv2 cores@.
15107 @item -mfpu=@var{fpu}
15108 @opindex mfpu
15109 Enables support for specific floating-point hardware extensions for ARCv2
15110 cores.  Supported values for @var{fpu} are:
15112 @table @samp
15114 @item fpus
15115 Enables support for single-precision floating-point hardware
15116 extensions@.
15118 @item fpud
15119 Enables support for double-precision floating-point hardware
15120 extensions.  The single-precision floating-point extension is also
15121 enabled.  Not available for ARC EM@.
15123 @item fpuda
15124 Enables support for double-precision floating-point hardware
15125 extensions using double-precision assist instructions.  The single-precision
15126 floating-point extension is also enabled.  This option is
15127 only available for ARC EM@.
15129 @item fpuda_div
15130 Enables support for double-precision floating-point hardware
15131 extensions using double-precision assist instructions.
15132 The single-precision floating-point, square-root, and divide 
15133 extensions are also enabled.  This option is
15134 only available for ARC EM@.
15136 @item fpuda_fma
15137 Enables support for double-precision floating-point hardware
15138 extensions using double-precision assist instructions.
15139 The single-precision floating-point and fused multiply and add 
15140 hardware extensions are also enabled.  This option is
15141 only available for ARC EM@.
15143 @item fpuda_all
15144 Enables support for double-precision floating-point hardware
15145 extensions using double-precision assist instructions.
15146 All single-precision floating-point hardware extensions are also
15147 enabled.  This option is only available for ARC EM@.
15149 @item fpus_div
15150 Enables support for single-precision floating-point, square-root and divide 
15151 hardware extensions@.
15153 @item fpud_div
15154 Enables support for double-precision floating-point, square-root and divide 
15155 hardware extensions.  This option
15156 includes option @samp{fpus_div}. Not available for ARC EM@.
15158 @item fpus_fma
15159 Enables support for single-precision floating-point and 
15160 fused multiply and add hardware extensions@.
15162 @item fpud_fma
15163 Enables support for double-precision floating-point and 
15164 fused multiply and add hardware extensions.  This option
15165 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15167 @item fpus_all
15168 Enables support for all single-precision floating-point hardware
15169 extensions@.
15171 @item fpud_all
15172 Enables support for all single- and double-precision floating-point
15173 hardware extensions.  Not available for ARC EM@.
15175 @end table
15177 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15178 @opindex mirq-ctrl-saved
15179 Specifies general-purposes registers that the processor automatically
15180 saves/restores on interrupt entry and exit.  @var{register-range} is
15181 specified as two registers separated by a dash.  The register range
15182 always starts with @code{r0}, the upper limit is @code{fp} register.
15183 @var{blink} and @var{lp_count} are optional.  This option is only
15184 valid for ARC EM and ARC HS cores.
15186 @item -mrgf-banked-regs=@var{number}
15187 @opindex mrgf-banked-regs
15188 Specifies the number of registers replicated in second register bank
15189 on entry to fast interrupt.  Fast interrupts are interrupts with the
15190 highest priority level P0.  These interrupts save only PC and STATUS32
15191 registers to avoid memory transactions during interrupt entry and exit
15192 sequences.  Use this option when you are using fast interrupts in an
15193 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15195 @item -mlpc-width=@var{width}
15196 @opindex mlpc-width
15197 Specify the width of the @code{lp_count} register.  Valid values for
15198 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15199 fixed to 32 bits.  If the width is less than 32, the compiler does not
15200 attempt to transform loops in your program to use the zero-delay loop
15201 mechanism unless it is known that the @code{lp_count} register can
15202 hold the required loop-counter value.  Depending on the width
15203 specified, the compiler and run-time library might continue to use the
15204 loop mechanism for various needs.  This option defines macro
15205 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15207 @end table
15209 The following options are passed through to the assembler, and also
15210 define preprocessor macro symbols.
15212 @c Flags used by the assembler, but for which we define preprocessor
15213 @c macro symbols as well.
15214 @table @gcctabopt
15215 @item -mdsp-packa
15216 @opindex mdsp-packa
15217 Passed down to the assembler to enable the DSP Pack A extensions.
15218 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15219 deprecated.
15221 @item -mdvbf
15222 @opindex mdvbf
15223 Passed down to the assembler to enable the dual Viterbi butterfly
15224 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15225 option is deprecated.
15227 @c ARC700 4.10 extension instruction
15228 @item -mlock
15229 @opindex mlock
15230 Passed down to the assembler to enable the locked load/store
15231 conditional extension.  Also sets the preprocessor symbol
15232 @code{__Xlock}.
15234 @item -mmac-d16
15235 @opindex mmac-d16
15236 Passed down to the assembler.  Also sets the preprocessor symbol
15237 @code{__Xxmac_d16}.  This option is deprecated.
15239 @item -mmac-24
15240 @opindex mmac-24
15241 Passed down to the assembler.  Also sets the preprocessor symbol
15242 @code{__Xxmac_24}.  This option is deprecated.
15244 @c ARC700 4.10 extension instruction
15245 @item -mrtsc
15246 @opindex mrtsc
15247 Passed down to the assembler to enable the 64-bit time-stamp counter
15248 extension instruction.  Also sets the preprocessor symbol
15249 @code{__Xrtsc}.  This option is deprecated.
15251 @c ARC700 4.10 extension instruction
15252 @item -mswape
15253 @opindex mswape
15254 Passed down to the assembler to enable the swap byte ordering
15255 extension instruction.  Also sets the preprocessor symbol
15256 @code{__Xswape}.
15258 @item -mtelephony
15259 @opindex mtelephony
15260 Passed down to the assembler to enable dual- and single-operand
15261 instructions for telephony.  Also sets the preprocessor symbol
15262 @code{__Xtelephony}.  This option is deprecated.
15264 @item -mxy
15265 @opindex mxy
15266 Passed down to the assembler to enable the XY memory extension.  Also
15267 sets the preprocessor symbol @code{__Xxy}.
15269 @end table
15271 The following options control how the assembly code is annotated:
15273 @c Assembly annotation options
15274 @table @gcctabopt
15275 @item -misize
15276 @opindex misize
15277 Annotate assembler instructions with estimated addresses.
15279 @item -mannotate-align
15280 @opindex mannotate-align
15281 Explain what alignment considerations lead to the decision to make an
15282 instruction short or long.
15284 @end table
15286 The following options are passed through to the linker:
15288 @c options passed through to the linker
15289 @table @gcctabopt
15290 @item -marclinux
15291 @opindex marclinux
15292 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15293 This option is enabled by default in tool chains built for
15294 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15295 when profiling is not requested.
15297 @item -marclinux_prof
15298 @opindex marclinux_prof
15299 Passed through to the linker, to specify use of the
15300 @code{arclinux_prof} emulation.  This option is enabled by default in
15301 tool chains built for @w{@code{arc-linux-uclibc}} and
15302 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15304 @end table
15306 The following options control the semantics of generated code:
15308 @c semantically relevant code generation options
15309 @table @gcctabopt
15310 @item -mlong-calls
15311 @opindex mlong-calls
15312 Generate calls as register indirect calls, thus providing access
15313 to the full 32-bit address range.
15315 @item -mmedium-calls
15316 @opindex mmedium-calls
15317 Don't use less than 25-bit addressing range for calls, which is the
15318 offset available for an unconditional branch-and-link
15319 instruction.  Conditional execution of function calls is suppressed, to
15320 allow use of the 25-bit range, rather than the 21-bit range with
15321 conditional branch-and-link.  This is the default for tool chains built
15322 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15324 @item -G @var{num}
15325 @opindex G
15326 Put definitions of externally-visible data in a small data section if
15327 that data is no bigger than @var{num} bytes.  The default value of
15328 @var{num} is 4 for any ARC configuration, or 8 when we have double
15329 load/store operations.
15331 @item -mno-sdata
15332 @opindex mno-sdata
15333 Do not generate sdata references.  This is the default for tool chains
15334 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15335 targets.
15337 @item -mvolatile-cache
15338 @opindex mvolatile-cache
15339 Use ordinarily cached memory accesses for volatile references.  This is the
15340 default.
15342 @item -mno-volatile-cache
15343 @opindex mno-volatile-cache
15344 Enable cache bypass for volatile references.
15346 @end table
15348 The following options fine tune code generation:
15349 @c code generation tuning options
15350 @table @gcctabopt
15351 @item -malign-call
15352 @opindex malign-call
15353 Do alignment optimizations for call instructions.
15355 @item -mauto-modify-reg
15356 @opindex mauto-modify-reg
15357 Enable the use of pre/post modify with register displacement.
15359 @item -mbbit-peephole
15360 @opindex mbbit-peephole
15361 Enable bbit peephole2.
15363 @item -mno-brcc
15364 @opindex mno-brcc
15365 This option disables a target-specific pass in @file{arc_reorg} to
15366 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15367 It has no effect on
15368 generation of these instructions driven by the combiner pass.
15370 @item -mcase-vector-pcrel
15371 @opindex mcase-vector-pcrel
15372 Use PC-relative switch case tables to enable case table shortening.
15373 This is the default for @option{-Os}.
15375 @item -mcompact-casesi
15376 @opindex mcompact-casesi
15377 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15378 and only available for ARCv1 cores.
15380 @item -mno-cond-exec
15381 @opindex mno-cond-exec
15382 Disable the ARCompact-specific pass to generate conditional 
15383 execution instructions.
15385 Due to delay slot scheduling and interactions between operand numbers,
15386 literal sizes, instruction lengths, and the support for conditional execution,
15387 the target-independent pass to generate conditional execution is often lacking,
15388 so the ARC port has kept a special pass around that tries to find more
15389 conditional execution generation opportunities after register allocation,
15390 branch shortening, and delay slot scheduling have been done.  This pass
15391 generally, but not always, improves performance and code size, at the cost of
15392 extra compilation time, which is why there is an option to switch it off.
15393 If you have a problem with call instructions exceeding their allowable
15394 offset range because they are conditionalized, you should consider using
15395 @option{-mmedium-calls} instead.
15397 @item -mearly-cbranchsi
15398 @opindex mearly-cbranchsi
15399 Enable pre-reload use of the @code{cbranchsi} pattern.
15401 @item -mexpand-adddi
15402 @opindex mexpand-adddi
15403 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15404 @code{add.f}, @code{adc} etc.  This option is deprecated.
15406 @item -mindexed-loads
15407 @opindex mindexed-loads
15408 Enable the use of indexed loads.  This can be problematic because some
15409 optimizers then assume that indexed stores exist, which is not
15410 the case.
15412 @item -mlra
15413 @opindex mlra
15414 Enable Local Register Allocation.  This is still experimental for ARC,
15415 so by default the compiler uses standard reload
15416 (i.e. @option{-mno-lra}).
15418 @item -mlra-priority-none
15419 @opindex mlra-priority-none
15420 Don't indicate any priority for target registers.
15422 @item -mlra-priority-compact
15423 @opindex mlra-priority-compact
15424 Indicate target register priority for r0..r3 / r12..r15.
15426 @item -mlra-priority-noncompact
15427 @opindex mlra-priority-noncompact
15428 Reduce target register priority for r0..r3 / r12..r15.
15430 @item -mno-millicode
15431 @opindex mno-millicode
15432 When optimizing for size (using @option{-Os}), prologues and epilogues
15433 that have to save or restore a large number of registers are often
15434 shortened by using call to a special function in libgcc; this is
15435 referred to as a @emph{millicode} call.  As these calls can pose
15436 performance issues, and/or cause linking issues when linking in a
15437 nonstandard way, this option is provided to turn off millicode call
15438 generation.
15440 @item -mmixed-code
15441 @opindex mmixed-code
15442 Tweak register allocation to help 16-bit instruction generation.
15443 This generally has the effect of decreasing the average instruction size
15444 while increasing the instruction count.
15446 @item -mq-class
15447 @opindex mq-class
15448 Enable @samp{q} instruction alternatives.
15449 This is the default for @option{-Os}.
15451 @item -mRcq
15452 @opindex mRcq
15453 Enable @samp{Rcq} constraint handling.  
15454 Most short code generation depends on this.
15455 This is the default.
15457 @item -mRcw
15458 @opindex mRcw
15459 Enable @samp{Rcw} constraint handling.  
15460 Most ccfsm condexec mostly depends on this.
15461 This is the default.
15463 @item -msize-level=@var{level}
15464 @opindex msize-level
15465 Fine-tune size optimization with regards to instruction lengths and alignment.
15466 The recognized values for @var{level} are:
15467 @table @samp
15468 @item 0
15469 No size optimization.  This level is deprecated and treated like @samp{1}.
15471 @item 1
15472 Short instructions are used opportunistically.
15474 @item 2
15475 In addition, alignment of loops and of code after barriers are dropped.
15477 @item 3
15478 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15480 @end table
15482 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15483 the behavior when this is not set is equivalent to level @samp{1}.
15485 @item -mtune=@var{cpu}
15486 @opindex mtune
15487 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15488 by @option{-mcpu=}.
15490 Supported values for @var{cpu} are
15492 @table @samp
15493 @item ARC600
15494 Tune for ARC600 CPU.
15496 @item ARC601
15497 Tune for ARC601 CPU.
15499 @item ARC700
15500 Tune for ARC700 CPU with standard multiplier block.
15502 @item ARC700-xmac
15503 Tune for ARC700 CPU with XMAC block.
15505 @item ARC725D
15506 Tune for ARC725D CPU.
15508 @item ARC750D
15509 Tune for ARC750D CPU.
15511 @end table
15513 @item -mmultcost=@var{num}
15514 @opindex mmultcost
15515 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15516 normal instruction.
15518 @item -munalign-prob-threshold=@var{probability}
15519 @opindex munalign-prob-threshold
15520 Set probability threshold for unaligning branches.
15521 When tuning for @samp{ARC700} and optimizing for speed, branches without
15522 filled delay slot are preferably emitted unaligned and long, unless
15523 profiling indicates that the probability for the branch to be taken
15524 is below @var{probability}.  @xref{Cross-profiling}.
15525 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15527 @end table
15529 The following options are maintained for backward compatibility, but
15530 are now deprecated and will be removed in a future release:
15532 @c Deprecated options
15533 @table @gcctabopt
15535 @item -margonaut
15536 @opindex margonaut
15537 Obsolete FPX.
15539 @item -mbig-endian
15540 @opindex mbig-endian
15541 @itemx -EB
15542 @opindex EB
15543 Compile code for big-endian targets.  Use of these options is now
15544 deprecated.  Big-endian code is supported by configuring GCC to build
15545 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15546 for which big endian is the default.
15548 @item -mlittle-endian
15549 @opindex mlittle-endian
15550 @itemx -EL
15551 @opindex EL
15552 Compile code for little-endian targets.  Use of these options is now
15553 deprecated.  Little-endian code is supported by configuring GCC to build 
15554 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15555 for which little endian is the default.
15557 @item -mbarrel_shifter
15558 @opindex mbarrel_shifter
15559 Replaced by @option{-mbarrel-shifter}.
15561 @item -mdpfp_compact
15562 @opindex mdpfp_compact
15563 Replaced by @option{-mdpfp-compact}.
15565 @item -mdpfp_fast
15566 @opindex mdpfp_fast
15567 Replaced by @option{-mdpfp-fast}.
15569 @item -mdsp_packa
15570 @opindex mdsp_packa
15571 Replaced by @option{-mdsp-packa}.
15573 @item -mEA
15574 @opindex mEA
15575 Replaced by @option{-mea}.
15577 @item -mmac_24
15578 @opindex mmac_24
15579 Replaced by @option{-mmac-24}.
15581 @item -mmac_d16
15582 @opindex mmac_d16
15583 Replaced by @option{-mmac-d16}.
15585 @item -mspfp_compact
15586 @opindex mspfp_compact
15587 Replaced by @option{-mspfp-compact}.
15589 @item -mspfp_fast
15590 @opindex mspfp_fast
15591 Replaced by @option{-mspfp-fast}.
15593 @item -mtune=@var{cpu}
15594 @opindex mtune
15595 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15596 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15597 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15599 @item -multcost=@var{num}
15600 @opindex multcost
15601 Replaced by @option{-mmultcost}.
15603 @end table
15605 @node ARM Options
15606 @subsection ARM Options
15607 @cindex ARM options
15609 These @samp{-m} options are defined for the ARM port:
15611 @table @gcctabopt
15612 @item -mabi=@var{name}
15613 @opindex mabi
15614 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15615 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15617 @item -mapcs-frame
15618 @opindex mapcs-frame
15619 Generate a stack frame that is compliant with the ARM Procedure Call
15620 Standard for all functions, even if this is not strictly necessary for
15621 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15622 with this option causes the stack frames not to be generated for
15623 leaf functions.  The default is @option{-mno-apcs-frame}.
15624 This option is deprecated.
15626 @item -mapcs
15627 @opindex mapcs
15628 This is a synonym for @option{-mapcs-frame} and is deprecated.
15630 @ignore
15631 @c not currently implemented
15632 @item -mapcs-stack-check
15633 @opindex mapcs-stack-check
15634 Generate code to check the amount of stack space available upon entry to
15635 every function (that actually uses some stack space).  If there is
15636 insufficient space available then either the function
15637 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15638 called, depending upon the amount of stack space required.  The runtime
15639 system is required to provide these functions.  The default is
15640 @option{-mno-apcs-stack-check}, since this produces smaller code.
15642 @c not currently implemented
15643 @item -mapcs-reentrant
15644 @opindex mapcs-reentrant
15645 Generate reentrant, position-independent code.  The default is
15646 @option{-mno-apcs-reentrant}.
15647 @end ignore
15649 @item -mthumb-interwork
15650 @opindex mthumb-interwork
15651 Generate code that supports calling between the ARM and Thumb
15652 instruction sets.  Without this option, on pre-v5 architectures, the
15653 two instruction sets cannot be reliably used inside one program.  The
15654 default is @option{-mno-thumb-interwork}, since slightly larger code
15655 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15656 configurations this option is meaningless.
15658 @item -mno-sched-prolog
15659 @opindex mno-sched-prolog
15660 Prevent the reordering of instructions in the function prologue, or the
15661 merging of those instruction with the instructions in the function's
15662 body.  This means that all functions start with a recognizable set
15663 of instructions (or in fact one of a choice from a small set of
15664 different function prologues), and this information can be used to
15665 locate the start of functions inside an executable piece of code.  The
15666 default is @option{-msched-prolog}.
15668 @item -mfloat-abi=@var{name}
15669 @opindex mfloat-abi
15670 Specifies which floating-point ABI to use.  Permissible values
15671 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15673 Specifying @samp{soft} causes GCC to generate output containing
15674 library calls for floating-point operations.
15675 @samp{softfp} allows the generation of code using hardware floating-point
15676 instructions, but still uses the soft-float calling conventions.
15677 @samp{hard} allows generation of floating-point instructions
15678 and uses FPU-specific calling conventions.
15680 The default depends on the specific target configuration.  Note that
15681 the hard-float and soft-float ABIs are not link-compatible; you must
15682 compile your entire program with the same ABI, and link with a
15683 compatible set of libraries.
15685 @item -mlittle-endian
15686 @opindex mlittle-endian
15687 Generate code for a processor running in little-endian mode.  This is
15688 the default for all standard configurations.
15690 @item -mbig-endian
15691 @opindex mbig-endian
15692 Generate code for a processor running in big-endian mode; the default is
15693 to compile code for a little-endian processor.
15695 @item -mbe8
15696 @itemx -mbe32
15697 @opindex mbe8
15698 When linking a big-endian image select between BE8 and BE32 formats.
15699 The option has no effect for little-endian images and is ignored.  The
15700 default is dependent on the selected target architecture.  For ARMv6
15701 and later architectures the default is BE8, for older architectures
15702 the default is BE32.  BE32 format has been deprecated by ARM.
15704 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15705 @opindex march
15706 This specifies the name of the target ARM architecture.  GCC uses this
15707 name to determine what kind of instructions it can emit when generating
15708 assembly code.  This option can be used in conjunction with or instead
15709 of the @option{-mcpu=} option.
15711 Permissible names are:
15712 @samp{armv4t},
15713 @samp{armv5t}, @samp{armv5te},
15714 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15715 @samp{armv6z}, @samp{armv6zk},
15716 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15717 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15718 @samp{armv8.4-a},
15719 @samp{armv7-r},
15720 @samp{armv8-r},
15721 @samp{armv6-m}, @samp{armv6s-m},
15722 @samp{armv7-m}, @samp{armv7e-m},
15723 @samp{armv8-m.base}, @samp{armv8-m.main},
15724 @samp{iwmmxt} and @samp{iwmmxt2}.
15726 Additionally, the following architectures, which lack support for the
15727 Thumb execution state, are recognized but support is deprecated:
15728 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15729 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15731 Many of the architectures support extensions.  These can be added by
15732 appending @samp{+@var{extension}} to the architecture name.  Extension
15733 options are processed in order and capabilities accumulate.  An extension
15734 will also enable any necessary base extensions
15735 upon which it depends.  For example, the @samp{+crypto} extension
15736 will always enable the @samp{+simd} extension.  The exception to the
15737 additive construction is for extensions that are prefixed with
15738 @samp{+no@dots{}}: these extensions disable the specified option and
15739 any other extensions that may depend on the presence of that
15740 extension.
15742 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15743 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15744 entirely disabled by the @samp{+nofp} option that follows it.
15746 Most extension names are generically named, but have an effect that is
15747 dependent upon the architecture to which it is applied.  For example,
15748 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15749 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15750 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15751 variant for @samp{armv8-a}.
15753 The table below lists the supported extensions for each architecture.
15754 Architectures not mentioned do not support any extensions.
15756 @table @samp
15757 @item  armv5e
15758 @itemx armv5te
15759 @itemx armv6
15760 @itemx armv6j
15761 @itemx armv6k
15762 @itemx armv6kz
15763 @itemx armv6t2
15764 @itemx armv6z
15765 @itemx armv6zk
15766 @table @samp
15767 @item +fp
15768 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15769 used as an alias for this extension.
15771 @item +nofp
15772 Disable the floating-point instructions.
15773 @end table
15775 @item armv7
15776 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15777 @table @samp
15778 @item +fp
15779 The VFPv3 floating-point instructions, with 16 double-precision
15780 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15781 for this extension.  Note that floating-point is not supported by the
15782 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15783 ARMv7-R architectures.
15785 @item +nofp
15786 Disable the floating-point instructions.
15787 @end table
15789 @item armv7-a
15790 @table @samp
15791 @item +fp
15792 The VFPv3 floating-point instructions, with 16 double-precision
15793 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15794 for this extension.
15796 @item +simd
15797 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15798 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15799 for this extension.
15801 @item +vfpv3
15802 The VFPv3 floating-point instructions, with 32 double-precision
15803 registers.
15805 @item +vfpv3-d16-fp16
15806 The VFPv3 floating-point instructions, with 16 double-precision
15807 registers and the half-precision floating-point conversion operations.
15809 @item +vfpv3-fp16
15810 The VFPv3 floating-point instructions, with 32 double-precision
15811 registers and the half-precision floating-point conversion operations.
15813 @item +vfpv4-d16
15814 The VFPv4 floating-point instructions, with 16 double-precision
15815 registers.
15817 @item +vfpv4
15818 The VFPv4 floating-point instructions, with 32 double-precision
15819 registers.
15821 @item +neon-fp16
15822 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15823 the half-precision floating-point conversion operations.
15825 @item +neon-vfpv4
15826 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15828 @item +nosimd
15829 Disable the Advanced SIMD instructions (does not disable floating point).
15831 @item +nofp
15832 Disable the floating-point and Advanced SIMD instructions.
15833 @end table
15835 @item armv7ve
15836 The extended version of the ARMv7-A architecture with support for
15837 virtualization.
15838 @table @samp
15839 @item +fp
15840 The VFPv4 floating-point instructions, with 16 double-precision registers.
15841 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15843 @item +simd
15844 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15845 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15847 @item +vfpv3-d16
15848 The VFPv3 floating-point instructions, with 16 double-precision
15849 registers.
15851 @item +vfpv3
15852 The VFPv3 floating-point instructions, with 32 double-precision
15853 registers.
15855 @item +vfpv3-d16-fp16
15856 The VFPv3 floating-point instructions, with 16 double-precision
15857 registers and the half-precision floating-point conversion operations.
15859 @item +vfpv3-fp16
15860 The VFPv3 floating-point instructions, with 32 double-precision
15861 registers and the half-precision floating-point conversion operations.
15863 @item +vfpv4-d16
15864 The VFPv4 floating-point instructions, with 16 double-precision
15865 registers.
15867 @item +vfpv4
15868 The VFPv4 floating-point instructions, with 32 double-precision
15869 registers.
15871 @item +neon
15872 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15873 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15875 @item +neon-fp16
15876 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15877 the half-precision floating-point conversion operations.
15879 @item +nosimd
15880 Disable the Advanced SIMD instructions (does not disable floating point).
15882 @item +nofp
15883 Disable the floating-point and Advanced SIMD instructions.
15884 @end table
15886 @item armv8-a
15887 @table @samp
15888 @item +crc
15889 The Cyclic Redundancy Check (CRC) instructions.
15890 @item +simd
15891 The ARMv8-A Advanced SIMD and floating-point instructions.
15892 @item +crypto
15893 The cryptographic instructions.
15894 @item +nocrypto
15895 Disable the cryptographic instructions.
15896 @item +nofp
15897 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15898 @end table
15900 @item armv8.1-a
15901 @table @samp
15902 @item +simd
15903 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15905 @item +crypto
15906 The cryptographic instructions.  This also enables the Advanced SIMD and
15907 floating-point instructions.
15909 @item +nocrypto
15910 Disable the cryptographic instructions.
15912 @item +nofp
15913 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15914 @end table
15916 @item armv8.2-a
15917 @itemx armv8.3-a
15918 @table @samp
15919 @item +fp16
15920 The half-precision floating-point data processing instructions.
15921 This also enables the Advanced SIMD and floating-point instructions.
15923 @item +fp16fml
15924 The half-precision floating-point fmla extension.  This also enables
15925 the half-precision floating-point extension and Advanced SIMD and
15926 floating-point instructions.
15928 @item +simd
15929 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15931 @item +crypto
15932 The cryptographic instructions.  This also enables the Advanced SIMD and
15933 floating-point instructions.
15935 @item +dotprod
15936 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15938 @item +nocrypto
15939 Disable the cryptographic extension.
15941 @item +nofp
15942 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15943 @end table
15945 @item armv8.4-a
15946 @table @samp
15947 @item +fp16
15948 The half-precision floating-point data processing instructions.
15949 This also enables the Advanced SIMD and floating-point instructions as well
15950 as the Dot Product extension and the half-precision floating-point fmla
15951 extension.
15953 @item +simd
15954 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
15955 Dot Product extension.
15957 @item +crypto
15958 The cryptographic instructions.  This also enables the Advanced SIMD and
15959 floating-point instructions as well as the Dot Product extension.
15961 @item +nocrypto
15962 Disable the cryptographic extension.
15964 @item +nofp
15965 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15966 @end table
15968 @item armv7-r
15969 @table @samp
15970 @item +fp.sp
15971 The single-precision VFPv3 floating-point instructions.  The extension
15972 @samp{+vfpv3xd} can be used as an alias for this extension.
15974 @item +fp
15975 The VFPv3 floating-point instructions with 16 double-precision registers.
15976 The extension +vfpv3-d16 can be used as an alias for this extension.
15978 @item +nofp
15979 Disable the floating-point extension.
15981 @item +idiv
15982 The ARM-state integer division instructions.
15984 @item +noidiv
15985 Disable the ARM-state integer division extension.
15986 @end table
15988 @item armv7e-m
15989 @table @samp
15990 @item +fp
15991 The single-precision VFPv4 floating-point instructions.
15993 @item +fpv5
15994 The single-precision FPv5 floating-point instructions.
15996 @item +fp.dp
15997 The single- and double-precision FPv5 floating-point instructions.
15999 @item +nofp
16000 Disable the floating-point extensions.
16001 @end table
16003 @item  armv8-m.main
16004 @table @samp
16005 @item +dsp
16006 The DSP instructions.
16008 @item +nodsp
16009 Disable the DSP extension.
16011 @item +fp
16012 The single-precision floating-point instructions.
16014 @item +fp.dp
16015 The single- and double-precision floating-point instructions.
16017 @item +nofp
16018 Disable the floating-point extension.
16019 @end table
16021 @item armv8-r
16022 @table @samp
16023 @item +crc
16024 The Cyclic Redundancy Check (CRC) instructions.
16025 @item +fp.sp
16026 The single-precision FPv5 floating-point instructions.
16027 @item +simd
16028 The ARMv8-A Advanced SIMD and floating-point instructions.
16029 @item +crypto
16030 The cryptographic instructions.
16031 @item +nocrypto
16032 Disable the cryptographic instructions.
16033 @item +nofp
16034 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16035 @end table
16037 @end table
16039 @option{-march=native} causes the compiler to auto-detect the architecture
16040 of the build computer.  At present, this feature is only supported on
16041 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16042 is unsuccessful the option has no effect.
16044 @item -mtune=@var{name}
16045 @opindex mtune
16046 This option specifies the name of the target ARM processor for
16047 which GCC should tune the performance of the code.
16048 For some ARM implementations better performance can be obtained by using
16049 this option.
16050 Permissible names are: @samp{arm2}, @samp{arm250},
16051 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16052 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16053 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16054 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16055 @samp{arm720},
16056 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16057 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16058 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16059 @samp{strongarm1110},
16060 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16061 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16062 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16063 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16064 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16065 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16066 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16067 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16068 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16069 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16070 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16071 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16072 @samp{cortex-r8}, @samp{cortex-r52},
16073 @samp{cortex-m33},
16074 @samp{cortex-m23},
16075 @samp{cortex-m7},
16076 @samp{cortex-m4},
16077 @samp{cortex-m3},
16078 @samp{cortex-m1},
16079 @samp{cortex-m0},
16080 @samp{cortex-m0plus},
16081 @samp{cortex-m1.small-multiply},
16082 @samp{cortex-m0.small-multiply},
16083 @samp{cortex-m0plus.small-multiply},
16084 @samp{exynos-m1},
16085 @samp{marvell-pj4},
16086 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16087 @samp{fa526}, @samp{fa626},
16088 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16089 @samp{xgene1}.
16091 Additionally, this option can specify that GCC should tune the performance
16092 of the code for a big.LITTLE system.  Permissible names are:
16093 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16094 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16095 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16096 @samp{cortex-a75.cortex-a55}.
16098 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16099 performance for a blend of processors within architecture @var{arch}.
16100 The aim is to generate code that run well on the current most popular
16101 processors, balancing between optimizations that benefit some CPUs in the
16102 range, and avoiding performance pitfalls of other CPUs.  The effects of
16103 this option may change in future GCC versions as CPU models come and go.
16105 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16106 the extension options do not affect the tuning of the generated code.
16108 @option{-mtune=native} causes the compiler to auto-detect the CPU
16109 of the build computer.  At present, this feature is only supported on
16110 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16111 unsuccessful the option has no effect.
16113 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16114 @opindex mcpu
16115 This specifies the name of the target ARM processor.  GCC uses this name
16116 to derive the name of the target ARM architecture (as if specified
16117 by @option{-march}) and the ARM processor type for which to tune for
16118 performance (as if specified by @option{-mtune}).  Where this option
16119 is used in conjunction with @option{-march} or @option{-mtune},
16120 those options take precedence over the appropriate part of this option.
16122 Many of the supported CPUs implement optional architectural
16123 extensions.  Where this is so the architectural extensions are
16124 normally enabled by default.  If implementations that lack the
16125 extension exist, then the extension syntax can be used to disable
16126 those extensions that have been omitted.  For floating-point and
16127 Advanced SIMD (Neon) instructions, the settings of the options
16128 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16129 floating-point and Advanced SIMD instructions will only be used if
16130 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16131 @option{-mfpu} other than @samp{auto} will override the available
16132 floating-point and SIMD extension instructions.
16134 For example, @samp{cortex-a9} can be found in three major
16135 configurations: integer only, with just a floating-point unit or with
16136 floating-point and Advanced SIMD.  The default is to enable all the
16137 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16138 be used to disable just the SIMD or both the SIMD and floating-point
16139 instructions respectively.
16141 Permissible names for this option are the same as those for
16142 @option{-mtune}.
16144 The following extension options are common to the listed CPUs:
16146 @table @samp
16147 @item +nodsp
16148 Disable the DSP instructions on @samp{cortex-m33}.
16150 @item  +nofp
16151 Disables the floating-point instructions on @samp{arm9e},
16152 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16153 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16154 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16155 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16156 Disables the floating-point and SIMD instructions on
16157 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16158 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16159 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16160 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16161 @samp{cortex-a53} and @samp{cortex-a55}.
16163 @item +nofp.dp
16164 Disables the double-precision component of the floating-point instructions
16165 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16167 @item +nosimd
16168 Disables the SIMD (but not floating-point) instructions on
16169 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16170 and @samp{cortex-a9}.
16172 @item +crypto
16173 Enables the cryptographic instructions on @samp{cortex-a32},
16174 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16175 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16176 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16177 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16178 @samp{cortex-a75.cortex-a55}.
16179 @end table
16181 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16182 VFPv3 with 16 double-precision registers.  It supports the following
16183 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16184 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16185 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16186 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16187 @option{-march=armv7-a}.
16189 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16190 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16191 See @option{-mtune} for more information.
16193 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16194 of the build computer.  At present, this feature is only supported on
16195 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16196 is unsuccessful the option has no effect.
16198 @item -mfpu=@var{name}
16199 @opindex mfpu
16200 This specifies what floating-point hardware (or hardware emulation) is
16201 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16202 @samp{vfpv3},
16203 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16204 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16205 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16206 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16207 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16208 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16209 is an alias for @samp{vfpv2}.
16211 The setting @samp{auto} is the default and is special.  It causes the
16212 compiler to select the floating-point and Advanced SIMD instructions
16213 based on the settings of @option{-mcpu} and @option{-march}.
16215 If the selected floating-point hardware includes the NEON extension
16216 (e.g. @option{-mfpu=neon}), note that floating-point
16217 operations are not generated by GCC's auto-vectorization pass unless
16218 @option{-funsafe-math-optimizations} is also specified.  This is
16219 because NEON hardware does not fully implement the IEEE 754 standard for
16220 floating-point arithmetic (in particular denormal values are treated as
16221 zero), so the use of NEON instructions may lead to a loss of precision.
16223 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}).
16225 @item -mfp16-format=@var{name}
16226 @opindex mfp16-format
16227 Specify the format of the @code{__fp16} half-precision floating-point type.
16228 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16229 the default is @samp{none}, in which case the @code{__fp16} type is not
16230 defined.  @xref{Half-Precision}, for more information.
16232 @item -mstructure-size-boundary=@var{n}
16233 @opindex mstructure-size-boundary
16234 The sizes of all structures and unions are rounded up to a multiple
16235 of the number of bits set by this option.  Permissible values are 8, 32
16236 and 64.  The default value varies for different toolchains.  For the COFF
16237 targeted toolchain the default value is 8.  A value of 64 is only allowed
16238 if the underlying ABI supports it.
16240 Specifying a larger number can produce faster, more efficient code, but
16241 can also increase the size of the program.  Different values are potentially
16242 incompatible.  Code compiled with one value cannot necessarily expect to
16243 work with code or libraries compiled with another value, if they exchange
16244 information using structures or unions.
16246 This option is deprecated.
16248 @item -mabort-on-noreturn
16249 @opindex mabort-on-noreturn
16250 Generate a call to the function @code{abort} at the end of a
16251 @code{noreturn} function.  It is executed if the function tries to
16252 return.
16254 @item -mlong-calls
16255 @itemx -mno-long-calls
16256 @opindex mlong-calls
16257 @opindex mno-long-calls
16258 Tells the compiler to perform function calls by first loading the
16259 address of the function into a register and then performing a subroutine
16260 call on this register.  This switch is needed if the target function
16261 lies outside of the 64-megabyte addressing range of the offset-based
16262 version of subroutine call instruction.
16264 Even if this switch is enabled, not all function calls are turned
16265 into long calls.  The heuristic is that static functions, functions
16266 that have the @code{short_call} attribute, functions that are inside
16267 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16268 definitions have already been compiled within the current compilation
16269 unit are not turned into long calls.  The exceptions to this rule are
16270 that weak function definitions, functions with the @code{long_call}
16271 attribute or the @code{section} attribute, and functions that are within
16272 the scope of a @code{#pragma long_calls} directive are always
16273 turned into long calls.
16275 This feature is not enabled by default.  Specifying
16276 @option{-mno-long-calls} restores the default behavior, as does
16277 placing the function calls within the scope of a @code{#pragma
16278 long_calls_off} directive.  Note these switches have no effect on how
16279 the compiler generates code to handle function calls via function
16280 pointers.
16282 @item -msingle-pic-base
16283 @opindex msingle-pic-base
16284 Treat the register used for PIC addressing as read-only, rather than
16285 loading it in the prologue for each function.  The runtime system is
16286 responsible for initializing this register with an appropriate value
16287 before execution begins.
16289 @item -mpic-register=@var{reg}
16290 @opindex mpic-register
16291 Specify the register to be used for PIC addressing.
16292 For standard PIC base case, the default is any suitable register
16293 determined by compiler.  For single PIC base case, the default is
16294 @samp{R9} if target is EABI based or stack-checking is enabled,
16295 otherwise the default is @samp{R10}.
16297 @item -mpic-data-is-text-relative
16298 @opindex mpic-data-is-text-relative
16299 Assume that the displacement between the text and data segments is fixed
16300 at static link time.  This permits using PC-relative addressing
16301 operations to access data known to be in the data segment.  For
16302 non-VxWorks RTP targets, this option is enabled by default.  When
16303 disabled on such targets, it will enable @option{-msingle-pic-base} by
16304 default.
16306 @item -mpoke-function-name
16307 @opindex mpoke-function-name
16308 Write the name of each function into the text section, directly
16309 preceding the function prologue.  The generated code is similar to this:
16311 @smallexample
16312      t0
16313          .ascii "arm_poke_function_name", 0
16314          .align
16315      t1
16316          .word 0xff000000 + (t1 - t0)
16317      arm_poke_function_name
16318          mov     ip, sp
16319          stmfd   sp!, @{fp, ip, lr, pc@}
16320          sub     fp, ip, #4
16321 @end smallexample
16323 When performing a stack backtrace, code can inspect the value of
16324 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16325 location @code{pc - 12} and the top 8 bits are set, then we know that
16326 there is a function name embedded immediately preceding this location
16327 and has length @code{((pc[-3]) & 0xff000000)}.
16329 @item -mthumb
16330 @itemx -marm
16331 @opindex marm
16332 @opindex mthumb
16334 Select between generating code that executes in ARM and Thumb
16335 states.  The default for most configurations is to generate code
16336 that executes in ARM state, but the default can be changed by
16337 configuring GCC with the @option{--with-mode=}@var{state}
16338 configure option.
16340 You can also override the ARM and Thumb mode for each function
16341 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16342 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16344 @item -mflip-thumb 
16345 @opindex mflip-thumb
16346 Switch ARM/Thumb modes on alternating functions.
16347 This option is provided for regression testing of mixed Thumb/ARM code
16348 generation, and is not intended for ordinary use in compiling code.
16350 @item -mtpcs-frame
16351 @opindex mtpcs-frame
16352 Generate a stack frame that is compliant with the Thumb Procedure Call
16353 Standard for all non-leaf functions.  (A leaf function is one that does
16354 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16356 @item -mtpcs-leaf-frame
16357 @opindex mtpcs-leaf-frame
16358 Generate a stack frame that is compliant with the Thumb Procedure Call
16359 Standard for all leaf functions.  (A leaf function is one that does
16360 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16362 @item -mcallee-super-interworking
16363 @opindex mcallee-super-interworking
16364 Gives all externally visible functions in the file being compiled an ARM
16365 instruction set header which switches to Thumb mode before executing the
16366 rest of the function.  This allows these functions to be called from
16367 non-interworking code.  This option is not valid in AAPCS configurations
16368 because interworking is enabled by default.
16370 @item -mcaller-super-interworking
16371 @opindex mcaller-super-interworking
16372 Allows calls via function pointers (including virtual functions) to
16373 execute correctly regardless of whether the target code has been
16374 compiled for interworking or not.  There is a small overhead in the cost
16375 of executing a function pointer if this option is enabled.  This option
16376 is not valid in AAPCS configurations because interworking is enabled
16377 by default.
16379 @item -mtp=@var{name}
16380 @opindex mtp
16381 Specify the access model for the thread local storage pointer.  The valid
16382 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16383 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16384 (supported in the arm6k architecture), and @samp{auto}, which uses the
16385 best available method for the selected processor.  The default setting is
16386 @samp{auto}.
16388 @item -mtls-dialect=@var{dialect}
16389 @opindex mtls-dialect
16390 Specify the dialect to use for accessing thread local storage.  Two
16391 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16392 @samp{gnu} dialect selects the original GNU scheme for supporting
16393 local and global dynamic TLS models.  The @samp{gnu2} dialect
16394 selects the GNU descriptor scheme, which provides better performance
16395 for shared libraries.  The GNU descriptor scheme is compatible with
16396 the original scheme, but does require new assembler, linker and
16397 library support.  Initial and local exec TLS models are unaffected by
16398 this option and always use the original scheme.
16400 @item -mword-relocations
16401 @opindex mword-relocations
16402 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16403 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16404 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16405 is specified.
16407 @item -mfix-cortex-m3-ldrd
16408 @opindex mfix-cortex-m3-ldrd
16409 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16410 with overlapping destination and base registers are used.  This option avoids
16411 generating these instructions.  This option is enabled by default when
16412 @option{-mcpu=cortex-m3} is specified.
16414 @item -munaligned-access
16415 @itemx -mno-unaligned-access
16416 @opindex munaligned-access
16417 @opindex mno-unaligned-access
16418 Enables (or disables) reading and writing of 16- and 32- bit values
16419 from addresses that are not 16- or 32- bit aligned.  By default
16420 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16421 ARMv8-M Baseline architectures, and enabled for all other
16422 architectures.  If unaligned access is not enabled then words in packed
16423 data structures are accessed a byte at a time.
16425 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16426 generated object file to either true or false, depending upon the
16427 setting of this option.  If unaligned access is enabled then the
16428 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16429 defined.
16431 @item -mneon-for-64bits
16432 @opindex mneon-for-64bits
16433 Enables using Neon to handle scalar 64-bits operations. This is
16434 disabled by default since the cost of moving data from core registers
16435 to Neon is high.
16437 @item -mslow-flash-data
16438 @opindex mslow-flash-data
16439 Assume loading data from flash is slower than fetching instruction.
16440 Therefore literal load is minimized for better performance.
16441 This option is only supported when compiling for ARMv7 M-profile and
16442 off by default.
16444 @item -masm-syntax-unified
16445 @opindex masm-syntax-unified
16446 Assume inline assembler is using unified asm syntax.  The default is
16447 currently off which implies divided syntax.  This option has no impact
16448 on Thumb2. However, this may change in future releases of GCC.
16449 Divided syntax should be considered deprecated.
16451 @item -mrestrict-it
16452 @opindex mrestrict-it
16453 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16454 IT blocks can only contain a single 16-bit instruction from a select
16455 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16457 @item -mprint-tune-info
16458 @opindex mprint-tune-info
16459 Print CPU tuning information as comment in assembler file.  This is
16460 an option used only for regression testing of the compiler and not
16461 intended for ordinary use in compiling code.  This option is disabled
16462 by default.
16464 @item -mverbose-cost-dump
16465 @opindex mverbose-cost-dump
16466 Enable verbose cost model dumping in the debug dump files.  This option is
16467 provided for use in debugging the compiler.
16469 @item -mpure-code
16470 @opindex mpure-code
16471 Do not allow constant data to be placed in code sections.
16472 Additionally, when compiling for ELF object format give all text sections the
16473 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16474 is only available when generating non-pic code for M-profile targets with the
16475 MOVT instruction.
16477 @item -mcmse
16478 @opindex mcmse
16479 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16480 Development Tools Engineering Specification", which can be found on
16481 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16482 @end table
16484 @node AVR Options
16485 @subsection AVR Options
16486 @cindex AVR Options
16488 These options are defined for AVR implementations:
16490 @table @gcctabopt
16491 @item -mmcu=@var{mcu}
16492 @opindex mmcu
16493 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16495 The default for this option is@tie{}@samp{avr2}.
16497 GCC supports the following AVR devices and ISAs:
16499 @include avr-mmcu.texi
16501 @item -mabsdata
16502 @opindex mabsdata
16504 Assume that all data in static storage can be accessed by LDS / STS
16505 instructions.  This option has only an effect on reduced Tiny devices like
16506 ATtiny40.  See also the @code{absdata}
16507 @ref{AVR Variable Attributes,variable attribute}.
16509 @item -maccumulate-args
16510 @opindex maccumulate-args
16511 Accumulate outgoing function arguments and acquire/release the needed
16512 stack space for outgoing function arguments once in function
16513 prologue/epilogue.  Without this option, outgoing arguments are pushed
16514 before calling a function and popped afterwards.
16516 Popping the arguments after the function call can be expensive on
16517 AVR so that accumulating the stack space might lead to smaller
16518 executables because arguments need not be removed from the
16519 stack after such a function call.
16521 This option can lead to reduced code size for functions that perform
16522 several calls to functions that get their arguments on the stack like
16523 calls to printf-like functions.
16525 @item -mbranch-cost=@var{cost}
16526 @opindex mbranch-cost
16527 Set the branch costs for conditional branch instructions to
16528 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16529 integers. The default branch cost is 0.
16531 @item -mcall-prologues
16532 @opindex mcall-prologues
16533 Functions prologues/epilogues are expanded as calls to appropriate
16534 subroutines.  Code size is smaller.
16536 @item -mgas-isr-prologues
16537 @opindex mgas-isr-prologues
16538 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16539 instruction supported by GNU Binutils.
16540 If this option is on, the feature can still be disabled for individual
16541 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16542 function attribute.  This feature is activated per default
16543 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16544 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16546 @item -mint8
16547 @opindex mint8
16548 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16549 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16550 and @code{long long} is 4 bytes.  Please note that this option does not
16551 conform to the C standards, but it results in smaller code
16552 size.
16554 @item -mmain-is-OS_task
16555 @opindex mmain-is-OS_task
16556 Do not save registers in @code{main}.  The effect is the same like
16557 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16558 to @code{main}. It is activated per default if optimization is on.
16560 @item -mn-flash=@var{num}
16561 @opindex mn-flash
16562 Assume that the flash memory has a size of 
16563 @var{num} times 64@tie{}KiB.
16565 @item -mno-interrupts
16566 @opindex mno-interrupts
16567 Generated code is not compatible with hardware interrupts.
16568 Code size is smaller.
16570 @item -mrelax
16571 @opindex mrelax
16572 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16573 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16574 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16575 the assembler's command line and the @option{--relax} option to the
16576 linker's command line.
16578 Jump relaxing is performed by the linker because jump offsets are not
16579 known before code is located. Therefore, the assembler code generated by the
16580 compiler is the same, but the instructions in the executable may
16581 differ from instructions in the assembler code.
16583 Relaxing must be turned on if linker stubs are needed, see the
16584 section on @code{EIND} and linker stubs below.
16586 @item -mrmw
16587 @opindex mrmw
16588 Assume that the device supports the Read-Modify-Write
16589 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16591 @item -mshort-calls
16592 @opindex mshort-calls
16594 Assume that @code{RJMP} and @code{RCALL} can target the whole
16595 program memory.
16597 This option is used internally for multilib selection.  It is
16598 not an optimization option, and you don't need to set it by hand.
16600 @item -msp8
16601 @opindex msp8
16602 Treat the stack pointer register as an 8-bit register,
16603 i.e.@: assume the high byte of the stack pointer is zero.
16604 In general, you don't need to set this option by hand.
16606 This option is used internally by the compiler to select and
16607 build multilibs for architectures @code{avr2} and @code{avr25}.
16608 These architectures mix devices with and without @code{SPH}.
16609 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16610 the compiler driver adds or removes this option from the compiler
16611 proper's command line, because the compiler then knows if the device
16612 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16613 register or not.
16615 @item -mstrict-X
16616 @opindex mstrict-X
16617 Use address register @code{X} in a way proposed by the hardware.  This means
16618 that @code{X} is only used in indirect, post-increment or
16619 pre-decrement addressing.
16621 Without this option, the @code{X} register may be used in the same way
16622 as @code{Y} or @code{Z} which then is emulated by additional
16623 instructions.  
16624 For example, loading a value with @code{X+const} addressing with a
16625 small non-negative @code{const < 64} to a register @var{Rn} is
16626 performed as
16628 @example
16629 adiw r26, const   ; X += const
16630 ld   @var{Rn}, X        ; @var{Rn} = *X
16631 sbiw r26, const   ; X -= const
16632 @end example
16634 @item -mtiny-stack
16635 @opindex mtiny-stack
16636 Only change the lower 8@tie{}bits of the stack pointer.
16638 @item -mfract-convert-truncate
16639 @opindex mfract-convert-truncate
16640 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16642 @item -nodevicelib
16643 @opindex nodevicelib
16644 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16646 @item -Waddr-space-convert
16647 @opindex Waddr-space-convert
16648 Warn about conversions between address spaces in the case where the
16649 resulting address space is not contained in the incoming address space.
16651 @item -Wmisspelled-isr
16652 @opindex Wmisspelled-isr
16653 Warn if the ISR is misspelled, i.e. without __vector prefix.
16654 Enabled by default.
16655 @end table
16657 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16658 @cindex @code{EIND}
16659 Pointers in the implementation are 16@tie{}bits wide.
16660 The address of a function or label is represented as word address so
16661 that indirect jumps and calls can target any code address in the
16662 range of 64@tie{}Ki words.
16664 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16665 bytes of program memory space, there is a special function register called
16666 @code{EIND} that serves as most significant part of the target address
16667 when @code{EICALL} or @code{EIJMP} instructions are used.
16669 Indirect jumps and calls on these devices are handled as follows by
16670 the compiler and are subject to some limitations:
16672 @itemize @bullet
16674 @item
16675 The compiler never sets @code{EIND}.
16677 @item
16678 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16679 instructions or might read @code{EIND} directly in order to emulate an
16680 indirect call/jump by means of a @code{RET} instruction.
16682 @item
16683 The compiler assumes that @code{EIND} never changes during the startup
16684 code or during the application. In particular, @code{EIND} is not
16685 saved/restored in function or interrupt service routine
16686 prologue/epilogue.
16688 @item
16689 For indirect calls to functions and computed goto, the linker
16690 generates @emph{stubs}. Stubs are jump pads sometimes also called
16691 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16692 The stub contains a direct jump to the desired address.
16694 @item
16695 Linker relaxation must be turned on so that the linker generates
16696 the stubs correctly in all situations. See the compiler option
16697 @option{-mrelax} and the linker option @option{--relax}.
16698 There are corner cases where the linker is supposed to generate stubs
16699 but aborts without relaxation and without a helpful error message.
16701 @item
16702 The default linker script is arranged for code with @code{EIND = 0}.
16703 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16704 linker script has to be used in order to place the sections whose
16705 name start with @code{.trampolines} into the segment where @code{EIND}
16706 points to.
16708 @item
16709 The startup code from libgcc never sets @code{EIND}.
16710 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16711 For the impact of AVR-LibC on @code{EIND}, see the
16712 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16714 @item
16715 It is legitimate for user-specific startup code to set up @code{EIND}
16716 early, for example by means of initialization code located in
16717 section @code{.init3}. Such code runs prior to general startup code
16718 that initializes RAM and calls constructors, but after the bit
16719 of startup code from AVR-LibC that sets @code{EIND} to the segment
16720 where the vector table is located.
16721 @example
16722 #include <avr/io.h>
16724 static void
16725 __attribute__((section(".init3"),naked,used,no_instrument_function))
16726 init3_set_eind (void)
16728   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16729                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16731 @end example
16733 @noindent
16734 The @code{__trampolines_start} symbol is defined in the linker script.
16736 @item
16737 Stubs are generated automatically by the linker if
16738 the following two conditions are met:
16739 @itemize @minus
16741 @item The address of a label is taken by means of the @code{gs} modifier
16742 (short for @emph{generate stubs}) like so:
16743 @example
16744 LDI r24, lo8(gs(@var{func}))
16745 LDI r25, hi8(gs(@var{func}))
16746 @end example
16747 @item The final location of that label is in a code segment
16748 @emph{outside} the segment where the stubs are located.
16749 @end itemize
16751 @item
16752 The compiler emits such @code{gs} modifiers for code labels in the
16753 following situations:
16754 @itemize @minus
16755 @item Taking address of a function or code label.
16756 @item Computed goto.
16757 @item If prologue-save function is used, see @option{-mcall-prologues}
16758 command-line option.
16759 @item Switch/case dispatch tables. If you do not want such dispatch
16760 tables you can specify the @option{-fno-jump-tables} command-line option.
16761 @item C and C++ constructors/destructors called during startup/shutdown.
16762 @item If the tools hit a @code{gs()} modifier explained above.
16763 @end itemize
16765 @item
16766 Jumping to non-symbolic addresses like so is @emph{not} supported:
16768 @example
16769 int main (void)
16771     /* Call function at word address 0x2 */
16772     return ((int(*)(void)) 0x2)();
16774 @end example
16776 Instead, a stub has to be set up, i.e.@: the function has to be called
16777 through a symbol (@code{func_4} in the example):
16779 @example
16780 int main (void)
16782     extern int func_4 (void);
16784     /* Call function at byte address 0x4 */
16785     return func_4();
16787 @end example
16789 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16790 Alternatively, @code{func_4} can be defined in the linker script.
16791 @end itemize
16793 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16794 @cindex @code{RAMPD}
16795 @cindex @code{RAMPX}
16796 @cindex @code{RAMPY}
16797 @cindex @code{RAMPZ}
16798 Some AVR devices support memories larger than the 64@tie{}KiB range
16799 that can be accessed with 16-bit pointers.  To access memory locations
16800 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16801 register is used as high part of the address:
16802 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16803 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16804 register, respectively, to get a wide address. Similarly,
16805 @code{RAMPD} is used together with direct addressing.
16807 @itemize
16808 @item
16809 The startup code initializes the @code{RAMP} special function
16810 registers with zero.
16812 @item
16813 If a @ref{AVR Named Address Spaces,named address space} other than
16814 generic or @code{__flash} is used, then @code{RAMPZ} is set
16815 as needed before the operation.
16817 @item
16818 If the device supports RAM larger than 64@tie{}KiB and the compiler
16819 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16820 is reset to zero after the operation.
16822 @item
16823 If the device comes with a specific @code{RAMP} register, the ISR
16824 prologue/epilogue saves/restores that SFR and initializes it with
16825 zero in case the ISR code might (implicitly) use it.
16827 @item
16828 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16829 If you use inline assembler to read from locations outside the
16830 16-bit address range and change one of the @code{RAMP} registers,
16831 you must reset it to zero after the access.
16833 @end itemize
16835 @subsubsection AVR Built-in Macros
16837 GCC defines several built-in macros so that the user code can test
16838 for the presence or absence of features.  Almost any of the following
16839 built-in macros are deduced from device capabilities and thus
16840 triggered by the @option{-mmcu=} command-line option.
16842 For even more AVR-specific built-in macros see
16843 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16845 @table @code
16847 @item __AVR_ARCH__
16848 Build-in macro that resolves to a decimal number that identifies the
16849 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16850 Possible values are:
16852 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16853 @code{4}, @code{5}, @code{51}, @code{6}
16855 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16856 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16858 respectively and
16860 @code{100},
16861 @code{102}, @code{103}, @code{104},
16862 @code{105}, @code{106}, @code{107}
16864 for @var{mcu}=@code{avrtiny},
16865 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16866 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16867 If @var{mcu} specifies a device, this built-in macro is set
16868 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16869 defined to @code{4}.
16871 @item __AVR_@var{Device}__
16872 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16873 the device's name. For example, @option{-mmcu=atmega8} defines the
16874 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16875 @code{__AVR_ATtiny261A__}, etc.
16877 The built-in macros' names follow
16878 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16879 the device name as from the AVR user manual. The difference between
16880 @var{Device} in the built-in macro and @var{device} in
16881 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16883 If @var{device} is not a device but only a core architecture like
16884 @samp{avr51}, this macro is not defined.
16886 @item __AVR_DEVICE_NAME__
16887 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16888 the device's name. For example, with @option{-mmcu=atmega8} the macro
16889 is defined to @code{atmega8}.
16891 If @var{device} is not a device but only a core architecture like
16892 @samp{avr51}, this macro is not defined.
16894 @item __AVR_XMEGA__
16895 The device / architecture belongs to the XMEGA family of devices.
16897 @item __AVR_HAVE_ELPM__
16898 The device has the @code{ELPM} instruction.
16900 @item __AVR_HAVE_ELPMX__
16901 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16902 R@var{n},Z+} instructions.
16904 @item __AVR_HAVE_MOVW__
16905 The device has the @code{MOVW} instruction to perform 16-bit
16906 register-register moves.
16908 @item __AVR_HAVE_LPMX__
16909 The device has the @code{LPM R@var{n},Z} and
16910 @code{LPM R@var{n},Z+} instructions.
16912 @item __AVR_HAVE_MUL__
16913 The device has a hardware multiplier. 
16915 @item __AVR_HAVE_JMP_CALL__
16916 The device has the @code{JMP} and @code{CALL} instructions.
16917 This is the case for devices with more than 8@tie{}KiB of program
16918 memory.
16920 @item __AVR_HAVE_EIJMP_EICALL__
16921 @itemx __AVR_3_BYTE_PC__
16922 The device has the @code{EIJMP} and @code{EICALL} instructions.
16923 This is the case for devices with more than 128@tie{}KiB of program memory.
16924 This also means that the program counter
16925 (PC) is 3@tie{}bytes wide.
16927 @item __AVR_2_BYTE_PC__
16928 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16929 with up to 128@tie{}KiB of program memory.
16931 @item __AVR_HAVE_8BIT_SP__
16932 @itemx __AVR_HAVE_16BIT_SP__
16933 The stack pointer (SP) register is treated as 8-bit respectively
16934 16-bit register by the compiler.
16935 The definition of these macros is affected by @option{-mtiny-stack}.
16937 @item __AVR_HAVE_SPH__
16938 @itemx __AVR_SP8__
16939 The device has the SPH (high part of stack pointer) special function
16940 register or has an 8-bit stack pointer, respectively.
16941 The definition of these macros is affected by @option{-mmcu=} and
16942 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16943 by @option{-msp8}.
16945 @item __AVR_HAVE_RAMPD__
16946 @itemx __AVR_HAVE_RAMPX__
16947 @itemx __AVR_HAVE_RAMPY__
16948 @itemx __AVR_HAVE_RAMPZ__
16949 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16950 @code{RAMPZ} special function register, respectively.
16952 @item __NO_INTERRUPTS__
16953 This macro reflects the @option{-mno-interrupts} command-line option.
16955 @item __AVR_ERRATA_SKIP__
16956 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16957 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16958 instructions because of a hardware erratum.  Skip instructions are
16959 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16960 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16961 set.
16963 @item __AVR_ISA_RMW__
16964 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16966 @item __AVR_SFR_OFFSET__=@var{offset}
16967 Instructions that can address I/O special function registers directly
16968 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16969 address as if addressed by an instruction to access RAM like @code{LD}
16970 or @code{STS}. This offset depends on the device architecture and has
16971 to be subtracted from the RAM address in order to get the
16972 respective I/O@tie{}address.
16974 @item __AVR_SHORT_CALLS__
16975 The @option{-mshort-calls} command line option is set.
16977 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16978 Some devices support reading from flash memory by means of @code{LD*}
16979 instructions.  The flash memory is seen in the data address space
16980 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16981 is not defined, this feature is not available.  If defined,
16982 the address space is linear and there is no need to put
16983 @code{.rodata} into RAM.  This is handled by the default linker
16984 description file, and is currently available for
16985 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16986 there is no need to use address spaces like @code{__flash} or
16987 features like attribute @code{progmem} and @code{pgm_read_*}.
16989 @item __WITH_AVRLIBC__
16990 The compiler is configured to be used together with AVR-Libc.
16991 See the @option{--with-avrlibc} configure option.
16993 @end table
16995 @node Blackfin Options
16996 @subsection Blackfin Options
16997 @cindex Blackfin Options
16999 @table @gcctabopt
17000 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17001 @opindex mcpu=
17002 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17003 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17004 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17005 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17006 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17007 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17008 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17009 @samp{bf561}, @samp{bf592}.
17011 The optional @var{sirevision} specifies the silicon revision of the target
17012 Blackfin processor.  Any workarounds available for the targeted silicon revision
17013 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17014 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17015 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17016 hexadecimal digits representing the major and minor numbers in the silicon
17017 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17018 is not defined.  If @var{sirevision} is @samp{any}, the
17019 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17020 If this optional @var{sirevision} is not used, GCC assumes the latest known
17021 silicon revision of the targeted Blackfin processor.
17023 GCC defines a preprocessor macro for the specified @var{cpu}.
17024 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17025 provided by libgloss to be linked in if @option{-msim} is not given.
17027 Without this option, @samp{bf532} is used as the processor by default.
17029 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17030 only the preprocessor macro is defined.
17032 @item -msim
17033 @opindex msim
17034 Specifies that the program will be run on the simulator.  This causes
17035 the simulator BSP provided by libgloss to be linked in.  This option
17036 has effect only for @samp{bfin-elf} toolchain.
17037 Certain other options, such as @option{-mid-shared-library} and
17038 @option{-mfdpic}, imply @option{-msim}.
17040 @item -momit-leaf-frame-pointer
17041 @opindex momit-leaf-frame-pointer
17042 Don't keep the frame pointer in a register for leaf functions.  This
17043 avoids the instructions to save, set up and restore frame pointers and
17044 makes an extra register available in leaf functions.
17046 @item -mspecld-anomaly
17047 @opindex mspecld-anomaly
17048 When enabled, the compiler ensures that the generated code does not
17049 contain speculative loads after jump instructions. If this option is used,
17050 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17052 @item -mno-specld-anomaly
17053 @opindex mno-specld-anomaly
17054 Don't generate extra code to prevent speculative loads from occurring.
17056 @item -mcsync-anomaly
17057 @opindex mcsync-anomaly
17058 When enabled, the compiler ensures that the generated code does not
17059 contain CSYNC or SSYNC instructions too soon after conditional branches.
17060 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17062 @item -mno-csync-anomaly
17063 @opindex mno-csync-anomaly
17064 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17065 occurring too soon after a conditional branch.
17067 @item -mlow-64k
17068 @opindex mlow-64k
17069 When enabled, the compiler is free to take advantage of the knowledge that
17070 the entire program fits into the low 64k of memory.
17072 @item -mno-low-64k
17073 @opindex mno-low-64k
17074 Assume that the program is arbitrarily large.  This is the default.
17076 @item -mstack-check-l1
17077 @opindex mstack-check-l1
17078 Do stack checking using information placed into L1 scratchpad memory by the
17079 uClinux kernel.
17081 @item -mid-shared-library
17082 @opindex mid-shared-library
17083 Generate code that supports shared libraries via the library ID method.
17084 This allows for execute in place and shared libraries in an environment
17085 without virtual memory management.  This option implies @option{-fPIC}.
17086 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17088 @item -mno-id-shared-library
17089 @opindex mno-id-shared-library
17090 Generate code that doesn't assume ID-based shared libraries are being used.
17091 This is the default.
17093 @item -mleaf-id-shared-library
17094 @opindex mleaf-id-shared-library
17095 Generate code that supports shared libraries via the library ID method,
17096 but assumes that this library or executable won't link against any other
17097 ID shared libraries.  That allows the compiler to use faster code for jumps
17098 and calls.
17100 @item -mno-leaf-id-shared-library
17101 @opindex mno-leaf-id-shared-library
17102 Do not assume that the code being compiled won't link against any ID shared
17103 libraries.  Slower code is generated for jump and call insns.
17105 @item -mshared-library-id=n
17106 @opindex mshared-library-id
17107 Specifies the identification number of the ID-based shared library being
17108 compiled.  Specifying a value of 0 generates more compact code; specifying
17109 other values forces the allocation of that number to the current
17110 library but is no more space- or time-efficient than omitting this option.
17112 @item -msep-data
17113 @opindex msep-data
17114 Generate code that allows the data segment to be located in a different
17115 area of memory from the text segment.  This allows for execute in place in
17116 an environment without virtual memory management by eliminating relocations
17117 against the text section.
17119 @item -mno-sep-data
17120 @opindex mno-sep-data
17121 Generate code that assumes that the data segment follows the text segment.
17122 This is the default.
17124 @item -mlong-calls
17125 @itemx -mno-long-calls
17126 @opindex mlong-calls
17127 @opindex mno-long-calls
17128 Tells the compiler to perform function calls by first loading the
17129 address of the function into a register and then performing a subroutine
17130 call on this register.  This switch is needed if the target function
17131 lies outside of the 24-bit addressing range of the offset-based
17132 version of subroutine call instruction.
17134 This feature is not enabled by default.  Specifying
17135 @option{-mno-long-calls} restores the default behavior.  Note these
17136 switches have no effect on how the compiler generates code to handle
17137 function calls via function pointers.
17139 @item -mfast-fp
17140 @opindex mfast-fp
17141 Link with the fast floating-point library. This library relaxes some of
17142 the IEEE floating-point standard's rules for checking inputs against
17143 Not-a-Number (NAN), in the interest of performance.
17145 @item -minline-plt
17146 @opindex minline-plt
17147 Enable inlining of PLT entries in function calls to functions that are
17148 not known to bind locally.  It has no effect without @option{-mfdpic}.
17150 @item -mmulticore
17151 @opindex mmulticore
17152 Build a standalone application for multicore Blackfin processors. 
17153 This option causes proper start files and link scripts supporting 
17154 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17155 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17157 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17158 selects the one-application-per-core programming model.  Without
17159 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17160 programming model is used. In this model, the main function of Core B
17161 should be named as @code{coreb_main}.
17163 If this option is not used, the single-core application programming
17164 model is used.
17166 @item -mcorea
17167 @opindex mcorea
17168 Build a standalone application for Core A of BF561 when using
17169 the one-application-per-core programming model. Proper start files
17170 and link scripts are used to support Core A, and the macro
17171 @code{__BFIN_COREA} is defined.
17172 This option can only be used in conjunction with @option{-mmulticore}.
17174 @item -mcoreb
17175 @opindex mcoreb
17176 Build a standalone application for Core B of BF561 when using
17177 the one-application-per-core programming model. Proper start files
17178 and link scripts are used to support Core B, and the macro
17179 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17180 should be used instead of @code{main}. 
17181 This option can only be used in conjunction with @option{-mmulticore}.
17183 @item -msdram
17184 @opindex msdram
17185 Build a standalone application for SDRAM. Proper start files and
17186 link scripts are used to put the application into SDRAM, and the macro
17187 @code{__BFIN_SDRAM} is defined.
17188 The loader should initialize SDRAM before loading the application.
17190 @item -micplb
17191 @opindex micplb
17192 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17193 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17194 are enabled; for standalone applications the default is off.
17195 @end table
17197 @node C6X Options
17198 @subsection C6X Options
17199 @cindex C6X Options
17201 @table @gcctabopt
17202 @item -march=@var{name}
17203 @opindex march
17204 This specifies the name of the target architecture.  GCC uses this
17205 name to determine what kind of instructions it can emit when generating
17206 assembly code.  Permissible names are: @samp{c62x},
17207 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17209 @item -mbig-endian
17210 @opindex mbig-endian
17211 Generate code for a big-endian target.
17213 @item -mlittle-endian
17214 @opindex mlittle-endian
17215 Generate code for a little-endian target.  This is the default.
17217 @item -msim
17218 @opindex msim
17219 Choose startup files and linker script suitable for the simulator.
17221 @item -msdata=default
17222 @opindex msdata=default
17223 Put small global and static data in the @code{.neardata} section,
17224 which is pointed to by register @code{B14}.  Put small uninitialized
17225 global and static data in the @code{.bss} section, which is adjacent
17226 to the @code{.neardata} section.  Put small read-only data into the
17227 @code{.rodata} section.  The corresponding sections used for large
17228 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17230 @item -msdata=all
17231 @opindex msdata=all
17232 Put all data, not just small objects, into the sections reserved for
17233 small data, and use addressing relative to the @code{B14} register to
17234 access them.
17236 @item -msdata=none
17237 @opindex msdata=none
17238 Make no use of the sections reserved for small data, and use absolute
17239 addresses to access all data.  Put all initialized global and static
17240 data in the @code{.fardata} section, and all uninitialized data in the
17241 @code{.far} section.  Put all constant data into the @code{.const}
17242 section.
17243 @end table
17245 @node CRIS Options
17246 @subsection CRIS Options
17247 @cindex CRIS Options
17249 These options are defined specifically for the CRIS ports.
17251 @table @gcctabopt
17252 @item -march=@var{architecture-type}
17253 @itemx -mcpu=@var{architecture-type}
17254 @opindex march
17255 @opindex mcpu
17256 Generate code for the specified architecture.  The choices for
17257 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17258 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17259 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17260 @samp{v10}.
17262 @item -mtune=@var{architecture-type}
17263 @opindex mtune
17264 Tune to @var{architecture-type} everything applicable about the generated
17265 code, except for the ABI and the set of available instructions.  The
17266 choices for @var{architecture-type} are the same as for
17267 @option{-march=@var{architecture-type}}.
17269 @item -mmax-stack-frame=@var{n}
17270 @opindex mmax-stack-frame
17271 Warn when the stack frame of a function exceeds @var{n} bytes.
17273 @item -metrax4
17274 @itemx -metrax100
17275 @opindex metrax4
17276 @opindex metrax100
17277 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17278 @option{-march=v3} and @option{-march=v8} respectively.
17280 @item -mmul-bug-workaround
17281 @itemx -mno-mul-bug-workaround
17282 @opindex mmul-bug-workaround
17283 @opindex mno-mul-bug-workaround
17284 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17285 models where it applies.  This option is active by default.
17287 @item -mpdebug
17288 @opindex mpdebug
17289 Enable CRIS-specific verbose debug-related information in the assembly
17290 code.  This option also has the effect of turning off the @samp{#NO_APP}
17291 formatted-code indicator to the assembler at the beginning of the
17292 assembly file.
17294 @item -mcc-init
17295 @opindex mcc-init
17296 Do not use condition-code results from previous instruction; always emit
17297 compare and test instructions before use of condition codes.
17299 @item -mno-side-effects
17300 @opindex mno-side-effects
17301 Do not emit instructions with side effects in addressing modes other than
17302 post-increment.
17304 @item -mstack-align
17305 @itemx -mno-stack-align
17306 @itemx -mdata-align
17307 @itemx -mno-data-align
17308 @itemx -mconst-align
17309 @itemx -mno-const-align
17310 @opindex mstack-align
17311 @opindex mno-stack-align
17312 @opindex mdata-align
17313 @opindex mno-data-align
17314 @opindex mconst-align
17315 @opindex mno-const-align
17316 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17317 stack frame, individual data and constants to be aligned for the maximum
17318 single data access size for the chosen CPU model.  The default is to
17319 arrange for 32-bit alignment.  ABI details such as structure layout are
17320 not affected by these options.
17322 @item -m32-bit
17323 @itemx -m16-bit
17324 @itemx -m8-bit
17325 @opindex m32-bit
17326 @opindex m16-bit
17327 @opindex m8-bit
17328 Similar to the stack- data- and const-align options above, these options
17329 arrange for stack frame, writable data and constants to all be 32-bit,
17330 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17332 @item -mno-prologue-epilogue
17333 @itemx -mprologue-epilogue
17334 @opindex mno-prologue-epilogue
17335 @opindex mprologue-epilogue
17336 With @option{-mno-prologue-epilogue}, the normal function prologue and
17337 epilogue which set up the stack frame are omitted and no return
17338 instructions or return sequences are generated in the code.  Use this
17339 option only together with visual inspection of the compiled code: no
17340 warnings or errors are generated when call-saved registers must be saved,
17341 or storage for local variables needs to be allocated.
17343 @item -mno-gotplt
17344 @itemx -mgotplt
17345 @opindex mno-gotplt
17346 @opindex mgotplt
17347 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17348 instruction sequences that load addresses for functions from the PLT part
17349 of the GOT rather than (traditional on other architectures) calls to the
17350 PLT@.  The default is @option{-mgotplt}.
17352 @item -melf
17353 @opindex melf
17354 Legacy no-op option only recognized with the cris-axis-elf and
17355 cris-axis-linux-gnu targets.
17357 @item -mlinux
17358 @opindex mlinux
17359 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17361 @item -sim
17362 @opindex sim
17363 This option, recognized for the cris-axis-elf, arranges
17364 to link with input-output functions from a simulator library.  Code,
17365 initialized data and zero-initialized data are allocated consecutively.
17367 @item -sim2
17368 @opindex sim2
17369 Like @option{-sim}, but pass linker options to locate initialized data at
17370 0x40000000 and zero-initialized data at 0x80000000.
17371 @end table
17373 @node CR16 Options
17374 @subsection CR16 Options
17375 @cindex CR16 Options
17377 These options are defined specifically for the CR16 ports.
17379 @table @gcctabopt
17381 @item -mmac
17382 @opindex mmac
17383 Enable the use of multiply-accumulate instructions. Disabled by default.
17385 @item -mcr16cplus
17386 @itemx -mcr16c
17387 @opindex mcr16cplus
17388 @opindex mcr16c
17389 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17390 is default.
17392 @item -msim
17393 @opindex msim
17394 Links the library libsim.a which is in compatible with simulator. Applicable
17395 to ELF compiler only.
17397 @item -mint32
17398 @opindex mint32
17399 Choose integer type as 32-bit wide.
17401 @item -mbit-ops
17402 @opindex mbit-ops
17403 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17405 @item -mdata-model=@var{model}
17406 @opindex mdata-model
17407 Choose a data model. The choices for @var{model} are @samp{near},
17408 @samp{far} or @samp{medium}. @samp{medium} is default.
17409 However, @samp{far} is not valid with @option{-mcr16c}, as the
17410 CR16C architecture does not support the far data model.
17411 @end table
17413 @node Darwin Options
17414 @subsection Darwin Options
17415 @cindex Darwin options
17417 These options are defined for all architectures running the Darwin operating
17418 system.
17420 FSF GCC on Darwin does not create ``fat'' object files; it creates
17421 an object file for the single architecture that GCC was built to
17422 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17423 @option{-arch} options are used; it does so by running the compiler or
17424 linker multiple times and joining the results together with
17425 @file{lipo}.
17427 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17428 @samp{i686}) is determined by the flags that specify the ISA
17429 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17430 @option{-force_cpusubtype_ALL} option can be used to override this.
17432 The Darwin tools vary in their behavior when presented with an ISA
17433 mismatch.  The assembler, @file{as}, only permits instructions to
17434 be used that are valid for the subtype of the file it is generating,
17435 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17436 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17437 and prints an error if asked to create a shared library with a less
17438 restrictive subtype than its input files (for instance, trying to put
17439 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17440 for executables, @command{ld}, quietly gives the executable the most
17441 restrictive subtype of any of its input files.
17443 @table @gcctabopt
17444 @item -F@var{dir}
17445 @opindex F
17446 Add the framework directory @var{dir} to the head of the list of
17447 directories to be searched for header files.  These directories are
17448 interleaved with those specified by @option{-I} options and are
17449 scanned in a left-to-right order.
17451 A framework directory is a directory with frameworks in it.  A
17452 framework is a directory with a @file{Headers} and/or
17453 @file{PrivateHeaders} directory contained directly in it that ends
17454 in @file{.framework}.  The name of a framework is the name of this
17455 directory excluding the @file{.framework}.  Headers associated with
17456 the framework are found in one of those two directories, with
17457 @file{Headers} being searched first.  A subframework is a framework
17458 directory that is in a framework's @file{Frameworks} directory.
17459 Includes of subframework headers can only appear in a header of a
17460 framework that contains the subframework, or in a sibling subframework
17461 header.  Two subframeworks are siblings if they occur in the same
17462 framework.  A subframework should not have the same name as a
17463 framework; a warning is issued if this is violated.  Currently a
17464 subframework cannot have subframeworks; in the future, the mechanism
17465 may be extended to support this.  The standard frameworks can be found
17466 in @file{/System/Library/Frameworks} and
17467 @file{/Library/Frameworks}.  An example include looks like
17468 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17469 the name of the framework and @file{header.h} is found in the
17470 @file{PrivateHeaders} or @file{Headers} directory.
17472 @item -iframework@var{dir}
17473 @opindex iframework
17474 Like @option{-F} except the directory is a treated as a system
17475 directory.  The main difference between this @option{-iframework} and
17476 @option{-F} is that with @option{-iframework} the compiler does not
17477 warn about constructs contained within header files found via
17478 @var{dir}.  This option is valid only for the C family of languages.
17480 @item -gused
17481 @opindex gused
17482 Emit debugging information for symbols that are used.  For stabs
17483 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17484 This is by default ON@.
17486 @item -gfull
17487 @opindex gfull
17488 Emit debugging information for all symbols and types.
17490 @item -mmacosx-version-min=@var{version}
17491 The earliest version of MacOS X that this executable will run on
17492 is @var{version}.  Typical values of @var{version} include @code{10.1},
17493 @code{10.2}, and @code{10.3.9}.
17495 If the compiler was built to use the system's headers by default,
17496 then the default for this option is the system version on which the
17497 compiler is running, otherwise the default is to make choices that
17498 are compatible with as many systems and code bases as possible.
17500 @item -mkernel
17501 @opindex mkernel
17502 Enable kernel development mode.  The @option{-mkernel} option sets
17503 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17504 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17505 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17506 applicable.  This mode also sets @option{-mno-altivec},
17507 @option{-msoft-float}, @option{-fno-builtin} and
17508 @option{-mlong-branch} for PowerPC targets.
17510 @item -mone-byte-bool
17511 @opindex mone-byte-bool
17512 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17513 By default @code{sizeof(bool)} is @code{4} when compiling for
17514 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17515 option has no effect on x86.
17517 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17518 to generate code that is not binary compatible with code generated
17519 without that switch.  Using this switch may require recompiling all
17520 other modules in a program, including system libraries.  Use this
17521 switch to conform to a non-default data model.
17523 @item -mfix-and-continue
17524 @itemx -ffix-and-continue
17525 @itemx -findirect-data
17526 @opindex mfix-and-continue
17527 @opindex ffix-and-continue
17528 @opindex findirect-data
17529 Generate code suitable for fast turnaround development, such as to
17530 allow GDB to dynamically load @file{.o} files into already-running
17531 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17532 are provided for backwards compatibility.
17534 @item -all_load
17535 @opindex all_load
17536 Loads all members of static archive libraries.
17537 See man ld(1) for more information.
17539 @item -arch_errors_fatal
17540 @opindex arch_errors_fatal
17541 Cause the errors having to do with files that have the wrong architecture
17542 to be fatal.
17544 @item -bind_at_load
17545 @opindex bind_at_load
17546 Causes the output file to be marked such that the dynamic linker will
17547 bind all undefined references when the file is loaded or launched.
17549 @item -bundle
17550 @opindex bundle
17551 Produce a Mach-o bundle format file.
17552 See man ld(1) for more information.
17554 @item -bundle_loader @var{executable}
17555 @opindex bundle_loader
17556 This option specifies the @var{executable} that will load the build
17557 output file being linked.  See man ld(1) for more information.
17559 @item -dynamiclib
17560 @opindex dynamiclib
17561 When passed this option, GCC produces a dynamic library instead of
17562 an executable when linking, using the Darwin @file{libtool} command.
17564 @item -force_cpusubtype_ALL
17565 @opindex force_cpusubtype_ALL
17566 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17567 one controlled by the @option{-mcpu} or @option{-march} option.
17569 @item -allowable_client  @var{client_name}
17570 @itemx -client_name
17571 @itemx -compatibility_version
17572 @itemx -current_version
17573 @itemx -dead_strip
17574 @itemx -dependency-file
17575 @itemx -dylib_file
17576 @itemx -dylinker_install_name
17577 @itemx -dynamic
17578 @itemx -exported_symbols_list
17579 @itemx -filelist
17580 @need 800
17581 @itemx -flat_namespace
17582 @itemx -force_flat_namespace
17583 @itemx -headerpad_max_install_names
17584 @itemx -image_base
17585 @itemx -init
17586 @itemx -install_name
17587 @itemx -keep_private_externs
17588 @itemx -multi_module
17589 @itemx -multiply_defined
17590 @itemx -multiply_defined_unused
17591 @need 800
17592 @itemx -noall_load
17593 @itemx -no_dead_strip_inits_and_terms
17594 @itemx -nofixprebinding
17595 @itemx -nomultidefs
17596 @itemx -noprebind
17597 @itemx -noseglinkedit
17598 @itemx -pagezero_size
17599 @itemx -prebind
17600 @itemx -prebind_all_twolevel_modules
17601 @itemx -private_bundle
17602 @need 800
17603 @itemx -read_only_relocs
17604 @itemx -sectalign
17605 @itemx -sectobjectsymbols
17606 @itemx -whyload
17607 @itemx -seg1addr
17608 @itemx -sectcreate
17609 @itemx -sectobjectsymbols
17610 @itemx -sectorder
17611 @itemx -segaddr
17612 @itemx -segs_read_only_addr
17613 @need 800
17614 @itemx -segs_read_write_addr
17615 @itemx -seg_addr_table
17616 @itemx -seg_addr_table_filename
17617 @itemx -seglinkedit
17618 @itemx -segprot
17619 @itemx -segs_read_only_addr
17620 @itemx -segs_read_write_addr
17621 @itemx -single_module
17622 @itemx -static
17623 @itemx -sub_library
17624 @need 800
17625 @itemx -sub_umbrella
17626 @itemx -twolevel_namespace
17627 @itemx -umbrella
17628 @itemx -undefined
17629 @itemx -unexported_symbols_list
17630 @itemx -weak_reference_mismatches
17631 @itemx -whatsloaded
17632 @opindex allowable_client
17633 @opindex client_name
17634 @opindex compatibility_version
17635 @opindex current_version
17636 @opindex dead_strip
17637 @opindex dependency-file
17638 @opindex dylib_file
17639 @opindex dylinker_install_name
17640 @opindex dynamic
17641 @opindex exported_symbols_list
17642 @opindex filelist
17643 @opindex flat_namespace
17644 @opindex force_flat_namespace
17645 @opindex headerpad_max_install_names
17646 @opindex image_base
17647 @opindex init
17648 @opindex install_name
17649 @opindex keep_private_externs
17650 @opindex multi_module
17651 @opindex multiply_defined
17652 @opindex multiply_defined_unused
17653 @opindex noall_load
17654 @opindex no_dead_strip_inits_and_terms
17655 @opindex nofixprebinding
17656 @opindex nomultidefs
17657 @opindex noprebind
17658 @opindex noseglinkedit
17659 @opindex pagezero_size
17660 @opindex prebind
17661 @opindex prebind_all_twolevel_modules
17662 @opindex private_bundle
17663 @opindex read_only_relocs
17664 @opindex sectalign
17665 @opindex sectobjectsymbols
17666 @opindex whyload
17667 @opindex seg1addr
17668 @opindex sectcreate
17669 @opindex sectobjectsymbols
17670 @opindex sectorder
17671 @opindex segaddr
17672 @opindex segs_read_only_addr
17673 @opindex segs_read_write_addr
17674 @opindex seg_addr_table
17675 @opindex seg_addr_table_filename
17676 @opindex seglinkedit
17677 @opindex segprot
17678 @opindex segs_read_only_addr
17679 @opindex segs_read_write_addr
17680 @opindex single_module
17681 @opindex static
17682 @opindex sub_library
17683 @opindex sub_umbrella
17684 @opindex twolevel_namespace
17685 @opindex umbrella
17686 @opindex undefined
17687 @opindex unexported_symbols_list
17688 @opindex weak_reference_mismatches
17689 @opindex whatsloaded
17690 These options are passed to the Darwin linker.  The Darwin linker man page
17691 describes them in detail.
17692 @end table
17694 @node DEC Alpha Options
17695 @subsection DEC Alpha Options
17697 These @samp{-m} options are defined for the DEC Alpha implementations:
17699 @table @gcctabopt
17700 @item -mno-soft-float
17701 @itemx -msoft-float
17702 @opindex mno-soft-float
17703 @opindex msoft-float
17704 Use (do not use) the hardware floating-point instructions for
17705 floating-point operations.  When @option{-msoft-float} is specified,
17706 functions in @file{libgcc.a} are used to perform floating-point
17707 operations.  Unless they are replaced by routines that emulate the
17708 floating-point operations, or compiled in such a way as to call such
17709 emulations routines, these routines issue floating-point
17710 operations.   If you are compiling for an Alpha without floating-point
17711 operations, you must ensure that the library is built so as not to call
17712 them.
17714 Note that Alpha implementations without floating-point operations are
17715 required to have floating-point registers.
17717 @item -mfp-reg
17718 @itemx -mno-fp-regs
17719 @opindex mfp-reg
17720 @opindex mno-fp-regs
17721 Generate code that uses (does not use) the floating-point register set.
17722 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17723 register set is not used, floating-point operands are passed in integer
17724 registers as if they were integers and floating-point results are passed
17725 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17726 so any function with a floating-point argument or return value called by code
17727 compiled with @option{-mno-fp-regs} must also be compiled with that
17728 option.
17730 A typical use of this option is building a kernel that does not use,
17731 and hence need not save and restore, any floating-point registers.
17733 @item -mieee
17734 @opindex mieee
17735 The Alpha architecture implements floating-point hardware optimized for
17736 maximum performance.  It is mostly compliant with the IEEE floating-point
17737 standard.  However, for full compliance, software assistance is
17738 required.  This option generates code fully IEEE-compliant code
17739 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17740 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17741 defined during compilation.  The resulting code is less efficient but is
17742 able to correctly support denormalized numbers and exceptional IEEE
17743 values such as not-a-number and plus/minus infinity.  Other Alpha
17744 compilers call this option @option{-ieee_with_no_inexact}.
17746 @item -mieee-with-inexact
17747 @opindex mieee-with-inexact
17748 This is like @option{-mieee} except the generated code also maintains
17749 the IEEE @var{inexact-flag}.  Turning on this option causes the
17750 generated code to implement fully-compliant IEEE math.  In addition to
17751 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17752 macro.  On some Alpha implementations the resulting code may execute
17753 significantly slower than the code generated by default.  Since there is
17754 very little code that depends on the @var{inexact-flag}, you should
17755 normally not specify this option.  Other Alpha compilers call this
17756 option @option{-ieee_with_inexact}.
17758 @item -mfp-trap-mode=@var{trap-mode}
17759 @opindex mfp-trap-mode
17760 This option controls what floating-point related traps are enabled.
17761 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17762 The trap mode can be set to one of four values:
17764 @table @samp
17765 @item n
17766 This is the default (normal) setting.  The only traps that are enabled
17767 are the ones that cannot be disabled in software (e.g., division by zero
17768 trap).
17770 @item u
17771 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17772 as well.
17774 @item su
17775 Like @samp{u}, but the instructions are marked to be safe for software
17776 completion (see Alpha architecture manual for details).
17778 @item sui
17779 Like @samp{su}, but inexact traps are enabled as well.
17780 @end table
17782 @item -mfp-rounding-mode=@var{rounding-mode}
17783 @opindex mfp-rounding-mode
17784 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17785 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17788 @table @samp
17789 @item n
17790 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17791 the nearest machine number or towards the even machine number in case
17792 of a tie.
17794 @item m
17795 Round towards minus infinity.
17797 @item c
17798 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17800 @item d
17801 Dynamic rounding mode.  A field in the floating-point control register
17802 (@var{fpcr}, see Alpha architecture reference manual) controls the
17803 rounding mode in effect.  The C library initializes this register for
17804 rounding towards plus infinity.  Thus, unless your program modifies the
17805 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17806 @end table
17808 @item -mtrap-precision=@var{trap-precision}
17809 @opindex mtrap-precision
17810 In the Alpha architecture, floating-point traps are imprecise.  This
17811 means without software assistance it is impossible to recover from a
17812 floating trap and program execution normally needs to be terminated.
17813 GCC can generate code that can assist operating system trap handlers
17814 in determining the exact location that caused a floating-point trap.
17815 Depending on the requirements of an application, different levels of
17816 precisions can be selected:
17818 @table @samp
17819 @item p
17820 Program precision.  This option is the default and means a trap handler
17821 can only identify which program caused a floating-point exception.
17823 @item f
17824 Function precision.  The trap handler can determine the function that
17825 caused a floating-point exception.
17827 @item i
17828 Instruction precision.  The trap handler can determine the exact
17829 instruction that caused a floating-point exception.
17830 @end table
17832 Other Alpha compilers provide the equivalent options called
17833 @option{-scope_safe} and @option{-resumption_safe}.
17835 @item -mieee-conformant
17836 @opindex mieee-conformant
17837 This option marks the generated code as IEEE conformant.  You must not
17838 use this option unless you also specify @option{-mtrap-precision=i} and either
17839 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17840 is to emit the line @samp{.eflag 48} in the function prologue of the
17841 generated assembly file.
17843 @item -mbuild-constants
17844 @opindex mbuild-constants
17845 Normally GCC examines a 32- or 64-bit integer constant to
17846 see if it can construct it from smaller constants in two or three
17847 instructions.  If it cannot, it outputs the constant as a literal and
17848 generates code to load it from the data segment at run time.
17850 Use this option to require GCC to construct @emph{all} integer constants
17851 using code, even if it takes more instructions (the maximum is six).
17853 You typically use this option to build a shared library dynamic
17854 loader.  Itself a shared library, it must relocate itself in memory
17855 before it can find the variables and constants in its own data segment.
17857 @item -mbwx
17858 @itemx -mno-bwx
17859 @itemx -mcix
17860 @itemx -mno-cix
17861 @itemx -mfix
17862 @itemx -mno-fix
17863 @itemx -mmax
17864 @itemx -mno-max
17865 @opindex mbwx
17866 @opindex mno-bwx
17867 @opindex mcix
17868 @opindex mno-cix
17869 @opindex mfix
17870 @opindex mno-fix
17871 @opindex mmax
17872 @opindex mno-max
17873 Indicate whether GCC should generate code to use the optional BWX,
17874 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17875 sets supported by the CPU type specified via @option{-mcpu=} option or that
17876 of the CPU on which GCC was built if none is specified.
17878 @item -mfloat-vax
17879 @itemx -mfloat-ieee
17880 @opindex mfloat-vax
17881 @opindex mfloat-ieee
17882 Generate code that uses (does not use) VAX F and G floating-point
17883 arithmetic instead of IEEE single and double precision.
17885 @item -mexplicit-relocs
17886 @itemx -mno-explicit-relocs
17887 @opindex mexplicit-relocs
17888 @opindex mno-explicit-relocs
17889 Older Alpha assemblers provided no way to generate symbol relocations
17890 except via assembler macros.  Use of these macros does not allow
17891 optimal instruction scheduling.  GNU binutils as of version 2.12
17892 supports a new syntax that allows the compiler to explicitly mark
17893 which relocations should apply to which instructions.  This option
17894 is mostly useful for debugging, as GCC detects the capabilities of
17895 the assembler when it is built and sets the default accordingly.
17897 @item -msmall-data
17898 @itemx -mlarge-data
17899 @opindex msmall-data
17900 @opindex mlarge-data
17901 When @option{-mexplicit-relocs} is in effect, static data is
17902 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17903 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17904 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17905 16-bit relocations off of the @code{$gp} register.  This limits the
17906 size of the small data area to 64KB, but allows the variables to be
17907 directly accessed via a single instruction.
17909 The default is @option{-mlarge-data}.  With this option the data area
17910 is limited to just below 2GB@.  Programs that require more than 2GB of
17911 data must use @code{malloc} or @code{mmap} to allocate the data in the
17912 heap instead of in the program's data segment.
17914 When generating code for shared libraries, @option{-fpic} implies
17915 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17917 @item -msmall-text
17918 @itemx -mlarge-text
17919 @opindex msmall-text
17920 @opindex mlarge-text
17921 When @option{-msmall-text} is used, the compiler assumes that the
17922 code of the entire program (or shared library) fits in 4MB, and is
17923 thus reachable with a branch instruction.  When @option{-msmall-data}
17924 is used, the compiler can assume that all local symbols share the
17925 same @code{$gp} value, and thus reduce the number of instructions
17926 required for a function call from 4 to 1.
17928 The default is @option{-mlarge-text}.
17930 @item -mcpu=@var{cpu_type}
17931 @opindex mcpu
17932 Set the instruction set and instruction scheduling parameters for
17933 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17934 style name or the corresponding chip number.  GCC supports scheduling
17935 parameters for the EV4, EV5 and EV6 family of processors and
17936 chooses the default values for the instruction set from the processor
17937 you specify.  If you do not specify a processor type, GCC defaults
17938 to the processor on which the compiler was built.
17940 Supported values for @var{cpu_type} are
17942 @table @samp
17943 @item ev4
17944 @itemx ev45
17945 @itemx 21064
17946 Schedules as an EV4 and has no instruction set extensions.
17948 @item ev5
17949 @itemx 21164
17950 Schedules as an EV5 and has no instruction set extensions.
17952 @item ev56
17953 @itemx 21164a
17954 Schedules as an EV5 and supports the BWX extension.
17956 @item pca56
17957 @itemx 21164pc
17958 @itemx 21164PC
17959 Schedules as an EV5 and supports the BWX and MAX extensions.
17961 @item ev6
17962 @itemx 21264
17963 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17965 @item ev67
17966 @itemx 21264a
17967 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17968 @end table
17970 Native toolchains also support the value @samp{native},
17971 which selects the best architecture option for the host processor.
17972 @option{-mcpu=native} has no effect if GCC does not recognize
17973 the processor.
17975 @item -mtune=@var{cpu_type}
17976 @opindex mtune
17977 Set only the instruction scheduling parameters for machine type
17978 @var{cpu_type}.  The instruction set is not changed.
17980 Native toolchains also support the value @samp{native},
17981 which selects the best architecture option for the host processor.
17982 @option{-mtune=native} has no effect if GCC does not recognize
17983 the processor.
17985 @item -mmemory-latency=@var{time}
17986 @opindex mmemory-latency
17987 Sets the latency the scheduler should assume for typical memory
17988 references as seen by the application.  This number is highly
17989 dependent on the memory access patterns used by the application
17990 and the size of the external cache on the machine.
17992 Valid options for @var{time} are
17994 @table @samp
17995 @item @var{number}
17996 A decimal number representing clock cycles.
17998 @item L1
17999 @itemx L2
18000 @itemx L3
18001 @itemx main
18002 The compiler contains estimates of the number of clock cycles for
18003 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18004 (also called Dcache, Scache, and Bcache), as well as to main memory.
18005 Note that L3 is only valid for EV5.
18007 @end table
18008 @end table
18010 @node FR30 Options
18011 @subsection FR30 Options
18012 @cindex FR30 Options
18014 These options are defined specifically for the FR30 port.
18016 @table @gcctabopt
18018 @item -msmall-model
18019 @opindex msmall-model
18020 Use the small address space model.  This can produce smaller code, but
18021 it does assume that all symbolic values and addresses fit into a
18022 20-bit range.
18024 @item -mno-lsim
18025 @opindex mno-lsim
18026 Assume that runtime support has been provided and so there is no need
18027 to include the simulator library (@file{libsim.a}) on the linker
18028 command line.
18030 @end table
18032 @node FT32 Options
18033 @subsection FT32 Options
18034 @cindex FT32 Options
18036 These options are defined specifically for the FT32 port.
18038 @table @gcctabopt
18040 @item -msim
18041 @opindex msim
18042 Specifies that the program will be run on the simulator.  This causes
18043 an alternate runtime startup and library to be linked.
18044 You must not use this option when generating programs that will run on
18045 real hardware; you must provide your own runtime library for whatever
18046 I/O functions are needed.
18048 @item -mlra
18049 @opindex mlra
18050 Enable Local Register Allocation.  This is still experimental for FT32,
18051 so by default the compiler uses standard reload.
18053 @item -mnodiv
18054 @opindex mnodiv
18055 Do not use div and mod instructions.
18057 @item -mft32b
18058 @opindex mft32b
18059 Enable use of the extended instructions of the FT32B processor.
18061 @item -mcompress
18062 @opindex mcompress
18063 Compress all code using the Ft32B code compression scheme.
18065 @item -mnopm
18066 @opindex  mnopm
18067 Do not generate code that reads program memory.
18069 @end table
18071 @node FRV Options
18072 @subsection FRV Options
18073 @cindex FRV Options
18075 @table @gcctabopt
18076 @item -mgpr-32
18077 @opindex mgpr-32
18079 Only use the first 32 general-purpose registers.
18081 @item -mgpr-64
18082 @opindex mgpr-64
18084 Use all 64 general-purpose registers.
18086 @item -mfpr-32
18087 @opindex mfpr-32
18089 Use only the first 32 floating-point registers.
18091 @item -mfpr-64
18092 @opindex mfpr-64
18094 Use all 64 floating-point registers.
18096 @item -mhard-float
18097 @opindex mhard-float
18099 Use hardware instructions for floating-point operations.
18101 @item -msoft-float
18102 @opindex msoft-float
18104 Use library routines for floating-point operations.
18106 @item -malloc-cc
18107 @opindex malloc-cc
18109 Dynamically allocate condition code registers.
18111 @item -mfixed-cc
18112 @opindex mfixed-cc
18114 Do not try to dynamically allocate condition code registers, only
18115 use @code{icc0} and @code{fcc0}.
18117 @item -mdword
18118 @opindex mdword
18120 Change ABI to use double word insns.
18122 @item -mno-dword
18123 @opindex mno-dword
18125 Do not use double word instructions.
18127 @item -mdouble
18128 @opindex mdouble
18130 Use floating-point double instructions.
18132 @item -mno-double
18133 @opindex mno-double
18135 Do not use floating-point double instructions.
18137 @item -mmedia
18138 @opindex mmedia
18140 Use media instructions.
18142 @item -mno-media
18143 @opindex mno-media
18145 Do not use media instructions.
18147 @item -mmuladd
18148 @opindex mmuladd
18150 Use multiply and add/subtract instructions.
18152 @item -mno-muladd
18153 @opindex mno-muladd
18155 Do not use multiply and add/subtract instructions.
18157 @item -mfdpic
18158 @opindex mfdpic
18160 Select the FDPIC ABI, which uses function descriptors to represent
18161 pointers to functions.  Without any PIC/PIE-related options, it
18162 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18163 assumes GOT entries and small data are within a 12-bit range from the
18164 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18165 are computed with 32 bits.
18166 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18168 @item -minline-plt
18169 @opindex minline-plt
18171 Enable inlining of PLT entries in function calls to functions that are
18172 not known to bind locally.  It has no effect without @option{-mfdpic}.
18173 It's enabled by default if optimizing for speed and compiling for
18174 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18175 optimization option such as @option{-O3} or above is present in the
18176 command line.
18178 @item -mTLS
18179 @opindex mTLS
18181 Assume a large TLS segment when generating thread-local code.
18183 @item -mtls
18184 @opindex mtls
18186 Do not assume a large TLS segment when generating thread-local code.
18188 @item -mgprel-ro
18189 @opindex mgprel-ro
18191 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18192 that is known to be in read-only sections.  It's enabled by default,
18193 except for @option{-fpic} or @option{-fpie}: even though it may help
18194 make the global offset table smaller, it trades 1 instruction for 4.
18195 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18196 one of which may be shared by multiple symbols, and it avoids the need
18197 for a GOT entry for the referenced symbol, so it's more likely to be a
18198 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18200 @item -multilib-library-pic
18201 @opindex multilib-library-pic
18203 Link with the (library, not FD) pic libraries.  It's implied by
18204 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18205 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18206 it explicitly.
18208 @item -mlinked-fp
18209 @opindex mlinked-fp
18211 Follow the EABI requirement of always creating a frame pointer whenever
18212 a stack frame is allocated.  This option is enabled by default and can
18213 be disabled with @option{-mno-linked-fp}.
18215 @item -mlong-calls
18216 @opindex mlong-calls
18218 Use indirect addressing to call functions outside the current
18219 compilation unit.  This allows the functions to be placed anywhere
18220 within the 32-bit address space.
18222 @item -malign-labels
18223 @opindex malign-labels
18225 Try to align labels to an 8-byte boundary by inserting NOPs into the
18226 previous packet.  This option only has an effect when VLIW packing
18227 is enabled.  It doesn't create new packets; it merely adds NOPs to
18228 existing ones.
18230 @item -mlibrary-pic
18231 @opindex mlibrary-pic
18233 Generate position-independent EABI code.
18235 @item -macc-4
18236 @opindex macc-4
18238 Use only the first four media accumulator registers.
18240 @item -macc-8
18241 @opindex macc-8
18243 Use all eight media accumulator registers.
18245 @item -mpack
18246 @opindex mpack
18248 Pack VLIW instructions.
18250 @item -mno-pack
18251 @opindex mno-pack
18253 Do not pack VLIW instructions.
18255 @item -mno-eflags
18256 @opindex mno-eflags
18258 Do not mark ABI switches in e_flags.
18260 @item -mcond-move
18261 @opindex mcond-move
18263 Enable the use of conditional-move instructions (default).
18265 This switch is mainly for debugging the compiler and will likely be removed
18266 in a future version.
18268 @item -mno-cond-move
18269 @opindex mno-cond-move
18271 Disable the use of conditional-move instructions.
18273 This switch is mainly for debugging the compiler and will likely be removed
18274 in a future version.
18276 @item -mscc
18277 @opindex mscc
18279 Enable the use of conditional set instructions (default).
18281 This switch is mainly for debugging the compiler and will likely be removed
18282 in a future version.
18284 @item -mno-scc
18285 @opindex mno-scc
18287 Disable the use of conditional set instructions.
18289 This switch is mainly for debugging the compiler and will likely be removed
18290 in a future version.
18292 @item -mcond-exec
18293 @opindex mcond-exec
18295 Enable the use of conditional execution (default).
18297 This switch is mainly for debugging the compiler and will likely be removed
18298 in a future version.
18300 @item -mno-cond-exec
18301 @opindex mno-cond-exec
18303 Disable the use of conditional execution.
18305 This switch is mainly for debugging the compiler and will likely be removed
18306 in a future version.
18308 @item -mvliw-branch
18309 @opindex mvliw-branch
18311 Run a pass to pack branches into VLIW instructions (default).
18313 This switch is mainly for debugging the compiler and will likely be removed
18314 in a future version.
18316 @item -mno-vliw-branch
18317 @opindex mno-vliw-branch
18319 Do not run a pass to pack branches into VLIW instructions.
18321 This switch is mainly for debugging the compiler and will likely be removed
18322 in a future version.
18324 @item -mmulti-cond-exec
18325 @opindex mmulti-cond-exec
18327 Enable optimization of @code{&&} and @code{||} in conditional execution
18328 (default).
18330 This switch is mainly for debugging the compiler and will likely be removed
18331 in a future version.
18333 @item -mno-multi-cond-exec
18334 @opindex mno-multi-cond-exec
18336 Disable optimization of @code{&&} and @code{||} in conditional execution.
18338 This switch is mainly for debugging the compiler and will likely be removed
18339 in a future version.
18341 @item -mnested-cond-exec
18342 @opindex mnested-cond-exec
18344 Enable nested conditional execution optimizations (default).
18346 This switch is mainly for debugging the compiler and will likely be removed
18347 in a future version.
18349 @item -mno-nested-cond-exec
18350 @opindex mno-nested-cond-exec
18352 Disable nested conditional execution optimizations.
18354 This switch is mainly for debugging the compiler and will likely be removed
18355 in a future version.
18357 @item -moptimize-membar
18358 @opindex moptimize-membar
18360 This switch removes redundant @code{membar} instructions from the
18361 compiler-generated code.  It is enabled by default.
18363 @item -mno-optimize-membar
18364 @opindex mno-optimize-membar
18366 This switch disables the automatic removal of redundant @code{membar}
18367 instructions from the generated code.
18369 @item -mtomcat-stats
18370 @opindex mtomcat-stats
18372 Cause gas to print out tomcat statistics.
18374 @item -mcpu=@var{cpu}
18375 @opindex mcpu
18377 Select the processor type for which to generate code.  Possible values are
18378 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18379 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18381 @end table
18383 @node GNU/Linux Options
18384 @subsection GNU/Linux Options
18386 These @samp{-m} options are defined for GNU/Linux targets:
18388 @table @gcctabopt
18389 @item -mglibc
18390 @opindex mglibc
18391 Use the GNU C library.  This is the default except
18392 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18393 @samp{*-*-linux-*android*} targets.
18395 @item -muclibc
18396 @opindex muclibc
18397 Use uClibc C library.  This is the default on
18398 @samp{*-*-linux-*uclibc*} targets.
18400 @item -mmusl
18401 @opindex mmusl
18402 Use the musl C library.  This is the default on
18403 @samp{*-*-linux-*musl*} targets.
18405 @item -mbionic
18406 @opindex mbionic
18407 Use Bionic C library.  This is the default on
18408 @samp{*-*-linux-*android*} targets.
18410 @item -mandroid
18411 @opindex mandroid
18412 Compile code compatible with Android platform.  This is the default on
18413 @samp{*-*-linux-*android*} targets.
18415 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18416 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18417 this option makes the GCC driver pass Android-specific options to the linker.
18418 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18419 to be defined.
18421 @item -tno-android-cc
18422 @opindex tno-android-cc
18423 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18424 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18425 @option{-fno-rtti} by default.
18427 @item -tno-android-ld
18428 @opindex tno-android-ld
18429 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18430 linking options to the linker.
18432 @end table
18434 @node H8/300 Options
18435 @subsection H8/300 Options
18437 These @samp{-m} options are defined for the H8/300 implementations:
18439 @table @gcctabopt
18440 @item -mrelax
18441 @opindex mrelax
18442 Shorten some address references at link time, when possible; uses the
18443 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18444 ld, Using ld}, for a fuller description.
18446 @item -mh
18447 @opindex mh
18448 Generate code for the H8/300H@.
18450 @item -ms
18451 @opindex ms
18452 Generate code for the H8S@.
18454 @item -mn
18455 @opindex mn
18456 Generate code for the H8S and H8/300H in the normal mode.  This switch
18457 must be used either with @option{-mh} or @option{-ms}.
18459 @item -ms2600
18460 @opindex ms2600
18461 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18463 @item -mexr
18464 @opindex mexr
18465 Extended registers are stored on stack before execution of function
18466 with monitor attribute. Default option is @option{-mexr}.
18467 This option is valid only for H8S targets.
18469 @item -mno-exr
18470 @opindex mno-exr
18471 Extended registers are not stored on stack before execution of function 
18472 with monitor attribute. Default option is @option{-mno-exr}. 
18473 This option is valid only for H8S targets.
18475 @item -mint32
18476 @opindex mint32
18477 Make @code{int} data 32 bits by default.
18479 @item -malign-300
18480 @opindex malign-300
18481 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18482 The default for the H8/300H and H8S is to align longs and floats on
18483 4-byte boundaries.
18484 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18485 This option has no effect on the H8/300.
18486 @end table
18488 @node HPPA Options
18489 @subsection HPPA Options
18490 @cindex HPPA Options
18492 These @samp{-m} options are defined for the HPPA family of computers:
18494 @table @gcctabopt
18495 @item -march=@var{architecture-type}
18496 @opindex march
18497 Generate code for the specified architecture.  The choices for
18498 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18499 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18500 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18501 architecture option for your machine.  Code compiled for lower numbered
18502 architectures runs on higher numbered architectures, but not the
18503 other way around.
18505 @item -mpa-risc-1-0
18506 @itemx -mpa-risc-1-1
18507 @itemx -mpa-risc-2-0
18508 @opindex mpa-risc-1-0
18509 @opindex mpa-risc-1-1
18510 @opindex mpa-risc-2-0
18511 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18513 @item -mcaller-copies
18514 @opindex mcaller-copies
18515 The caller copies function arguments passed by hidden reference.  This
18516 option should be used with care as it is not compatible with the default
18517 32-bit runtime.  However, only aggregates larger than eight bytes are
18518 passed by hidden reference and the option provides better compatibility
18519 with OpenMP.
18521 @item -mjump-in-delay
18522 @opindex mjump-in-delay
18523 This option is ignored and provided for compatibility purposes only.
18525 @item -mdisable-fpregs
18526 @opindex mdisable-fpregs
18527 Prevent floating-point registers from being used in any manner.  This is
18528 necessary for compiling kernels that perform lazy context switching of
18529 floating-point registers.  If you use this option and attempt to perform
18530 floating-point operations, the compiler aborts.
18532 @item -mdisable-indexing
18533 @opindex mdisable-indexing
18534 Prevent the compiler from using indexing address modes.  This avoids some
18535 rather obscure problems when compiling MIG generated code under MACH@.
18537 @item -mno-space-regs
18538 @opindex mno-space-regs
18539 Generate code that assumes the target has no space registers.  This allows
18540 GCC to generate faster indirect calls and use unscaled index address modes.
18542 Such code is suitable for level 0 PA systems and kernels.
18544 @item -mfast-indirect-calls
18545 @opindex mfast-indirect-calls
18546 Generate code that assumes calls never cross space boundaries.  This
18547 allows GCC to emit code that performs faster indirect calls.
18549 This option does not work in the presence of shared libraries or nested
18550 functions.
18552 @item -mfixed-range=@var{register-range}
18553 @opindex mfixed-range
18554 Generate code treating the given register range as fixed registers.
18555 A fixed register is one that the register allocator cannot use.  This is
18556 useful when compiling kernel code.  A register range is specified as
18557 two registers separated by a dash.  Multiple register ranges can be
18558 specified separated by a comma.
18560 @item -mlong-load-store
18561 @opindex mlong-load-store
18562 Generate 3-instruction load and store sequences as sometimes required by
18563 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18564 the HP compilers.
18566 @item -mportable-runtime
18567 @opindex mportable-runtime
18568 Use the portable calling conventions proposed by HP for ELF systems.
18570 @item -mgas
18571 @opindex mgas
18572 Enable the use of assembler directives only GAS understands.
18574 @item -mschedule=@var{cpu-type}
18575 @opindex mschedule
18576 Schedule code according to the constraints for the machine type
18577 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18578 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18579 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18580 proper scheduling option for your machine.  The default scheduling is
18581 @samp{8000}.
18583 @item -mlinker-opt
18584 @opindex mlinker-opt
18585 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18586 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18587 linkers in which they give bogus error messages when linking some programs.
18589 @item -msoft-float
18590 @opindex msoft-float
18591 Generate output containing library calls for floating point.
18592 @strong{Warning:} the requisite libraries are not available for all HPPA
18593 targets.  Normally the facilities of the machine's usual C compiler are
18594 used, but this cannot be done directly in cross-compilation.  You must make
18595 your own arrangements to provide suitable library functions for
18596 cross-compilation.
18598 @option{-msoft-float} changes the calling convention in the output file;
18599 therefore, it is only useful if you compile @emph{all} of a program with
18600 this option.  In particular, you need to compile @file{libgcc.a}, the
18601 library that comes with GCC, with @option{-msoft-float} in order for
18602 this to work.
18604 @item -msio
18605 @opindex msio
18606 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18607 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18608 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18609 options are available under HP-UX and HI-UX@.
18611 @item -mgnu-ld
18612 @opindex mgnu-ld
18613 Use options specific to GNU @command{ld}.
18614 This passes @option{-shared} to @command{ld} when
18615 building a shared library.  It is the default when GCC is configured,
18616 explicitly or implicitly, with the GNU linker.  This option does not
18617 affect which @command{ld} is called; it only changes what parameters
18618 are passed to that @command{ld}.
18619 The @command{ld} that is called is determined by the
18620 @option{--with-ld} configure option, GCC's program search path, and
18621 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18622 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18623 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18625 @item -mhp-ld
18626 @opindex mhp-ld
18627 Use options specific to HP @command{ld}.
18628 This passes @option{-b} to @command{ld} when building
18629 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18630 links.  It is the default when GCC is configured, explicitly or
18631 implicitly, with the HP linker.  This option does not affect
18632 which @command{ld} is called; it only changes what parameters are passed to that
18633 @command{ld}.
18634 The @command{ld} that is called is determined by the @option{--with-ld}
18635 configure option, GCC's program search path, and finally by the user's
18636 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18637 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18638 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18640 @item -mlong-calls
18641 @opindex mno-long-calls
18642 Generate code that uses long call sequences.  This ensures that a call
18643 is always able to reach linker generated stubs.  The default is to generate
18644 long calls only when the distance from the call site to the beginning
18645 of the function or translation unit, as the case may be, exceeds a
18646 predefined limit set by the branch type being used.  The limits for
18647 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18648 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18649 240,000 bytes.
18651 Distances are measured from the beginning of functions when using the
18652 @option{-ffunction-sections} option, or when using the @option{-mgas}
18653 and @option{-mno-portable-runtime} options together under HP-UX with
18654 the SOM linker.
18656 It is normally not desirable to use this option as it degrades
18657 performance.  However, it may be useful in large applications,
18658 particularly when partial linking is used to build the application.
18660 The types of long calls used depends on the capabilities of the
18661 assembler and linker, and the type of code being generated.  The
18662 impact on systems that support long absolute calls, and long pic
18663 symbol-difference or pc-relative calls should be relatively small.
18664 However, an indirect call is used on 32-bit ELF systems in pic code
18665 and it is quite long.
18667 @item -munix=@var{unix-std}
18668 @opindex march
18669 Generate compiler predefines and select a startfile for the specified
18670 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18671 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18672 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18673 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18674 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18675 and later.
18677 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18678 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18679 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18680 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18681 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18682 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18684 It is @emph{important} to note that this option changes the interfaces
18685 for various library routines.  It also affects the operational behavior
18686 of the C library.  Thus, @emph{extreme} care is needed in using this
18687 option.
18689 Library code that is intended to operate with more than one UNIX
18690 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18691 as appropriate.  Most GNU software doesn't provide this capability.
18693 @item -nolibdld
18694 @opindex nolibdld
18695 Suppress the generation of link options to search libdld.sl when the
18696 @option{-static} option is specified on HP-UX 10 and later.
18698 @item -static
18699 @opindex static
18700 The HP-UX implementation of setlocale in libc has a dependency on
18701 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18702 when the @option{-static} option is specified, special link options
18703 are needed to resolve this dependency.
18705 On HP-UX 10 and later, the GCC driver adds the necessary options to
18706 link with libdld.sl when the @option{-static} option is specified.
18707 This causes the resulting binary to be dynamic.  On the 64-bit port,
18708 the linkers generate dynamic binaries by default in any case.  The
18709 @option{-nolibdld} option can be used to prevent the GCC driver from
18710 adding these link options.
18712 @item -threads
18713 @opindex threads
18714 Add support for multithreading with the @dfn{dce thread} library
18715 under HP-UX@.  This option sets flags for both the preprocessor and
18716 linker.
18717 @end table
18719 @node IA-64 Options
18720 @subsection IA-64 Options
18721 @cindex IA-64 Options
18723 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18725 @table @gcctabopt
18726 @item -mbig-endian
18727 @opindex mbig-endian
18728 Generate code for a big-endian target.  This is the default for HP-UX@.
18730 @item -mlittle-endian
18731 @opindex mlittle-endian
18732 Generate code for a little-endian target.  This is the default for AIX5
18733 and GNU/Linux.
18735 @item -mgnu-as
18736 @itemx -mno-gnu-as
18737 @opindex mgnu-as
18738 @opindex mno-gnu-as
18739 Generate (or don't) code for the GNU assembler.  This is the default.
18740 @c Also, this is the default if the configure option @option{--with-gnu-as}
18741 @c is used.
18743 @item -mgnu-ld
18744 @itemx -mno-gnu-ld
18745 @opindex mgnu-ld
18746 @opindex mno-gnu-ld
18747 Generate (or don't) code for the GNU linker.  This is the default.
18748 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18749 @c is used.
18751 @item -mno-pic
18752 @opindex mno-pic
18753 Generate code that does not use a global pointer register.  The result
18754 is not position independent code, and violates the IA-64 ABI@.
18756 @item -mvolatile-asm-stop
18757 @itemx -mno-volatile-asm-stop
18758 @opindex mvolatile-asm-stop
18759 @opindex mno-volatile-asm-stop
18760 Generate (or don't) a stop bit immediately before and after volatile asm
18761 statements.
18763 @item -mregister-names
18764 @itemx -mno-register-names
18765 @opindex mregister-names
18766 @opindex mno-register-names
18767 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18768 the stacked registers.  This may make assembler output more readable.
18770 @item -mno-sdata
18771 @itemx -msdata
18772 @opindex mno-sdata
18773 @opindex msdata
18774 Disable (or enable) optimizations that use the small data section.  This may
18775 be useful for working around optimizer bugs.
18777 @item -mconstant-gp
18778 @opindex mconstant-gp
18779 Generate code that uses a single constant global pointer value.  This is
18780 useful when compiling kernel code.
18782 @item -mauto-pic
18783 @opindex mauto-pic
18784 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18785 This is useful when compiling firmware code.
18787 @item -minline-float-divide-min-latency
18788 @opindex minline-float-divide-min-latency
18789 Generate code for inline divides of floating-point values
18790 using the minimum latency algorithm.
18792 @item -minline-float-divide-max-throughput
18793 @opindex minline-float-divide-max-throughput
18794 Generate code for inline divides of floating-point values
18795 using the maximum throughput algorithm.
18797 @item -mno-inline-float-divide
18798 @opindex mno-inline-float-divide
18799 Do not generate inline code for divides of floating-point values.
18801 @item -minline-int-divide-min-latency
18802 @opindex minline-int-divide-min-latency
18803 Generate code for inline divides of integer values
18804 using the minimum latency algorithm.
18806 @item -minline-int-divide-max-throughput
18807 @opindex minline-int-divide-max-throughput
18808 Generate code for inline divides of integer values
18809 using the maximum throughput algorithm.
18811 @item -mno-inline-int-divide
18812 @opindex mno-inline-int-divide
18813 Do not generate inline code for divides of integer values.
18815 @item -minline-sqrt-min-latency
18816 @opindex minline-sqrt-min-latency
18817 Generate code for inline square roots
18818 using the minimum latency algorithm.
18820 @item -minline-sqrt-max-throughput
18821 @opindex minline-sqrt-max-throughput
18822 Generate code for inline square roots
18823 using the maximum throughput algorithm.
18825 @item -mno-inline-sqrt
18826 @opindex mno-inline-sqrt
18827 Do not generate inline code for @code{sqrt}.
18829 @item -mfused-madd
18830 @itemx -mno-fused-madd
18831 @opindex mfused-madd
18832 @opindex mno-fused-madd
18833 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18834 instructions.  The default is to use these instructions.
18836 @item -mno-dwarf2-asm
18837 @itemx -mdwarf2-asm
18838 @opindex mno-dwarf2-asm
18839 @opindex mdwarf2-asm
18840 Don't (or do) generate assembler code for the DWARF line number debugging
18841 info.  This may be useful when not using the GNU assembler.
18843 @item -mearly-stop-bits
18844 @itemx -mno-early-stop-bits
18845 @opindex mearly-stop-bits
18846 @opindex mno-early-stop-bits
18847 Allow stop bits to be placed earlier than immediately preceding the
18848 instruction that triggered the stop bit.  This can improve instruction
18849 scheduling, but does not always do so.
18851 @item -mfixed-range=@var{register-range}
18852 @opindex mfixed-range
18853 Generate code treating the given register range as fixed registers.
18854 A fixed register is one that the register allocator cannot use.  This is
18855 useful when compiling kernel code.  A register range is specified as
18856 two registers separated by a dash.  Multiple register ranges can be
18857 specified separated by a comma.
18859 @item -mtls-size=@var{tls-size}
18860 @opindex mtls-size
18861 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18864 @item -mtune=@var{cpu-type}
18865 @opindex mtune
18866 Tune the instruction scheduling for a particular CPU, Valid values are
18867 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18868 and @samp{mckinley}.
18870 @item -milp32
18871 @itemx -mlp64
18872 @opindex milp32
18873 @opindex mlp64
18874 Generate code for a 32-bit or 64-bit environment.
18875 The 32-bit environment sets int, long and pointer to 32 bits.
18876 The 64-bit environment sets int to 32 bits and long and pointer
18877 to 64 bits.  These are HP-UX specific flags.
18879 @item -mno-sched-br-data-spec
18880 @itemx -msched-br-data-spec
18881 @opindex mno-sched-br-data-spec
18882 @opindex msched-br-data-spec
18883 (Dis/En)able data speculative scheduling before reload.
18884 This results in generation of @code{ld.a} instructions and
18885 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18886 The default setting is disabled.
18888 @item -msched-ar-data-spec
18889 @itemx -mno-sched-ar-data-spec
18890 @opindex msched-ar-data-spec
18891 @opindex mno-sched-ar-data-spec
18892 (En/Dis)able data speculative scheduling after reload.
18893 This results in generation of @code{ld.a} instructions and
18894 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18895 The default setting is enabled.
18897 @item -mno-sched-control-spec
18898 @itemx -msched-control-spec
18899 @opindex mno-sched-control-spec
18900 @opindex msched-control-spec
18901 (Dis/En)able control speculative scheduling.  This feature is
18902 available only during region scheduling (i.e.@: before reload).
18903 This results in generation of the @code{ld.s} instructions and
18904 the corresponding check instructions @code{chk.s}.
18905 The default setting is disabled.
18907 @item -msched-br-in-data-spec
18908 @itemx -mno-sched-br-in-data-spec
18909 @opindex msched-br-in-data-spec
18910 @opindex mno-sched-br-in-data-spec
18911 (En/Dis)able speculative scheduling of the instructions that
18912 are dependent on the data speculative loads before reload.
18913 This is effective only with @option{-msched-br-data-spec} enabled.
18914 The default setting is enabled.
18916 @item -msched-ar-in-data-spec
18917 @itemx -mno-sched-ar-in-data-spec
18918 @opindex msched-ar-in-data-spec
18919 @opindex mno-sched-ar-in-data-spec
18920 (En/Dis)able speculative scheduling of the instructions that
18921 are dependent on the data speculative loads after reload.
18922 This is effective only with @option{-msched-ar-data-spec} enabled.
18923 The default setting is enabled.
18925 @item -msched-in-control-spec
18926 @itemx -mno-sched-in-control-spec
18927 @opindex msched-in-control-spec
18928 @opindex mno-sched-in-control-spec
18929 (En/Dis)able speculative scheduling of the instructions that
18930 are dependent on the control speculative loads.
18931 This is effective only with @option{-msched-control-spec} enabled.
18932 The default setting is enabled.
18934 @item -mno-sched-prefer-non-data-spec-insns
18935 @itemx -msched-prefer-non-data-spec-insns
18936 @opindex mno-sched-prefer-non-data-spec-insns
18937 @opindex msched-prefer-non-data-spec-insns
18938 If enabled, data-speculative instructions are chosen for schedule
18939 only if there are no other choices at the moment.  This makes
18940 the use of the data speculation much more conservative.
18941 The default setting is disabled.
18943 @item -mno-sched-prefer-non-control-spec-insns
18944 @itemx -msched-prefer-non-control-spec-insns
18945 @opindex mno-sched-prefer-non-control-spec-insns
18946 @opindex msched-prefer-non-control-spec-insns
18947 If enabled, control-speculative instructions are chosen for schedule
18948 only if there are no other choices at the moment.  This makes
18949 the use of the control speculation much more conservative.
18950 The default setting is disabled.
18952 @item -mno-sched-count-spec-in-critical-path
18953 @itemx -msched-count-spec-in-critical-path
18954 @opindex mno-sched-count-spec-in-critical-path
18955 @opindex msched-count-spec-in-critical-path
18956 If enabled, speculative dependencies are considered during
18957 computation of the instructions priorities.  This makes the use of the
18958 speculation a bit more conservative.
18959 The default setting is disabled.
18961 @item -msched-spec-ldc
18962 @opindex msched-spec-ldc
18963 Use a simple data speculation check.  This option is on by default.
18965 @item -msched-control-spec-ldc
18966 @opindex msched-spec-ldc
18967 Use a simple check for control speculation.  This option is on by default.
18969 @item -msched-stop-bits-after-every-cycle
18970 @opindex msched-stop-bits-after-every-cycle
18971 Place a stop bit after every cycle when scheduling.  This option is on
18972 by default.
18974 @item -msched-fp-mem-deps-zero-cost
18975 @opindex msched-fp-mem-deps-zero-cost
18976 Assume that floating-point stores and loads are not likely to cause a conflict
18977 when placed into the same instruction group.  This option is disabled by
18978 default.
18980 @item -msel-sched-dont-check-control-spec
18981 @opindex msel-sched-dont-check-control-spec
18982 Generate checks for control speculation in selective scheduling.
18983 This flag is disabled by default.
18985 @item -msched-max-memory-insns=@var{max-insns}
18986 @opindex msched-max-memory-insns
18987 Limit on the number of memory insns per instruction group, giving lower
18988 priority to subsequent memory insns attempting to schedule in the same
18989 instruction group. Frequently useful to prevent cache bank conflicts.
18990 The default value is 1.
18992 @item -msched-max-memory-insns-hard-limit
18993 @opindex msched-max-memory-insns-hard-limit
18994 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18995 disallowing more than that number in an instruction group.
18996 Otherwise, the limit is ``soft'', meaning that non-memory operations
18997 are preferred when the limit is reached, but memory operations may still
18998 be scheduled.
19000 @end table
19002 @node LM32 Options
19003 @subsection LM32 Options
19004 @cindex LM32 options
19006 These @option{-m} options are defined for the LatticeMico32 architecture:
19008 @table @gcctabopt
19009 @item -mbarrel-shift-enabled
19010 @opindex mbarrel-shift-enabled
19011 Enable barrel-shift instructions.
19013 @item -mdivide-enabled
19014 @opindex mdivide-enabled
19015 Enable divide and modulus instructions.
19017 @item -mmultiply-enabled
19018 @opindex multiply-enabled
19019 Enable multiply instructions.
19021 @item -msign-extend-enabled
19022 @opindex msign-extend-enabled
19023 Enable sign extend instructions.
19025 @item -muser-enabled
19026 @opindex muser-enabled
19027 Enable user-defined instructions.
19029 @end table
19031 @node M32C Options
19032 @subsection M32C Options
19033 @cindex M32C options
19035 @table @gcctabopt
19036 @item -mcpu=@var{name}
19037 @opindex mcpu=
19038 Select the CPU for which code is generated.  @var{name} may be one of
19039 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19040 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19041 the M32C/80 series.
19043 @item -msim
19044 @opindex msim
19045 Specifies that the program will be run on the simulator.  This causes
19046 an alternate runtime library to be linked in which supports, for
19047 example, file I/O@.  You must not use this option when generating
19048 programs that will run on real hardware; you must provide your own
19049 runtime library for whatever I/O functions are needed.
19051 @item -memregs=@var{number}
19052 @opindex memregs=
19053 Specifies the number of memory-based pseudo-registers GCC uses
19054 during code generation.  These pseudo-registers are used like real
19055 registers, so there is a tradeoff between GCC's ability to fit the
19056 code into available registers, and the performance penalty of using
19057 memory instead of registers.  Note that all modules in a program must
19058 be compiled with the same value for this option.  Because of that, you
19059 must not use this option with GCC's default runtime libraries.
19061 @end table
19063 @node M32R/D Options
19064 @subsection M32R/D Options
19065 @cindex M32R/D options
19067 These @option{-m} options are defined for Renesas M32R/D architectures:
19069 @table @gcctabopt
19070 @item -m32r2
19071 @opindex m32r2
19072 Generate code for the M32R/2@.
19074 @item -m32rx
19075 @opindex m32rx
19076 Generate code for the M32R/X@.
19078 @item -m32r
19079 @opindex m32r
19080 Generate code for the M32R@.  This is the default.
19082 @item -mmodel=small
19083 @opindex mmodel=small
19084 Assume all objects live in the lower 16MB of memory (so that their addresses
19085 can be loaded with the @code{ld24} instruction), and assume all subroutines
19086 are reachable with the @code{bl} instruction.
19087 This is the default.
19089 The addressability of a particular object can be set with the
19090 @code{model} attribute.
19092 @item -mmodel=medium
19093 @opindex mmodel=medium
19094 Assume objects may be anywhere in the 32-bit address space (the compiler
19095 generates @code{seth/add3} instructions to load their addresses), and
19096 assume all subroutines are reachable with the @code{bl} instruction.
19098 @item -mmodel=large
19099 @opindex mmodel=large
19100 Assume objects may be anywhere in the 32-bit address space (the compiler
19101 generates @code{seth/add3} instructions to load their addresses), and
19102 assume subroutines may not be reachable with the @code{bl} instruction
19103 (the compiler generates the much slower @code{seth/add3/jl}
19104 instruction sequence).
19106 @item -msdata=none
19107 @opindex msdata=none
19108 Disable use of the small data area.  Variables are put into
19109 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19110 @code{section} attribute has been specified).
19111 This is the default.
19113 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19114 Objects may be explicitly put in the small data area with the
19115 @code{section} attribute using one of these sections.
19117 @item -msdata=sdata
19118 @opindex msdata=sdata
19119 Put small global and static data in the small data area, but do not
19120 generate special code to reference them.
19122 @item -msdata=use
19123 @opindex msdata=use
19124 Put small global and static data in the small data area, and generate
19125 special instructions to reference them.
19127 @item -G @var{num}
19128 @opindex G
19129 @cindex smaller data references
19130 Put global and static objects less than or equal to @var{num} bytes
19131 into the small data or BSS sections instead of the normal data or BSS
19132 sections.  The default value of @var{num} is 8.
19133 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19134 for this option to have any effect.
19136 All modules should be compiled with the same @option{-G @var{num}} value.
19137 Compiling with different values of @var{num} may or may not work; if it
19138 doesn't the linker gives an error message---incorrect code is not
19139 generated.
19141 @item -mdebug
19142 @opindex mdebug
19143 Makes the M32R-specific code in the compiler display some statistics
19144 that might help in debugging programs.
19146 @item -malign-loops
19147 @opindex malign-loops
19148 Align all loops to a 32-byte boundary.
19150 @item -mno-align-loops
19151 @opindex mno-align-loops
19152 Do not enforce a 32-byte alignment for loops.  This is the default.
19154 @item -missue-rate=@var{number}
19155 @opindex missue-rate=@var{number}
19156 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19157 or 2.
19159 @item -mbranch-cost=@var{number}
19160 @opindex mbranch-cost=@var{number}
19161 @var{number} can only be 1 or 2.  If it is 1 then branches are
19162 preferred over conditional code, if it is 2, then the opposite applies.
19164 @item -mflush-trap=@var{number}
19165 @opindex mflush-trap=@var{number}
19166 Specifies the trap number to use to flush the cache.  The default is
19167 12.  Valid numbers are between 0 and 15 inclusive.
19169 @item -mno-flush-trap
19170 @opindex mno-flush-trap
19171 Specifies that the cache cannot be flushed by using a trap.
19173 @item -mflush-func=@var{name}
19174 @opindex mflush-func=@var{name}
19175 Specifies the name of the operating system function to call to flush
19176 the cache.  The default is @samp{_flush_cache}, but a function call
19177 is only used if a trap is not available.
19179 @item -mno-flush-func
19180 @opindex mno-flush-func
19181 Indicates that there is no OS function for flushing the cache.
19183 @end table
19185 @node M680x0 Options
19186 @subsection M680x0 Options
19187 @cindex M680x0 options
19189 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19190 The default settings depend on which architecture was selected when
19191 the compiler was configured; the defaults for the most common choices
19192 are given below.
19194 @table @gcctabopt
19195 @item -march=@var{arch}
19196 @opindex march
19197 Generate code for a specific M680x0 or ColdFire instruction set
19198 architecture.  Permissible values of @var{arch} for M680x0
19199 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19200 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19201 architectures are selected according to Freescale's ISA classification
19202 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19203 @samp{isab} and @samp{isac}.
19205 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19206 code for a ColdFire target.  The @var{arch} in this macro is one of the
19207 @option{-march} arguments given above.
19209 When used together, @option{-march} and @option{-mtune} select code
19210 that runs on a family of similar processors but that is optimized
19211 for a particular microarchitecture.
19213 @item -mcpu=@var{cpu}
19214 @opindex mcpu
19215 Generate code for a specific M680x0 or ColdFire processor.
19216 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19217 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19218 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19219 below, which also classifies the CPUs into families:
19221 @multitable @columnfractions 0.20 0.80
19222 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19223 @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}
19224 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19225 @item @samp{5206e} @tab @samp{5206e}
19226 @item @samp{5208} @tab @samp{5207} @samp{5208}
19227 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19228 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19229 @item @samp{5216} @tab @samp{5214} @samp{5216}
19230 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19231 @item @samp{5225} @tab @samp{5224} @samp{5225}
19232 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19233 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19234 @item @samp{5249} @tab @samp{5249}
19235 @item @samp{5250} @tab @samp{5250}
19236 @item @samp{5271} @tab @samp{5270} @samp{5271}
19237 @item @samp{5272} @tab @samp{5272}
19238 @item @samp{5275} @tab @samp{5274} @samp{5275}
19239 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19240 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19241 @item @samp{5307} @tab @samp{5307}
19242 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19243 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19244 @item @samp{5407} @tab @samp{5407}
19245 @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}
19246 @end multitable
19248 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19249 @var{arch} is compatible with @var{cpu}.  Other combinations of
19250 @option{-mcpu} and @option{-march} are rejected.
19252 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19253 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19254 where the value of @var{family} is given by the table above.
19256 @item -mtune=@var{tune}
19257 @opindex mtune
19258 Tune the code for a particular microarchitecture within the
19259 constraints set by @option{-march} and @option{-mcpu}.
19260 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19261 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19262 and @samp{cpu32}.  The ColdFire microarchitectures
19263 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19265 You can also use @option{-mtune=68020-40} for code that needs
19266 to run relatively well on 68020, 68030 and 68040 targets.
19267 @option{-mtune=68020-60} is similar but includes 68060 targets
19268 as well.  These two options select the same tuning decisions as
19269 @option{-m68020-40} and @option{-m68020-60} respectively.
19271 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19272 when tuning for 680x0 architecture @var{arch}.  It also defines
19273 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19274 option is used.  If GCC is tuning for a range of architectures,
19275 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19276 it defines the macros for every architecture in the range.
19278 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19279 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19280 of the arguments given above.
19282 @item -m68000
19283 @itemx -mc68000
19284 @opindex m68000
19285 @opindex mc68000
19286 Generate output for a 68000.  This is the default
19287 when the compiler is configured for 68000-based systems.
19288 It is equivalent to @option{-march=68000}.
19290 Use this option for microcontrollers with a 68000 or EC000 core,
19291 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19293 @item -m68010
19294 @opindex m68010
19295 Generate output for a 68010.  This is the default
19296 when the compiler is configured for 68010-based systems.
19297 It is equivalent to @option{-march=68010}.
19299 @item -m68020
19300 @itemx -mc68020
19301 @opindex m68020
19302 @opindex mc68020
19303 Generate output for a 68020.  This is the default
19304 when the compiler is configured for 68020-based systems.
19305 It is equivalent to @option{-march=68020}.
19307 @item -m68030
19308 @opindex m68030
19309 Generate output for a 68030.  This is the default when the compiler is
19310 configured for 68030-based systems.  It is equivalent to
19311 @option{-march=68030}.
19313 @item -m68040
19314 @opindex m68040
19315 Generate output for a 68040.  This is the default when the compiler is
19316 configured for 68040-based systems.  It is equivalent to
19317 @option{-march=68040}.
19319 This option inhibits the use of 68881/68882 instructions that have to be
19320 emulated by software on the 68040.  Use this option if your 68040 does not
19321 have code to emulate those instructions.
19323 @item -m68060
19324 @opindex m68060
19325 Generate output for a 68060.  This is the default when the compiler is
19326 configured for 68060-based systems.  It is equivalent to
19327 @option{-march=68060}.
19329 This option inhibits the use of 68020 and 68881/68882 instructions that
19330 have to be emulated by software on the 68060.  Use this option if your 68060
19331 does not have code to emulate those instructions.
19333 @item -mcpu32
19334 @opindex mcpu32
19335 Generate output for a CPU32.  This is the default
19336 when the compiler is configured for CPU32-based systems.
19337 It is equivalent to @option{-march=cpu32}.
19339 Use this option for microcontrollers with a
19340 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19341 68336, 68340, 68341, 68349 and 68360.
19343 @item -m5200
19344 @opindex m5200
19345 Generate output for a 520X ColdFire CPU@.  This is the default
19346 when the compiler is configured for 520X-based systems.
19347 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19348 in favor of that option.
19350 Use this option for microcontroller with a 5200 core, including
19351 the MCF5202, MCF5203, MCF5204 and MCF5206.
19353 @item -m5206e
19354 @opindex m5206e
19355 Generate output for a 5206e ColdFire CPU@.  The option is now
19356 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19358 @item -m528x
19359 @opindex m528x
19360 Generate output for a member of the ColdFire 528X family.
19361 The option is now deprecated in favor of the equivalent
19362 @option{-mcpu=528x}.
19364 @item -m5307
19365 @opindex m5307
19366 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19367 in favor of the equivalent @option{-mcpu=5307}.
19369 @item -m5407
19370 @opindex m5407
19371 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19372 in favor of the equivalent @option{-mcpu=5407}.
19374 @item -mcfv4e
19375 @opindex mcfv4e
19376 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19377 This includes use of hardware floating-point instructions.
19378 The option is equivalent to @option{-mcpu=547x}, and is now
19379 deprecated in favor of that option.
19381 @item -m68020-40
19382 @opindex m68020-40
19383 Generate output for a 68040, without using any of the new instructions.
19384 This results in code that can run relatively efficiently on either a
19385 68020/68881 or a 68030 or a 68040.  The generated code does use the
19386 68881 instructions that are emulated on the 68040.
19388 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19390 @item -m68020-60
19391 @opindex m68020-60
19392 Generate output for a 68060, without using any of the new instructions.
19393 This results in code that can run relatively efficiently on either a
19394 68020/68881 or a 68030 or a 68040.  The generated code does use the
19395 68881 instructions that are emulated on the 68060.
19397 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19399 @item -mhard-float
19400 @itemx -m68881
19401 @opindex mhard-float
19402 @opindex m68881
19403 Generate floating-point instructions.  This is the default for 68020
19404 and above, and for ColdFire devices that have an FPU@.  It defines the
19405 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19406 on ColdFire targets.
19408 @item -msoft-float
19409 @opindex msoft-float
19410 Do not generate floating-point instructions; use library calls instead.
19411 This is the default for 68000, 68010, and 68832 targets.  It is also
19412 the default for ColdFire devices that have no FPU.
19414 @item -mdiv
19415 @itemx -mno-div
19416 @opindex mdiv
19417 @opindex mno-div
19418 Generate (do not generate) ColdFire hardware divide and remainder
19419 instructions.  If @option{-march} is used without @option{-mcpu},
19420 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19421 architectures.  Otherwise, the default is taken from the target CPU
19422 (either the default CPU, or the one specified by @option{-mcpu}).  For
19423 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19424 @option{-mcpu=5206e}.
19426 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19428 @item -mshort
19429 @opindex mshort
19430 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19431 Additionally, parameters passed on the stack are also aligned to a
19432 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19434 @item -mno-short
19435 @opindex mno-short
19436 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19438 @item -mnobitfield
19439 @itemx -mno-bitfield
19440 @opindex mnobitfield
19441 @opindex mno-bitfield
19442 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19443 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19445 @item -mbitfield
19446 @opindex mbitfield
19447 Do use the bit-field instructions.  The @option{-m68020} option implies
19448 @option{-mbitfield}.  This is the default if you use a configuration
19449 designed for a 68020.
19451 @item -mrtd
19452 @opindex mrtd
19453 Use a different function-calling convention, in which functions
19454 that take a fixed number of arguments return with the @code{rtd}
19455 instruction, which pops their arguments while returning.  This
19456 saves one instruction in the caller since there is no need to pop
19457 the arguments there.
19459 This calling convention is incompatible with the one normally
19460 used on Unix, so you cannot use it if you need to call libraries
19461 compiled with the Unix compiler.
19463 Also, you must provide function prototypes for all functions that
19464 take variable numbers of arguments (including @code{printf});
19465 otherwise incorrect code is generated for calls to those
19466 functions.
19468 In addition, seriously incorrect code results if you call a
19469 function with too many arguments.  (Normally, extra arguments are
19470 harmlessly ignored.)
19472 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19473 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19475 @item -mno-rtd
19476 @opindex mno-rtd
19477 Do not use the calling conventions selected by @option{-mrtd}.
19478 This is the default.
19480 @item -malign-int
19481 @itemx -mno-align-int
19482 @opindex malign-int
19483 @opindex mno-align-int
19484 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19485 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19486 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19487 Aligning variables on 32-bit boundaries produces code that runs somewhat
19488 faster on processors with 32-bit busses at the expense of more memory.
19490 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19491 aligns structures containing the above types differently than
19492 most published application binary interface specifications for the m68k.
19494 @item -mpcrel
19495 @opindex mpcrel
19496 Use the pc-relative addressing mode of the 68000 directly, instead of
19497 using a global offset table.  At present, this option implies @option{-fpic},
19498 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19499 not presently supported with @option{-mpcrel}, though this could be supported for
19500 68020 and higher processors.
19502 @item -mno-strict-align
19503 @itemx -mstrict-align
19504 @opindex mno-strict-align
19505 @opindex mstrict-align
19506 Do not (do) assume that unaligned memory references are handled by
19507 the system.
19509 @item -msep-data
19510 Generate code that allows the data segment to be located in a different
19511 area of memory from the text segment.  This allows for execute-in-place in
19512 an environment without virtual memory management.  This option implies
19513 @option{-fPIC}.
19515 @item -mno-sep-data
19516 Generate code that assumes that the data segment follows the text segment.
19517 This is the default.
19519 @item -mid-shared-library
19520 Generate code that supports shared libraries via the library ID method.
19521 This allows for execute-in-place and shared libraries in an environment
19522 without virtual memory management.  This option implies @option{-fPIC}.
19524 @item -mno-id-shared-library
19525 Generate code that doesn't assume ID-based shared libraries are being used.
19526 This is the default.
19528 @item -mshared-library-id=n
19529 Specifies the identification number of the ID-based shared library being
19530 compiled.  Specifying a value of 0 generates more compact code; specifying
19531 other values forces the allocation of that number to the current
19532 library, but is no more space- or time-efficient than omitting this option.
19534 @item -mxgot
19535 @itemx -mno-xgot
19536 @opindex mxgot
19537 @opindex mno-xgot
19538 When generating position-independent code for ColdFire, generate code
19539 that works if the GOT has more than 8192 entries.  This code is
19540 larger and slower than code generated without this option.  On M680x0
19541 processors, this option is not needed; @option{-fPIC} suffices.
19543 GCC normally uses a single instruction to load values from the GOT@.
19544 While this is relatively efficient, it only works if the GOT
19545 is smaller than about 64k.  Anything larger causes the linker
19546 to report an error such as:
19548 @cindex relocation truncated to fit (ColdFire)
19549 @smallexample
19550 relocation truncated to fit: R_68K_GOT16O foobar
19551 @end smallexample
19553 If this happens, you should recompile your code with @option{-mxgot}.
19554 It should then work with very large GOTs.  However, code generated with
19555 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19556 the value of a global symbol.
19558 Note that some linkers, including newer versions of the GNU linker,
19559 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19560 you should only need to use @option{-mxgot} when compiling a single
19561 object file that accesses more than 8192 GOT entries.  Very few do.
19563 These options have no effect unless GCC is generating
19564 position-independent code.
19566 @item -mlong-jump-table-offsets
19567 @opindex mlong-jump-table-offsets
19568 Use 32-bit offsets in @code{switch} tables.  The default is to use
19569 16-bit offsets.
19571 @end table
19573 @node MCore Options
19574 @subsection MCore Options
19575 @cindex MCore options
19577 These are the @samp{-m} options defined for the Motorola M*Core
19578 processors.
19580 @table @gcctabopt
19582 @item -mhardlit
19583 @itemx -mno-hardlit
19584 @opindex mhardlit
19585 @opindex mno-hardlit
19586 Inline constants into the code stream if it can be done in two
19587 instructions or less.
19589 @item -mdiv
19590 @itemx -mno-div
19591 @opindex mdiv
19592 @opindex mno-div
19593 Use the divide instruction.  (Enabled by default).
19595 @item -mrelax-immediate
19596 @itemx -mno-relax-immediate
19597 @opindex mrelax-immediate
19598 @opindex mno-relax-immediate
19599 Allow arbitrary-sized immediates in bit operations.
19601 @item -mwide-bitfields
19602 @itemx -mno-wide-bitfields
19603 @opindex mwide-bitfields
19604 @opindex mno-wide-bitfields
19605 Always treat bit-fields as @code{int}-sized.
19607 @item -m4byte-functions
19608 @itemx -mno-4byte-functions
19609 @opindex m4byte-functions
19610 @opindex mno-4byte-functions
19611 Force all functions to be aligned to a 4-byte boundary.
19613 @item -mcallgraph-data
19614 @itemx -mno-callgraph-data
19615 @opindex mcallgraph-data
19616 @opindex mno-callgraph-data
19617 Emit callgraph information.
19619 @item -mslow-bytes
19620 @itemx -mno-slow-bytes
19621 @opindex mslow-bytes
19622 @opindex mno-slow-bytes
19623 Prefer word access when reading byte quantities.
19625 @item -mlittle-endian
19626 @itemx -mbig-endian
19627 @opindex mlittle-endian
19628 @opindex mbig-endian
19629 Generate code for a little-endian target.
19631 @item -m210
19632 @itemx -m340
19633 @opindex m210
19634 @opindex m340
19635 Generate code for the 210 processor.
19637 @item -mno-lsim
19638 @opindex mno-lsim
19639 Assume that runtime support has been provided and so omit the
19640 simulator library (@file{libsim.a)} from the linker command line.
19642 @item -mstack-increment=@var{size}
19643 @opindex mstack-increment
19644 Set the maximum amount for a single stack increment operation.  Large
19645 values can increase the speed of programs that contain functions
19646 that need a large amount of stack space, but they can also trigger a
19647 segmentation fault if the stack is extended too much.  The default
19648 value is 0x1000.
19650 @end table
19652 @node MeP Options
19653 @subsection MeP Options
19654 @cindex MeP options
19656 @table @gcctabopt
19658 @item -mabsdiff
19659 @opindex mabsdiff
19660 Enables the @code{abs} instruction, which is the absolute difference
19661 between two registers.
19663 @item -mall-opts
19664 @opindex mall-opts
19665 Enables all the optional instructions---average, multiply, divide, bit
19666 operations, leading zero, absolute difference, min/max, clip, and
19667 saturation.
19670 @item -maverage
19671 @opindex maverage
19672 Enables the @code{ave} instruction, which computes the average of two
19673 registers.
19675 @item -mbased=@var{n}
19676 @opindex mbased=
19677 Variables of size @var{n} bytes or smaller are placed in the
19678 @code{.based} section by default.  Based variables use the @code{$tp}
19679 register as a base register, and there is a 128-byte limit to the
19680 @code{.based} section.
19682 @item -mbitops
19683 @opindex mbitops
19684 Enables the bit operation instructions---bit test (@code{btstm}), set
19685 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19686 test-and-set (@code{tas}).
19688 @item -mc=@var{name}
19689 @opindex mc=
19690 Selects which section constant data is placed in.  @var{name} may
19691 be @samp{tiny}, @samp{near}, or @samp{far}.
19693 @item -mclip
19694 @opindex mclip
19695 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19696 useful unless you also provide @option{-mminmax}.
19698 @item -mconfig=@var{name}
19699 @opindex mconfig=
19700 Selects one of the built-in core configurations.  Each MeP chip has
19701 one or more modules in it; each module has a core CPU and a variety of
19702 coprocessors, optional instructions, and peripherals.  The
19703 @code{MeP-Integrator} tool, not part of GCC, provides these
19704 configurations through this option; using this option is the same as
19705 using all the corresponding command-line options.  The default
19706 configuration is @samp{default}.
19708 @item -mcop
19709 @opindex mcop
19710 Enables the coprocessor instructions.  By default, this is a 32-bit
19711 coprocessor.  Note that the coprocessor is normally enabled via the
19712 @option{-mconfig=} option.
19714 @item -mcop32
19715 @opindex mcop32
19716 Enables the 32-bit coprocessor's instructions.
19718 @item -mcop64
19719 @opindex mcop64
19720 Enables the 64-bit coprocessor's instructions.
19722 @item -mivc2
19723 @opindex mivc2
19724 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19726 @item -mdc
19727 @opindex mdc
19728 Causes constant variables to be placed in the @code{.near} section.
19730 @item -mdiv
19731 @opindex mdiv
19732 Enables the @code{div} and @code{divu} instructions.
19734 @item -meb
19735 @opindex meb
19736 Generate big-endian code.
19738 @item -mel
19739 @opindex mel
19740 Generate little-endian code.
19742 @item -mio-volatile
19743 @opindex mio-volatile
19744 Tells the compiler that any variable marked with the @code{io}
19745 attribute is to be considered volatile.
19747 @item -ml
19748 @opindex ml
19749 Causes variables to be assigned to the @code{.far} section by default.
19751 @item -mleadz
19752 @opindex mleadz
19753 Enables the @code{leadz} (leading zero) instruction.
19755 @item -mm
19756 @opindex mm
19757 Causes variables to be assigned to the @code{.near} section by default.
19759 @item -mminmax
19760 @opindex mminmax
19761 Enables the @code{min} and @code{max} instructions.
19763 @item -mmult
19764 @opindex mmult
19765 Enables the multiplication and multiply-accumulate instructions.
19767 @item -mno-opts
19768 @opindex mno-opts
19769 Disables all the optional instructions enabled by @option{-mall-opts}.
19771 @item -mrepeat
19772 @opindex mrepeat
19773 Enables the @code{repeat} and @code{erepeat} instructions, used for
19774 low-overhead looping.
19776 @item -ms
19777 @opindex ms
19778 Causes all variables to default to the @code{.tiny} section.  Note
19779 that there is a 65536-byte limit to this section.  Accesses to these
19780 variables use the @code{%gp} base register.
19782 @item -msatur
19783 @opindex msatur
19784 Enables the saturation instructions.  Note that the compiler does not
19785 currently generate these itself, but this option is included for
19786 compatibility with other tools, like @code{as}.
19788 @item -msdram
19789 @opindex msdram
19790 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19792 @item -msim
19793 @opindex msim
19794 Link the simulator run-time libraries.
19796 @item -msimnovec
19797 @opindex msimnovec
19798 Link the simulator runtime libraries, excluding built-in support
19799 for reset and exception vectors and tables.
19801 @item -mtf
19802 @opindex mtf
19803 Causes all functions to default to the @code{.far} section.  Without
19804 this option, functions default to the @code{.near} section.
19806 @item -mtiny=@var{n}
19807 @opindex mtiny=
19808 Variables that are @var{n} bytes or smaller are allocated to the
19809 @code{.tiny} section.  These variables use the @code{$gp} base
19810 register.  The default for this option is 4, but note that there's a
19811 65536-byte limit to the @code{.tiny} section.
19813 @end table
19815 @node MicroBlaze Options
19816 @subsection MicroBlaze Options
19817 @cindex MicroBlaze Options
19819 @table @gcctabopt
19821 @item -msoft-float
19822 @opindex msoft-float
19823 Use software emulation for floating point (default).
19825 @item -mhard-float
19826 @opindex mhard-float
19827 Use hardware floating-point instructions.
19829 @item -mmemcpy
19830 @opindex mmemcpy
19831 Do not optimize block moves, use @code{memcpy}.
19833 @item -mno-clearbss
19834 @opindex mno-clearbss
19835 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19837 @item -mcpu=@var{cpu-type}
19838 @opindex mcpu=
19839 Use features of, and schedule code for, the given CPU.
19840 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19841 where @var{X} is a major version, @var{YY} is the minor version, and
19842 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19843 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19845 @item -mxl-soft-mul
19846 @opindex mxl-soft-mul
19847 Use software multiply emulation (default).
19849 @item -mxl-soft-div
19850 @opindex mxl-soft-div
19851 Use software emulation for divides (default).
19853 @item -mxl-barrel-shift
19854 @opindex mxl-barrel-shift
19855 Use the hardware barrel shifter.
19857 @item -mxl-pattern-compare
19858 @opindex mxl-pattern-compare
19859 Use pattern compare instructions.
19861 @item -msmall-divides
19862 @opindex msmall-divides
19863 Use table lookup optimization for small signed integer divisions.
19865 @item -mxl-stack-check
19866 @opindex mxl-stack-check
19867 This option is deprecated.  Use @option{-fstack-check} instead.
19869 @item -mxl-gp-opt
19870 @opindex mxl-gp-opt
19871 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19873 @item -mxl-multiply-high
19874 @opindex mxl-multiply-high
19875 Use multiply high instructions for high part of 32x32 multiply.
19877 @item -mxl-float-convert
19878 @opindex mxl-float-convert
19879 Use hardware floating-point conversion instructions.
19881 @item -mxl-float-sqrt
19882 @opindex mxl-float-sqrt
19883 Use hardware floating-point square root instruction.
19885 @item -mbig-endian
19886 @opindex mbig-endian
19887 Generate code for a big-endian target.
19889 @item -mlittle-endian
19890 @opindex mlittle-endian
19891 Generate code for a little-endian target.
19893 @item -mxl-reorder
19894 @opindex mxl-reorder
19895 Use reorder instructions (swap and byte reversed load/store).
19897 @item -mxl-mode-@var{app-model}
19898 Select application model @var{app-model}.  Valid models are
19899 @table @samp
19900 @item executable
19901 normal executable (default), uses startup code @file{crt0.o}.
19903 @item xmdstub
19904 for use with Xilinx Microprocessor Debugger (XMD) based
19905 software intrusive debug agent called xmdstub. This uses startup file
19906 @file{crt1.o} and sets the start address of the program to 0x800.
19908 @item bootstrap
19909 for applications that are loaded using a bootloader.
19910 This model uses startup file @file{crt2.o} which does not contain a processor
19911 reset vector handler. This is suitable for transferring control on a
19912 processor reset to the bootloader rather than the application.
19914 @item novectors
19915 for applications that do not require any of the
19916 MicroBlaze vectors. This option may be useful for applications running
19917 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19918 @end table
19920 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19921 @option{-mxl-mode-@var{app-model}}.
19923 @end table
19925 @node MIPS Options
19926 @subsection MIPS Options
19927 @cindex MIPS options
19929 @table @gcctabopt
19931 @item -EB
19932 @opindex EB
19933 Generate big-endian code.
19935 @item -EL
19936 @opindex EL
19937 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19938 configurations.
19940 @item -march=@var{arch}
19941 @opindex march
19942 Generate code that runs on @var{arch}, which can be the name of a
19943 generic MIPS ISA, or the name of a particular processor.
19944 The ISA names are:
19945 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19946 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19947 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19948 @samp{mips64r5} and @samp{mips64r6}.
19949 The processor names are:
19950 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19951 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19952 @samp{5kc}, @samp{5kf},
19953 @samp{20kc},
19954 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19955 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19956 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19957 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19958 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19959 @samp{i6400},
19960 @samp{interaptiv},
19961 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19962 @samp{m4k},
19963 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19964 @samp{m5100}, @samp{m5101},
19965 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19966 @samp{orion},
19967 @samp{p5600},
19968 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19969 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19970 @samp{rm7000}, @samp{rm9000},
19971 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19972 @samp{sb1},
19973 @samp{sr71000},
19974 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19975 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19976 @samp{xlr} and @samp{xlp}.
19977 The special value @samp{from-abi} selects the
19978 most compatible architecture for the selected ABI (that is,
19979 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19981 The native Linux/GNU toolchain also supports the value @samp{native},
19982 which selects the best architecture option for the host processor.
19983 @option{-march=native} has no effect if GCC does not recognize
19984 the processor.
19986 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19987 (for example, @option{-march=r2k}).  Prefixes are optional, and
19988 @samp{vr} may be written @samp{r}.
19990 Names of the form @samp{@var{n}f2_1} refer to processors with
19991 FPUs clocked at half the rate of the core, names of the form
19992 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19993 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19994 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19995 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19996 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19997 accepted as synonyms for @samp{@var{n}f1_1}.
19999 GCC defines two macros based on the value of this option.  The first
20000 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20001 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20002 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20003 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20004 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20006 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20007 above.  In other words, it has the full prefix and does not
20008 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20009 the macro names the resolved architecture (either @code{"mips1"} or
20010 @code{"mips3"}).  It names the default architecture when no
20011 @option{-march} option is given.
20013 @item -mtune=@var{arch}
20014 @opindex mtune
20015 Optimize for @var{arch}.  Among other things, this option controls
20016 the way instructions are scheduled, and the perceived cost of arithmetic
20017 operations.  The list of @var{arch} values is the same as for
20018 @option{-march}.
20020 When this option is not used, GCC optimizes for the processor
20021 specified by @option{-march}.  By using @option{-march} and
20022 @option{-mtune} together, it is possible to generate code that
20023 runs on a family of processors, but optimize the code for one
20024 particular member of that family.
20026 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20027 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20028 @option{-march} ones described above.
20030 @item -mips1
20031 @opindex mips1
20032 Equivalent to @option{-march=mips1}.
20034 @item -mips2
20035 @opindex mips2
20036 Equivalent to @option{-march=mips2}.
20038 @item -mips3
20039 @opindex mips3
20040 Equivalent to @option{-march=mips3}.
20042 @item -mips4
20043 @opindex mips4
20044 Equivalent to @option{-march=mips4}.
20046 @item -mips32
20047 @opindex mips32
20048 Equivalent to @option{-march=mips32}.
20050 @item -mips32r3
20051 @opindex mips32r3
20052 Equivalent to @option{-march=mips32r3}.
20054 @item -mips32r5
20055 @opindex mips32r5
20056 Equivalent to @option{-march=mips32r5}.
20058 @item -mips32r6
20059 @opindex mips32r6
20060 Equivalent to @option{-march=mips32r6}.
20062 @item -mips64
20063 @opindex mips64
20064 Equivalent to @option{-march=mips64}.
20066 @item -mips64r2
20067 @opindex mips64r2
20068 Equivalent to @option{-march=mips64r2}.
20070 @item -mips64r3
20071 @opindex mips64r3
20072 Equivalent to @option{-march=mips64r3}.
20074 @item -mips64r5
20075 @opindex mips64r5
20076 Equivalent to @option{-march=mips64r5}.
20078 @item -mips64r6
20079 @opindex mips64r6
20080 Equivalent to @option{-march=mips64r6}.
20082 @item -mips16
20083 @itemx -mno-mips16
20084 @opindex mips16
20085 @opindex mno-mips16
20086 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20087 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20089 MIPS16 code generation can also be controlled on a per-function basis
20090 by means of @code{mips16} and @code{nomips16} attributes.
20091 @xref{Function Attributes}, for more information.
20093 @item -mflip-mips16
20094 @opindex mflip-mips16
20095 Generate MIPS16 code on alternating functions.  This option is provided
20096 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20097 not intended for ordinary use in compiling user code.
20099 @item -minterlink-compressed
20100 @item -mno-interlink-compressed
20101 @opindex minterlink-compressed
20102 @opindex mno-interlink-compressed
20103 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20104 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20106 For example, code using the standard ISA encoding cannot jump directly
20107 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20108 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20109 knows that the target of the jump is not compressed.
20111 @item -minterlink-mips16
20112 @itemx -mno-interlink-mips16
20113 @opindex minterlink-mips16
20114 @opindex mno-interlink-mips16
20115 Aliases of @option{-minterlink-compressed} and
20116 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20117 and are retained for backwards compatibility.
20119 @item -mabi=32
20120 @itemx -mabi=o64
20121 @itemx -mabi=n32
20122 @itemx -mabi=64
20123 @itemx -mabi=eabi
20124 @opindex mabi=32
20125 @opindex mabi=o64
20126 @opindex mabi=n32
20127 @opindex mabi=64
20128 @opindex mabi=eabi
20129 Generate code for the given ABI@.
20131 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20132 generates 64-bit code when you select a 64-bit architecture, but you
20133 can use @option{-mgp32} to get 32-bit code instead.
20135 For information about the O64 ABI, see
20136 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20138 GCC supports a variant of the o32 ABI in which floating-point registers
20139 are 64 rather than 32 bits wide.  You can select this combination with
20140 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20141 and @code{mfhc1} instructions and is therefore only supported for
20142 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20144 The register assignments for arguments and return values remain the
20145 same, but each scalar value is passed in a single 64-bit register
20146 rather than a pair of 32-bit registers.  For example, scalar
20147 floating-point values are returned in @samp{$f0} only, not a
20148 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20149 remains the same in that the even-numbered double-precision registers
20150 are saved.
20152 Two additional variants of the o32 ABI are supported to enable
20153 a transition from 32-bit to 64-bit registers.  These are FPXX
20154 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20155 The FPXX extension mandates that all code must execute correctly
20156 when run using 32-bit or 64-bit registers.  The code can be interlinked
20157 with either FP32 or FP64, but not both.
20158 The FP64A extension is similar to the FP64 extension but forbids the
20159 use of odd-numbered single-precision registers.  This can be used
20160 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20161 processors and allows both FP32 and FP64A code to interlink and
20162 run in the same process without changing FPU modes.
20164 @item -mabicalls
20165 @itemx -mno-abicalls
20166 @opindex mabicalls
20167 @opindex mno-abicalls
20168 Generate (do not generate) code that is suitable for SVR4-style
20169 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20170 systems.
20172 @item -mshared
20173 @itemx -mno-shared
20174 Generate (do not generate) code that is fully position-independent,
20175 and that can therefore be linked into shared libraries.  This option
20176 only affects @option{-mabicalls}.
20178 All @option{-mabicalls} code has traditionally been position-independent,
20179 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20180 as an extension, the GNU toolchain allows executables to use absolute
20181 accesses for locally-binding symbols.  It can also use shorter GP
20182 initialization sequences and generate direct calls to locally-defined
20183 functions.  This mode is selected by @option{-mno-shared}.
20185 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20186 objects that can only be linked by the GNU linker.  However, the option
20187 does not affect the ABI of the final executable; it only affects the ABI
20188 of relocatable objects.  Using @option{-mno-shared} generally makes
20189 executables both smaller and quicker.
20191 @option{-mshared} is the default.
20193 @item -mplt
20194 @itemx -mno-plt
20195 @opindex mplt
20196 @opindex mno-plt
20197 Assume (do not assume) that the static and dynamic linkers
20198 support PLTs and copy relocations.  This option only affects
20199 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20200 has no effect without @option{-msym32}.
20202 You can make @option{-mplt} the default by configuring
20203 GCC with @option{--with-mips-plt}.  The default is
20204 @option{-mno-plt} otherwise.
20206 @item -mxgot
20207 @itemx -mno-xgot
20208 @opindex mxgot
20209 @opindex mno-xgot
20210 Lift (do not lift) the usual restrictions on the size of the global
20211 offset table.
20213 GCC normally uses a single instruction to load values from the GOT@.
20214 While this is relatively efficient, it only works if the GOT
20215 is smaller than about 64k.  Anything larger causes the linker
20216 to report an error such as:
20218 @cindex relocation truncated to fit (MIPS)
20219 @smallexample
20220 relocation truncated to fit: R_MIPS_GOT16 foobar
20221 @end smallexample
20223 If this happens, you should recompile your code with @option{-mxgot}.
20224 This works with very large GOTs, although the code is also
20225 less efficient, since it takes three instructions to fetch the
20226 value of a global symbol.
20228 Note that some linkers can create multiple GOTs.  If you have such a
20229 linker, you should only need to use @option{-mxgot} when a single object
20230 file accesses more than 64k's worth of GOT entries.  Very few do.
20232 These options have no effect unless GCC is generating position
20233 independent code.
20235 @item -mgp32
20236 @opindex mgp32
20237 Assume that general-purpose registers are 32 bits wide.
20239 @item -mgp64
20240 @opindex mgp64
20241 Assume that general-purpose registers are 64 bits wide.
20243 @item -mfp32
20244 @opindex mfp32
20245 Assume that floating-point registers are 32 bits wide.
20247 @item -mfp64
20248 @opindex mfp64
20249 Assume that floating-point registers are 64 bits wide.
20251 @item -mfpxx
20252 @opindex mfpxx
20253 Do not assume the width of floating-point registers.
20255 @item -mhard-float
20256 @opindex mhard-float
20257 Use floating-point coprocessor instructions.
20259 @item -msoft-float
20260 @opindex msoft-float
20261 Do not use floating-point coprocessor instructions.  Implement
20262 floating-point calculations using library calls instead.
20264 @item -mno-float
20265 @opindex mno-float
20266 Equivalent to @option{-msoft-float}, but additionally asserts that the
20267 program being compiled does not perform any floating-point operations.
20268 This option is presently supported only by some bare-metal MIPS
20269 configurations, where it may select a special set of libraries
20270 that lack all floating-point support (including, for example, the
20271 floating-point @code{printf} formats).  
20272 If code compiled with @option{-mno-float} accidentally contains
20273 floating-point operations, it is likely to suffer a link-time
20274 or run-time failure.
20276 @item -msingle-float
20277 @opindex msingle-float
20278 Assume that the floating-point coprocessor only supports single-precision
20279 operations.
20281 @item -mdouble-float
20282 @opindex mdouble-float
20283 Assume that the floating-point coprocessor supports double-precision
20284 operations.  This is the default.
20286 @item -modd-spreg
20287 @itemx -mno-odd-spreg
20288 @opindex modd-spreg
20289 @opindex mno-odd-spreg
20290 Enable the use of odd-numbered single-precision floating-point registers
20291 for the o32 ABI.  This is the default for processors that are known to
20292 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20293 is set by default.
20295 @item -mabs=2008
20296 @itemx -mabs=legacy
20297 @opindex mabs=2008
20298 @opindex mabs=legacy
20299 These options control the treatment of the special not-a-number (NaN)
20300 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20301 @code{neg.@i{fmt}} machine instructions.
20303 By default or when @option{-mabs=legacy} is used the legacy
20304 treatment is selected.  In this case these instructions are considered
20305 arithmetic and avoided where correct operation is required and the
20306 input operand might be a NaN.  A longer sequence of instructions that
20307 manipulate the sign bit of floating-point datum manually is used
20308 instead unless the @option{-ffinite-math-only} option has also been
20309 specified.
20311 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20312 this case these instructions are considered non-arithmetic and therefore
20313 operating correctly in all cases, including in particular where the
20314 input operand is a NaN.  These instructions are therefore always used
20315 for the respective operations.
20317 @item -mnan=2008
20318 @itemx -mnan=legacy
20319 @opindex mnan=2008
20320 @opindex mnan=legacy
20321 These options control the encoding of the special not-a-number (NaN)
20322 IEEE 754 floating-point data.
20324 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20325 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20326 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20327 by the first bit of their trailing significand field being 1.
20329 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20330 this case qNaNs are denoted by the first bit of their trailing
20331 significand field being 1, whereas sNaNs are denoted by the first bit of
20332 their trailing significand field being 0.
20334 The default is @option{-mnan=legacy} unless GCC has been configured with
20335 @option{--with-nan=2008}.
20337 @item -mllsc
20338 @itemx -mno-llsc
20339 @opindex mllsc
20340 @opindex mno-llsc
20341 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20342 implement atomic memory built-in functions.  When neither option is
20343 specified, GCC uses the instructions if the target architecture
20344 supports them.
20346 @option{-mllsc} is useful if the runtime environment can emulate the
20347 instructions and @option{-mno-llsc} can be useful when compiling for
20348 nonstandard ISAs.  You can make either option the default by
20349 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20350 respectively.  @option{--with-llsc} is the default for some
20351 configurations; see the installation documentation for details.
20353 @item -mdsp
20354 @itemx -mno-dsp
20355 @opindex mdsp
20356 @opindex mno-dsp
20357 Use (do not use) revision 1 of the MIPS DSP ASE@.
20358 @xref{MIPS DSP Built-in Functions}.  This option defines the
20359 preprocessor macro @code{__mips_dsp}.  It also defines
20360 @code{__mips_dsp_rev} to 1.
20362 @item -mdspr2
20363 @itemx -mno-dspr2
20364 @opindex mdspr2
20365 @opindex mno-dspr2
20366 Use (do not use) revision 2 of the MIPS DSP ASE@.
20367 @xref{MIPS DSP Built-in Functions}.  This option defines the
20368 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20369 It also defines @code{__mips_dsp_rev} to 2.
20371 @item -msmartmips
20372 @itemx -mno-smartmips
20373 @opindex msmartmips
20374 @opindex mno-smartmips
20375 Use (do not use) the MIPS SmartMIPS ASE.
20377 @item -mpaired-single
20378 @itemx -mno-paired-single
20379 @opindex mpaired-single
20380 @opindex mno-paired-single
20381 Use (do not use) paired-single floating-point instructions.
20382 @xref{MIPS Paired-Single Support}.  This option requires
20383 hardware floating-point support to be enabled.
20385 @item -mdmx
20386 @itemx -mno-mdmx
20387 @opindex mdmx
20388 @opindex mno-mdmx
20389 Use (do not use) MIPS Digital Media Extension instructions.
20390 This option can only be used when generating 64-bit code and requires
20391 hardware floating-point support to be enabled.
20393 @item -mips3d
20394 @itemx -mno-mips3d
20395 @opindex mips3d
20396 @opindex mno-mips3d
20397 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20398 The option @option{-mips3d} implies @option{-mpaired-single}.
20400 @item -mmicromips
20401 @itemx -mno-micromips
20402 @opindex mmicromips
20403 @opindex mno-mmicromips
20404 Generate (do not generate) microMIPS code.
20406 MicroMIPS code generation can also be controlled on a per-function basis
20407 by means of @code{micromips} and @code{nomicromips} attributes.
20408 @xref{Function Attributes}, for more information.
20410 @item -mmt
20411 @itemx -mno-mt
20412 @opindex mmt
20413 @opindex mno-mt
20414 Use (do not use) MT Multithreading instructions.
20416 @item -mmcu
20417 @itemx -mno-mcu
20418 @opindex mmcu
20419 @opindex mno-mcu
20420 Use (do not use) the MIPS MCU ASE instructions.
20422 @item -meva
20423 @itemx -mno-eva
20424 @opindex meva
20425 @opindex mno-eva
20426 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20428 @item -mvirt
20429 @itemx -mno-virt
20430 @opindex mvirt
20431 @opindex mno-virt
20432 Use (do not use) the MIPS Virtualization (VZ) instructions.
20434 @item -mxpa
20435 @itemx -mno-xpa
20436 @opindex mxpa
20437 @opindex mno-xpa
20438 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20440 @item -mlong64
20441 @opindex mlong64
20442 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20443 an explanation of the default and the way that the pointer size is
20444 determined.
20446 @item -mlong32
20447 @opindex mlong32
20448 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20450 The default size of @code{int}s, @code{long}s and pointers depends on
20451 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20452 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20453 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20454 or the same size as integer registers, whichever is smaller.
20456 @item -msym32
20457 @itemx -mno-sym32
20458 @opindex msym32
20459 @opindex mno-sym32
20460 Assume (do not assume) that all symbols have 32-bit values, regardless
20461 of the selected ABI@.  This option is useful in combination with
20462 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20463 to generate shorter and faster references to symbolic addresses.
20465 @item -G @var{num}
20466 @opindex G
20467 Put definitions of externally-visible data in a small data section
20468 if that data is no bigger than @var{num} bytes.  GCC can then generate
20469 more efficient accesses to the data; see @option{-mgpopt} for details.
20471 The default @option{-G} option depends on the configuration.
20473 @item -mlocal-sdata
20474 @itemx -mno-local-sdata
20475 @opindex mlocal-sdata
20476 @opindex mno-local-sdata
20477 Extend (do not extend) the @option{-G} behavior to local data too,
20478 such as to static variables in C@.  @option{-mlocal-sdata} is the
20479 default for all configurations.
20481 If the linker complains that an application is using too much small data,
20482 you might want to try rebuilding the less performance-critical parts with
20483 @option{-mno-local-sdata}.  You might also want to build large
20484 libraries with @option{-mno-local-sdata}, so that the libraries leave
20485 more room for the main program.
20487 @item -mextern-sdata
20488 @itemx -mno-extern-sdata
20489 @opindex mextern-sdata
20490 @opindex mno-extern-sdata
20491 Assume (do not assume) that externally-defined data is in
20492 a small data section if the size of that data is within the @option{-G} limit.
20493 @option{-mextern-sdata} is the default for all configurations.
20495 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20496 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20497 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20498 is placed in a small data section.  If @var{Var} is defined by another
20499 module, you must either compile that module with a high-enough
20500 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20501 definition.  If @var{Var} is common, you must link the application
20502 with a high-enough @option{-G} setting.
20504 The easiest way of satisfying these restrictions is to compile
20505 and link every module with the same @option{-G} option.  However,
20506 you may wish to build a library that supports several different
20507 small data limits.  You can do this by compiling the library with
20508 the highest supported @option{-G} setting and additionally using
20509 @option{-mno-extern-sdata} to stop the library from making assumptions
20510 about externally-defined data.
20512 @item -mgpopt
20513 @itemx -mno-gpopt
20514 @opindex mgpopt
20515 @opindex mno-gpopt
20516 Use (do not use) GP-relative accesses for symbols that are known to be
20517 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20518 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20519 configurations.
20521 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20522 might not hold the value of @code{_gp}.  For example, if the code is
20523 part of a library that might be used in a boot monitor, programs that
20524 call boot monitor routines pass an unknown value in @code{$gp}.
20525 (In such situations, the boot monitor itself is usually compiled
20526 with @option{-G0}.)
20528 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20529 @option{-mno-extern-sdata}.
20531 @item -membedded-data
20532 @itemx -mno-embedded-data
20533 @opindex membedded-data
20534 @opindex mno-embedded-data
20535 Allocate variables to the read-only data section first if possible, then
20536 next in the small data section if possible, otherwise in data.  This gives
20537 slightly slower code than the default, but reduces the amount of RAM required
20538 when executing, and thus may be preferred for some embedded systems.
20540 @item -muninit-const-in-rodata
20541 @itemx -mno-uninit-const-in-rodata
20542 @opindex muninit-const-in-rodata
20543 @opindex mno-uninit-const-in-rodata
20544 Put uninitialized @code{const} variables in the read-only data section.
20545 This option is only meaningful in conjunction with @option{-membedded-data}.
20547 @item -mcode-readable=@var{setting}
20548 @opindex mcode-readable
20549 Specify whether GCC may generate code that reads from executable sections.
20550 There are three possible settings:
20552 @table @gcctabopt
20553 @item -mcode-readable=yes
20554 Instructions may freely access executable sections.  This is the
20555 default setting.
20557 @item -mcode-readable=pcrel
20558 MIPS16 PC-relative load instructions can access executable sections,
20559 but other instructions must not do so.  This option is useful on 4KSc
20560 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20561 It is also useful on processors that can be configured to have a dual
20562 instruction/data SRAM interface and that, like the M4K, automatically
20563 redirect PC-relative loads to the instruction RAM.
20565 @item -mcode-readable=no
20566 Instructions must not access executable sections.  This option can be
20567 useful on targets that are configured to have a dual instruction/data
20568 SRAM interface but that (unlike the M4K) do not automatically redirect
20569 PC-relative loads to the instruction RAM.
20570 @end table
20572 @item -msplit-addresses
20573 @itemx -mno-split-addresses
20574 @opindex msplit-addresses
20575 @opindex mno-split-addresses
20576 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20577 relocation operators.  This option has been superseded by
20578 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20580 @item -mexplicit-relocs
20581 @itemx -mno-explicit-relocs
20582 @opindex mexplicit-relocs
20583 @opindex mno-explicit-relocs
20584 Use (do not use) assembler relocation operators when dealing with symbolic
20585 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20586 is to use assembler macros instead.
20588 @option{-mexplicit-relocs} is the default if GCC was configured
20589 to use an assembler that supports relocation operators.
20591 @item -mcheck-zero-division
20592 @itemx -mno-check-zero-division
20593 @opindex mcheck-zero-division
20594 @opindex mno-check-zero-division
20595 Trap (do not trap) on integer division by zero.
20597 The default is @option{-mcheck-zero-division}.
20599 @item -mdivide-traps
20600 @itemx -mdivide-breaks
20601 @opindex mdivide-traps
20602 @opindex mdivide-breaks
20603 MIPS systems check for division by zero by generating either a
20604 conditional trap or a break instruction.  Using traps results in
20605 smaller code, but is only supported on MIPS II and later.  Also, some
20606 versions of the Linux kernel have a bug that prevents trap from
20607 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20608 allow conditional traps on architectures that support them and
20609 @option{-mdivide-breaks} to force the use of breaks.
20611 The default is usually @option{-mdivide-traps}, but this can be
20612 overridden at configure time using @option{--with-divide=breaks}.
20613 Divide-by-zero checks can be completely disabled using
20614 @option{-mno-check-zero-division}.
20616 @item -mload-store-pairs
20617 @itemx -mno-load-store-pairs
20618 @opindex mload-store-pairs
20619 @opindex mno-load-store-pairs
20620 Enable (disable) an optimization that pairs consecutive load or store
20621 instructions to enable load/store bonding.  This option is enabled by
20622 default but only takes effect when the selected architecture is known
20623 to support bonding.
20625 @item -mmemcpy
20626 @itemx -mno-memcpy
20627 @opindex mmemcpy
20628 @opindex mno-memcpy
20629 Force (do not force) the use of @code{memcpy} for non-trivial block
20630 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20631 most constant-sized copies.
20633 @item -mlong-calls
20634 @itemx -mno-long-calls
20635 @opindex mlong-calls
20636 @opindex mno-long-calls
20637 Disable (do not disable) use of the @code{jal} instruction.  Calling
20638 functions using @code{jal} is more efficient but requires the caller
20639 and callee to be in the same 256 megabyte segment.
20641 This option has no effect on abicalls code.  The default is
20642 @option{-mno-long-calls}.
20644 @item -mmad
20645 @itemx -mno-mad
20646 @opindex mmad
20647 @opindex mno-mad
20648 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20649 instructions, as provided by the R4650 ISA@.
20651 @item -mimadd
20652 @itemx -mno-imadd
20653 @opindex mimadd
20654 @opindex mno-imadd
20655 Enable (disable) use of the @code{madd} and @code{msub} integer
20656 instructions.  The default is @option{-mimadd} on architectures
20657 that support @code{madd} and @code{msub} except for the 74k 
20658 architecture where it was found to generate slower code.
20660 @item -mfused-madd
20661 @itemx -mno-fused-madd
20662 @opindex mfused-madd
20663 @opindex mno-fused-madd
20664 Enable (disable) use of the floating-point multiply-accumulate
20665 instructions, when they are available.  The default is
20666 @option{-mfused-madd}.
20668 On the R8000 CPU when multiply-accumulate instructions are used,
20669 the intermediate product is calculated to infinite precision
20670 and is not subject to the FCSR Flush to Zero bit.  This may be
20671 undesirable in some circumstances.  On other processors the result
20672 is numerically identical to the equivalent computation using
20673 separate multiply, add, subtract and negate instructions.
20675 @item -nocpp
20676 @opindex nocpp
20677 Tell the MIPS assembler to not run its preprocessor over user
20678 assembler files (with a @samp{.s} suffix) when assembling them.
20680 @item -mfix-24k
20681 @item -mno-fix-24k
20682 @opindex mfix-24k
20683 @opindex mno-fix-24k
20684 Work around the 24K E48 (lost data on stores during refill) errata.
20685 The workarounds are implemented by the assembler rather than by GCC@.
20687 @item -mfix-r4000
20688 @itemx -mno-fix-r4000
20689 @opindex mfix-r4000
20690 @opindex mno-fix-r4000
20691 Work around certain R4000 CPU errata:
20692 @itemize @minus
20693 @item
20694 A double-word or a variable shift may give an incorrect result if executed
20695 immediately after starting an integer division.
20696 @item
20697 A double-word or a variable shift may give an incorrect result if executed
20698 while an integer multiplication is in progress.
20699 @item
20700 An integer division may give an incorrect result if started in a delay slot
20701 of a taken branch or a jump.
20702 @end itemize
20704 @item -mfix-r4400
20705 @itemx -mno-fix-r4400
20706 @opindex mfix-r4400
20707 @opindex mno-fix-r4400
20708 Work around certain R4400 CPU errata:
20709 @itemize @minus
20710 @item
20711 A double-word or a variable shift may give an incorrect result if executed
20712 immediately after starting an integer division.
20713 @end itemize
20715 @item -mfix-r10000
20716 @itemx -mno-fix-r10000
20717 @opindex mfix-r10000
20718 @opindex mno-fix-r10000
20719 Work around certain R10000 errata:
20720 @itemize @minus
20721 @item
20722 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20723 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20724 @end itemize
20726 This option can only be used if the target architecture supports
20727 branch-likely instructions.  @option{-mfix-r10000} is the default when
20728 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20729 otherwise.
20731 @item -mfix-rm7000
20732 @itemx -mno-fix-rm7000
20733 @opindex mfix-rm7000
20734 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20735 workarounds are implemented by the assembler rather than by GCC@.
20737 @item -mfix-vr4120
20738 @itemx -mno-fix-vr4120
20739 @opindex mfix-vr4120
20740 Work around certain VR4120 errata:
20741 @itemize @minus
20742 @item
20743 @code{dmultu} does not always produce the correct result.
20744 @item
20745 @code{div} and @code{ddiv} do not always produce the correct result if one
20746 of the operands is negative.
20747 @end itemize
20748 The workarounds for the division errata rely on special functions in
20749 @file{libgcc.a}.  At present, these functions are only provided by
20750 the @code{mips64vr*-elf} configurations.
20752 Other VR4120 errata require a NOP to be inserted between certain pairs of
20753 instructions.  These errata are handled by the assembler, not by GCC itself.
20755 @item -mfix-vr4130
20756 @opindex mfix-vr4130
20757 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20758 workarounds are implemented by the assembler rather than by GCC,
20759 although GCC avoids using @code{mflo} and @code{mfhi} if the
20760 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20761 instructions are available instead.
20763 @item -mfix-sb1
20764 @itemx -mno-fix-sb1
20765 @opindex mfix-sb1
20766 Work around certain SB-1 CPU core errata.
20767 (This flag currently works around the SB-1 revision 2
20768 ``F1'' and ``F2'' floating-point errata.)
20770 @item -mr10k-cache-barrier=@var{setting}
20771 @opindex mr10k-cache-barrier
20772 Specify whether GCC should insert cache barriers to avoid the
20773 side-effects of speculation on R10K processors.
20775 In common with many processors, the R10K tries to predict the outcome
20776 of a conditional branch and speculatively executes instructions from
20777 the ``taken'' branch.  It later aborts these instructions if the
20778 predicted outcome is wrong.  However, on the R10K, even aborted
20779 instructions can have side effects.
20781 This problem only affects kernel stores and, depending on the system,
20782 kernel loads.  As an example, a speculatively-executed store may load
20783 the target memory into cache and mark the cache line as dirty, even if
20784 the store itself is later aborted.  If a DMA operation writes to the
20785 same area of memory before the ``dirty'' line is flushed, the cached
20786 data overwrites the DMA-ed data.  See the R10K processor manual
20787 for a full description, including other potential problems.
20789 One workaround is to insert cache barrier instructions before every memory
20790 access that might be speculatively executed and that might have side
20791 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20792 controls GCC's implementation of this workaround.  It assumes that
20793 aborted accesses to any byte in the following regions does not have
20794 side effects:
20796 @enumerate
20797 @item
20798 the memory occupied by the current function's stack frame;
20800 @item
20801 the memory occupied by an incoming stack argument;
20803 @item
20804 the memory occupied by an object with a link-time-constant address.
20805 @end enumerate
20807 It is the kernel's responsibility to ensure that speculative
20808 accesses to these regions are indeed safe.
20810 If the input program contains a function declaration such as:
20812 @smallexample
20813 void foo (void);
20814 @end smallexample
20816 then the implementation of @code{foo} must allow @code{j foo} and
20817 @code{jal foo} to be executed speculatively.  GCC honors this
20818 restriction for functions it compiles itself.  It expects non-GCC
20819 functions (such as hand-written assembly code) to do the same.
20821 The option has three forms:
20823 @table @gcctabopt
20824 @item -mr10k-cache-barrier=load-store
20825 Insert a cache barrier before a load or store that might be
20826 speculatively executed and that might have side effects even
20827 if aborted.
20829 @item -mr10k-cache-barrier=store
20830 Insert a cache barrier before a store that might be speculatively
20831 executed and that might have side effects even if aborted.
20833 @item -mr10k-cache-barrier=none
20834 Disable the insertion of cache barriers.  This is the default setting.
20835 @end table
20837 @item -mflush-func=@var{func}
20838 @itemx -mno-flush-func
20839 @opindex mflush-func
20840 Specifies the function to call to flush the I and D caches, or to not
20841 call any such function.  If called, the function must take the same
20842 arguments as the common @code{_flush_func}, that is, the address of the
20843 memory range for which the cache is being flushed, the size of the
20844 memory range, and the number 3 (to flush both caches).  The default
20845 depends on the target GCC was configured for, but commonly is either
20846 @code{_flush_func} or @code{__cpu_flush}.
20848 @item mbranch-cost=@var{num}
20849 @opindex mbranch-cost
20850 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20851 This cost is only a heuristic and is not guaranteed to produce
20852 consistent results across releases.  A zero cost redundantly selects
20853 the default, which is based on the @option{-mtune} setting.
20855 @item -mbranch-likely
20856 @itemx -mno-branch-likely
20857 @opindex mbranch-likely
20858 @opindex mno-branch-likely
20859 Enable or disable use of Branch Likely instructions, regardless of the
20860 default for the selected architecture.  By default, Branch Likely
20861 instructions may be generated if they are supported by the selected
20862 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20863 and processors that implement those architectures; for those, Branch
20864 Likely instructions are not be generated by default because the MIPS32
20865 and MIPS64 architectures specifically deprecate their use.
20867 @item -mcompact-branches=never
20868 @itemx -mcompact-branches=optimal
20869 @itemx -mcompact-branches=always
20870 @opindex mcompact-branches=never
20871 @opindex mcompact-branches=optimal
20872 @opindex mcompact-branches=always
20873 These options control which form of branches will be generated.  The
20874 default is @option{-mcompact-branches=optimal}.
20876 The @option{-mcompact-branches=never} option ensures that compact branch
20877 instructions will never be generated.
20879 The @option{-mcompact-branches=always} option ensures that a compact
20880 branch instruction will be generated if available.  If a compact branch
20881 instruction is not available, a delay slot form of the branch will be
20882 used instead.
20884 This option is supported from MIPS Release 6 onwards.
20886 The @option{-mcompact-branches=optimal} option will cause a delay slot
20887 branch to be used if one is available in the current ISA and the delay
20888 slot is successfully filled.  If the delay slot is not filled, a compact
20889 branch will be chosen if one is available.
20891 @item -mfp-exceptions
20892 @itemx -mno-fp-exceptions
20893 @opindex mfp-exceptions
20894 Specifies whether FP exceptions are enabled.  This affects how
20895 FP instructions are scheduled for some processors.
20896 The default is that FP exceptions are
20897 enabled.
20899 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20900 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20901 FP pipe.
20903 @item -mvr4130-align
20904 @itemx -mno-vr4130-align
20905 @opindex mvr4130-align
20906 The VR4130 pipeline is two-way superscalar, but can only issue two
20907 instructions together if the first one is 8-byte aligned.  When this
20908 option is enabled, GCC aligns pairs of instructions that it
20909 thinks should execute in parallel.
20911 This option only has an effect when optimizing for the VR4130.
20912 It normally makes code faster, but at the expense of making it bigger.
20913 It is enabled by default at optimization level @option{-O3}.
20915 @item -msynci
20916 @itemx -mno-synci
20917 @opindex msynci
20918 Enable (disable) generation of @code{synci} instructions on
20919 architectures that support it.  The @code{synci} instructions (if
20920 enabled) are generated when @code{__builtin___clear_cache} is
20921 compiled.
20923 This option defaults to @option{-mno-synci}, but the default can be
20924 overridden by configuring GCC with @option{--with-synci}.
20926 When compiling code for single processor systems, it is generally safe
20927 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20928 does not invalidate the instruction caches on all cores and may lead
20929 to undefined behavior.
20931 @item -mrelax-pic-calls
20932 @itemx -mno-relax-pic-calls
20933 @opindex mrelax-pic-calls
20934 Try to turn PIC calls that are normally dispatched via register
20935 @code{$25} into direct calls.  This is only possible if the linker can
20936 resolve the destination at link time and if the destination is within
20937 range for a direct call.
20939 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20940 an assembler and a linker that support the @code{.reloc} assembly
20941 directive and @option{-mexplicit-relocs} is in effect.  With
20942 @option{-mno-explicit-relocs}, this optimization can be performed by the
20943 assembler and the linker alone without help from the compiler.
20945 @item -mmcount-ra-address
20946 @itemx -mno-mcount-ra-address
20947 @opindex mmcount-ra-address
20948 @opindex mno-mcount-ra-address
20949 Emit (do not emit) code that allows @code{_mcount} to modify the
20950 calling function's return address.  When enabled, this option extends
20951 the usual @code{_mcount} interface with a new @var{ra-address}
20952 parameter, which has type @code{intptr_t *} and is passed in register
20953 @code{$12}.  @code{_mcount} can then modify the return address by
20954 doing both of the following:
20955 @itemize
20956 @item
20957 Returning the new address in register @code{$31}.
20958 @item
20959 Storing the new address in @code{*@var{ra-address}},
20960 if @var{ra-address} is nonnull.
20961 @end itemize
20963 The default is @option{-mno-mcount-ra-address}.
20965 @item -mframe-header-opt
20966 @itemx -mno-frame-header-opt
20967 @opindex mframe-header-opt
20968 Enable (disable) frame header optimization in the o32 ABI.  When using the
20969 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20970 function to write out register arguments.  When enabled, this optimization
20971 will suppress the allocation of the frame header if it can be determined that
20972 it is unused.
20974 This optimization is off by default at all optimization levels.
20976 @item -mlxc1-sxc1
20977 @itemx -mno-lxc1-sxc1
20978 @opindex mlxc1-sxc1
20979 When applicable, enable (disable) the generation of @code{lwxc1},
20980 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20982 @item -mmadd4
20983 @itemx -mno-madd4
20984 @opindex mmadd4
20985 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20986 @code{madd.d} and related instructions.  Enabled by default.
20988 @end table
20990 @node MMIX Options
20991 @subsection MMIX Options
20992 @cindex MMIX Options
20994 These options are defined for the MMIX:
20996 @table @gcctabopt
20997 @item -mlibfuncs
20998 @itemx -mno-libfuncs
20999 @opindex mlibfuncs
21000 @opindex mno-libfuncs
21001 Specify that intrinsic library functions are being compiled, passing all
21002 values in registers, no matter the size.
21004 @item -mepsilon
21005 @itemx -mno-epsilon
21006 @opindex mepsilon
21007 @opindex mno-epsilon
21008 Generate floating-point comparison instructions that compare with respect
21009 to the @code{rE} epsilon register.
21011 @item -mabi=mmixware
21012 @itemx -mabi=gnu
21013 @opindex mabi=mmixware
21014 @opindex mabi=gnu
21015 Generate code that passes function parameters and return values that (in
21016 the called function) are seen as registers @code{$0} and up, as opposed to
21017 the GNU ABI which uses global registers @code{$231} and up.
21019 @item -mzero-extend
21020 @itemx -mno-zero-extend
21021 @opindex mzero-extend
21022 @opindex mno-zero-extend
21023 When reading data from memory in sizes shorter than 64 bits, use (do not
21024 use) zero-extending load instructions by default, rather than
21025 sign-extending ones.
21027 @item -mknuthdiv
21028 @itemx -mno-knuthdiv
21029 @opindex mknuthdiv
21030 @opindex mno-knuthdiv
21031 Make the result of a division yielding a remainder have the same sign as
21032 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21033 remainder follows the sign of the dividend.  Both methods are
21034 arithmetically valid, the latter being almost exclusively used.
21036 @item -mtoplevel-symbols
21037 @itemx -mno-toplevel-symbols
21038 @opindex mtoplevel-symbols
21039 @opindex mno-toplevel-symbols
21040 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21041 code can be used with the @code{PREFIX} assembly directive.
21043 @item -melf
21044 @opindex melf
21045 Generate an executable in the ELF format, rather than the default
21046 @samp{mmo} format used by the @command{mmix} simulator.
21048 @item -mbranch-predict
21049 @itemx -mno-branch-predict
21050 @opindex mbranch-predict
21051 @opindex mno-branch-predict
21052 Use (do not use) the probable-branch instructions, when static branch
21053 prediction indicates a probable branch.
21055 @item -mbase-addresses
21056 @itemx -mno-base-addresses
21057 @opindex mbase-addresses
21058 @opindex mno-base-addresses
21059 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21060 base address automatically generates a request (handled by the assembler
21061 and the linker) for a constant to be set up in a global register.  The
21062 register is used for one or more base address requests within the range 0
21063 to 255 from the value held in the register.  The generally leads to short
21064 and fast code, but the number of different data items that can be
21065 addressed is limited.  This means that a program that uses lots of static
21066 data may require @option{-mno-base-addresses}.
21068 @item -msingle-exit
21069 @itemx -mno-single-exit
21070 @opindex msingle-exit
21071 @opindex mno-single-exit
21072 Force (do not force) generated code to have a single exit point in each
21073 function.
21074 @end table
21076 @node MN10300 Options
21077 @subsection MN10300 Options
21078 @cindex MN10300 options
21080 These @option{-m} options are defined for Matsushita MN10300 architectures:
21082 @table @gcctabopt
21083 @item -mmult-bug
21084 @opindex mmult-bug
21085 Generate code to avoid bugs in the multiply instructions for the MN10300
21086 processors.  This is the default.
21088 @item -mno-mult-bug
21089 @opindex mno-mult-bug
21090 Do not generate code to avoid bugs in the multiply instructions for the
21091 MN10300 processors.
21093 @item -mam33
21094 @opindex mam33
21095 Generate code using features specific to the AM33 processor.
21097 @item -mno-am33
21098 @opindex mno-am33
21099 Do not generate code using features specific to the AM33 processor.  This
21100 is the default.
21102 @item -mam33-2
21103 @opindex mam33-2
21104 Generate code using features specific to the AM33/2.0 processor.
21106 @item -mam34
21107 @opindex mam34
21108 Generate code using features specific to the AM34 processor.
21110 @item -mtune=@var{cpu-type}
21111 @opindex mtune
21112 Use the timing characteristics of the indicated CPU type when
21113 scheduling instructions.  This does not change the targeted processor
21114 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21115 @samp{am33-2} or @samp{am34}.
21117 @item -mreturn-pointer-on-d0
21118 @opindex mreturn-pointer-on-d0
21119 When generating a function that returns a pointer, return the pointer
21120 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21121 only in @code{a0}, and attempts to call such functions without a prototype
21122 result in errors.  Note that this option is on by default; use
21123 @option{-mno-return-pointer-on-d0} to disable it.
21125 @item -mno-crt0
21126 @opindex mno-crt0
21127 Do not link in the C run-time initialization object file.
21129 @item -mrelax
21130 @opindex mrelax
21131 Indicate to the linker that it should perform a relaxation optimization pass
21132 to shorten branches, calls and absolute memory addresses.  This option only
21133 has an effect when used on the command line for the final link step.
21135 This option makes symbolic debugging impossible.
21137 @item -mliw
21138 @opindex mliw
21139 Allow the compiler to generate @emph{Long Instruction Word}
21140 instructions if the target is the @samp{AM33} or later.  This is the
21141 default.  This option defines the preprocessor macro @code{__LIW__}.
21143 @item -mnoliw
21144 @opindex mnoliw
21145 Do not allow the compiler to generate @emph{Long Instruction Word}
21146 instructions.  This option defines the preprocessor macro
21147 @code{__NO_LIW__}.
21149 @item -msetlb
21150 @opindex msetlb
21151 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21152 instructions if the target is the @samp{AM33} or later.  This is the
21153 default.  This option defines the preprocessor macro @code{__SETLB__}.
21155 @item -mnosetlb
21156 @opindex mnosetlb
21157 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21158 instructions.  This option defines the preprocessor macro
21159 @code{__NO_SETLB__}.
21161 @end table
21163 @node Moxie Options
21164 @subsection Moxie Options
21165 @cindex Moxie Options
21167 @table @gcctabopt
21169 @item -meb
21170 @opindex meb
21171 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21172 configurations.
21174 @item -mel
21175 @opindex mel
21176 Generate little-endian code.
21178 @item -mmul.x
21179 @opindex mmul.x
21180 Generate mul.x and umul.x instructions.  This is the default for
21181 @samp{moxiebox-*-*} configurations.
21183 @item -mno-crt0
21184 @opindex mno-crt0
21185 Do not link in the C run-time initialization object file.
21187 @end table
21189 @node MSP430 Options
21190 @subsection MSP430 Options
21191 @cindex MSP430 Options
21193 These options are defined for the MSP430:
21195 @table @gcctabopt
21197 @item -masm-hex
21198 @opindex masm-hex
21199 Force assembly output to always use hex constants.  Normally such
21200 constants are signed decimals, but this option is available for
21201 testsuite and/or aesthetic purposes.
21203 @item -mmcu=
21204 @opindex mmcu=
21205 Select the MCU to target.  This is used to create a C preprocessor
21206 symbol based upon the MCU name, converted to upper case and pre- and
21207 post-fixed with @samp{__}.  This in turn is used by the
21208 @file{msp430.h} header file to select an MCU-specific supplementary
21209 header file.
21211 The option also sets the ISA to use.  If the MCU name is one that is
21212 known to only support the 430 ISA then that is selected, otherwise the
21213 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21214 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21215 name selects the 430X ISA.
21217 In addition an MCU-specific linker script is added to the linker
21218 command line.  The script's name is the name of the MCU with
21219 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21220 command line defines the C preprocessor symbol @code{__XXX__} and
21221 cause the linker to search for a script called @file{xxx.ld}.
21223 This option is also passed on to the assembler.
21225 @item -mwarn-mcu
21226 @itemx -mno-warn-mcu
21227 @opindex mwarn-mcu
21228 @opindex mno-warn-mcu
21229 This option enables or disables warnings about conflicts between the
21230 MCU name specified by the @option{-mmcu} option and the ISA set by the
21231 @option{-mcpu} option and/or the hardware multiply support set by the
21232 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21233 MCU names.  This option is on by default.
21235 @item -mcpu=
21236 @opindex mcpu=
21237 Specifies the ISA to use.  Accepted values are @samp{msp430},
21238 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21239 @option{-mmcu=} option should be used to select the ISA.
21241 @item -msim
21242 @opindex msim
21243 Link to the simulator runtime libraries and linker script.  Overrides
21244 any scripts that would be selected by the @option{-mmcu=} option.
21246 @item -mlarge
21247 @opindex mlarge
21248 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21250 @item -msmall
21251 @opindex msmall
21252 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21254 @item -mrelax
21255 @opindex mrelax
21256 This option is passed to the assembler and linker, and allows the
21257 linker to perform certain optimizations that cannot be done until
21258 the final link.
21260 @item mhwmult=
21261 @opindex mhwmult=
21262 Describes the type of hardware multiply supported by the target.
21263 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21264 for the original 16-bit-only multiply supported by early MCUs.
21265 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21266 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21267 A value of @samp{auto} can also be given.  This tells GCC to deduce
21268 the hardware multiply support based upon the MCU name provided by the
21269 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21270 the MCU name is not recognized then no hardware multiply support is
21271 assumed.  @code{auto} is the default setting.
21273 Hardware multiplies are normally performed by calling a library
21274 routine.  This saves space in the generated code.  When compiling at
21275 @option{-O3} or higher however the hardware multiplier is invoked
21276 inline.  This makes for bigger, but faster code.
21278 The hardware multiply routines disable interrupts whilst running and
21279 restore the previous interrupt state when they finish.  This makes
21280 them safe to use inside interrupt handlers as well as in normal code.
21282 @item -minrt
21283 @opindex minrt
21284 Enable the use of a minimum runtime environment - no static
21285 initializers or constructors.  This is intended for memory-constrained
21286 devices.  The compiler includes special symbols in some objects
21287 that tell the linker and runtime which code fragments are required.
21289 @item -mcode-region=
21290 @itemx -mdata-region=
21291 @opindex mcode-region
21292 @opindex mdata-region
21293 These options tell the compiler where to place functions and data that
21294 do not have one of the @code{lower}, @code{upper}, @code{either} or
21295 @code{section} attributes.  Possible values are @code{lower},
21296 @code{upper}, @code{either} or @code{any}.  The first three behave
21297 like the corresponding attribute.  The fourth possible value -
21298 @code{any} - is the default.  It leaves placement entirely up to the
21299 linker script and how it assigns the standard sections
21300 (@code{.text}, @code{.data}, etc) to the memory regions.
21302 @item -msilicon-errata=
21303 @opindex msilicon-errata
21304 This option passes on a request to assembler to enable the fixes for
21305 the named silicon errata.
21307 @item -msilicon-errata-warn=
21308 @opindex msilicon-errata-warn
21309 This option passes on a request to the assembler to enable warning
21310 messages when a silicon errata might need to be applied.
21312 @end table
21314 @node NDS32 Options
21315 @subsection NDS32 Options
21316 @cindex NDS32 Options
21318 These options are defined for NDS32 implementations:
21320 @table @gcctabopt
21322 @item -mbig-endian
21323 @opindex mbig-endian
21324 Generate code in big-endian mode.
21326 @item -mlittle-endian
21327 @opindex mlittle-endian
21328 Generate code in little-endian mode.
21330 @item -mreduced-regs
21331 @opindex mreduced-regs
21332 Use reduced-set registers for register allocation.
21334 @item -mfull-regs
21335 @opindex mfull-regs
21336 Use full-set registers for register allocation.
21338 @item -mcmov
21339 @opindex mcmov
21340 Generate conditional move instructions.
21342 @item -mno-cmov
21343 @opindex mno-cmov
21344 Do not generate conditional move instructions.
21346 @item -mext-perf
21347 @opindex mperf-ext
21348 Generate performance extension instructions.
21350 @item -mno-ext-perf
21351 @opindex mno-perf-ext
21352 Do not generate performance extension instructions.
21354 @item -mext-perf2
21355 @opindex mperf-ext
21356 Generate performance extension 2 instructions.
21358 @item -mno-ext-perf2
21359 @opindex mno-perf-ext
21360 Do not generate performance extension 2 instructions.
21362 @item -mext-string
21363 @opindex mperf-ext
21364 Generate string extension instructions.
21366 @item -mno-ext-string
21367 @opindex mno-perf-ext
21368 Do not generate string extension instructions.
21370 @item -mv3push
21371 @opindex mv3push
21372 Generate v3 push25/pop25 instructions.
21374 @item -mno-v3push
21375 @opindex mno-v3push
21376 Do not generate v3 push25/pop25 instructions.
21378 @item -m16-bit
21379 @opindex m16-bit
21380 Generate 16-bit instructions.
21382 @item -mno-16-bit
21383 @opindex mno-16-bit
21384 Do not generate 16-bit instructions.
21386 @item -misr-vector-size=@var{num}
21387 @opindex misr-vector-size
21388 Specify the size of each interrupt vector, which must be 4 or 16.
21390 @item -mcache-block-size=@var{num}
21391 @opindex mcache-block-size
21392 Specify the size of each cache block,
21393 which must be a power of 2 between 4 and 512.
21395 @item -march=@var{arch}
21396 @opindex march
21397 Specify the name of the target architecture.
21399 @item -mcmodel=@var{code-model}
21400 @opindex mcmodel
21401 Set the code model to one of
21402 @table @asis
21403 @item @samp{small}
21404 All the data and read-only data segments must be within 512KB addressing space.
21405 The text segment must be within 16MB addressing space.
21406 @item @samp{medium}
21407 The data segment must be within 512KB while the read-only data segment can be
21408 within 4GB addressing space.  The text segment should be still within 16MB
21409 addressing space.
21410 @item @samp{large}
21411 All the text and data segments can be within 4GB addressing space.
21412 @end table
21414 @item -mctor-dtor
21415 @opindex mctor-dtor
21416 Enable constructor/destructor feature.
21418 @item -mrelax
21419 @opindex mrelax
21420 Guide linker to relax instructions.
21422 @end table
21424 @node Nios II Options
21425 @subsection Nios II Options
21426 @cindex Nios II options
21427 @cindex Altera Nios II options
21429 These are the options defined for the Altera Nios II processor.
21431 @table @gcctabopt
21433 @item -G @var{num}
21434 @opindex G
21435 @cindex smaller data references
21436 Put global and static objects less than or equal to @var{num} bytes
21437 into the small data or BSS sections instead of the normal data or BSS
21438 sections.  The default value of @var{num} is 8.
21440 @item -mgpopt=@var{option}
21441 @item -mgpopt
21442 @itemx -mno-gpopt
21443 @opindex mgpopt
21444 @opindex mno-gpopt
21445 Generate (do not generate) GP-relative accesses.  The following 
21446 @var{option} names are recognized:
21448 @table @samp
21450 @item none
21451 Do not generate GP-relative accesses.
21453 @item local
21454 Generate GP-relative accesses for small data objects that are not 
21455 external, weak, or uninitialized common symbols.  
21456 Also use GP-relative addressing for objects that
21457 have been explicitly placed in a small data section via a @code{section}
21458 attribute.
21460 @item global
21461 As for @samp{local}, but also generate GP-relative accesses for
21462 small data objects that are external, weak, or common.  If you use this option,
21463 you must ensure that all parts of your program (including libraries) are
21464 compiled with the same @option{-G} setting.
21466 @item data
21467 Generate GP-relative accesses for all data objects in the program.  If you
21468 use this option, the entire data and BSS segments
21469 of your program must fit in 64K of memory and you must use an appropriate
21470 linker script to allocate them within the addressable range of the
21471 global pointer.
21473 @item all
21474 Generate GP-relative addresses for function pointers as well as data
21475 pointers.  If you use this option, the entire text, data, and BSS segments
21476 of your program must fit in 64K of memory and you must use an appropriate
21477 linker script to allocate them within the addressable range of the
21478 global pointer.
21480 @end table
21482 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21483 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21485 The default is @option{-mgpopt} except when @option{-fpic} or
21486 @option{-fPIC} is specified to generate position-independent code.
21487 Note that the Nios II ABI does not permit GP-relative accesses from
21488 shared libraries.
21490 You may need to specify @option{-mno-gpopt} explicitly when building
21491 programs that include large amounts of small data, including large
21492 GOT data sections.  In this case, the 16-bit offset for GP-relative
21493 addressing may not be large enough to allow access to the entire 
21494 small data section.
21496 @item -mgprel-sec=@var{regexp}
21497 @opindex mgprel-sec
21498 This option specifies additional section names that can be accessed via
21499 GP-relative addressing.  It is most useful in conjunction with 
21500 @code{section} attributes on variable declarations 
21501 (@pxref{Common Variable Attributes}) and a custom linker script.  
21502 The @var{regexp} is a POSIX Extended Regular Expression.
21504 This option does not affect the behavior of the @option{-G} option, and 
21505 and the specified sections are in addition to the standard @code{.sdata} 
21506 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21508 @item -mr0rel-sec=@var{regexp}
21509 @opindex mr0rel-sec
21510 This option specifies names of sections that can be accessed via a 
21511 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21512 of the 32-bit address space.  It is most useful in conjunction with 
21513 @code{section} attributes on variable declarations 
21514 (@pxref{Common Variable Attributes}) and a custom linker script.  
21515 The @var{regexp} is a POSIX Extended Regular Expression.
21517 In contrast to the use of GP-relative addressing for small data, 
21518 zero-based addressing is never generated by default and there are no 
21519 conventional section names used in standard linker scripts for sections
21520 in the low or high areas of memory.
21522 @item -mel
21523 @itemx -meb
21524 @opindex mel
21525 @opindex meb
21526 Generate little-endian (default) or big-endian (experimental) code,
21527 respectively.
21529 @item -march=@var{arch}
21530 @opindex march
21531 This specifies the name of the target Nios II architecture.  GCC uses this
21532 name to determine what kind of instructions it can emit when generating
21533 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21535 The preprocessor macro @code{__nios2_arch__} is available to programs,
21536 with value 1 or 2, indicating the targeted ISA level.
21538 @item -mbypass-cache
21539 @itemx -mno-bypass-cache
21540 @opindex mno-bypass-cache
21541 @opindex mbypass-cache
21542 Force all load and store instructions to always bypass cache by 
21543 using I/O variants of the instructions. The default is not to
21544 bypass the cache.
21546 @item -mno-cache-volatile 
21547 @itemx -mcache-volatile       
21548 @opindex mcache-volatile 
21549 @opindex mno-cache-volatile
21550 Volatile memory access bypass the cache using the I/O variants of 
21551 the load and store instructions. The default is not to bypass the cache.
21553 @item -mno-fast-sw-div
21554 @itemx -mfast-sw-div
21555 @opindex mno-fast-sw-div
21556 @opindex mfast-sw-div
21557 Do not use table-based fast divide for small numbers. The default 
21558 is to use the fast divide at @option{-O3} and above.
21560 @item -mno-hw-mul
21561 @itemx -mhw-mul
21562 @itemx -mno-hw-mulx
21563 @itemx -mhw-mulx
21564 @itemx -mno-hw-div
21565 @itemx -mhw-div
21566 @opindex mno-hw-mul
21567 @opindex mhw-mul
21568 @opindex mno-hw-mulx
21569 @opindex mhw-mulx
21570 @opindex mno-hw-div
21571 @opindex mhw-div
21572 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21573 instructions by the compiler. The default is to emit @code{mul}
21574 and not emit @code{div} and @code{mulx}.
21576 @item -mbmx
21577 @itemx -mno-bmx
21578 @itemx -mcdx
21579 @itemx -mno-cdx
21580 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21581 CDX (code density) instructions.  Enabling these instructions also
21582 requires @option{-march=r2}.  Since these instructions are optional
21583 extensions to the R2 architecture, the default is not to emit them.
21585 @item -mcustom-@var{insn}=@var{N}
21586 @itemx -mno-custom-@var{insn}
21587 @opindex mcustom-@var{insn}
21588 @opindex mno-custom-@var{insn}
21589 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21590 custom instruction with encoding @var{N} when generating code that uses 
21591 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21592 instruction 253 for single-precision floating-point add operations instead
21593 of the default behavior of using a library call.
21595 The following values of @var{insn} are supported.  Except as otherwise
21596 noted, floating-point operations are expected to be implemented with
21597 normal IEEE 754 semantics and correspond directly to the C operators or the
21598 equivalent GCC built-in functions (@pxref{Other Builtins}).
21600 Single-precision floating point:
21601 @table @asis
21603 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21604 Binary arithmetic operations.
21606 @item @samp{fnegs}
21607 Unary negation.
21609 @item @samp{fabss}
21610 Unary absolute value.
21612 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21613 Comparison operations.
21615 @item @samp{fmins}, @samp{fmaxs}
21616 Floating-point minimum and maximum.  These instructions are only
21617 generated if @option{-ffinite-math-only} is specified.
21619 @item @samp{fsqrts}
21620 Unary square root operation.
21622 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21623 Floating-point trigonometric and exponential functions.  These instructions
21624 are only generated if @option{-funsafe-math-optimizations} is also specified.
21626 @end table
21628 Double-precision floating point:
21629 @table @asis
21631 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21632 Binary arithmetic operations.
21634 @item @samp{fnegd}
21635 Unary negation.
21637 @item @samp{fabsd}
21638 Unary absolute value.
21640 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21641 Comparison operations.
21643 @item @samp{fmind}, @samp{fmaxd}
21644 Double-precision minimum and maximum.  These instructions are only
21645 generated if @option{-ffinite-math-only} is specified.
21647 @item @samp{fsqrtd}
21648 Unary square root operation.
21650 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21651 Double-precision trigonometric and exponential functions.  These instructions
21652 are only generated if @option{-funsafe-math-optimizations} is also specified.
21654 @end table
21656 Conversions:
21657 @table @asis
21658 @item @samp{fextsd}
21659 Conversion from single precision to double precision.
21661 @item @samp{ftruncds}
21662 Conversion from double precision to single precision.
21664 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21665 Conversion from floating point to signed or unsigned integer types, with
21666 truncation towards zero.
21668 @item @samp{round}
21669 Conversion from single-precision floating point to signed integer,
21670 rounding to the nearest integer and ties away from zero.
21671 This corresponds to the @code{__builtin_lroundf} function when
21672 @option{-fno-math-errno} is used.
21674 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21675 Conversion from signed or unsigned integer types to floating-point types.
21677 @end table
21679 In addition, all of the following transfer instructions for internal
21680 registers X and Y must be provided to use any of the double-precision
21681 floating-point instructions.  Custom instructions taking two
21682 double-precision source operands expect the first operand in the
21683 64-bit register X.  The other operand (or only operand of a unary
21684 operation) is given to the custom arithmetic instruction with the
21685 least significant half in source register @var{src1} and the most
21686 significant half in @var{src2}.  A custom instruction that returns a
21687 double-precision result returns the most significant 32 bits in the
21688 destination register and the other half in 32-bit register Y.  
21689 GCC automatically generates the necessary code sequences to write
21690 register X and/or read register Y when double-precision floating-point
21691 instructions are used.
21693 @table @asis
21695 @item @samp{fwrx}
21696 Write @var{src1} into the least significant half of X and @var{src2} into
21697 the most significant half of X.
21699 @item @samp{fwry}
21700 Write @var{src1} into Y.
21702 @item @samp{frdxhi}, @samp{frdxlo}
21703 Read the most or least (respectively) significant half of X and store it in
21704 @var{dest}.
21706 @item @samp{frdy}
21707 Read the value of Y and store it into @var{dest}.
21708 @end table
21710 Note that you can gain more local control over generation of Nios II custom
21711 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21712 and @code{target("no-custom-@var{insn}")} function attributes
21713 (@pxref{Function Attributes})
21714 or pragmas (@pxref{Function Specific Option Pragmas}).
21716 @item -mcustom-fpu-cfg=@var{name}
21717 @opindex mcustom-fpu-cfg
21719 This option enables a predefined, named set of custom instruction encodings
21720 (see @option{-mcustom-@var{insn}} above).  
21721 Currently, the following sets are defined:
21723 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21724 @gccoptlist{-mcustom-fmuls=252 @gol
21725 -mcustom-fadds=253 @gol
21726 -mcustom-fsubs=254 @gol
21727 -fsingle-precision-constant}
21729 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21730 @gccoptlist{-mcustom-fmuls=252 @gol
21731 -mcustom-fadds=253 @gol
21732 -mcustom-fsubs=254 @gol
21733 -mcustom-fdivs=255 @gol
21734 -fsingle-precision-constant}
21736 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21737 @gccoptlist{-mcustom-floatus=243 @gol
21738 -mcustom-fixsi=244 @gol
21739 -mcustom-floatis=245 @gol
21740 -mcustom-fcmpgts=246 @gol
21741 -mcustom-fcmples=249 @gol
21742 -mcustom-fcmpeqs=250 @gol
21743 -mcustom-fcmpnes=251 @gol
21744 -mcustom-fmuls=252 @gol
21745 -mcustom-fadds=253 @gol
21746 -mcustom-fsubs=254 @gol
21747 -mcustom-fdivs=255 @gol
21748 -fsingle-precision-constant}
21750 Custom instruction assignments given by individual
21751 @option{-mcustom-@var{insn}=} options override those given by
21752 @option{-mcustom-fpu-cfg=}, regardless of the
21753 order of the options on the command line.
21755 Note that you can gain more local control over selection of a FPU
21756 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21757 function attribute (@pxref{Function Attributes})
21758 or pragma (@pxref{Function Specific Option Pragmas}).
21760 @end table
21762 These additional @samp{-m} options are available for the Altera Nios II
21763 ELF (bare-metal) target:
21765 @table @gcctabopt
21767 @item -mhal
21768 @opindex mhal
21769 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21770 startup and termination code, and is typically used in conjunction with
21771 @option{-msys-crt0=} to specify the location of the alternate startup code
21772 provided by the HAL BSP.
21774 @item -msmallc
21775 @opindex msmallc
21776 Link with a limited version of the C library, @option{-lsmallc}, rather than
21777 Newlib.
21779 @item -msys-crt0=@var{startfile}
21780 @opindex msys-crt0
21781 @var{startfile} is the file name of the startfile (crt0) to use 
21782 when linking.  This option is only useful in conjunction with @option{-mhal}.
21784 @item -msys-lib=@var{systemlib}
21785 @opindex msys-lib
21786 @var{systemlib} is the library name of the library that provides
21787 low-level system calls required by the C library,
21788 e.g. @code{read} and @code{write}.
21789 This option is typically used to link with a library provided by a HAL BSP.
21791 @end table
21793 @node Nvidia PTX Options
21794 @subsection Nvidia PTX Options
21795 @cindex Nvidia PTX options
21796 @cindex nvptx options
21798 These options are defined for Nvidia PTX:
21800 @table @gcctabopt
21802 @item -m32
21803 @itemx -m64
21804 @opindex m32
21805 @opindex m64
21806 Generate code for 32-bit or 64-bit ABI.
21808 @item -mmainkernel
21809 @opindex mmainkernel
21810 Link in code for a __main kernel.  This is for stand-alone instead of
21811 offloading execution.
21813 @item -moptimize
21814 @opindex moptimize
21815 Apply partitioned execution optimizations.  This is the default when any
21816 level of optimization is selected.
21818 @item -msoft-stack
21819 @opindex msoft-stack
21820 Generate code that does not use @code{.local} memory
21821 directly for stack storage. Instead, a per-warp stack pointer is
21822 maintained explicitly. This enables variable-length stack allocation (with
21823 variable-length arrays or @code{alloca}), and when global memory is used for
21824 underlying storage, makes it possible to access automatic variables from other
21825 threads, or with atomic instructions. This code generation variant is used
21826 for OpenMP offloading, but the option is exposed on its own for the purpose
21827 of testing the compiler; to generate code suitable for linking into programs
21828 using OpenMP offloading, use option @option{-mgomp}.
21830 @item -muniform-simt
21831 @opindex muniform-simt
21832 Switch to code generation variant that allows to execute all threads in each
21833 warp, while maintaining memory state and side effects as if only one thread
21834 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21835 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21836 current lane index equals the master lane index), and the register being
21837 assigned is copied via a shuffle instruction from the master lane.  Outside of
21838 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21839 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21840 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21841 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21842 with current lane index to compute the master lane index.
21844 @item -mgomp
21845 @opindex mgomp
21846 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21847 @option{-muniform-simt} options, and selects corresponding multilib variant.
21849 @end table
21851 @node PDP-11 Options
21852 @subsection PDP-11 Options
21853 @cindex PDP-11 Options
21855 These options are defined for the PDP-11:
21857 @table @gcctabopt
21858 @item -mfpu
21859 @opindex mfpu
21860 Use hardware FPP floating point.  This is the default.  (FIS floating
21861 point on the PDP-11/40 is not supported.)
21863 @item -msoft-float
21864 @opindex msoft-float
21865 Do not use hardware floating point.
21867 @item -mac0
21868 @opindex mac0
21869 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21871 @item -mno-ac0
21872 @opindex mno-ac0
21873 Return floating-point results in memory.  This is the default.
21875 @item -m40
21876 @opindex m40
21877 Generate code for a PDP-11/40.
21879 @item -m45
21880 @opindex m45
21881 Generate code for a PDP-11/45.  This is the default.
21883 @item -m10
21884 @opindex m10
21885 Generate code for a PDP-11/10.
21887 @item -mbcopy-builtin
21888 @opindex mbcopy-builtin
21889 Use inline @code{movmemhi} patterns for copying memory.  This is the
21890 default.
21892 @item -mbcopy
21893 @opindex mbcopy
21894 Do not use inline @code{movmemhi} patterns for copying memory.
21896 @item -mint16
21897 @itemx -mno-int32
21898 @opindex mint16
21899 @opindex mno-int32
21900 Use 16-bit @code{int}.  This is the default.
21902 @item -mint32
21903 @itemx -mno-int16
21904 @opindex mint32
21905 @opindex mno-int16
21906 Use 32-bit @code{int}.
21908 @item -mfloat64
21909 @itemx -mno-float32
21910 @opindex mfloat64
21911 @opindex mno-float32
21912 Use 64-bit @code{float}.  This is the default.
21914 @item -mfloat32
21915 @itemx -mno-float64
21916 @opindex mfloat32
21917 @opindex mno-float64
21918 Use 32-bit @code{float}.
21920 @item -mabshi
21921 @opindex mabshi
21922 Use @code{abshi2} pattern.  This is the default.
21924 @item -mno-abshi
21925 @opindex mno-abshi
21926 Do not use @code{abshi2} pattern.
21928 @item -mbranch-expensive
21929 @opindex mbranch-expensive
21930 Pretend that branches are expensive.  This is for experimenting with
21931 code generation only.
21933 @item -mbranch-cheap
21934 @opindex mbranch-cheap
21935 Do not pretend that branches are expensive.  This is the default.
21937 @item -munix-asm
21938 @opindex munix-asm
21939 Use Unix assembler syntax.  This is the default when configured for
21940 @samp{pdp11-*-bsd}.
21942 @item -mdec-asm
21943 @opindex mdec-asm
21944 Use DEC assembler syntax.  This is the default when configured for any
21945 PDP-11 target other than @samp{pdp11-*-bsd}.
21946 @end table
21948 @node picoChip Options
21949 @subsection picoChip Options
21950 @cindex picoChip options
21952 These @samp{-m} options are defined for picoChip implementations:
21954 @table @gcctabopt
21956 @item -mae=@var{ae_type}
21957 @opindex mcpu
21958 Set the instruction set, register set, and instruction scheduling
21959 parameters for array element type @var{ae_type}.  Supported values
21960 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21962 @option{-mae=ANY} selects a completely generic AE type.  Code
21963 generated with this option runs on any of the other AE types.  The
21964 code is not as efficient as it would be if compiled for a specific
21965 AE type, and some types of operation (e.g., multiplication) do not
21966 work properly on all types of AE.
21968 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21969 for compiled code, and is the default.
21971 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21972 option may suffer from poor performance of byte (char) manipulation,
21973 since the DSP AE does not provide hardware support for byte load/stores.
21975 @item -msymbol-as-address
21976 Enable the compiler to directly use a symbol name as an address in a
21977 load/store instruction, without first loading it into a
21978 register.  Typically, the use of this option generates larger
21979 programs, which run faster than when the option isn't used.  However, the
21980 results vary from program to program, so it is left as a user option,
21981 rather than being permanently enabled.
21983 @item -mno-inefficient-warnings
21984 Disables warnings about the generation of inefficient code.  These
21985 warnings can be generated, for example, when compiling code that
21986 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21987 no hardware support for byte-level memory operations, so all byte
21988 load/stores must be synthesized from word load/store operations.  This is
21989 inefficient and a warning is generated to indicate
21990 that you should rewrite the code to avoid byte operations, or to target
21991 an AE type that has the necessary hardware support.  This option disables
21992 these warnings.
21994 @end table
21996 @node PowerPC Options
21997 @subsection PowerPC Options
21998 @cindex PowerPC options
22000 These are listed under @xref{RS/6000 and PowerPC Options}.
22002 @node RISC-V Options
22003 @subsection RISC-V Options
22004 @cindex RISC-V Options
22006 These command-line options are defined for RISC-V targets:
22008 @table @gcctabopt
22009 @item -mbranch-cost=@var{n}
22010 @opindex mbranch-cost
22011 Set the cost of branches to roughly @var{n} instructions.
22013 @item -mplt
22014 @itemx -mno-plt
22015 @opindex plt
22016 When generating PIC code, do or don't allow the use of PLTs. Ignored for
22017 non-PIC.  The default is @option{-mplt}.
22019 @item -mabi=@var{ABI-string}
22020 @opindex mabi
22021 Specify integer and floating-point calling convention.  @var{ABI-string}
22022 contains two parts: the size of integer types and the registers used for
22023 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
22024 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
22025 32-bit), and that floating-point values up to 64 bits wide are passed in F
22026 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
22027 allows the compiler to generate code that uses the F and D extensions but only
22028 allows floating-point values up to 32 bits long to be passed in registers; or
22029 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
22030 passed in registers.
22032 The default for this argument is system dependent, users who want a specific
22033 calling convention should specify one explicitly.  The valid calling
22034 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
22035 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
22036 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
22037 invalid because the ABI requires 64-bit values be passed in F registers, but F
22038 registers are only 32 bits wide.
22040 @item -mfdiv
22041 @itemx -mno-fdiv
22042 @opindex mfdiv
22043 Do or don't use hardware floating-point divide and square root instructions.
22044 This requires the F or D extensions for floating-point registers.  The default
22045 is to use them if the specified architecture has these instructions.
22047 @item -mdiv
22048 @itemx -mno-div
22049 @opindex mdiv
22050 Do or don't use hardware instructions for integer division.  This requires the
22051 M extension.  The default is to use them if the specified architecture has
22052 these instructions.
22054 @item -march=@var{ISA-string}
22055 @opindex march
22056 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
22057 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
22059 @item -mtune=@var{processor-string}
22060 @opindex mtune
22061 Optimize the output for the given processor, specified by microarchitecture
22062 name.
22064 @item -msmall-data-limit=@var{n}
22065 @opindex msmall-data-limit
22066 Put global and static data smaller than @var{n} bytes into a special section
22067 (on some targets).
22069 @item -msave-restore
22070 @itemx -mno-save-restore
22071 @opindex msave-restore
22072 Do or don't use smaller but slower prologue and epilogue code that uses
22073 library function calls.  The default is to use fast inline prologues and
22074 epilogues.
22076 @item -mstrict-align
22077 @itemx -mno-strict-align
22078 @opindex mstrict-align
22079 Do not or do generate unaligned memory accesses.  The default is set depending
22080 on whether the processor we are optimizing for supports fast unaligned access
22081 or not.
22083 @item -mcmodel=medlow
22084 @opindex mcmodel=medlow
22085 Generate code for the medium-low code model. The program and its statically
22086 defined symbols must lie within a single 2 GiB address range and must lie
22087 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
22088 statically or dynamically linked. This is the default code model.
22090 @item -mcmodel=medany
22091 @opindex mcmodel=medany
22092 Generate code for the medium-any code model. The program and its statically
22093 defined symbols must be within any single 2 GiB address range. Programs can be
22094 statically or dynamically linked.
22096 @item -mexplicit-relocs
22097 @itemx -mno-exlicit-relocs
22098 Use or do not use assembler relocation operators when dealing with symbolic
22099 addresses.  The alternative is to use assembler macros instead, which may
22100 limit optimization.
22102 @end table
22104 @node RL78 Options
22105 @subsection RL78 Options
22106 @cindex RL78 Options
22108 @table @gcctabopt
22110 @item -msim
22111 @opindex msim
22112 Links in additional target libraries to support operation within a
22113 simulator.
22115 @item -mmul=none
22116 @itemx -mmul=g10
22117 @itemx -mmul=g13
22118 @itemx -mmul=g14
22119 @itemx -mmul=rl78
22120 @opindex mmul
22121 Specifies the type of hardware multiplication and division support to
22122 be used.  The simplest is @code{none}, which uses software for both
22123 multiplication and division.  This is the default.  The @code{g13}
22124 value is for the hardware multiply/divide peripheral found on the
22125 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
22126 the multiplication and division instructions supported by the RL78/G14
22127 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
22128 the value @code{mg10} is an alias for @code{none}.
22130 In addition a C preprocessor macro is defined, based upon the setting
22131 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
22132 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
22134 @item -mcpu=g10
22135 @itemx -mcpu=g13
22136 @itemx -mcpu=g14
22137 @itemx -mcpu=rl78
22138 @opindex mcpu
22139 Specifies the RL78 core to target.  The default is the G14 core, also
22140 known as an S3 core or just RL78.  The G13 or S2 core does not have
22141 multiply or divide instructions, instead it uses a hardware peripheral
22142 for these operations.  The G10 or S1 core does not have register
22143 banks, so it uses a different calling convention.
22145 If this option is set it also selects the type of hardware multiply
22146 support to use, unless this is overridden by an explicit
22147 @option{-mmul=none} option on the command line.  Thus specifying
22148 @option{-mcpu=g13} enables the use of the G13 hardware multiply
22149 peripheral and specifying @option{-mcpu=g10} disables the use of
22150 hardware multiplications altogether.
22152 Note, although the RL78/G14 core is the default target, specifying
22153 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
22154 change the behavior of the toolchain since it also enables G14
22155 hardware multiply support.  If these options are not specified on the
22156 command line then software multiplication routines will be used even
22157 though the code targets the RL78 core.  This is for backwards
22158 compatibility with older toolchains which did not have hardware
22159 multiply and divide support.
22161 In addition a C preprocessor macro is defined, based upon the setting
22162 of this option.  Possible values are: @code{__RL78_G10__},
22163 @code{__RL78_G13__} or @code{__RL78_G14__}.
22165 @item -mg10
22166 @itemx -mg13
22167 @itemx -mg14
22168 @itemx -mrl78
22169 @opindex mg10
22170 @opindex mg13
22171 @opindex mg14
22172 @opindex mrl78
22173 These are aliases for the corresponding @option{-mcpu=} option.  They
22174 are provided for backwards compatibility.
22176 @item -mallregs
22177 @opindex mallregs
22178 Allow the compiler to use all of the available registers.  By default
22179 registers @code{r24..r31} are reserved for use in interrupt handlers.
22180 With this option enabled these registers can be used in ordinary
22181 functions as well.
22183 @item -m64bit-doubles
22184 @itemx -m32bit-doubles
22185 @opindex m64bit-doubles
22186 @opindex m32bit-doubles
22187 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22188 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22189 @option{-m32bit-doubles}.
22191 @item -msave-mduc-in-interrupts
22192 @item -mno-save-mduc-in-interrupts
22193 @opindex msave-mduc-in-interrupts
22194 @opindex mno-save-mduc-in-interrupts
22195 Specifies that interrupt handler functions should preserve the
22196 MDUC registers.  This is only necessary if normal code might use
22197 the MDUC registers, for example because it performs multiplication
22198 and division operations.  The default is to ignore the MDUC registers
22199 as this makes the interrupt handlers faster.  The target option -mg13
22200 needs to be passed for this to work as this feature is only available
22201 on the G13 target (S2 core).  The MDUC registers will only be saved
22202 if the interrupt handler performs a multiplication or division
22203 operation or it calls another function.
22205 @end table
22207 @node RS/6000 and PowerPC Options
22208 @subsection IBM RS/6000 and PowerPC Options
22209 @cindex RS/6000 and PowerPC Options
22210 @cindex IBM RS/6000 and PowerPC Options
22212 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22213 @table @gcctabopt
22214 @item -mpowerpc-gpopt
22215 @itemx -mno-powerpc-gpopt
22216 @itemx -mpowerpc-gfxopt
22217 @itemx -mno-powerpc-gfxopt
22218 @need 800
22219 @itemx -mpowerpc64
22220 @itemx -mno-powerpc64
22221 @itemx -mmfcrf
22222 @itemx -mno-mfcrf
22223 @itemx -mpopcntb
22224 @itemx -mno-popcntb
22225 @itemx -mpopcntd
22226 @itemx -mno-popcntd
22227 @itemx -mfprnd
22228 @itemx -mno-fprnd
22229 @need 800
22230 @itemx -mcmpb
22231 @itemx -mno-cmpb
22232 @itemx -mmfpgpr
22233 @itemx -mno-mfpgpr
22234 @itemx -mhard-dfp
22235 @itemx -mno-hard-dfp
22236 @opindex mpowerpc-gpopt
22237 @opindex mno-powerpc-gpopt
22238 @opindex mpowerpc-gfxopt
22239 @opindex mno-powerpc-gfxopt
22240 @opindex mpowerpc64
22241 @opindex mno-powerpc64
22242 @opindex mmfcrf
22243 @opindex mno-mfcrf
22244 @opindex mpopcntb
22245 @opindex mno-popcntb
22246 @opindex mpopcntd
22247 @opindex mno-popcntd
22248 @opindex mfprnd
22249 @opindex mno-fprnd
22250 @opindex mcmpb
22251 @opindex mno-cmpb
22252 @opindex mmfpgpr
22253 @opindex mno-mfpgpr
22254 @opindex mhard-dfp
22255 @opindex mno-hard-dfp
22256 You use these options to specify which instructions are available on the
22257 processor you are using.  The default value of these options is
22258 determined when configuring GCC@.  Specifying the
22259 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22260 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22261 rather than the options listed above.
22263 Specifying @option{-mpowerpc-gpopt} allows
22264 GCC to use the optional PowerPC architecture instructions in the
22265 General Purpose group, including floating-point square root.  Specifying
22266 @option{-mpowerpc-gfxopt} allows GCC to
22267 use the optional PowerPC architecture instructions in the Graphics
22268 group, including floating-point select.
22270 The @option{-mmfcrf} option allows GCC to generate the move from
22271 condition register field instruction implemented on the POWER4
22272 processor and other processors that support the PowerPC V2.01
22273 architecture.
22274 The @option{-mpopcntb} option allows GCC to generate the popcount and
22275 double-precision FP reciprocal estimate instruction implemented on the
22276 POWER5 processor and other processors that support the PowerPC V2.02
22277 architecture.
22278 The @option{-mpopcntd} option allows GCC to generate the popcount
22279 instruction implemented on the POWER7 processor and other processors
22280 that support the PowerPC V2.06 architecture.
22281 The @option{-mfprnd} option allows GCC to generate the FP round to
22282 integer instructions implemented on the POWER5+ processor and other
22283 processors that support the PowerPC V2.03 architecture.
22284 The @option{-mcmpb} option allows GCC to generate the compare bytes
22285 instruction implemented on the POWER6 processor and other processors
22286 that support the PowerPC V2.05 architecture.
22287 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22288 general-purpose register instructions implemented on the POWER6X
22289 processor and other processors that support the extended PowerPC V2.05
22290 architecture.
22291 The @option{-mhard-dfp} option allows GCC to generate the decimal
22292 floating-point instructions implemented on some POWER processors.
22294 The @option{-mpowerpc64} option allows GCC to generate the additional
22295 64-bit instructions that are found in the full PowerPC64 architecture
22296 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22297 @option{-mno-powerpc64}.
22299 @item -mcpu=@var{cpu_type}
22300 @opindex mcpu
22301 Set architecture type, register usage, and
22302 instruction scheduling parameters for machine type @var{cpu_type}.
22303 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22304 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22305 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22306 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22307 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22308 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22309 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22310 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22311 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22312 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22313 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22314 and @samp{rs64}.
22316 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22317 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22318 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22319 architecture machine types, with an appropriate, generic processor
22320 model assumed for scheduling purposes.
22322 The other options specify a specific processor.  Code generated under
22323 those options runs best on that processor, and may not run at all on
22324 others.
22326 The @option{-mcpu} options automatically enable or disable the
22327 following options:
22329 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22330 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22331 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22332 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22333 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22334 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22336 The particular options set for any particular CPU varies between
22337 compiler versions, depending on what setting seems to produce optimal
22338 code for that CPU; it doesn't necessarily reflect the actual hardware's
22339 capabilities.  If you wish to set an individual option to a particular
22340 value, you may specify it after the @option{-mcpu} option, like
22341 @option{-mcpu=970 -mno-altivec}.
22343 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22344 not enabled or disabled by the @option{-mcpu} option at present because
22345 AIX does not have full support for these options.  You may still
22346 enable or disable them individually if you're sure it'll work in your
22347 environment.
22349 @item -mtune=@var{cpu_type}
22350 @opindex mtune
22351 Set the instruction scheduling parameters for machine type
22352 @var{cpu_type}, but do not set the architecture type or register usage,
22353 as @option{-mcpu=@var{cpu_type}} does.  The same
22354 values for @var{cpu_type} are used for @option{-mtune} as for
22355 @option{-mcpu}.  If both are specified, the code generated uses the
22356 architecture and registers set by @option{-mcpu}, but the
22357 scheduling parameters set by @option{-mtune}.
22359 @item -mcmodel=small
22360 @opindex mcmodel=small
22361 Generate PowerPC64 code for the small model: The TOC is limited to
22362 64k.
22364 @item -mcmodel=medium
22365 @opindex mcmodel=medium
22366 Generate PowerPC64 code for the medium model: The TOC and other static
22367 data may be up to a total of 4G in size.  This is the default for 64-bit
22368 Linux.
22370 @item -mcmodel=large
22371 @opindex mcmodel=large
22372 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22373 in size.  Other data and code is only limited by the 64-bit address
22374 space.
22376 @item -maltivec
22377 @itemx -mno-altivec
22378 @opindex maltivec
22379 @opindex mno-altivec
22380 Generate code that uses (does not use) AltiVec instructions, and also
22381 enable the use of built-in functions that allow more direct access to
22382 the AltiVec instruction set.  You may also need to set
22383 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22384 enhancements.
22386 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22387 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22388 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22389 match array element order corresponding to the endianness of the
22390 target.  That is, element zero identifies the leftmost element in a
22391 vector register when targeting a big-endian platform, and identifies
22392 the rightmost element in a vector register when targeting a
22393 little-endian platform.
22395 @item -maltivec=be
22396 @opindex maltivec=be
22397 Generate AltiVec instructions using big-endian element order,
22398 regardless of whether the target is big- or little-endian.  This is
22399 the default when targeting a big-endian platform.
22401 The element order is used to interpret element numbers in AltiVec
22402 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22403 @code{vec_insert}.  By default, these match array element order
22404 corresponding to the endianness for the target.
22406 @item -maltivec=le
22407 @opindex maltivec=le
22408 Generate AltiVec instructions using little-endian element order,
22409 regardless of whether the target is big- or little-endian.  This is
22410 the default when targeting a little-endian platform.  This option is
22411 currently ignored when targeting a big-endian platform.
22413 The element order is used to interpret element numbers in AltiVec
22414 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22415 @code{vec_insert}.  By default, these match array element order
22416 corresponding to the endianness for the target.
22418 @item -mvrsave
22419 @itemx -mno-vrsave
22420 @opindex mvrsave
22421 @opindex mno-vrsave
22422 Generate VRSAVE instructions when generating AltiVec code.
22424 @item -msecure-plt
22425 @opindex msecure-plt
22426 Generate code that allows @command{ld} and @command{ld.so}
22427 to build executables and shared
22428 libraries with non-executable @code{.plt} and @code{.got} sections.
22429 This is a PowerPC
22430 32-bit SYSV ABI option.
22432 @item -mbss-plt
22433 @opindex mbss-plt
22434 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22435 fills in, and
22436 requires @code{.plt} and @code{.got}
22437 sections that are both writable and executable.
22438 This is a PowerPC 32-bit SYSV ABI option.
22440 @item -misel
22441 @itemx -mno-isel
22442 @opindex misel
22443 @opindex mno-isel
22444 This switch enables or disables the generation of ISEL instructions.
22446 @item -misel=@var{yes/no}
22447 This switch has been deprecated.  Use @option{-misel} and
22448 @option{-mno-isel} instead.
22450 @item -mspe
22451 @itemx -mno-spe
22452 @opindex mspe
22453 @opindex mno-spe
22454 This switch enables or disables the generation of SPE simd
22455 instructions.
22457 @item -mpaired
22458 @itemx -mno-paired
22459 @opindex mpaired
22460 @opindex mno-paired
22461 This switch enables or disables the generation of PAIRED simd
22462 instructions.
22464 @item -mspe=@var{yes/no}
22465 This option has been deprecated.  Use @option{-mspe} and
22466 @option{-mno-spe} instead.
22468 @item -mvsx
22469 @itemx -mno-vsx
22470 @opindex mvsx
22471 @opindex mno-vsx
22472 Generate code that uses (does not use) vector/scalar (VSX)
22473 instructions, and also enable the use of built-in functions that allow
22474 more direct access to the VSX instruction set.
22476 @item -mcrypto
22477 @itemx -mno-crypto
22478 @opindex mcrypto
22479 @opindex mno-crypto
22480 Enable the use (disable) of the built-in functions that allow direct
22481 access to the cryptographic instructions that were added in version
22482 2.07 of the PowerPC ISA.
22484 @item -mdirect-move
22485 @itemx -mno-direct-move
22486 @opindex mdirect-move
22487 @opindex mno-direct-move
22488 Generate code that uses (does not use) the instructions to move data
22489 between the general purpose registers and the vector/scalar (VSX)
22490 registers that were added in version 2.07 of the PowerPC ISA.
22492 @item -mhtm
22493 @itemx -mno-htm
22494 @opindex mhtm
22495 @opindex mno-htm
22496 Enable (disable) the use of the built-in functions that allow direct
22497 access to the Hardware Transactional Memory (HTM) instructions that
22498 were added in version 2.07 of the PowerPC ISA.
22500 @item -mpower8-fusion
22501 @itemx -mno-power8-fusion
22502 @opindex mpower8-fusion
22503 @opindex mno-power8-fusion
22504 Generate code that keeps (does not keeps) some integer operations
22505 adjacent so that the instructions can be fused together on power8 and
22506 later processors.
22508 @item -mpower8-vector
22509 @itemx -mno-power8-vector
22510 @opindex mpower8-vector
22511 @opindex mno-power8-vector
22512 Generate code that uses (does not use) the vector and scalar
22513 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22514 enable the use of built-in functions that allow more direct access to
22515 the vector instructions.
22517 @item -mquad-memory
22518 @itemx -mno-quad-memory
22519 @opindex mquad-memory
22520 @opindex mno-quad-memory
22521 Generate code that uses (does not use) the non-atomic quad word memory
22522 instructions.  The @option{-mquad-memory} option requires use of
22523 64-bit mode.
22525 @item -mquad-memory-atomic
22526 @itemx -mno-quad-memory-atomic
22527 @opindex mquad-memory-atomic
22528 @opindex mno-quad-memory-atomic
22529 Generate code that uses (does not use) the atomic quad word memory
22530 instructions.  The @option{-mquad-memory-atomic} option requires use of
22531 64-bit mode.
22533 @item -mfloat128
22534 @itemx -mno-float128
22535 @opindex mfloat128
22536 @opindex mno-float128
22537 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22538 and use either software emulation for IEEE 128-bit floating point or
22539 hardware instructions.
22541 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22542 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22543 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22544 floating point support only works on PowerPC Linux systems.
22546 The default for @option{-mfloat128} is enabled on PowerPC Linux
22547 systems using the VSX instruction set, and disabled on other systems.
22549 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22550 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22551 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22552 floating point instructions.  Otherwise, if you do not specify to
22553 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22554 system, IEEE 128-bit floating point will be done with software
22555 emulation.
22557 @item -mfloat128-hardware
22558 @itemx -mno-float128-hardware
22559 @opindex mfloat128-hardware
22560 @opindex mno-float128-hardware
22561 Enable/disable using ISA 3.0 hardware instructions to support the
22562 @var{__float128} data type.
22564 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22565 Linux systems using the ISA 3.0 instruction set, and disabled on other
22566 systems.
22568 @item -mfloat-gprs=@var{yes/single/double/no}
22569 @itemx -mfloat-gprs
22570 @opindex mfloat-gprs
22571 This switch enables or disables the generation of floating-point
22572 operations on the general-purpose registers for architectures that
22573 support it.
22575 The argument @samp{yes} or @samp{single} enables the use of
22576 single-precision floating-point operations.
22578 The argument @samp{double} enables the use of single and
22579 double-precision floating-point operations.
22581 The argument @samp{no} disables floating-point operations on the
22582 general-purpose registers.
22584 This option is currently only available on the MPC854x.
22586 @item -m32
22587 @itemx -m64
22588 @opindex m32
22589 @opindex m64
22590 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22591 targets (including GNU/Linux).  The 32-bit environment sets int, long
22592 and pointer to 32 bits and generates code that runs on any PowerPC
22593 variant.  The 64-bit environment sets int to 32 bits and long and
22594 pointer to 64 bits, and generates code for PowerPC64, as for
22595 @option{-mpowerpc64}.
22597 @item -mfull-toc
22598 @itemx -mno-fp-in-toc
22599 @itemx -mno-sum-in-toc
22600 @itemx -mminimal-toc
22601 @opindex mfull-toc
22602 @opindex mno-fp-in-toc
22603 @opindex mno-sum-in-toc
22604 @opindex mminimal-toc
22605 Modify generation of the TOC (Table Of Contents), which is created for
22606 every executable file.  The @option{-mfull-toc} option is selected by
22607 default.  In that case, GCC allocates at least one TOC entry for
22608 each unique non-automatic variable reference in your program.  GCC
22609 also places floating-point constants in the TOC@.  However, only
22610 16,384 entries are available in the TOC@.
22612 If you receive a linker error message that saying you have overflowed
22613 the available TOC space, you can reduce the amount of TOC space used
22614 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22615 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22616 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22617 generate code to calculate the sum of an address and a constant at
22618 run time instead of putting that sum into the TOC@.  You may specify one
22619 or both of these options.  Each causes GCC to produce very slightly
22620 slower and larger code at the expense of conserving TOC space.
22622 If you still run out of space in the TOC even when you specify both of
22623 these options, specify @option{-mminimal-toc} instead.  This option causes
22624 GCC to make only one TOC entry for every file.  When you specify this
22625 option, GCC produces code that is slower and larger but which
22626 uses extremely little TOC space.  You may wish to use this option
22627 only on files that contain less frequently-executed code.
22629 @item -maix64
22630 @itemx -maix32
22631 @opindex maix64
22632 @opindex maix32
22633 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22634 @code{long} type, and the infrastructure needed to support them.
22635 Specifying @option{-maix64} implies @option{-mpowerpc64},
22636 while @option{-maix32} disables the 64-bit ABI and
22637 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22639 @item -mxl-compat
22640 @itemx -mno-xl-compat
22641 @opindex mxl-compat
22642 @opindex mno-xl-compat
22643 Produce code that conforms more closely to IBM XL compiler semantics
22644 when using AIX-compatible ABI@.  Pass floating-point arguments to
22645 prototyped functions beyond the register save area (RSA) on the stack
22646 in addition to argument FPRs.  Do not assume that most significant
22647 double in 128-bit long double value is properly rounded when comparing
22648 values and converting to double.  Use XL symbol names for long double
22649 support routines.
22651 The AIX calling convention was extended but not initially documented to
22652 handle an obscure K&R C case of calling a function that takes the
22653 address of its arguments with fewer arguments than declared.  IBM XL
22654 compilers access floating-point arguments that do not fit in the
22655 RSA from the stack when a subroutine is compiled without
22656 optimization.  Because always storing floating-point arguments on the
22657 stack is inefficient and rarely needed, this option is not enabled by
22658 default and only is necessary when calling subroutines compiled by IBM
22659 XL compilers without optimization.
22661 @item -mpe
22662 @opindex mpe
22663 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22664 application written to use message passing with special startup code to
22665 enable the application to run.  The system must have PE installed in the
22666 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22667 must be overridden with the @option{-specs=} option to specify the
22668 appropriate directory location.  The Parallel Environment does not
22669 support threads, so the @option{-mpe} option and the @option{-pthread}
22670 option are incompatible.
22672 @item -malign-natural
22673 @itemx -malign-power
22674 @opindex malign-natural
22675 @opindex malign-power
22676 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22677 @option{-malign-natural} overrides the ABI-defined alignment of larger
22678 types, such as floating-point doubles, on their natural size-based boundary.
22679 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22680 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22682 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22683 is not supported.
22685 @item -msoft-float
22686 @itemx -mhard-float
22687 @opindex msoft-float
22688 @opindex mhard-float
22689 Generate code that does not use (uses) the floating-point register set.
22690 Software floating-point emulation is provided if you use the
22691 @option{-msoft-float} option, and pass the option to GCC when linking.
22693 @item -msingle-float
22694 @itemx -mdouble-float
22695 @opindex msingle-float
22696 @opindex mdouble-float
22697 Generate code for single- or double-precision floating-point operations.
22698 @option{-mdouble-float} implies @option{-msingle-float}.
22700 @item -msimple-fpu
22701 @opindex msimple-fpu
22702 Do not generate @code{sqrt} and @code{div} instructions for hardware
22703 floating-point unit.
22705 @item -mfpu=@var{name}
22706 @opindex mfpu
22707 Specify type of floating-point unit.  Valid values for @var{name} are
22708 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22709 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22710 @samp{sp_full} (equivalent to @option{-msingle-float}),
22711 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22713 @item -mxilinx-fpu
22714 @opindex mxilinx-fpu
22715 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22717 @item -mmultiple
22718 @itemx -mno-multiple
22719 @opindex mmultiple
22720 @opindex mno-multiple
22721 Generate code that uses (does not use) the load multiple word
22722 instructions and the store multiple word instructions.  These
22723 instructions are generated by default on POWER systems, and not
22724 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22725 PowerPC systems, since those instructions do not work when the
22726 processor is in little-endian mode.  The exceptions are PPC740 and
22727 PPC750 which permit these instructions in little-endian mode.
22729 @item -mupdate
22730 @itemx -mno-update
22731 @opindex mupdate
22732 @opindex mno-update
22733 Generate code that uses (does not use) the load or store instructions
22734 that update the base register to the address of the calculated memory
22735 location.  These instructions are generated by default.  If you use
22736 @option{-mno-update}, there is a small window between the time that the
22737 stack pointer is updated and the address of the previous frame is
22738 stored, which means code that walks the stack frame across interrupts or
22739 signals may get corrupted data.
22741 @item -mavoid-indexed-addresses
22742 @itemx -mno-avoid-indexed-addresses
22743 @opindex mavoid-indexed-addresses
22744 @opindex mno-avoid-indexed-addresses
22745 Generate code that tries to avoid (not avoid) the use of indexed load
22746 or store instructions. These instructions can incur a performance
22747 penalty on Power6 processors in certain situations, such as when
22748 stepping through large arrays that cross a 16M boundary.  This option
22749 is enabled by default when targeting Power6 and disabled otherwise.
22751 @item -mfused-madd
22752 @itemx -mno-fused-madd
22753 @opindex mfused-madd
22754 @opindex mno-fused-madd
22755 Generate code that uses (does not use) the floating-point multiply and
22756 accumulate instructions.  These instructions are generated by default
22757 if hardware floating point is used.  The machine-dependent
22758 @option{-mfused-madd} option is now mapped to the machine-independent
22759 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22760 mapped to @option{-ffp-contract=off}.
22762 @item -mmulhw
22763 @itemx -mno-mulhw
22764 @opindex mmulhw
22765 @opindex mno-mulhw
22766 Generate code that uses (does not use) the half-word multiply and
22767 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22768 These instructions are generated by default when targeting those
22769 processors.
22771 @item -mdlmzb
22772 @itemx -mno-dlmzb
22773 @opindex mdlmzb
22774 @opindex mno-dlmzb
22775 Generate code that uses (does not use) the string-search @samp{dlmzb}
22776 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22777 generated by default when targeting those processors.
22779 @item -mno-bit-align
22780 @itemx -mbit-align
22781 @opindex mno-bit-align
22782 @opindex mbit-align
22783 On System V.4 and embedded PowerPC systems do not (do) force structures
22784 and unions that contain bit-fields to be aligned to the base type of the
22785 bit-field.
22787 For example, by default a structure containing nothing but 8
22788 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22789 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22790 the structure is aligned to a 1-byte boundary and is 1 byte in
22791 size.
22793 @item -mno-strict-align
22794 @itemx -mstrict-align
22795 @opindex mno-strict-align
22796 @opindex mstrict-align
22797 On System V.4 and embedded PowerPC systems do not (do) assume that
22798 unaligned memory references are handled by the system.
22800 @item -mrelocatable
22801 @itemx -mno-relocatable
22802 @opindex mrelocatable
22803 @opindex mno-relocatable
22804 Generate code that allows (does not allow) a static executable to be
22805 relocated to a different address at run time.  A simple embedded
22806 PowerPC system loader should relocate the entire contents of
22807 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22808 a table of 32-bit addresses generated by this option.  For this to
22809 work, all objects linked together must be compiled with
22810 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22811 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22813 @item -mrelocatable-lib
22814 @itemx -mno-relocatable-lib
22815 @opindex mrelocatable-lib
22816 @opindex mno-relocatable-lib
22817 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22818 @code{.fixup} section to allow static executables to be relocated at
22819 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22820 alignment of @option{-mrelocatable}.  Objects compiled with
22821 @option{-mrelocatable-lib} may be linked with objects compiled with
22822 any combination of the @option{-mrelocatable} options.
22824 @item -mno-toc
22825 @itemx -mtoc
22826 @opindex mno-toc
22827 @opindex mtoc
22828 On System V.4 and embedded PowerPC systems do not (do) assume that
22829 register 2 contains a pointer to a global area pointing to the addresses
22830 used in the program.
22832 @item -mlittle
22833 @itemx -mlittle-endian
22834 @opindex mlittle
22835 @opindex mlittle-endian
22836 On System V.4 and embedded PowerPC systems compile code for the
22837 processor in little-endian mode.  The @option{-mlittle-endian} option is
22838 the same as @option{-mlittle}.
22840 @item -mbig
22841 @itemx -mbig-endian
22842 @opindex mbig
22843 @opindex mbig-endian
22844 On System V.4 and embedded PowerPC systems compile code for the
22845 processor in big-endian mode.  The @option{-mbig-endian} option is
22846 the same as @option{-mbig}.
22848 @item -mdynamic-no-pic
22849 @opindex mdynamic-no-pic
22850 On Darwin and Mac OS X systems, compile code so that it is not
22851 relocatable, but that its external references are relocatable.  The
22852 resulting code is suitable for applications, but not shared
22853 libraries.
22855 @item -msingle-pic-base
22856 @opindex msingle-pic-base
22857 Treat the register used for PIC addressing as read-only, rather than
22858 loading it in the prologue for each function.  The runtime system is
22859 responsible for initializing this register with an appropriate value
22860 before execution begins.
22862 @item -mprioritize-restricted-insns=@var{priority}
22863 @opindex mprioritize-restricted-insns
22864 This option controls the priority that is assigned to
22865 dispatch-slot restricted instructions during the second scheduling
22866 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22867 or @samp{2} to assign no, highest, or second-highest (respectively) 
22868 priority to dispatch-slot restricted
22869 instructions.
22871 @item -msched-costly-dep=@var{dependence_type}
22872 @opindex msched-costly-dep
22873 This option controls which dependences are considered costly
22874 by the target during instruction scheduling.  The argument
22875 @var{dependence_type} takes one of the following values:
22877 @table @asis
22878 @item @samp{no}
22879 No dependence is costly.
22881 @item @samp{all}
22882 All dependences are costly.
22884 @item @samp{true_store_to_load}
22885 A true dependence from store to load is costly.
22887 @item @samp{store_to_load}
22888 Any dependence from store to load is costly.
22890 @item @var{number}
22891 Any dependence for which the latency is greater than or equal to 
22892 @var{number} is costly.
22893 @end table
22895 @item -minsert-sched-nops=@var{scheme}
22896 @opindex minsert-sched-nops
22897 This option controls which NOP insertion scheme is used during
22898 the second scheduling pass.  The argument @var{scheme} takes one of the
22899 following values:
22901 @table @asis
22902 @item @samp{no}
22903 Don't insert NOPs.
22905 @item @samp{pad}
22906 Pad with NOPs any dispatch group that has vacant issue slots,
22907 according to the scheduler's grouping.
22909 @item @samp{regroup_exact}
22910 Insert NOPs to force costly dependent insns into
22911 separate groups.  Insert exactly as many NOPs as needed to force an insn
22912 to a new group, according to the estimated processor grouping.
22914 @item @var{number}
22915 Insert NOPs to force costly dependent insns into
22916 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22917 @end table
22919 @item -mcall-sysv
22920 @opindex mcall-sysv
22921 On System V.4 and embedded PowerPC systems compile code using calling
22922 conventions that adhere to the March 1995 draft of the System V
22923 Application Binary Interface, PowerPC processor supplement.  This is the
22924 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22926 @item -mcall-sysv-eabi
22927 @itemx -mcall-eabi
22928 @opindex mcall-sysv-eabi
22929 @opindex mcall-eabi
22930 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22932 @item -mcall-sysv-noeabi
22933 @opindex mcall-sysv-noeabi
22934 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22936 @item -mcall-aixdesc
22937 @opindex m
22938 On System V.4 and embedded PowerPC systems compile code for the AIX
22939 operating system.
22941 @item -mcall-linux
22942 @opindex mcall-linux
22943 On System V.4 and embedded PowerPC systems compile code for the
22944 Linux-based GNU system.
22946 @item -mcall-freebsd
22947 @opindex mcall-freebsd
22948 On System V.4 and embedded PowerPC systems compile code for the
22949 FreeBSD operating system.
22951 @item -mcall-netbsd
22952 @opindex mcall-netbsd
22953 On System V.4 and embedded PowerPC systems compile code for the
22954 NetBSD operating system.
22956 @item -mcall-openbsd
22957 @opindex mcall-netbsd
22958 On System V.4 and embedded PowerPC systems compile code for the
22959 OpenBSD operating system.
22961 @item -maix-struct-return
22962 @opindex maix-struct-return
22963 Return all structures in memory (as specified by the AIX ABI)@.
22965 @item -msvr4-struct-return
22966 @opindex msvr4-struct-return
22967 Return structures smaller than 8 bytes in registers (as specified by the
22968 SVR4 ABI)@.
22970 @item -mabi=@var{abi-type}
22971 @opindex mabi
22972 Extend the current ABI with a particular extension, or remove such extension.
22973 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22974 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22975 @samp{elfv1}, @samp{elfv2}@.
22977 @item -mabi=spe
22978 @opindex mabi=spe
22979 Extend the current ABI with SPE ABI extensions.  This does not change
22980 the default ABI, instead it adds the SPE ABI extensions to the current
22981 ABI@.
22983 @item -mabi=no-spe
22984 @opindex mabi=no-spe
22985 Disable Book-E SPE ABI extensions for the current ABI@.
22987 @item -mabi=ibmlongdouble
22988 @opindex mabi=ibmlongdouble
22989 Change the current ABI to use IBM extended-precision long double.
22990 This is not likely to work if your system defaults to using IEEE
22991 extended-precision long double.  If you change the long double type
22992 from IEEE extended-precision, the compiler will issue a warning unless
22993 you use the @option{-Wno-psabi} option.
22995 @item -mabi=ieeelongdouble
22996 @opindex mabi=ieeelongdouble
22997 Change the current ABI to use IEEE extended-precision long double.
22998 This is not likely to work if your system defaults to using IBM
22999 extended-precision long double.  If you change the long double type
23000 from IBM extended-precision, the compiler will issue a warning unless
23001 you use the @option{-Wno-psabi} option.
23003 @item -mabi=elfv1
23004 @opindex mabi=elfv1
23005 Change the current ABI to use the ELFv1 ABI.
23006 This is the default ABI for big-endian PowerPC 64-bit Linux.
23007 Overriding the default ABI requires special system support and is
23008 likely to fail in spectacular ways.
23010 @item -mabi=elfv2
23011 @opindex mabi=elfv2
23012 Change the current ABI to use the ELFv2 ABI.
23013 This is the default ABI for little-endian PowerPC 64-bit Linux.
23014 Overriding the default ABI requires special system support and is
23015 likely to fail in spectacular ways.
23017 @item -mgnu-attribute
23018 @itemx -mno-gnu-attribute
23019 @opindex mgnu-attribute
23020 @opindex mno-gnu-attribute
23021 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23022 .gnu.attributes section that specify ABI variations in function
23023 parameters or return values.
23025 @item -mprototype
23026 @itemx -mno-prototype
23027 @opindex mprototype
23028 @opindex mno-prototype
23029 On System V.4 and embedded PowerPC systems assume that all calls to
23030 variable argument functions are properly prototyped.  Otherwise, the
23031 compiler must insert an instruction before every non-prototyped call to
23032 set or clear bit 6 of the condition code register (@code{CR}) to
23033 indicate whether floating-point values are passed in the floating-point
23034 registers in case the function takes variable arguments.  With
23035 @option{-mprototype}, only calls to prototyped variable argument functions
23036 set or clear the bit.
23038 @item -msim
23039 @opindex msim
23040 On embedded PowerPC systems, assume that the startup module is called
23041 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23042 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23043 configurations.
23045 @item -mmvme
23046 @opindex mmvme
23047 On embedded PowerPC systems, assume that the startup module is called
23048 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23049 @file{libc.a}.
23051 @item -mads
23052 @opindex mads
23053 On embedded PowerPC systems, assume that the startup module is called
23054 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23055 @file{libc.a}.
23057 @item -myellowknife
23058 @opindex myellowknife
23059 On embedded PowerPC systems, assume that the startup module is called
23060 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
23061 @file{libc.a}.
23063 @item -mvxworks
23064 @opindex mvxworks
23065 On System V.4 and embedded PowerPC systems, specify that you are
23066 compiling for a VxWorks system.
23068 @item -memb
23069 @opindex memb
23070 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23071 header to indicate that @samp{eabi} extended relocations are used.
23073 @item -meabi
23074 @itemx -mno-eabi
23075 @opindex meabi
23076 @opindex mno-eabi
23077 On System V.4 and embedded PowerPC systems do (do not) adhere to the
23078 Embedded Applications Binary Interface (EABI), which is a set of
23079 modifications to the System V.4 specifications.  Selecting @option{-meabi}
23080 means that the stack is aligned to an 8-byte boundary, a function
23081 @code{__eabi} is called from @code{main} to set up the EABI
23082 environment, and the @option{-msdata} option can use both @code{r2} and
23083 @code{r13} to point to two separate small data areas.  Selecting
23084 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
23085 no EABI initialization function is called from @code{main}, and the
23086 @option{-msdata} option only uses @code{r13} to point to a single
23087 small data area.  The @option{-meabi} option is on by default if you
23088 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
23090 @item -msdata=eabi
23091 @opindex msdata=eabi
23092 On System V.4 and embedded PowerPC systems, put small initialized
23093 @code{const} global and static data in the @code{.sdata2} section, which
23094 is pointed to by register @code{r2}.  Put small initialized
23095 non-@code{const} global and static data in the @code{.sdata} section,
23096 which is pointed to by register @code{r13}.  Put small uninitialized
23097 global and static data in the @code{.sbss} section, which is adjacent to
23098 the @code{.sdata} section.  The @option{-msdata=eabi} option is
23099 incompatible with the @option{-mrelocatable} option.  The
23100 @option{-msdata=eabi} option also sets the @option{-memb} option.
23102 @item -msdata=sysv
23103 @opindex msdata=sysv
23104 On System V.4 and embedded PowerPC systems, put small global and static
23105 data in the @code{.sdata} section, which is pointed to by register
23106 @code{r13}.  Put small uninitialized global and static data in the
23107 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
23108 The @option{-msdata=sysv} option is incompatible with the
23109 @option{-mrelocatable} option.
23111 @item -msdata=default
23112 @itemx -msdata
23113 @opindex msdata=default
23114 @opindex msdata
23115 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
23116 compile code the same as @option{-msdata=eabi}, otherwise compile code the
23117 same as @option{-msdata=sysv}.
23119 @item -msdata=data
23120 @opindex msdata=data
23121 On System V.4 and embedded PowerPC systems, put small global
23122 data in the @code{.sdata} section.  Put small uninitialized global
23123 data in the @code{.sbss} section.  Do not use register @code{r13}
23124 to address small data however.  This is the default behavior unless
23125 other @option{-msdata} options are used.
23127 @item -msdata=none
23128 @itemx -mno-sdata
23129 @opindex msdata=none
23130 @opindex mno-sdata
23131 On embedded PowerPC systems, put all initialized global and static data
23132 in the @code{.data} section, and all uninitialized data in the
23133 @code{.bss} section.
23135 @item -mblock-move-inline-limit=@var{num}
23136 @opindex mblock-move-inline-limit
23137 Inline all block moves (such as calls to @code{memcpy} or structure
23138 copies) less than or equal to @var{num} bytes.  The minimum value for
23139 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23140 targets.  The default value is target-specific.
23142 @item -G @var{num}
23143 @opindex G
23144 @cindex smaller data references (PowerPC)
23145 @cindex .sdata/.sdata2 references (PowerPC)
23146 On embedded PowerPC systems, put global and static items less than or
23147 equal to @var{num} bytes into the small data or BSS sections instead of
23148 the normal data or BSS section.  By default, @var{num} is 8.  The
23149 @option{-G @var{num}} switch is also passed to the linker.
23150 All modules should be compiled with the same @option{-G @var{num}} value.
23152 @item -mregnames
23153 @itemx -mno-regnames
23154 @opindex mregnames
23155 @opindex mno-regnames
23156 On System V.4 and embedded PowerPC systems do (do not) emit register
23157 names in the assembly language output using symbolic forms.
23159 @item -mlongcall
23160 @itemx -mno-longcall
23161 @opindex mlongcall
23162 @opindex mno-longcall
23163 By default assume that all calls are far away so that a longer and more
23164 expensive calling sequence is required.  This is required for calls
23165 farther than 32 megabytes (33,554,432 bytes) from the current location.
23166 A short call is generated if the compiler knows
23167 the call cannot be that far away.  This setting can be overridden by
23168 the @code{shortcall} function attribute, or by @code{#pragma
23169 longcall(0)}.
23171 Some linkers are capable of detecting out-of-range calls and generating
23172 glue code on the fly.  On these systems, long calls are unnecessary and
23173 generate slower code.  As of this writing, the AIX linker can do this,
23174 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23175 to the GNU linker for 32-bit PowerPC systems as well.
23177 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23178 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23179 addresses represent the callee and the branch island.  The
23180 Darwin/PPC linker prefers the first address and generates a @code{bl
23181 callee} if the PPC @code{bl} instruction reaches the callee directly;
23182 otherwise, the linker generates @code{bl L42} to call the branch
23183 island.  The branch island is appended to the body of the
23184 calling function; it computes the full 32-bit address of the callee
23185 and jumps to it.
23187 On Mach-O (Darwin) systems, this option directs the compiler emit to
23188 the glue for every direct call, and the Darwin linker decides whether
23189 to use or discard it.
23191 In the future, GCC may ignore all longcall specifications
23192 when the linker is known to generate glue.
23194 @item -mtls-markers
23195 @itemx -mno-tls-markers
23196 @opindex mtls-markers
23197 @opindex mno-tls-markers
23198 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23199 specifying the function argument.  The relocation allows the linker to
23200 reliably associate function call with argument setup instructions for
23201 TLS optimization, which in turn allows GCC to better schedule the
23202 sequence.
23204 @item -mrecip
23205 @itemx -mno-recip
23206 @opindex mrecip
23207 This option enables use of the reciprocal estimate and
23208 reciprocal square root estimate instructions with additional
23209 Newton-Raphson steps to increase precision instead of doing a divide or
23210 square root and divide for floating-point arguments.  You should use
23211 the @option{-ffast-math} option when using @option{-mrecip} (or at
23212 least @option{-funsafe-math-optimizations},
23213 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23214 @option{-fno-trapping-math}).  Note that while the throughput of the
23215 sequence is generally higher than the throughput of the non-reciprocal
23216 instruction, the precision of the sequence can be decreased by up to 2
23217 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23218 roots.
23220 @item -mrecip=@var{opt}
23221 @opindex mrecip=opt
23222 This option controls which reciprocal estimate instructions
23223 may be used.  @var{opt} is a comma-separated list of options, which may
23224 be preceded by a @code{!} to invert the option:
23226 @table @samp
23228 @item all
23229 Enable all estimate instructions.
23231 @item default 
23232 Enable the default instructions, equivalent to @option{-mrecip}.
23234 @item none 
23235 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23237 @item div 
23238 Enable the reciprocal approximation instructions for both 
23239 single and double precision.
23241 @item divf 
23242 Enable the single-precision reciprocal approximation instructions.
23244 @item divd 
23245 Enable the double-precision reciprocal approximation instructions.
23247 @item rsqrt 
23248 Enable the reciprocal square root approximation instructions for both
23249 single and double precision.
23251 @item rsqrtf 
23252 Enable the single-precision reciprocal square root approximation instructions.
23254 @item rsqrtd 
23255 Enable the double-precision reciprocal square root approximation instructions.
23257 @end table
23259 So, for example, @option{-mrecip=all,!rsqrtd} enables
23260 all of the reciprocal estimate instructions, except for the
23261 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23262 which handle the double-precision reciprocal square root calculations.
23264 @item -mrecip-precision
23265 @itemx -mno-recip-precision
23266 @opindex mrecip-precision
23267 Assume (do not assume) that the reciprocal estimate instructions
23268 provide higher-precision estimates than is mandated by the PowerPC
23269 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23270 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23271 The double-precision square root estimate instructions are not generated by
23272 default on low-precision machines, since they do not provide an
23273 estimate that converges after three steps.
23275 @item -mveclibabi=@var{type}
23276 @opindex mveclibabi
23277 Specifies the ABI type to use for vectorizing intrinsics using an
23278 external library.  The only type supported at present is @samp{mass},
23279 which specifies to use IBM's Mathematical Acceleration Subsystem
23280 (MASS) libraries for vectorizing intrinsics using external libraries.
23281 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23282 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23283 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23284 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23285 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23286 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23287 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23288 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23289 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23290 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23291 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23292 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23293 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23294 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23295 for power7.  Both @option{-ftree-vectorize} and
23296 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23297 libraries must be specified at link time.
23299 @item -mfriz
23300 @itemx -mno-friz
23301 @opindex mfriz
23302 Generate (do not generate) the @code{friz} instruction when the
23303 @option{-funsafe-math-optimizations} option is used to optimize
23304 rounding of floating-point values to 64-bit integer and back to floating
23305 point.  The @code{friz} instruction does not return the same value if
23306 the floating-point number is too large to fit in an integer.
23308 @item -mpointers-to-nested-functions
23309 @itemx -mno-pointers-to-nested-functions
23310 @opindex mpointers-to-nested-functions
23311 Generate (do not generate) code to load up the static chain register
23312 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23313 systems where a function pointer points to a 3-word descriptor giving
23314 the function address, TOC value to be loaded in register @code{r2}, and
23315 static chain value to be loaded in register @code{r11}.  The
23316 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23317 call through pointers to nested functions or pointers
23318 to functions compiled in other languages that use the static chain if
23319 you use @option{-mno-pointers-to-nested-functions}.
23321 @item -msave-toc-indirect
23322 @itemx -mno-save-toc-indirect
23323 @opindex msave-toc-indirect
23324 Generate (do not generate) code to save the TOC value in the reserved
23325 stack location in the function prologue if the function calls through
23326 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23327 saved in the prologue, it is saved just before the call through the
23328 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23330 @item -mcompat-align-parm
23331 @itemx -mno-compat-align-parm
23332 @opindex mcompat-align-parm
23333 Generate (do not generate) code to pass structure parameters with a
23334 maximum alignment of 64 bits, for compatibility with older versions
23335 of GCC.
23337 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23338 structure parameter on a 128-bit boundary when that structure contained
23339 a member requiring 128-bit alignment.  This is corrected in more
23340 recent versions of GCC.  This option may be used to generate code
23341 that is compatible with functions compiled with older versions of
23342 GCC.
23344 The @option{-mno-compat-align-parm} option is the default.
23346 @item -mstack-protector-guard=@var{guard}
23347 @itemx -mstack-protector-guard-reg=@var{reg}
23348 @itemx -mstack-protector-guard-offset=@var{offset}
23349 @itemx -mstack-protector-guard-symbol=@var{symbol}
23350 @opindex mstack-protector-guard
23351 @opindex mstack-protector-guard-reg
23352 @opindex mstack-protector-guard-offset
23353 @opindex mstack-protector-guard-symbol
23354 Generate stack protection code using canary at @var{guard}.  Supported
23355 locations are @samp{global} for global canary or @samp{tls} for per-thread
23356 canary in the TLS block (the default with GNU libc version 2.4 or later).
23358 With the latter choice the options
23359 @option{-mstack-protector-guard-reg=@var{reg}} and
23360 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23361 which register to use as base register for reading the canary, and from what
23362 offset from that base register. The default for those is as specified in the
23363 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23364 the offset with a symbol reference to a canary in the TLS block.
23365 @end table
23367 @node RX Options
23368 @subsection RX Options
23369 @cindex RX Options
23371 These command-line options are defined for RX targets:
23373 @table @gcctabopt
23374 @item -m64bit-doubles
23375 @itemx -m32bit-doubles
23376 @opindex m64bit-doubles
23377 @opindex m32bit-doubles
23378 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23379 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23380 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23381 works on 32-bit values, which is why the default is
23382 @option{-m32bit-doubles}.
23384 @item -fpu
23385 @itemx -nofpu
23386 @opindex fpu
23387 @opindex nofpu
23388 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23389 floating-point hardware.  The default is enabled for the RX600
23390 series and disabled for the RX200 series.
23392 Floating-point instructions are only generated for 32-bit floating-point 
23393 values, however, so the FPU hardware is not used for doubles if the
23394 @option{-m64bit-doubles} option is used.
23396 @emph{Note} If the @option{-fpu} option is enabled then
23397 @option{-funsafe-math-optimizations} is also enabled automatically.
23398 This is because the RX FPU instructions are themselves unsafe.
23400 @item -mcpu=@var{name}
23401 @opindex mcpu
23402 Selects the type of RX CPU to be targeted.  Currently three types are
23403 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23404 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23406 The only difference between @samp{RX600} and @samp{RX610} is that the
23407 @samp{RX610} does not support the @code{MVTIPL} instruction.
23409 The @samp{RX200} series does not have a hardware floating-point unit
23410 and so @option{-nofpu} is enabled by default when this type is
23411 selected.
23413 @item -mbig-endian-data
23414 @itemx -mlittle-endian-data
23415 @opindex mbig-endian-data
23416 @opindex mlittle-endian-data
23417 Store data (but not code) in the big-endian format.  The default is
23418 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23419 format.
23421 @item -msmall-data-limit=@var{N}
23422 @opindex msmall-data-limit
23423 Specifies the maximum size in bytes of global and static variables
23424 which can be placed into the small data area.  Using the small data
23425 area can lead to smaller and faster code, but the size of area is
23426 limited and it is up to the programmer to ensure that the area does
23427 not overflow.  Also when the small data area is used one of the RX's
23428 registers (usually @code{r13}) is reserved for use pointing to this
23429 area, so it is no longer available for use by the compiler.  This
23430 could result in slower and/or larger code if variables are pushed onto
23431 the stack instead of being held in this register.
23433 Note, common variables (variables that have not been initialized) and
23434 constants are not placed into the small data area as they are assigned
23435 to other sections in the output executable.
23437 The default value is zero, which disables this feature.  Note, this
23438 feature is not enabled by default with higher optimization levels
23439 (@option{-O2} etc) because of the potentially detrimental effects of
23440 reserving a register.  It is up to the programmer to experiment and
23441 discover whether this feature is of benefit to their program.  See the
23442 description of the @option{-mpid} option for a description of how the
23443 actual register to hold the small data area pointer is chosen.
23445 @item -msim
23446 @itemx -mno-sim
23447 @opindex msim
23448 @opindex mno-sim
23449 Use the simulator runtime.  The default is to use the libgloss
23450 board-specific runtime.
23452 @item -mas100-syntax
23453 @itemx -mno-as100-syntax
23454 @opindex mas100-syntax
23455 @opindex mno-as100-syntax
23456 When generating assembler output use a syntax that is compatible with
23457 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23458 assembler, but it has some restrictions so it is not generated by default.
23460 @item -mmax-constant-size=@var{N}
23461 @opindex mmax-constant-size
23462 Specifies the maximum size, in bytes, of a constant that can be used as
23463 an operand in a RX instruction.  Although the RX instruction set does
23464 allow constants of up to 4 bytes in length to be used in instructions,
23465 a longer value equates to a longer instruction.  Thus in some
23466 circumstances it can be beneficial to restrict the size of constants
23467 that are used in instructions.  Constants that are too big are instead
23468 placed into a constant pool and referenced via register indirection.
23470 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23471 or 4 means that constants of any size are allowed.
23473 @item -mrelax
23474 @opindex mrelax
23475 Enable linker relaxation.  Linker relaxation is a process whereby the
23476 linker attempts to reduce the size of a program by finding shorter
23477 versions of various instructions.  Disabled by default.
23479 @item -mint-register=@var{N}
23480 @opindex mint-register
23481 Specify the number of registers to reserve for fast interrupt handler
23482 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23483 means that register @code{r13} is reserved for the exclusive use
23484 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23485 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23486 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23487 A value of 0, the default, does not reserve any registers.
23489 @item -msave-acc-in-interrupts
23490 @opindex msave-acc-in-interrupts
23491 Specifies that interrupt handler functions should preserve the
23492 accumulator register.  This is only necessary if normal code might use
23493 the accumulator register, for example because it performs 64-bit
23494 multiplications.  The default is to ignore the accumulator as this
23495 makes the interrupt handlers faster.
23497 @item -mpid
23498 @itemx -mno-pid
23499 @opindex mpid
23500 @opindex mno-pid
23501 Enables the generation of position independent data.  When enabled any
23502 access to constant data is done via an offset from a base address
23503 held in a register.  This allows the location of constant data to be
23504 determined at run time without requiring the executable to be
23505 relocated, which is a benefit to embedded applications with tight
23506 memory constraints.  Data that can be modified is not affected by this
23507 option.
23509 Note, using this feature reserves a register, usually @code{r13}, for
23510 the constant data base address.  This can result in slower and/or
23511 larger code, especially in complicated functions.
23513 The actual register chosen to hold the constant data base address
23514 depends upon whether the @option{-msmall-data-limit} and/or the
23515 @option{-mint-register} command-line options are enabled.  Starting
23516 with register @code{r13} and proceeding downwards, registers are
23517 allocated first to satisfy the requirements of @option{-mint-register},
23518 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23519 is possible for the small data area register to be @code{r8} if both
23520 @option{-mint-register=4} and @option{-mpid} are specified on the
23521 command line.
23523 By default this feature is not enabled.  The default can be restored
23524 via the @option{-mno-pid} command-line option.
23526 @item -mno-warn-multiple-fast-interrupts
23527 @itemx -mwarn-multiple-fast-interrupts
23528 @opindex mno-warn-multiple-fast-interrupts
23529 @opindex mwarn-multiple-fast-interrupts
23530 Prevents GCC from issuing a warning message if it finds more than one
23531 fast interrupt handler when it is compiling a file.  The default is to
23532 issue a warning for each extra fast interrupt handler found, as the RX
23533 only supports one such interrupt.
23535 @item -mallow-string-insns
23536 @itemx -mno-allow-string-insns
23537 @opindex mallow-string-insns
23538 @opindex mno-allow-string-insns
23539 Enables or disables the use of the string manipulation instructions
23540 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23541 @code{SWHILE} and also the @code{RMPA} instruction.  These
23542 instructions may prefetch data, which is not safe to do if accessing
23543 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23544 for more information).
23546 The default is to allow these instructions, but it is not possible for
23547 GCC to reliably detect all circumstances where a string instruction
23548 might be used to access an I/O register, so their use cannot be
23549 disabled automatically.  Instead it is reliant upon the programmer to
23550 use the @option{-mno-allow-string-insns} option if their program
23551 accesses I/O space.
23553 When the instructions are enabled GCC defines the C preprocessor
23554 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23555 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23557 @item -mjsr
23558 @itemx -mno-jsr
23559 @opindex mjsr
23560 @opindex mno-jsr
23561 Use only (or not only) @code{JSR} instructions to access functions.
23562 This option can be used when code size exceeds the range of @code{BSR}
23563 instructions.  Note that @option{-mno-jsr} does not mean to not use
23564 @code{JSR} but instead means that any type of branch may be used.
23565 @end table
23567 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23568 has special significance to the RX port when used with the
23569 @code{interrupt} function attribute.  This attribute indicates a
23570 function intended to process fast interrupts.  GCC ensures
23571 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23572 and/or @code{r13} and only provided that the normal use of the
23573 corresponding registers have been restricted via the
23574 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23575 options.
23577 @node S/390 and zSeries Options
23578 @subsection S/390 and zSeries Options
23579 @cindex S/390 and zSeries Options
23581 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23583 @table @gcctabopt
23584 @item -mhard-float
23585 @itemx -msoft-float
23586 @opindex mhard-float
23587 @opindex msoft-float
23588 Use (do not use) the hardware floating-point instructions and registers
23589 for floating-point operations.  When @option{-msoft-float} is specified,
23590 functions in @file{libgcc.a} are used to perform floating-point
23591 operations.  When @option{-mhard-float} is specified, the compiler
23592 generates IEEE floating-point instructions.  This is the default.
23594 @item -mhard-dfp
23595 @itemx -mno-hard-dfp
23596 @opindex mhard-dfp
23597 @opindex mno-hard-dfp
23598 Use (do not use) the hardware decimal-floating-point instructions for
23599 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23600 specified, functions in @file{libgcc.a} are used to perform
23601 decimal-floating-point operations.  When @option{-mhard-dfp} is
23602 specified, the compiler generates decimal-floating-point hardware
23603 instructions.  This is the default for @option{-march=z9-ec} or higher.
23605 @item -mlong-double-64
23606 @itemx -mlong-double-128
23607 @opindex mlong-double-64
23608 @opindex mlong-double-128
23609 These switches control the size of @code{long double} type. A size
23610 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23611 type. This is the default.
23613 @item -mbackchain
23614 @itemx -mno-backchain
23615 @opindex mbackchain
23616 @opindex mno-backchain
23617 Store (do not store) the address of the caller's frame as backchain pointer
23618 into the callee's stack frame.
23619 A backchain may be needed to allow debugging using tools that do not understand
23620 DWARF call frame information.
23621 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23622 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23623 the backchain is placed into the topmost word of the 96/160 byte register
23624 save area.
23626 In general, code compiled with @option{-mbackchain} is call-compatible with
23627 code compiled with @option{-mmo-backchain}; however, use of the backchain
23628 for debugging purposes usually requires that the whole binary is built with
23629 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23630 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23631 to build a linux kernel use @option{-msoft-float}.
23633 The default is to not maintain the backchain.
23635 @item -mpacked-stack
23636 @itemx -mno-packed-stack
23637 @opindex mpacked-stack
23638 @opindex mno-packed-stack
23639 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23640 specified, the compiler uses the all fields of the 96/160 byte register save
23641 area only for their default purpose; unused fields still take up stack space.
23642 When @option{-mpacked-stack} is specified, register save slots are densely
23643 packed at the top of the register save area; unused space is reused for other
23644 purposes, allowing for more efficient use of the available stack space.
23645 However, when @option{-mbackchain} is also in effect, the topmost word of
23646 the save area is always used to store the backchain, and the return address
23647 register is always saved two words below the backchain.
23649 As long as the stack frame backchain is not used, code generated with
23650 @option{-mpacked-stack} is call-compatible with code generated with
23651 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23652 S/390 or zSeries generated code that uses the stack frame backchain at run
23653 time, not just for debugging purposes.  Such code is not call-compatible
23654 with code compiled with @option{-mpacked-stack}.  Also, note that the
23655 combination of @option{-mbackchain},
23656 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23657 to build a linux kernel use @option{-msoft-float}.
23659 The default is to not use the packed stack layout.
23661 @item -msmall-exec
23662 @itemx -mno-small-exec
23663 @opindex msmall-exec
23664 @opindex mno-small-exec
23665 Generate (or do not generate) code using the @code{bras} instruction
23666 to do subroutine calls.
23667 This only works reliably if the total executable size does not
23668 exceed 64k.  The default is to use the @code{basr} instruction instead,
23669 which does not have this limitation.
23671 @item -m64
23672 @itemx -m31
23673 @opindex m64
23674 @opindex m31
23675 When @option{-m31} is specified, generate code compliant to the
23676 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23677 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23678 particular to generate 64-bit instructions.  For the @samp{s390}
23679 targets, the default is @option{-m31}, while the @samp{s390x}
23680 targets default to @option{-m64}.
23682 @item -mzarch
23683 @itemx -mesa
23684 @opindex mzarch
23685 @opindex mesa
23686 When @option{-mzarch} is specified, generate code using the
23687 instructions available on z/Architecture.
23688 When @option{-mesa} is specified, generate code using the
23689 instructions available on ESA/390.  Note that @option{-mesa} is
23690 not possible with @option{-m64}.
23691 When generating code compliant to the GNU/Linux for S/390 ABI,
23692 the default is @option{-mesa}.  When generating code compliant
23693 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23695 @item -mhtm
23696 @itemx -mno-htm
23697 @opindex mhtm
23698 @opindex mno-htm
23699 The @option{-mhtm} option enables a set of builtins making use of
23700 instructions available with the transactional execution facility
23701 introduced with the IBM zEnterprise EC12 machine generation
23702 @ref{S/390 System z Built-in Functions}.
23703 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23705 @item -mvx
23706 @itemx -mno-vx
23707 @opindex mvx
23708 @opindex mno-vx
23709 When @option{-mvx} is specified, generate code using the instructions
23710 available with the vector extension facility introduced with the IBM
23711 z13 machine generation.
23712 This option changes the ABI for some vector type values with regard to
23713 alignment and calling conventions.  In case vector type values are
23714 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23715 command will be added to mark the resulting binary with the ABI used.
23716 @option{-mvx} is enabled by default when using @option{-march=z13}.
23718 @item -mzvector
23719 @itemx -mno-zvector
23720 @opindex mzvector
23721 @opindex mno-zvector
23722 The @option{-mzvector} option enables vector language extensions and
23723 builtins using instructions available with the vector extension
23724 facility introduced with the IBM z13 machine generation.
23725 This option adds support for @samp{vector} to be used as a keyword to
23726 define vector type variables and arguments.  @samp{vector} is only
23727 available when GNU extensions are enabled.  It will not be expanded
23728 when requesting strict standard compliance e.g. with @option{-std=c99}.
23729 In addition to the GCC low-level builtins @option{-mzvector} enables
23730 a set of builtins added for compatibility with AltiVec-style
23731 implementations like Power and Cell.  In order to make use of these
23732 builtins the header file @file{vecintrin.h} needs to be included.
23733 @option{-mzvector} is disabled by default.
23735 @item -mmvcle
23736 @itemx -mno-mvcle
23737 @opindex mmvcle
23738 @opindex mno-mvcle
23739 Generate (or do not generate) code using the @code{mvcle} instruction
23740 to perform block moves.  When @option{-mno-mvcle} is specified,
23741 use a @code{mvc} loop instead.  This is the default unless optimizing for
23742 size.
23744 @item -mdebug
23745 @itemx -mno-debug
23746 @opindex mdebug
23747 @opindex mno-debug
23748 Print (or do not print) additional debug information when compiling.
23749 The default is to not print debug information.
23751 @item -march=@var{cpu-type}
23752 @opindex march
23753 Generate code that runs on @var{cpu-type}, which is the name of a
23754 system representing a certain processor type.  Possible values for
23755 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23756 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23757 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23758 @samp{native}.
23760 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23761 @samp{g6} are deprecated and will be removed with future releases.
23763 Specifying @samp{native} as cpu type can be used to select the best
23764 architecture option for the host processor.
23765 @option{-march=native} has no effect if GCC does not recognize the
23766 processor.
23768 @item -mtune=@var{cpu-type}
23769 @opindex mtune
23770 Tune to @var{cpu-type} everything applicable about the generated code,
23771 except for the ABI and the set of available instructions.
23772 The list of @var{cpu-type} values is the same as for @option{-march}.
23773 The default is the value used for @option{-march}.
23775 @item -mtpf-trace
23776 @itemx -mno-tpf-trace
23777 @opindex mtpf-trace
23778 @opindex mno-tpf-trace
23779 Generate code that adds (does not add) in TPF OS specific branches to trace
23780 routines in the operating system.  This option is off by default, even
23781 when compiling for the TPF OS@.
23783 @item -mfused-madd
23784 @itemx -mno-fused-madd
23785 @opindex mfused-madd
23786 @opindex mno-fused-madd
23787 Generate code that uses (does not use) the floating-point multiply and
23788 accumulate instructions.  These instructions are generated by default if
23789 hardware floating point is used.
23791 @item -mwarn-framesize=@var{framesize}
23792 @opindex mwarn-framesize
23793 Emit a warning if the current function exceeds the given frame size.  Because
23794 this is a compile-time check it doesn't need to be a real problem when the program
23795 runs.  It is intended to identify functions that most probably cause
23796 a stack overflow.  It is useful to be used in an environment with limited stack
23797 size e.g.@: the linux kernel.
23799 @item -mwarn-dynamicstack
23800 @opindex mwarn-dynamicstack
23801 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23802 arrays.  This is generally a bad idea with a limited stack size.
23804 @item -mstack-guard=@var{stack-guard}
23805 @itemx -mstack-size=@var{stack-size}
23806 @opindex mstack-guard
23807 @opindex mstack-size
23808 If these options are provided the S/390 back end emits additional instructions in
23809 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23810 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23811 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23812 the frame size of the compiled function is chosen.
23813 These options are intended to be used to help debugging stack overflow problems.
23814 The additionally emitted code causes only little overhead and hence can also be
23815 used in production-like systems without greater performance degradation.  The given
23816 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23817 @var{stack-guard} without exceeding 64k.
23818 In order to be efficient the extra code makes the assumption that the stack starts
23819 at an address aligned to the value given by @var{stack-size}.
23820 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23822 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23823 @opindex mhotpatch
23824 If the hotpatch option is enabled, a ``hot-patching'' function
23825 prologue is generated for all functions in the compilation unit.
23826 The funtion label is prepended with the given number of two-byte
23827 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23828 the label, 2 * @var{post-halfwords} bytes are appended, using the
23829 largest NOP like instructions the architecture allows (maximum
23830 1000000).
23832 If both arguments are zero, hotpatching is disabled.
23834 This option can be overridden for individual functions with the
23835 @code{hotpatch} attribute.
23836 @end table
23838 @node Score Options
23839 @subsection Score Options
23840 @cindex Score Options
23842 These options are defined for Score implementations:
23844 @table @gcctabopt
23845 @item -meb
23846 @opindex meb
23847 Compile code for big-endian mode.  This is the default.
23849 @item -mel
23850 @opindex mel
23851 Compile code for little-endian mode.
23853 @item -mnhwloop
23854 @opindex mnhwloop
23855 Disable generation of @code{bcnz} instructions.
23857 @item -muls
23858 @opindex muls
23859 Enable generation of unaligned load and store instructions.
23861 @item -mmac
23862 @opindex mmac
23863 Enable the use of multiply-accumulate instructions. Disabled by default.
23865 @item -mscore5
23866 @opindex mscore5
23867 Specify the SCORE5 as the target architecture.
23869 @item -mscore5u
23870 @opindex mscore5u
23871 Specify the SCORE5U of the target architecture.
23873 @item -mscore7
23874 @opindex mscore7
23875 Specify the SCORE7 as the target architecture. This is the default.
23877 @item -mscore7d
23878 @opindex mscore7d
23879 Specify the SCORE7D as the target architecture.
23880 @end table
23882 @node SH Options
23883 @subsection SH Options
23885 These @samp{-m} options are defined for the SH implementations:
23887 @table @gcctabopt
23888 @item -m1
23889 @opindex m1
23890 Generate code for the SH1.
23892 @item -m2
23893 @opindex m2
23894 Generate code for the SH2.
23896 @item -m2e
23897 Generate code for the SH2e.
23899 @item -m2a-nofpu
23900 @opindex m2a-nofpu
23901 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23902 that the floating-point unit is not used.
23904 @item -m2a-single-only
23905 @opindex m2a-single-only
23906 Generate code for the SH2a-FPU, in such a way that no double-precision
23907 floating-point operations are used.
23909 @item -m2a-single
23910 @opindex m2a-single
23911 Generate code for the SH2a-FPU assuming the floating-point unit is in
23912 single-precision mode by default.
23914 @item -m2a
23915 @opindex m2a
23916 Generate code for the SH2a-FPU assuming the floating-point unit is in
23917 double-precision mode by default.
23919 @item -m3
23920 @opindex m3
23921 Generate code for the SH3.
23923 @item -m3e
23924 @opindex m3e
23925 Generate code for the SH3e.
23927 @item -m4-nofpu
23928 @opindex m4-nofpu
23929 Generate code for the SH4 without a floating-point unit.
23931 @item -m4-single-only
23932 @opindex m4-single-only
23933 Generate code for the SH4 with a floating-point unit that only
23934 supports single-precision arithmetic.
23936 @item -m4-single
23937 @opindex m4-single
23938 Generate code for the SH4 assuming the floating-point unit is in
23939 single-precision mode by default.
23941 @item -m4
23942 @opindex m4
23943 Generate code for the SH4.
23945 @item -m4-100
23946 @opindex m4-100
23947 Generate code for SH4-100.
23949 @item -m4-100-nofpu
23950 @opindex m4-100-nofpu
23951 Generate code for SH4-100 in such a way that the
23952 floating-point unit is not used.
23954 @item -m4-100-single
23955 @opindex m4-100-single
23956 Generate code for SH4-100 assuming the floating-point unit is in
23957 single-precision mode by default.
23959 @item -m4-100-single-only
23960 @opindex m4-100-single-only
23961 Generate code for SH4-100 in such a way that no double-precision
23962 floating-point operations are used.
23964 @item -m4-200
23965 @opindex m4-200
23966 Generate code for SH4-200.
23968 @item -m4-200-nofpu
23969 @opindex m4-200-nofpu
23970 Generate code for SH4-200 without in such a way that the
23971 floating-point unit is not used.
23973 @item -m4-200-single
23974 @opindex m4-200-single
23975 Generate code for SH4-200 assuming the floating-point unit is in
23976 single-precision mode by default.
23978 @item -m4-200-single-only
23979 @opindex m4-200-single-only
23980 Generate code for SH4-200 in such a way that no double-precision
23981 floating-point operations are used.
23983 @item -m4-300
23984 @opindex m4-300
23985 Generate code for SH4-300.
23987 @item -m4-300-nofpu
23988 @opindex m4-300-nofpu
23989 Generate code for SH4-300 without in such a way that the
23990 floating-point unit is not used.
23992 @item -m4-300-single
23993 @opindex m4-300-single
23994 Generate code for SH4-300 in such a way that no double-precision
23995 floating-point operations are used.
23997 @item -m4-300-single-only
23998 @opindex m4-300-single-only
23999 Generate code for SH4-300 in such a way that no double-precision
24000 floating-point operations are used.
24002 @item -m4-340
24003 @opindex m4-340
24004 Generate code for SH4-340 (no MMU, no FPU).
24006 @item -m4-500
24007 @opindex m4-500
24008 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24009 assembler.
24011 @item -m4a-nofpu
24012 @opindex m4a-nofpu
24013 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
24014 floating-point unit is not used.
24016 @item -m4a-single-only
24017 @opindex m4a-single-only
24018 Generate code for the SH4a, in such a way that no double-precision
24019 floating-point operations are used.
24021 @item -m4a-single
24022 @opindex m4a-single
24023 Generate code for the SH4a assuming the floating-point unit is in
24024 single-precision mode by default.
24026 @item -m4a
24027 @opindex m4a
24028 Generate code for the SH4a.
24030 @item -m4al
24031 @opindex m4al
24032 Same as @option{-m4a-nofpu}, except that it implicitly passes
24033 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
24034 instructions at the moment.
24036 @item -mb
24037 @opindex mb
24038 Compile code for the processor in big-endian mode.
24040 @item -ml
24041 @opindex ml
24042 Compile code for the processor in little-endian mode.
24044 @item -mdalign
24045 @opindex mdalign
24046 Align doubles at 64-bit boundaries.  Note that this changes the calling
24047 conventions, and thus some functions from the standard C library do
24048 not work unless you recompile it first with @option{-mdalign}.
24050 @item -mrelax
24051 @opindex mrelax
24052 Shorten some address references at link time, when possible; uses the
24053 linker option @option{-relax}.
24055 @item -mbigtable
24056 @opindex mbigtable
24057 Use 32-bit offsets in @code{switch} tables.  The default is to use
24058 16-bit offsets.
24060 @item -mbitops
24061 @opindex mbitops
24062 Enable the use of bit manipulation instructions on SH2A.
24064 @item -mfmovd
24065 @opindex mfmovd
24066 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
24067 alignment constraints.
24069 @item -mrenesas
24070 @opindex mrenesas
24071 Comply with the calling conventions defined by Renesas.
24073 @item -mno-renesas
24074 @opindex mno-renesas
24075 Comply with the calling conventions defined for GCC before the Renesas
24076 conventions were available.  This option is the default for all
24077 targets of the SH toolchain.
24079 @item -mnomacsave
24080 @opindex mnomacsave
24081 Mark the @code{MAC} register as call-clobbered, even if
24082 @option{-mrenesas} is given.
24084 @item -mieee
24085 @itemx -mno-ieee
24086 @opindex mieee
24087 @opindex mno-ieee
24088 Control the IEEE compliance of floating-point comparisons, which affects the
24089 handling of cases where the result of a comparison is unordered.  By default
24090 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
24091 enabled @option{-mno-ieee} is implicitly set, which results in faster
24092 floating-point greater-equal and less-equal comparisons.  The implicit settings
24093 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
24095 @item -minline-ic_invalidate
24096 @opindex minline-ic_invalidate
24097 Inline code to invalidate instruction cache entries after setting up
24098 nested function trampolines.
24099 This option has no effect if @option{-musermode} is in effect and the selected
24100 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
24101 instruction.
24102 If the selected code generation option does not allow the use of the @code{icbi}
24103 instruction, and @option{-musermode} is not in effect, the inlined code
24104 manipulates the instruction cache address array directly with an associative
24105 write.  This not only requires privileged mode at run time, but it also
24106 fails if the cache line had been mapped via the TLB and has become unmapped.
24108 @item -misize
24109 @opindex misize
24110 Dump instruction size and location in the assembly code.
24112 @item -mpadstruct
24113 @opindex mpadstruct
24114 This option is deprecated.  It pads structures to multiple of 4 bytes,
24115 which is incompatible with the SH ABI@.
24117 @item -matomic-model=@var{model}
24118 @opindex matomic-model=@var{model}
24119 Sets the model of atomic operations and additional parameters as a comma
24120 separated list.  For details on the atomic built-in functions see
24121 @ref{__atomic Builtins}.  The following models and parameters are supported:
24123 @table @samp
24125 @item none
24126 Disable compiler generated atomic sequences and emit library calls for atomic
24127 operations.  This is the default if the target is not @code{sh*-*-linux*}.
24129 @item soft-gusa
24130 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
24131 built-in functions.  The generated atomic sequences require additional support
24132 from the interrupt/exception handling code of the system and are only suitable
24133 for SH3* and SH4* single-core systems.  This option is enabled by default when
24134 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
24135 this option also partially utilizes the hardware atomic instructions
24136 @code{movli.l} and @code{movco.l} to create more efficient code, unless
24137 @samp{strict} is specified.  
24139 @item soft-tcb
24140 Generate software atomic sequences that use a variable in the thread control
24141 block.  This is a variation of the gUSA sequences which can also be used on
24142 SH1* and SH2* targets.  The generated atomic sequences require additional
24143 support from the interrupt/exception handling code of the system and are only
24144 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
24145 parameter has to be specified as well.
24147 @item soft-imask
24148 Generate software atomic sequences that temporarily disable interrupts by
24149 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
24150 in privileged mode and is only suitable for single-core systems.  Additional
24151 support from the interrupt/exception handling code of the system is not
24152 required.  This model is enabled by default when the target is
24153 @code{sh*-*-linux*} and SH1* or SH2*.
24155 @item hard-llcs
24156 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24157 instructions only.  This is only available on SH4A and is suitable for
24158 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24159 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24160 Code compiled with this option is also compatible with other software
24161 atomic model interrupt/exception handling systems if executed on an SH4A
24162 system.  Additional support from the interrupt/exception handling code of the
24163 system is not required for this model.
24165 @item gbr-offset=
24166 This parameter specifies the offset in bytes of the variable in the thread
24167 control block structure that should be used by the generated atomic sequences
24168 when the @samp{soft-tcb} model has been selected.  For other models this
24169 parameter is ignored.  The specified value must be an integer multiple of four
24170 and in the range 0-1020.
24172 @item strict
24173 This parameter prevents mixed usage of multiple atomic models, even if they
24174 are compatible, and makes the compiler generate atomic sequences of the
24175 specified model only.
24177 @end table
24179 @item -mtas
24180 @opindex mtas
24181 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24182 Notice that depending on the particular hardware and software configuration
24183 this can degrade overall performance due to the operand cache line flushes
24184 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24185 processors the @code{tas.b} instruction must be used with caution since it
24186 can result in data corruption for certain cache configurations.
24188 @item -mprefergot
24189 @opindex mprefergot
24190 When generating position-independent code, emit function calls using
24191 the Global Offset Table instead of the Procedure Linkage Table.
24193 @item -musermode
24194 @itemx -mno-usermode
24195 @opindex musermode
24196 @opindex mno-usermode
24197 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24198 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24199 inlined code would not work in user mode.  @option{-musermode} is the default
24200 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24201 @option{-musermode} has no effect, since there is no user mode.
24203 @item -multcost=@var{number}
24204 @opindex multcost=@var{number}
24205 Set the cost to assume for a multiply insn.
24207 @item -mdiv=@var{strategy}
24208 @opindex mdiv=@var{strategy}
24209 Set the division strategy to be used for integer division operations.
24210 @var{strategy} can be one of: 
24212 @table @samp
24214 @item call-div1
24215 Calls a library function that uses the single-step division instruction
24216 @code{div1} to perform the operation.  Division by zero calculates an
24217 unspecified result and does not trap.  This is the default except for SH4,
24218 SH2A and SHcompact.
24220 @item call-fp
24221 Calls a library function that performs the operation in double precision
24222 floating point.  Division by zero causes a floating-point exception.  This is
24223 the default for SHcompact with FPU.  Specifying this for targets that do not
24224 have a double precision FPU defaults to @code{call-div1}.
24226 @item call-table
24227 Calls a library function that uses a lookup table for small divisors and
24228 the @code{div1} instruction with case distinction for larger divisors.  Division
24229 by zero calculates an unspecified result and does not trap.  This is the default
24230 for SH4.  Specifying this for targets that do not have dynamic shift
24231 instructions defaults to @code{call-div1}.
24233 @end table
24235 When a division strategy has not been specified the default strategy is
24236 selected based on the current target.  For SH2A the default strategy is to
24237 use the @code{divs} and @code{divu} instructions instead of library function
24238 calls.
24240 @item -maccumulate-outgoing-args
24241 @opindex maccumulate-outgoing-args
24242 Reserve space once for outgoing arguments in the function prologue rather
24243 than around each call.  Generally beneficial for performance and size.  Also
24244 needed for unwinding to avoid changing the stack frame around conditional code.
24246 @item -mdivsi3_libfunc=@var{name}
24247 @opindex mdivsi3_libfunc=@var{name}
24248 Set the name of the library function used for 32-bit signed division to
24249 @var{name}.
24250 This only affects the name used in the @samp{call} division strategies, and
24251 the compiler still expects the same sets of input/output/clobbered registers as
24252 if this option were not present.
24254 @item -mfixed-range=@var{register-range}
24255 @opindex mfixed-range
24256 Generate code treating the given register range as fixed registers.
24257 A fixed register is one that the register allocator can not use.  This is
24258 useful when compiling kernel code.  A register range is specified as
24259 two registers separated by a dash.  Multiple register ranges can be
24260 specified separated by a comma.
24262 @item -mbranch-cost=@var{num}
24263 @opindex mbranch-cost=@var{num}
24264 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24265 make the compiler try to generate more branch-free code if possible.  
24266 If not specified the value is selected depending on the processor type that
24267 is being compiled for.
24269 @item -mzdcbranch
24270 @itemx -mno-zdcbranch
24271 @opindex mzdcbranch
24272 @opindex mno-zdcbranch
24273 Assume (do not assume) that zero displacement conditional branch instructions
24274 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24275 compiler prefers zero displacement branch code sequences.  This is
24276 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24277 disabled by specifying @option{-mno-zdcbranch}.
24279 @item -mcbranch-force-delay-slot
24280 @opindex mcbranch-force-delay-slot
24281 Force the usage of delay slots for conditional branches, which stuffs the delay
24282 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24283 this option is disabled.  It can be enabled to work around hardware bugs as
24284 found in the original SH7055.
24286 @item -mfused-madd
24287 @itemx -mno-fused-madd
24288 @opindex mfused-madd
24289 @opindex mno-fused-madd
24290 Generate code that uses (does not use) the floating-point multiply and
24291 accumulate instructions.  These instructions are generated by default
24292 if hardware floating point is used.  The machine-dependent
24293 @option{-mfused-madd} option is now mapped to the machine-independent
24294 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24295 mapped to @option{-ffp-contract=off}.
24297 @item -mfsca
24298 @itemx -mno-fsca
24299 @opindex mfsca
24300 @opindex mno-fsca
24301 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24302 and cosine approximations.  The option @option{-mfsca} must be used in
24303 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24304 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24305 approximations even if @option{-funsafe-math-optimizations} is in effect.
24307 @item -mfsrra
24308 @itemx -mno-fsrra
24309 @opindex mfsrra
24310 @opindex mno-fsrra
24311 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24312 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24313 in combination with @option{-funsafe-math-optimizations} and
24314 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24315 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24316 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24317 in effect.
24319 @item -mpretend-cmove
24320 @opindex mpretend-cmove
24321 Prefer zero-displacement conditional branches for conditional move instruction
24322 patterns.  This can result in faster code on the SH4 processor.
24324 @item -mfdpic
24325 @opindex fdpic
24326 Generate code using the FDPIC ABI.
24328 @end table
24330 @node Solaris 2 Options
24331 @subsection Solaris 2 Options
24332 @cindex Solaris 2 options
24334 These @samp{-m} options are supported on Solaris 2:
24336 @table @gcctabopt
24337 @item -mclear-hwcap
24338 @opindex mclear-hwcap
24339 @option{-mclear-hwcap} tells the compiler to remove the hardware
24340 capabilities generated by the Solaris assembler.  This is only necessary
24341 when object files use ISA extensions not supported by the current
24342 machine, but check at runtime whether or not to use them.
24344 @item -mimpure-text
24345 @opindex mimpure-text
24346 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24347 the compiler to not pass @option{-z text} to the linker when linking a
24348 shared object.  Using this option, you can link position-dependent
24349 code into a shared object.
24351 @option{-mimpure-text} suppresses the ``relocations remain against
24352 allocatable but non-writable sections'' linker error message.
24353 However, the necessary relocations trigger copy-on-write, and the
24354 shared object is not actually shared across processes.  Instead of
24355 using @option{-mimpure-text}, you should compile all source code with
24356 @option{-fpic} or @option{-fPIC}.
24358 @end table
24360 These switches are supported in addition to the above on Solaris 2:
24362 @table @gcctabopt
24363 @item -pthreads
24364 @opindex pthreads
24365 This is a synonym for @option{-pthread}.
24366 @end table
24368 @node SPARC Options
24369 @subsection SPARC Options
24370 @cindex SPARC options
24372 These @samp{-m} options are supported on the SPARC:
24374 @table @gcctabopt
24375 @item -mno-app-regs
24376 @itemx -mapp-regs
24377 @opindex mno-app-regs
24378 @opindex mapp-regs
24379 Specify @option{-mapp-regs} to generate output using the global registers
24380 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24381 global register 1, each global register 2 through 4 is then treated as an
24382 allocable register that is clobbered by function calls.  This is the default.
24384 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24385 specify @option{-mno-app-regs}.  You should compile libraries and system
24386 software with this option.
24388 @item -mflat
24389 @itemx -mno-flat
24390 @opindex mflat
24391 @opindex mno-flat
24392 With @option{-mflat}, the compiler does not generate save/restore instructions
24393 and uses a ``flat'' or single register window model.  This model is compatible
24394 with the regular register window model.  The local registers and the input
24395 registers (0--5) are still treated as ``call-saved'' registers and are
24396 saved on the stack as needed.
24398 With @option{-mno-flat} (the default), the compiler generates save/restore
24399 instructions (except for leaf functions).  This is the normal operating mode.
24401 @item -mfpu
24402 @itemx -mhard-float
24403 @opindex mfpu
24404 @opindex mhard-float
24405 Generate output containing floating-point instructions.  This is the
24406 default.
24408 @item -mno-fpu
24409 @itemx -msoft-float
24410 @opindex mno-fpu
24411 @opindex msoft-float
24412 Generate output containing library calls for floating point.
24413 @strong{Warning:} the requisite libraries are not available for all SPARC
24414 targets.  Normally the facilities of the machine's usual C compiler are
24415 used, but this cannot be done directly in cross-compilation.  You must make
24416 your own arrangements to provide suitable library functions for
24417 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24418 @samp{sparclite-*-*} do provide software floating-point support.
24420 @option{-msoft-float} changes the calling convention in the output file;
24421 therefore, it is only useful if you compile @emph{all} of a program with
24422 this option.  In particular, you need to compile @file{libgcc.a}, the
24423 library that comes with GCC, with @option{-msoft-float} in order for
24424 this to work.
24426 @item -mhard-quad-float
24427 @opindex mhard-quad-float
24428 Generate output containing quad-word (long double) floating-point
24429 instructions.
24431 @item -msoft-quad-float
24432 @opindex msoft-quad-float
24433 Generate output containing library calls for quad-word (long double)
24434 floating-point instructions.  The functions called are those specified
24435 in the SPARC ABI@.  This is the default.
24437 As of this writing, there are no SPARC implementations that have hardware
24438 support for the quad-word floating-point instructions.  They all invoke
24439 a trap handler for one of these instructions, and then the trap handler
24440 emulates the effect of the instruction.  Because of the trap handler overhead,
24441 this is much slower than calling the ABI library routines.  Thus the
24442 @option{-msoft-quad-float} option is the default.
24444 @item -mno-unaligned-doubles
24445 @itemx -munaligned-doubles
24446 @opindex mno-unaligned-doubles
24447 @opindex munaligned-doubles
24448 Assume that doubles have 8-byte alignment.  This is the default.
24450 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24451 alignment only if they are contained in another type, or if they have an
24452 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24453 Specifying this option avoids some rare compatibility problems with code
24454 generated by other compilers.  It is not the default because it results
24455 in a performance loss, especially for floating-point code.
24457 @item -muser-mode
24458 @itemx -mno-user-mode
24459 @opindex muser-mode
24460 @opindex mno-user-mode
24461 Do not generate code that can only run in supervisor mode.  This is relevant
24462 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24463 is the default.
24465 @item -mfaster-structs
24466 @itemx -mno-faster-structs
24467 @opindex mfaster-structs
24468 @opindex mno-faster-structs
24469 With @option{-mfaster-structs}, the compiler assumes that structures
24470 should have 8-byte alignment.  This enables the use of pairs of
24471 @code{ldd} and @code{std} instructions for copies in structure
24472 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24473 However, the use of this changed alignment directly violates the SPARC
24474 ABI@.  Thus, it's intended only for use on targets where the developer
24475 acknowledges that their resulting code is not directly in line with
24476 the rules of the ABI@.
24478 @item -mstd-struct-return
24479 @itemx -mno-std-struct-return
24480 @opindex mstd-struct-return
24481 @opindex mno-std-struct-return
24482 With @option{-mstd-struct-return}, the compiler generates checking code
24483 in functions returning structures or unions to detect size mismatches
24484 between the two sides of function calls, as per the 32-bit ABI@.
24486 The default is @option{-mno-std-struct-return}.  This option has no effect
24487 in 64-bit mode.
24489 @item -mlra
24490 @itemx -mno-lra
24491 @opindex mlra
24492 @opindex mno-lra
24493 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24494 so @option{-mno-lra} needs to be passed to get old Reload.
24496 @item -mcpu=@var{cpu_type}
24497 @opindex mcpu
24498 Set the instruction set, register set, and instruction scheduling parameters
24499 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24500 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24501 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24502 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24503 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24504 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24506 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24507 which selects the best architecture option for the host processor.
24508 @option{-mcpu=native} has no effect if GCC does not recognize
24509 the processor.
24511 Default instruction scheduling parameters are used for values that select
24512 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24513 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24515 Here is a list of each supported architecture and their supported
24516 implementations.
24518 @table @asis
24519 @item v7
24520 cypress, leon3v7
24522 @item v8
24523 supersparc, hypersparc, leon, leon3
24525 @item sparclite
24526 f930, f934, sparclite86x
24528 @item sparclet
24529 tsc701
24531 @item v9
24532 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24533 niagara7, m8
24534 @end table
24536 By default (unless configured otherwise), GCC generates code for the V7
24537 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24538 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24539 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24540 SPARCStation 1, 2, IPX etc.
24542 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24543 architecture.  The only difference from V7 code is that the compiler emits
24544 the integer multiply and integer divide instructions which exist in SPARC-V8
24545 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24546 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24547 2000 series.
24549 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24550 the SPARC architecture.  This adds the integer multiply, integer divide step
24551 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24552 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24553 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24554 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24555 MB86934 chip, which is the more recent SPARClite with FPU@.
24557 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24558 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24559 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24560 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24561 optimizes it for the TEMIC SPARClet chip.
24563 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24564 architecture.  This adds 64-bit integer and floating-point move instructions,
24565 3 additional floating-point condition code registers and conditional move
24566 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24567 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24568 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24569 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24570 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24571 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24572 additionally optimizes it for Sun UltraSPARC T2 chips. With
24573 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24574 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24575 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24576 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24577 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24578 additionally optimizes it for Oracle M8 chips.
24580 @item -mtune=@var{cpu_type}
24581 @opindex mtune
24582 Set the instruction scheduling parameters for machine type
24583 @var{cpu_type}, but do not set the instruction set or register set that the
24584 option @option{-mcpu=@var{cpu_type}} does.
24586 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24587 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24588 that select a particular CPU implementation.  Those are
24589 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24590 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24591 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24592 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24593 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24594 and GNU/Linux toolchains, @samp{native} can also be used.
24596 @item -mv8plus
24597 @itemx -mno-v8plus
24598 @opindex mv8plus
24599 @opindex mno-v8plus
24600 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24601 difference from the V8 ABI is that the global and out registers are
24602 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24603 mode for all SPARC-V9 processors.
24605 @item -mvis
24606 @itemx -mno-vis
24607 @opindex mvis
24608 @opindex mno-vis
24609 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24610 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24612 @item -mvis2
24613 @itemx -mno-vis2
24614 @opindex mvis2
24615 @opindex mno-vis2
24616 With @option{-mvis2}, GCC generates code that takes advantage of
24617 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24618 default is @option{-mvis2} when targeting a cpu that supports such
24619 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24620 also sets @option{-mvis}.
24622 @item -mvis3
24623 @itemx -mno-vis3
24624 @opindex mvis3
24625 @opindex mno-vis3
24626 With @option{-mvis3}, GCC generates code that takes advantage of
24627 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24628 default is @option{-mvis3} when targeting a cpu that supports such
24629 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24630 also sets @option{-mvis2} and @option{-mvis}.
24632 @item -mvis4
24633 @itemx -mno-vis4
24634 @opindex mvis4
24635 @opindex mno-vis4
24636 With @option{-mvis4}, GCC generates code that takes advantage of
24637 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24638 default is @option{-mvis4} when targeting a cpu that supports such
24639 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24640 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24642 @item -mvis4b
24643 @itemx -mno-vis4b
24644 @opindex mvis4b
24645 @opindex mno-vis4b
24646 With @option{-mvis4b}, GCC generates code that takes advantage of
24647 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24648 the additional VIS instructions introduced in the Oracle SPARC
24649 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24650 cpu that supports such instructions, such as m8 and later.  Setting
24651 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24652 @option{-mvis2} and @option{-mvis}.
24654 @item -mcbcond
24655 @itemx -mno-cbcond
24656 @opindex mcbcond
24657 @opindex mno-cbcond
24658 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24659 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24660 when targeting a CPU that supports such instructions, such as Niagara-4 and
24661 later.
24663 @item -mfmaf
24664 @itemx -mno-fmaf
24665 @opindex mfmaf
24666 @opindex mno-fmaf
24667 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24668 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24669 when targeting a CPU that supports such instructions, such as Niagara-3 and
24670 later.
24672 @item -mfsmuld
24673 @itemx -mno-fsmuld
24674 @opindex mfsmuld
24675 @opindex mno-fsmuld
24676 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24677 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24678 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24679 or V9 with FPU except @option{-mcpu=leon}.
24681 @item -mpopc
24682 @itemx -mno-popc
24683 @opindex mpopc
24684 @opindex mno-popc
24685 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24686 Population Count instruction.  The default is @option{-mpopc}
24687 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24688 later.
24690 @item -msubxc
24691 @itemx -mno-subxc
24692 @opindex msubxc
24693 @opindex mno-subxc
24694 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24695 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24696 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24697 later.
24699 @item -mfix-at697f
24700 @opindex mfix-at697f
24701 Enable the documented workaround for the single erratum of the Atmel AT697F
24702 processor (which corresponds to erratum #13 of the AT697E processor).
24704 @item -mfix-ut699
24705 @opindex mfix-ut699
24706 Enable the documented workarounds for the floating-point errata and the data
24707 cache nullify errata of the UT699 processor.
24709 @item -mfix-ut700
24710 @opindex mfix-ut700
24711 Enable the documented workaround for the back-to-back store errata of
24712 the UT699E/UT700 processor.
24714 @item -mfix-gr712rc
24715 @opindex mfix-gr712rc
24716 Enable the documented workaround for the back-to-back store errata of
24717 the GR712RC processor.
24718 @end table
24720 These @samp{-m} options are supported in addition to the above
24721 on SPARC-V9 processors in 64-bit environments:
24723 @table @gcctabopt
24724 @item -m32
24725 @itemx -m64
24726 @opindex m32
24727 @opindex m64
24728 Generate code for a 32-bit or 64-bit environment.
24729 The 32-bit environment sets int, long and pointer to 32 bits.
24730 The 64-bit environment sets int to 32 bits and long and pointer
24731 to 64 bits.
24733 @item -mcmodel=@var{which}
24734 @opindex mcmodel
24735 Set the code model to one of
24737 @table @samp
24738 @item medlow
24739 The Medium/Low code model: 64-bit addresses, programs
24740 must be linked in the low 32 bits of memory.  Programs can be statically
24741 or dynamically linked.
24743 @item medmid
24744 The Medium/Middle code model: 64-bit addresses, programs
24745 must be linked in the low 44 bits of memory, the text and data segments must
24746 be less than 2GB in size and the data segment must be located within 2GB of
24747 the text segment.
24749 @item medany
24750 The Medium/Anywhere code model: 64-bit addresses, programs
24751 may be linked anywhere in memory, the text and data segments must be less
24752 than 2GB in size and the data segment must be located within 2GB of the
24753 text segment.
24755 @item embmedany
24756 The Medium/Anywhere code model for embedded systems:
24757 64-bit addresses, the text and data segments must be less than 2GB in
24758 size, both starting anywhere in memory (determined at link time).  The
24759 global register %g4 points to the base of the data segment.  Programs
24760 are statically linked and PIC is not supported.
24761 @end table
24763 @item -mmemory-model=@var{mem-model}
24764 @opindex mmemory-model
24765 Set the memory model in force on the processor to one of
24767 @table @samp
24768 @item default
24769 The default memory model for the processor and operating system.
24771 @item rmo
24772 Relaxed Memory Order
24774 @item pso
24775 Partial Store Order
24777 @item tso
24778 Total Store Order
24780 @item sc
24781 Sequential Consistency
24782 @end table
24784 These memory models are formally defined in Appendix D of the SPARC-V9
24785 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24787 @item -mstack-bias
24788 @itemx -mno-stack-bias
24789 @opindex mstack-bias
24790 @opindex mno-stack-bias
24791 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24792 frame pointer if present, are offset by @minus{}2047 which must be added back
24793 when making stack frame references.  This is the default in 64-bit mode.
24794 Otherwise, assume no such offset is present.
24795 @end table
24797 @node SPU Options
24798 @subsection SPU Options
24799 @cindex SPU options
24801 These @samp{-m} options are supported on the SPU:
24803 @table @gcctabopt
24804 @item -mwarn-reloc
24805 @itemx -merror-reloc
24806 @opindex mwarn-reloc
24807 @opindex merror-reloc
24809 The loader for SPU does not handle dynamic relocations.  By default, GCC
24810 gives an error when it generates code that requires a dynamic
24811 relocation.  @option{-mno-error-reloc} disables the error,
24812 @option{-mwarn-reloc} generates a warning instead.
24814 @item -msafe-dma
24815 @itemx -munsafe-dma
24816 @opindex msafe-dma
24817 @opindex munsafe-dma
24819 Instructions that initiate or test completion of DMA must not be
24820 reordered with respect to loads and stores of the memory that is being
24821 accessed.
24822 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24823 memory accesses, but that can lead to inefficient code in places where the
24824 memory is known to not change.  Rather than mark the memory as volatile,
24825 you can use @option{-msafe-dma} to tell the compiler to treat
24826 the DMA instructions as potentially affecting all memory.  
24828 @item -mbranch-hints
24829 @opindex mbranch-hints
24831 By default, GCC generates a branch hint instruction to avoid
24832 pipeline stalls for always-taken or probably-taken branches.  A hint
24833 is not generated closer than 8 instructions away from its branch.
24834 There is little reason to disable them, except for debugging purposes,
24835 or to make an object a little bit smaller.
24837 @item -msmall-mem
24838 @itemx -mlarge-mem
24839 @opindex msmall-mem
24840 @opindex mlarge-mem
24842 By default, GCC generates code assuming that addresses are never larger
24843 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24844 a full 32-bit address.
24846 @item -mstdmain
24847 @opindex mstdmain
24849 By default, GCC links against startup code that assumes the SPU-style
24850 main function interface (which has an unconventional parameter list).
24851 With @option{-mstdmain}, GCC links your program against startup
24852 code that assumes a C99-style interface to @code{main}, including a
24853 local copy of @code{argv} strings.
24855 @item -mfixed-range=@var{register-range}
24856 @opindex mfixed-range
24857 Generate code treating the given register range as fixed registers.
24858 A fixed register is one that the register allocator cannot use.  This is
24859 useful when compiling kernel code.  A register range is specified as
24860 two registers separated by a dash.  Multiple register ranges can be
24861 specified separated by a comma.
24863 @item -mea32
24864 @itemx -mea64
24865 @opindex mea32
24866 @opindex mea64
24867 Compile code assuming that pointers to the PPU address space accessed
24868 via the @code{__ea} named address space qualifier are either 32 or 64
24869 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24870 all object code in an executable must be compiled with the same setting.
24872 @item -maddress-space-conversion
24873 @itemx -mno-address-space-conversion
24874 @opindex maddress-space-conversion
24875 @opindex mno-address-space-conversion
24876 Allow/disallow treating the @code{__ea} address space as superset
24877 of the generic address space.  This enables explicit type casts
24878 between @code{__ea} and generic pointer as well as implicit
24879 conversions of generic pointers to @code{__ea} pointers.  The
24880 default is to allow address space pointer conversions.
24882 @item -mcache-size=@var{cache-size}
24883 @opindex mcache-size
24884 This option controls the version of libgcc that the compiler links to an
24885 executable and selects a software-managed cache for accessing variables
24886 in the @code{__ea} address space with a particular cache size.  Possible
24887 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24888 and @samp{128}.  The default cache size is 64KB.
24890 @item -matomic-updates
24891 @itemx -mno-atomic-updates
24892 @opindex matomic-updates
24893 @opindex mno-atomic-updates
24894 This option controls the version of libgcc that the compiler links to an
24895 executable and selects whether atomic updates to the software-managed
24896 cache of PPU-side variables are used.  If you use atomic updates, changes
24897 to a PPU variable from SPU code using the @code{__ea} named address space
24898 qualifier do not interfere with changes to other PPU variables residing
24899 in the same cache line from PPU code.  If you do not use atomic updates,
24900 such interference may occur; however, writing back cache lines is
24901 more efficient.  The default behavior is to use atomic updates.
24903 @item -mdual-nops
24904 @itemx -mdual-nops=@var{n}
24905 @opindex mdual-nops
24906 By default, GCC inserts NOPs to increase dual issue when it expects
24907 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24908 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24909 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24911 @item -mhint-max-nops=@var{n}
24912 @opindex mhint-max-nops
24913 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24914 be at least 8 instructions away from the branch it is affecting.  GCC
24915 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24916 generate the branch hint.
24918 @item -mhint-max-distance=@var{n}
24919 @opindex mhint-max-distance
24920 The encoding of the branch hint instruction limits the hint to be within
24921 256 instructions of the branch it is affecting.  By default, GCC makes
24922 sure it is within 125.
24924 @item -msafe-hints
24925 @opindex msafe-hints
24926 Work around a hardware bug that causes the SPU to stall indefinitely.
24927 By default, GCC inserts the @code{hbrp} instruction to make sure
24928 this stall won't happen.
24930 @end table
24932 @node System V Options
24933 @subsection Options for System V
24935 These additional options are available on System V Release 4 for
24936 compatibility with other compilers on those systems:
24938 @table @gcctabopt
24939 @item -G
24940 @opindex G
24941 Create a shared object.
24942 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24944 @item -Qy
24945 @opindex Qy
24946 Identify the versions of each tool used by the compiler, in a
24947 @code{.ident} assembler directive in the output.
24949 @item -Qn
24950 @opindex Qn
24951 Refrain from adding @code{.ident} directives to the output file (this is
24952 the default).
24954 @item -YP,@var{dirs}
24955 @opindex YP
24956 Search the directories @var{dirs}, and no others, for libraries
24957 specified with @option{-l}.
24959 @item -Ym,@var{dir}
24960 @opindex Ym
24961 Look in the directory @var{dir} to find the M4 preprocessor.
24962 The assembler uses this option.
24963 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24964 @c the generic assembler that comes with Solaris takes just -Ym.
24965 @end table
24967 @node TILE-Gx Options
24968 @subsection TILE-Gx Options
24969 @cindex TILE-Gx options
24971 These @samp{-m} options are supported on the TILE-Gx:
24973 @table @gcctabopt
24974 @item -mcmodel=small
24975 @opindex mcmodel=small
24976 Generate code for the small model.  The distance for direct calls is
24977 limited to 500M in either direction.  PC-relative addresses are 32
24978 bits.  Absolute addresses support the full address range.
24980 @item -mcmodel=large
24981 @opindex mcmodel=large
24982 Generate code for the large model.  There is no limitation on call
24983 distance, pc-relative addresses, or absolute addresses.
24985 @item -mcpu=@var{name}
24986 @opindex mcpu
24987 Selects the type of CPU to be targeted.  Currently the only supported
24988 type is @samp{tilegx}.
24990 @item -m32
24991 @itemx -m64
24992 @opindex m32
24993 @opindex m64
24994 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24995 environment sets int, long, and pointer to 32 bits.  The 64-bit
24996 environment sets int to 32 bits and long and pointer to 64 bits.
24998 @item -mbig-endian
24999 @itemx -mlittle-endian
25000 @opindex mbig-endian
25001 @opindex mlittle-endian
25002 Generate code in big/little endian mode, respectively.
25003 @end table
25005 @node TILEPro Options
25006 @subsection TILEPro Options
25007 @cindex TILEPro options
25009 These @samp{-m} options are supported on the TILEPro:
25011 @table @gcctabopt
25012 @item -mcpu=@var{name}
25013 @opindex mcpu
25014 Selects the type of CPU to be targeted.  Currently the only supported
25015 type is @samp{tilepro}.
25017 @item -m32
25018 @opindex m32
25019 Generate code for a 32-bit environment, which sets int, long, and
25020 pointer to 32 bits.  This is the only supported behavior so the flag
25021 is essentially ignored.
25022 @end table
25024 @node V850 Options
25025 @subsection V850 Options
25026 @cindex V850 Options
25028 These @samp{-m} options are defined for V850 implementations:
25030 @table @gcctabopt
25031 @item -mlong-calls
25032 @itemx -mno-long-calls
25033 @opindex mlong-calls
25034 @opindex mno-long-calls
25035 Treat all calls as being far away (near).  If calls are assumed to be
25036 far away, the compiler always loads the function's address into a
25037 register, and calls indirect through the pointer.
25039 @item -mno-ep
25040 @itemx -mep
25041 @opindex mno-ep
25042 @opindex mep
25043 Do not optimize (do optimize) basic blocks that use the same index
25044 pointer 4 or more times to copy pointer into the @code{ep} register, and
25045 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
25046 option is on by default if you optimize.
25048 @item -mno-prolog-function
25049 @itemx -mprolog-function
25050 @opindex mno-prolog-function
25051 @opindex mprolog-function
25052 Do not use (do use) external functions to save and restore registers
25053 at the prologue and epilogue of a function.  The external functions
25054 are slower, but use less code space if more than one function saves
25055 the same number of registers.  The @option{-mprolog-function} option
25056 is on by default if you optimize.
25058 @item -mspace
25059 @opindex mspace
25060 Try to make the code as small as possible.  At present, this just turns
25061 on the @option{-mep} and @option{-mprolog-function} options.
25063 @item -mtda=@var{n}
25064 @opindex mtda
25065 Put static or global variables whose size is @var{n} bytes or less into
25066 the tiny data area that register @code{ep} points to.  The tiny data
25067 area can hold up to 256 bytes in total (128 bytes for byte references).
25069 @item -msda=@var{n}
25070 @opindex msda
25071 Put static or global variables whose size is @var{n} bytes or less into
25072 the small data area that register @code{gp} points to.  The small data
25073 area can hold up to 64 kilobytes.
25075 @item -mzda=@var{n}
25076 @opindex mzda
25077 Put static or global variables whose size is @var{n} bytes or less into
25078 the first 32 kilobytes of memory.
25080 @item -mv850
25081 @opindex mv850
25082 Specify that the target processor is the V850.
25084 @item -mv850e3v5
25085 @opindex mv850e3v5
25086 Specify that the target processor is the V850E3V5.  The preprocessor
25087 constant @code{__v850e3v5__} is defined if this option is used.
25089 @item -mv850e2v4
25090 @opindex mv850e2v4
25091 Specify that the target processor is the V850E3V5.  This is an alias for
25092 the @option{-mv850e3v5} option.
25094 @item -mv850e2v3
25095 @opindex mv850e2v3
25096 Specify that the target processor is the V850E2V3.  The preprocessor
25097 constant @code{__v850e2v3__} is defined if this option is used.
25099 @item -mv850e2
25100 @opindex mv850e2
25101 Specify that the target processor is the V850E2.  The preprocessor
25102 constant @code{__v850e2__} is defined if this option is used.
25104 @item -mv850e1
25105 @opindex mv850e1
25106 Specify that the target processor is the V850E1.  The preprocessor
25107 constants @code{__v850e1__} and @code{__v850e__} are defined if
25108 this option is used.
25110 @item -mv850es
25111 @opindex mv850es
25112 Specify that the target processor is the V850ES.  This is an alias for
25113 the @option{-mv850e1} option.
25115 @item -mv850e
25116 @opindex mv850e
25117 Specify that the target processor is the V850E@.  The preprocessor
25118 constant @code{__v850e__} is defined if this option is used.
25120 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
25121 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
25122 are defined then a default target processor is chosen and the
25123 relevant @samp{__v850*__} preprocessor constant is defined.
25125 The preprocessor constants @code{__v850} and @code{__v851__} are always
25126 defined, regardless of which processor variant is the target.
25128 @item -mdisable-callt
25129 @itemx -mno-disable-callt
25130 @opindex mdisable-callt
25131 @opindex mno-disable-callt
25132 This option suppresses generation of the @code{CALLT} instruction for the
25133 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
25134 architecture.
25136 This option is enabled by default when the RH850 ABI is
25137 in use (see @option{-mrh850-abi}), and disabled by default when the
25138 GCC ABI is in use.  If @code{CALLT} instructions are being generated
25139 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
25141 @item -mrelax
25142 @itemx -mno-relax
25143 @opindex mrelax
25144 @opindex mno-relax
25145 Pass on (or do not pass on) the @option{-mrelax} command-line option
25146 to the assembler.
25148 @item -mlong-jumps
25149 @itemx -mno-long-jumps
25150 @opindex mlong-jumps
25151 @opindex mno-long-jumps
25152 Disable (or re-enable) the generation of PC-relative jump instructions.
25154 @item -msoft-float
25155 @itemx -mhard-float
25156 @opindex msoft-float
25157 @opindex mhard-float
25158 Disable (or re-enable) the generation of hardware floating point
25159 instructions.  This option is only significant when the target
25160 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25161 instructions are being generated then the C preprocessor symbol
25162 @code{__FPU_OK__} is defined, otherwise the symbol
25163 @code{__NO_FPU__} is defined.
25165 @item -mloop
25166 @opindex mloop
25167 Enables the use of the e3v5 LOOP instruction.  The use of this
25168 instruction is not enabled by default when the e3v5 architecture is
25169 selected because its use is still experimental.
25171 @item -mrh850-abi
25172 @itemx -mghs
25173 @opindex mrh850-abi
25174 @opindex mghs
25175 Enables support for the RH850 version of the V850 ABI.  This is the
25176 default.  With this version of the ABI the following rules apply:
25178 @itemize
25179 @item
25180 Integer sized structures and unions are returned via a memory pointer
25181 rather than a register.
25183 @item
25184 Large structures and unions (more than 8 bytes in size) are passed by
25185 value.
25187 @item
25188 Functions are aligned to 16-bit boundaries.
25190 @item
25191 The @option{-m8byte-align} command-line option is supported.
25193 @item
25194 The @option{-mdisable-callt} command-line option is enabled by
25195 default.  The @option{-mno-disable-callt} command-line option is not
25196 supported.
25197 @end itemize
25199 When this version of the ABI is enabled the C preprocessor symbol
25200 @code{__V850_RH850_ABI__} is defined.
25202 @item -mgcc-abi
25203 @opindex mgcc-abi
25204 Enables support for the old GCC version of the V850 ABI.  With this
25205 version of the ABI the following rules apply:
25207 @itemize
25208 @item
25209 Integer sized structures and unions are returned in register @code{r10}.
25211 @item
25212 Large structures and unions (more than 8 bytes in size) are passed by
25213 reference.
25215 @item
25216 Functions are aligned to 32-bit boundaries, unless optimizing for
25217 size.
25219 @item
25220 The @option{-m8byte-align} command-line option is not supported.
25222 @item
25223 The @option{-mdisable-callt} command-line option is supported but not
25224 enabled by default.
25225 @end itemize
25227 When this version of the ABI is enabled the C preprocessor symbol
25228 @code{__V850_GCC_ABI__} is defined.
25230 @item -m8byte-align
25231 @itemx -mno-8byte-align
25232 @opindex m8byte-align
25233 @opindex mno-8byte-align
25234 Enables support for @code{double} and @code{long long} types to be
25235 aligned on 8-byte boundaries.  The default is to restrict the
25236 alignment of all objects to at most 4-bytes.  When
25237 @option{-m8byte-align} is in effect the C preprocessor symbol
25238 @code{__V850_8BYTE_ALIGN__} is defined.
25240 @item -mbig-switch
25241 @opindex mbig-switch
25242 Generate code suitable for big switch tables.  Use this option only if
25243 the assembler/linker complain about out of range branches within a switch
25244 table.
25246 @item -mapp-regs
25247 @opindex mapp-regs
25248 This option causes r2 and r5 to be used in the code generated by
25249 the compiler.  This setting is the default.
25251 @item -mno-app-regs
25252 @opindex mno-app-regs
25253 This option causes r2 and r5 to be treated as fixed registers.
25255 @end table
25257 @node VAX Options
25258 @subsection VAX Options
25259 @cindex VAX options
25261 These @samp{-m} options are defined for the VAX:
25263 @table @gcctabopt
25264 @item -munix
25265 @opindex munix
25266 Do not output certain jump instructions (@code{aobleq} and so on)
25267 that the Unix assembler for the VAX cannot handle across long
25268 ranges.
25270 @item -mgnu
25271 @opindex mgnu
25272 Do output those jump instructions, on the assumption that the
25273 GNU assembler is being used.
25275 @item -mg
25276 @opindex mg
25277 Output code for G-format floating-point numbers instead of D-format.
25278 @end table
25280 @node Visium Options
25281 @subsection Visium Options
25282 @cindex Visium options
25284 @table @gcctabopt
25286 @item -mdebug
25287 @opindex mdebug
25288 A program which performs file I/O and is destined to run on an MCM target
25289 should be linked with this option.  It causes the libraries libc.a and
25290 libdebug.a to be linked.  The program should be run on the target under
25291 the control of the GDB remote debugging stub.
25293 @item -msim
25294 @opindex msim
25295 A program which performs file I/O and is destined to run on the simulator
25296 should be linked with option.  This causes libraries libc.a and libsim.a to
25297 be linked.
25299 @item -mfpu
25300 @itemx -mhard-float
25301 @opindex mfpu
25302 @opindex mhard-float
25303 Generate code containing floating-point instructions.  This is the
25304 default.
25306 @item -mno-fpu
25307 @itemx -msoft-float
25308 @opindex mno-fpu
25309 @opindex msoft-float
25310 Generate code containing library calls for floating-point.
25312 @option{-msoft-float} changes the calling convention in the output file;
25313 therefore, it is only useful if you compile @emph{all} of a program with
25314 this option.  In particular, you need to compile @file{libgcc.a}, the
25315 library that comes with GCC, with @option{-msoft-float} in order for
25316 this to work.
25318 @item -mcpu=@var{cpu_type}
25319 @opindex mcpu
25320 Set the instruction set, register set, and instruction scheduling parameters
25321 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25322 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25324 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25326 By default (unless configured otherwise), GCC generates code for the GR5
25327 variant of the Visium architecture.  
25329 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25330 architecture.  The only difference from GR5 code is that the compiler will
25331 generate block move instructions.
25333 @item -mtune=@var{cpu_type}
25334 @opindex mtune
25335 Set the instruction scheduling parameters for machine type @var{cpu_type},
25336 but do not set the instruction set or register set that the option
25337 @option{-mcpu=@var{cpu_type}} would.
25339 @item -msv-mode
25340 @opindex msv-mode
25341 Generate code for the supervisor mode, where there are no restrictions on
25342 the access to general registers.  This is the default.
25344 @item -muser-mode
25345 @opindex muser-mode
25346 Generate code for the user mode, where the access to some general registers
25347 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25348 mode; on the GR6, only registers r29 to r31 are affected.
25349 @end table
25351 @node VMS Options
25352 @subsection VMS Options
25354 These @samp{-m} options are defined for the VMS implementations:
25356 @table @gcctabopt
25357 @item -mvms-return-codes
25358 @opindex mvms-return-codes
25359 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25360 condition (e.g.@ error) codes.
25362 @item -mdebug-main=@var{prefix}
25363 @opindex mdebug-main=@var{prefix}
25364 Flag the first routine whose name starts with @var{prefix} as the main
25365 routine for the debugger.
25367 @item -mmalloc64
25368 @opindex mmalloc64
25369 Default to 64-bit memory allocation routines.
25371 @item -mpointer-size=@var{size}
25372 @opindex mpointer-size=@var{size}
25373 Set the default size of pointers. Possible options for @var{size} are
25374 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25375 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25376 The later option disables @code{pragma pointer_size}.
25377 @end table
25379 @node VxWorks Options
25380 @subsection VxWorks Options
25381 @cindex VxWorks Options
25383 The options in this section are defined for all VxWorks targets.
25384 Options specific to the target hardware are listed with the other
25385 options for that target.
25387 @table @gcctabopt
25388 @item -mrtp
25389 @opindex mrtp
25390 GCC can generate code for both VxWorks kernels and real time processes
25391 (RTPs).  This option switches from the former to the latter.  It also
25392 defines the preprocessor macro @code{__RTP__}.
25394 @item -non-static
25395 @opindex non-static
25396 Link an RTP executable against shared libraries rather than static
25397 libraries.  The options @option{-static} and @option{-shared} can
25398 also be used for RTPs (@pxref{Link Options}); @option{-static}
25399 is the default.
25401 @item -Bstatic
25402 @itemx -Bdynamic
25403 @opindex Bstatic
25404 @opindex Bdynamic
25405 These options are passed down to the linker.  They are defined for
25406 compatibility with Diab.
25408 @item -Xbind-lazy
25409 @opindex Xbind-lazy
25410 Enable lazy binding of function calls.  This option is equivalent to
25411 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25413 @item -Xbind-now
25414 @opindex Xbind-now
25415 Disable lazy binding of function calls.  This option is the default and
25416 is defined for compatibility with Diab.
25417 @end table
25419 @node x86 Options
25420 @subsection x86 Options
25421 @cindex x86 Options
25423 These @samp{-m} options are defined for the x86 family of computers.
25425 @table @gcctabopt
25427 @item -march=@var{cpu-type}
25428 @opindex march
25429 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25430 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25431 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25432 to generate code that may not run at all on processors other than the one
25433 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25434 @option{-mtune=@var{cpu-type}}.
25436 The choices for @var{cpu-type} are:
25438 @table @samp
25439 @item native
25440 This selects the CPU to generate code for at compilation time by determining
25441 the processor type of the compiling machine.  Using @option{-march=native}
25442 enables all instruction subsets supported by the local machine (hence
25443 the result might not run on different machines).  Using @option{-mtune=native}
25444 produces code optimized for the local machine under the constraints
25445 of the selected instruction set.  
25447 @item i386
25448 Original Intel i386 CPU@.
25450 @item i486
25451 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25453 @item i586
25454 @itemx pentium
25455 Intel Pentium CPU with no MMX support.
25457 @item lakemont
25458 Intel Lakemont MCU, based on Intel Pentium CPU.
25460 @item pentium-mmx
25461 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25463 @item pentiumpro
25464 Intel Pentium Pro CPU@.
25466 @item i686
25467 When used with @option{-march}, the Pentium Pro
25468 instruction set is used, so the code runs on all i686 family chips.
25469 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25471 @item pentium2
25472 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25473 support.
25475 @item pentium3
25476 @itemx pentium3m
25477 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25478 set support.
25480 @item pentium-m
25481 Intel Pentium M; low-power version of Intel Pentium III CPU
25482 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25484 @item pentium4
25485 @itemx pentium4m
25486 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25488 @item prescott
25489 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25490 set support.
25492 @item nocona
25493 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25494 SSE2 and SSE3 instruction set support.
25496 @item core2
25497 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25498 instruction set support.
25500 @item nehalem
25501 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25502 SSE4.1, SSE4.2 and POPCNT instruction set support.
25504 @item westmere
25505 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25506 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25508 @item sandybridge
25509 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25510 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25512 @item ivybridge
25513 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25514 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25515 instruction set support.
25517 @item haswell
25518 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25519 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25520 BMI, BMI2 and F16C instruction set support.
25522 @item broadwell
25523 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25524 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25525 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25527 @item skylake
25528 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25529 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25530 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25531 XSAVES instruction set support.
25533 @item bonnell
25534 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25535 instruction set support.
25537 @item silvermont
25538 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25539 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25541 @item knl
25542 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25543 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25544 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25545 AVX512CD instruction set support.
25547 @item knm
25548 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25549 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25550 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25551 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25553 @item skylake-avx512
25554 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25555 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25556 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25557 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25559 @item cannonlake
25560 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25561 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25562 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25563 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25564 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25566 @item k6
25567 AMD K6 CPU with MMX instruction set support.
25569 @item k6-2
25570 @itemx k6-3
25571 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25573 @item athlon
25574 @itemx athlon-tbird
25575 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25576 support.
25578 @item athlon-4
25579 @itemx athlon-xp
25580 @itemx athlon-mp
25581 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25582 instruction set support.
25584 @item k8
25585 @itemx opteron
25586 @itemx athlon64
25587 @itemx athlon-fx
25588 Processors based on the AMD K8 core with x86-64 instruction set support,
25589 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25590 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25591 instruction set extensions.)
25593 @item k8-sse3
25594 @itemx opteron-sse3
25595 @itemx athlon64-sse3
25596 Improved versions of AMD K8 cores with SSE3 instruction set support.
25598 @item amdfam10
25599 @itemx barcelona
25600 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25601 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25602 instruction set extensions.)
25604 @item bdver1
25605 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25606 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25607 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25608 @item bdver2
25609 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25610 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25611 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25612 extensions.)
25613 @item bdver3
25614 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25615 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25616 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25617 64-bit instruction set extensions.
25618 @item bdver4
25619 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25620 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25621 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25622 SSE4.2, ABM and 64-bit instruction set extensions.
25624 @item znver1
25625 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25626 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25627 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25628 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25629 instruction set extensions.
25631 @item btver1
25632 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25633 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25634 instruction set extensions.)
25636 @item btver2
25637 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25638 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25639 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25641 @item winchip-c6
25642 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25643 set support.
25645 @item winchip2
25646 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25647 instruction set support.
25649 @item c3
25650 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25651 (No scheduling is implemented for this chip.)
25653 @item c3-2
25654 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25655 (No scheduling is implemented for this chip.)
25657 @item c7
25658 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25659 (No scheduling is implemented for this chip.)
25661 @item samuel-2
25662 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25663 (No scheduling is implemented for this chip.)
25665 @item nehemiah
25666 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25667 (No scheduling is implemented for this chip.)
25669 @item esther
25670 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25671 (No scheduling is implemented for this chip.)
25673 @item eden-x2
25674 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25675 (No scheduling is implemented for this chip.)
25677 @item eden-x4
25678 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25679 AVX and AVX2 instruction set support.
25680 (No scheduling is implemented for this chip.)
25682 @item nano
25683 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25684 instruction set support.
25685 (No scheduling is implemented for this chip.)
25687 @item nano-1000
25688 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25689 instruction set support.
25690 (No scheduling is implemented for this chip.)
25692 @item nano-2000
25693 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25694 instruction set support.
25695 (No scheduling is implemented for this chip.)
25697 @item nano-3000
25698 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25699 instruction set support.
25700 (No scheduling is implemented for this chip.)
25702 @item nano-x2
25703 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25704 instruction set support.
25705 (No scheduling is implemented for this chip.)
25707 @item nano-x4
25708 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25709 instruction set support.
25710 (No scheduling is implemented for this chip.)
25712 @item geode
25713 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25714 @end table
25716 @item -mtune=@var{cpu-type}
25717 @opindex mtune
25718 Tune to @var{cpu-type} everything applicable about the generated code, except
25719 for the ABI and the set of available instructions.  
25720 While picking a specific @var{cpu-type} schedules things appropriately
25721 for that particular chip, the compiler does not generate any code that
25722 cannot run on the default machine type unless you use a
25723 @option{-march=@var{cpu-type}} option.
25724 For example, if GCC is configured for i686-pc-linux-gnu
25725 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25726 but still runs on i686 machines.
25728 The choices for @var{cpu-type} are the same as for @option{-march}.
25729 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25731 @table @samp
25732 @item generic
25733 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25734 If you know the CPU on which your code will run, then you should use
25735 the corresponding @option{-mtune} or @option{-march} option instead of
25736 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25737 of your application will have, then you should use this option.
25739 As new processors are deployed in the marketplace, the behavior of this
25740 option will change.  Therefore, if you upgrade to a newer version of
25741 GCC, code generation controlled by this option will change to reflect
25742 the processors
25743 that are most common at the time that version of GCC is released.
25745 There is no @option{-march=generic} option because @option{-march}
25746 indicates the instruction set the compiler can use, and there is no
25747 generic instruction set applicable to all processors.  In contrast,
25748 @option{-mtune} indicates the processor (or, in this case, collection of
25749 processors) for which the code is optimized.
25751 @item intel
25752 Produce code optimized for the most current Intel processors, which are
25753 Haswell and Silvermont for this version of GCC.  If you know the CPU
25754 on which your code will run, then you should use the corresponding
25755 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25756 But, if you want your application performs better on both Haswell and
25757 Silvermont, then you should use this option.
25759 As new Intel processors are deployed in the marketplace, the behavior of
25760 this option will change.  Therefore, if you upgrade to a newer version of
25761 GCC, code generation controlled by this option will change to reflect
25762 the most current Intel processors at the time that version of GCC is
25763 released.
25765 There is no @option{-march=intel} option because @option{-march} indicates
25766 the instruction set the compiler can use, and there is no common
25767 instruction set applicable to all processors.  In contrast,
25768 @option{-mtune} indicates the processor (or, in this case, collection of
25769 processors) for which the code is optimized.
25770 @end table
25772 @item -mcpu=@var{cpu-type}
25773 @opindex mcpu
25774 A deprecated synonym for @option{-mtune}.
25776 @item -mfpmath=@var{unit}
25777 @opindex mfpmath
25778 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25779 for @var{unit} are:
25781 @table @samp
25782 @item 387
25783 Use the standard 387 floating-point coprocessor present on the majority of chips and
25784 emulated otherwise.  Code compiled with this option runs almost everywhere.
25785 The temporary results are computed in 80-bit precision instead of the precision
25786 specified by the type, resulting in slightly different results compared to most
25787 of other chips.  See @option{-ffloat-store} for more detailed description.
25789 This is the default choice for non-Darwin x86-32 targets.
25791 @item sse
25792 Use scalar floating-point instructions present in the SSE instruction set.
25793 This instruction set is supported by Pentium III and newer chips,
25794 and in the AMD line
25795 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25796 instruction set supports only single-precision arithmetic, thus the double and
25797 extended-precision arithmetic are still done using 387.  A later version, present
25798 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25799 arithmetic too.
25801 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25802 or @option{-msse2} switches to enable SSE extensions and make this option
25803 effective.  For the x86-64 compiler, these extensions are enabled by default.
25805 The resulting code should be considerably faster in the majority of cases and avoid
25806 the numerical instability problems of 387 code, but may break some existing
25807 code that expects temporaries to be 80 bits.
25809 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25810 and the default choice for x86-32 targets with the SSE2 instruction set
25811 when @option{-ffast-math} is enabled.
25813 @item sse,387
25814 @itemx sse+387
25815 @itemx both
25816 Attempt to utilize both instruction sets at once.  This effectively doubles the
25817 amount of available registers, and on chips with separate execution units for
25818 387 and SSE the execution resources too.  Use this option with care, as it is
25819 still experimental, because the GCC register allocator does not model separate
25820 functional units well, resulting in unstable performance.
25821 @end table
25823 @item -masm=@var{dialect}
25824 @opindex masm=@var{dialect}
25825 Output assembly instructions using selected @var{dialect}.  Also affects
25826 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25827 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25828 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25829 not support @samp{intel}.
25831 @item -mieee-fp
25832 @itemx -mno-ieee-fp
25833 @opindex mieee-fp
25834 @opindex mno-ieee-fp
25835 Control whether or not the compiler uses IEEE floating-point
25836 comparisons.  These correctly handle the case where the result of a
25837 comparison is unordered.
25839 @item -m80387
25840 @item -mhard-float
25841 @opindex 80387
25842 @opindex mhard-float
25843 Generate output containing 80387 instructions for floating point.
25845 @item -mno-80387
25846 @item -msoft-float
25847 @opindex no-80387
25848 @opindex msoft-float
25849 Generate output containing library calls for floating point.
25851 @strong{Warning:} the requisite libraries are not part of GCC@.
25852 Normally the facilities of the machine's usual C compiler are used, but
25853 this cannot be done directly in cross-compilation.  You must make your
25854 own arrangements to provide suitable library functions for
25855 cross-compilation.
25857 On machines where a function returns floating-point results in the 80387
25858 register stack, some floating-point opcodes may be emitted even if
25859 @option{-msoft-float} is used.
25861 @item -mno-fp-ret-in-387
25862 @opindex mno-fp-ret-in-387
25863 Do not use the FPU registers for return values of functions.
25865 The usual calling convention has functions return values of types
25866 @code{float} and @code{double} in an FPU register, even if there
25867 is no FPU@.  The idea is that the operating system should emulate
25868 an FPU@.
25870 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25871 in ordinary CPU registers instead.
25873 @item -mno-fancy-math-387
25874 @opindex mno-fancy-math-387
25875 Some 387 emulators do not support the @code{sin}, @code{cos} and
25876 @code{sqrt} instructions for the 387.  Specify this option to avoid
25877 generating those instructions.  This option is the default on
25878 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25879 indicates that the target CPU always has an FPU and so the
25880 instruction does not need emulation.  These
25881 instructions are not generated unless you also use the
25882 @option{-funsafe-math-optimizations} switch.
25884 @item -malign-double
25885 @itemx -mno-align-double
25886 @opindex malign-double
25887 @opindex mno-align-double
25888 Control whether GCC aligns @code{double}, @code{long double}, and
25889 @code{long long} variables on a two-word boundary or a one-word
25890 boundary.  Aligning @code{double} variables on a two-word boundary
25891 produces code that runs somewhat faster on a Pentium at the
25892 expense of more memory.
25894 On x86-64, @option{-malign-double} is enabled by default.
25896 @strong{Warning:} if you use the @option{-malign-double} switch,
25897 structures containing the above types are aligned differently than
25898 the published application binary interface specifications for the x86-32
25899 and are not binary compatible with structures in code compiled
25900 without that switch.
25902 @item -m96bit-long-double
25903 @itemx -m128bit-long-double
25904 @opindex m96bit-long-double
25905 @opindex m128bit-long-double
25906 These switches control the size of @code{long double} type.  The x86-32
25907 application binary interface specifies the size to be 96 bits,
25908 so @option{-m96bit-long-double} is the default in 32-bit mode.
25910 Modern architectures (Pentium and newer) prefer @code{long double}
25911 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25912 conforming to the ABI, this is not possible.  So specifying
25913 @option{-m128bit-long-double} aligns @code{long double}
25914 to a 16-byte boundary by padding the @code{long double} with an additional
25915 32-bit zero.
25917 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25918 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25920 Notice that neither of these options enable any extra precision over the x87
25921 standard of 80 bits for a @code{long double}.
25923 @strong{Warning:} if you override the default value for your target ABI, this
25924 changes the size of 
25925 structures and arrays containing @code{long double} variables,
25926 as well as modifying the function calling convention for functions taking
25927 @code{long double}.  Hence they are not binary-compatible
25928 with code compiled without that switch.
25930 @item -mlong-double-64
25931 @itemx -mlong-double-80
25932 @itemx -mlong-double-128
25933 @opindex mlong-double-64
25934 @opindex mlong-double-80
25935 @opindex mlong-double-128
25936 These switches control the size of @code{long double} type. A size
25937 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25938 type. This is the default for 32-bit Bionic C library.  A size
25939 of 128 bits makes the @code{long double} type equivalent to the
25940 @code{__float128} type. This is the default for 64-bit Bionic C library.
25942 @strong{Warning:} if you override the default value for your target ABI, this
25943 changes the size of
25944 structures and arrays containing @code{long double} variables,
25945 as well as modifying the function calling convention for functions taking
25946 @code{long double}.  Hence they are not binary-compatible
25947 with code compiled without that switch.
25949 @item -malign-data=@var{type}
25950 @opindex malign-data
25951 Control how GCC aligns variables.  Supported values for @var{type} are
25952 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25953 and earlier, @samp{abi} uses alignment value as specified by the
25954 psABI, and @samp{cacheline} uses increased alignment value to match
25955 the cache line size.  @samp{compat} is the default.
25957 @item -mlarge-data-threshold=@var{threshold}
25958 @opindex mlarge-data-threshold
25959 When @option{-mcmodel=medium} is specified, data objects larger than
25960 @var{threshold} are placed in the large data section.  This value must be the
25961 same across all objects linked into the binary, and defaults to 65535.
25963 @item -mrtd
25964 @opindex mrtd
25965 Use a different function-calling convention, in which functions that
25966 take a fixed number of arguments return with the @code{ret @var{num}}
25967 instruction, which pops their arguments while returning.  This saves one
25968 instruction in the caller since there is no need to pop the arguments
25969 there.
25971 You can specify that an individual function is called with this calling
25972 sequence with the function attribute @code{stdcall}.  You can also
25973 override the @option{-mrtd} option by using the function attribute
25974 @code{cdecl}.  @xref{Function Attributes}.
25976 @strong{Warning:} this calling convention is incompatible with the one
25977 normally used on Unix, so you cannot use it if you need to call
25978 libraries compiled with the Unix compiler.
25980 Also, you must provide function prototypes for all functions that
25981 take variable numbers of arguments (including @code{printf});
25982 otherwise incorrect code is generated for calls to those
25983 functions.
25985 In addition, seriously incorrect code results if you call a
25986 function with too many arguments.  (Normally, extra arguments are
25987 harmlessly ignored.)
25989 @item -mregparm=@var{num}
25990 @opindex mregparm
25991 Control how many registers are used to pass integer arguments.  By
25992 default, no registers are used to pass arguments, and at most 3
25993 registers can be used.  You can control this behavior for a specific
25994 function by using the function attribute @code{regparm}.
25995 @xref{Function Attributes}.
25997 @strong{Warning:} if you use this switch, and
25998 @var{num} is nonzero, then you must build all modules with the same
25999 value, including any libraries.  This includes the system libraries and
26000 startup modules.
26002 @item -msseregparm
26003 @opindex msseregparm
26004 Use SSE register passing conventions for float and double arguments
26005 and return values.  You can control this behavior for a specific
26006 function by using the function attribute @code{sseregparm}.
26007 @xref{Function Attributes}.
26009 @strong{Warning:} if you use this switch then you must build all
26010 modules with the same value, including any libraries.  This includes
26011 the system libraries and startup modules.
26013 @item -mvect8-ret-in-mem
26014 @opindex mvect8-ret-in-mem
26015 Return 8-byte vectors in memory instead of MMX registers.  This is the
26016 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
26017 Studio compilers until version 12.  Later compiler versions (starting
26018 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
26019 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
26020 you need to remain compatible with existing code produced by those
26021 previous compiler versions or older versions of GCC@.
26023 @item -mpc32
26024 @itemx -mpc64
26025 @itemx -mpc80
26026 @opindex mpc32
26027 @opindex mpc64
26028 @opindex mpc80
26030 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
26031 is specified, the significands of results of floating-point operations are
26032 rounded to 24 bits (single precision); @option{-mpc64} rounds the
26033 significands of results of floating-point operations to 53 bits (double
26034 precision) and @option{-mpc80} rounds the significands of results of
26035 floating-point operations to 64 bits (extended double precision), which is
26036 the default.  When this option is used, floating-point operations in higher
26037 precisions are not available to the programmer without setting the FPU
26038 control word explicitly.
26040 Setting the rounding of floating-point operations to less than the default
26041 80 bits can speed some programs by 2% or more.  Note that some mathematical
26042 libraries assume that extended-precision (80-bit) floating-point operations
26043 are enabled by default; routines in such libraries could suffer significant
26044 loss of accuracy, typically through so-called ``catastrophic cancellation'',
26045 when this option is used to set the precision to less than extended precision.
26047 @item -mstackrealign
26048 @opindex mstackrealign
26049 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
26050 option generates an alternate prologue and epilogue that realigns the
26051 run-time stack if necessary.  This supports mixing legacy codes that keep
26052 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
26053 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
26054 applicable to individual functions.
26056 @item -mpreferred-stack-boundary=@var{num}
26057 @opindex mpreferred-stack-boundary
26058 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
26059 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
26060 the default is 4 (16 bytes or 128 bits).
26062 @strong{Warning:} When generating code for the x86-64 architecture with
26063 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
26064 used to keep the stack boundary aligned to 8 byte boundary.  Since
26065 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
26066 intended to be used in controlled environment where stack space is
26067 important limitation.  This option leads to wrong code when functions
26068 compiled with 16 byte stack alignment (such as functions from a standard
26069 library) are called with misaligned stack.  In this case, SSE
26070 instructions may lead to misaligned memory access traps.  In addition,
26071 variable arguments are handled incorrectly for 16 byte aligned
26072 objects (including x87 long double and __int128), leading to wrong
26073 results.  You must build all modules with
26074 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
26075 includes the system libraries and startup modules.
26077 @item -mincoming-stack-boundary=@var{num}
26078 @opindex mincoming-stack-boundary
26079 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
26080 boundary.  If @option{-mincoming-stack-boundary} is not specified,
26081 the one specified by @option{-mpreferred-stack-boundary} is used.
26083 On Pentium and Pentium Pro, @code{double} and @code{long double} values
26084 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
26085 suffer significant run time performance penalties.  On Pentium III, the
26086 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
26087 properly if it is not 16-byte aligned.
26089 To ensure proper alignment of this values on the stack, the stack boundary
26090 must be as aligned as that required by any value stored on the stack.
26091 Further, every function must be generated such that it keeps the stack
26092 aligned.  Thus calling a function compiled with a higher preferred
26093 stack boundary from a function compiled with a lower preferred stack
26094 boundary most likely misaligns the stack.  It is recommended that
26095 libraries that use callbacks always use the default setting.
26097 This extra alignment does consume extra stack space, and generally
26098 increases code size.  Code that is sensitive to stack space usage, such
26099 as embedded systems and operating system kernels, may want to reduce the
26100 preferred alignment to @option{-mpreferred-stack-boundary=2}.
26102 @need 200
26103 @item -mmmx
26104 @opindex mmmx
26105 @need 200
26106 @itemx -msse
26107 @opindex msse
26108 @need 200
26109 @itemx -msse2
26110 @opindex msse2
26111 @need 200
26112 @itemx -msse3
26113 @opindex msse3
26114 @need 200
26115 @itemx -mssse3
26116 @opindex mssse3
26117 @need 200
26118 @itemx -msse4
26119 @opindex msse4
26120 @need 200
26121 @itemx -msse4a
26122 @opindex msse4a
26123 @need 200
26124 @itemx -msse4.1
26125 @opindex msse4.1
26126 @need 200
26127 @itemx -msse4.2
26128 @opindex msse4.2
26129 @need 200
26130 @itemx -mavx
26131 @opindex mavx
26132 @need 200
26133 @itemx -mavx2
26134 @opindex mavx2
26135 @need 200
26136 @itemx -mavx512f
26137 @opindex mavx512f
26138 @need 200
26139 @itemx -mavx512pf
26140 @opindex mavx512pf
26141 @need 200
26142 @itemx -mavx512er
26143 @opindex mavx512er
26144 @need 200
26145 @itemx -mavx512cd
26146 @opindex mavx512cd
26147 @need 200
26148 @itemx -mavx512vl
26149 @opindex mavx512vl
26150 @need 200
26151 @itemx -mavx512bw
26152 @opindex mavx512bw
26153 @need 200
26154 @itemx -mavx512dq
26155 @opindex mavx512dq
26156 @need 200
26157 @itemx -mavx512ifma
26158 @opindex mavx512ifma
26159 @need 200
26160 @itemx -mavx512vbmi
26161 @opindex mavx512vbmi
26162 @need 200
26163 @itemx -msha
26164 @opindex msha
26165 @need 200
26166 @itemx -maes
26167 @opindex maes
26168 @need 200
26169 @itemx -mpclmul
26170 @opindex mpclmul
26171 @need 200
26172 @itemx -mclfushopt
26173 @opindex mclfushopt
26174 @need 200
26175 @itemx -mfsgsbase
26176 @opindex mfsgsbase
26177 @need 200
26178 @itemx -mrdrnd
26179 @opindex mrdrnd
26180 @need 200
26181 @itemx -mf16c
26182 @opindex mf16c
26183 @need 200
26184 @itemx -mfma
26185 @opindex mfma
26186 @need 200
26187 @itemx -mfma4
26188 @opindex mfma4
26189 @need 200
26190 @itemx -mprefetchwt1
26191 @opindex mprefetchwt1
26192 @need 200
26193 @itemx -mxop
26194 @opindex mxop
26195 @need 200
26196 @itemx -mlwp
26197 @opindex mlwp
26198 @need 200
26199 @itemx -m3dnow
26200 @opindex m3dnow
26201 @need 200
26202 @itemx -m3dnowa
26203 @opindex m3dnowa
26204 @need 200
26205 @itemx -mpopcnt
26206 @opindex mpopcnt
26207 @need 200
26208 @itemx -mabm
26209 @opindex mabm
26210 @need 200
26211 @itemx -mbmi
26212 @opindex mbmi
26213 @need 200
26214 @itemx -mbmi2
26215 @need 200
26216 @itemx -mlzcnt
26217 @opindex mlzcnt
26218 @need 200
26219 @itemx -mfxsr
26220 @opindex mfxsr
26221 @need 200
26222 @itemx -mxsave
26223 @opindex mxsave
26224 @need 200
26225 @itemx -mxsaveopt
26226 @opindex mxsaveopt
26227 @need 200
26228 @itemx -mxsavec
26229 @opindex mxsavec
26230 @need 200
26231 @itemx -mxsaves
26232 @opindex mxsaves
26233 @need 200
26234 @itemx -mrtm
26235 @opindex mrtm
26236 @need 200
26237 @itemx -mtbm
26238 @opindex mtbm
26239 @need 200
26240 @itemx -mmpx
26241 @opindex mmpx
26242 @need 200
26243 @itemx -mmwaitx
26244 @opindex mmwaitx
26245 @need 200
26246 @itemx -mclzero
26247 @opindex mclzero
26248 @need 200
26249 @itemx -mpku
26250 @opindex mpku
26251 @need 200
26252 @itemx -mcet
26253 @opindex mcet
26254 @need 200
26255 @itemx -mavx512vbmi2
26256 @opindex mavx512vbmi2
26257 @need 200
26258 @itemx -mgfni
26259 @opindex mgfni
26260 @need 200
26261 @itemx -mvaes
26262 @opindex mvaes
26263 @need 200
26264 @itemx -mvpclmulqdq
26265 @opindex mvpclmulqdq
26266 @need 200
26267 @itemx -mavx512bitalg
26268 @opindex mavx512bitalg
26269 @need 200
26270 @itemx -mavx512vpopcntdq
26271 @opindex mavx512vpopcntdq
26272 These switches enable the use of instructions in the MMX, SSE,
26273 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26274 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26275 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
26276 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26277 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
26278 extended instruction sets.
26279 Each has a corresponding @option{-mno-} option to disable use of these
26280 instructions.
26282 These extensions are also available as built-in functions: see
26283 @ref{x86 Built-in Functions}, for details of the functions enabled and
26284 disabled by these switches.
26286 To generate SSE/SSE2 instructions automatically from floating-point
26287 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26289 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26290 generates new AVX instructions or AVX equivalence for all SSEx instructions
26291 when needed.
26293 These options enable GCC to use these extended instructions in
26294 generated code, even without @option{-mfpmath=sse}.  Applications that
26295 perform run-time CPU detection must compile separate files for each
26296 supported architecture, using the appropriate flags.  In particular,
26297 the file containing the CPU detection code should be compiled without
26298 these options.
26300 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26301 options.  The @option{-mibt} option enables indirect branch tracking support
26302 and the @option{-mshstk} option enables shadow stack support from
26303 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26304 a number of built-in functions for fine-grained control in a CET-based
26305 application.  See @xref{x86 Built-in Functions}, for more information.
26307 @item -mdump-tune-features
26308 @opindex mdump-tune-features
26309 This option instructs GCC to dump the names of the x86 performance 
26310 tuning features and default settings. The names can be used in 
26311 @option{-mtune-ctrl=@var{feature-list}}.
26313 @item -mtune-ctrl=@var{feature-list}
26314 @opindex mtune-ctrl=@var{feature-list}
26315 This option is used to do fine grain control of x86 code generation features.
26316 @var{feature-list} is a comma separated list of @var{feature} names. See also
26317 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26318 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26319 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26320 developers. Using it may lead to code paths not covered by testing and can
26321 potentially result in compiler ICEs or runtime errors.
26323 @item -mno-default
26324 @opindex mno-default
26325 This option instructs GCC to turn off all tunable features. See also 
26326 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26328 @item -mcld
26329 @opindex mcld
26330 This option instructs GCC to emit a @code{cld} instruction in the prologue
26331 of functions that use string instructions.  String instructions depend on
26332 the DF flag to select between autoincrement or autodecrement mode.  While the
26333 ABI specifies the DF flag to be cleared on function entry, some operating
26334 systems violate this specification by not clearing the DF flag in their
26335 exception dispatchers.  The exception handler can be invoked with the DF flag
26336 set, which leads to wrong direction mode when string instructions are used.
26337 This option can be enabled by default on 32-bit x86 targets by configuring
26338 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26339 instructions can be suppressed with the @option{-mno-cld} compiler option
26340 in this case.
26342 @item -mvzeroupper
26343 @opindex mvzeroupper
26344 This option instructs GCC to emit a @code{vzeroupper} instruction
26345 before a transfer of control flow out of the function to minimize
26346 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26347 intrinsics.
26349 @item -mprefer-avx128
26350 @opindex mprefer-avx128
26351 This option instructs GCC to use 128-bit AVX instructions instead of
26352 256-bit AVX instructions in the auto-vectorizer.
26354 @item -mprefer-vector-width=@var{opt}
26355 @opindex mprefer-vector-width
26356 This option instructs GCC to use @var{opt}-bit vector width in instructions
26357 instead of default on the selected platform.
26359 @table @samp
26360 @item none
26361 No extra limitations applied to GCC other than defined by the selected platform.
26363 @item 128
26364 Prefer 128-bit vector width for instructions.
26366 @item 256
26367 Prefer 256-bit vector width for instructions.
26369 @item 512
26370 Prefer 512-bit vector width for instructions.
26371 @end table
26373 @item -mcx16
26374 @opindex mcx16
26375 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26376 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26377 objects.  This is useful for atomic updates of data structures exceeding one
26378 machine word in size.  The compiler uses this instruction to implement
26379 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26380 128-bit integers, a library call is always used.
26382 @item -msahf
26383 @opindex msahf
26384 This option enables generation of @code{SAHF} instructions in 64-bit code.
26385 Early Intel Pentium 4 CPUs with Intel 64 support,
26386 prior to the introduction of Pentium 4 G1 step in December 2005,
26387 lacked the @code{LAHF} and @code{SAHF} instructions
26388 which are supported by AMD64.
26389 These are load and store instructions, respectively, for certain status flags.
26390 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26391 @code{drem}, and @code{remainder} built-in functions;
26392 see @ref{Other Builtins} for details.
26394 @item -mmovbe
26395 @opindex mmovbe
26396 This option enables use of the @code{movbe} instruction to implement
26397 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26399 @item -mibt
26400 @opindex mibt
26401 This option tells the compiler to use indirect branch tracking support
26402 (for indirect calls and jumps) from x86 Control-flow Enforcement
26403 Technology (CET).  The option has effect only if the
26404 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26405 is specified. The option @option{-mibt} is on by default when the
26406 @code{-mcet} option is specified.
26408 @item -mshstk
26409 @opindex mshstk
26410 This option tells the compiler to use shadow stack support (return
26411 address tracking) from x86 Control-flow Enforcement Technology (CET).
26412 The option has effect only if the @option{-fcf-protection=full} or
26413 @option{-fcf-protection=return} option is specified.  The option
26414 @option{-mshstk} is on by default when the @option{-mcet} option is
26415 specified.
26417 @item -mcrc32
26418 @opindex mcrc32
26419 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26420 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26421 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26423 @item -mrecip
26424 @opindex mrecip
26425 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26426 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26427 with an additional Newton-Raphson step
26428 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26429 (and their vectorized
26430 variants) for single-precision floating-point arguments.  These instructions
26431 are generated only when @option{-funsafe-math-optimizations} is enabled
26432 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26433 Note that while the throughput of the sequence is higher than the throughput
26434 of the non-reciprocal instruction, the precision of the sequence can be
26435 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26437 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26438 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26439 combination), and doesn't need @option{-mrecip}.
26441 Also note that GCC emits the above sequence with additional Newton-Raphson step
26442 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26443 already with @option{-ffast-math} (or the above option combination), and
26444 doesn't need @option{-mrecip}.
26446 @item -mrecip=@var{opt}
26447 @opindex mrecip=opt
26448 This option controls which reciprocal estimate instructions
26449 may be used.  @var{opt} is a comma-separated list of options, which may
26450 be preceded by a @samp{!} to invert the option:
26452 @table @samp
26453 @item all
26454 Enable all estimate instructions.
26456 @item default
26457 Enable the default instructions, equivalent to @option{-mrecip}.
26459 @item none
26460 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26462 @item div
26463 Enable the approximation for scalar division.
26465 @item vec-div
26466 Enable the approximation for vectorized division.
26468 @item sqrt
26469 Enable the approximation for scalar square root.
26471 @item vec-sqrt
26472 Enable the approximation for vectorized square root.
26473 @end table
26475 So, for example, @option{-mrecip=all,!sqrt} enables
26476 all of the reciprocal approximations, except for square root.
26478 @item -mveclibabi=@var{type}
26479 @opindex mveclibabi
26480 Specifies the ABI type to use for vectorizing intrinsics using an
26481 external library.  Supported values for @var{type} are @samp{svml} 
26482 for the Intel short
26483 vector math library and @samp{acml} for the AMD math core library.
26484 To use this option, both @option{-ftree-vectorize} and
26485 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26486 ABI-compatible library must be specified at link time.
26488 GCC currently emits calls to @code{vmldExp2},
26489 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26490 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26491 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26492 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26493 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26494 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26495 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26496 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26497 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26498 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26499 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26500 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26501 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26502 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26503 when @option{-mveclibabi=acml} is used.  
26505 @item -mabi=@var{name}
26506 @opindex mabi
26507 Generate code for the specified calling convention.  Permissible values
26508 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26509 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26510 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26511 You can control this behavior for specific functions by
26512 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26513 @xref{Function Attributes}.
26515 @item -mforce-indirect-call
26516 @opindex mforce-indirect-call
26517 Force all calls to functions to be indirect. This is useful
26518 when using Intel Processor Trace where it generates more precise timing
26519 information for function calls.
26521 @item -mcall-ms2sysv-xlogues
26522 @opindex mcall-ms2sysv-xlogues
26523 @opindex mno-call-ms2sysv-xlogues
26524 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26525 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26526 default, the code for saving and restoring these registers is emitted inline,
26527 resulting in fairly lengthy prologues and epilogues.  Using
26528 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26529 use stubs in the static portion of libgcc to perform these saves and restores,
26530 thus reducing function size at the cost of a few extra instructions.
26532 @item -mtls-dialect=@var{type}
26533 @opindex mtls-dialect
26534 Generate code to access thread-local storage using the @samp{gnu} or
26535 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26536 @samp{gnu2} is more efficient, but it may add compile- and run-time
26537 requirements that cannot be satisfied on all systems.
26539 @item -mpush-args
26540 @itemx -mno-push-args
26541 @opindex mpush-args
26542 @opindex mno-push-args
26543 Use PUSH operations to store outgoing parameters.  This method is shorter
26544 and usually equally fast as method using SUB/MOV operations and is enabled
26545 by default.  In some cases disabling it may improve performance because of
26546 improved scheduling and reduced dependencies.
26548 @item -maccumulate-outgoing-args
26549 @opindex maccumulate-outgoing-args
26550 If enabled, the maximum amount of space required for outgoing arguments is
26551 computed in the function prologue.  This is faster on most modern CPUs
26552 because of reduced dependencies, improved scheduling and reduced stack usage
26553 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26554 increase in code size.  This switch implies @option{-mno-push-args}.
26556 @item -mthreads
26557 @opindex mthreads
26558 Support thread-safe exception handling on MinGW.  Programs that rely
26559 on thread-safe exception handling must compile and link all code with the
26560 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26561 @option{-D_MT}; when linking, it links in a special thread helper library
26562 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26564 @item -mms-bitfields
26565 @itemx -mno-ms-bitfields
26566 @opindex mms-bitfields
26567 @opindex mno-ms-bitfields
26569 Enable/disable bit-field layout compatible with the native Microsoft
26570 Windows compiler.  
26572 If @code{packed} is used on a structure, or if bit-fields are used,
26573 it may be that the Microsoft ABI lays out the structure differently
26574 than the way GCC normally does.  Particularly when moving packed
26575 data between functions compiled with GCC and the native Microsoft compiler
26576 (either via function call or as data in a file), it may be necessary to access
26577 either format.
26579 This option is enabled by default for Microsoft Windows
26580 targets.  This behavior can also be controlled locally by use of variable
26581 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26582 and @ref{x86 Type Attributes}.
26584 The Microsoft structure layout algorithm is fairly simple with the exception
26585 of the bit-field packing.  
26586 The padding and alignment of members of structures and whether a bit-field 
26587 can straddle a storage-unit boundary are determine by these rules:
26589 @enumerate
26590 @item Structure members are stored sequentially in the order in which they are
26591 declared: the first member has the lowest memory address and the last member
26592 the highest.
26594 @item Every data object has an alignment requirement.  The alignment requirement
26595 for all data except structures, unions, and arrays is either the size of the
26596 object or the current packing size (specified with either the
26597 @code{aligned} attribute or the @code{pack} pragma),
26598 whichever is less.  For structures, unions, and arrays,
26599 the alignment requirement is the largest alignment requirement of its members.
26600 Every object is allocated an offset so that:
26602 @smallexample
26603 offset % alignment_requirement == 0
26604 @end smallexample
26606 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26607 unit if the integral types are the same size and if the next bit-field fits
26608 into the current allocation unit without crossing the boundary imposed by the
26609 common alignment requirements of the bit-fields.
26610 @end enumerate
26612 MSVC interprets zero-length bit-fields in the following ways:
26614 @enumerate
26615 @item If a zero-length bit-field is inserted between two bit-fields that
26616 are normally coalesced, the bit-fields are not coalesced.
26618 For example:
26620 @smallexample
26621 struct
26622  @{
26623    unsigned long bf_1 : 12;
26624    unsigned long : 0;
26625    unsigned long bf_2 : 12;
26626  @} t1;
26627 @end smallexample
26629 @noindent
26630 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26631 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26633 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26634 alignment of the zero-length bit-field is greater than the member that follows it,
26635 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26637 For example:
26639 @smallexample
26640 struct
26641  @{
26642    char foo : 4;
26643    short : 0;
26644    char bar;
26645  @} t2;
26647 struct
26648  @{
26649    char foo : 4;
26650    short : 0;
26651    double bar;
26652  @} t3;
26653 @end smallexample
26655 @noindent
26656 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26657 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26658 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26659 of the structure.
26661 Taking this into account, it is important to note the following:
26663 @enumerate
26664 @item If a zero-length bit-field follows a normal bit-field, the type of the
26665 zero-length bit-field may affect the alignment of the structure as whole. For
26666 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26667 normal bit-field, and is of type short.
26669 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26670 still affect the alignment of the structure:
26672 @smallexample
26673 struct
26674  @{
26675    char foo : 6;
26676    long : 0;
26677  @} t4;
26678 @end smallexample
26680 @noindent
26681 Here, @code{t4} takes up 4 bytes.
26682 @end enumerate
26684 @item Zero-length bit-fields following non-bit-field members are ignored:
26686 @smallexample
26687 struct
26688  @{
26689    char foo;
26690    long : 0;
26691    char bar;
26692  @} t5;
26693 @end smallexample
26695 @noindent
26696 Here, @code{t5} takes up 2 bytes.
26697 @end enumerate
26700 @item -mno-align-stringops
26701 @opindex mno-align-stringops
26702 Do not align the destination of inlined string operations.  This switch reduces
26703 code size and improves performance in case the destination is already aligned,
26704 but GCC doesn't know about it.
26706 @item -minline-all-stringops
26707 @opindex minline-all-stringops
26708 By default GCC inlines string operations only when the destination is 
26709 known to be aligned to least a 4-byte boundary.  
26710 This enables more inlining and increases code
26711 size, but may improve performance of code that depends on fast
26712 @code{memcpy}, @code{strlen},
26713 and @code{memset} for short lengths.
26715 @item -minline-stringops-dynamically
26716 @opindex minline-stringops-dynamically
26717 For string operations of unknown size, use run-time checks with
26718 inline code for small blocks and a library call for large blocks.
26720 @item -mstringop-strategy=@var{alg}
26721 @opindex mstringop-strategy=@var{alg}
26722 Override the internal decision heuristic for the particular algorithm to use
26723 for inlining string operations.  The allowed values for @var{alg} are:
26725 @table @samp
26726 @item rep_byte
26727 @itemx rep_4byte
26728 @itemx rep_8byte
26729 Expand using i386 @code{rep} prefix of the specified size.
26731 @item byte_loop
26732 @itemx loop
26733 @itemx unrolled_loop
26734 Expand into an inline loop.
26736 @item libcall
26737 Always use a library call.
26738 @end table
26740 @item -mmemcpy-strategy=@var{strategy}
26741 @opindex mmemcpy-strategy=@var{strategy}
26742 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26743 should be inlined and what inline algorithm to use when the expected size
26744 of the copy operation is known. @var{strategy} 
26745 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26746 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26747 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26748 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26749 in the list must be specified in increasing order.  The minimal byte size for 
26750 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26751 preceding range.
26753 @item -mmemset-strategy=@var{strategy}
26754 @opindex mmemset-strategy=@var{strategy}
26755 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26756 @code{__builtin_memset} expansion.
26758 @item -momit-leaf-frame-pointer
26759 @opindex momit-leaf-frame-pointer
26760 Don't keep the frame pointer in a register for leaf functions.  This
26761 avoids the instructions to save, set up, and restore frame pointers and
26762 makes an extra register available in leaf functions.  The option
26763 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26764 which might make debugging harder.
26766 @item -mtls-direct-seg-refs
26767 @itemx -mno-tls-direct-seg-refs
26768 @opindex mtls-direct-seg-refs
26769 Controls whether TLS variables may be accessed with offsets from the
26770 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26771 or whether the thread base pointer must be added.  Whether or not this
26772 is valid depends on the operating system, and whether it maps the
26773 segment to cover the entire TLS area.
26775 For systems that use the GNU C Library, the default is on.
26777 @item -msse2avx
26778 @itemx -mno-sse2avx
26779 @opindex msse2avx
26780 Specify that the assembler should encode SSE instructions with VEX
26781 prefix.  The option @option{-mavx} turns this on by default.
26783 @item -mfentry
26784 @itemx -mno-fentry
26785 @opindex mfentry
26786 If profiling is active (@option{-pg}), put the profiling
26787 counter call before the prologue.
26788 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26789 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26791 @item -mrecord-mcount
26792 @itemx -mno-record-mcount
26793 @opindex mrecord-mcount
26794 If profiling is active (@option{-pg}), generate a __mcount_loc section
26795 that contains pointers to each profiling call. This is useful for
26796 automatically patching and out calls.
26798 @item -mnop-mcount
26799 @itemx -mno-nop-mcount
26800 @opindex mnop-mcount
26801 If profiling is active (@option{-pg}), generate the calls to
26802 the profiling functions as NOPs. This is useful when they
26803 should be patched in later dynamically. This is likely only
26804 useful together with @option{-mrecord-mcount}.
26806 @item -mskip-rax-setup
26807 @itemx -mno-skip-rax-setup
26808 @opindex mskip-rax-setup
26809 When generating code for the x86-64 architecture with SSE extensions
26810 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26811 register when there are no variable arguments passed in vector registers.
26813 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26814 saving vector registers on stack when passing variable arguments, the
26815 impacts of this option are callees may waste some stack space,
26816 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26817 those issues, regardless the RAX register value.
26819 @item -m8bit-idiv
26820 @itemx -mno-8bit-idiv
26821 @opindex m8bit-idiv
26822 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26823 much faster than 32-bit/64-bit integer divide.  This option generates a
26824 run-time check.  If both dividend and divisor are within range of 0
26825 to 255, 8-bit unsigned integer divide is used instead of
26826 32-bit/64-bit integer divide.
26828 @item -mavx256-split-unaligned-load
26829 @itemx -mavx256-split-unaligned-store
26830 @opindex mavx256-split-unaligned-load
26831 @opindex mavx256-split-unaligned-store
26832 Split 32-byte AVX unaligned load and store.
26834 @item -mstack-protector-guard=@var{guard}
26835 @itemx -mstack-protector-guard-reg=@var{reg}
26836 @itemx -mstack-protector-guard-offset=@var{offset}
26837 @opindex mstack-protector-guard
26838 @opindex mstack-protector-guard-reg
26839 @opindex mstack-protector-guard-offset
26840 Generate stack protection code using canary at @var{guard}.  Supported
26841 locations are @samp{global} for global canary or @samp{tls} for per-thread
26842 canary in the TLS block (the default).  This option has effect only when
26843 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26845 With the latter choice the options
26846 @option{-mstack-protector-guard-reg=@var{reg}} and
26847 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26848 which segment register (@code{%fs} or @code{%gs}) to use as base register
26849 for reading the canary, and from what offset from that base register.
26850 The default for those is as specified in the relevant ABI.
26852 @item -mmitigate-rop
26853 @opindex mmitigate-rop
26854 Try to avoid generating code sequences that contain unintended return
26855 opcodes, to mitigate against certain forms of attack. At the moment,
26856 this option is limited in what it can do and should not be relied
26857 on to provide serious protection.
26859 @item -mgeneral-regs-only
26860 @opindex mgeneral-regs-only
26861 Generate code that uses only the general-purpose registers.  This
26862 prevents the compiler from using floating-point, vector, mask and bound
26863 registers.
26865 @item -mindirect-branch=@var{choice}
26866 @opindex -mindirect-branch
26867 Convert indirect call and jump with @var{choice}.  The default is
26868 @samp{keep}, which keeps indirect call and jump unmodified.
26869 @samp{thunk} converts indirect call and jump to call and return thunk.
26870 @samp{thunk-inline} converts indirect call and jump to inlined call
26871 and return thunk.  @samp{thunk-extern} converts indirect call and jump
26872 to external call and return thunk provided in a separate object file.
26873 You can control this behavior for a specific function by using the
26874 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
26876 Note that @option{-mcmodel=large} is incompatible with
26877 @option{-mindirect-branch=thunk} nor
26878 @option{-mindirect-branch=thunk-extern} since the thunk function may
26879 not be reachable in large code model.
26881 @item -mfunction-return=@var{choice}
26882 @opindex -mfunction-return
26883 Convert function return with @var{choice}.  The default is @samp{keep},
26884 which keeps function return unmodified.  @samp{thunk} converts function
26885 return to call and return thunk.  @samp{thunk-inline} converts function
26886 return to inlined call and return thunk.  @samp{thunk-extern} converts
26887 function return to external call and return thunk provided in a separate
26888 object file.  You can control this behavior for a specific function by
26889 using the function attribute @code{function_return}.
26890 @xref{Function Attributes}.
26892 Note that @option{-mcmodel=large} is incompatible with
26893 @option{-mfunction-return=thunk} nor
26894 @option{-mfunction-return=thunk-extern} since the thunk function may
26895 not be reachable in large code model.
26898 @item -mindirect-branch-register
26899 @opindex -mindirect-branch-register
26900 Force indirect call and jump via register.
26902 @end table
26904 These @samp{-m} switches are supported in addition to the above
26905 on x86-64 processors in 64-bit environments.
26907 @table @gcctabopt
26908 @item -m32
26909 @itemx -m64
26910 @itemx -mx32
26911 @itemx -m16
26912 @itemx -miamcu
26913 @opindex m32
26914 @opindex m64
26915 @opindex mx32
26916 @opindex m16
26917 @opindex miamcu
26918 Generate code for a 16-bit, 32-bit or 64-bit environment.
26919 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26920 to 32 bits, and
26921 generates code that runs on any i386 system.
26923 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26924 types to 64 bits, and generates code for the x86-64 architecture.
26925 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26926 and @option{-mdynamic-no-pic} options.
26928 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26929 to 32 bits, and
26930 generates code for the x86-64 architecture.
26932 The @option{-m16} option is the same as @option{-m32}, except for that
26933 it outputs the @code{.code16gcc} assembly directive at the beginning of
26934 the assembly output so that the binary can run in 16-bit mode.
26936 The @option{-miamcu} option generates code which conforms to Intel MCU
26937 psABI.  It requires the @option{-m32} option to be turned on.
26939 @item -mno-red-zone
26940 @opindex mno-red-zone
26941 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26942 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26943 stack pointer that is not modified by signal or interrupt handlers
26944 and therefore can be used for temporary data without adjusting the stack
26945 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26947 @item -mcmodel=small
26948 @opindex mcmodel=small
26949 Generate code for the small code model: the program and its symbols must
26950 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26951 Programs can be statically or dynamically linked.  This is the default
26952 code model.
26954 @item -mcmodel=kernel
26955 @opindex mcmodel=kernel
26956 Generate code for the kernel code model.  The kernel runs in the
26957 negative 2 GB of the address space.
26958 This model has to be used for Linux kernel code.
26960 @item -mcmodel=medium
26961 @opindex mcmodel=medium
26962 Generate code for the medium model: the program is linked in the lower 2
26963 GB of the address space.  Small symbols are also placed there.  Symbols
26964 with sizes larger than @option{-mlarge-data-threshold} are put into
26965 large data or BSS sections and can be located above 2GB.  Programs can
26966 be statically or dynamically linked.
26968 @item -mcmodel=large
26969 @opindex mcmodel=large
26970 Generate code for the large model.  This model makes no assumptions
26971 about addresses and sizes of sections.
26973 @item -maddress-mode=long
26974 @opindex maddress-mode=long
26975 Generate code for long address mode.  This is only supported for 64-bit
26976 and x32 environments.  It is the default address mode for 64-bit
26977 environments.
26979 @item -maddress-mode=short
26980 @opindex maddress-mode=short
26981 Generate code for short address mode.  This is only supported for 32-bit
26982 and x32 environments.  It is the default address mode for 32-bit and
26983 x32 environments.
26984 @end table
26986 @node x86 Windows Options
26987 @subsection x86 Windows Options
26988 @cindex x86 Windows Options
26989 @cindex Windows Options for x86
26991 These additional options are available for Microsoft Windows targets:
26993 @table @gcctabopt
26994 @item -mconsole
26995 @opindex mconsole
26996 This option
26997 specifies that a console application is to be generated, by
26998 instructing the linker to set the PE header subsystem type
26999 required for console applications.
27000 This option is available for Cygwin and MinGW targets and is
27001 enabled by default on those targets.
27003 @item -mdll
27004 @opindex mdll
27005 This option is available for Cygwin and MinGW targets.  It
27006 specifies that a DLL---a dynamic link library---is to be
27007 generated, enabling the selection of the required runtime
27008 startup object and entry point.
27010 @item -mnop-fun-dllimport
27011 @opindex mnop-fun-dllimport
27012 This option is available for Cygwin and MinGW targets.  It
27013 specifies that the @code{dllimport} attribute should be ignored.
27015 @item -mthread
27016 @opindex mthread
27017 This option is available for MinGW targets. It specifies
27018 that MinGW-specific thread support is to be used.
27020 @item -municode
27021 @opindex municode
27022 This option is available for MinGW-w64 targets.  It causes
27023 the @code{UNICODE} preprocessor macro to be predefined, and
27024 chooses Unicode-capable runtime startup code.
27026 @item -mwin32
27027 @opindex mwin32
27028 This option is available for Cygwin and MinGW targets.  It
27029 specifies that the typical Microsoft Windows predefined macros are to
27030 be set in the pre-processor, but does not influence the choice
27031 of runtime library/startup code.
27033 @item -mwindows
27034 @opindex mwindows
27035 This option is available for Cygwin and MinGW targets.  It
27036 specifies that a GUI application is to be generated by
27037 instructing the linker to set the PE header subsystem type
27038 appropriately.
27040 @item -fno-set-stack-executable
27041 @opindex fno-set-stack-executable
27042 This option is available for MinGW targets. It specifies that
27043 the executable flag for the stack used by nested functions isn't
27044 set. This is necessary for binaries running in kernel mode of
27045 Microsoft Windows, as there the User32 API, which is used to set executable
27046 privileges, isn't available.
27048 @item -fwritable-relocated-rdata
27049 @opindex fno-writable-relocated-rdata
27050 This option is available for MinGW and Cygwin targets.  It specifies
27051 that relocated-data in read-only section is put into the @code{.data}
27052 section.  This is a necessary for older runtimes not supporting
27053 modification of @code{.rdata} sections for pseudo-relocation.
27055 @item -mpe-aligned-commons
27056 @opindex mpe-aligned-commons
27057 This option is available for Cygwin and MinGW targets.  It
27058 specifies that the GNU extension to the PE file format that
27059 permits the correct alignment of COMMON variables should be
27060 used when generating code.  It is enabled by default if
27061 GCC detects that the target assembler found during configuration
27062 supports the feature.
27063 @end table
27065 See also under @ref{x86 Options} for standard options.
27067 @node Xstormy16 Options
27068 @subsection Xstormy16 Options
27069 @cindex Xstormy16 Options
27071 These options are defined for Xstormy16:
27073 @table @gcctabopt
27074 @item -msim
27075 @opindex msim
27076 Choose startup files and linker script suitable for the simulator.
27077 @end table
27079 @node Xtensa Options
27080 @subsection Xtensa Options
27081 @cindex Xtensa Options
27083 These options are supported for Xtensa targets:
27085 @table @gcctabopt
27086 @item -mconst16
27087 @itemx -mno-const16
27088 @opindex mconst16
27089 @opindex mno-const16
27090 Enable or disable use of @code{CONST16} instructions for loading
27091 constant values.  The @code{CONST16} instruction is currently not a
27092 standard option from Tensilica.  When enabled, @code{CONST16}
27093 instructions are always used in place of the standard @code{L32R}
27094 instructions.  The use of @code{CONST16} is enabled by default only if
27095 the @code{L32R} instruction is not available.
27097 @item -mfused-madd
27098 @itemx -mno-fused-madd
27099 @opindex mfused-madd
27100 @opindex mno-fused-madd
27101 Enable or disable use of fused multiply/add and multiply/subtract
27102 instructions in the floating-point option.  This has no effect if the
27103 floating-point option is not also enabled.  Disabling fused multiply/add
27104 and multiply/subtract instructions forces the compiler to use separate
27105 instructions for the multiply and add/subtract operations.  This may be
27106 desirable in some cases where strict IEEE 754-compliant results are
27107 required: the fused multiply add/subtract instructions do not round the
27108 intermediate result, thereby producing results with @emph{more} bits of
27109 precision than specified by the IEEE standard.  Disabling fused multiply
27110 add/subtract instructions also ensures that the program output is not
27111 sensitive to the compiler's ability to combine multiply and add/subtract
27112 operations.
27114 @item -mserialize-volatile
27115 @itemx -mno-serialize-volatile
27116 @opindex mserialize-volatile
27117 @opindex mno-serialize-volatile
27118 When this option is enabled, GCC inserts @code{MEMW} instructions before
27119 @code{volatile} memory references to guarantee sequential consistency.
27120 The default is @option{-mserialize-volatile}.  Use
27121 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
27123 @item -mforce-no-pic
27124 @opindex mforce-no-pic
27125 For targets, like GNU/Linux, where all user-mode Xtensa code must be
27126 position-independent code (PIC), this option disables PIC for compiling
27127 kernel code.
27129 @item -mtext-section-literals
27130 @itemx -mno-text-section-literals
27131 @opindex mtext-section-literals
27132 @opindex mno-text-section-literals
27133 These options control the treatment of literal pools.  The default is
27134 @option{-mno-text-section-literals}, which places literals in a separate
27135 section in the output file.  This allows the literal pool to be placed
27136 in a data RAM/ROM, and it also allows the linker to combine literal
27137 pools from separate object files to remove redundant literals and
27138 improve code size.  With @option{-mtext-section-literals}, the literals
27139 are interspersed in the text section in order to keep them as close as
27140 possible to their references.  This may be necessary for large assembly
27141 files.  Literals for each function are placed right before that function.
27143 @item -mauto-litpools
27144 @itemx -mno-auto-litpools
27145 @opindex mauto-litpools
27146 @opindex mno-auto-litpools
27147 These options control the treatment of literal pools.  The default is
27148 @option{-mno-auto-litpools}, which places literals in a separate
27149 section in the output file unless @option{-mtext-section-literals} is
27150 used.  With @option{-mauto-litpools} the literals are interspersed in
27151 the text section by the assembler.  Compiler does not produce explicit
27152 @code{.literal} directives and loads literals into registers with
27153 @code{MOVI} instructions instead of @code{L32R} to let the assembler
27154 do relaxation and place literals as necessary.  This option allows
27155 assembler to create several literal pools per function and assemble
27156 very big functions, which may not be possible with
27157 @option{-mtext-section-literals}.
27159 @item -mtarget-align
27160 @itemx -mno-target-align
27161 @opindex mtarget-align
27162 @opindex mno-target-align
27163 When this option is enabled, GCC instructs the assembler to
27164 automatically align instructions to reduce branch penalties at the
27165 expense of some code density.  The assembler attempts to widen density
27166 instructions to align branch targets and the instructions following call
27167 instructions.  If there are not enough preceding safe density
27168 instructions to align a target, no widening is performed.  The
27169 default is @option{-mtarget-align}.  These options do not affect the
27170 treatment of auto-aligned instructions like @code{LOOP}, which the
27171 assembler always aligns, either by widening density instructions or
27172 by inserting NOP instructions.
27174 @item -mlongcalls
27175 @itemx -mno-longcalls
27176 @opindex mlongcalls
27177 @opindex mno-longcalls
27178 When this option is enabled, GCC instructs the assembler to translate
27179 direct calls to indirect calls unless it can determine that the target
27180 of a direct call is in the range allowed by the call instruction.  This
27181 translation typically occurs for calls to functions in other source
27182 files.  Specifically, the assembler translates a direct @code{CALL}
27183 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
27184 The default is @option{-mno-longcalls}.  This option should be used in
27185 programs where the call target can potentially be out of range.  This
27186 option is implemented in the assembler, not the compiler, so the
27187 assembly code generated by GCC still shows direct call
27188 instructions---look at the disassembled object code to see the actual
27189 instructions.  Note that the assembler uses an indirect call for
27190 every cross-file call, not just those that really are out of range.
27191 @end table
27193 @node zSeries Options
27194 @subsection zSeries Options
27195 @cindex zSeries options
27197 These are listed under @xref{S/390 and zSeries Options}.
27200 @c man end
27202 @node Spec Files
27203 @section Specifying Subprocesses and the Switches to Pass to Them
27204 @cindex Spec Files
27206 @command{gcc} is a driver program.  It performs its job by invoking a
27207 sequence of other programs to do the work of compiling, assembling and
27208 linking.  GCC interprets its command-line parameters and uses these to
27209 deduce which programs it should invoke, and which command-line options
27210 it ought to place on their command lines.  This behavior is controlled
27211 by @dfn{spec strings}.  In most cases there is one spec string for each
27212 program that GCC can invoke, but a few programs have multiple spec
27213 strings to control their behavior.  The spec strings built into GCC can
27214 be overridden by using the @option{-specs=} command-line switch to specify
27215 a spec file.
27217 @dfn{Spec files} are plain-text files that are used to construct spec
27218 strings.  They consist of a sequence of directives separated by blank
27219 lines.  The type of directive is determined by the first non-whitespace
27220 character on the line, which can be one of the following:
27222 @table @code
27223 @item %@var{command}
27224 Issues a @var{command} to the spec file processor.  The commands that can
27225 appear here are:
27227 @table @code
27228 @item %include <@var{file}>
27229 @cindex @code{%include}
27230 Search for @var{file} and insert its text at the current point in the
27231 specs file.
27233 @item %include_noerr <@var{file}>
27234 @cindex @code{%include_noerr}
27235 Just like @samp{%include}, but do not generate an error message if the include
27236 file cannot be found.
27238 @item %rename @var{old_name} @var{new_name}
27239 @cindex @code{%rename}
27240 Rename the spec string @var{old_name} to @var{new_name}.
27242 @end table
27244 @item *[@var{spec_name}]:
27245 This tells the compiler to create, override or delete the named spec
27246 string.  All lines after this directive up to the next directive or
27247 blank line are considered to be the text for the spec string.  If this
27248 results in an empty string then the spec is deleted.  (Or, if the
27249 spec did not exist, then nothing happens.)  Otherwise, if the spec
27250 does not currently exist a new spec is created.  If the spec does
27251 exist then its contents are overridden by the text of this
27252 directive, unless the first character of that text is the @samp{+}
27253 character, in which case the text is appended to the spec.
27255 @item [@var{suffix}]:
27256 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27257 and up to the next directive or blank line are considered to make up the
27258 spec string for the indicated suffix.  When the compiler encounters an
27259 input file with the named suffix, it processes the spec string in
27260 order to work out how to compile that file.  For example:
27262 @smallexample
27263 .ZZ:
27264 z-compile -input %i
27265 @end smallexample
27267 This says that any input file whose name ends in @samp{.ZZ} should be
27268 passed to the program @samp{z-compile}, which should be invoked with the
27269 command-line switch @option{-input} and with the result of performing the
27270 @samp{%i} substitution.  (See below.)
27272 As an alternative to providing a spec string, the text following a
27273 suffix directive can be one of the following:
27275 @table @code
27276 @item @@@var{language}
27277 This says that the suffix is an alias for a known @var{language}.  This is
27278 similar to using the @option{-x} command-line switch to GCC to specify a
27279 language explicitly.  For example:
27281 @smallexample
27282 .ZZ:
27283 @@c++
27284 @end smallexample
27286 Says that .ZZ files are, in fact, C++ source files.
27288 @item #@var{name}
27289 This causes an error messages saying:
27291 @smallexample
27292 @var{name} compiler not installed on this system.
27293 @end smallexample
27294 @end table
27296 GCC already has an extensive list of suffixes built into it.
27297 This directive adds an entry to the end of the list of suffixes, but
27298 since the list is searched from the end backwards, it is effectively
27299 possible to override earlier entries using this technique.
27301 @end table
27303 GCC has the following spec strings built into it.  Spec files can
27304 override these strings or create their own.  Note that individual
27305 targets can also add their own spec strings to this list.
27307 @smallexample
27308 asm          Options to pass to the assembler
27309 asm_final    Options to pass to the assembler post-processor
27310 cpp          Options to pass to the C preprocessor
27311 cc1          Options to pass to the C compiler
27312 cc1plus      Options to pass to the C++ compiler
27313 endfile      Object files to include at the end of the link
27314 link         Options to pass to the linker
27315 lib          Libraries to include on the command line to the linker
27316 libgcc       Decides which GCC support library to pass to the linker
27317 linker       Sets the name of the linker
27318 predefines   Defines to be passed to the C preprocessor
27319 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27320              by default
27321 startfile    Object files to include at the start of the link
27322 @end smallexample
27324 Here is a small example of a spec file:
27326 @smallexample
27327 %rename lib                 old_lib
27329 *lib:
27330 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27331 @end smallexample
27333 This example renames the spec called @samp{lib} to @samp{old_lib} and
27334 then overrides the previous definition of @samp{lib} with a new one.
27335 The new definition adds in some extra command-line options before
27336 including the text of the old definition.
27338 @dfn{Spec strings} are a list of command-line options to be passed to their
27339 corresponding program.  In addition, the spec strings can contain
27340 @samp{%}-prefixed sequences to substitute variable text or to
27341 conditionally insert text into the command line.  Using these constructs
27342 it is possible to generate quite complex command lines.
27344 Here is a table of all defined @samp{%}-sequences for spec
27345 strings.  Note that spaces are not generated automatically around the
27346 results of expanding these sequences.  Therefore you can concatenate them
27347 together or combine them with constant text in a single argument.
27349 @table @code
27350 @item %%
27351 Substitute one @samp{%} into the program name or argument.
27353 @item %i
27354 Substitute the name of the input file being processed.
27356 @item %b
27357 Substitute the basename of the input file being processed.
27358 This is the substring up to (and not including) the last period
27359 and not including the directory.
27361 @item %B
27362 This is the same as @samp{%b}, but include the file suffix (text after
27363 the last period).
27365 @item %d
27366 Marks the argument containing or following the @samp{%d} as a
27367 temporary file name, so that that file is deleted if GCC exits
27368 successfully.  Unlike @samp{%g}, this contributes no text to the
27369 argument.
27371 @item %g@var{suffix}
27372 Substitute a file name that has suffix @var{suffix} and is chosen
27373 once per compilation, and mark the argument in the same way as
27374 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27375 name is now chosen in a way that is hard to predict even when previously
27376 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27377 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27378 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27379 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27380 was simply substituted with a file name chosen once per compilation,
27381 without regard to any appended suffix (which was therefore treated
27382 just like ordinary text), making such attacks more likely to succeed.
27384 @item %u@var{suffix}
27385 Like @samp{%g}, but generates a new temporary file name
27386 each time it appears instead of once per compilation.
27388 @item %U@var{suffix}
27389 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27390 new one if there is no such last file name.  In the absence of any
27391 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27392 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27393 involves the generation of two distinct file names, one
27394 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27395 simply substituted with a file name chosen for the previous @samp{%u},
27396 without regard to any appended suffix.
27398 @item %j@var{suffix}
27399 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27400 writable, and if @option{-save-temps} is not used; 
27401 otherwise, substitute the name
27402 of a temporary file, just like @samp{%u}.  This temporary file is not
27403 meant for communication between processes, but rather as a junk
27404 disposal mechanism.
27406 @item %|@var{suffix}
27407 @itemx %m@var{suffix}
27408 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27409 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27410 all.  These are the two most common ways to instruct a program that it
27411 should read from standard input or write to standard output.  If you
27412 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27413 construct: see for example @file{f/lang-specs.h}.
27415 @item %.@var{SUFFIX}
27416 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27417 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27418 terminated by the next space or %.
27420 @item %w
27421 Marks the argument containing or following the @samp{%w} as the
27422 designated output file of this compilation.  This puts the argument
27423 into the sequence of arguments that @samp{%o} substitutes.
27425 @item %o
27426 Substitutes the names of all the output files, with spaces
27427 automatically placed around them.  You should write spaces
27428 around the @samp{%o} as well or the results are undefined.
27429 @samp{%o} is for use in the specs for running the linker.
27430 Input files whose names have no recognized suffix are not compiled
27431 at all, but they are included among the output files, so they are
27432 linked.
27434 @item %O
27435 Substitutes the suffix for object files.  Note that this is
27436 handled specially when it immediately follows @samp{%g, %u, or %U},
27437 because of the need for those to form complete file names.  The
27438 handling is such that @samp{%O} is treated exactly as if it had already
27439 been substituted, except that @samp{%g, %u, and %U} do not currently
27440 support additional @var{suffix} characters following @samp{%O} as they do
27441 following, for example, @samp{.o}.
27443 @item %p
27444 Substitutes the standard macro predefinitions for the
27445 current target machine.  Use this when running @command{cpp}.
27447 @item %P
27448 Like @samp{%p}, but puts @samp{__} before and after the name of each
27449 predefined macro, except for macros that start with @samp{__} or with
27450 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27453 @item %I
27454 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27455 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27456 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27457 and @option{-imultilib} as necessary.
27459 @item %s
27460 Current argument is the name of a library or startup file of some sort.
27461 Search for that file in a standard list of directories and substitute
27462 the full name found.  The current working directory is included in the
27463 list of directories scanned.
27465 @item %T
27466 Current argument is the name of a linker script.  Search for that file
27467 in the current list of directories to scan for libraries. If the file
27468 is located insert a @option{--script} option into the command line
27469 followed by the full path name found.  If the file is not found then
27470 generate an error message.  Note: the current working directory is not
27471 searched.
27473 @item %e@var{str}
27474 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27475 Use this when inconsistent options are detected.
27477 @item %(@var{name})
27478 Substitute the contents of spec string @var{name} at this point.
27480 @item %x@{@var{option}@}
27481 Accumulate an option for @samp{%X}.
27483 @item %X
27484 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27485 spec string.
27487 @item %Y
27488 Output the accumulated assembler options specified by @option{-Wa}.
27490 @item %Z
27491 Output the accumulated preprocessor options specified by @option{-Wp}.
27493 @item %a
27494 Process the @code{asm} spec.  This is used to compute the
27495 switches to be passed to the assembler.
27497 @item %A
27498 Process the @code{asm_final} spec.  This is a spec string for
27499 passing switches to an assembler post-processor, if such a program is
27500 needed.
27502 @item %l
27503 Process the @code{link} spec.  This is the spec for computing the
27504 command line passed to the linker.  Typically it makes use of the
27505 @samp{%L %G %S %D and %E} sequences.
27507 @item %D
27508 Dump out a @option{-L} option for each directory that GCC believes might
27509 contain startup files.  If the target supports multilibs then the
27510 current multilib directory is prepended to each of these paths.
27512 @item %L
27513 Process the @code{lib} spec.  This is a spec string for deciding which
27514 libraries are included on the command line to the linker.
27516 @item %G
27517 Process the @code{libgcc} spec.  This is a spec string for deciding
27518 which GCC support library is included on the command line to the linker.
27520 @item %S
27521 Process the @code{startfile} spec.  This is a spec for deciding which
27522 object files are the first ones passed to the linker.  Typically
27523 this might be a file named @file{crt0.o}.
27525 @item %E
27526 Process the @code{endfile} spec.  This is a spec string that specifies
27527 the last object files that are passed to the linker.
27529 @item %C
27530 Process the @code{cpp} spec.  This is used to construct the arguments
27531 to be passed to the C preprocessor.
27533 @item %1
27534 Process the @code{cc1} spec.  This is used to construct the options to be
27535 passed to the actual C compiler (@command{cc1}).
27537 @item %2
27538 Process the @code{cc1plus} spec.  This is used to construct the options to be
27539 passed to the actual C++ compiler (@command{cc1plus}).
27541 @item %*
27542 Substitute the variable part of a matched option.  See below.
27543 Note that each comma in the substituted string is replaced by
27544 a single space.
27546 @item %<S
27547 Remove all occurrences of @code{-S} from the command line.  Note---this
27548 command is position dependent.  @samp{%} commands in the spec string
27549 before this one see @code{-S}, @samp{%} commands in the spec string
27550 after this one do not.
27552 @item %:@var{function}(@var{args})
27553 Call the named function @var{function}, passing it @var{args}.
27554 @var{args} is first processed as a nested spec string, then split
27555 into an argument vector in the usual fashion.  The function returns
27556 a string which is processed as if it had appeared literally as part
27557 of the current spec.
27559 The following built-in spec functions are provided:
27561 @table @code
27562 @item @code{getenv}
27563 The @code{getenv} spec function takes two arguments: an environment
27564 variable name and a string.  If the environment variable is not
27565 defined, a fatal error is issued.  Otherwise, the return value is the
27566 value of the environment variable concatenated with the string.  For
27567 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27569 @smallexample
27570 %:getenv(TOPDIR /include)
27571 @end smallexample
27573 expands to @file{/path/to/top/include}.
27575 @item @code{if-exists}
27576 The @code{if-exists} spec function takes one argument, an absolute
27577 pathname to a file.  If the file exists, @code{if-exists} returns the
27578 pathname.  Here is a small example of its usage:
27580 @smallexample
27581 *startfile:
27582 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27583 @end smallexample
27585 @item @code{if-exists-else}
27586 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27587 spec function, except that it takes two arguments.  The first argument is
27588 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27589 returns the pathname.  If it does not exist, it returns the second argument.
27590 This way, @code{if-exists-else} can be used to select one file or another,
27591 based on the existence of the first.  Here is a small example of its usage:
27593 @smallexample
27594 *startfile:
27595 crt0%O%s %:if-exists(crti%O%s) \
27596 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27597 @end smallexample
27599 @item @code{replace-outfile}
27600 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27601 first argument in the outfiles array and replaces it with the second argument.  Here
27602 is a small example of its usage:
27604 @smallexample
27605 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27606 @end smallexample
27608 @item @code{remove-outfile}
27609 The @code{remove-outfile} spec function takes one argument.  It looks for the
27610 first argument in the outfiles array and removes it.  Here is a small example
27611 its usage:
27613 @smallexample
27614 %:remove-outfile(-lm)
27615 @end smallexample
27617 @item @code{pass-through-libs}
27618 The @code{pass-through-libs} spec function takes any number of arguments.  It
27619 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27620 assumes are the names of linker input library archive files) and returns a
27621 result containing all the found arguments each prepended by
27622 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27623 intended to be passed to the LTO linker plugin.
27625 @smallexample
27626 %:pass-through-libs(%G %L %G)
27627 @end smallexample
27629 @item @code{print-asm-header}
27630 The @code{print-asm-header} function takes no arguments and simply
27631 prints a banner like:
27633 @smallexample
27634 Assembler options
27635 =================
27637 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27638 @end smallexample
27640 It is used to separate compiler options from assembler options
27641 in the @option{--target-help} output.
27642 @end table
27644 @item %@{S@}
27645 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27646 If that switch is not specified, this substitutes nothing.  Note that
27647 the leading dash is omitted when specifying this option, and it is
27648 automatically inserted if the substitution is performed.  Thus the spec
27649 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27650 and outputs the command-line option @option{-foo}.
27652 @item %W@{S@}
27653 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27654 deleted on failure.
27656 @item %@{S*@}
27657 Substitutes all the switches specified to GCC whose names start
27658 with @code{-S}, but which also take an argument.  This is used for
27659 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27660 GCC considers @option{-o foo} as being
27661 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27662 text, including the space.  Thus two arguments are generated.
27664 @item %@{S*&T*@}
27665 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27666 (the order of @code{S} and @code{T} in the spec is not significant).
27667 There can be any number of ampersand-separated variables; for each the
27668 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27670 @item %@{S:X@}
27671 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27673 @item %@{!S:X@}
27674 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27676 @item %@{S*:X@}
27677 Substitutes @code{X} if one or more switches whose names start with
27678 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27679 once, no matter how many such switches appeared.  However, if @code{%*}
27680 appears somewhere in @code{X}, then @code{X} is substituted once
27681 for each matching switch, with the @code{%*} replaced by the part of
27682 that switch matching the @code{*}.
27684 If @code{%*} appears as the last part of a spec sequence then a space
27685 is added after the end of the last substitution.  If there is more
27686 text in the sequence, however, then a space is not generated.  This
27687 allows the @code{%*} substitution to be used as part of a larger
27688 string.  For example, a spec string like this:
27690 @smallexample
27691 %@{mcu=*:--script=%*/memory.ld@}
27692 @end smallexample
27694 @noindent
27695 when matching an option like @option{-mcu=newchip} produces:
27697 @smallexample
27698 --script=newchip/memory.ld
27699 @end smallexample
27701 @item %@{.S:X@}
27702 Substitutes @code{X}, if processing a file with suffix @code{S}.
27704 @item %@{!.S:X@}
27705 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27707 @item %@{,S:X@}
27708 Substitutes @code{X}, if processing a file for language @code{S}.
27710 @item %@{!,S:X@}
27711 Substitutes @code{X}, if not processing a file for language @code{S}.
27713 @item %@{S|P:X@}
27714 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27715 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27716 @code{*} sequences as well, although they have a stronger binding than
27717 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27718 alternatives must be starred, and only the first matching alternative
27719 is substituted.
27721 For example, a spec string like this:
27723 @smallexample
27724 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27725 @end smallexample
27727 @noindent
27728 outputs the following command-line options from the following input
27729 command-line options:
27731 @smallexample
27732 fred.c        -foo -baz
27733 jim.d         -bar -boggle
27734 -d fred.c     -foo -baz -boggle
27735 -d jim.d      -bar -baz -boggle
27736 @end smallexample
27738 @item %@{S:X; T:Y; :D@}
27740 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27741 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27742 be as many clauses as you need.  This may be combined with @code{.},
27743 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27746 @end table
27748 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27749 or similar construct can use a backslash to ignore the special meaning
27750 of the character following it, thus allowing literal matching of a
27751 character that is otherwise specially treated.  For example,
27752 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27753 @option{-std=iso9899:1999} option is given.
27755 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27756 construct may contain other nested @samp{%} constructs or spaces, or
27757 even newlines.  They are processed as usual, as described above.
27758 Trailing white space in @code{X} is ignored.  White space may also
27759 appear anywhere on the left side of the colon in these constructs,
27760 except between @code{.} or @code{*} and the corresponding word.
27762 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27763 handled specifically in these constructs.  If another value of
27764 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27765 @option{-W} switch is found later in the command line, the earlier
27766 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27767 just one letter, which passes all matching options.
27769 The character @samp{|} at the beginning of the predicate text is used to
27770 indicate that a command should be piped to the following command, but
27771 only if @option{-pipe} is specified.
27773 It is built into GCC which switches take arguments and which do not.
27774 (You might think it would be useful to generalize this to allow each
27775 compiler's spec to say which switches take arguments.  But this cannot
27776 be done in a consistent fashion.  GCC cannot even decide which input
27777 files have been specified without knowing which switches take arguments,
27778 and it must know which input files to compile in order to tell which
27779 compilers to run).
27781 GCC also knows implicitly that arguments starting in @option{-l} are to be
27782 treated as compiler output files, and passed to the linker in their
27783 proper position among the other output files.
27785 @node Environment Variables
27786 @section Environment Variables Affecting GCC
27787 @cindex environment variables
27789 @c man begin ENVIRONMENT
27790 This section describes several environment variables that affect how GCC
27791 operates.  Some of them work by specifying directories or prefixes to use
27792 when searching for various kinds of files.  Some are used to specify other
27793 aspects of the compilation environment.
27795 Note that you can also specify places to search using options such as
27796 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27797 take precedence over places specified using environment variables, which
27798 in turn take precedence over those specified by the configuration of GCC@.
27799 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27800 GNU Compiler Collection (GCC) Internals}.
27802 @table @env
27803 @item LANG
27804 @itemx LC_CTYPE
27805 @c @itemx LC_COLLATE
27806 @itemx LC_MESSAGES
27807 @c @itemx LC_MONETARY
27808 @c @itemx LC_NUMERIC
27809 @c @itemx LC_TIME
27810 @itemx LC_ALL
27811 @findex LANG
27812 @findex LC_CTYPE
27813 @c @findex LC_COLLATE
27814 @findex LC_MESSAGES
27815 @c @findex LC_MONETARY
27816 @c @findex LC_NUMERIC
27817 @c @findex LC_TIME
27818 @findex LC_ALL
27819 @cindex locale
27820 These environment variables control the way that GCC uses
27821 localization information which allows GCC to work with different
27822 national conventions.  GCC inspects the locale categories
27823 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27824 so.  These locale categories can be set to any value supported by your
27825 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27826 Kingdom encoded in UTF-8.
27828 The @env{LC_CTYPE} environment variable specifies character
27829 classification.  GCC uses it to determine the character boundaries in
27830 a string; this is needed for some multibyte encodings that contain quote
27831 and escape characters that are otherwise interpreted as a string
27832 end or escape.
27834 The @env{LC_MESSAGES} environment variable specifies the language to
27835 use in diagnostic messages.
27837 If the @env{LC_ALL} environment variable is set, it overrides the value
27838 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27839 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27840 environment variable.  If none of these variables are set, GCC
27841 defaults to traditional C English behavior.
27843 @item TMPDIR
27844 @findex TMPDIR
27845 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27846 files.  GCC uses temporary files to hold the output of one stage of
27847 compilation which is to be used as input to the next stage: for example,
27848 the output of the preprocessor, which is the input to the compiler
27849 proper.
27851 @item GCC_COMPARE_DEBUG
27852 @findex GCC_COMPARE_DEBUG
27853 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27854 @option{-fcompare-debug} to the compiler driver.  See the documentation
27855 of this option for more details.
27857 @item GCC_EXEC_PREFIX
27858 @findex GCC_EXEC_PREFIX
27859 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27860 names of the subprograms executed by the compiler.  No slash is added
27861 when this prefix is combined with the name of a subprogram, but you can
27862 specify a prefix that ends with a slash if you wish.
27864 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27865 an appropriate prefix to use based on the pathname it is invoked with.
27867 If GCC cannot find the subprogram using the specified prefix, it
27868 tries looking in the usual places for the subprogram.
27870 The default value of @env{GCC_EXEC_PREFIX} is
27871 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27872 the installed compiler. In many cases @var{prefix} is the value
27873 of @code{prefix} when you ran the @file{configure} script.
27875 Other prefixes specified with @option{-B} take precedence over this prefix.
27877 This prefix is also used for finding files such as @file{crt0.o} that are
27878 used for linking.
27880 In addition, the prefix is used in an unusual way in finding the
27881 directories to search for header files.  For each of the standard
27882 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27883 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27884 replacing that beginning with the specified prefix to produce an
27885 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27886 @file{foo/bar} just before it searches the standard directory 
27887 @file{/usr/local/lib/bar}.
27888 If a standard directory begins with the configured
27889 @var{prefix} then the value of @var{prefix} is replaced by
27890 @env{GCC_EXEC_PREFIX} when looking for header files.
27892 @item COMPILER_PATH
27893 @findex COMPILER_PATH
27894 The value of @env{COMPILER_PATH} is a colon-separated list of
27895 directories, much like @env{PATH}.  GCC tries the directories thus
27896 specified when searching for subprograms, if it cannot find the
27897 subprograms using @env{GCC_EXEC_PREFIX}.
27899 @item LIBRARY_PATH
27900 @findex LIBRARY_PATH
27901 The value of @env{LIBRARY_PATH} is a colon-separated list of
27902 directories, much like @env{PATH}.  When configured as a native compiler,
27903 GCC tries the directories thus specified when searching for special
27904 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27905 using GCC also uses these directories when searching for ordinary
27906 libraries for the @option{-l} option (but directories specified with
27907 @option{-L} come first).
27909 @item LANG
27910 @findex LANG
27911 @cindex locale definition
27912 This variable is used to pass locale information to the compiler.  One way in
27913 which this information is used is to determine the character set to be used
27914 when character literals, string literals and comments are parsed in C and C++.
27915 When the compiler is configured to allow multibyte characters,
27916 the following values for @env{LANG} are recognized:
27918 @table @samp
27919 @item C-JIS
27920 Recognize JIS characters.
27921 @item C-SJIS
27922 Recognize SJIS characters.
27923 @item C-EUCJP
27924 Recognize EUCJP characters.
27925 @end table
27927 If @env{LANG} is not defined, or if it has some other value, then the
27928 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27929 recognize and translate multibyte characters.
27930 @end table
27932 @noindent
27933 Some additional environment variables affect the behavior of the
27934 preprocessor.
27936 @include cppenv.texi
27938 @c man end
27940 @node Precompiled Headers
27941 @section Using Precompiled Headers
27942 @cindex precompiled headers
27943 @cindex speed of compilation
27945 Often large projects have many header files that are included in every
27946 source file.  The time the compiler takes to process these header files
27947 over and over again can account for nearly all of the time required to
27948 build the project.  To make builds faster, GCC allows you to
27949 @dfn{precompile} a header file.
27951 To create a precompiled header file, simply compile it as you would any
27952 other file, if necessary using the @option{-x} option to make the driver
27953 treat it as a C or C++ header file.  You may want to use a
27954 tool like @command{make} to keep the precompiled header up-to-date when
27955 the headers it contains change.
27957 A precompiled header file is searched for when @code{#include} is
27958 seen in the compilation.  As it searches for the included file
27959 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27960 compiler looks for a precompiled header in each directory just before it
27961 looks for the include file in that directory.  The name searched for is
27962 the name specified in the @code{#include} with @samp{.gch} appended.  If
27963 the precompiled header file cannot be used, it is ignored.
27965 For instance, if you have @code{#include "all.h"}, and you have
27966 @file{all.h.gch} in the same directory as @file{all.h}, then the
27967 precompiled header file is used if possible, and the original
27968 header is used otherwise.
27970 Alternatively, you might decide to put the precompiled header file in a
27971 directory and use @option{-I} to ensure that directory is searched
27972 before (or instead of) the directory containing the original header.
27973 Then, if you want to check that the precompiled header file is always
27974 used, you can put a file of the same name as the original header in this
27975 directory containing an @code{#error} command.
27977 This also works with @option{-include}.  So yet another way to use
27978 precompiled headers, good for projects not designed with precompiled
27979 header files in mind, is to simply take most of the header files used by
27980 a project, include them from another header file, precompile that header
27981 file, and @option{-include} the precompiled header.  If the header files
27982 have guards against multiple inclusion, they are skipped because
27983 they've already been included (in the precompiled header).
27985 If you need to precompile the same header file for different
27986 languages, targets, or compiler options, you can instead make a
27987 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27988 header in the directory, perhaps using @option{-o}.  It doesn't matter
27989 what you call the files in the directory; every precompiled header in
27990 the directory is considered.  The first precompiled header
27991 encountered in the directory that is valid for this compilation is
27992 used; they're searched in no particular order.
27994 There are many other possibilities, limited only by your imagination,
27995 good sense, and the constraints of your build system.
27997 A precompiled header file can be used only when these conditions apply:
27999 @itemize
28000 @item
28001 Only one precompiled header can be used in a particular compilation.
28003 @item
28004 A precompiled header cannot be used once the first C token is seen.  You
28005 can have preprocessor directives before a precompiled header; you cannot
28006 include a precompiled header from inside another header.
28008 @item
28009 The precompiled header file must be produced for the same language as
28010 the current compilation.  You cannot use a C precompiled header for a C++
28011 compilation.
28013 @item
28014 The precompiled header file must have been produced by the same compiler
28015 binary as the current compilation is using.
28017 @item
28018 Any macros defined before the precompiled header is included must
28019 either be defined in the same way as when the precompiled header was
28020 generated, or must not affect the precompiled header, which usually
28021 means that they don't appear in the precompiled header at all.
28023 The @option{-D} option is one way to define a macro before a
28024 precompiled header is included; using a @code{#define} can also do it.
28025 There are also some options that define macros implicitly, like
28026 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
28027 defined this way.
28029 @item If debugging information is output when using the precompiled
28030 header, using @option{-g} or similar, the same kind of debugging information
28031 must have been output when building the precompiled header.  However,
28032 a precompiled header built using @option{-g} can be used in a compilation
28033 when no debugging information is being output.
28035 @item The same @option{-m} options must generally be used when building
28036 and using the precompiled header.  @xref{Submodel Options},
28037 for any cases where this rule is relaxed.
28039 @item Each of the following options must be the same when building and using
28040 the precompiled header:
28042 @gccoptlist{-fexceptions}
28044 @item
28045 Some other command-line options starting with @option{-f},
28046 @option{-p}, or @option{-O} must be defined in the same way as when
28047 the precompiled header was generated.  At present, it's not clear
28048 which options are safe to change and which are not; the safest choice
28049 is to use exactly the same options when generating and using the
28050 precompiled header.  The following are known to be safe:
28052 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
28053 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
28054 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
28055 -pedantic-errors}
28057 @end itemize
28059 For all of these except the last, the compiler automatically
28060 ignores the precompiled header if the conditions aren't met.  If you
28061 find an option combination that doesn't work and doesn't cause the
28062 precompiled header to be ignored, please consider filing a bug report,
28063 see @ref{Bugs}.
28065 If you do use differing options when generating and using the
28066 precompiled header, the actual behavior is a mixture of the
28067 behavior for the options.  For instance, if you use @option{-g} to
28068 generate the precompiled header but not when using it, you may or may
28069 not get debugging information for routines in the precompiled header.