2017-10-26 Tamar Christina <tamar.christina@arm.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob71b2445f70fd5b832c68c08e69e71d8ecad37a4a
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
350 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
351 -fno-eliminate-unused-debug-types @gol
352 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
353 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
354 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
355 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
356 -fvar-tracking  -fvar-tracking-assignments}
358 @item Optimization Options
359 @xref{Optimize Options,,Options that Control Optimization}.
360 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
361 -falign-jumps[=@var{n}] @gol
362 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
363 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
364 -fauto-inc-dec  -fbranch-probabilities @gol
365 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
366 -fbtr-bb-exclusive  -fcaller-saves @gol
367 -fcombine-stack-adjustments  -fconserve-stack @gol
368 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
369 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
370 -fcx-limited-range @gol
371 -fdata-sections  -fdce  -fdelayed-branch @gol
372 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
373 -fdevirtualize-at-ltrans  -fdse @gol
374 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
375 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
376 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
377 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
378 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
379 -fif-conversion2  -findirect-inlining @gol
380 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
381 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
382 -fipa-bit-cp -fipa-vrp @gol
383 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
384 -fira-algorithm=@var{algorithm} @gol
385 -fira-region=@var{region}  -fira-hoist-pressure @gol
386 -fira-loop-pressure  -fno-ira-share-save-slots @gol
387 -fno-ira-share-spill-slots @gol
388 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
389 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
390 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
391 -floop-block  -floop-interchange  -floop-strip-mine @gol
392 -floop-unroll-and-jam  -floop-nest-optimize @gol
393 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
394 -flto-partition=@var{alg}  -fmerge-all-constants @gol
395 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
396 -fmove-loop-invariants  -fno-branch-count-reg @gol
397 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
398 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
399 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
400 -fno-sched-spec  -fno-signed-zeros @gol
401 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
402 -fomit-frame-pointer  -foptimize-sibling-calls @gol
403 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
404 -fprefetch-loop-arrays @gol
405 -fprofile-correction @gol
406 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
407 -fprofile-reorder-functions @gol
408 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
409 -freorder-blocks-algorithm=@var{algorithm} @gol
410 -freorder-blocks-and-partition  -freorder-functions @gol
411 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
412 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
413 -fsched-spec-load  -fsched-spec-load-dangerous @gol
414 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
415 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
416 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
417 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
418 -fschedule-fusion @gol
419 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
420 -fselective-scheduling  -fselective-scheduling2 @gol
421 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
422 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
423 -fsignaling-nans @gol
424 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
425 -fsplit-paths @gol
426 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
427 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
428 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
429 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
430 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
431 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
432 -ftree-loop-if-convert  -ftree-loop-im @gol
433 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
434 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
435 -ftree-loop-vectorize @gol
436 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
437 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
438 -ftree-switch-conversion  -ftree-tail-merge @gol
439 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
440 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
441 -funsafe-math-optimizations  -funswitch-loops @gol
442 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
443 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
444 --param @var{name}=@var{value}
445 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
447 @item Program Instrumentation Options
448 @xref{Instrumentation Options,,Program Instrumentation Options}.
449 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
450 -fprofile-abs-path @gol
451 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
452 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
453 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
454 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
455 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
456 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
457 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
458 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
459 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
460 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
461 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
462 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
463 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
464 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
465 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
466 -fstack-protector-explicit  -fstack-check @gol
467 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
468 -fno-stack-limit  -fsplit-stack @gol
469 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
470 -fvtv-counts  -fvtv-debug @gol
471 -finstrument-functions @gol
472 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
473 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
475 @item Preprocessor Options
476 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
477 @gccoptlist{-A@var{question}=@var{answer} @gol
478 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
479 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
480 -dD  -dI  -dM  -dN  -dU @gol
481 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
482 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
483 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
484 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
485 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
486 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
487 -H  -imacros @var{file}  -include @var{file} @gol
488 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
489 -no-integrated-cpp  -P  -pthread  -remap @gol
490 -traditional  -traditional-cpp  -trigraphs @gol
491 -U@var{macro}  -undef  @gol
492 -Wp,@var{option}  -Xpreprocessor @var{option}}
494 @item Assembler Options
495 @xref{Assembler Options,,Passing Options to the Assembler}.
496 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
498 @item Linker Options
499 @xref{Link Options,,Options for Linking}.
500 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
501 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
502 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
503 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
504 -static-libmpx  -static-libmpxwrappers @gol
505 -shared  -shared-libgcc  -symbolic @gol
506 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
507 -u @var{symbol}  -z @var{keyword}}
509 @item Directory Options
510 @xref{Directory Options,,Options for Directory Search}.
511 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
512 -idirafter @var{dir} @gol
513 -imacros @var{file}  -imultilib @var{dir} @gol
514 -iplugindir=@var{dir}  -iprefix @var{file} @gol
515 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
516 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
517 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
518 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
520 @item Code Generation Options
521 @xref{Code Gen Options,,Options for Code Generation Conventions}.
522 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
523 -ffixed-@var{reg}  -fexceptions @gol
524 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
525 -fasynchronous-unwind-tables @gol
526 -fno-gnu-unique @gol
527 -finhibit-size-directive  -fno-common  -fno-ident @gol
528 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
529 -fno-jump-tables @gol
530 -frecord-gcc-switches @gol
531 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
532 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
533 -fleading-underscore  -ftls-model=@var{model} @gol
534 -fstack-reuse=@var{reuse_level} @gol
535 -ftrampolines  -ftrapv  -fwrapv @gol
536 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
537 -fstrict-volatile-bitfields  -fsync-libcalls}
539 @item Developer Options
540 @xref{Developer Options,,GCC Developer Options}.
541 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
542 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
543 -fdbg-cnt=@var{counter-value-list} @gol
544 -fdisable-ipa-@var{pass_name} @gol
545 -fdisable-rtl-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
547 -fdisable-tree-@var{pass_name} @gol
548 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
549 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
550 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
551 -fdump-final-insns@r{[}=@var{file}@r{]}
552 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
553 -fdump-lang-all @gol
554 -fdump-lang-@var{switch} @gol
555 -fdump-lang-@var{switch}-@var{options} @gol
556 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
557 -fdump-passes @gol
558 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
559 -fdump-statistics @gol
560 -fdump-tree-all @gol
561 -fdump-tree-@var{switch} @gol
562 -fdump-tree-@var{switch}-@var{options} @gol
563 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
564 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
565 -fenable-@var{kind}-@var{pass} @gol
566 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
567 -fira-verbose=@var{n} @gol
568 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
569 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
570 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
571 -fprofile-report @gol
572 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
573 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
574 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
575 -fvar-tracking-assignments-toggle  -gtoggle @gol
576 -print-file-name=@var{library}  -print-libgcc-file-name @gol
577 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
578 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
579 -print-sysroot  -print-sysroot-headers-suffix @gol
580 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
582 @item Machine-Dependent Options
583 @xref{Submodel Options,,Machine-Dependent Options}.
584 @c This list is ordered alphanumerically by subsection name.
585 @c Try and put the significant identifier (CPU or system) first,
586 @c so users have a clue at guessing where the ones they want will be.
588 @emph{AArch64 Options}
589 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
590 -mgeneral-regs-only @gol
591 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
592 -mstrict-align @gol
593 -momit-leaf-frame-pointer @gol
594 -mtls-dialect=desc  -mtls-dialect=traditional @gol
595 -mtls-size=@var{size} @gol
596 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
597 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
598 -mpc-relative-literal-loads @gol
599 -msign-return-address=@var{scope} @gol
600 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
602 @emph{Adapteva Epiphany Options}
603 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
604 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
605 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
606 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
607 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
608 -msplit-vecmove-early  -m1reg-@var{reg}}
610 @emph{ARC Options}
611 @gccoptlist{-mbarrel-shifter @gol
612 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
613 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
614 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
615 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
616 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
617 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
618 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
619 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
620 -mvolatile-cache  -mtp-regno=@var{regno} @gol
621 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
622 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
623 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
624 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
625 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
626 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
627 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
628 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
630 @emph{ARM Options}
631 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
632 -mabi=@var{name} @gol
633 -mapcs-stack-check  -mno-apcs-stack-check @gol
634 -mapcs-reentrant  -mno-apcs-reentrant @gol
635 -msched-prolog  -mno-sched-prolog @gol
636 -mlittle-endian  -mbig-endian @gol
637 -mbe8 -mbe32 @gol
638 -mfloat-abi=@var{name} @gol
639 -mfp16-format=@var{name}
640 -mthumb-interwork  -mno-thumb-interwork @gol
641 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
642 -mtune=@var{name}  -mprint-tune-info @gol
643 -mstructure-size-boundary=@var{n} @gol
644 -mabort-on-noreturn @gol
645 -mlong-calls  -mno-long-calls @gol
646 -msingle-pic-base  -mno-single-pic-base @gol
647 -mpic-register=@var{reg} @gol
648 -mnop-fun-dllimport @gol
649 -mpoke-function-name @gol
650 -mthumb  -marm @gol
651 -mtpcs-frame  -mtpcs-leaf-frame @gol
652 -mcaller-super-interworking  -mcallee-super-interworking @gol
653 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
654 -mword-relocations @gol
655 -mfix-cortex-m3-ldrd @gol
656 -munaligned-access @gol
657 -mneon-for-64bits @gol
658 -mslow-flash-data @gol
659 -masm-syntax-unified @gol
660 -mrestrict-it @gol
661 -mpure-code @gol
662 -mcmse}
664 @emph{AVR Options}
665 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
666 -mbranch-cost=@var{cost} @gol
667 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
668 -mn_flash=@var{size}  -mno-interrupts @gol
669 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
670 -mshort-calls  -nodevicelib @gol
671 -Waddr-space-convert  -Wmisspelled-isr}
673 @emph{Blackfin Options}
674 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
675 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
676 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
677 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
678 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
679 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
680 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
681 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
682 -micplb}
684 @emph{C6X Options}
685 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
686 -msim  -msdata=@var{sdata-type}}
688 @emph{CRIS Options}
689 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
690 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
691 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
692 -mstack-align  -mdata-align  -mconst-align @gol
693 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
694 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
695 -mmul-bug-workaround  -mno-mul-bug-workaround}
697 @emph{CR16 Options}
698 @gccoptlist{-mmac @gol
699 -mcr16cplus  -mcr16c @gol
700 -msim  -mint32  -mbit-ops
701 -mdata-model=@var{model}}
703 @emph{Darwin Options}
704 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
705 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
706 -client_name  -compatibility_version  -current_version @gol
707 -dead_strip @gol
708 -dependency-file  -dylib_file  -dylinker_install_name @gol
709 -dynamic  -dynamiclib  -exported_symbols_list @gol
710 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
711 -force_flat_namespace  -headerpad_max_install_names @gol
712 -iframework @gol
713 -image_base  -init  -install_name  -keep_private_externs @gol
714 -multi_module  -multiply_defined  -multiply_defined_unused @gol
715 -noall_load   -no_dead_strip_inits_and_terms @gol
716 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
717 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
718 -private_bundle  -read_only_relocs  -sectalign @gol
719 -sectobjectsymbols  -whyload  -seg1addr @gol
720 -sectcreate  -sectobjectsymbols  -sectorder @gol
721 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
722 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
723 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
724 -single_module  -static  -sub_library  -sub_umbrella @gol
725 -twolevel_namespace  -umbrella  -undefined @gol
726 -unexported_symbols_list  -weak_reference_mismatches @gol
727 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
728 -mkernel  -mone-byte-bool}
730 @emph{DEC Alpha Options}
731 @gccoptlist{-mno-fp-regs  -msoft-float @gol
732 -mieee  -mieee-with-inexact  -mieee-conformant @gol
733 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
734 -mtrap-precision=@var{mode}  -mbuild-constants @gol
735 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
736 -mbwx  -mmax  -mfix  -mcix @gol
737 -mfloat-vax  -mfloat-ieee @gol
738 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
739 -msmall-text  -mlarge-text @gol
740 -mmemory-latency=@var{time}}
742 @emph{FR30 Options}
743 @gccoptlist{-msmall-model  -mno-lsim}
745 @emph{FT32 Options}
746 @gccoptlist{-msim  -mlra  -mnodiv}
748 @emph{FRV Options}
749 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
750 -mhard-float  -msoft-float @gol
751 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
752 -mdouble  -mno-double @gol
753 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
754 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
755 -mlinked-fp  -mlong-calls  -malign-labels @gol
756 -mlibrary-pic  -macc-4  -macc-8 @gol
757 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
758 -moptimize-membar  -mno-optimize-membar @gol
759 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
760 -mvliw-branch  -mno-vliw-branch @gol
761 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
762 -mno-nested-cond-exec  -mtomcat-stats @gol
763 -mTLS  -mtls @gol
764 -mcpu=@var{cpu}}
766 @emph{GNU/Linux Options}
767 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
768 -tno-android-cc  -tno-android-ld}
770 @emph{H8/300 Options}
771 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
773 @emph{HPPA Options}
774 @gccoptlist{-march=@var{architecture-type} @gol
775 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
776 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
777 -mfixed-range=@var{register-range} @gol
778 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
779 -mlong-load-store  -mno-disable-fpregs @gol
780 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
781 -mno-jump-in-delay  -mno-long-load-store @gol
782 -mno-portable-runtime  -mno-soft-float @gol
783 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
784 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
785 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
786 -munix=@var{unix-std}  -nolibdld  -static  -threads}
788 @emph{IA-64 Options}
789 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
790 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
791 -mconstant-gp  -mauto-pic  -mfused-madd @gol
792 -minline-float-divide-min-latency @gol
793 -minline-float-divide-max-throughput @gol
794 -mno-inline-float-divide @gol
795 -minline-int-divide-min-latency @gol
796 -minline-int-divide-max-throughput  @gol
797 -mno-inline-int-divide @gol
798 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
799 -mno-inline-sqrt @gol
800 -mdwarf2-asm  -mearly-stop-bits @gol
801 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
802 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
803 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
804 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
805 -msched-spec-ldc  -msched-spec-control-ldc @gol
806 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
807 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
808 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
809 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
811 @emph{LM32 Options}
812 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
813 -msign-extend-enabled  -muser-enabled}
815 @emph{M32R/D Options}
816 @gccoptlist{-m32r2  -m32rx  -m32r @gol
817 -mdebug @gol
818 -malign-loops  -mno-align-loops @gol
819 -missue-rate=@var{number} @gol
820 -mbranch-cost=@var{number} @gol
821 -mmodel=@var{code-size-model-type} @gol
822 -msdata=@var{sdata-type} @gol
823 -mno-flush-func  -mflush-func=@var{name} @gol
824 -mno-flush-trap  -mflush-trap=@var{number} @gol
825 -G @var{num}}
827 @emph{M32C Options}
828 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
830 @emph{M680x0 Options}
831 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
832 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
833 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
834 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
835 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
836 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
837 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
838 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
839 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
841 @emph{MCore Options}
842 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
843 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
844 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
845 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
846 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
848 @emph{MeP Options}
849 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
850 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
851 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
852 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
853 -mtiny=@var{n}}
855 @emph{MicroBlaze Options}
856 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
857 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
858 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
859 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
860 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
862 @emph{MIPS Options}
863 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
864 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
865 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
866 -mips16  -mno-mips16  -mflip-mips16 @gol
867 -minterlink-compressed  -mno-interlink-compressed @gol
868 -minterlink-mips16  -mno-interlink-mips16 @gol
869 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
870 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
871 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
872 -mno-float  -msingle-float  -mdouble-float @gol
873 -modd-spreg  -mno-odd-spreg @gol
874 -mabs=@var{mode}  -mnan=@var{encoding} @gol
875 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
876 -mmcu  -mmno-mcu @gol
877 -meva  -mno-eva @gol
878 -mvirt  -mno-virt @gol
879 -mxpa  -mno-xpa @gol
880 -mmicromips  -mno-micromips @gol
881 -mmsa  -mno-msa @gol
882 -mfpu=@var{fpu-type} @gol
883 -msmartmips  -mno-smartmips @gol
884 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
885 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
886 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
887 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
888 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
889 -membedded-data  -mno-embedded-data @gol
890 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
891 -mcode-readable=@var{setting} @gol
892 -msplit-addresses  -mno-split-addresses @gol
893 -mexplicit-relocs  -mno-explicit-relocs @gol
894 -mcheck-zero-division  -mno-check-zero-division @gol
895 -mdivide-traps  -mdivide-breaks @gol
896 -mload-store-pairs  -mno-load-store-pairs @gol
897 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
898 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
899 -mfix-24k  -mno-fix-24k @gol
900 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
901 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
902 -mfix-vr4120  -mno-fix-vr4120 @gol
903 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
904 -mflush-func=@var{func}  -mno-flush-func @gol
905 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
906 -mcompact-branches=@var{policy} @gol
907 -mfp-exceptions  -mno-fp-exceptions @gol
908 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
909 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
910 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
911 -mframe-header-opt  -mno-frame-header-opt}
913 @emph{MMIX Options}
914 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
915 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
916 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
917 -mno-base-addresses  -msingle-exit  -mno-single-exit}
919 @emph{MN10300 Options}
920 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
921 -mno-am33  -mam33  -mam33-2  -mam34 @gol
922 -mtune=@var{cpu-type} @gol
923 -mreturn-pointer-on-d0 @gol
924 -mno-crt0  -mrelax  -mliw  -msetlb}
926 @emph{Moxie Options}
927 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
929 @emph{MSP430 Options}
930 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
931 -mwarn-mcu @gol
932 -mcode-region=  -mdata-region= @gol
933 -msilicon-errata=  -msilicon-errata-warn= @gol
934 -mhwmult=  -minrt}
936 @emph{NDS32 Options}
937 @gccoptlist{-mbig-endian  -mlittle-endian @gol
938 -mreduced-regs  -mfull-regs @gol
939 -mcmov  -mno-cmov @gol
940 -mperf-ext  -mno-perf-ext @gol
941 -mv3push  -mno-v3push @gol
942 -m16bit  -mno-16bit @gol
943 -misr-vector-size=@var{num} @gol
944 -mcache-block-size=@var{num} @gol
945 -march=@var{arch} @gol
946 -mcmodel=@var{code-model} @gol
947 -mctor-dtor  -mrelax}
949 @emph{Nios II Options}
950 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
951 -mel  -meb @gol
952 -mno-bypass-cache  -mbypass-cache @gol
953 -mno-cache-volatile  -mcache-volatile @gol
954 -mno-fast-sw-div  -mfast-sw-div @gol
955 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
956 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
957 -mcustom-fpu-cfg=@var{name} @gol
958 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
959 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
961 @emph{Nvidia PTX Options}
962 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
964 @emph{PDP-11 Options}
965 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
966 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
967 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
968 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
969 -mbranch-expensive  -mbranch-cheap @gol
970 -munix-asm  -mdec-asm}
972 @emph{picoChip Options}
973 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
974 -msymbol-as-address  -mno-inefficient-warnings}
976 @emph{PowerPC Options}
977 See RS/6000 and PowerPC Options.
979 @emph{RISC-V Options}
980 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
981 -mmemcpy  -mno-memcpy @gol
982 -mplt  -mno-plt @gol
983 -mabi=@var{ABI-string} @gol
984 -mfdiv  -mno-fdiv @gol
985 -mdiv  -mno-div @gol
986 -march=@var{ISA-string} @gol
987 -mtune=@var{processor-string} @gol
988 -msmall-data-limit=@var{N-bytes} @gol
989 -msave-restore  -mno-save-restore @gol
990 -mstrict-align -mno-strict-align @gol
991 -mcmodel=@var{code-model} @gol
992 -mexplicit-relocs  -mno-explicit-relocs @gol}
994 @emph{RL78 Options}
995 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
996 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
997 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
999 @emph{RS/6000 and PowerPC Options}
1000 @gccoptlist{-mcpu=@var{cpu-type} @gol
1001 -mtune=@var{cpu-type} @gol
1002 -mcmodel=@var{code-model} @gol
1003 -mpowerpc64 @gol
1004 -maltivec  -mno-altivec @gol
1005 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1006 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1007 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1008 -mfprnd  -mno-fprnd @gol
1009 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1010 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1011 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1012 -malign-power  -malign-natural @gol
1013 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1014 -msingle-float  -mdouble-float  -msimple-fpu @gol
1015 -mstring  -mno-string  -mupdate  -mno-update @gol
1016 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1017 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1018 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1019 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1020 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1021 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1022 -mprioritize-restricted-insns=@var{priority} @gol
1023 -msched-costly-dep=@var{dependence_type} @gol
1024 -minsert-sched-nops=@var{scheme} @gol
1025 -mcall-sysv  -mcall-netbsd @gol
1026 -maix-struct-return  -msvr4-struct-return @gol
1027 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1028 -mblock-move-inline-limit=@var{num} @gol
1029 -misel  -mno-isel @gol
1030 -misel=yes  -misel=no @gol
1031 -mspe  -mno-spe @gol
1032 -mspe=yes  -mspe=no @gol
1033 -mpaired @gol
1034 -mvrsave  -mno-vrsave @gol
1035 -mmulhw  -mno-mulhw @gol
1036 -mdlmzb  -mno-dlmzb @gol
1037 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1038 -mprototype  -mno-prototype @gol
1039 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1040 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1041 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1042 -mno-recip-precision @gol
1043 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1044 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1045 -msave-toc-indirect  -mno-save-toc-indirect @gol
1046 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1047 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1048 -mquad-memory  -mno-quad-memory @gol
1049 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1050 -mcompat-align-parm  -mno-compat-align-parm @gol
1051 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1052 -mgnu-attribute  -mno-gnu-attribute @gol
1053 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1054 -mstack-protector-guard-offset=@var{offset}}
1056 @emph{RX Options}
1057 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1058 -mcpu=@gol
1059 -mbig-endian-data  -mlittle-endian-data @gol
1060 -msmall-data @gol
1061 -msim  -mno-sim@gol
1062 -mas100-syntax  -mno-as100-syntax@gol
1063 -mrelax@gol
1064 -mmax-constant-size=@gol
1065 -mint-register=@gol
1066 -mpid@gol
1067 -mallow-string-insns  -mno-allow-string-insns@gol
1068 -mjsr@gol
1069 -mno-warn-multiple-fast-interrupts@gol
1070 -msave-acc-in-interrupts}
1072 @emph{S/390 and zSeries Options}
1073 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1074 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1075 -mlong-double-64  -mlong-double-128 @gol
1076 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1077 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1078 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1079 -mhtm  -mvx  -mzvector @gol
1080 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1081 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1082 -mhotpatch=@var{halfwords},@var{halfwords}}
1084 @emph{Score Options}
1085 @gccoptlist{-meb  -mel @gol
1086 -mnhwloop @gol
1087 -muls @gol
1088 -mmac @gol
1089 -mscore5  -mscore5u  -mscore7  -mscore7d}
1091 @emph{SH Options}
1092 @gccoptlist{-m1  -m2  -m2e @gol
1093 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1094 -m3  -m3e @gol
1095 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1096 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1097 -mb  -ml  -mdalign  -mrelax @gol
1098 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1099 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1100 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1101 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1102 -maccumulate-outgoing-args @gol
1103 -matomic-model=@var{atomic-model} @gol
1104 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1105 -mcbranch-force-delay-slot @gol
1106 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1107 -mpretend-cmove  -mtas}
1109 @emph{Solaris 2 Options}
1110 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1111 -pthreads}
1113 @emph{SPARC Options}
1114 @gccoptlist{-mcpu=@var{cpu-type} @gol
1115 -mtune=@var{cpu-type} @gol
1116 -mcmodel=@var{code-model} @gol
1117 -mmemory-model=@var{mem-model} @gol
1118 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1119 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1120 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1121 -mhard-quad-float  -msoft-quad-float @gol
1122 -mstack-bias  -mno-stack-bias @gol
1123 -mstd-struct-return  -mno-std-struct-return @gol
1124 -munaligned-doubles  -mno-unaligned-doubles @gol
1125 -muser-mode  -mno-user-mode @gol
1126 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1127 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1128 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1129 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1130 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1131 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1132 -mlra  -mno-lra}
1134 @emph{SPU Options}
1135 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1136 -msafe-dma  -munsafe-dma @gol
1137 -mbranch-hints @gol
1138 -msmall-mem  -mlarge-mem  -mstdmain @gol
1139 -mfixed-range=@var{register-range} @gol
1140 -mea32  -mea64 @gol
1141 -maddress-space-conversion  -mno-address-space-conversion @gol
1142 -mcache-size=@var{cache-size} @gol
1143 -matomic-updates  -mno-atomic-updates}
1145 @emph{System V Options}
1146 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1148 @emph{TILE-Gx Options}
1149 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1150 -mcmodel=@var{code-model}}
1152 @emph{TILEPro Options}
1153 @gccoptlist{-mcpu=@var{cpu}  -m32}
1155 @emph{V850 Options}
1156 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1157 -mprolog-function  -mno-prolog-function  -mspace @gol
1158 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1159 -mapp-regs  -mno-app-regs @gol
1160 -mdisable-callt  -mno-disable-callt @gol
1161 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1162 -mv850e  -mv850  -mv850e3v5 @gol
1163 -mloop @gol
1164 -mrelax @gol
1165 -mlong-jumps @gol
1166 -msoft-float @gol
1167 -mhard-float @gol
1168 -mgcc-abi @gol
1169 -mrh850-abi @gol
1170 -mbig-switch}
1172 @emph{VAX Options}
1173 @gccoptlist{-mg  -mgnu  -munix}
1175 @emph{Visium Options}
1176 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1177 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1179 @emph{VMS Options}
1180 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1181 -mpointer-size=@var{size}}
1183 @emph{VxWorks Options}
1184 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1185 -Xbind-lazy  -Xbind-now}
1187 @emph{x86 Options}
1188 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1189 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1190 -mfpmath=@var{unit} @gol
1191 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1192 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1193 -mno-wide-multiply  -mrtd  -malign-double @gol
1194 -mpreferred-stack-boundary=@var{num} @gol
1195 -mincoming-stack-boundary=@var{num} @gol
1196 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1197 -mrecip  -mrecip=@var{opt} @gol
1198 -mvzeroupper  -mprefer-avx128 -mprefer-avx256 @gol
1199 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1200 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1201 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1202 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1203 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1204 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1205 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1206 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1207 -mcet -mibt -mshstk @gol
1208 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1209 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1210 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1211 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1212 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1213 -mregparm=@var{num}  -msseregparm @gol
1214 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1215 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1216 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1217 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1218 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1219 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1220 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1221 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1222 -mstack-protector-guard-reg=@var{reg} @gol
1223 -mstack-protector-guard-offset=@var{offset} @gol
1224 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1225 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1227 @emph{x86 Windows Options}
1228 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1229 -mnop-fun-dllimport  -mthread @gol
1230 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1232 @emph{Xstormy16 Options}
1233 @gccoptlist{-msim}
1235 @emph{Xtensa Options}
1236 @gccoptlist{-mconst16  -mno-const16 @gol
1237 -mfused-madd  -mno-fused-madd @gol
1238 -mforce-no-pic @gol
1239 -mserialize-volatile  -mno-serialize-volatile @gol
1240 -mtext-section-literals  -mno-text-section-literals @gol
1241 -mauto-litpools  -mno-auto-litpools @gol
1242 -mtarget-align  -mno-target-align @gol
1243 -mlongcalls  -mno-longcalls}
1245 @emph{zSeries Options}
1246 See S/390 and zSeries Options.
1247 @end table
1250 @node Overall Options
1251 @section Options Controlling the Kind of Output
1253 Compilation can involve up to four stages: preprocessing, compilation
1254 proper, assembly and linking, always in that order.  GCC is capable of
1255 preprocessing and compiling several files either into several
1256 assembler input files, or into one assembler input file; then each
1257 assembler input file produces an object file, and linking combines all
1258 the object files (those newly compiled, and those specified as input)
1259 into an executable file.
1261 @cindex file name suffix
1262 For any given input file, the file name suffix determines what kind of
1263 compilation is done:
1265 @table @gcctabopt
1266 @item @var{file}.c
1267 C source code that must be preprocessed.
1269 @item @var{file}.i
1270 C source code that should not be preprocessed.
1272 @item @var{file}.ii
1273 C++ source code that should not be preprocessed.
1275 @item @var{file}.m
1276 Objective-C source code.  Note that you must link with the @file{libobjc}
1277 library to make an Objective-C program work.
1279 @item @var{file}.mi
1280 Objective-C source code that should not be preprocessed.
1282 @item @var{file}.mm
1283 @itemx @var{file}.M
1284 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1285 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1286 to a literal capital M@.
1288 @item @var{file}.mii
1289 Objective-C++ source code that should not be preprocessed.
1291 @item @var{file}.h
1292 C, C++, Objective-C or Objective-C++ header file to be turned into a
1293 precompiled header (default), or C, C++ header file to be turned into an
1294 Ada spec (via the @option{-fdump-ada-spec} switch).
1296 @item @var{file}.cc
1297 @itemx @var{file}.cp
1298 @itemx @var{file}.cxx
1299 @itemx @var{file}.cpp
1300 @itemx @var{file}.CPP
1301 @itemx @var{file}.c++
1302 @itemx @var{file}.C
1303 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1304 the last two letters must both be literally @samp{x}.  Likewise,
1305 @samp{.C} refers to a literal capital C@.
1307 @item @var{file}.mm
1308 @itemx @var{file}.M
1309 Objective-C++ source code that must be preprocessed.
1311 @item @var{file}.mii
1312 Objective-C++ source code that should not be preprocessed.
1314 @item @var{file}.hh
1315 @itemx @var{file}.H
1316 @itemx @var{file}.hp
1317 @itemx @var{file}.hxx
1318 @itemx @var{file}.hpp
1319 @itemx @var{file}.HPP
1320 @itemx @var{file}.h++
1321 @itemx @var{file}.tcc
1322 C++ header file to be turned into a precompiled header or Ada spec.
1324 @item @var{file}.f
1325 @itemx @var{file}.for
1326 @itemx @var{file}.ftn
1327 Fixed form Fortran source code that should not be preprocessed.
1329 @item @var{file}.F
1330 @itemx @var{file}.FOR
1331 @itemx @var{file}.fpp
1332 @itemx @var{file}.FPP
1333 @itemx @var{file}.FTN
1334 Fixed form Fortran source code that must be preprocessed (with the traditional
1335 preprocessor).
1337 @item @var{file}.f90
1338 @itemx @var{file}.f95
1339 @itemx @var{file}.f03
1340 @itemx @var{file}.f08
1341 Free form Fortran source code that should not be preprocessed.
1343 @item @var{file}.F90
1344 @itemx @var{file}.F95
1345 @itemx @var{file}.F03
1346 @itemx @var{file}.F08
1347 Free form Fortran source code that must be preprocessed (with the
1348 traditional preprocessor).
1350 @item @var{file}.go
1351 Go source code.
1353 @item @var{file}.brig
1354 BRIG files (binary representation of HSAIL).
1356 @item @var{file}.ads
1357 Ada source code file that contains a library unit declaration (a
1358 declaration of a package, subprogram, or generic, or a generic
1359 instantiation), or a library unit renaming declaration (a package,
1360 generic, or subprogram renaming declaration).  Such files are also
1361 called @dfn{specs}.
1363 @item @var{file}.adb
1364 Ada source code file containing a library unit body (a subprogram or
1365 package body).  Such files are also called @dfn{bodies}.
1367 @c GCC also knows about some suffixes for languages not yet included:
1368 @c Pascal:
1369 @c @var{file}.p
1370 @c @var{file}.pas
1371 @c Ratfor:
1372 @c @var{file}.r
1374 @item @var{file}.s
1375 Assembler code.
1377 @item @var{file}.S
1378 @itemx @var{file}.sx
1379 Assembler code that must be preprocessed.
1381 @item @var{other}
1382 An object file to be fed straight into linking.
1383 Any file name with no recognized suffix is treated this way.
1384 @end table
1386 @opindex x
1387 You can specify the input language explicitly with the @option{-x} option:
1389 @table @gcctabopt
1390 @item -x @var{language}
1391 Specify explicitly the @var{language} for the following input files
1392 (rather than letting the compiler choose a default based on the file
1393 name suffix).  This option applies to all following input files until
1394 the next @option{-x} option.  Possible values for @var{language} are:
1395 @smallexample
1396 c  c-header  cpp-output
1397 c++  c++-header  c++-cpp-output
1398 objective-c  objective-c-header  objective-c-cpp-output
1399 objective-c++ objective-c++-header objective-c++-cpp-output
1400 assembler  assembler-with-cpp
1402 f77  f77-cpp-input f95  f95-cpp-input
1404 brig
1405 @end smallexample
1407 @item -x none
1408 Turn off any specification of a language, so that subsequent files are
1409 handled according to their file name suffixes (as they are if @option{-x}
1410 has not been used at all).
1411 @end table
1413 If you only want some of the stages of compilation, you can use
1414 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1415 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1416 @command{gcc} is to stop.  Note that some combinations (for example,
1417 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1419 @table @gcctabopt
1420 @item -c
1421 @opindex c
1422 Compile or assemble the source files, but do not link.  The linking
1423 stage simply is not done.  The ultimate output is in the form of an
1424 object file for each source file.
1426 By default, the object file name for a source file is made by replacing
1427 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1429 Unrecognized input files, not requiring compilation or assembly, are
1430 ignored.
1432 @item -S
1433 @opindex S
1434 Stop after the stage of compilation proper; do not assemble.  The output
1435 is in the form of an assembler code file for each non-assembler input
1436 file specified.
1438 By default, the assembler file name for a source file is made by
1439 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1441 Input files that don't require compilation are ignored.
1443 @item -E
1444 @opindex E
1445 Stop after the preprocessing stage; do not run the compiler proper.  The
1446 output is in the form of preprocessed source code, which is sent to the
1447 standard output.
1449 Input files that don't require preprocessing are ignored.
1451 @cindex output file option
1452 @item -o @var{file}
1453 @opindex o
1454 Place output in file @var{file}.  This applies to whatever
1455 sort of output is being produced, whether it be an executable file,
1456 an object file, an assembler file or preprocessed C code.
1458 If @option{-o} is not specified, the default is to put an executable
1459 file in @file{a.out}, the object file for
1460 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1461 assembler file in @file{@var{source}.s}, a precompiled header file in
1462 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1463 standard output.
1465 @item -v
1466 @opindex v
1467 Print (on standard error output) the commands executed to run the stages
1468 of compilation.  Also print the version number of the compiler driver
1469 program and of the preprocessor and the compiler proper.
1471 @item -###
1472 @opindex ###
1473 Like @option{-v} except the commands are not executed and arguments
1474 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1475 This is useful for shell scripts to capture the driver-generated command lines.
1477 @item --help
1478 @opindex help
1479 Print (on the standard output) a description of the command-line options
1480 understood by @command{gcc}.  If the @option{-v} option is also specified
1481 then @option{--help} is also passed on to the various processes
1482 invoked by @command{gcc}, so that they can display the command-line options
1483 they accept.  If the @option{-Wextra} option has also been specified
1484 (prior to the @option{--help} option), then command-line options that
1485 have no documentation associated with them are also displayed.
1487 @item --target-help
1488 @opindex target-help
1489 Print (on the standard output) a description of target-specific command-line
1490 options for each tool.  For some targets extra target-specific
1491 information may also be printed.
1493 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1494 Print (on the standard output) a description of the command-line
1495 options understood by the compiler that fit into all specified classes
1496 and qualifiers.  These are the supported classes:
1498 @table @asis
1499 @item @samp{optimizers}
1500 Display all of the optimization options supported by the
1501 compiler.
1503 @item @samp{warnings}
1504 Display all of the options controlling warning messages
1505 produced by the compiler.
1507 @item @samp{target}
1508 Display target-specific options.  Unlike the
1509 @option{--target-help} option however, target-specific options of the
1510 linker and assembler are not displayed.  This is because those
1511 tools do not currently support the extended @option{--help=} syntax.
1513 @item @samp{params}
1514 Display the values recognized by the @option{--param}
1515 option.
1517 @item @var{language}
1518 Display the options supported for @var{language}, where
1519 @var{language} is the name of one of the languages supported in this
1520 version of GCC@.
1522 @item @samp{common}
1523 Display the options that are common to all languages.
1524 @end table
1526 These are the supported qualifiers:
1528 @table @asis
1529 @item @samp{undocumented}
1530 Display only those options that are undocumented.
1532 @item @samp{joined}
1533 Display options taking an argument that appears after an equal
1534 sign in the same continuous piece of text, such as:
1535 @samp{--help=target}.
1537 @item @samp{separate}
1538 Display options taking an argument that appears as a separate word
1539 following the original option, such as: @samp{-o output-file}.
1540 @end table
1542 Thus for example to display all the undocumented target-specific
1543 switches supported by the compiler, use:
1545 @smallexample
1546 --help=target,undocumented
1547 @end smallexample
1549 The sense of a qualifier can be inverted by prefixing it with the
1550 @samp{^} character, so for example to display all binary warning
1551 options (i.e., ones that are either on or off and that do not take an
1552 argument) that have a description, use:
1554 @smallexample
1555 --help=warnings,^joined,^undocumented
1556 @end smallexample
1558 The argument to @option{--help=} should not consist solely of inverted
1559 qualifiers.
1561 Combining several classes is possible, although this usually
1562 restricts the output so much that there is nothing to display.  One
1563 case where it does work, however, is when one of the classes is
1564 @var{target}.  For example, to display all the target-specific
1565 optimization options, use:
1567 @smallexample
1568 --help=target,optimizers
1569 @end smallexample
1571 The @option{--help=} option can be repeated on the command line.  Each
1572 successive use displays its requested class of options, skipping
1573 those that have already been displayed.
1575 If the @option{-Q} option appears on the command line before the
1576 @option{--help=} option, then the descriptive text displayed by
1577 @option{--help=} is changed.  Instead of describing the displayed
1578 options, an indication is given as to whether the option is enabled,
1579 disabled or set to a specific value (assuming that the compiler
1580 knows this at the point where the @option{--help=} option is used).
1582 Here is a truncated example from the ARM port of @command{gcc}:
1584 @smallexample
1585   % gcc -Q -mabi=2 --help=target -c
1586   The following options are target specific:
1587   -mabi=                                2
1588   -mabort-on-noreturn                   [disabled]
1589   -mapcs                                [disabled]
1590 @end smallexample
1592 The output is sensitive to the effects of previous command-line
1593 options, so for example it is possible to find out which optimizations
1594 are enabled at @option{-O2} by using:
1596 @smallexample
1597 -Q -O2 --help=optimizers
1598 @end smallexample
1600 Alternatively you can discover which binary optimizations are enabled
1601 by @option{-O3} by using:
1603 @smallexample
1604 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1605 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1606 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1607 @end smallexample
1609 @item --version
1610 @opindex version
1611 Display the version number and copyrights of the invoked GCC@.
1613 @item -pass-exit-codes
1614 @opindex pass-exit-codes
1615 Normally the @command{gcc} program exits with the code of 1 if any
1616 phase of the compiler returns a non-success return code.  If you specify
1617 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1618 the numerically highest error produced by any phase returning an error
1619 indication.  The C, C++, and Fortran front ends return 4 if an internal
1620 compiler error is encountered.
1622 @item -pipe
1623 @opindex pipe
1624 Use pipes rather than temporary files for communication between the
1625 various stages of compilation.  This fails to work on some systems where
1626 the assembler is unable to read from a pipe; but the GNU assembler has
1627 no trouble.
1629 @item -specs=@var{file}
1630 @opindex specs
1631 Process @var{file} after the compiler reads in the standard @file{specs}
1632 file, in order to override the defaults which the @command{gcc} driver
1633 program uses when determining what switches to pass to @command{cc1},
1634 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1635 @option{-specs=@var{file}} can be specified on the command line, and they
1636 are processed in order, from left to right.  @xref{Spec Files}, for
1637 information about the format of the @var{file}.
1639 @item -wrapper
1640 @opindex wrapper
1641 Invoke all subcommands under a wrapper program.  The name of the
1642 wrapper program and its parameters are passed as a comma separated
1643 list.
1645 @smallexample
1646 gcc -c t.c -wrapper gdb,--args
1647 @end smallexample
1649 @noindent
1650 This invokes all subprograms of @command{gcc} under
1651 @samp{gdb --args}, thus the invocation of @command{cc1} is
1652 @samp{gdb --args cc1 @dots{}}.
1654 @item -fplugin=@var{name}.so
1655 @opindex fplugin
1656 Load the plugin code in file @var{name}.so, assumed to be a
1657 shared object to be dlopen'd by the compiler.  The base name of
1658 the shared object file is used to identify the plugin for the
1659 purposes of argument parsing (See
1660 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1661 Each plugin should define the callback functions specified in the
1662 Plugins API.
1664 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1665 @opindex fplugin-arg
1666 Define an argument called @var{key} with a value of @var{value}
1667 for the plugin called @var{name}.
1669 @item -fdump-ada-spec@r{[}-slim@r{]}
1670 @opindex fdump-ada-spec
1671 For C and C++ source and include files, generate corresponding Ada specs.
1672 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1673 GNAT User's Guide}, which provides detailed documentation on this feature.
1675 @item -fada-spec-parent=@var{unit}
1676 @opindex fada-spec-parent
1677 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1678 Ada specs as child units of parent @var{unit}.
1680 @item -fdump-go-spec=@var{file}
1681 @opindex fdump-go-spec
1682 For input files in any language, generate corresponding Go
1683 declarations in @var{file}.  This generates Go @code{const},
1684 @code{type}, @code{var}, and @code{func} declarations which may be a
1685 useful way to start writing a Go interface to code written in some
1686 other language.
1688 @include @value{srcdir}/../libiberty/at-file.texi
1689 @end table
1691 @node Invoking G++
1692 @section Compiling C++ Programs
1694 @cindex suffixes for C++ source
1695 @cindex C++ source file suffixes
1696 C++ source files conventionally use one of the suffixes @samp{.C},
1697 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1698 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1699 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1700 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1701 files with these names and compiles them as C++ programs even if you
1702 call the compiler the same way as for compiling C programs (usually
1703 with the name @command{gcc}).
1705 @findex g++
1706 @findex c++
1707 However, the use of @command{gcc} does not add the C++ library.
1708 @command{g++} is a program that calls GCC and automatically specifies linking
1709 against the C++ library.  It treats @samp{.c},
1710 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1711 files unless @option{-x} is used.  This program is also useful when
1712 precompiling a C header file with a @samp{.h} extension for use in C++
1713 compilations.  On many systems, @command{g++} is also installed with
1714 the name @command{c++}.
1716 @cindex invoking @command{g++}
1717 When you compile C++ programs, you may specify many of the same
1718 command-line options that you use for compiling programs in any
1719 language; or command-line options meaningful for C and related
1720 languages; or options that are meaningful only for C++ programs.
1721 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1722 explanations of options for languages related to C@.
1723 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1724 explanations of options that are meaningful only for C++ programs.
1726 @node C Dialect Options
1727 @section Options Controlling C Dialect
1728 @cindex dialect options
1729 @cindex language dialect options
1730 @cindex options, dialect
1732 The following options control the dialect of C (or languages derived
1733 from C, such as C++, Objective-C and Objective-C++) that the compiler
1734 accepts:
1736 @table @gcctabopt
1737 @cindex ANSI support
1738 @cindex ISO support
1739 @item -ansi
1740 @opindex ansi
1741 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1742 equivalent to @option{-std=c++98}.
1744 This turns off certain features of GCC that are incompatible with ISO
1745 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1746 such as the @code{asm} and @code{typeof} keywords, and
1747 predefined macros such as @code{unix} and @code{vax} that identify the
1748 type of system you are using.  It also enables the undesirable and
1749 rarely used ISO trigraph feature.  For the C compiler,
1750 it disables recognition of C++ style @samp{//} comments as well as
1751 the @code{inline} keyword.
1753 The alternate keywords @code{__asm__}, @code{__extension__},
1754 @code{__inline__} and @code{__typeof__} continue to work despite
1755 @option{-ansi}.  You would not want to use them in an ISO C program, of
1756 course, but it is useful to put them in header files that might be included
1757 in compilations done with @option{-ansi}.  Alternate predefined macros
1758 such as @code{__unix__} and @code{__vax__} are also available, with or
1759 without @option{-ansi}.
1761 The @option{-ansi} option does not cause non-ISO programs to be
1762 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1763 addition to @option{-ansi}.  @xref{Warning Options}.
1765 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1766 option is used.  Some header files may notice this macro and refrain
1767 from declaring certain functions or defining certain macros that the
1768 ISO standard doesn't call for; this is to avoid interfering with any
1769 programs that might use these names for other things.
1771 Functions that are normally built in but do not have semantics
1772 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1773 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1774 built-in functions provided by GCC}, for details of the functions
1775 affected.
1777 @item -std=
1778 @opindex std
1779 Determine the language standard. @xref{Standards,,Language Standards
1780 Supported by GCC}, for details of these standard versions.  This option
1781 is currently only supported when compiling C or C++.
1783 The compiler can accept several base standards, such as @samp{c90} or
1784 @samp{c++98}, and GNU dialects of those standards, such as
1785 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1786 compiler accepts all programs following that standard plus those
1787 using GNU extensions that do not contradict it.  For example,
1788 @option{-std=c90} turns off certain features of GCC that are
1789 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1790 keywords, but not other GNU extensions that do not have a meaning in
1791 ISO C90, such as omitting the middle term of a @code{?:}
1792 expression. On the other hand, when a GNU dialect of a standard is
1793 specified, all features supported by the compiler are enabled, even when
1794 those features change the meaning of the base standard.  As a result, some
1795 strict-conforming programs may be rejected.  The particular standard
1796 is used by @option{-Wpedantic} to identify which features are GNU
1797 extensions given that version of the standard. For example
1798 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1799 comments, while @option{-std=gnu99 -Wpedantic} does not.
1801 A value for this option must be provided; possible values are
1803 @table @samp
1804 @item c90
1805 @itemx c89
1806 @itemx iso9899:1990
1807 Support all ISO C90 programs (certain GNU extensions that conflict
1808 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1810 @item iso9899:199409
1811 ISO C90 as modified in amendment 1.
1813 @item c99
1814 @itemx c9x
1815 @itemx iso9899:1999
1816 @itemx iso9899:199x
1817 ISO C99.  This standard is substantially completely supported, modulo
1818 bugs and floating-point issues
1819 (mainly but not entirely relating to optional C99 features from
1820 Annexes F and G).  See
1821 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1822 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1824 @item c11
1825 @itemx c1x
1826 @itemx iso9899:2011
1827 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1828 substantially completely supported, modulo bugs, floating-point issues
1829 (mainly but not entirely relating to optional C11 features from
1830 Annexes F and G) and the optional Annexes K (Bounds-checking
1831 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1833 @item gnu90
1834 @itemx gnu89
1835 GNU dialect of ISO C90 (including some C99 features).
1837 @item gnu99
1838 @itemx gnu9x
1839 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1841 @item gnu11
1842 @itemx gnu1x
1843 GNU dialect of ISO C11.  This is the default for C code.
1844 The name @samp{gnu1x} is deprecated.
1846 @item c++98
1847 @itemx c++03
1848 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1849 additional defect reports. Same as @option{-ansi} for C++ code.
1851 @item gnu++98
1852 @itemx gnu++03
1853 GNU dialect of @option{-std=c++98}.
1855 @item c++11
1856 @itemx c++0x
1857 The 2011 ISO C++ standard plus amendments.
1858 The name @samp{c++0x} is deprecated.
1860 @item gnu++11
1861 @itemx gnu++0x
1862 GNU dialect of @option{-std=c++11}.
1863 The name @samp{gnu++0x} is deprecated.
1865 @item c++14
1866 @itemx c++1y
1867 The 2014 ISO C++ standard plus amendments.
1868 The name @samp{c++1y} is deprecated.
1870 @item gnu++14
1871 @itemx gnu++1y
1872 GNU dialect of @option{-std=c++14}.
1873 This is the default for C++ code.
1874 The name @samp{gnu++1y} is deprecated.
1876 @item c++17
1877 @itemx c++1z
1878 The 2017 ISO C++ standard plus amendments.
1879 The name @samp{c++1z} is deprecated.
1881 @item gnu++17
1882 @itemx gnu++1z
1883 GNU dialect of @option{-std=c++17}.
1884 The name @samp{gnu++1z} is deprecated.
1886 @item c++2a
1887 The next revision of the ISO C++ standard, tentatively planned for
1888 2020.  Support is highly experimental, and will almost certainly
1889 change in incompatible ways in future releases.
1891 @item gnu++2a
1892 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1893 and will almost certainly change in incompatible ways in future
1894 releases.
1895 @end table
1897 @item -fgnu89-inline
1898 @opindex fgnu89-inline
1899 The option @option{-fgnu89-inline} tells GCC to use the traditional
1900 GNU semantics for @code{inline} functions when in C99 mode.
1901 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1902 Using this option is roughly equivalent to adding the
1903 @code{gnu_inline} function attribute to all inline functions
1904 (@pxref{Function Attributes}).
1906 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1907 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1908 specifies the default behavior).
1909 This option is not supported in @option{-std=c90} or
1910 @option{-std=gnu90} mode.
1912 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1913 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1914 in effect for @code{inline} functions.  @xref{Common Predefined
1915 Macros,,,cpp,The C Preprocessor}.
1917 @item -fpermitted-flt-eval-methods=@var{style}
1918 @opindex fpermitted-flt-eval-methods
1919 @opindex fpermitted-flt-eval-methods=c11
1920 @opindex fpermitted-flt-eval-methods=ts-18661-3
1921 ISO/IEC TS 18661-3 defines new permissible values for
1922 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1923 a semantic type that is an interchange or extended format should be
1924 evaluated to the precision and range of that type.  These new values are
1925 a superset of those permitted under C99/C11, which does not specify the
1926 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1927 conforming to C11 may not have been written expecting the possibility of
1928 the new values.
1930 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1931 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1932 or the extended set of values specified in ISO/IEC TS 18661-3.
1934 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1936 The default when in a standards compliant mode (@option{-std=c11} or similar)
1937 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1938 dialect (@option{-std=gnu11} or similar) is
1939 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1941 @item -aux-info @var{filename}
1942 @opindex aux-info
1943 Output to the given filename prototyped declarations for all functions
1944 declared and/or defined in a translation unit, including those in header
1945 files.  This option is silently ignored in any language other than C@.
1947 Besides declarations, the file indicates, in comments, the origin of
1948 each declaration (source file and line), whether the declaration was
1949 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1950 @samp{O} for old, respectively, in the first character after the line
1951 number and the colon), and whether it came from a declaration or a
1952 definition (@samp{C} or @samp{F}, respectively, in the following
1953 character).  In the case of function definitions, a K&R-style list of
1954 arguments followed by their declarations is also provided, inside
1955 comments, after the declaration.
1957 @item -fallow-parameterless-variadic-functions
1958 @opindex fallow-parameterless-variadic-functions
1959 Accept variadic functions without named parameters.
1961 Although it is possible to define such a function, this is not very
1962 useful as it is not possible to read the arguments.  This is only
1963 supported for C as this construct is allowed by C++.
1965 @item -fno-asm
1966 @opindex fno-asm
1967 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1968 keyword, so that code can use these words as identifiers.  You can use
1969 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1970 instead.  @option{-ansi} implies @option{-fno-asm}.
1972 In C++, this switch only affects the @code{typeof} keyword, since
1973 @code{asm} and @code{inline} are standard keywords.  You may want to
1974 use the @option{-fno-gnu-keywords} flag instead, which has the same
1975 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1976 switch only affects the @code{asm} and @code{typeof} keywords, since
1977 @code{inline} is a standard keyword in ISO C99.
1979 @item -fno-builtin
1980 @itemx -fno-builtin-@var{function}
1981 @opindex fno-builtin
1982 @cindex built-in functions
1983 Don't recognize built-in functions that do not begin with
1984 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1985 functions provided by GCC}, for details of the functions affected,
1986 including those which are not built-in functions when @option{-ansi} or
1987 @option{-std} options for strict ISO C conformance are used because they
1988 do not have an ISO standard meaning.
1990 GCC normally generates special code to handle certain built-in functions
1991 more efficiently; for instance, calls to @code{alloca} may become single
1992 instructions which adjust the stack directly, and calls to @code{memcpy}
1993 may become inline copy loops.  The resulting code is often both smaller
1994 and faster, but since the function calls no longer appear as such, you
1995 cannot set a breakpoint on those calls, nor can you change the behavior
1996 of the functions by linking with a different library.  In addition,
1997 when a function is recognized as a built-in function, GCC may use
1998 information about that function to warn about problems with calls to
1999 that function, or to generate more efficient code, even if the
2000 resulting code still contains calls to that function.  For example,
2001 warnings are given with @option{-Wformat} for bad calls to
2002 @code{printf} when @code{printf} is built in and @code{strlen} is
2003 known not to modify global memory.
2005 With the @option{-fno-builtin-@var{function}} option
2006 only the built-in function @var{function} is
2007 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2008 function is named that is not built-in in this version of GCC, this
2009 option is ignored.  There is no corresponding
2010 @option{-fbuiltin-@var{function}} option; if you wish to enable
2011 built-in functions selectively when using @option{-fno-builtin} or
2012 @option{-ffreestanding}, you may define macros such as:
2014 @smallexample
2015 #define abs(n)          __builtin_abs ((n))
2016 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2017 @end smallexample
2019 @item -fgimple
2020 @opindex fgimple
2022 Enable parsing of function definitions marked with @code{__GIMPLE}.
2023 This is an experimental feature that allows unit testing of GIMPLE
2024 passes.
2026 @item -fhosted
2027 @opindex fhosted
2028 @cindex hosted environment
2030 Assert that compilation targets a hosted environment.  This implies
2031 @option{-fbuiltin}.  A hosted environment is one in which the
2032 entire standard library is available, and in which @code{main} has a return
2033 type of @code{int}.  Examples are nearly everything except a kernel.
2034 This is equivalent to @option{-fno-freestanding}.
2036 @item -ffreestanding
2037 @opindex ffreestanding
2038 @cindex hosted environment
2040 Assert that compilation targets a freestanding environment.  This
2041 implies @option{-fno-builtin}.  A freestanding environment
2042 is one in which the standard library may not exist, and program startup may
2043 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2044 This is equivalent to @option{-fno-hosted}.
2046 @xref{Standards,,Language Standards Supported by GCC}, for details of
2047 freestanding and hosted environments.
2049 @item -fopenacc
2050 @opindex fopenacc
2051 @cindex OpenACC accelerator programming
2052 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2053 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2054 compiler generates accelerated code according to the OpenACC Application
2055 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2056 implies @option{-pthread}, and thus is only supported on targets that
2057 have support for @option{-pthread}.
2059 @item -fopenacc-dim=@var{geom}
2060 @opindex fopenacc-dim
2061 @cindex OpenACC accelerator programming
2062 Specify default compute dimensions for parallel offload regions that do
2063 not explicitly specify.  The @var{geom} value is a triple of
2064 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2065 can be omitted, to use a target-specific default value.
2067 @item -fopenmp
2068 @opindex fopenmp
2069 @cindex OpenMP parallel
2070 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2071 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2072 compiler generates parallel code according to the OpenMP Application
2073 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2074 implies @option{-pthread}, and thus is only supported on targets that
2075 have support for @option{-pthread}. @option{-fopenmp} implies
2076 @option{-fopenmp-simd}.
2078 @item -fopenmp-simd
2079 @opindex fopenmp-simd
2080 @cindex OpenMP SIMD
2081 @cindex SIMD
2082 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2083 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2084 are ignored.
2086 @item -fcilkplus
2087 @opindex fcilkplus
2088 @cindex Enable Cilk Plus
2089 Enable the usage of Cilk Plus language extension features for C/C++.
2090 When the option @option{-fcilkplus} is specified, enable the usage of
2091 the Cilk Plus Language extension features for C/C++.  The present
2092 implementation follows ABI version 1.2.  This is an experimental
2093 feature that is only partially complete, and whose interface may
2094 change in future versions of GCC as the official specification
2095 changes.  Currently, all features but @code{_Cilk_for} have been
2096 implemented.
2098 @item -fgnu-tm
2099 @opindex fgnu-tm
2100 When the option @option{-fgnu-tm} is specified, the compiler
2101 generates code for the Linux variant of Intel's current Transactional
2102 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2103 an experimental feature whose interface may change in future versions
2104 of GCC, as the official specification changes.  Please note that not
2105 all architectures are supported for this feature.
2107 For more information on GCC's support for transactional memory,
2108 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2109 Transactional Memory Library}.
2111 Note that the transactional memory feature is not supported with
2112 non-call exceptions (@option{-fnon-call-exceptions}).
2114 @item -fms-extensions
2115 @opindex fms-extensions
2116 Accept some non-standard constructs used in Microsoft header files.
2118 In C++ code, this allows member names in structures to be similar
2119 to previous types declarations.
2121 @smallexample
2122 typedef int UOW;
2123 struct ABC @{
2124   UOW UOW;
2126 @end smallexample
2128 Some cases of unnamed fields in structures and unions are only
2129 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2130 fields within structs/unions}, for details.
2132 Note that this option is off for all targets but x86 
2133 targets using ms-abi.
2135 @item -fplan9-extensions
2136 @opindex fplan9-extensions
2137 Accept some non-standard constructs used in Plan 9 code.
2139 This enables @option{-fms-extensions}, permits passing pointers to
2140 structures with anonymous fields to functions that expect pointers to
2141 elements of the type of the field, and permits referring to anonymous
2142 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2143 struct/union fields within structs/unions}, for details.  This is only
2144 supported for C, not C++.
2146 @item -fcond-mismatch
2147 @opindex fcond-mismatch
2148 Allow conditional expressions with mismatched types in the second and
2149 third arguments.  The value of such an expression is void.  This option
2150 is not supported for C++.
2152 @item -flax-vector-conversions
2153 @opindex flax-vector-conversions
2154 Allow implicit conversions between vectors with differing numbers of
2155 elements and/or incompatible element types.  This option should not be
2156 used for new code.
2158 @item -funsigned-char
2159 @opindex funsigned-char
2160 Let the type @code{char} be unsigned, like @code{unsigned char}.
2162 Each kind of machine has a default for what @code{char} should
2163 be.  It is either like @code{unsigned char} by default or like
2164 @code{signed char} by default.
2166 Ideally, a portable program should always use @code{signed char} or
2167 @code{unsigned char} when it depends on the signedness of an object.
2168 But many programs have been written to use plain @code{char} and
2169 expect it to be signed, or expect it to be unsigned, depending on the
2170 machines they were written for.  This option, and its inverse, let you
2171 make such a program work with the opposite default.
2173 The type @code{char} is always a distinct type from each of
2174 @code{signed char} or @code{unsigned char}, even though its behavior
2175 is always just like one of those two.
2177 @item -fsigned-char
2178 @opindex fsigned-char
2179 Let the type @code{char} be signed, like @code{signed char}.
2181 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2182 the negative form of @option{-funsigned-char}.  Likewise, the option
2183 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2185 @item -fsigned-bitfields
2186 @itemx -funsigned-bitfields
2187 @itemx -fno-signed-bitfields
2188 @itemx -fno-unsigned-bitfields
2189 @opindex fsigned-bitfields
2190 @opindex funsigned-bitfields
2191 @opindex fno-signed-bitfields
2192 @opindex fno-unsigned-bitfields
2193 These options control whether a bit-field is signed or unsigned, when the
2194 declaration does not use either @code{signed} or @code{unsigned}.  By
2195 default, such a bit-field is signed, because this is consistent: the
2196 basic integer types such as @code{int} are signed types.
2198 @item -fsso-struct=@var{endianness}
2199 @opindex fsso-struct
2200 Set the default scalar storage order of structures and unions to the
2201 specified endianness.  The accepted values are @samp{big-endian},
2202 @samp{little-endian} and @samp{native} for the native endianness of
2203 the target (the default).  This option is not supported for C++.
2205 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2206 code that is not binary compatible with code generated without it if the
2207 specified endianness is not the native endianness of the target.
2208 @end table
2210 @node C++ Dialect Options
2211 @section Options Controlling C++ Dialect
2213 @cindex compiler options, C++
2214 @cindex C++ options, command-line
2215 @cindex options, C++
2216 This section describes the command-line options that are only meaningful
2217 for C++ programs.  You can also use most of the GNU compiler options
2218 regardless of what language your program is in.  For example, you
2219 might compile a file @file{firstClass.C} like this:
2221 @smallexample
2222 g++ -g -fstrict-enums -O -c firstClass.C
2223 @end smallexample
2225 @noindent
2226 In this example, only @option{-fstrict-enums} is an option meant
2227 only for C++ programs; you can use the other options with any
2228 language supported by GCC@.
2230 Some options for compiling C programs, such as @option{-std}, are also
2231 relevant for C++ programs.
2232 @xref{C Dialect Options,,Options Controlling C Dialect}.
2234 Here is a list of options that are @emph{only} for compiling C++ programs:
2236 @table @gcctabopt
2238 @item -fabi-version=@var{n}
2239 @opindex fabi-version
2240 Use version @var{n} of the C++ ABI@.  The default is version 0.
2242 Version 0 refers to the version conforming most closely to
2243 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2244 will change in different versions of G++ as ABI bugs are fixed.
2246 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2248 Version 2 is the version of the C++ ABI that first appeared in G++
2249 3.4, and was the default through G++ 4.9.
2251 Version 3 corrects an error in mangling a constant address as a
2252 template argument.
2254 Version 4, which first appeared in G++ 4.5, implements a standard
2255 mangling for vector types.
2257 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2258 attribute const/volatile on function pointer types, decltype of a
2259 plain decl, and use of a function parameter in the declaration of
2260 another parameter.
2262 Version 6, which first appeared in G++ 4.7, corrects the promotion
2263 behavior of C++11 scoped enums and the mangling of template argument
2264 packs, const/static_cast, prefix ++ and --, and a class scope function
2265 used as a template argument.
2267 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2268 builtin type and corrects the mangling of lambdas in default argument
2269 scope.
2271 Version 8, which first appeared in G++ 4.9, corrects the substitution
2272 behavior of function types with function-cv-qualifiers.
2274 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2275 @code{nullptr_t}.
2277 Version 10, which first appeared in G++ 6.1, adds mangling of
2278 attributes that affect type identity, such as ia32 calling convention
2279 attributes (e.g. @samp{stdcall}).
2281 Version 11, which first appeared in G++ 7, corrects the mangling of
2282 sizeof... expressions and operator names.  For multiple entities with
2283 the same name within a function, that are declared in different scopes,
2284 the mangling now changes starting with the twelfth occurrence.  It also
2285 implies @option{-fnew-inheriting-ctors}.
2287 See also @option{-Wabi}.
2289 @item -fabi-compat-version=@var{n}
2290 @opindex fabi-compat-version
2291 On targets that support strong aliases, G++
2292 works around mangling changes by creating an alias with the correct
2293 mangled name when defining a symbol with an incorrect mangled name.
2294 This switch specifies which ABI version to use for the alias.
2296 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2297 compatibility).  If another ABI version is explicitly selected, this
2298 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2299 use @option{-fabi-compat-version=2}.
2301 If this option is not provided but @option{-Wabi=@var{n}} is, that
2302 version is used for compatibility aliases.  If this option is provided
2303 along with @option{-Wabi} (without the version), the version from this
2304 option is used for the warning.
2306 @item -fno-access-control
2307 @opindex fno-access-control
2308 Turn off all access checking.  This switch is mainly useful for working
2309 around bugs in the access control code.
2311 @item -faligned-new
2312 @opindex faligned-new
2313 Enable support for C++17 @code{new} of types that require more
2314 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2315 numeric argument such as @code{-faligned-new=32} can be used to
2316 specify how much alignment (in bytes) is provided by that function,
2317 but few users will need to override the default of
2318 @code{alignof(std::max_align_t)}.
2320 This flag is enabled by default for @option{-std=c++17}.
2322 @item -fcheck-new
2323 @opindex fcheck-new
2324 Check that the pointer returned by @code{operator new} is non-null
2325 before attempting to modify the storage allocated.  This check is
2326 normally unnecessary because the C++ standard specifies that
2327 @code{operator new} only returns @code{0} if it is declared
2328 @code{throw()}, in which case the compiler always checks the
2329 return value even without this option.  In all other cases, when
2330 @code{operator new} has a non-empty exception specification, memory
2331 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2332 @samp{new (nothrow)}.
2334 @item -fconcepts
2335 @opindex fconcepts
2336 Enable support for the C++ Extensions for Concepts Technical
2337 Specification, ISO 19217 (2015), which allows code like
2339 @smallexample
2340 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2341 template <Addable T> T add (T a, T b) @{ return a + b; @}
2342 @end smallexample
2344 @item -fconstexpr-depth=@var{n}
2345 @opindex fconstexpr-depth
2346 Set the maximum nested evaluation depth for C++11 constexpr functions
2347 to @var{n}.  A limit is needed to detect endless recursion during
2348 constant expression evaluation.  The minimum specified by the standard
2349 is 512.
2351 @item -fconstexpr-loop-limit=@var{n}
2352 @opindex fconstexpr-loop-limit
2353 Set the maximum number of iterations for a loop in C++14 constexpr functions
2354 to @var{n}.  A limit is needed to detect infinite loops during
2355 constant expression evaluation.  The default is 262144 (1<<18).
2357 @item -fdeduce-init-list
2358 @opindex fdeduce-init-list
2359 Enable deduction of a template type parameter as
2360 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2362 @smallexample
2363 template <class T> auto forward(T t) -> decltype (realfn (t))
2365   return realfn (t);
2368 void f()
2370   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2372 @end smallexample
2374 This deduction was implemented as a possible extension to the
2375 originally proposed semantics for the C++11 standard, but was not part
2376 of the final standard, so it is disabled by default.  This option is
2377 deprecated, and may be removed in a future version of G++.
2379 @item -ffriend-injection
2380 @opindex ffriend-injection
2381 Inject friend functions into the enclosing namespace, so that they are
2382 visible outside the scope of the class in which they are declared.
2383 Friend functions were documented to work this way in the old Annotated
2384 C++ Reference Manual.  
2385 However, in ISO C++ a friend function that is not declared
2386 in an enclosing scope can only be found using argument dependent
2387 lookup.  GCC defaults to the standard behavior.
2389 This option is for compatibility, and may be removed in a future
2390 release of G++.
2392 @item -fno-elide-constructors
2393 @opindex fno-elide-constructors
2394 The C++ standard allows an implementation to omit creating a temporary
2395 that is only used to initialize another object of the same type.
2396 Specifying this option disables that optimization, and forces G++ to
2397 call the copy constructor in all cases.  This option also causes G++
2398 to call trivial member functions which otherwise would be expanded inline.
2400 In C++17, the compiler is required to omit these temporaries, but this
2401 option still affects trivial member functions.
2403 @item -fno-enforce-eh-specs
2404 @opindex fno-enforce-eh-specs
2405 Don't generate code to check for violation of exception specifications
2406 at run time.  This option violates the C++ standard, but may be useful
2407 for reducing code size in production builds, much like defining
2408 @code{NDEBUG}.  This does not give user code permission to throw
2409 exceptions in violation of the exception specifications; the compiler
2410 still optimizes based on the specifications, so throwing an
2411 unexpected exception results in undefined behavior at run time.
2413 @item -fextern-tls-init
2414 @itemx -fno-extern-tls-init
2415 @opindex fextern-tls-init
2416 @opindex fno-extern-tls-init
2417 The C++11 and OpenMP standards allow @code{thread_local} and
2418 @code{threadprivate} variables to have dynamic (runtime)
2419 initialization.  To support this, any use of such a variable goes
2420 through a wrapper function that performs any necessary initialization.
2421 When the use and definition of the variable are in the same
2422 translation unit, this overhead can be optimized away, but when the
2423 use is in a different translation unit there is significant overhead
2424 even if the variable doesn't actually need dynamic initialization.  If
2425 the programmer can be sure that no use of the variable in a
2426 non-defining TU needs to trigger dynamic initialization (either
2427 because the variable is statically initialized, or a use of the
2428 variable in the defining TU will be executed before any uses in
2429 another TU), they can avoid this overhead with the
2430 @option{-fno-extern-tls-init} option.
2432 On targets that support symbol aliases, the default is
2433 @option{-fextern-tls-init}.  On targets that do not support symbol
2434 aliases, the default is @option{-fno-extern-tls-init}.
2436 @item -ffor-scope
2437 @itemx -fno-for-scope
2438 @opindex ffor-scope
2439 @opindex fno-for-scope
2440 If @option{-ffor-scope} is specified, the scope of variables declared in
2441 a @i{for-init-statement} is limited to the @code{for} loop itself,
2442 as specified by the C++ standard.
2443 If @option{-fno-for-scope} is specified, the scope of variables declared in
2444 a @i{for-init-statement} extends to the end of the enclosing scope,
2445 as was the case in old versions of G++, and other (traditional)
2446 implementations of C++.
2448 If neither flag is given, the default is to follow the standard,
2449 but to allow and give a warning for old-style code that would
2450 otherwise be invalid, or have different behavior.
2452 @item -fno-gnu-keywords
2453 @opindex fno-gnu-keywords
2454 Do not recognize @code{typeof} as a keyword, so that code can use this
2455 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2456 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2457 @option{-std=c++98}, @option{-std=c++11}, etc.
2459 @item -fno-implicit-templates
2460 @opindex fno-implicit-templates
2461 Never emit code for non-inline templates that are instantiated
2462 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2463 @xref{Template Instantiation}, for more information.
2465 @item -fno-implicit-inline-templates
2466 @opindex fno-implicit-inline-templates
2467 Don't emit code for implicit instantiations of inline templates, either.
2468 The default is to handle inlines differently so that compiles with and
2469 without optimization need the same set of explicit instantiations.
2471 @item -fno-implement-inlines
2472 @opindex fno-implement-inlines
2473 To save space, do not emit out-of-line copies of inline functions
2474 controlled by @code{#pragma implementation}.  This causes linker
2475 errors if these functions are not inlined everywhere they are called.
2477 @item -fms-extensions
2478 @opindex fms-extensions
2479 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2480 int and getting a pointer to member function via non-standard syntax.
2482 @item -fnew-inheriting-ctors
2483 @opindex fnew-inheriting-ctors
2484 Enable the P0136 adjustment to the semantics of C++11 constructor
2485 inheritance.  This is part of C++17 but also considered to be a Defect
2486 Report against C++11 and C++14.  This flag is enabled by default
2487 unless @option{-fabi-version=10} or lower is specified.
2489 @item -fnew-ttp-matching
2490 @opindex fnew-ttp-matching
2491 Enable the P0522 resolution to Core issue 150, template template
2492 parameters and default arguments: this allows a template with default
2493 template arguments as an argument for a template template parameter
2494 with fewer template parameters.  This flag is enabled by default for
2495 @option{-std=c++17}.
2497 @item -fno-nonansi-builtins
2498 @opindex fno-nonansi-builtins
2499 Disable built-in declarations of functions that are not mandated by
2500 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2501 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2503 @item -fnothrow-opt
2504 @opindex fnothrow-opt
2505 Treat a @code{throw()} exception specification as if it were a
2506 @code{noexcept} specification to reduce or eliminate the text size
2507 overhead relative to a function with no exception specification.  If
2508 the function has local variables of types with non-trivial
2509 destructors, the exception specification actually makes the
2510 function smaller because the EH cleanups for those variables can be
2511 optimized away.  The semantic effect is that an exception thrown out of
2512 a function with such an exception specification results in a call
2513 to @code{terminate} rather than @code{unexpected}.
2515 @item -fno-operator-names
2516 @opindex fno-operator-names
2517 Do not treat the operator name keywords @code{and}, @code{bitand},
2518 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2519 synonyms as keywords.
2521 @item -fno-optional-diags
2522 @opindex fno-optional-diags
2523 Disable diagnostics that the standard says a compiler does not need to
2524 issue.  Currently, the only such diagnostic issued by G++ is the one for
2525 a name having multiple meanings within a class.
2527 @item -fpermissive
2528 @opindex fpermissive
2529 Downgrade some diagnostics about nonconformant code from errors to
2530 warnings.  Thus, using @option{-fpermissive} allows some
2531 nonconforming code to compile.
2533 @item -fno-pretty-templates
2534 @opindex fno-pretty-templates
2535 When an error message refers to a specialization of a function
2536 template, the compiler normally prints the signature of the
2537 template followed by the template arguments and any typedefs or
2538 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2539 rather than @code{void f(int)}) so that it's clear which template is
2540 involved.  When an error message refers to a specialization of a class
2541 template, the compiler omits any template arguments that match
2542 the default template arguments for that template.  If either of these
2543 behaviors make it harder to understand the error message rather than
2544 easier, you can use @option{-fno-pretty-templates} to disable them.
2546 @item -frepo
2547 @opindex frepo
2548 Enable automatic template instantiation at link time.  This option also
2549 implies @option{-fno-implicit-templates}.  @xref{Template
2550 Instantiation}, for more information.
2552 @item -fno-rtti
2553 @opindex fno-rtti
2554 Disable generation of information about every class with virtual
2555 functions for use by the C++ run-time type identification features
2556 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2557 of the language, you can save some space by using this flag.  Note that
2558 exception handling uses the same information, but G++ generates it as
2559 needed. The @code{dynamic_cast} operator can still be used for casts that
2560 do not require run-time type information, i.e.@: casts to @code{void *} or to
2561 unambiguous base classes.
2563 @item -fsized-deallocation
2564 @opindex fsized-deallocation
2565 Enable the built-in global declarations
2566 @smallexample
2567 void operator delete (void *, std::size_t) noexcept;
2568 void operator delete[] (void *, std::size_t) noexcept;
2569 @end smallexample
2570 as introduced in C++14.  This is useful for user-defined replacement
2571 deallocation functions that, for example, use the size of the object
2572 to make deallocation faster.  Enabled by default under
2573 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2574 warns about places that might want to add a definition.
2576 @item -fstrict-enums
2577 @opindex fstrict-enums
2578 Allow the compiler to optimize using the assumption that a value of
2579 enumerated type can only be one of the values of the enumeration (as
2580 defined in the C++ standard; basically, a value that can be
2581 represented in the minimum number of bits needed to represent all the
2582 enumerators).  This assumption may not be valid if the program uses a
2583 cast to convert an arbitrary integer value to the enumerated type.
2585 @item -fstrong-eval-order
2586 @opindex fstrong-eval-order
2587 Evaluate member access, array subscripting, and shift expressions in
2588 left-to-right order, and evaluate assignment in right-to-left order,
2589 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2590 @option{-fstrong-eval-order=some} enables just the ordering of member
2591 access and shift expressions, and is the default without
2592 @option{-std=c++17}.
2594 @item -ftemplate-backtrace-limit=@var{n}
2595 @opindex ftemplate-backtrace-limit
2596 Set the maximum number of template instantiation notes for a single
2597 warning or error to @var{n}.  The default value is 10.
2599 @item -ftemplate-depth=@var{n}
2600 @opindex ftemplate-depth
2601 Set the maximum instantiation depth for template classes to @var{n}.
2602 A limit on the template instantiation depth is needed to detect
2603 endless recursions during template class instantiation.  ANSI/ISO C++
2604 conforming programs must not rely on a maximum depth greater than 17
2605 (changed to 1024 in C++11).  The default value is 900, as the compiler
2606 can run out of stack space before hitting 1024 in some situations.
2608 @item -fno-threadsafe-statics
2609 @opindex fno-threadsafe-statics
2610 Do not emit the extra code to use the routines specified in the C++
2611 ABI for thread-safe initialization of local statics.  You can use this
2612 option to reduce code size slightly in code that doesn't need to be
2613 thread-safe.
2615 @item -fuse-cxa-atexit
2616 @opindex fuse-cxa-atexit
2617 Register destructors for objects with static storage duration with the
2618 @code{__cxa_atexit} function rather than the @code{atexit} function.
2619 This option is required for fully standards-compliant handling of static
2620 destructors, but only works if your C library supports
2621 @code{__cxa_atexit}.
2623 @item -fno-use-cxa-get-exception-ptr
2624 @opindex fno-use-cxa-get-exception-ptr
2625 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2626 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2627 if the runtime routine is not available.
2629 @item -fvisibility-inlines-hidden
2630 @opindex fvisibility-inlines-hidden
2631 This switch declares that the user does not attempt to compare
2632 pointers to inline functions or methods where the addresses of the two functions
2633 are taken in different shared objects.
2635 The effect of this is that GCC may, effectively, mark inline methods with
2636 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2637 appear in the export table of a DSO and do not require a PLT indirection
2638 when used within the DSO@.  Enabling this option can have a dramatic effect
2639 on load and link times of a DSO as it massively reduces the size of the
2640 dynamic export table when the library makes heavy use of templates.
2642 The behavior of this switch is not quite the same as marking the
2643 methods as hidden directly, because it does not affect static variables
2644 local to the function or cause the compiler to deduce that
2645 the function is defined in only one shared object.
2647 You may mark a method as having a visibility explicitly to negate the
2648 effect of the switch for that method.  For example, if you do want to
2649 compare pointers to a particular inline method, you might mark it as
2650 having default visibility.  Marking the enclosing class with explicit
2651 visibility has no effect.
2653 Explicitly instantiated inline methods are unaffected by this option
2654 as their linkage might otherwise cross a shared library boundary.
2655 @xref{Template Instantiation}.
2657 @item -fvisibility-ms-compat
2658 @opindex fvisibility-ms-compat
2659 This flag attempts to use visibility settings to make GCC's C++
2660 linkage model compatible with that of Microsoft Visual Studio.
2662 The flag makes these changes to GCC's linkage model:
2664 @enumerate
2665 @item
2666 It sets the default visibility to @code{hidden}, like
2667 @option{-fvisibility=hidden}.
2669 @item
2670 Types, but not their members, are not hidden by default.
2672 @item
2673 The One Definition Rule is relaxed for types without explicit
2674 visibility specifications that are defined in more than one
2675 shared object: those declarations are permitted if they are
2676 permitted when this option is not used.
2677 @end enumerate
2679 In new code it is better to use @option{-fvisibility=hidden} and
2680 export those classes that are intended to be externally visible.
2681 Unfortunately it is possible for code to rely, perhaps accidentally,
2682 on the Visual Studio behavior.
2684 Among the consequences of these changes are that static data members
2685 of the same type with the same name but defined in different shared
2686 objects are different, so changing one does not change the other;
2687 and that pointers to function members defined in different shared
2688 objects may not compare equal.  When this flag is given, it is a
2689 violation of the ODR to define types with the same name differently.
2691 @item -fno-weak
2692 @opindex fno-weak
2693 Do not use weak symbol support, even if it is provided by the linker.
2694 By default, G++ uses weak symbols if they are available.  This
2695 option exists only for testing, and should not be used by end-users;
2696 it results in inferior code and has no benefits.  This option may
2697 be removed in a future release of G++.
2699 @item -nostdinc++
2700 @opindex nostdinc++
2701 Do not search for header files in the standard directories specific to
2702 C++, but do still search the other standard directories.  (This option
2703 is used when building the C++ library.)
2704 @end table
2706 In addition, these optimization, warning, and code generation options
2707 have meanings only for C++ programs:
2709 @table @gcctabopt
2710 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2711 @opindex Wabi
2712 @opindex Wno-abi
2713 Warn when G++ it generates code that is probably not compatible with
2714 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2715 ABI with each major release, normally @option{-Wabi} will warn only if
2716 there is a check added later in a release series for an ABI issue
2717 discovered since the initial release.  @option{-Wabi} will warn about
2718 more things if an older ABI version is selected (with
2719 @option{-fabi-version=@var{n}}).
2721 @option{-Wabi} can also be used with an explicit version number to
2722 warn about compatibility with a particular @option{-fabi-version}
2723 level, e.g. @option{-Wabi=2} to warn about changes relative to
2724 @option{-fabi-version=2}.
2726 If an explicit version number is provided and
2727 @option{-fabi-compat-version} is not specified, the version number
2728 from this option is used for compatibility aliases.  If no explicit
2729 version number is provided with this option, but
2730 @option{-fabi-compat-version} is specified, that version number is
2731 used for ABI warnings.
2733 Although an effort has been made to warn about
2734 all such cases, there are probably some cases that are not warned about,
2735 even though G++ is generating incompatible code.  There may also be
2736 cases where warnings are emitted even though the code that is generated
2737 is compatible.
2739 You should rewrite your code to avoid these warnings if you are
2740 concerned about the fact that code generated by G++ may not be binary
2741 compatible with code generated by other compilers.
2743 Known incompatibilities in @option{-fabi-version=2} (which was the
2744 default from GCC 3.4 to 4.9) include:
2746 @itemize @bullet
2748 @item
2749 A template with a non-type template parameter of reference type was
2750 mangled incorrectly:
2751 @smallexample
2752 extern int N;
2753 template <int &> struct S @{@};
2754 void n (S<N>) @{2@}
2755 @end smallexample
2757 This was fixed in @option{-fabi-version=3}.
2759 @item
2760 SIMD vector types declared using @code{__attribute ((vector_size))} were
2761 mangled in a non-standard way that does not allow for overloading of
2762 functions taking vectors of different sizes.
2764 The mangling was changed in @option{-fabi-version=4}.
2766 @item
2767 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2768 qualifiers, and @code{decltype} of a plain declaration was folded away.
2770 These mangling issues were fixed in @option{-fabi-version=5}.
2772 @item
2773 Scoped enumerators passed as arguments to a variadic function are
2774 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2775 On most targets this does not actually affect the parameter passing
2776 ABI, as there is no way to pass an argument smaller than @code{int}.
2778 Also, the ABI changed the mangling of template argument packs,
2779 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2780 a class scope function used as a template argument.
2782 These issues were corrected in @option{-fabi-version=6}.
2784 @item
2785 Lambdas in default argument scope were mangled incorrectly, and the
2786 ABI changed the mangling of @code{nullptr_t}.
2788 These issues were corrected in @option{-fabi-version=7}.
2790 @item
2791 When mangling a function type with function-cv-qualifiers, the
2792 un-qualified function type was incorrectly treated as a substitution
2793 candidate.
2795 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2797 @item
2798 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2799 unaligned accesses.  Note that this did not affect the ABI of a
2800 function with a @code{nullptr_t} parameter, as parameters have a
2801 minimum alignment.
2803 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2805 @item
2806 Target-specific attributes that affect the identity of a type, such as
2807 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2808 did not affect the mangled name, leading to name collisions when
2809 function pointers were used as template arguments.
2811 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2813 @end itemize
2815 It also warns about psABI-related changes.  The known psABI changes at this
2816 point include:
2818 @itemize @bullet
2820 @item
2821 For SysV/x86-64, unions with @code{long double} members are 
2822 passed in memory as specified in psABI.  For example:
2824 @smallexample
2825 union U @{
2826   long double ld;
2827   int i;
2829 @end smallexample
2831 @noindent
2832 @code{union U} is always passed in memory.
2834 @end itemize
2836 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2837 @opindex Wabi-tag
2838 @opindex -Wabi-tag
2839 Warn when a type with an ABI tag is used in a context that does not
2840 have that ABI tag.  See @ref{C++ Attributes} for more information
2841 about ABI tags.
2843 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2844 @opindex Wctor-dtor-privacy
2845 @opindex Wno-ctor-dtor-privacy
2846 Warn when a class seems unusable because all the constructors or
2847 destructors in that class are private, and it has neither friends nor
2848 public static member functions.  Also warn if there are no non-private
2849 methods, and there's at least one private member function that isn't
2850 a constructor or destructor.
2852 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2853 @opindex Wdelete-non-virtual-dtor
2854 @opindex Wno-delete-non-virtual-dtor
2855 Warn when @code{delete} is used to destroy an instance of a class that
2856 has virtual functions and non-virtual destructor. It is unsafe to delete
2857 an instance of a derived class through a pointer to a base class if the
2858 base class does not have a virtual destructor.  This warning is enabled
2859 by @option{-Wall}.
2861 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2862 @opindex Wliteral-suffix
2863 @opindex Wno-literal-suffix
2864 Warn when a string or character literal is followed by a ud-suffix which does
2865 not begin with an underscore.  As a conforming extension, GCC treats such
2866 suffixes as separate preprocessing tokens in order to maintain backwards
2867 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2868 For example:
2870 @smallexample
2871 #define __STDC_FORMAT_MACROS
2872 #include <inttypes.h>
2873 #include <stdio.h>
2875 int main() @{
2876   int64_t i64 = 123;
2877   printf("My int64: %" PRId64"\n", i64);
2879 @end smallexample
2881 In this case, @code{PRId64} is treated as a separate preprocessing token.
2883 Additionally, warn when a user-defined literal operator is declared with
2884 a literal suffix identifier that doesn't begin with an underscore. Literal
2885 suffix identifiers that don't begin with an underscore are reserved for
2886 future standardization.
2888 This warning is enabled by default.
2890 @item -Wlto-type-mismatch
2891 @opindex Wlto-type-mismatch
2892 @opindex Wno-lto-type-mismatch
2894 During the link-time optimization warn about type mismatches in
2895 global declarations from different compilation units.
2896 Requires @option{-flto} to be enabled.  Enabled by default.
2898 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2899 @opindex Wnarrowing
2900 @opindex Wno-narrowing
2901 For C++11 and later standards, narrowing conversions are diagnosed by default,
2902 as required by the standard.  A narrowing conversion from a constant produces
2903 an error, and a narrowing conversion from a non-constant produces a warning,
2904 but @option{-Wno-narrowing} suppresses the diagnostic.
2905 Note that this does not affect the meaning of well-formed code;
2906 narrowing conversions are still considered ill-formed in SFINAE contexts.
2908 With @option{-Wnarrowing} in C++98, warn when a narrowing
2909 conversion prohibited by C++11 occurs within
2910 @samp{@{ @}}, e.g.
2912 @smallexample
2913 int i = @{ 2.2 @}; // error: narrowing from double to int
2914 @end smallexample
2916 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2918 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2919 @opindex Wnoexcept
2920 @opindex Wno-noexcept
2921 Warn when a noexcept-expression evaluates to false because of a call
2922 to a function that does not have a non-throwing exception
2923 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2924 the compiler to never throw an exception.
2926 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2927 @opindex Wnoexcept-type
2928 @opindex Wno-noexcept-type
2929 Warn if the C++17 feature making @code{noexcept} part of a function
2930 type changes the mangled name of a symbol relative to C++14.  Enabled
2931 by @option{-Wabi} and @option{-Wc++17-compat}.
2933 @smallexample
2934 template <class T> void f(T t) @{ t(); @};
2935 void g() noexcept;
2936 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2937 @end smallexample
2939 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2940 @opindex Wclass-memaccess
2941 Warn when the destination of a call to a raw memory function such as
2942 @code{memset} or @code{memcpy} is an object of class type writing into which
2943 might bypass the class non-trivial or deleted constructor or copy assignment,
2944 violate const-correctness or encapsulation, or corrupt the virtual table.
2945 Modifying the representation of such objects may violate invariants maintained
2946 by member functions of the class.  For example, the call to @code{memset}
2947 below is undefined becase it modifies a non-trivial class object and is,
2948 therefore, diagnosed.  The safe way to either initialize or clear the storage
2949 of objects of such types is by using the appropriate constructor or assignment
2950 operator, if one is available.
2951 @smallexample
2952 std::string str = "abc";
2953 memset (&str, 0, 3);
2954 @end smallexample
2955 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2957 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2958 @opindex Wnon-virtual-dtor
2959 @opindex Wno-non-virtual-dtor
2960 Warn when a class has virtual functions and an accessible non-virtual
2961 destructor itself or in an accessible polymorphic base class, in which
2962 case it is possible but unsafe to delete an instance of a derived
2963 class through a pointer to the class itself or base class.  This
2964 warning is automatically enabled if @option{-Weffc++} is specified.
2966 @item -Wregister @r{(C++ and Objective-C++ only)}
2967 @opindex Wregister
2968 @opindex Wno-register
2969 Warn on uses of the @code{register} storage class specifier, except
2970 when it is part of the GNU @ref{Explicit Register Variables} extension.
2971 The use of the @code{register} keyword as storage class specifier has
2972 been deprecated in C++11 and removed in C++17.
2973 Enabled by default with @option{-std=c++17}.
2975 @item -Wreorder @r{(C++ and Objective-C++ only)}
2976 @opindex Wreorder
2977 @opindex Wno-reorder
2978 @cindex reordering, warning
2979 @cindex warning for reordering of member initializers
2980 Warn when the order of member initializers given in the code does not
2981 match the order in which they must be executed.  For instance:
2983 @smallexample
2984 struct A @{
2985   int i;
2986   int j;
2987   A(): j (0), i (1) @{ @}
2989 @end smallexample
2991 @noindent
2992 The compiler rearranges the member initializers for @code{i}
2993 and @code{j} to match the declaration order of the members, emitting
2994 a warning to that effect.  This warning is enabled by @option{-Wall}.
2996 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2997 @opindex fext-numeric-literals
2998 @opindex fno-ext-numeric-literals
2999 Accept imaginary, fixed-point, or machine-defined
3000 literal number suffixes as GNU extensions.
3001 When this option is turned off these suffixes are treated
3002 as C++11 user-defined literal numeric suffixes.
3003 This is on by default for all pre-C++11 dialects and all GNU dialects:
3004 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3005 @option{-std=gnu++14}.
3006 This option is off by default
3007 for ISO C++11 onwards (@option{-std=c++11}, ...).
3008 @end table
3010 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3012 @table @gcctabopt
3013 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3014 @opindex Weffc++
3015 @opindex Wno-effc++
3016 Warn about violations of the following style guidelines from Scott Meyers'
3017 @cite{Effective C++} series of books:
3019 @itemize @bullet
3020 @item
3021 Define a copy constructor and an assignment operator for classes
3022 with dynamically-allocated memory.
3024 @item
3025 Prefer initialization to assignment in constructors.
3027 @item
3028 Have @code{operator=} return a reference to @code{*this}.
3030 @item
3031 Don't try to return a reference when you must return an object.
3033 @item
3034 Distinguish between prefix and postfix forms of increment and
3035 decrement operators.
3037 @item
3038 Never overload @code{&&}, @code{||}, or @code{,}.
3040 @end itemize
3042 This option also enables @option{-Wnon-virtual-dtor}, which is also
3043 one of the effective C++ recommendations.  However, the check is
3044 extended to warn about the lack of virtual destructor in accessible
3045 non-polymorphic bases classes too.
3047 When selecting this option, be aware that the standard library
3048 headers do not obey all of these guidelines; use @samp{grep -v}
3049 to filter out those warnings.
3051 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3052 @opindex Wstrict-null-sentinel
3053 @opindex Wno-strict-null-sentinel
3054 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3055 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3056 to @code{__null}.  Although it is a null pointer constant rather than a
3057 null pointer, it is guaranteed to be of the same size as a pointer.
3058 But this use is not portable across different compilers.
3060 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3061 @opindex Wno-non-template-friend
3062 @opindex Wnon-template-friend
3063 Disable warnings when non-template friend functions are declared
3064 within a template.  In very old versions of GCC that predate implementation
3065 of the ISO standard, declarations such as 
3066 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3067 could be interpreted as a particular specialization of a template
3068 function; the warning exists to diagnose compatibility problems, 
3069 and is enabled by default.
3071 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3072 @opindex Wold-style-cast
3073 @opindex Wno-old-style-cast
3074 Warn if an old-style (C-style) cast to a non-void type is used within
3075 a C++ program.  The new-style casts (@code{dynamic_cast},
3076 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3077 less vulnerable to unintended effects and much easier to search for.
3079 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3080 @opindex Woverloaded-virtual
3081 @opindex Wno-overloaded-virtual
3082 @cindex overloaded virtual function, warning
3083 @cindex warning for overloaded virtual function
3084 Warn when a function declaration hides virtual functions from a
3085 base class.  For example, in:
3087 @smallexample
3088 struct A @{
3089   virtual void f();
3092 struct B: public A @{
3093   void f(int);
3095 @end smallexample
3097 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3098 like:
3100 @smallexample
3101 B* b;
3102 b->f();
3103 @end smallexample
3105 @noindent
3106 fails to compile.
3108 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3109 @opindex Wno-pmf-conversions
3110 @opindex Wpmf-conversions
3111 Disable the diagnostic for converting a bound pointer to member function
3112 to a plain pointer.
3114 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3115 @opindex Wsign-promo
3116 @opindex Wno-sign-promo
3117 Warn when overload resolution chooses a promotion from unsigned or
3118 enumerated type to a signed type, over a conversion to an unsigned type of
3119 the same size.  Previous versions of G++ tried to preserve
3120 unsignedness, but the standard mandates the current behavior.
3122 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3123 @opindex Wtemplates
3124 Warn when a primary template declaration is encountered.  Some coding
3125 rules disallow templates, and this may be used to enforce that rule.
3126 The warning is inactive inside a system header file, such as the STL, so
3127 one can still use the STL.  One may also instantiate or specialize
3128 templates.
3130 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3131 @opindex Wmultiple-inheritance
3132 Warn when a class is defined with multiple direct base classes.  Some
3133 coding rules disallow multiple inheritance, and this may be used to
3134 enforce that rule.  The warning is inactive inside a system header file,
3135 such as the STL, so one can still use the STL.  One may also define
3136 classes that indirectly use multiple inheritance.
3138 @item -Wvirtual-inheritance
3139 @opindex Wvirtual-inheritance
3140 Warn when a class is defined with a virtual direct base class.  Some
3141 coding rules disallow multiple inheritance, and this may be used to
3142 enforce that rule.  The warning is inactive inside a system header file,
3143 such as the STL, so one can still use the STL.  One may also define
3144 classes that indirectly use virtual inheritance.
3146 @item -Wnamespaces
3147 @opindex Wnamespaces
3148 Warn when a namespace definition is opened.  Some coding rules disallow
3149 namespaces, and this may be used to enforce that rule.  The warning is
3150 inactive inside a system header file, such as the STL, so one can still
3151 use the STL.  One may also use using directives and qualified names.
3153 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3154 @opindex Wterminate
3155 @opindex Wno-terminate
3156 Disable the warning about a throw-expression that will immediately
3157 result in a call to @code{terminate}.
3158 @end table
3160 @node Objective-C and Objective-C++ Dialect Options
3161 @section Options Controlling Objective-C and Objective-C++ Dialects
3163 @cindex compiler options, Objective-C and Objective-C++
3164 @cindex Objective-C and Objective-C++ options, command-line
3165 @cindex options, Objective-C and Objective-C++
3166 (NOTE: This manual does not describe the Objective-C and Objective-C++
3167 languages themselves.  @xref{Standards,,Language Standards
3168 Supported by GCC}, for references.)
3170 This section describes the command-line options that are only meaningful
3171 for Objective-C and Objective-C++ programs.  You can also use most of
3172 the language-independent GNU compiler options.
3173 For example, you might compile a file @file{some_class.m} like this:
3175 @smallexample
3176 gcc -g -fgnu-runtime -O -c some_class.m
3177 @end smallexample
3179 @noindent
3180 In this example, @option{-fgnu-runtime} is an option meant only for
3181 Objective-C and Objective-C++ programs; you can use the other options with
3182 any language supported by GCC@.
3184 Note that since Objective-C is an extension of the C language, Objective-C
3185 compilations may also use options specific to the C front-end (e.g.,
3186 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3187 C++-specific options (e.g., @option{-Wabi}).
3189 Here is a list of options that are @emph{only} for compiling Objective-C
3190 and Objective-C++ programs:
3192 @table @gcctabopt
3193 @item -fconstant-string-class=@var{class-name}
3194 @opindex fconstant-string-class
3195 Use @var{class-name} as the name of the class to instantiate for each
3196 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3197 class name is @code{NXConstantString} if the GNU runtime is being used, and
3198 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3199 @option{-fconstant-cfstrings} option, if also present, overrides the
3200 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3201 to be laid out as constant CoreFoundation strings.
3203 @item -fgnu-runtime
3204 @opindex fgnu-runtime
3205 Generate object code compatible with the standard GNU Objective-C
3206 runtime.  This is the default for most types of systems.
3208 @item -fnext-runtime
3209 @opindex fnext-runtime
3210 Generate output compatible with the NeXT runtime.  This is the default
3211 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3212 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3213 used.
3215 @item -fno-nil-receivers
3216 @opindex fno-nil-receivers
3217 Assume that all Objective-C message dispatches (@code{[receiver
3218 message:arg]}) in this translation unit ensure that the receiver is
3219 not @code{nil}.  This allows for more efficient entry points in the
3220 runtime to be used.  This option is only available in conjunction with
3221 the NeXT runtime and ABI version 0 or 1.
3223 @item -fobjc-abi-version=@var{n}
3224 @opindex fobjc-abi-version
3225 Use version @var{n} of the Objective-C ABI for the selected runtime.
3226 This option is currently supported only for the NeXT runtime.  In that
3227 case, Version 0 is the traditional (32-bit) ABI without support for
3228 properties and other Objective-C 2.0 additions.  Version 1 is the
3229 traditional (32-bit) ABI with support for properties and other
3230 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3231 nothing is specified, the default is Version 0 on 32-bit target
3232 machines, and Version 2 on 64-bit target machines.
3234 @item -fobjc-call-cxx-cdtors
3235 @opindex fobjc-call-cxx-cdtors
3236 For each Objective-C class, check if any of its instance variables is a
3237 C++ object with a non-trivial default constructor.  If so, synthesize a
3238 special @code{- (id) .cxx_construct} instance method which runs
3239 non-trivial default constructors on any such instance variables, in order,
3240 and then return @code{self}.  Similarly, check if any instance variable
3241 is a C++ object with a non-trivial destructor, and if so, synthesize a
3242 special @code{- (void) .cxx_destruct} method which runs
3243 all such default destructors, in reverse order.
3245 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3246 methods thusly generated only operate on instance variables
3247 declared in the current Objective-C class, and not those inherited
3248 from superclasses.  It is the responsibility of the Objective-C
3249 runtime to invoke all such methods in an object's inheritance
3250 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3251 by the runtime immediately after a new object instance is allocated;
3252 the @code{- (void) .cxx_destruct} methods are invoked immediately
3253 before the runtime deallocates an object instance.
3255 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3256 support for invoking the @code{- (id) .cxx_construct} and
3257 @code{- (void) .cxx_destruct} methods.
3259 @item -fobjc-direct-dispatch
3260 @opindex fobjc-direct-dispatch
3261 Allow fast jumps to the message dispatcher.  On Darwin this is
3262 accomplished via the comm page.
3264 @item -fobjc-exceptions
3265 @opindex fobjc-exceptions
3266 Enable syntactic support for structured exception handling in
3267 Objective-C, similar to what is offered by C++.  This option
3268 is required to use the Objective-C keywords @code{@@try},
3269 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3270 @code{@@synchronized}.  This option is available with both the GNU
3271 runtime and the NeXT runtime (but not available in conjunction with
3272 the NeXT runtime on Mac OS X 10.2 and earlier).
3274 @item -fobjc-gc
3275 @opindex fobjc-gc
3276 Enable garbage collection (GC) in Objective-C and Objective-C++
3277 programs.  This option is only available with the NeXT runtime; the
3278 GNU runtime has a different garbage collection implementation that
3279 does not require special compiler flags.
3281 @item -fobjc-nilcheck
3282 @opindex fobjc-nilcheck
3283 For the NeXT runtime with version 2 of the ABI, check for a nil
3284 receiver in method invocations before doing the actual method call.
3285 This is the default and can be disabled using
3286 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3287 checked for nil in this way no matter what this flag is set to.
3288 Currently this flag does nothing when the GNU runtime, or an older
3289 version of the NeXT runtime ABI, is used.
3291 @item -fobjc-std=objc1
3292 @opindex fobjc-std
3293 Conform to the language syntax of Objective-C 1.0, the language
3294 recognized by GCC 4.0.  This only affects the Objective-C additions to
3295 the C/C++ language; it does not affect conformance to C/C++ standards,
3296 which is controlled by the separate C/C++ dialect option flags.  When
3297 this option is used with the Objective-C or Objective-C++ compiler,
3298 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3299 This is useful if you need to make sure that your Objective-C code can
3300 be compiled with older versions of GCC@.
3302 @item -freplace-objc-classes
3303 @opindex freplace-objc-classes
3304 Emit a special marker instructing @command{ld(1)} not to statically link in
3305 the resulting object file, and allow @command{dyld(1)} to load it in at
3306 run time instead.  This is used in conjunction with the Fix-and-Continue
3307 debugging mode, where the object file in question may be recompiled and
3308 dynamically reloaded in the course of program execution, without the need
3309 to restart the program itself.  Currently, Fix-and-Continue functionality
3310 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3311 and later.
3313 @item -fzero-link
3314 @opindex fzero-link
3315 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3316 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3317 compile time) with static class references that get initialized at load time,
3318 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3319 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3320 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3321 for individual class implementations to be modified during program execution.
3322 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3323 regardless of command-line options.
3325 @item -fno-local-ivars
3326 @opindex fno-local-ivars
3327 @opindex flocal-ivars
3328 By default instance variables in Objective-C can be accessed as if
3329 they were local variables from within the methods of the class they're
3330 declared in.  This can lead to shadowing between instance variables
3331 and other variables declared either locally inside a class method or
3332 globally with the same name.  Specifying the @option{-fno-local-ivars}
3333 flag disables this behavior thus avoiding variable shadowing issues.
3335 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3336 @opindex fivar-visibility
3337 Set the default instance variable visibility to the specified option
3338 so that instance variables declared outside the scope of any access
3339 modifier directives default to the specified visibility.
3341 @item -gen-decls
3342 @opindex gen-decls
3343 Dump interface declarations for all classes seen in the source file to a
3344 file named @file{@var{sourcename}.decl}.
3346 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3347 @opindex Wassign-intercept
3348 @opindex Wno-assign-intercept
3349 Warn whenever an Objective-C assignment is being intercepted by the
3350 garbage collector.
3352 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3353 @opindex Wno-protocol
3354 @opindex Wprotocol
3355 If a class is declared to implement a protocol, a warning is issued for
3356 every method in the protocol that is not implemented by the class.  The
3357 default behavior is to issue a warning for every method not explicitly
3358 implemented in the class, even if a method implementation is inherited
3359 from the superclass.  If you use the @option{-Wno-protocol} option, then
3360 methods inherited from the superclass are considered to be implemented,
3361 and no warning is issued for them.
3363 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3364 @opindex Wselector
3365 @opindex Wno-selector
3366 Warn if multiple methods of different types for the same selector are
3367 found during compilation.  The check is performed on the list of methods
3368 in the final stage of compilation.  Additionally, a check is performed
3369 for each selector appearing in a @code{@@selector(@dots{})}
3370 expression, and a corresponding method for that selector has been found
3371 during compilation.  Because these checks scan the method table only at
3372 the end of compilation, these warnings are not produced if the final
3373 stage of compilation is not reached, for example because an error is
3374 found during compilation, or because the @option{-fsyntax-only} option is
3375 being used.
3377 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3378 @opindex Wstrict-selector-match
3379 @opindex Wno-strict-selector-match
3380 Warn if multiple methods with differing argument and/or return types are
3381 found for a given selector when attempting to send a message using this
3382 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3383 is off (which is the default behavior), the compiler omits such warnings
3384 if any differences found are confined to types that share the same size
3385 and alignment.
3387 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3388 @opindex Wundeclared-selector
3389 @opindex Wno-undeclared-selector
3390 Warn if a @code{@@selector(@dots{})} expression referring to an
3391 undeclared selector is found.  A selector is considered undeclared if no
3392 method with that name has been declared before the
3393 @code{@@selector(@dots{})} expression, either explicitly in an
3394 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3395 an @code{@@implementation} section.  This option always performs its
3396 checks as soon as a @code{@@selector(@dots{})} expression is found,
3397 while @option{-Wselector} only performs its checks in the final stage of
3398 compilation.  This also enforces the coding style convention
3399 that methods and selectors must be declared before being used.
3401 @item -print-objc-runtime-info
3402 @opindex print-objc-runtime-info
3403 Generate C header describing the largest structure that is passed by
3404 value, if any.
3406 @end table
3408 @node Diagnostic Message Formatting Options
3409 @section Options to Control Diagnostic Messages Formatting
3410 @cindex options to control diagnostics formatting
3411 @cindex diagnostic messages
3412 @cindex message formatting
3414 Traditionally, diagnostic messages have been formatted irrespective of
3415 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3416 options described below
3417 to control the formatting algorithm for diagnostic messages, 
3418 e.g.@: how many characters per line, how often source location
3419 information should be reported.  Note that some language front ends may not
3420 honor these options.
3422 @table @gcctabopt
3423 @item -fmessage-length=@var{n}
3424 @opindex fmessage-length
3425 Try to format error messages so that they fit on lines of about
3426 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3427 done; each error message appears on a single line.  This is the
3428 default for all front ends.
3430 @item -fdiagnostics-show-location=once
3431 @opindex fdiagnostics-show-location
3432 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3433 reporter to emit source location information @emph{once}; that is, in
3434 case the message is too long to fit on a single physical line and has to
3435 be wrapped, the source location won't be emitted (as prefix) again,
3436 over and over, in subsequent continuation lines.  This is the default
3437 behavior.
3439 @item -fdiagnostics-show-location=every-line
3440 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3441 messages reporter to emit the same source location information (as
3442 prefix) for physical lines that result from the process of breaking
3443 a message which is too long to fit on a single line.
3445 @item -fdiagnostics-color[=@var{WHEN}]
3446 @itemx -fno-diagnostics-color
3447 @opindex fdiagnostics-color
3448 @cindex highlight, color
3449 @vindex GCC_COLORS @r{environment variable}
3450 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3451 or @samp{auto}.  The default depends on how the compiler has been configured,
3452 it can be any of the above @var{WHEN} options or also @samp{never}
3453 if @env{GCC_COLORS} environment variable isn't present in the environment,
3454 and @samp{auto} otherwise.
3455 @samp{auto} means to use color only when the standard error is a terminal.
3456 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3457 aliases for @option{-fdiagnostics-color=always} and
3458 @option{-fdiagnostics-color=never}, respectively.
3460 The colors are defined by the environment variable @env{GCC_COLORS}.
3461 Its value is a colon-separated list of capabilities and Select Graphic
3462 Rendition (SGR) substrings. SGR commands are interpreted by the
3463 terminal or terminal emulator.  (See the section in the documentation
3464 of your text terminal for permitted values and their meanings as
3465 character attributes.)  These substring values are integers in decimal
3466 representation and can be concatenated with semicolons.
3467 Common values to concatenate include
3468 @samp{1} for bold,
3469 @samp{4} for underline,
3470 @samp{5} for blink,
3471 @samp{7} for inverse,
3472 @samp{39} for default foreground color,
3473 @samp{30} to @samp{37} for foreground colors,
3474 @samp{90} to @samp{97} for 16-color mode foreground colors,
3475 @samp{38;5;0} to @samp{38;5;255}
3476 for 88-color and 256-color modes foreground colors,
3477 @samp{49} for default background color,
3478 @samp{40} to @samp{47} for background colors,
3479 @samp{100} to @samp{107} for 16-color mode background colors,
3480 and @samp{48;5;0} to @samp{48;5;255}
3481 for 88-color and 256-color modes background colors.
3483 The default @env{GCC_COLORS} is
3484 @smallexample
3485 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3486 quote=01:fixit-insert=32:fixit-delete=31:\
3487 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3488 type-diff=01;32
3489 @end smallexample
3490 @noindent
3491 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3492 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3493 @samp{01} is bold, and @samp{31} is red.
3494 Setting @env{GCC_COLORS} to the empty string disables colors.
3495 Supported capabilities are as follows.
3497 @table @code
3498 @item error=
3499 @vindex error GCC_COLORS @r{capability}
3500 SGR substring for error: markers.
3502 @item warning=
3503 @vindex warning GCC_COLORS @r{capability}
3504 SGR substring for warning: markers.
3506 @item note=
3507 @vindex note GCC_COLORS @r{capability}
3508 SGR substring for note: markers.
3510 @item range1=
3511 @vindex range1 GCC_COLORS @r{capability}
3512 SGR substring for first additional range.
3514 @item range2=
3515 @vindex range2 GCC_COLORS @r{capability}
3516 SGR substring for second additional range.
3518 @item locus=
3519 @vindex locus GCC_COLORS @r{capability}
3520 SGR substring for location information, @samp{file:line} or
3521 @samp{file:line:column} etc.
3523 @item quote=
3524 @vindex quote GCC_COLORS @r{capability}
3525 SGR substring for information printed within quotes.
3527 @item fixit-insert=
3528 @vindex fixit-insert GCC_COLORS @r{capability}
3529 SGR substring for fix-it hints suggesting text to
3530 be inserted or replaced.
3532 @item fixit-delete=
3533 @vindex fixit-delete GCC_COLORS @r{capability}
3534 SGR substring for fix-it hints suggesting text to
3535 be deleted.
3537 @item diff-filename=
3538 @vindex diff-filename GCC_COLORS @r{capability}
3539 SGR substring for filename headers within generated patches.
3541 @item diff-hunk=
3542 @vindex diff-hunk GCC_COLORS @r{capability}
3543 SGR substring for the starts of hunks within generated patches.
3545 @item diff-delete=
3546 @vindex diff-delete GCC_COLORS @r{capability}
3547 SGR substring for deleted lines within generated patches.
3549 @item diff-insert=
3550 @vindex diff-insert GCC_COLORS @r{capability}
3551 SGR substring for inserted lines within generated patches.
3553 @item type-diff=
3554 @vindex type-diff GCC_COLORS @r{capability}
3555 SGR substring for highlighting mismatching types within template
3556 arguments in the C++ frontend.
3557 @end table
3559 @item -fno-diagnostics-show-option
3560 @opindex fno-diagnostics-show-option
3561 @opindex fdiagnostics-show-option
3562 By default, each diagnostic emitted includes text indicating the
3563 command-line option that directly controls the diagnostic (if such an
3564 option is known to the diagnostic machinery).  Specifying the
3565 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3567 @item -fno-diagnostics-show-caret
3568 @opindex fno-diagnostics-show-caret
3569 @opindex fdiagnostics-show-caret
3570 By default, each diagnostic emitted includes the original source line
3571 and a caret @samp{^} indicating the column.  This option suppresses this
3572 information.  The source line is truncated to @var{n} characters, if
3573 the @option{-fmessage-length=n} option is given.  When the output is done
3574 to the terminal, the width is limited to the width given by the
3575 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3577 @item -fdiagnostics-parseable-fixits
3578 @opindex fdiagnostics-parseable-fixits
3579 Emit fix-it hints in a machine-parseable format, suitable for consumption
3580 by IDEs.  For each fix-it, a line will be printed after the relevant
3581 diagnostic, starting with the string ``fix-it:''.  For example:
3583 @smallexample
3584 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3585 @end smallexample
3587 The location is expressed as a half-open range, expressed as a count of
3588 bytes, starting at byte 1 for the initial column.  In the above example,
3589 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3590 given string:
3592 @smallexample
3593 00000000011111111112222222222
3594 12345678901234567890123456789
3595   gtk_widget_showall (dlg);
3596   ^^^^^^^^^^^^^^^^^^
3597   gtk_widget_show_all
3598 @end smallexample
3600 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3601 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3602 (e.g. vertical tab as ``\013'').
3604 An empty replacement string indicates that the given range is to be removed.
3605 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3606 be inserted at the given position.
3608 @item -fdiagnostics-generate-patch
3609 @opindex fdiagnostics-generate-patch
3610 Print fix-it hints to stderr in unified diff format, after any diagnostics
3611 are printed.  For example:
3613 @smallexample
3614 --- test.c
3615 +++ test.c
3616 @@ -42,5 +42,5 @@
3618  void show_cb(GtkDialog *dlg)
3619  @{
3620 -  gtk_widget_showall(dlg);
3621 +  gtk_widget_show_all(dlg);
3622  @}
3624 @end smallexample
3626 The diff may or may not be colorized, following the same rules
3627 as for diagnostics (see @option{-fdiagnostics-color}).
3629 @item -fdiagnostics-show-template-tree
3630 @opindex fdiagnostics-show-template-tree
3632 In the C++ frontend, when printing diagnostics showing mismatching
3633 template types, such as:
3635 @smallexample
3636   could not convert 'std::map<int, std::vector<double> >()'
3637     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3638 @end smallexample
3640 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3641 tree-like structure showing the common and differing parts of the types,
3642 such as:
3644 @smallexample
3645   map<
3646     [...],
3647     vector<
3648       [double != float]>>
3649 @end smallexample
3651 The parts that differ are highlighted with color (``double'' and
3652 ``float'' in this case).
3654 @item -fno-elide-type
3655 @opindex fno-elide-type
3656 @opindex felide-type
3657 By default when the C++ frontend prints diagnostics showing mismatching
3658 template types, common parts of the types are printed as ``[...]'' to
3659 simplify the error message.  For example:
3661 @smallexample
3662   could not convert 'std::map<int, std::vector<double> >()'
3663     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3664 @end smallexample
3666 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3667 This flag also affects the output of the
3668 @option{-fdiagnostics-show-template-tree} flag.
3670 @item -fno-show-column
3671 @opindex fno-show-column
3672 Do not print column numbers in diagnostics.  This may be necessary if
3673 diagnostics are being scanned by a program that does not understand the
3674 column numbers, such as @command{dejagnu}.
3676 @end table
3678 @node Warning Options
3679 @section Options to Request or Suppress Warnings
3680 @cindex options to control warnings
3681 @cindex warning messages
3682 @cindex messages, warning
3683 @cindex suppressing warnings
3685 Warnings are diagnostic messages that report constructions that
3686 are not inherently erroneous but that are risky or suggest there
3687 may have been an error.
3689 The following language-independent options do not enable specific
3690 warnings but control the kinds of diagnostics produced by GCC@.
3692 @table @gcctabopt
3693 @cindex syntax checking
3694 @item -fsyntax-only
3695 @opindex fsyntax-only
3696 Check the code for syntax errors, but don't do anything beyond that.
3698 @item -fmax-errors=@var{n}
3699 @opindex fmax-errors
3700 Limits the maximum number of error messages to @var{n}, at which point
3701 GCC bails out rather than attempting to continue processing the source
3702 code.  If @var{n} is 0 (the default), there is no limit on the number
3703 of error messages produced.  If @option{-Wfatal-errors} is also
3704 specified, then @option{-Wfatal-errors} takes precedence over this
3705 option.
3707 @item -w
3708 @opindex w
3709 Inhibit all warning messages.
3711 @item -Werror
3712 @opindex Werror
3713 @opindex Wno-error
3714 Make all warnings into errors.
3716 @item -Werror=
3717 @opindex Werror=
3718 @opindex Wno-error=
3719 Make the specified warning into an error.  The specifier for a warning
3720 is appended; for example @option{-Werror=switch} turns the warnings
3721 controlled by @option{-Wswitch} into errors.  This switch takes a
3722 negative form, to be used to negate @option{-Werror} for specific
3723 warnings; for example @option{-Wno-error=switch} makes
3724 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3725 is in effect.
3727 The warning message for each controllable warning includes the
3728 option that controls the warning.  That option can then be used with
3729 @option{-Werror=} and @option{-Wno-error=} as described above.
3730 (Printing of the option in the warning message can be disabled using the
3731 @option{-fno-diagnostics-show-option} flag.)
3733 Note that specifying @option{-Werror=}@var{foo} automatically implies
3734 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3735 imply anything.
3737 @item -Wfatal-errors
3738 @opindex Wfatal-errors
3739 @opindex Wno-fatal-errors
3740 This option causes the compiler to abort compilation on the first error
3741 occurred rather than trying to keep going and printing further error
3742 messages.
3744 @end table
3746 You can request many specific warnings with options beginning with
3747 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3748 implicit declarations.  Each of these specific warning options also
3749 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3750 example, @option{-Wno-implicit}.  This manual lists only one of the
3751 two forms, whichever is not the default.  For further
3752 language-specific options also refer to @ref{C++ Dialect Options} and
3753 @ref{Objective-C and Objective-C++ Dialect Options}.
3755 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3756 options, such as @option{-Wunused}, which may turn on further options,
3757 such as @option{-Wunused-value}. The combined effect of positive and
3758 negative forms is that more specific options have priority over less
3759 specific ones, independently of their position in the command-line. For
3760 options of the same specificity, the last one takes effect. Options
3761 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3762 as if they appeared at the end of the command-line.
3764 When an unrecognized warning option is requested (e.g.,
3765 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3766 that the option is not recognized.  However, if the @option{-Wno-} form
3767 is used, the behavior is slightly different: no diagnostic is
3768 produced for @option{-Wno-unknown-warning} unless other diagnostics
3769 are being produced.  This allows the use of new @option{-Wno-} options
3770 with old compilers, but if something goes wrong, the compiler
3771 warns that an unrecognized option is present.
3773 @table @gcctabopt
3774 @item -Wpedantic
3775 @itemx -pedantic
3776 @opindex pedantic
3777 @opindex Wpedantic
3778 Issue all the warnings demanded by strict ISO C and ISO C++;
3779 reject all programs that use forbidden extensions, and some other
3780 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3781 version of the ISO C standard specified by any @option{-std} option used.
3783 Valid ISO C and ISO C++ programs should compile properly with or without
3784 this option (though a rare few require @option{-ansi} or a
3785 @option{-std} option specifying the required version of ISO C)@.  However,
3786 without this option, certain GNU extensions and traditional C and C++
3787 features are supported as well.  With this option, they are rejected.
3789 @option{-Wpedantic} does not cause warning messages for use of the
3790 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3791 warnings are also disabled in the expression that follows
3792 @code{__extension__}.  However, only system header files should use
3793 these escape routes; application programs should avoid them.
3794 @xref{Alternate Keywords}.
3796 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3797 C conformance.  They soon find that it does not do quite what they want:
3798 it finds some non-ISO practices, but not all---only those for which
3799 ISO C @emph{requires} a diagnostic, and some others for which
3800 diagnostics have been added.
3802 A feature to report any failure to conform to ISO C might be useful in
3803 some instances, but would require considerable additional work and would
3804 be quite different from @option{-Wpedantic}.  We don't have plans to
3805 support such a feature in the near future.
3807 Where the standard specified with @option{-std} represents a GNU
3808 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3809 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3810 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3811 where they are required by the base standard.  (It does not make sense
3812 for such warnings to be given only for features not in the specified GNU
3813 C dialect, since by definition the GNU dialects of C include all
3814 features the compiler supports with the given option, and there would be
3815 nothing to warn about.)
3817 @item -pedantic-errors
3818 @opindex pedantic-errors
3819 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3820 requires a diagnostic, in some cases where there is undefined behavior
3821 at compile-time and in some other cases that do not prevent compilation
3822 of programs that are valid according to the standard. This is not
3823 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3824 by this option and not enabled by the latter and vice versa.
3826 @item -Wall
3827 @opindex Wall
3828 @opindex Wno-all
3829 This enables all the warnings about constructions that some users
3830 consider questionable, and that are easy to avoid (or modify to
3831 prevent the warning), even in conjunction with macros.  This also
3832 enables some language-specific warnings described in @ref{C++ Dialect
3833 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3835 @option{-Wall} turns on the following warning flags:
3837 @gccoptlist{-Waddress   @gol
3838 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3839 -Wbool-compare  @gol
3840 -Wbool-operation  @gol
3841 -Wc++11-compat  -Wc++14-compat  @gol
3842 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3843 -Wchar-subscripts  @gol
3844 -Wcomment  @gol
3845 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3846 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3847 -Wformat   @gol
3848 -Wint-in-bool-context  @gol
3849 -Wimplicit @r{(C and Objective-C only)} @gol
3850 -Wimplicit-int @r{(C and Objective-C only)} @gol
3851 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3852 -Winit-self @r{(only for C++)} @gol
3853 -Wlogical-not-parentheses @gol
3854 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3855 -Wmaybe-uninitialized @gol
3856 -Wmemset-elt-size @gol
3857 -Wmemset-transposed-args @gol
3858 -Wmisleading-indentation @r{(only for C/C++)} @gol
3859 -Wmissing-braces @r{(only for C/ObjC)} @gol
3860 -Wmultistatement-macros  @gol
3861 -Wnarrowing @r{(only for C++)}  @gol
3862 -Wnonnull  @gol
3863 -Wnonnull-compare  @gol
3864 -Wopenmp-simd @gol
3865 -Wparentheses  @gol
3866 -Wpointer-sign  @gol
3867 -Wreorder   @gol
3868 -Wreturn-type  @gol
3869 -Wsequence-point  @gol
3870 -Wsign-compare @r{(only in C++)}  @gol
3871 -Wsizeof-pointer-div @gol
3872 -Wsizeof-pointer-memaccess @gol
3873 -Wstrict-aliasing  @gol
3874 -Wstrict-overflow=1  @gol
3875 -Wswitch  @gol
3876 -Wtautological-compare  @gol
3877 -Wtrigraphs  @gol
3878 -Wuninitialized  @gol
3879 -Wunknown-pragmas  @gol
3880 -Wunused-function  @gol
3881 -Wunused-label     @gol
3882 -Wunused-value     @gol
3883 -Wunused-variable  @gol
3884 -Wvolatile-register-var @gol
3887 Note that some warning flags are not implied by @option{-Wall}.  Some of
3888 them warn about constructions that users generally do not consider
3889 questionable, but which occasionally you might wish to check for;
3890 others warn about constructions that are necessary or hard to avoid in
3891 some cases, and there is no simple way to modify the code to suppress
3892 the warning. Some of them are enabled by @option{-Wextra} but many of
3893 them must be enabled individually.
3895 @item -Wextra
3896 @opindex W
3897 @opindex Wextra
3898 @opindex Wno-extra
3899 This enables some extra warning flags that are not enabled by
3900 @option{-Wall}. (This option used to be called @option{-W}.  The older
3901 name is still supported, but the newer name is more descriptive.)
3903 @gccoptlist{-Wclobbered  @gol
3904 -Wempty-body  @gol
3905 -Wignored-qualifiers @gol
3906 -Wimplicit-fallthrough=3 @gol
3907 -Wmissing-field-initializers  @gol
3908 -Wmissing-parameter-type @r{(C only)}  @gol
3909 -Wold-style-declaration @r{(C only)}  @gol
3910 -Woverride-init  @gol
3911 -Wsign-compare @r{(C only)} @gol
3912 -Wtype-limits  @gol
3913 -Wuninitialized  @gol
3914 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3915 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3916 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3919 The option @option{-Wextra} also prints warning messages for the
3920 following cases:
3922 @itemize @bullet
3924 @item
3925 A pointer is compared against integer zero with @code{<}, @code{<=},
3926 @code{>}, or @code{>=}.
3928 @item
3929 (C++ only) An enumerator and a non-enumerator both appear in a
3930 conditional expression.
3932 @item
3933 (C++ only) Ambiguous virtual bases.
3935 @item
3936 (C++ only) Subscripting an array that has been declared @code{register}.
3938 @item
3939 (C++ only) Taking the address of a variable that has been declared
3940 @code{register}.
3942 @item
3943 (C++ only) A base class is not initialized in the copy constructor
3944 of a derived class.
3946 @end itemize
3948 @item -Wchar-subscripts
3949 @opindex Wchar-subscripts
3950 @opindex Wno-char-subscripts
3951 Warn if an array subscript has type @code{char}.  This is a common cause
3952 of error, as programmers often forget that this type is signed on some
3953 machines.
3954 This warning is enabled by @option{-Wall}.
3956 @item -Wchkp
3957 @opindex Wchkp
3958 Warn about an invalid memory access that is found by Pointer Bounds Checker
3959 (@option{-fcheck-pointer-bounds}).
3961 @item -Wno-coverage-mismatch
3962 @opindex Wno-coverage-mismatch
3963 Warn if feedback profiles do not match when using the
3964 @option{-fprofile-use} option.
3965 If a source file is changed between compiling with @option{-fprofile-gen} and
3966 with @option{-fprofile-use}, the files with the profile feedback can fail
3967 to match the source file and GCC cannot use the profile feedback
3968 information.  By default, this warning is enabled and is treated as an
3969 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3970 warning or @option{-Wno-error=coverage-mismatch} can be used to
3971 disable the error.  Disabling the error for this warning can result in
3972 poorly optimized code and is useful only in the
3973 case of very minor changes such as bug fixes to an existing code-base.
3974 Completely disabling the warning is not recommended.
3976 @item -Wno-cpp
3977 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3979 Suppress warning messages emitted by @code{#warning} directives.
3981 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3982 @opindex Wdouble-promotion
3983 @opindex Wno-double-promotion
3984 Give a warning when a value of type @code{float} is implicitly
3985 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3986 floating-point unit implement @code{float} in hardware, but emulate
3987 @code{double} in software.  On such a machine, doing computations
3988 using @code{double} values is much more expensive because of the
3989 overhead required for software emulation.
3991 It is easy to accidentally do computations with @code{double} because
3992 floating-point literals are implicitly of type @code{double}.  For
3993 example, in:
3994 @smallexample
3995 @group
3996 float area(float radius)
3998    return 3.14159 * radius * radius;
4000 @end group
4001 @end smallexample
4002 the compiler performs the entire computation with @code{double}
4003 because the floating-point literal is a @code{double}.
4005 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4006 @opindex Wduplicate-decl-specifier
4007 @opindex Wno-duplicate-decl-specifier
4008 Warn if a declaration has duplicate @code{const}, @code{volatile},
4009 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4010 @option{-Wall}.
4012 @item -Wformat
4013 @itemx -Wformat=@var{n}
4014 @opindex Wformat
4015 @opindex Wno-format
4016 @opindex ffreestanding
4017 @opindex fno-builtin
4018 @opindex Wformat=
4019 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4020 the arguments supplied have types appropriate to the format string
4021 specified, and that the conversions specified in the format string make
4022 sense.  This includes standard functions, and others specified by format
4023 attributes (@pxref{Function Attributes}), in the @code{printf},
4024 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4025 not in the C standard) families (or other target-specific families).
4026 Which functions are checked without format attributes having been
4027 specified depends on the standard version selected, and such checks of
4028 functions without the attribute specified are disabled by
4029 @option{-ffreestanding} or @option{-fno-builtin}.
4031 The formats are checked against the format features supported by GNU
4032 libc version 2.2.  These include all ISO C90 and C99 features, as well
4033 as features from the Single Unix Specification and some BSD and GNU
4034 extensions.  Other library implementations may not support all these
4035 features; GCC does not support warning about features that go beyond a
4036 particular library's limitations.  However, if @option{-Wpedantic} is used
4037 with @option{-Wformat}, warnings are given about format features not
4038 in the selected standard version (but not for @code{strfmon} formats,
4039 since those are not in any version of the C standard).  @xref{C Dialect
4040 Options,,Options Controlling C Dialect}.
4042 @table @gcctabopt
4043 @item -Wformat=1
4044 @itemx -Wformat
4045 @opindex Wformat
4046 @opindex Wformat=1
4047 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4048 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4049 @option{-Wformat} also checks for null format arguments for several
4050 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4051 aspects of this level of format checking can be disabled by the
4052 options: @option{-Wno-format-contains-nul},
4053 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4054 @option{-Wformat} is enabled by @option{-Wall}.
4056 @item -Wno-format-contains-nul
4057 @opindex Wno-format-contains-nul
4058 @opindex Wformat-contains-nul
4059 If @option{-Wformat} is specified, do not warn about format strings that
4060 contain NUL bytes.
4062 @item -Wno-format-extra-args
4063 @opindex Wno-format-extra-args
4064 @opindex Wformat-extra-args
4065 If @option{-Wformat} is specified, do not warn about excess arguments to a
4066 @code{printf} or @code{scanf} format function.  The C standard specifies
4067 that such arguments are ignored.
4069 Where the unused arguments lie between used arguments that are
4070 specified with @samp{$} operand number specifications, normally
4071 warnings are still given, since the implementation could not know what
4072 type to pass to @code{va_arg} to skip the unused arguments.  However,
4073 in the case of @code{scanf} formats, this option suppresses the
4074 warning if the unused arguments are all pointers, since the Single
4075 Unix Specification says that such unused arguments are allowed.
4077 @item -Wformat-overflow
4078 @itemx -Wformat-overflow=@var{level}
4079 @opindex Wformat-overflow
4080 @opindex Wno-format-overflow
4081 Warn about calls to formatted input/output functions such as @code{sprintf}
4082 and @code{vsprintf} that might overflow the destination buffer.  When the
4083 exact number of bytes written by a format directive cannot be determined
4084 at compile-time it is estimated based on heuristics that depend on the
4085 @var{level} argument and on optimization.  While enabling optimization
4086 will in most cases improve the accuracy of the warning, it may also
4087 result in false positives.
4089 @table @gcctabopt
4090 @item -Wformat-overflow
4091 @item -Wformat-overflow=1
4092 @opindex Wformat-overflow
4093 @opindex Wno-format-overflow
4094 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4095 employs a conservative approach that warns only about calls that most
4096 likely overflow the buffer.  At this level, numeric arguments to format
4097 directives with unknown values are assumed to have the value of one, and
4098 strings of unknown length to be empty.  Numeric arguments that are known
4099 to be bounded to a subrange of their type, or string arguments whose output
4100 is bounded either by their directive's precision or by a finite set of
4101 string literals, are assumed to take on the value within the range that
4102 results in the most bytes on output.  For example, the call to @code{sprintf}
4103 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4104 the terminating NUL character (@code{'\0'}) appended by the function
4105 to the destination buffer will be written past its end.  Increasing
4106 the size of the buffer by a single byte is sufficient to avoid the
4107 warning, though it may not be sufficient to avoid the overflow.
4109 @smallexample
4110 void f (int a, int b)
4112   char buf [12];
4113   sprintf (buf, "a = %i, b = %i\n", a, b);
4115 @end smallexample
4117 @item -Wformat-overflow=2
4118 Level @var{2} warns also about calls that might overflow the destination
4119 buffer given an argument of sufficient length or magnitude.  At level
4120 @var{2}, unknown numeric arguments are assumed to have the minimum
4121 representable value for signed types with a precision greater than 1, and
4122 the maximum representable value otherwise.  Unknown string arguments whose
4123 length cannot be assumed to be bounded either by the directive's precision,
4124 or by a finite set of string literals they may evaluate to, or the character
4125 array they may point to, are assumed to be 1 character long.
4127 At level @var{2}, the call in the example above is again diagnosed, but
4128 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4129 @code{%i} directive will write some of its digits beyond the end of
4130 the destination buffer.  To make the call safe regardless of the values
4131 of the two variables, the size of the destination buffer must be increased
4132 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4133 an informational note following the warning.
4135 An alternative to increasing the size of the destination buffer is to
4136 constrain the range of formatted values.  The maximum length of string
4137 arguments can be bounded by specifying the precision in the format
4138 directive.  When numeric arguments of format directives can be assumed
4139 to be bounded by less than the precision of their type, choosing
4140 an appropriate length modifier to the format specifier will reduce
4141 the required buffer size.  For example, if @var{a} and @var{b} in the
4142 example above can be assumed to be within the precision of
4143 the @code{short int} type then using either the @code{%hi} format
4144 directive or casting the argument to @code{short} reduces the maximum
4145 required size of the buffer to 24 bytes.
4147 @smallexample
4148 void f (int a, int b)
4150   char buf [23];
4151   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4153 @end smallexample
4154 @end table
4156 @item -Wno-format-zero-length
4157 @opindex Wno-format-zero-length
4158 @opindex Wformat-zero-length
4159 If @option{-Wformat} is specified, do not warn about zero-length formats.
4160 The C standard specifies that zero-length formats are allowed.
4163 @item -Wformat=2
4164 @opindex Wformat=2
4165 Enable @option{-Wformat} plus additional format checks.  Currently
4166 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4167 -Wformat-y2k}.
4169 @item -Wformat-nonliteral
4170 @opindex Wformat-nonliteral
4171 @opindex Wno-format-nonliteral
4172 If @option{-Wformat} is specified, also warn if the format string is not a
4173 string literal and so cannot be checked, unless the format function
4174 takes its format arguments as a @code{va_list}.
4176 @item -Wformat-security
4177 @opindex Wformat-security
4178 @opindex Wno-format-security
4179 If @option{-Wformat} is specified, also warn about uses of format
4180 functions that represent possible security problems.  At present, this
4181 warns about calls to @code{printf} and @code{scanf} functions where the
4182 format string is not a string literal and there are no format arguments,
4183 as in @code{printf (foo);}.  This may be a security hole if the format
4184 string came from untrusted input and contains @samp{%n}.  (This is
4185 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4186 in future warnings may be added to @option{-Wformat-security} that are not
4187 included in @option{-Wformat-nonliteral}.)
4189 @item -Wformat-signedness
4190 @opindex Wformat-signedness
4191 @opindex Wno-format-signedness
4192 If @option{-Wformat} is specified, also warn if the format string
4193 requires an unsigned argument and the argument is signed and vice versa.
4195 @item -Wformat-truncation
4196 @itemx -Wformat-truncation=@var{level}
4197 @opindex Wformat-truncation
4198 @opindex Wno-format-truncation
4199 Warn about calls to formatted input/output functions such as @code{snprintf}
4200 and @code{vsnprintf} that might result in output truncation.  When the exact
4201 number of bytes written by a format directive cannot be determined at
4202 compile-time it is estimated based on heuristics that depend on
4203 the @var{level} argument and on optimization.  While enabling optimization
4204 will in most cases improve the accuracy of the warning, it may also result
4205 in false positives.  Except as noted otherwise, the option uses the same
4206 logic @option{-Wformat-overflow}.
4208 @table @gcctabopt
4209 @item -Wformat-truncation
4210 @item -Wformat-truncation=1
4211 @opindex Wformat-truncation
4212 @opindex Wno-format-overflow
4213 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4214 employs a conservative approach that warns only about calls to bounded
4215 functions whose return value is unused and that will most likely result
4216 in output truncation.
4218 @item -Wformat-truncation=2
4219 Level @var{2} warns also about calls to bounded functions whose return
4220 value is used and that might result in truncation given an argument of
4221 sufficient length or magnitude.
4222 @end table
4224 @item -Wformat-y2k
4225 @opindex Wformat-y2k
4226 @opindex Wno-format-y2k
4227 If @option{-Wformat} is specified, also warn about @code{strftime}
4228 formats that may yield only a two-digit year.
4229 @end table
4231 @item -Wnonnull
4232 @opindex Wnonnull
4233 @opindex Wno-nonnull
4234 Warn about passing a null pointer for arguments marked as
4235 requiring a non-null value by the @code{nonnull} function attribute.
4237 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4238 can be disabled with the @option{-Wno-nonnull} option.
4240 @item -Wnonnull-compare
4241 @opindex Wnonnull-compare
4242 @opindex Wno-nonnull-compare
4243 Warn when comparing an argument marked with the @code{nonnull}
4244 function attribute against null inside the function.
4246 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4247 can be disabled with the @option{-Wno-nonnull-compare} option.
4249 @item -Wnull-dereference
4250 @opindex Wnull-dereference
4251 @opindex Wno-null-dereference
4252 Warn if the compiler detects paths that trigger erroneous or
4253 undefined behavior due to dereferencing a null pointer.  This option
4254 is only active when @option{-fdelete-null-pointer-checks} is active,
4255 which is enabled by optimizations in most targets.  The precision of
4256 the warnings depends on the optimization options used.
4258 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4259 @opindex Winit-self
4260 @opindex Wno-init-self
4261 Warn about uninitialized variables that are initialized with themselves.
4262 Note this option can only be used with the @option{-Wuninitialized} option.
4264 For example, GCC warns about @code{i} being uninitialized in the
4265 following snippet only when @option{-Winit-self} has been specified:
4266 @smallexample
4267 @group
4268 int f()
4270   int i = i;
4271   return i;
4273 @end group
4274 @end smallexample
4276 This warning is enabled by @option{-Wall} in C++.
4278 @item -Wimplicit-int @r{(C and Objective-C only)}
4279 @opindex Wimplicit-int
4280 @opindex Wno-implicit-int
4281 Warn when a declaration does not specify a type.
4282 This warning is enabled by @option{-Wall}.
4284 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4285 @opindex Wimplicit-function-declaration
4286 @opindex Wno-implicit-function-declaration
4287 Give a warning whenever a function is used before being declared. In
4288 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4289 enabled by default and it is made into an error by
4290 @option{-pedantic-errors}. This warning is also enabled by
4291 @option{-Wall}.
4293 @item -Wimplicit @r{(C and Objective-C only)}
4294 @opindex Wimplicit
4295 @opindex Wno-implicit
4296 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4297 This warning is enabled by @option{-Wall}.
4299 @item -Wimplicit-fallthrough
4300 @opindex Wimplicit-fallthrough
4301 @opindex Wno-implicit-fallthrough
4302 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4303 and @option{-Wno-implicit-fallthrough} is the same as
4304 @option{-Wimplicit-fallthrough=0}.
4306 @item -Wimplicit-fallthrough=@var{n}
4307 @opindex Wimplicit-fallthrough=
4308 Warn when a switch case falls through.  For example:
4310 @smallexample
4311 @group
4312 switch (cond)
4313   @{
4314   case 1:
4315     a = 1;
4316     break;
4317   case 2:
4318     a = 2;
4319   case 3:
4320     a = 3;
4321     break;
4322   @}
4323 @end group
4324 @end smallexample
4326 This warning does not warn when the last statement of a case cannot
4327 fall through, e.g. when there is a return statement or a call to function
4328 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4329 also takes into account control flow statements, such as ifs, and only
4330 warns when appropriate.  E.g.@:
4332 @smallexample
4333 @group
4334 switch (cond)
4335   @{
4336   case 1:
4337     if (i > 3) @{
4338       bar (5);
4339       break;
4340     @} else if (i < 1) @{
4341       bar (0);
4342     @} else
4343       return;
4344   default:
4345     @dots{}
4346   @}
4347 @end group
4348 @end smallexample
4350 Since there are occasions where a switch case fall through is desirable,
4351 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4352 to be used along with a null statement to suppress this warning that
4353 would normally occur:
4355 @smallexample
4356 @group
4357 switch (cond)
4358   @{
4359   case 1:
4360     bar (0);
4361     __attribute__ ((fallthrough));
4362   default:
4363     @dots{}
4364   @}
4365 @end group
4366 @end smallexample
4368 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4369 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4370 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4371 Instead of these attributes, it is also possible to add a fallthrough comment
4372 to silence the warning.  The whole body of the C or C++ style comment should
4373 match the given regular expressions listed below.  The option argument @var{n}
4374 specifies what kind of comments are accepted:
4376 @itemize @bullet
4378 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4380 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4381 expression, any comment is used as fallthrough comment.
4383 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4384 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4386 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4387 following regular expressions:
4389 @itemize @bullet
4391 @item @code{-fallthrough}
4393 @item @code{@@fallthrough@@}
4395 @item @code{lint -fallthrough[ \t]*}
4397 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4399 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4401 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4403 @end itemize
4405 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4406 following regular expressions:
4408 @itemize @bullet
4410 @item @code{-fallthrough}
4412 @item @code{@@fallthrough@@}
4414 @item @code{lint -fallthrough[ \t]*}
4416 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4418 @end itemize
4420 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4421 fallthrough comments, only attributes disable the warning.
4423 @end itemize
4425 The comment needs to be followed after optional whitespace and other comments
4426 by @code{case} or @code{default} keywords or by a user label that precedes some
4427 @code{case} or @code{default} label.
4429 @smallexample
4430 @group
4431 switch (cond)
4432   @{
4433   case 1:
4434     bar (0);
4435     /* FALLTHRU */
4436   default:
4437     @dots{}
4438   @}
4439 @end group
4440 @end smallexample
4442 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4444 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4445 @opindex Wif-not-aligned
4446 @opindex Wno-if-not-aligned
4447 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4448 should be issued.  This is is enabled by default.
4449 Use @option{-Wno-if-not-aligned} to disable it.
4451 @item -Wignored-qualifiers @r{(C and C++ only)}
4452 @opindex Wignored-qualifiers
4453 @opindex Wno-ignored-qualifiers
4454 Warn if the return type of a function has a type qualifier
4455 such as @code{const}.  For ISO C such a type qualifier has no effect,
4456 since the value returned by a function is not an lvalue.
4457 For C++, the warning is only emitted for scalar types or @code{void}.
4458 ISO C prohibits qualified @code{void} return types on function
4459 definitions, so such return types always receive a warning
4460 even without this option.
4462 This warning is also enabled by @option{-Wextra}.
4464 @item -Wignored-attributes @r{(C and C++ only)}
4465 @opindex Wignored-attributes
4466 @opindex Wno-ignored-attributes
4467 Warn when an attribute is ignored.  This is different from the
4468 @option{-Wattributes} option in that it warns whenever the compiler decides
4469 to drop an attribute, not that the attribute is either unknown, used in a
4470 wrong place, etc.  This warning is enabled by default.
4472 @item -Wmain
4473 @opindex Wmain
4474 @opindex Wno-main
4475 Warn if the type of @code{main} is suspicious.  @code{main} should be
4476 a function with external linkage, returning int, taking either zero
4477 arguments, two, or three arguments of appropriate types.  This warning
4478 is enabled by default in C++ and is enabled by either @option{-Wall}
4479 or @option{-Wpedantic}.
4481 @item -Wmisleading-indentation @r{(C and C++ only)}
4482 @opindex Wmisleading-indentation
4483 @opindex Wno-misleading-indentation
4484 Warn when the indentation of the code does not reflect the block structure.
4485 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4486 @code{for} clauses with a guarded statement that does not use braces,
4487 followed by an unguarded statement with the same indentation.
4489 In the following example, the call to ``bar'' is misleadingly indented as
4490 if it were guarded by the ``if'' conditional.
4492 @smallexample
4493   if (some_condition ())
4494     foo ();
4495     bar ();  /* Gotcha: this is not guarded by the "if".  */
4496 @end smallexample
4498 In the case of mixed tabs and spaces, the warning uses the
4499 @option{-ftabstop=} option to determine if the statements line up
4500 (defaulting to 8).
4502 The warning is not issued for code involving multiline preprocessor logic
4503 such as the following example.
4505 @smallexample
4506   if (flagA)
4507     foo (0);
4508 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4509   if (flagB)
4510 #endif
4511     foo (1);
4512 @end smallexample
4514 The warning is not issued after a @code{#line} directive, since this
4515 typically indicates autogenerated code, and no assumptions can be made
4516 about the layout of the file that the directive references.
4518 This warning is enabled by @option{-Wall} in C and C++.
4520 @item -Wmissing-braces
4521 @opindex Wmissing-braces
4522 @opindex Wno-missing-braces
4523 Warn if an aggregate or union initializer is not fully bracketed.  In
4524 the following example, the initializer for @code{a} is not fully
4525 bracketed, but that for @code{b} is fully bracketed.  This warning is
4526 enabled by @option{-Wall} in C.
4528 @smallexample
4529 int a[2][2] = @{ 0, 1, 2, 3 @};
4530 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4531 @end smallexample
4533 This warning is enabled by @option{-Wall}.
4535 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4536 @opindex Wmissing-include-dirs
4537 @opindex Wno-missing-include-dirs
4538 Warn if a user-supplied include directory does not exist.
4540 @item -Wmultistatement-macros
4541 @opindex Wmultistatement-macros
4542 @opindex Wno-multistatement-macros
4543 Warn about unsafe multiple statement macros that appear to be guarded
4544 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4545 @code{while}, in which only the first statement is actually guarded after
4546 the macro is expanded.
4548 For example:
4550 @smallexample
4551 #define DOIT x++; y++
4552 if (c)
4553   DOIT;
4554 @end smallexample
4556 will increment @code{y} unconditionally, not just when @code{c} holds.
4557 The can usually be fixed by wrapping the macro in a do-while loop:
4558 @smallexample
4559 #define DOIT do @{ x++; y++; @} while (0)
4560 if (c)
4561   DOIT;
4562 @end smallexample
4564 This warning is enabled by @option{-Wall} in C and C++.
4566 @item -Wparentheses
4567 @opindex Wparentheses
4568 @opindex Wno-parentheses
4569 Warn if parentheses are omitted in certain contexts, such
4570 as when there is an assignment in a context where a truth value
4571 is expected, or when operators are nested whose precedence people
4572 often get confused about.
4574 Also warn if a comparison like @code{x<=y<=z} appears; this is
4575 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4576 interpretation from that of ordinary mathematical notation.
4578 Also warn for dangerous uses of the GNU extension to
4579 @code{?:} with omitted middle operand. When the condition
4580 in the @code{?}: operator is a boolean expression, the omitted value is
4581 always 1.  Often programmers expect it to be a value computed
4582 inside the conditional expression instead.
4584 For C++ this also warns for some cases of unnecessary parentheses in
4585 declarations, which can indicate an attempt at a function call instead
4586 of a declaration:
4587 @smallexample
4589   // Declares a local variable called mymutex.
4590   std::unique_lock<std::mutex> (mymutex);
4591   // User meant std::unique_lock<std::mutex> lock (mymutex);
4593 @end smallexample
4595 This warning is enabled by @option{-Wall}.
4597 @item -Wsequence-point
4598 @opindex Wsequence-point
4599 @opindex Wno-sequence-point
4600 Warn about code that may have undefined semantics because of violations
4601 of sequence point rules in the C and C++ standards.
4603 The C and C++ standards define the order in which expressions in a C/C++
4604 program are evaluated in terms of @dfn{sequence points}, which represent
4605 a partial ordering between the execution of parts of the program: those
4606 executed before the sequence point, and those executed after it.  These
4607 occur after the evaluation of a full expression (one which is not part
4608 of a larger expression), after the evaluation of the first operand of a
4609 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4610 function is called (but after the evaluation of its arguments and the
4611 expression denoting the called function), and in certain other places.
4612 Other than as expressed by the sequence point rules, the order of
4613 evaluation of subexpressions of an expression is not specified.  All
4614 these rules describe only a partial order rather than a total order,
4615 since, for example, if two functions are called within one expression
4616 with no sequence point between them, the order in which the functions
4617 are called is not specified.  However, the standards committee have
4618 ruled that function calls do not overlap.
4620 It is not specified when between sequence points modifications to the
4621 values of objects take effect.  Programs whose behavior depends on this
4622 have undefined behavior; the C and C++ standards specify that ``Between
4623 the previous and next sequence point an object shall have its stored
4624 value modified at most once by the evaluation of an expression.
4625 Furthermore, the prior value shall be read only to determine the value
4626 to be stored.''.  If a program breaks these rules, the results on any
4627 particular implementation are entirely unpredictable.
4629 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4630 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4631 diagnosed by this option, and it may give an occasional false positive
4632 result, but in general it has been found fairly effective at detecting
4633 this sort of problem in programs.
4635 The C++17 standard will define the order of evaluation of operands in
4636 more cases: in particular it requires that the right-hand side of an
4637 assignment be evaluated before the left-hand side, so the above
4638 examples are no longer undefined.  But this warning will still warn
4639 about them, to help people avoid writing code that is undefined in C
4640 and earlier revisions of C++.
4642 The standard is worded confusingly, therefore there is some debate
4643 over the precise meaning of the sequence point rules in subtle cases.
4644 Links to discussions of the problem, including proposed formal
4645 definitions, may be found on the GCC readings page, at
4646 @uref{http://gcc.gnu.org/@/readings.html}.
4648 This warning is enabled by @option{-Wall} for C and C++.
4650 @item -Wno-return-local-addr
4651 @opindex Wno-return-local-addr
4652 @opindex Wreturn-local-addr
4653 Do not warn about returning a pointer (or in C++, a reference) to a
4654 variable that goes out of scope after the function returns.
4656 @item -Wreturn-type
4657 @opindex Wreturn-type
4658 @opindex Wno-return-type
4659 Warn whenever a function is defined with a return type that defaults
4660 to @code{int}.  Also warn about any @code{return} statement with no
4661 return value in a function whose return type is not @code{void}
4662 (falling off the end of the function body is considered returning
4663 without a value).
4665 For C only, warn about a @code{return} statement with an expression in a
4666 function whose return type is @code{void}, unless the expression type is
4667 also @code{void}.  As a GNU extension, the latter case is accepted
4668 without a warning unless @option{-Wpedantic} is used.
4670 For C++, a function without return type always produces a diagnostic
4671 message, even when @option{-Wno-return-type} is specified.  The only
4672 exceptions are @code{main} and functions defined in system headers.
4674 This warning is enabled by @option{-Wall}.
4676 @item -Wshift-count-negative
4677 @opindex Wshift-count-negative
4678 @opindex Wno-shift-count-negative
4679 Warn if shift count is negative. This warning is enabled by default.
4681 @item -Wshift-count-overflow
4682 @opindex Wshift-count-overflow
4683 @opindex Wno-shift-count-overflow
4684 Warn if shift count >= width of type. This warning is enabled by default.
4686 @item -Wshift-negative-value
4687 @opindex Wshift-negative-value
4688 @opindex Wno-shift-negative-value
4689 Warn if left shifting a negative value.  This warning is enabled by
4690 @option{-Wextra} in C99 and C++11 modes (and newer).
4692 @item -Wshift-overflow
4693 @itemx -Wshift-overflow=@var{n}
4694 @opindex Wshift-overflow
4695 @opindex Wno-shift-overflow
4696 Warn about left shift overflows.  This warning is enabled by
4697 default in C99 and C++11 modes (and newer).
4699 @table @gcctabopt
4700 @item -Wshift-overflow=1
4701 This is the warning level of @option{-Wshift-overflow} and is enabled
4702 by default in C99 and C++11 modes (and newer).  This warning level does
4703 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4704 an overflow is still rejected in contexts where an integer constant expression
4705 is required.)
4707 @item -Wshift-overflow=2
4708 This warning level also warns about left-shifting 1 into the sign bit,
4709 unless C++14 mode is active.
4710 @end table
4712 @item -Wswitch
4713 @opindex Wswitch
4714 @opindex Wno-switch
4715 Warn whenever a @code{switch} statement has an index of enumerated type
4716 and lacks a @code{case} for one or more of the named codes of that
4717 enumeration.  (The presence of a @code{default} label prevents this
4718 warning.)  @code{case} labels outside the enumeration range also
4719 provoke warnings when this option is used (even if there is a
4720 @code{default} label).
4721 This warning is enabled by @option{-Wall}.
4723 @item -Wswitch-default
4724 @opindex Wswitch-default
4725 @opindex Wno-switch-default
4726 Warn whenever a @code{switch} statement does not have a @code{default}
4727 case.
4729 @item -Wswitch-enum
4730 @opindex Wswitch-enum
4731 @opindex Wno-switch-enum
4732 Warn whenever a @code{switch} statement has an index of enumerated type
4733 and lacks a @code{case} for one or more of the named codes of that
4734 enumeration.  @code{case} labels outside the enumeration range also
4735 provoke warnings when this option is used.  The only difference
4736 between @option{-Wswitch} and this option is that this option gives a
4737 warning about an omitted enumeration code even if there is a
4738 @code{default} label.
4740 @item -Wswitch-bool
4741 @opindex Wswitch-bool
4742 @opindex Wno-switch-bool
4743 Warn whenever a @code{switch} statement has an index of boolean type
4744 and the case values are outside the range of a boolean type.
4745 It is possible to suppress this warning by casting the controlling
4746 expression to a type other than @code{bool}.  For example:
4747 @smallexample
4748 @group
4749 switch ((int) (a == 4))
4750   @{
4751   @dots{}
4752   @}
4753 @end group
4754 @end smallexample
4755 This warning is enabled by default for C and C++ programs.
4757 @item -Wswitch-unreachable
4758 @opindex Wswitch-unreachable
4759 @opindex Wno-switch-unreachable
4760 Warn whenever a @code{switch} statement contains statements between the
4761 controlling expression and the first case label, which will never be
4762 executed.  For example:
4763 @smallexample
4764 @group
4765 switch (cond)
4766   @{
4767    i = 15;
4768   @dots{}
4769    case 5:
4770   @dots{}
4771   @}
4772 @end group
4773 @end smallexample
4774 @option{-Wswitch-unreachable} does not warn if the statement between the
4775 controlling expression and the first case label is just a declaration:
4776 @smallexample
4777 @group
4778 switch (cond)
4779   @{
4780    int i;
4781   @dots{}
4782    case 5:
4783    i = 5;
4784   @dots{}
4785   @}
4786 @end group
4787 @end smallexample
4788 This warning is enabled by default for C and C++ programs.
4790 @item -Wsync-nand @r{(C and C++ only)}
4791 @opindex Wsync-nand
4792 @opindex Wno-sync-nand
4793 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4794 built-in functions are used.  These functions changed semantics in GCC 4.4.
4796 @item -Wunused-but-set-parameter
4797 @opindex Wunused-but-set-parameter
4798 @opindex Wno-unused-but-set-parameter
4799 Warn whenever a function parameter is assigned to, but otherwise unused
4800 (aside from its declaration).
4802 To suppress this warning use the @code{unused} attribute
4803 (@pxref{Variable Attributes}).
4805 This warning is also enabled by @option{-Wunused} together with
4806 @option{-Wextra}.
4808 @item -Wunused-but-set-variable
4809 @opindex Wunused-but-set-variable
4810 @opindex Wno-unused-but-set-variable
4811 Warn whenever a local variable is assigned to, but otherwise unused
4812 (aside from its declaration).
4813 This warning is enabled by @option{-Wall}.
4815 To suppress this warning use the @code{unused} attribute
4816 (@pxref{Variable Attributes}).
4818 This warning is also enabled by @option{-Wunused}, which is enabled
4819 by @option{-Wall}.
4821 @item -Wunused-function
4822 @opindex Wunused-function
4823 @opindex Wno-unused-function
4824 Warn whenever a static function is declared but not defined or a
4825 non-inline static function is unused.
4826 This warning is enabled by @option{-Wall}.
4828 @item -Wunused-label
4829 @opindex Wunused-label
4830 @opindex Wno-unused-label
4831 Warn whenever a label is declared but not used.
4832 This warning is enabled by @option{-Wall}.
4834 To suppress this warning use the @code{unused} attribute
4835 (@pxref{Variable Attributes}).
4837 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4838 @opindex Wunused-local-typedefs
4839 Warn when a typedef locally defined in a function is not used.
4840 This warning is enabled by @option{-Wall}.
4842 @item -Wunused-parameter
4843 @opindex Wunused-parameter
4844 @opindex Wno-unused-parameter
4845 Warn whenever a function parameter is unused aside from its declaration.
4847 To suppress this warning use the @code{unused} attribute
4848 (@pxref{Variable Attributes}).
4850 @item -Wno-unused-result
4851 @opindex Wunused-result
4852 @opindex Wno-unused-result
4853 Do not warn if a caller of a function marked with attribute
4854 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4855 its return value. The default is @option{-Wunused-result}.
4857 @item -Wunused-variable
4858 @opindex Wunused-variable
4859 @opindex Wno-unused-variable
4860 Warn whenever a local or static variable is unused aside from its
4861 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4862 but not for C++. This warning is enabled by @option{-Wall}.
4864 To suppress this warning use the @code{unused} attribute
4865 (@pxref{Variable Attributes}).
4867 @item -Wunused-const-variable
4868 @itemx -Wunused-const-variable=@var{n}
4869 @opindex Wunused-const-variable
4870 @opindex Wno-unused-const-variable
4871 Warn whenever a constant static variable is unused aside from its declaration.
4872 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4873 for C, but not for C++. In C this declares variable storage, but in C++ this
4874 is not an error since const variables take the place of @code{#define}s.
4876 To suppress this warning use the @code{unused} attribute
4877 (@pxref{Variable Attributes}).
4879 @table @gcctabopt
4880 @item -Wunused-const-variable=1
4881 This is the warning level that is enabled by @option{-Wunused-variable} for
4882 C.  It warns only about unused static const variables defined in the main
4883 compilation unit, but not about static const variables declared in any
4884 header included.
4886 @item -Wunused-const-variable=2
4887 This warning level also warns for unused constant static variables in
4888 headers (excluding system headers).  This is the warning level of
4889 @option{-Wunused-const-variable} and must be explicitly requested since
4890 in C++ this isn't an error and in C it might be harder to clean up all
4891 headers included.
4892 @end table
4894 @item -Wunused-value
4895 @opindex Wunused-value
4896 @opindex Wno-unused-value
4897 Warn whenever a statement computes a result that is explicitly not
4898 used. To suppress this warning cast the unused expression to
4899 @code{void}. This includes an expression-statement or the left-hand
4900 side of a comma expression that contains no side effects. For example,
4901 an expression such as @code{x[i,j]} causes a warning, while
4902 @code{x[(void)i,j]} does not.
4904 This warning is enabled by @option{-Wall}.
4906 @item -Wunused
4907 @opindex Wunused
4908 @opindex Wno-unused
4909 All the above @option{-Wunused} options combined.
4911 In order to get a warning about an unused function parameter, you must
4912 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4913 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4915 @item -Wuninitialized
4916 @opindex Wuninitialized
4917 @opindex Wno-uninitialized
4918 Warn if an automatic variable is used without first being initialized
4919 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4920 warn if a non-static reference or non-static @code{const} member
4921 appears in a class without constructors.
4923 If you want to warn about code that uses the uninitialized value of the
4924 variable in its own initializer, use the @option{-Winit-self} option.
4926 These warnings occur for individual uninitialized or clobbered
4927 elements of structure, union or array variables as well as for
4928 variables that are uninitialized or clobbered as a whole.  They do
4929 not occur for variables or elements declared @code{volatile}.  Because
4930 these warnings depend on optimization, the exact variables or elements
4931 for which there are warnings depends on the precise optimization
4932 options and version of GCC used.
4934 Note that there may be no warning about a variable that is used only
4935 to compute a value that itself is never used, because such
4936 computations may be deleted by data flow analysis before the warnings
4937 are printed.
4939 @item -Winvalid-memory-model
4940 @opindex Winvalid-memory-model
4941 @opindex Wno-invalid-memory-model
4942 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4943 and the C11 atomic generic functions with a memory consistency argument
4944 that is either invalid for the operation or outside the range of values
4945 of the @code{memory_order} enumeration.  For example, since the
4946 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4947 defined for the relaxed, release, and sequentially consistent memory
4948 orders the following code is diagnosed:
4950 @smallexample
4951 void store (int *i)
4953   __atomic_store_n (i, 0, memory_order_consume);
4955 @end smallexample
4957 @option{-Winvalid-memory-model} is enabled by default.
4959 @item -Wmaybe-uninitialized
4960 @opindex Wmaybe-uninitialized
4961 @opindex Wno-maybe-uninitialized
4962 For an automatic variable, if there exists a path from the function
4963 entry to a use of the variable that is initialized, but there exist
4964 some other paths for which the variable is not initialized, the compiler
4965 emits a warning if it cannot prove the uninitialized paths are not
4966 executed at run time. These warnings are made optional because GCC is
4967 not smart enough to see all the reasons why the code might be correct
4968 in spite of appearing to have an error.  Here is one example of how
4969 this can happen:
4971 @smallexample
4972 @group
4974   int x;
4975   switch (y)
4976     @{
4977     case 1: x = 1;
4978       break;
4979     case 2: x = 4;
4980       break;
4981     case 3: x = 5;
4982     @}
4983   foo (x);
4985 @end group
4986 @end smallexample
4988 @noindent
4989 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4990 always initialized, but GCC doesn't know this. To suppress the
4991 warning, you need to provide a default case with assert(0) or
4992 similar code.
4994 @cindex @code{longjmp} warnings
4995 This option also warns when a non-volatile automatic variable might be
4996 changed by a call to @code{longjmp}.  These warnings as well are possible
4997 only in optimizing compilation.
4999 The compiler sees only the calls to @code{setjmp}.  It cannot know
5000 where @code{longjmp} will be called; in fact, a signal handler could
5001 call it at any point in the code.  As a result, you may get a warning
5002 even when there is in fact no problem because @code{longjmp} cannot
5003 in fact be called at the place that would cause a problem.
5005 Some spurious warnings can be avoided if you declare all the functions
5006 you use that never return as @code{noreturn}.  @xref{Function
5007 Attributes}.
5009 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5011 @item -Wunknown-pragmas
5012 @opindex Wunknown-pragmas
5013 @opindex Wno-unknown-pragmas
5014 @cindex warning for unknown pragmas
5015 @cindex unknown pragmas, warning
5016 @cindex pragmas, warning of unknown
5017 Warn when a @code{#pragma} directive is encountered that is not understood by 
5018 GCC@.  If this command-line option is used, warnings are even issued
5019 for unknown pragmas in system header files.  This is not the case if
5020 the warnings are only enabled by the @option{-Wall} command-line option.
5022 @item -Wno-pragmas
5023 @opindex Wno-pragmas
5024 @opindex Wpragmas
5025 Do not warn about misuses of pragmas, such as incorrect parameters,
5026 invalid syntax, or conflicts between pragmas.  See also
5027 @option{-Wunknown-pragmas}.
5029 @item -Wstrict-aliasing
5030 @opindex Wstrict-aliasing
5031 @opindex Wno-strict-aliasing
5032 This option is only active when @option{-fstrict-aliasing} is active.
5033 It warns about code that might break the strict aliasing rules that the
5034 compiler is using for optimization.  The warning does not catch all
5035 cases, but does attempt to catch the more common pitfalls.  It is
5036 included in @option{-Wall}.
5037 It is equivalent to @option{-Wstrict-aliasing=3}
5039 @item -Wstrict-aliasing=n
5040 @opindex Wstrict-aliasing=n
5041 This option is only active when @option{-fstrict-aliasing} is active.
5042 It warns about code that might break the strict aliasing rules that the
5043 compiler is using for optimization.
5044 Higher levels correspond to higher accuracy (fewer false positives).
5045 Higher levels also correspond to more effort, similar to the way @option{-O} 
5046 works.
5047 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5049 Level 1: Most aggressive, quick, least accurate.
5050 Possibly useful when higher levels
5051 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5052 false negatives.  However, it has many false positives.
5053 Warns for all pointer conversions between possibly incompatible types,
5054 even if never dereferenced.  Runs in the front end only.
5056 Level 2: Aggressive, quick, not too precise.
5057 May still have many false positives (not as many as level 1 though),
5058 and few false negatives (but possibly more than level 1).
5059 Unlike level 1, it only warns when an address is taken.  Warns about
5060 incomplete types.  Runs in the front end only.
5062 Level 3 (default for @option{-Wstrict-aliasing}):
5063 Should have very few false positives and few false
5064 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5065 Takes care of the common pun+dereference pattern in the front end:
5066 @code{*(int*)&some_float}.
5067 If optimization is enabled, it also runs in the back end, where it deals
5068 with multiple statement cases using flow-sensitive points-to information.
5069 Only warns when the converted pointer is dereferenced.
5070 Does not warn about incomplete types.
5072 @item -Wstrict-overflow
5073 @itemx -Wstrict-overflow=@var{n}
5074 @opindex Wstrict-overflow
5075 @opindex Wno-strict-overflow
5076 This option is only active when signed overflow is undefined.
5077 It warns about cases where the compiler optimizes based on the
5078 assumption that signed overflow does not occur.  Note that it does not
5079 warn about all cases where the code might overflow: it only warns
5080 about cases where the compiler implements some optimization.  Thus
5081 this warning depends on the optimization level.
5083 An optimization that assumes that signed overflow does not occur is
5084 perfectly safe if the values of the variables involved are such that
5085 overflow never does, in fact, occur.  Therefore this warning can
5086 easily give a false positive: a warning about code that is not
5087 actually a problem.  To help focus on important issues, several
5088 warning levels are defined.  No warnings are issued for the use of
5089 undefined signed overflow when estimating how many iterations a loop
5090 requires, in particular when determining whether a loop will be
5091 executed at all.
5093 @table @gcctabopt
5094 @item -Wstrict-overflow=1
5095 Warn about cases that are both questionable and easy to avoid.  For
5096 example the compiler simplifies
5097 @code{x + 1 > x} to @code{1}.  This level of
5098 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5099 are not, and must be explicitly requested.
5101 @item -Wstrict-overflow=2
5102 Also warn about other cases where a comparison is simplified to a
5103 constant.  For example: @code{abs (x) >= 0}.  This can only be
5104 simplified when signed integer overflow is undefined, because
5105 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5106 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5107 @option{-Wstrict-overflow=2}.
5109 @item -Wstrict-overflow=3
5110 Also warn about other cases where a comparison is simplified.  For
5111 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5113 @item -Wstrict-overflow=4
5114 Also warn about other simplifications not covered by the above cases.
5115 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5117 @item -Wstrict-overflow=5
5118 Also warn about cases where the compiler reduces the magnitude of a
5119 constant involved in a comparison.  For example: @code{x + 2 > y} is
5120 simplified to @code{x + 1 >= y}.  This is reported only at the
5121 highest warning level because this simplification applies to many
5122 comparisons, so this warning level gives a very large number of
5123 false positives.
5124 @end table
5126 @item -Wstringop-overflow
5127 @itemx -Wstringop-overflow=@var{type}
5128 @opindex Wstringop-overflow
5129 @opindex Wno-stringop-overflow
5130 Warn for calls to string manipulation functions such as @code{memcpy} and
5131 @code{strcpy} that are determined to overflow the destination buffer.  The
5132 optional argument is one greater than the type of Object Size Checking to
5133 perform to determine the size of the destination.  @xref{Object Size Checking}.
5134 The argument is meaningful only for functions that operate on character arrays
5135 but not for raw memory functions like @code{memcpy} which always make use
5136 of Object Size type-0.  The option also warns for calls that specify a size
5137 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5138 The option produces the best results with optimization enabled but can detect
5139 a small subset of simple buffer overflows even without optimization in
5140 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5141 correspond to the standard functions.  In any case, the option warns about
5142 just a subset of buffer overflows detected by the corresponding overflow
5143 checking built-ins.  For example, the option will issue a warning for
5144 the @code{strcpy} call below because it copies at least 5 characters
5145 (the string @code{"blue"} including the terminating NUL) into the buffer
5146 of size 4.
5148 @smallexample
5149 enum Color @{ blue, purple, yellow @};
5150 const char* f (enum Color clr)
5152   static char buf [4];
5153   const char *str;
5154   switch (clr)
5155     @{
5156       case blue: str = "blue"; break;
5157       case purple: str = "purple"; break;
5158       case yellow: str = "yellow"; break;
5159     @}
5161   return strcpy (buf, str);   // warning here
5163 @end smallexample
5165 Option @option{-Wstringop-overflow=2} is enabled by default.
5167 @table @gcctabopt
5168 @item -Wstringop-overflow
5169 @item -Wstringop-overflow=1
5170 @opindex Wstringop-overflow
5171 @opindex Wno-stringop-overflow
5172 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5173 to determine the sizes of destination objects.  This is the default setting
5174 of the option.  At this setting the option will not warn for writes past
5175 the end of subobjects of larger objects accessed by pointers unless the
5176 size of the largest surrounding object is known.  When the destination may
5177 be one of several objects it is assumed to be the largest one of them.  On
5178 Linux systems, when optimization is enabled at this setting the option warns
5179 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5180 a non-zero value.
5182 @item -Wstringop-overflow=2
5183 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5184 to determine the sizes of destination objects.  At this setting the option
5185 will warn about overflows when writing to members of the largest complete
5186 objects whose exact size is known.  It will, however, not warn for excessive
5187 writes to the same members of unknown objects referenced by pointers since
5188 they may point to arrays containing unknown numbers of elements.
5190 @item -Wstringop-overflow=3
5191 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5192 to determine the sizes of destination objects.  At this setting the option
5193 warns about overflowing the smallest object or data member.  This is the
5194 most restrictive setting of the option that may result in warnings for safe
5195 code.
5197 @item -Wstringop-overflow=4
5198 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5199 to determine the sizes of destination objects.  At this setting the option
5200 will warn about overflowing any data members, and when the destination is
5201 one of several objects it uses the size of the largest of them to decide
5202 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5203 setting of the option may result in warnings for benign code.
5204 @end table
5206 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{]}
5207 @opindex Wsuggest-attribute=
5208 @opindex Wno-suggest-attribute=
5209 Warn for cases where adding an attribute may be beneficial. The
5210 attributes currently supported are listed below.
5212 @table @gcctabopt
5213 @item -Wsuggest-attribute=pure
5214 @itemx -Wsuggest-attribute=const
5215 @itemx -Wsuggest-attribute=noreturn
5216 @opindex Wsuggest-attribute=pure
5217 @opindex Wno-suggest-attribute=pure
5218 @opindex Wsuggest-attribute=const
5219 @opindex Wno-suggest-attribute=const
5220 @opindex Wsuggest-attribute=noreturn
5221 @opindex Wno-suggest-attribute=noreturn
5223 Warn about functions that might be candidates for attributes
5224 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5225 functions visible in other compilation units or (in the case of @code{pure} and
5226 @code{const}) if it cannot prove that the function returns normally. A function
5227 returns normally if it doesn't contain an infinite loop or return abnormally
5228 by throwing, calling @code{abort} or trapping.  This analysis requires option
5229 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5230 higher.  Higher optimization levels improve the accuracy of the analysis.
5232 @item -Wsuggest-attribute=format
5233 @itemx -Wmissing-format-attribute
5234 @opindex Wsuggest-attribute=format
5235 @opindex Wmissing-format-attribute
5236 @opindex Wno-suggest-attribute=format
5237 @opindex Wno-missing-format-attribute
5238 @opindex Wformat
5239 @opindex Wno-format
5241 Warn about function pointers that might be candidates for @code{format}
5242 attributes.  Note these are only possible candidates, not absolute ones.
5243 GCC guesses that function pointers with @code{format} attributes that
5244 are used in assignment, initialization, parameter passing or return
5245 statements should have a corresponding @code{format} attribute in the
5246 resulting type.  I.e.@: the left-hand side of the assignment or
5247 initialization, the type of the parameter variable, or the return type
5248 of the containing function respectively should also have a @code{format}
5249 attribute to avoid the warning.
5251 GCC also warns about function definitions that might be
5252 candidates for @code{format} attributes.  Again, these are only
5253 possible candidates.  GCC guesses that @code{format} attributes
5254 might be appropriate for any function that calls a function like
5255 @code{vprintf} or @code{vscanf}, but this might not always be the
5256 case, and some functions for which @code{format} attributes are
5257 appropriate may not be detected.
5259 @item -Wsuggest-attribute=cold
5260 @opindex Wsuggest-attribute=cold
5261 @opindex Wno-suggest-attribute=cold
5263 Warn about functions that might be candidates for @code{cold} attribute.  This
5264 is based on static detection and generally will only warn about functions which
5265 always leads to a call to another @code{cold} function such as wrappers of
5266 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5267 @end table
5269 @item -Wsuggest-final-types
5270 @opindex Wno-suggest-final-types
5271 @opindex Wsuggest-final-types
5272 Warn about types with virtual methods where code quality would be improved
5273 if the type were declared with the C++11 @code{final} specifier, 
5274 or, if possible,
5275 declared in an anonymous namespace. This allows GCC to more aggressively
5276 devirtualize the polymorphic calls. This warning is more effective with link
5277 time optimization, where the information about the class hierarchy graph is
5278 more complete.
5280 @item -Wsuggest-final-methods
5281 @opindex Wno-suggest-final-methods
5282 @opindex Wsuggest-final-methods
5283 Warn about virtual methods where code quality would be improved if the method
5284 were declared with the C++11 @code{final} specifier, 
5285 or, if possible, its type were
5286 declared in an anonymous namespace or with the @code{final} specifier.
5287 This warning is
5288 more effective with link-time optimization, where the information about the
5289 class hierarchy graph is more complete. It is recommended to first consider
5290 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5291 annotations.
5293 @item -Wsuggest-override
5294 Warn about overriding virtual functions that are not marked with the override
5295 keyword.
5297 @item -Walloc-zero
5298 @opindex Wno-alloc-zero
5299 @opindex Walloc-zero
5300 Warn about calls to allocation functions decorated with attribute
5301 @code{alloc_size} that specify zero bytes, including those to the built-in
5302 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5303 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5304 when called with a zero size differs among implementations (and in the case
5305 of @code{realloc} has been deprecated) relying on it may result in subtle
5306 portability bugs and should be avoided.
5308 @item -Walloc-size-larger-than=@var{n}
5309 Warn about calls to functions decorated with attribute @code{alloc_size}
5310 that attempt to allocate objects larger than the specified number of bytes,
5311 or where the result of the size computation in an integer type with infinite
5312 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5313 may end in one of the standard suffixes designating a multiple of bytes
5314 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5315 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5316 @xref{Function Attributes}.
5318 @item -Walloca
5319 @opindex Wno-alloca
5320 @opindex Walloca
5321 This option warns on all uses of @code{alloca} in the source.
5323 @item -Walloca-larger-than=@var{n}
5324 This option warns on calls to @code{alloca} that are not bounded by a
5325 controlling predicate limiting its argument of integer type to at most
5326 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5327 Arguments of non-integer types are considered unbounded even if they
5328 appear to be constrained to the expected range.
5330 For example, a bounded case of @code{alloca} could be:
5332 @smallexample
5333 void func (size_t n)
5335   void *p;
5336   if (n <= 1000)
5337     p = alloca (n);
5338   else
5339     p = malloc (n);
5340   f (p);
5342 @end smallexample
5344 In the above example, passing @code{-Walloca-larger-than=1000} would not
5345 issue a warning because the call to @code{alloca} is known to be at most
5346 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5347 the compiler would emit a warning.
5349 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5350 controlling predicate constraining its integer argument.  For example:
5352 @smallexample
5353 void func ()
5355   void *p = alloca (n);
5356   f (p);
5358 @end smallexample
5360 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5361 a warning, but this time because of the lack of bounds checking.
5363 Note, that even seemingly correct code involving signed integers could
5364 cause a warning:
5366 @smallexample
5367 void func (signed int n)
5369   if (n < 500)
5370     @{
5371       p = alloca (n);
5372       f (p);
5373     @}
5375 @end smallexample
5377 In the above example, @var{n} could be negative, causing a larger than
5378 expected argument to be implicitly cast into the @code{alloca} call.
5380 This option also warns when @code{alloca} is used in a loop.
5382 This warning is not enabled by @option{-Wall}, and is only active when
5383 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5385 See also @option{-Wvla-larger-than=@var{n}}.
5387 @item -Warray-bounds
5388 @itemx -Warray-bounds=@var{n}
5389 @opindex Wno-array-bounds
5390 @opindex Warray-bounds
5391 This option is only active when @option{-ftree-vrp} is active
5392 (default for @option{-O2} and above). It warns about subscripts to arrays
5393 that are always out of bounds. This warning is enabled by @option{-Wall}.
5395 @table @gcctabopt
5396 @item -Warray-bounds=1
5397 This is the warning level of @option{-Warray-bounds} and is enabled
5398 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5400 @item -Warray-bounds=2
5401 This warning level also warns about out of bounds access for
5402 arrays at the end of a struct and for arrays accessed through
5403 pointers. This warning level may give a larger number of
5404 false positives and is deactivated by default.
5405 @end table
5407 @item -Wattribute-alias
5408 Warn about declarations using the @code{alias} and similar attributes whose
5409 target is incompatible with the type of the alias.  @xref{Function Attributes,
5410 ,Declaring Attributes of Functions}.
5412 @item -Wbool-compare
5413 @opindex Wno-bool-compare
5414 @opindex Wbool-compare
5415 Warn about boolean expression compared with an integer value different from
5416 @code{true}/@code{false}.  For instance, the following comparison is
5417 always false:
5418 @smallexample
5419 int n = 5;
5420 @dots{}
5421 if ((n > 1) == 2) @{ @dots{} @}
5422 @end smallexample
5423 This warning is enabled by @option{-Wall}.
5425 @item -Wbool-operation
5426 @opindex Wno-bool-operation
5427 @opindex Wbool-operation
5428 Warn about suspicious operations on expressions of a boolean type.  For
5429 instance, bitwise negation of a boolean is very likely a bug in the program.
5430 For C, this warning also warns about incrementing or decrementing a boolean,
5431 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5432 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5434 This warning is enabled by @option{-Wall}.
5436 @item -Wduplicated-branches
5437 @opindex Wno-duplicated-branches
5438 @opindex Wduplicated-branches
5439 Warn when an if-else has identical branches.  This warning detects cases like
5440 @smallexample
5441 if (p != NULL)
5442   return 0;
5443 else
5444   return 0;
5445 @end smallexample
5446 It doesn't warn when both branches contain just a null statement.  This warning
5447 also warn for conditional operators:
5448 @smallexample
5449   int i = x ? *p : *p;
5450 @end smallexample
5452 @item -Wduplicated-cond
5453 @opindex Wno-duplicated-cond
5454 @opindex Wduplicated-cond
5455 Warn about duplicated conditions in an if-else-if chain.  For instance,
5456 warn for the following code:
5457 @smallexample
5458 if (p->q != NULL) @{ @dots{} @}
5459 else if (p->q != NULL) @{ @dots{} @}
5460 @end smallexample
5462 @item -Wframe-address
5463 @opindex Wno-frame-address
5464 @opindex Wframe-address
5465 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5466 is called with an argument greater than 0.  Such calls may return indeterminate
5467 values or crash the program.  The warning is included in @option{-Wall}.
5469 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5470 @opindex Wno-discarded-qualifiers
5471 @opindex Wdiscarded-qualifiers
5472 Do not warn if type qualifiers on pointers are being discarded.
5473 Typically, the compiler warns if a @code{const char *} variable is
5474 passed to a function that takes a @code{char *} parameter.  This option
5475 can be used to suppress such a warning.
5477 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5478 @opindex Wno-discarded-array-qualifiers
5479 @opindex Wdiscarded-array-qualifiers
5480 Do not warn if type qualifiers on arrays which are pointer targets
5481 are being discarded. Typically, the compiler warns if a
5482 @code{const int (*)[]} variable is passed to a function that
5483 takes a @code{int (*)[]} parameter.  This option can be used to
5484 suppress such a warning.
5486 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5487 @opindex Wno-incompatible-pointer-types
5488 @opindex Wincompatible-pointer-types
5489 Do not warn when there is a conversion between pointers that have incompatible
5490 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5491 which warns for pointer argument passing or assignment with different
5492 signedness.
5494 @item -Wno-int-conversion @r{(C and Objective-C only)}
5495 @opindex Wno-int-conversion
5496 @opindex Wint-conversion
5497 Do not warn about incompatible integer to pointer and pointer to integer
5498 conversions.  This warning is about implicit conversions; for explicit
5499 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5500 @option{-Wno-pointer-to-int-cast} may be used.
5502 @item -Wno-div-by-zero
5503 @opindex Wno-div-by-zero
5504 @opindex Wdiv-by-zero
5505 Do not warn about compile-time integer division by zero.  Floating-point
5506 division by zero is not warned about, as it can be a legitimate way of
5507 obtaining infinities and NaNs.
5509 @item -Wsystem-headers
5510 @opindex Wsystem-headers
5511 @opindex Wno-system-headers
5512 @cindex warnings from system headers
5513 @cindex system headers, warnings from
5514 Print warning messages for constructs found in system header files.
5515 Warnings from system headers are normally suppressed, on the assumption
5516 that they usually do not indicate real problems and would only make the
5517 compiler output harder to read.  Using this command-line option tells
5518 GCC to emit warnings from system headers as if they occurred in user
5519 code.  However, note that using @option{-Wall} in conjunction with this
5520 option does @emph{not} warn about unknown pragmas in system
5521 headers---for that, @option{-Wunknown-pragmas} must also be used.
5523 @item -Wtautological-compare
5524 @opindex Wtautological-compare
5525 @opindex Wno-tautological-compare
5526 Warn if a self-comparison always evaluates to true or false.  This
5527 warning detects various mistakes such as:
5528 @smallexample
5529 int i = 1;
5530 @dots{}
5531 if (i > i) @{ @dots{} @}
5532 @end smallexample
5534 This warning also warns about bitwise comparisons that always evaluate
5535 to true or false, for instance:
5536 @smallexample
5537 if ((a & 16) == 10) @{ @dots{} @}
5538 @end smallexample
5539 will always be false.
5541 This warning is enabled by @option{-Wall}.
5543 @item -Wtrampolines
5544 @opindex Wtrampolines
5545 @opindex Wno-trampolines
5546 Warn about trampolines generated for pointers to nested functions.
5547 A trampoline is a small piece of data or code that is created at run
5548 time on the stack when the address of a nested function is taken, and is
5549 used to call the nested function indirectly.  For some targets, it is
5550 made up of data only and thus requires no special treatment.  But, for
5551 most targets, it is made up of code and thus requires the stack to be
5552 made executable in order for the program to work properly.
5554 @item -Wfloat-equal
5555 @opindex Wfloat-equal
5556 @opindex Wno-float-equal
5557 Warn if floating-point values are used in equality comparisons.
5559 The idea behind this is that sometimes it is convenient (for the
5560 programmer) to consider floating-point values as approximations to
5561 infinitely precise real numbers.  If you are doing this, then you need
5562 to compute (by analyzing the code, or in some other way) the maximum or
5563 likely maximum error that the computation introduces, and allow for it
5564 when performing comparisons (and when producing output, but that's a
5565 different problem).  In particular, instead of testing for equality, you
5566 should check to see whether the two values have ranges that overlap; and
5567 this is done with the relational operators, so equality comparisons are
5568 probably mistaken.
5570 @item -Wtraditional @r{(C and Objective-C only)}
5571 @opindex Wtraditional
5572 @opindex Wno-traditional
5573 Warn about certain constructs that behave differently in traditional and
5574 ISO C@.  Also warn about ISO C constructs that have no traditional C
5575 equivalent, and/or problematic constructs that should be avoided.
5577 @itemize @bullet
5578 @item
5579 Macro parameters that appear within string literals in the macro body.
5580 In traditional C macro replacement takes place within string literals,
5581 but in ISO C it does not.
5583 @item
5584 In traditional C, some preprocessor directives did not exist.
5585 Traditional preprocessors only considered a line to be a directive
5586 if the @samp{#} appeared in column 1 on the line.  Therefore
5587 @option{-Wtraditional} warns about directives that traditional C
5588 understands but ignores because the @samp{#} does not appear as the
5589 first character on the line.  It also suggests you hide directives like
5590 @code{#pragma} not understood by traditional C by indenting them.  Some
5591 traditional implementations do not recognize @code{#elif}, so this option
5592 suggests avoiding it altogether.
5594 @item
5595 A function-like macro that appears without arguments.
5597 @item
5598 The unary plus operator.
5600 @item
5601 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5602 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5603 constants.)  Note, these suffixes appear in macros defined in the system
5604 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5605 Use of these macros in user code might normally lead to spurious
5606 warnings, however GCC's integrated preprocessor has enough context to
5607 avoid warning in these cases.
5609 @item
5610 A function declared external in one block and then used after the end of
5611 the block.
5613 @item
5614 A @code{switch} statement has an operand of type @code{long}.
5616 @item
5617 A non-@code{static} function declaration follows a @code{static} one.
5618 This construct is not accepted by some traditional C compilers.
5620 @item
5621 The ISO type of an integer constant has a different width or
5622 signedness from its traditional type.  This warning is only issued if
5623 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5624 typically represent bit patterns, are not warned about.
5626 @item
5627 Usage of ISO string concatenation is detected.
5629 @item
5630 Initialization of automatic aggregates.
5632 @item
5633 Identifier conflicts with labels.  Traditional C lacks a separate
5634 namespace for labels.
5636 @item
5637 Initialization of unions.  If the initializer is zero, the warning is
5638 omitted.  This is done under the assumption that the zero initializer in
5639 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5640 initializer warnings and relies on default initialization to zero in the
5641 traditional C case.
5643 @item
5644 Conversions by prototypes between fixed/floating-point values and vice
5645 versa.  The absence of these prototypes when compiling with traditional
5646 C causes serious problems.  This is a subset of the possible
5647 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5649 @item
5650 Use of ISO C style function definitions.  This warning intentionally is
5651 @emph{not} issued for prototype declarations or variadic functions
5652 because these ISO C features appear in your code when using
5653 libiberty's traditional C compatibility macros, @code{PARAMS} and
5654 @code{VPARAMS}.  This warning is also bypassed for nested functions
5655 because that feature is already a GCC extension and thus not relevant to
5656 traditional C compatibility.
5657 @end itemize
5659 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5660 @opindex Wtraditional-conversion
5661 @opindex Wno-traditional-conversion
5662 Warn if a prototype causes a type conversion that is different from what
5663 would happen to the same argument in the absence of a prototype.  This
5664 includes conversions of fixed point to floating and vice versa, and
5665 conversions changing the width or signedness of a fixed-point argument
5666 except when the same as the default promotion.
5668 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5669 @opindex Wdeclaration-after-statement
5670 @opindex Wno-declaration-after-statement
5671 Warn when a declaration is found after a statement in a block.  This
5672 construct, known from C++, was introduced with ISO C99 and is by default
5673 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5675 @item -Wshadow
5676 @opindex Wshadow
5677 @opindex Wno-shadow
5678 Warn whenever a local variable or type declaration shadows another
5679 variable, parameter, type, class member (in C++), or instance variable
5680 (in Objective-C) or whenever a built-in function is shadowed. Note
5681 that in C++, the compiler warns if a local variable shadows an
5682 explicit typedef, but not if it shadows a struct/class/enum.
5683 Same as @option{-Wshadow=global}.
5685 @item -Wno-shadow-ivar @r{(Objective-C only)}
5686 @opindex Wno-shadow-ivar
5687 @opindex Wshadow-ivar
5688 Do not warn whenever a local variable shadows an instance variable in an
5689 Objective-C method.
5691 @item -Wshadow=global
5692 @opindex Wshadow=local
5693 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5695 @item -Wshadow=local
5696 @opindex Wshadow=local
5697 Warn when a local variable shadows another local variable or parameter.
5698 This warning is enabled by @option{-Wshadow=global}.
5700 @item -Wshadow=compatible-local
5701 @opindex Wshadow=compatible-local
5702 Warn when a local variable shadows another local variable or parameter
5703 whose type is compatible with that of the shadowing variable. In C++,
5704 type compatibility here means the type of the shadowing variable can be
5705 converted to that of the shadowed variable. The creation of this flag
5706 (in addition to @option{-Wshadow=local}) is based on the idea that when
5707 a local variable shadows another one of incompatible type, it is most
5708 likely intentional, not a bug or typo, as shown in the following example:
5710 @smallexample
5711 @group
5712 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5714   for (int i = 0; i < N; ++i)
5715   @{
5716     ...
5717   @}
5718   ...
5720 @end group
5721 @end smallexample
5723 Since the two variable @code{i} in the example above have incompatible types,
5724 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5725 Because their types are incompatible, if a programmer accidentally uses one
5726 in place of the other, type checking will catch that and emit an error or
5727 warning. So not warning (about shadowing) in this case will not lead to
5728 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5729 possibly reduce the number of warnings triggered by intentional shadowing.
5731 This warning is enabled by @option{-Wshadow=local}.
5733 @item -Wlarger-than=@var{len}
5734 @opindex Wlarger-than=@var{len}
5735 @opindex Wlarger-than-@var{len}
5736 Warn whenever an object of larger than @var{len} bytes is defined.
5738 @item -Wframe-larger-than=@var{len}
5739 @opindex Wframe-larger-than
5740 Warn if the size of a function frame is larger than @var{len} bytes.
5741 The computation done to determine the stack frame size is approximate
5742 and not conservative.
5743 The actual requirements may be somewhat greater than @var{len}
5744 even if you do not get a warning.  In addition, any space allocated
5745 via @code{alloca}, variable-length arrays, or related constructs
5746 is not included by the compiler when determining
5747 whether or not to issue a warning.
5749 @item -Wno-free-nonheap-object
5750 @opindex Wno-free-nonheap-object
5751 @opindex Wfree-nonheap-object
5752 Do not warn when attempting to free an object that was not allocated
5753 on the heap.
5755 @item -Wstack-usage=@var{len}
5756 @opindex Wstack-usage
5757 Warn if the stack usage of a function might be larger than @var{len} bytes.
5758 The computation done to determine the stack usage is conservative.
5759 Any space allocated via @code{alloca}, variable-length arrays, or related
5760 constructs is included by the compiler when determining whether or not to
5761 issue a warning.
5763 The message is in keeping with the output of @option{-fstack-usage}.
5765 @itemize
5766 @item
5767 If the stack usage is fully static but exceeds the specified amount, it's:
5769 @smallexample
5770   warning: stack usage is 1120 bytes
5771 @end smallexample
5772 @item
5773 If the stack usage is (partly) dynamic but bounded, it's:
5775 @smallexample
5776   warning: stack usage might be 1648 bytes
5777 @end smallexample
5778 @item
5779 If the stack usage is (partly) dynamic and not bounded, it's:
5781 @smallexample
5782   warning: stack usage might be unbounded
5783 @end smallexample
5784 @end itemize
5786 @item -Wunsafe-loop-optimizations
5787 @opindex Wunsafe-loop-optimizations
5788 @opindex Wno-unsafe-loop-optimizations
5789 Warn if the loop cannot be optimized because the compiler cannot
5790 assume anything on the bounds of the loop indices.  With
5791 @option{-funsafe-loop-optimizations} warn if the compiler makes
5792 such assumptions.
5794 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5795 @opindex Wno-pedantic-ms-format
5796 @opindex Wpedantic-ms-format
5797 When used in combination with @option{-Wformat}
5798 and @option{-pedantic} without GNU extensions, this option
5799 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5800 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5801 which depend on the MS runtime.
5803 @item -Waligned-new
5804 @opindex Waligned-new
5805 @opindex Wno-aligned-new
5806 Warn about a new-expression of a type that requires greater alignment
5807 than the @code{alignof(std::max_align_t)} but uses an allocation
5808 function without an explicit alignment parameter. This option is
5809 enabled by @option{-Wall}.
5811 Normally this only warns about global allocation functions, but
5812 @option{-Waligned-new=all} also warns about class member allocation
5813 functions.
5815 @item -Wplacement-new
5816 @itemx -Wplacement-new=@var{n}
5817 @opindex Wplacement-new
5818 @opindex Wno-placement-new
5819 Warn about placement new expressions with undefined behavior, such as
5820 constructing an object in a buffer that is smaller than the type of
5821 the object.  For example, the placement new expression below is diagnosed
5822 because it attempts to construct an array of 64 integers in a buffer only
5823 64 bytes large.
5824 @smallexample
5825 char buf [64];
5826 new (buf) int[64];
5827 @end smallexample
5828 This warning is enabled by default.
5830 @table @gcctabopt
5831 @item -Wplacement-new=1
5832 This is the default warning level of @option{-Wplacement-new}.  At this
5833 level the warning is not issued for some strictly undefined constructs that
5834 GCC allows as extensions for compatibility with legacy code.  For example,
5835 the following @code{new} expression is not diagnosed at this level even
5836 though it has undefined behavior according to the C++ standard because
5837 it writes past the end of the one-element array.
5838 @smallexample
5839 struct S @{ int n, a[1]; @};
5840 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5841 new (s->a)int [32]();
5842 @end smallexample
5844 @item -Wplacement-new=2
5845 At this level, in addition to diagnosing all the same constructs as at level
5846 1, a diagnostic is also issued for placement new expressions that construct
5847 an object in the last member of structure whose type is an array of a single
5848 element and whose size is less than the size of the object being constructed.
5849 While the previous example would be diagnosed, the following construct makes
5850 use of the flexible member array extension to avoid the warning at level 2.
5851 @smallexample
5852 struct S @{ int n, a[]; @};
5853 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5854 new (s->a)int [32]();
5855 @end smallexample
5857 @end table
5859 @item -Wpointer-arith
5860 @opindex Wpointer-arith
5861 @opindex Wno-pointer-arith
5862 Warn about anything that depends on the ``size of'' a function type or
5863 of @code{void}.  GNU C assigns these types a size of 1, for
5864 convenience in calculations with @code{void *} pointers and pointers
5865 to functions.  In C++, warn also when an arithmetic operation involves
5866 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5868 @item -Wpointer-compare
5869 @opindex Wpointer-compare
5870 @opindex Wno-pointer-compare
5871 Warn if a pointer is compared with a zero character constant.  This usually
5872 means that the pointer was meant to be dereferenced.  For example:
5874 @smallexample
5875 const char *p = foo ();
5876 if (p == '\0')
5877   return 42;
5878 @end smallexample
5880 Note that the code above is invalid in C++11.
5882 This warning is enabled by default.
5884 @item -Wtype-limits
5885 @opindex Wtype-limits
5886 @opindex Wno-type-limits
5887 Warn if a comparison is always true or always false due to the limited
5888 range of the data type, but do not warn for constant expressions.  For
5889 example, warn if an unsigned variable is compared against zero with
5890 @code{<} or @code{>=}.  This warning is also enabled by
5891 @option{-Wextra}.
5893 @include cppwarnopts.texi
5895 @item -Wbad-function-cast @r{(C and Objective-C only)}
5896 @opindex Wbad-function-cast
5897 @opindex Wno-bad-function-cast
5898 Warn when a function call is cast to a non-matching type.
5899 For example, warn if a call to a function returning an integer type 
5900 is cast to a pointer type.
5902 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5903 @opindex Wc90-c99-compat
5904 @opindex Wno-c90-c99-compat
5905 Warn about features not present in ISO C90, but present in ISO C99.
5906 For instance, warn about use of variable length arrays, @code{long long}
5907 type, @code{bool} type, compound literals, designated initializers, and so
5908 on.  This option is independent of the standards mode.  Warnings are disabled
5909 in the expression that follows @code{__extension__}.
5911 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5912 @opindex Wc99-c11-compat
5913 @opindex Wno-c99-c11-compat
5914 Warn about features not present in ISO C99, but present in ISO C11.
5915 For instance, warn about use of anonymous structures and unions,
5916 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5917 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5918 and so on.  This option is independent of the standards mode.  Warnings are
5919 disabled in the expression that follows @code{__extension__}.
5921 @item -Wc++-compat @r{(C and Objective-C only)}
5922 @opindex Wc++-compat
5923 Warn about ISO C constructs that are outside of the common subset of
5924 ISO C and ISO C++, e.g.@: request for implicit conversion from
5925 @code{void *} to a pointer to non-@code{void} type.
5927 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5928 @opindex Wc++11-compat
5929 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5930 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5931 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5932 enabled by @option{-Wall}.
5934 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5935 @opindex Wc++14-compat
5936 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5937 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5939 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
5940 @opindex Wc++17-compat
5941 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5942 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
5944 @item -Wcast-qual
5945 @opindex Wcast-qual
5946 @opindex Wno-cast-qual
5947 Warn whenever a pointer is cast so as to remove a type qualifier from
5948 the target type.  For example, warn if a @code{const char *} is cast
5949 to an ordinary @code{char *}.
5951 Also warn when making a cast that introduces a type qualifier in an
5952 unsafe way.  For example, casting @code{char **} to @code{const char **}
5953 is unsafe, as in this example:
5955 @smallexample
5956   /* p is char ** value.  */
5957   const char **q = (const char **) p;
5958   /* Assignment of readonly string to const char * is OK.  */
5959   *q = "string";
5960   /* Now char** pointer points to read-only memory.  */
5961   **p = 'b';
5962 @end smallexample
5964 @item -Wcast-align
5965 @opindex Wcast-align
5966 @opindex Wno-cast-align
5967 Warn whenever a pointer is cast such that the required alignment of the
5968 target is increased.  For example, warn if a @code{char *} is cast to
5969 an @code{int *} on machines where integers can only be accessed at
5970 two- or four-byte boundaries.
5972 @item -Wcast-align=strict
5973 @opindex Wcast-align=strict
5974 Warn whenever a pointer is cast such that the required alignment of the
5975 target is increased.  For example, warn if a @code{char *} is cast to
5976 an @code{int *} regardless of the target machine.
5978 @item -Wwrite-strings
5979 @opindex Wwrite-strings
5980 @opindex Wno-write-strings
5981 When compiling C, give string constants the type @code{const
5982 char[@var{length}]} so that copying the address of one into a
5983 non-@code{const} @code{char *} pointer produces a warning.  These
5984 warnings help you find at compile time code that can try to write
5985 into a string constant, but only if you have been very careful about
5986 using @code{const} in declarations and prototypes.  Otherwise, it is
5987 just a nuisance. This is why we did not make @option{-Wall} request
5988 these warnings.
5990 When compiling C++, warn about the deprecated conversion from string
5991 literals to @code{char *}.  This warning is enabled by default for C++
5992 programs.
5994 @item -Wcatch-value
5995 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5996 @opindex Wcatch-value
5997 @opindex Wno-catch-value
5998 Warn about catch handlers that do not catch via reference.
5999 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6000 warn about polymorphic class types that are caught by value.
6001 With @option{-Wcatch-value=2} warn about all class types that are caught
6002 by value. With @option{-Wcatch-value=3} warn about all types that are
6003 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6005 @item -Wclobbered
6006 @opindex Wclobbered
6007 @opindex Wno-clobbered
6008 Warn for variables that might be changed by @code{longjmp} or
6009 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6011 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6012 @opindex Wconditionally-supported
6013 @opindex Wno-conditionally-supported
6014 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6016 @item -Wconversion
6017 @opindex Wconversion
6018 @opindex Wno-conversion
6019 Warn for implicit conversions that may alter a value. This includes
6020 conversions between real and integer, like @code{abs (x)} when
6021 @code{x} is @code{double}; conversions between signed and unsigned,
6022 like @code{unsigned ui = -1}; and conversions to smaller types, like
6023 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6024 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6025 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6026 conversions between signed and unsigned integers can be disabled by
6027 using @option{-Wno-sign-conversion}.
6029 For C++, also warn for confusing overload resolution for user-defined
6030 conversions; and conversions that never use a type conversion
6031 operator: conversions to @code{void}, the same type, a base class or a
6032 reference to them. Warnings about conversions between signed and
6033 unsigned integers are disabled by default in C++ unless
6034 @option{-Wsign-conversion} is explicitly enabled.
6036 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6037 @opindex Wconversion-null
6038 @opindex Wno-conversion-null
6039 Do not warn for conversions between @code{NULL} and non-pointer
6040 types. @option{-Wconversion-null} is enabled by default.
6042 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6043 @opindex Wzero-as-null-pointer-constant
6044 @opindex Wno-zero-as-null-pointer-constant
6045 Warn when a literal @samp{0} is used as null pointer constant.  This can
6046 be useful to facilitate the conversion to @code{nullptr} in C++11.
6048 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6049 @opindex Wsubobject-linkage
6050 @opindex Wno-subobject-linkage
6051 Warn if a class type has a base or a field whose type uses the anonymous
6052 namespace or depends on a type with no linkage.  If a type A depends on
6053 a type B with no or internal linkage, defining it in multiple
6054 translation units would be an ODR violation because the meaning of B
6055 is different in each translation unit.  If A only appears in a single
6056 translation unit, the best way to silence the warning is to give it
6057 internal linkage by putting it in an anonymous namespace as well.  The
6058 compiler doesn't give this warning for types defined in the main .C
6059 file, as those are unlikely to have multiple definitions.
6060 @option{-Wsubobject-linkage} is enabled by default.
6062 @item -Wdangling-else
6063 @opindex Wdangling-else
6064 @opindex Wno-dangling-else
6065 Warn about constructions where there may be confusion to which
6066 @code{if} statement an @code{else} branch belongs.  Here is an example of
6067 such a case:
6069 @smallexample
6070 @group
6072   if (a)
6073     if (b)
6074       foo ();
6075   else
6076     bar ();
6078 @end group
6079 @end smallexample
6081 In C/C++, every @code{else} branch belongs to the innermost possible
6082 @code{if} statement, which in this example is @code{if (b)}.  This is
6083 often not what the programmer expected, as illustrated in the above
6084 example by indentation the programmer chose.  When there is the
6085 potential for this confusion, GCC issues a warning when this flag
6086 is specified.  To eliminate the warning, add explicit braces around
6087 the innermost @code{if} statement so there is no way the @code{else}
6088 can belong to the enclosing @code{if}.  The resulting code
6089 looks like this:
6091 @smallexample
6092 @group
6094   if (a)
6095     @{
6096       if (b)
6097         foo ();
6098       else
6099         bar ();
6100     @}
6102 @end group
6103 @end smallexample
6105 This warning is enabled by @option{-Wparentheses}.
6107 @item -Wdate-time
6108 @opindex Wdate-time
6109 @opindex Wno-date-time
6110 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6111 are encountered as they might prevent bit-wise-identical reproducible
6112 compilations.
6114 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6115 @opindex Wdelete-incomplete
6116 @opindex Wno-delete-incomplete
6117 Warn when deleting a pointer to incomplete type, which may cause
6118 undefined behavior at runtime.  This warning is enabled by default.
6120 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6121 @opindex Wuseless-cast
6122 @opindex Wno-useless-cast
6123 Warn when an expression is casted to its own type.
6125 @item -Wempty-body
6126 @opindex Wempty-body
6127 @opindex Wno-empty-body
6128 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6129 while} statement.  This warning is also enabled by @option{-Wextra}.
6131 @item -Wenum-compare
6132 @opindex Wenum-compare
6133 @opindex Wno-enum-compare
6134 Warn about a comparison between values of different enumerated types.
6135 In C++ enumerated type mismatches in conditional expressions are also
6136 diagnosed and the warning is enabled by default.  In C this warning is 
6137 enabled by @option{-Wall}.
6139 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6140 @opindex Wextra-semi
6141 @opindex Wno-extra-semi
6142 Warn about redundant semicolon after in-class function definition.
6144 @item -Wjump-misses-init @r{(C, Objective-C only)}
6145 @opindex Wjump-misses-init
6146 @opindex Wno-jump-misses-init
6147 Warn if a @code{goto} statement or a @code{switch} statement jumps
6148 forward across the initialization of a variable, or jumps backward to a
6149 label after the variable has been initialized.  This only warns about
6150 variables that are initialized when they are declared.  This warning is
6151 only supported for C and Objective-C; in C++ this sort of branch is an
6152 error in any case.
6154 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6155 can be disabled with the @option{-Wno-jump-misses-init} option.
6157 @item -Wsign-compare
6158 @opindex Wsign-compare
6159 @opindex Wno-sign-compare
6160 @cindex warning for comparison of signed and unsigned values
6161 @cindex comparison of signed and unsigned values, warning
6162 @cindex signed and unsigned values, comparison warning
6163 Warn when a comparison between signed and unsigned values could produce
6164 an incorrect result when the signed value is converted to unsigned.
6165 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6166 also enabled by @option{-Wextra}.
6168 @item -Wsign-conversion
6169 @opindex Wsign-conversion
6170 @opindex Wno-sign-conversion
6171 Warn for implicit conversions that may change the sign of an integer
6172 value, like assigning a signed integer expression to an unsigned
6173 integer variable. An explicit cast silences the warning. In C, this
6174 option is enabled also by @option{-Wconversion}.
6176 @item -Wfloat-conversion
6177 @opindex Wfloat-conversion
6178 @opindex Wno-float-conversion
6179 Warn for implicit conversions that reduce the precision of a real value.
6180 This includes conversions from real to integer, and from higher precision
6181 real to lower precision real values.  This option is also enabled by
6182 @option{-Wconversion}.
6184 @item -Wno-scalar-storage-order
6185 @opindex -Wno-scalar-storage-order
6186 @opindex -Wscalar-storage-order
6187 Do not warn on suspicious constructs involving reverse scalar storage order.
6189 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6190 @opindex Wsized-deallocation
6191 @opindex Wno-sized-deallocation
6192 Warn about a definition of an unsized deallocation function
6193 @smallexample
6194 void operator delete (void *) noexcept;
6195 void operator delete[] (void *) noexcept;
6196 @end smallexample
6197 without a definition of the corresponding sized deallocation function
6198 @smallexample
6199 void operator delete (void *, std::size_t) noexcept;
6200 void operator delete[] (void *, std::size_t) noexcept;
6201 @end smallexample
6202 or vice versa.  Enabled by @option{-Wextra} along with
6203 @option{-fsized-deallocation}.
6205 @item -Wsizeof-pointer-div
6206 @opindex Wsizeof-pointer-div
6207 @opindex Wno-sizeof-pointer-div
6208 Warn for suspicious divisions of two sizeof expressions that divide
6209 the pointer size by the element size, which is the usual way to compute
6210 the array size but won't work out correctly with pointers.  This warning
6211 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6212 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6214 @item -Wsizeof-pointer-memaccess
6215 @opindex Wsizeof-pointer-memaccess
6216 @opindex Wno-sizeof-pointer-memaccess
6217 Warn for suspicious length parameters to certain string and memory built-in
6218 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6219 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6220 but a pointer, and suggests a possible fix, or about
6221 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6222 @option{-Wall}.
6224 @item -Wsizeof-array-argument
6225 @opindex Wsizeof-array-argument
6226 @opindex Wno-sizeof-array-argument
6227 Warn when the @code{sizeof} operator is applied to a parameter that is
6228 declared as an array in a function definition.  This warning is enabled by
6229 default for C and C++ programs.
6231 @item -Wmemset-elt-size
6232 @opindex Wmemset-elt-size
6233 @opindex Wno-memset-elt-size
6234 Warn for suspicious calls to the @code{memset} built-in function, if the
6235 first argument references an array, and the third argument is a number
6236 equal to the number of elements, but not equal to the size of the array
6237 in memory.  This indicates that the user has omitted a multiplication by
6238 the element size.  This warning is enabled by @option{-Wall}.
6240 @item -Wmemset-transposed-args
6241 @opindex Wmemset-transposed-args
6242 @opindex Wno-memset-transposed-args
6243 Warn for suspicious calls to the @code{memset} built-in function, if the
6244 second argument is not zero and the third argument is zero.  This warns e.g.@
6245 about @code{memset (buf, sizeof buf, 0)} where most probably
6246 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6247 is only emitted if the third argument is literal zero.  If it is some
6248 expression that is folded to zero, a cast of zero to some type, etc., 
6249 it is far less likely that the user has mistakenly exchanged the arguments 
6250 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6252 @item -Waddress
6253 @opindex Waddress
6254 @opindex Wno-address
6255 Warn about suspicious uses of memory addresses. These include using
6256 the address of a function in a conditional expression, such as
6257 @code{void func(void); if (func)}, and comparisons against the memory
6258 address of a string literal, such as @code{if (x == "abc")}.  Such
6259 uses typically indicate a programmer error: the address of a function
6260 always evaluates to true, so their use in a conditional usually
6261 indicate that the programmer forgot the parentheses in a function
6262 call; and comparisons against string literals result in unspecified
6263 behavior and are not portable in C, so they usually indicate that the
6264 programmer intended to use @code{strcmp}.  This warning is enabled by
6265 @option{-Wall}.
6267 @item -Wlogical-op
6268 @opindex Wlogical-op
6269 @opindex Wno-logical-op
6270 Warn about suspicious uses of logical operators in expressions.
6271 This includes using logical operators in contexts where a
6272 bit-wise operator is likely to be expected.  Also warns when
6273 the operands of a logical operator are the same:
6274 @smallexample
6275 extern int a;
6276 if (a < 0 && a < 0) @{ @dots{} @}
6277 @end smallexample
6279 @item -Wlogical-not-parentheses
6280 @opindex Wlogical-not-parentheses
6281 @opindex Wno-logical-not-parentheses
6282 Warn about logical not used on the left hand side operand of a comparison.
6283 This option does not warn if the right operand is considered to be a boolean
6284 expression.  Its purpose is to detect suspicious code like the following:
6285 @smallexample
6286 int a;
6287 @dots{}
6288 if (!a > 1) @{ @dots{} @}
6289 @end smallexample
6291 It is possible to suppress the warning by wrapping the LHS into
6292 parentheses:
6293 @smallexample
6294 if ((!a) > 1) @{ @dots{} @}
6295 @end smallexample
6297 This warning is enabled by @option{-Wall}.
6299 @item -Waggregate-return
6300 @opindex Waggregate-return
6301 @opindex Wno-aggregate-return
6302 Warn if any functions that return structures or unions are defined or
6303 called.  (In languages where you can return an array, this also elicits
6304 a warning.)
6306 @item -Wno-aggressive-loop-optimizations
6307 @opindex Wno-aggressive-loop-optimizations
6308 @opindex Waggressive-loop-optimizations
6309 Warn if in a loop with constant number of iterations the compiler detects
6310 undefined behavior in some statement during one or more of the iterations.
6312 @item -Wno-attributes
6313 @opindex Wno-attributes
6314 @opindex Wattributes
6315 Do not warn if an unexpected @code{__attribute__} is used, such as
6316 unrecognized attributes, function attributes applied to variables,
6317 etc.  This does not stop errors for incorrect use of supported
6318 attributes.
6320 @item -Wno-builtin-declaration-mismatch
6321 @opindex Wno-builtin-declaration-mismatch
6322 @opindex Wbuiltin-declaration-mismatch
6323 Warn if a built-in function is declared with the wrong signature or 
6324 as non-function.
6325 This warning is enabled by default.
6327 @item -Wno-builtin-macro-redefined
6328 @opindex Wno-builtin-macro-redefined
6329 @opindex Wbuiltin-macro-redefined
6330 Do not warn if certain built-in macros are redefined.  This suppresses
6331 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6332 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6334 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6335 @opindex Wstrict-prototypes
6336 @opindex Wno-strict-prototypes
6337 Warn if a function is declared or defined without specifying the
6338 argument types.  (An old-style function definition is permitted without
6339 a warning if preceded by a declaration that specifies the argument
6340 types.)
6342 @item -Wold-style-declaration @r{(C and Objective-C only)}
6343 @opindex Wold-style-declaration
6344 @opindex Wno-old-style-declaration
6345 Warn for obsolescent usages, according to the C Standard, in a
6346 declaration. For example, warn if storage-class specifiers like
6347 @code{static} are not the first things in a declaration.  This warning
6348 is also enabled by @option{-Wextra}.
6350 @item -Wold-style-definition @r{(C and Objective-C only)}
6351 @opindex Wold-style-definition
6352 @opindex Wno-old-style-definition
6353 Warn if an old-style function definition is used.  A warning is given
6354 even if there is a previous prototype.
6356 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6357 @opindex Wmissing-parameter-type
6358 @opindex Wno-missing-parameter-type
6359 A function parameter is declared without a type specifier in K&R-style
6360 functions:
6362 @smallexample
6363 void foo(bar) @{ @}
6364 @end smallexample
6366 This warning is also enabled by @option{-Wextra}.
6368 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6369 @opindex Wmissing-prototypes
6370 @opindex Wno-missing-prototypes
6371 Warn if a global function is defined without a previous prototype
6372 declaration.  This warning is issued even if the definition itself
6373 provides a prototype.  Use this option to detect global functions
6374 that do not have a matching prototype declaration in a header file.
6375 This option is not valid for C++ because all function declarations
6376 provide prototypes and a non-matching declaration declares an
6377 overload rather than conflict with an earlier declaration.
6378 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6380 @item -Wmissing-declarations
6381 @opindex Wmissing-declarations
6382 @opindex Wno-missing-declarations
6383 Warn if a global function is defined without a previous declaration.
6384 Do so even if the definition itself provides a prototype.
6385 Use this option to detect global functions that are not declared in
6386 header files.  In C, no warnings are issued for functions with previous
6387 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6388 missing prototypes.  In C++, no warnings are issued for function templates,
6389 or for inline functions, or for functions in anonymous namespaces.
6391 @item -Wmissing-field-initializers
6392 @opindex Wmissing-field-initializers
6393 @opindex Wno-missing-field-initializers
6394 @opindex W
6395 @opindex Wextra
6396 @opindex Wno-extra
6397 Warn if a structure's initializer has some fields missing.  For
6398 example, the following code causes such a warning, because
6399 @code{x.h} is implicitly zero:
6401 @smallexample
6402 struct s @{ int f, g, h; @};
6403 struct s x = @{ 3, 4 @};
6404 @end smallexample
6406 This option does not warn about designated initializers, so the following
6407 modification does not trigger a warning:
6409 @smallexample
6410 struct s @{ int f, g, h; @};
6411 struct s x = @{ .f = 3, .g = 4 @};
6412 @end smallexample
6414 In C this option does not warn about the universal zero initializer
6415 @samp{@{ 0 @}}:
6417 @smallexample
6418 struct s @{ int f, g, h; @};
6419 struct s x = @{ 0 @};
6420 @end smallexample
6422 Likewise, in C++ this option does not warn about the empty @{ @}
6423 initializer, for example:
6425 @smallexample
6426 struct s @{ int f, g, h; @};
6427 s x = @{ @};
6428 @end smallexample
6430 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6431 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6433 @item -Wno-multichar
6434 @opindex Wno-multichar
6435 @opindex Wmultichar
6436 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6437 Usually they indicate a typo in the user's code, as they have
6438 implementation-defined values, and should not be used in portable code.
6440 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6441 @opindex Wnormalized=
6442 @opindex Wnormalized
6443 @opindex Wno-normalized
6444 @cindex NFC
6445 @cindex NFKC
6446 @cindex character set, input normalization
6447 In ISO C and ISO C++, two identifiers are different if they are
6448 different sequences of characters.  However, sometimes when characters
6449 outside the basic ASCII character set are used, you can have two
6450 different character sequences that look the same.  To avoid confusion,
6451 the ISO 10646 standard sets out some @dfn{normalization rules} which
6452 when applied ensure that two sequences that look the same are turned into
6453 the same sequence.  GCC can warn you if you are using identifiers that
6454 have not been normalized; this option controls that warning.
6456 There are four levels of warning supported by GCC@.  The default is
6457 @option{-Wnormalized=nfc}, which warns about any identifier that is
6458 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6459 recommended form for most uses.  It is equivalent to
6460 @option{-Wnormalized}.
6462 Unfortunately, there are some characters allowed in identifiers by
6463 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6464 identifiers.  That is, there's no way to use these symbols in portable
6465 ISO C or C++ and have all your identifiers in NFC@.
6466 @option{-Wnormalized=id} suppresses the warning for these characters.
6467 It is hoped that future versions of the standards involved will correct
6468 this, which is why this option is not the default.
6470 You can switch the warning off for all characters by writing
6471 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6472 only do this if you are using some other normalization scheme (like
6473 ``D''), because otherwise you can easily create bugs that are
6474 literally impossible to see.
6476 Some characters in ISO 10646 have distinct meanings but look identical
6477 in some fonts or display methodologies, especially once formatting has
6478 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6479 LETTER N'', displays just like a regular @code{n} that has been
6480 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6481 normalization scheme to convert all these into a standard form as
6482 well, and GCC warns if your code is not in NFKC if you use
6483 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6484 about every identifier that contains the letter O because it might be
6485 confused with the digit 0, and so is not the default, but may be
6486 useful as a local coding convention if the programming environment 
6487 cannot be fixed to display these characters distinctly.
6489 @item -Wno-deprecated
6490 @opindex Wno-deprecated
6491 @opindex Wdeprecated
6492 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6494 @item -Wno-deprecated-declarations
6495 @opindex Wno-deprecated-declarations
6496 @opindex Wdeprecated-declarations
6497 Do not warn about uses of functions (@pxref{Function Attributes}),
6498 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6499 Attributes}) marked as deprecated by using the @code{deprecated}
6500 attribute.
6502 @item -Wno-overflow
6503 @opindex Wno-overflow
6504 @opindex Woverflow
6505 Do not warn about compile-time overflow in constant expressions.
6507 @item -Wno-odr
6508 @opindex Wno-odr
6509 @opindex Wodr
6510 Warn about One Definition Rule violations during link-time optimization.
6511 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6513 @item -Wopenmp-simd
6514 @opindex Wopenm-simd
6515 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6516 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6517 option can be used to relax the cost model.
6519 @item -Woverride-init @r{(C and Objective-C only)}
6520 @opindex Woverride-init
6521 @opindex Wno-override-init
6522 @opindex W
6523 @opindex Wextra
6524 @opindex Wno-extra
6525 Warn if an initialized field without side effects is overridden when
6526 using designated initializers (@pxref{Designated Inits, , Designated
6527 Initializers}).
6529 This warning is included in @option{-Wextra}.  To get other
6530 @option{-Wextra} warnings without this one, use @option{-Wextra
6531 -Wno-override-init}.
6533 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6534 @opindex Woverride-init-side-effects
6535 @opindex Wno-override-init-side-effects
6536 Warn if an initialized field with side effects is overridden when
6537 using designated initializers (@pxref{Designated Inits, , Designated
6538 Initializers}).  This warning is enabled by default.
6540 @item -Wpacked
6541 @opindex Wpacked
6542 @opindex Wno-packed
6543 Warn if a structure is given the packed attribute, but the packed
6544 attribute has no effect on the layout or size of the structure.
6545 Such structures may be mis-aligned for little benefit.  For
6546 instance, in this code, the variable @code{f.x} in @code{struct bar}
6547 is misaligned even though @code{struct bar} does not itself
6548 have the packed attribute:
6550 @smallexample
6551 @group
6552 struct foo @{
6553   int x;
6554   char a, b, c, d;
6555 @} __attribute__((packed));
6556 struct bar @{
6557   char z;
6558   struct foo f;
6560 @end group
6561 @end smallexample
6563 @item -Wpacked-bitfield-compat
6564 @opindex Wpacked-bitfield-compat
6565 @opindex Wno-packed-bitfield-compat
6566 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6567 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6568 the change can lead to differences in the structure layout.  GCC
6569 informs you when the offset of such a field has changed in GCC 4.4.
6570 For example there is no longer a 4-bit padding between field @code{a}
6571 and @code{b} in this structure:
6573 @smallexample
6574 struct foo
6576   char a:4;
6577   char b:8;
6578 @} __attribute__ ((packed));
6579 @end smallexample
6581 This warning is enabled by default.  Use
6582 @option{-Wno-packed-bitfield-compat} to disable this warning.
6584 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6585 @opindex Wpacked-not-aligned
6586 @opindex Wno-packed-not-aligned
6587 Warn if a structure field with explicitly specified alignment in a
6588 packed struct or union is misaligned.  For example, a warning will
6589 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6590 'struct S' is less than 8}, in this code:
6592 @smallexample
6593 @group
6594 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6595 struct __attribute__ ((packed)) S @{
6596   struct S8 s8;
6598 @end group
6599 @end smallexample
6601 This warning is enabled by @option{-Wall}.
6603 @item -Wpadded
6604 @opindex Wpadded
6605 @opindex Wno-padded
6606 Warn if padding is included in a structure, either to align an element
6607 of the structure or to align the whole structure.  Sometimes when this
6608 happens it is possible to rearrange the fields of the structure to
6609 reduce the padding and so make the structure smaller.
6611 @item -Wredundant-decls
6612 @opindex Wredundant-decls
6613 @opindex Wno-redundant-decls
6614 Warn if anything is declared more than once in the same scope, even in
6615 cases where multiple declaration is valid and changes nothing.
6617 @item -Wrestrict
6618 @opindex Wrestrict
6619 @opindex Wno-restrict
6620 Warn when an argument passed to a restrict-qualified parameter
6621 aliases with another argument.
6623 @item -Wnested-externs @r{(C and Objective-C only)}
6624 @opindex Wnested-externs
6625 @opindex Wno-nested-externs
6626 Warn if an @code{extern} declaration is encountered within a function.
6628 @item -Wno-inherited-variadic-ctor
6629 @opindex Winherited-variadic-ctor
6630 @opindex Wno-inherited-variadic-ctor
6631 Suppress warnings about use of C++11 inheriting constructors when the
6632 base class inherited from has a C variadic constructor; the warning is
6633 on by default because the ellipsis is not inherited.
6635 @item -Winline
6636 @opindex Winline
6637 @opindex Wno-inline
6638 Warn if a function that is declared as inline cannot be inlined.
6639 Even with this option, the compiler does not warn about failures to
6640 inline functions declared in system headers.
6642 The compiler uses a variety of heuristics to determine whether or not
6643 to inline a function.  For example, the compiler takes into account
6644 the size of the function being inlined and the amount of inlining
6645 that has already been done in the current function.  Therefore,
6646 seemingly insignificant changes in the source program can cause the
6647 warnings produced by @option{-Winline} to appear or disappear.
6649 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6650 @opindex Wno-invalid-offsetof
6651 @opindex Winvalid-offsetof
6652 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6653 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6654 to a non-standard-layout type is undefined.  In existing C++ implementations,
6655 however, @code{offsetof} typically gives meaningful results.
6656 This flag is for users who are aware that they are
6657 writing nonportable code and who have deliberately chosen to ignore the
6658 warning about it.
6660 The restrictions on @code{offsetof} may be relaxed in a future version
6661 of the C++ standard.
6663 @item -Wint-in-bool-context
6664 @opindex Wint-in-bool-context
6665 @opindex Wno-int-in-bool-context
6666 Warn for suspicious use of integer values where boolean values are expected,
6667 such as conditional expressions (?:) using non-boolean integer constants in
6668 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6669 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6670 for all kinds of multiplications regardless of the data type.
6671 This warning is enabled by @option{-Wall}.
6673 @item -Wno-int-to-pointer-cast
6674 @opindex Wno-int-to-pointer-cast
6675 @opindex Wint-to-pointer-cast
6676 Suppress warnings from casts to pointer type of an integer of a
6677 different size. In C++, casting to a pointer type of smaller size is
6678 an error. @option{Wint-to-pointer-cast} is enabled by default.
6681 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6682 @opindex Wno-pointer-to-int-cast
6683 @opindex Wpointer-to-int-cast
6684 Suppress warnings from casts from a pointer to an integer type of a
6685 different size.
6687 @item -Winvalid-pch
6688 @opindex Winvalid-pch
6689 @opindex Wno-invalid-pch
6690 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6691 the search path but cannot be used.
6693 @item -Wlong-long
6694 @opindex Wlong-long
6695 @opindex Wno-long-long
6696 Warn if @code{long long} type is used.  This is enabled by either
6697 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6698 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6700 @item -Wvariadic-macros
6701 @opindex Wvariadic-macros
6702 @opindex Wno-variadic-macros
6703 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6704 alternate syntax is used in ISO C99 mode.  This is enabled by either
6705 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6706 messages, use @option{-Wno-variadic-macros}.
6708 @item -Wvarargs
6709 @opindex Wvarargs
6710 @opindex Wno-varargs
6711 Warn upon questionable usage of the macros used to handle variable
6712 arguments like @code{va_start}.  This is default.  To inhibit the
6713 warning messages, use @option{-Wno-varargs}.
6715 @item -Wvector-operation-performance
6716 @opindex Wvector-operation-performance
6717 @opindex Wno-vector-operation-performance
6718 Warn if vector operation is not implemented via SIMD capabilities of the
6719 architecture.  Mainly useful for the performance tuning.
6720 Vector operation can be implemented @code{piecewise}, which means that the
6721 scalar operation is performed on every vector element; 
6722 @code{in parallel}, which means that the vector operation is implemented
6723 using scalars of wider type, which normally is more performance efficient;
6724 and @code{as a single scalar}, which means that vector fits into a
6725 scalar type.
6727 @item -Wno-virtual-move-assign
6728 @opindex Wvirtual-move-assign
6729 @opindex Wno-virtual-move-assign
6730 Suppress warnings about inheriting from a virtual base with a
6731 non-trivial C++11 move assignment operator.  This is dangerous because
6732 if the virtual base is reachable along more than one path, it is
6733 moved multiple times, which can mean both objects end up in the
6734 moved-from state.  If the move assignment operator is written to avoid
6735 moving from a moved-from object, this warning can be disabled.
6737 @item -Wvla
6738 @opindex Wvla
6739 @opindex Wno-vla
6740 Warn if a variable-length array is used in the code.
6741 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6742 the variable-length array.
6744 @item -Wvla-larger-than=@var{n}
6745 If this option is used, the compiler will warn on uses of
6746 variable-length arrays where the size is either unbounded, or bounded
6747 by an argument that can be larger than @var{n} bytes.  This is similar
6748 to how @option{-Walloca-larger-than=@var{n}} works, but with
6749 variable-length arrays.
6751 Note that GCC may optimize small variable-length arrays of a known
6752 value into plain arrays, so this warning may not get triggered for
6753 such arrays.
6755 This warning is not enabled by @option{-Wall}, and is only active when
6756 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6758 See also @option{-Walloca-larger-than=@var{n}}.
6760 @item -Wvolatile-register-var
6761 @opindex Wvolatile-register-var
6762 @opindex Wno-volatile-register-var
6763 Warn if a register variable is declared volatile.  The volatile
6764 modifier does not inhibit all optimizations that may eliminate reads
6765 and/or writes to register variables.  This warning is enabled by
6766 @option{-Wall}.
6768 @item -Wdisabled-optimization
6769 @opindex Wdisabled-optimization
6770 @opindex Wno-disabled-optimization
6771 Warn if a requested optimization pass is disabled.  This warning does
6772 not generally indicate that there is anything wrong with your code; it
6773 merely indicates that GCC's optimizers are unable to handle the code
6774 effectively.  Often, the problem is that your code is too big or too
6775 complex; GCC refuses to optimize programs when the optimization
6776 itself is likely to take inordinate amounts of time.
6778 @item -Wpointer-sign @r{(C and Objective-C only)}
6779 @opindex Wpointer-sign
6780 @opindex Wno-pointer-sign
6781 Warn for pointer argument passing or assignment with different signedness.
6782 This option is only supported for C and Objective-C@.  It is implied by
6783 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6784 @option{-Wno-pointer-sign}.
6786 @item -Wstack-protector
6787 @opindex Wstack-protector
6788 @opindex Wno-stack-protector
6789 This option is only active when @option{-fstack-protector} is active.  It
6790 warns about functions that are not protected against stack smashing.
6792 @item -Woverlength-strings
6793 @opindex Woverlength-strings
6794 @opindex Wno-overlength-strings
6795 Warn about string constants that are longer than the ``minimum
6796 maximum'' length specified in the C standard.  Modern compilers
6797 generally allow string constants that are much longer than the
6798 standard's minimum limit, but very portable programs should avoid
6799 using longer strings.
6801 The limit applies @emph{after} string constant concatenation, and does
6802 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6803 C99, it was raised to 4095.  C++98 does not specify a normative
6804 minimum maximum, so we do not diagnose overlength strings in C++@.
6806 This option is implied by @option{-Wpedantic}, and can be disabled with
6807 @option{-Wno-overlength-strings}.
6809 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6810 @opindex Wunsuffixed-float-constants
6812 Issue a warning for any floating constant that does not have
6813 a suffix.  When used together with @option{-Wsystem-headers} it
6814 warns about such constants in system header files.  This can be useful
6815 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6816 from the decimal floating-point extension to C99.
6818 @item -Wno-designated-init @r{(C and Objective-C only)}
6819 Suppress warnings when a positional initializer is used to initialize
6820 a structure that has been marked with the @code{designated_init}
6821 attribute.
6823 @item -Whsa
6824 Issue a warning when HSAIL cannot be emitted for the compiled function or
6825 OpenMP construct.
6827 @end table
6829 @node Debugging Options
6830 @section Options for Debugging Your Program
6831 @cindex options, debugging
6832 @cindex debugging information options
6834 To tell GCC to emit extra information for use by a debugger, in almost 
6835 all cases you need only to add @option{-g} to your other options.
6837 GCC allows you to use @option{-g} with
6838 @option{-O}.  The shortcuts taken by optimized code may occasionally
6839 be surprising: some variables you declared may not exist
6840 at all; flow of control may briefly move where you did not expect it;
6841 some statements may not be executed because they compute constant
6842 results or their values are already at hand; some statements may
6843 execute in different places because they have been moved out of loops.
6844 Nevertheless it is possible to debug optimized output.  This makes
6845 it reasonable to use the optimizer for programs that might have bugs.
6847 If you are not using some other optimization option, consider
6848 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6849 With no @option{-O} option at all, some compiler passes that collect
6850 information useful for debugging do not run at all, so that
6851 @option{-Og} may result in a better debugging experience.
6853 @table @gcctabopt
6854 @item -g
6855 @opindex g
6856 Produce debugging information in the operating system's native format
6857 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6858 information.
6860 On most systems that use stabs format, @option{-g} enables use of extra
6861 debugging information that only GDB can use; this extra information
6862 makes debugging work better in GDB but probably makes other debuggers
6863 crash or
6864 refuse to read the program.  If you want to control for certain whether
6865 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6866 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6868 @item -ggdb
6869 @opindex ggdb
6870 Produce debugging information for use by GDB@.  This means to use the
6871 most expressive format available (DWARF, stabs, or the native format
6872 if neither of those are supported), including GDB extensions if at all
6873 possible.
6875 @item -gdwarf
6876 @itemx -gdwarf-@var{version}
6877 @opindex gdwarf
6878 Produce debugging information in DWARF format (if that is supported).
6879 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6880 for most targets is 4.  DWARF Version 5 is only experimental.
6882 Note that with DWARF Version 2, some ports require and always
6883 use some non-conflicting DWARF 3 extensions in the unwind tables.
6885 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6886 for maximum benefit.
6888 GCC no longer supports DWARF Version 1, which is substantially
6889 different than Version 2 and later.  For historical reasons, some
6890 other DWARF-related options such as
6891 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6892 in their names, but apply to all currently-supported versions of DWARF.
6894 @item -gstabs
6895 @opindex gstabs
6896 Produce debugging information in stabs format (if that is supported),
6897 without GDB extensions.  This is the format used by DBX on most BSD
6898 systems.  On MIPS, Alpha and System V Release 4 systems this option
6899 produces stabs debugging output that is not understood by DBX or SDB@.
6900 On System V Release 4 systems this option requires the GNU assembler.
6902 @item -gstabs+
6903 @opindex gstabs+
6904 Produce debugging information in stabs format (if that is supported),
6905 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6906 use of these extensions is likely to make other debuggers crash or
6907 refuse to read the program.
6909 @item -gcoff
6910 @opindex gcoff
6911 Produce debugging information in COFF format (if that is supported).
6912 This is the format used by SDB on most System V systems prior to
6913 System V Release 4.
6915 @item -gxcoff
6916 @opindex gxcoff
6917 Produce debugging information in XCOFF format (if that is supported).
6918 This is the format used by the DBX debugger on IBM RS/6000 systems.
6920 @item -gxcoff+
6921 @opindex gxcoff+
6922 Produce debugging information in XCOFF format (if that is supported),
6923 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6924 use of these extensions is likely to make other debuggers crash or
6925 refuse to read the program, and may cause assemblers other than the GNU
6926 assembler (GAS) to fail with an error.
6928 @item -gvms
6929 @opindex gvms
6930 Produce debugging information in Alpha/VMS debug format (if that is
6931 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6933 @item -g@var{level}
6934 @itemx -ggdb@var{level}
6935 @itemx -gstabs@var{level}
6936 @itemx -gcoff@var{level}
6937 @itemx -gxcoff@var{level}
6938 @itemx -gvms@var{level}
6939 Request debugging information and also use @var{level} to specify how
6940 much information.  The default level is 2.
6942 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6943 @option{-g}.
6945 Level 1 produces minimal information, enough for making backtraces in
6946 parts of the program that you don't plan to debug.  This includes
6947 descriptions of functions and external variables, and line number
6948 tables, but no information about local variables.
6950 Level 3 includes extra information, such as all the macro definitions
6951 present in the program.  Some debuggers support macro expansion when
6952 you use @option{-g3}.
6954 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6955 confusion with @option{-gdwarf-@var{level}}.
6956 Instead use an additional @option{-g@var{level}} option to change the
6957 debug level for DWARF.
6959 @item -feliminate-unused-debug-symbols
6960 @opindex feliminate-unused-debug-symbols
6961 Produce debugging information in stabs format (if that is supported),
6962 for only symbols that are actually used.
6964 @item -femit-class-debug-always
6965 @opindex femit-class-debug-always
6966 Instead of emitting debugging information for a C++ class in only one
6967 object file, emit it in all object files using the class.  This option
6968 should be used only with debuggers that are unable to handle the way GCC
6969 normally emits debugging information for classes because using this
6970 option increases the size of debugging information by as much as a
6971 factor of two.
6973 @item -fno-merge-debug-strings
6974 @opindex fmerge-debug-strings
6975 @opindex fno-merge-debug-strings
6976 Direct the linker to not merge together strings in the debugging
6977 information that are identical in different object files.  Merging is
6978 not supported by all assemblers or linkers.  Merging decreases the size
6979 of the debug information in the output file at the cost of increasing
6980 link processing time.  Merging is enabled by default.
6982 @item -fdebug-prefix-map=@var{old}=@var{new}
6983 @opindex fdebug-prefix-map
6984 When compiling files in directory @file{@var{old}}, record debugging
6985 information describing them as in @file{@var{new}} instead.
6987 @item -fvar-tracking
6988 @opindex fvar-tracking
6989 Run variable tracking pass.  It computes where variables are stored at each
6990 position in code.  Better debugging information is then generated
6991 (if the debugging information format supports this information).
6993 It is enabled by default when compiling with optimization (@option{-Os},
6994 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6995 the debug info format supports it.
6997 @item -fvar-tracking-assignments
6998 @opindex fvar-tracking-assignments
6999 @opindex fno-var-tracking-assignments
7000 Annotate assignments to user variables early in the compilation and
7001 attempt to carry the annotations over throughout the compilation all the
7002 way to the end, in an attempt to improve debug information while
7003 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7005 It can be enabled even if var-tracking is disabled, in which case
7006 annotations are created and maintained, but discarded at the end.
7007 By default, this flag is enabled together with @option{-fvar-tracking},
7008 except when selective scheduling is enabled.
7010 @item -gsplit-dwarf
7011 @opindex gsplit-dwarf
7012 Separate as much DWARF debugging information as possible into a
7013 separate output file with the extension @file{.dwo}.  This option allows
7014 the build system to avoid linking files with debug information.  To
7015 be useful, this option requires a debugger capable of reading @file{.dwo}
7016 files.
7018 @item -gpubnames
7019 @opindex gpubnames
7020 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7022 @item -ggnu-pubnames
7023 @opindex ggnu-pubnames
7024 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7025 suitable for conversion into a GDB@ index.  This option is only useful
7026 with a linker that can produce GDB@ index version 7.
7028 @item -fdebug-types-section
7029 @opindex fdebug-types-section
7030 @opindex fno-debug-types-section
7031 When using DWARF Version 4 or higher, type DIEs can be put into
7032 their own @code{.debug_types} section instead of making them part of the
7033 @code{.debug_info} section.  It is more efficient to put them in a separate
7034 comdat sections since the linker can then remove duplicates.
7035 But not all DWARF consumers support @code{.debug_types} sections yet
7036 and on some objects @code{.debug_types} produces larger instead of smaller
7037 debugging information.
7039 @item -grecord-gcc-switches
7040 @item -gno-record-gcc-switches
7041 @opindex grecord-gcc-switches
7042 @opindex gno-record-gcc-switches
7043 This switch causes the command-line options used to invoke the
7044 compiler that may affect code generation to be appended to the
7045 DW_AT_producer attribute in DWARF debugging information.  The options
7046 are concatenated with spaces separating them from each other and from
7047 the compiler version.  
7048 It is enabled by default.
7049 See also @option{-frecord-gcc-switches} for another
7050 way of storing compiler options into the object file.  
7052 @item -gstrict-dwarf
7053 @opindex gstrict-dwarf
7054 Disallow using extensions of later DWARF standard version than selected
7055 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7056 DWARF extensions from later standard versions is allowed.
7058 @item -gno-strict-dwarf
7059 @opindex gno-strict-dwarf
7060 Allow using extensions of later DWARF standard version than selected with
7061 @option{-gdwarf-@var{version}}.
7063 @item -gcolumn-info
7064 @item -gno-column-info
7065 @opindex gcolumn-info
7066 @opindex gno-column-info
7067 Emit location column information into DWARF debugging information, rather
7068 than just file and line.
7069 This option is enabled by default.
7071 @item -gz@r{[}=@var{type}@r{]}
7072 @opindex gz
7073 Produce compressed debug sections in DWARF format, if that is supported.
7074 If @var{type} is not given, the default type depends on the capabilities
7075 of the assembler and linker used.  @var{type} may be one of
7076 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7077 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7078 compression in traditional GNU format).  If the linker doesn't support
7079 writing compressed debug sections, the option is rejected.  Otherwise,
7080 if the assembler does not support them, @option{-gz} is silently ignored
7081 when producing object files.
7083 @item -femit-struct-debug-baseonly
7084 @opindex femit-struct-debug-baseonly
7085 Emit debug information for struct-like types
7086 only when the base name of the compilation source file
7087 matches the base name of file in which the struct is defined.
7089 This option substantially reduces the size of debugging information,
7090 but at significant potential loss in type information to the debugger.
7091 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7092 See @option{-femit-struct-debug-detailed} for more detailed control.
7094 This option works only with DWARF debug output.
7096 @item -femit-struct-debug-reduced
7097 @opindex femit-struct-debug-reduced
7098 Emit debug information for struct-like types
7099 only when the base name of the compilation source file
7100 matches the base name of file in which the type is defined,
7101 unless the struct is a template or defined in a system header.
7103 This option significantly reduces the size of debugging information,
7104 with some potential loss in type information to the debugger.
7105 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7106 See @option{-femit-struct-debug-detailed} for more detailed control.
7108 This option works only with DWARF debug output.
7110 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7111 @opindex femit-struct-debug-detailed
7112 Specify the struct-like types
7113 for which the compiler generates debug information.
7114 The intent is to reduce duplicate struct debug information
7115 between different object files within the same program.
7117 This option is a detailed version of
7118 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7119 which serves for most needs.
7121 A specification has the syntax@*
7122 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7124 The optional first word limits the specification to
7125 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7126 A struct type is used directly when it is the type of a variable, member.
7127 Indirect uses arise through pointers to structs.
7128 That is, when use of an incomplete struct is valid, the use is indirect.
7129 An example is
7130 @samp{struct one direct; struct two * indirect;}.
7132 The optional second word limits the specification to
7133 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7134 Generic structs are a bit complicated to explain.
7135 For C++, these are non-explicit specializations of template classes,
7136 or non-template classes within the above.
7137 Other programming languages have generics,
7138 but @option{-femit-struct-debug-detailed} does not yet implement them.
7140 The third word specifies the source files for those
7141 structs for which the compiler should emit debug information.
7142 The values @samp{none} and @samp{any} have the normal meaning.
7143 The value @samp{base} means that
7144 the base of name of the file in which the type declaration appears
7145 must match the base of the name of the main compilation file.
7146 In practice, this means that when compiling @file{foo.c}, debug information
7147 is generated for types declared in that file and @file{foo.h},
7148 but not other header files.
7149 The value @samp{sys} means those types satisfying @samp{base}
7150 or declared in system or compiler headers.
7152 You may need to experiment to determine the best settings for your application.
7154 The default is @option{-femit-struct-debug-detailed=all}.
7156 This option works only with DWARF debug output.
7158 @item -fno-dwarf2-cfi-asm
7159 @opindex fdwarf2-cfi-asm
7160 @opindex fno-dwarf2-cfi-asm
7161 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7162 instead of using GAS @code{.cfi_*} directives.
7164 @item -fno-eliminate-unused-debug-types
7165 @opindex feliminate-unused-debug-types
7166 @opindex fno-eliminate-unused-debug-types
7167 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7168 output for types that are nowhere used in the source file being compiled.
7169 Sometimes it is useful to have GCC emit debugging
7170 information for all types declared in a compilation
7171 unit, regardless of whether or not they are actually used
7172 in that compilation unit, for example 
7173 if, in the debugger, you want to cast a value to a type that is
7174 not actually used in your program (but is declared).  More often,
7175 however, this results in a significant amount of wasted space.
7176 @end table
7178 @node Optimize Options
7179 @section Options That Control Optimization
7180 @cindex optimize options
7181 @cindex options, optimization
7183 These options control various sorts of optimizations.
7185 Without any optimization option, the compiler's goal is to reduce the
7186 cost of compilation and to make debugging produce the expected
7187 results.  Statements are independent: if you stop the program with a
7188 breakpoint between statements, you can then assign a new value to any
7189 variable or change the program counter to any other statement in the
7190 function and get exactly the results you expect from the source
7191 code.
7193 Turning on optimization flags makes the compiler attempt to improve
7194 the performance and/or code size at the expense of compilation time
7195 and possibly the ability to debug the program.
7197 The compiler performs optimization based on the knowledge it has of the
7198 program.  Compiling multiple files at once to a single output file mode allows
7199 the compiler to use information gained from all of the files when compiling
7200 each of them.
7202 Not all optimizations are controlled directly by a flag.  Only
7203 optimizations that have a flag are listed in this section.
7205 Most optimizations are only enabled if an @option{-O} level is set on
7206 the command line.  Otherwise they are disabled, even if individual
7207 optimization flags are specified.
7209 Depending on the target and how GCC was configured, a slightly different
7210 set of optimizations may be enabled at each @option{-O} level than
7211 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7212 to find out the exact set of optimizations that are enabled at each level.
7213 @xref{Overall Options}, for examples.
7215 @table @gcctabopt
7216 @item -O
7217 @itemx -O1
7218 @opindex O
7219 @opindex O1
7220 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7221 more memory for a large function.
7223 With @option{-O}, the compiler tries to reduce code size and execution
7224 time, without performing any optimizations that take a great deal of
7225 compilation time.
7227 @option{-O} turns on the following optimization flags:
7228 @gccoptlist{
7229 -fauto-inc-dec @gol
7230 -fbranch-count-reg @gol
7231 -fcombine-stack-adjustments @gol
7232 -fcompare-elim @gol
7233 -fcprop-registers @gol
7234 -fdce @gol
7235 -fdefer-pop @gol
7236 -fdelayed-branch @gol
7237 -fdse @gol
7238 -fforward-propagate @gol
7239 -fguess-branch-probability @gol
7240 -fif-conversion2 @gol
7241 -fif-conversion @gol
7242 -finline-functions-called-once @gol
7243 -fipa-pure-const @gol
7244 -fipa-profile @gol
7245 -fipa-reference @gol
7246 -fmerge-constants @gol
7247 -fmove-loop-invariants @gol
7248 -freorder-blocks @gol
7249 -fshrink-wrap @gol
7250 -fshrink-wrap-separate @gol
7251 -fsplit-wide-types @gol
7252 -fssa-backprop @gol
7253 -fssa-phiopt @gol
7254 -ftree-bit-ccp @gol
7255 -ftree-ccp @gol
7256 -ftree-ch @gol
7257 -ftree-coalesce-vars @gol
7258 -ftree-copy-prop @gol
7259 -ftree-dce @gol
7260 -ftree-dominator-opts @gol
7261 -ftree-dse @gol
7262 -ftree-forwprop @gol
7263 -ftree-fre @gol
7264 -ftree-phiprop @gol
7265 -ftree-sink @gol
7266 -ftree-slsr @gol
7267 -ftree-sra @gol
7268 -ftree-pta @gol
7269 -ftree-ter @gol
7270 -funit-at-a-time}
7272 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7273 where doing so does not interfere with debugging.
7275 @item -O2
7276 @opindex O2
7277 Optimize even more.  GCC performs nearly all supported optimizations
7278 that do not involve a space-speed tradeoff.
7279 As compared to @option{-O}, this option increases both compilation time
7280 and the performance of the generated code.
7282 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7283 also turns on the following optimization flags:
7284 @gccoptlist{-fthread-jumps @gol
7285 -falign-functions  -falign-jumps @gol
7286 -falign-loops  -falign-labels @gol
7287 -fcaller-saves @gol
7288 -fcrossjumping @gol
7289 -fcse-follow-jumps  -fcse-skip-blocks @gol
7290 -fdelete-null-pointer-checks @gol
7291 -fdevirtualize -fdevirtualize-speculatively @gol
7292 -fexpensive-optimizations @gol
7293 -fgcse  -fgcse-lm  @gol
7294 -fhoist-adjacent-loads @gol
7295 -finline-small-functions @gol
7296 -findirect-inlining @gol
7297 -fipa-cp @gol
7298 -fipa-bit-cp @gol
7299 -fipa-vrp @gol
7300 -fipa-sra @gol
7301 -fipa-icf @gol
7302 -fisolate-erroneous-paths-dereference @gol
7303 -flra-remat @gol
7304 -foptimize-sibling-calls @gol
7305 -foptimize-strlen @gol
7306 -fpartial-inlining @gol
7307 -fpeephole2 @gol
7308 -freorder-blocks-algorithm=stc @gol
7309 -freorder-blocks-and-partition -freorder-functions @gol
7310 -frerun-cse-after-loop  @gol
7311 -fsched-interblock  -fsched-spec @gol
7312 -fschedule-insns  -fschedule-insns2 @gol
7313 -fstore-merging @gol
7314 -fstrict-aliasing @gol
7315 -ftree-builtin-call-dce @gol
7316 -ftree-switch-conversion -ftree-tail-merge @gol
7317 -fcode-hoisting @gol
7318 -ftree-pre @gol
7319 -ftree-vrp @gol
7320 -fipa-ra}
7322 Please note the warning under @option{-fgcse} about
7323 invoking @option{-O2} on programs that use computed gotos.
7325 @item -O3
7326 @opindex O3
7327 Optimize yet more.  @option{-O3} turns on all optimizations specified
7328 by @option{-O2} and also turns on the following optimization flags:
7329 @gccoptlist{-finline-functions @gol
7330 -funswitch-loops @gol
7331 -fpredictive-commoning @gol
7332 -fgcse-after-reload @gol
7333 -ftree-loop-vectorize @gol
7334 -ftree-loop-distribution @gol
7335 -ftree-loop-distribute-patterns @gol
7336 -fsplit-paths @gol
7337 -ftree-slp-vectorize @gol
7338 -fvect-cost-model @gol
7339 -ftree-partial-pre @gol
7340 -fpeel-loops @gol
7341 -fipa-cp-clone}
7343 @item -O0
7344 @opindex O0
7345 Reduce compilation time and make debugging produce the expected
7346 results.  This is the default.
7348 @item -Os
7349 @opindex Os
7350 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7351 do not typically increase code size.  It also performs further
7352 optimizations designed to reduce code size.
7354 @option{-Os} disables the following optimization flags:
7355 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7356 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7357 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7359 @item -Ofast
7360 @opindex Ofast
7361 Disregard strict standards compliance.  @option{-Ofast} enables all
7362 @option{-O3} optimizations.  It also enables optimizations that are not
7363 valid for all standard-compliant programs.
7364 It turns on @option{-ffast-math} and the Fortran-specific
7365 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7366 specified, and @option{-fno-protect-parens}.
7368 @item -Og
7369 @opindex Og
7370 Optimize debugging experience.  @option{-Og} enables optimizations
7371 that do not interfere with debugging. It should be the optimization
7372 level of choice for the standard edit-compile-debug cycle, offering
7373 a reasonable level of optimization while maintaining fast compilation
7374 and a good debugging experience.
7375 @end table
7377 If you use multiple @option{-O} options, with or without level numbers,
7378 the last such option is the one that is effective.
7380 Options of the form @option{-f@var{flag}} specify machine-independent
7381 flags.  Most flags have both positive and negative forms; the negative
7382 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7383 below, only one of the forms is listed---the one you typically 
7384 use.  You can figure out the other form by either removing @samp{no-}
7385 or adding it.
7387 The following options control specific optimizations.  They are either
7388 activated by @option{-O} options or are related to ones that are.  You
7389 can use the following flags in the rare cases when ``fine-tuning'' of
7390 optimizations to be performed is desired.
7392 @table @gcctabopt
7393 @item -fno-defer-pop
7394 @opindex fno-defer-pop
7395 Always pop the arguments to each function call as soon as that function
7396 returns.  For machines that must pop arguments after a function call,
7397 the compiler normally lets arguments accumulate on the stack for several
7398 function calls and pops them all at once.
7400 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7402 @item -fforward-propagate
7403 @opindex fforward-propagate
7404 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7405 instructions and checks if the result can be simplified.  If loop unrolling
7406 is active, two passes are performed and the second is scheduled after
7407 loop unrolling.
7409 This option is enabled by default at optimization levels @option{-O},
7410 @option{-O2}, @option{-O3}, @option{-Os}.
7412 @item -ffp-contract=@var{style}
7413 @opindex ffp-contract
7414 @option{-ffp-contract=off} disables floating-point expression contraction.
7415 @option{-ffp-contract=fast} enables floating-point expression contraction
7416 such as forming of fused multiply-add operations if the target has
7417 native support for them.
7418 @option{-ffp-contract=on} enables floating-point expression contraction
7419 if allowed by the language standard.  This is currently not implemented
7420 and treated equal to @option{-ffp-contract=off}.
7422 The default is @option{-ffp-contract=fast}.
7424 @item -fomit-frame-pointer
7425 @opindex fomit-frame-pointer
7426 Don't keep the frame pointer in a register for functions that
7427 don't need one.  This avoids the instructions to save, set up and
7428 restore frame pointers; it also makes an extra register available
7429 in many functions.  @strong{It also makes debugging impossible on
7430 some machines.}
7432 On some machines, such as the VAX, this flag has no effect, because
7433 the standard calling sequence automatically handles the frame pointer
7434 and nothing is saved by pretending it doesn't exist.  The
7435 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7436 whether a target machine supports this flag.  @xref{Registers,,Register
7437 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7439 The default setting (when not optimizing for
7440 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7441 @option{-fomit-frame-pointer}.  You can configure GCC with the
7442 @option{--enable-frame-pointer} configure option to change the default.
7444 Note that @option{-fno-omit-frame-pointer} doesn't force a new stack
7445 frame for all functions if it isn't otherwise needed, and hence doesn't
7446 guarantee a new frame pointer for all functions.
7448 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7450 @item -foptimize-sibling-calls
7451 @opindex foptimize-sibling-calls
7452 Optimize sibling and tail recursive calls.
7454 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7456 @item -foptimize-strlen
7457 @opindex foptimize-strlen
7458 Optimize various standard C string functions (e.g. @code{strlen},
7459 @code{strchr} or @code{strcpy}) and
7460 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7462 Enabled at levels @option{-O2}, @option{-O3}.
7464 @item -fno-inline
7465 @opindex fno-inline
7466 Do not expand any functions inline apart from those marked with
7467 the @code{always_inline} attribute.  This is the default when not
7468 optimizing.
7470 Single functions can be exempted from inlining by marking them
7471 with the @code{noinline} attribute.
7473 @item -finline-small-functions
7474 @opindex finline-small-functions
7475 Integrate functions into their callers when their body is smaller than expected
7476 function call code (so overall size of program gets smaller).  The compiler
7477 heuristically decides which functions are simple enough to be worth integrating
7478 in this way.  This inlining applies to all functions, even those not declared
7479 inline.
7481 Enabled at level @option{-O2}.
7483 @item -findirect-inlining
7484 @opindex findirect-inlining
7485 Inline also indirect calls that are discovered to be known at compile
7486 time thanks to previous inlining.  This option has any effect only
7487 when inlining itself is turned on by the @option{-finline-functions}
7488 or @option{-finline-small-functions} options.
7490 Enabled at level @option{-O2}.
7492 @item -finline-functions
7493 @opindex finline-functions
7494 Consider all functions for inlining, even if they are not declared inline.
7495 The compiler heuristically decides which functions are worth integrating
7496 in this way.
7498 If all calls to a given function are integrated, and the function is
7499 declared @code{static}, then the function is normally not output as
7500 assembler code in its own right.
7502 Enabled at level @option{-O3}.
7504 @item -finline-functions-called-once
7505 @opindex finline-functions-called-once
7506 Consider all @code{static} functions called once for inlining into their
7507 caller even if they are not marked @code{inline}.  If a call to a given
7508 function is integrated, then the function is not output as assembler code
7509 in its own right.
7511 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7513 @item -fearly-inlining
7514 @opindex fearly-inlining
7515 Inline functions marked by @code{always_inline} and functions whose body seems
7516 smaller than the function call overhead early before doing
7517 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7518 makes profiling significantly cheaper and usually inlining faster on programs
7519 having large chains of nested wrapper functions.
7521 Enabled by default.
7523 @item -fipa-sra
7524 @opindex fipa-sra
7525 Perform interprocedural scalar replacement of aggregates, removal of
7526 unused parameters and replacement of parameters passed by reference
7527 by parameters passed by value.
7529 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7531 @item -finline-limit=@var{n}
7532 @opindex finline-limit
7533 By default, GCC limits the size of functions that can be inlined.  This flag
7534 allows coarse control of this limit.  @var{n} is the size of functions that
7535 can be inlined in number of pseudo instructions.
7537 Inlining is actually controlled by a number of parameters, which may be
7538 specified individually by using @option{--param @var{name}=@var{value}}.
7539 The @option{-finline-limit=@var{n}} option sets some of these parameters
7540 as follows:
7542 @table @gcctabopt
7543 @item max-inline-insns-single
7544 is set to @var{n}/2.
7545 @item max-inline-insns-auto
7546 is set to @var{n}/2.
7547 @end table
7549 See below for a documentation of the individual
7550 parameters controlling inlining and for the defaults of these parameters.
7552 @emph{Note:} there may be no value to @option{-finline-limit} that results
7553 in default behavior.
7555 @emph{Note:} pseudo instruction represents, in this particular context, an
7556 abstract measurement of function's size.  In no way does it represent a count
7557 of assembly instructions and as such its exact meaning might change from one
7558 release to an another.
7560 @item -fno-keep-inline-dllexport
7561 @opindex fno-keep-inline-dllexport
7562 This is a more fine-grained version of @option{-fkeep-inline-functions},
7563 which applies only to functions that are declared using the @code{dllexport}
7564 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7565 Functions}.
7567 @item -fkeep-inline-functions
7568 @opindex fkeep-inline-functions
7569 In C, emit @code{static} functions that are declared @code{inline}
7570 into the object file, even if the function has been inlined into all
7571 of its callers.  This switch does not affect functions using the
7572 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7573 inline functions into the object file.
7575 @item -fkeep-static-functions
7576 @opindex fkeep-static-functions
7577 Emit @code{static} functions into the object file, even if the function
7578 is never used.
7580 @item -fkeep-static-consts
7581 @opindex fkeep-static-consts
7582 Emit variables declared @code{static const} when optimization isn't turned
7583 on, even if the variables aren't referenced.
7585 GCC enables this option by default.  If you want to force the compiler to
7586 check if a variable is referenced, regardless of whether or not
7587 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7589 @item -fmerge-constants
7590 @opindex fmerge-constants
7591 Attempt to merge identical constants (string constants and floating-point
7592 constants) across compilation units.
7594 This option is the default for optimized compilation if the assembler and
7595 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7596 behavior.
7598 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7600 @item -fmerge-all-constants
7601 @opindex fmerge-all-constants
7602 Attempt to merge identical constants and identical variables.
7604 This option implies @option{-fmerge-constants}.  In addition to
7605 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7606 arrays or initialized constant variables with integral or floating-point
7607 types.  Languages like C or C++ require each variable, including multiple
7608 instances of the same variable in recursive calls, to have distinct locations,
7609 so using this option results in non-conforming
7610 behavior.
7612 @item -fmodulo-sched
7613 @opindex fmodulo-sched
7614 Perform swing modulo scheduling immediately before the first scheduling
7615 pass.  This pass looks at innermost loops and reorders their
7616 instructions by overlapping different iterations.
7618 @item -fmodulo-sched-allow-regmoves
7619 @opindex fmodulo-sched-allow-regmoves
7620 Perform more aggressive SMS-based modulo scheduling with register moves
7621 allowed.  By setting this flag certain anti-dependences edges are
7622 deleted, which triggers the generation of reg-moves based on the
7623 life-range analysis.  This option is effective only with
7624 @option{-fmodulo-sched} enabled.
7626 @item -fno-branch-count-reg
7627 @opindex fno-branch-count-reg
7628 Avoid running a pass scanning for opportunities to use ``decrement and
7629 branch'' instructions on a count register instead of generating sequences
7630 of instructions that decrement a register, compare it against zero, and
7631 then branch based upon the result.  This option is only meaningful on
7632 architectures that support such instructions, which include x86, PowerPC,
7633 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7634 doesn't remove the decrement and branch instructions from the generated
7635 instruction stream introduced by other optimization passes.
7637 Enabled by default at @option{-O1} and higher.
7639 The default is @option{-fbranch-count-reg}.
7641 @item -fno-function-cse
7642 @opindex fno-function-cse
7643 Do not put function addresses in registers; make each instruction that
7644 calls a constant function contain the function's address explicitly.
7646 This option results in less efficient code, but some strange hacks
7647 that alter the assembler output may be confused by the optimizations
7648 performed when this option is not used.
7650 The default is @option{-ffunction-cse}
7652 @item -fno-zero-initialized-in-bss
7653 @opindex fno-zero-initialized-in-bss
7654 If the target supports a BSS section, GCC by default puts variables that
7655 are initialized to zero into BSS@.  This can save space in the resulting
7656 code.
7658 This option turns off this behavior because some programs explicitly
7659 rely on variables going to the data section---e.g., so that the
7660 resulting executable can find the beginning of that section and/or make
7661 assumptions based on that.
7663 The default is @option{-fzero-initialized-in-bss}.
7665 @item -fthread-jumps
7666 @opindex fthread-jumps
7667 Perform optimizations that check to see if a jump branches to a
7668 location where another comparison subsumed by the first is found.  If
7669 so, the first branch is redirected to either the destination of the
7670 second branch or a point immediately following it, depending on whether
7671 the condition is known to be true or false.
7673 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7675 @item -fsplit-wide-types
7676 @opindex fsplit-wide-types
7677 When using a type that occupies multiple registers, such as @code{long
7678 long} on a 32-bit system, split the registers apart and allocate them
7679 independently.  This normally generates better code for those types,
7680 but may make debugging more difficult.
7682 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7683 @option{-Os}.
7685 @item -fcse-follow-jumps
7686 @opindex fcse-follow-jumps
7687 In common subexpression elimination (CSE), scan through jump instructions
7688 when the target of the jump is not reached by any other path.  For
7689 example, when CSE encounters an @code{if} statement with an
7690 @code{else} clause, CSE follows the jump when the condition
7691 tested is false.
7693 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7695 @item -fcse-skip-blocks
7696 @opindex fcse-skip-blocks
7697 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7698 follow jumps that conditionally skip over blocks.  When CSE
7699 encounters a simple @code{if} statement with no else clause,
7700 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7701 body of the @code{if}.
7703 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7705 @item -frerun-cse-after-loop
7706 @opindex frerun-cse-after-loop
7707 Re-run common subexpression elimination after loop optimizations are
7708 performed.
7710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7712 @item -fgcse
7713 @opindex fgcse
7714 Perform a global common subexpression elimination pass.
7715 This pass also performs global constant and copy propagation.
7717 @emph{Note:} When compiling a program using computed gotos, a GCC
7718 extension, you may get better run-time performance if you disable
7719 the global common subexpression elimination pass by adding
7720 @option{-fno-gcse} to the command line.
7722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7724 @item -fgcse-lm
7725 @opindex fgcse-lm
7726 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7727 attempts to move loads that are only killed by stores into themselves.  This
7728 allows a loop containing a load/store sequence to be changed to a load outside
7729 the loop, and a copy/store within the loop.
7731 Enabled by default when @option{-fgcse} is enabled.
7733 @item -fgcse-sm
7734 @opindex fgcse-sm
7735 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7736 global common subexpression elimination.  This pass attempts to move
7737 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7738 loops containing a load/store sequence can be changed to a load before
7739 the loop and a store after the loop.
7741 Not enabled at any optimization level.
7743 @item -fgcse-las
7744 @opindex fgcse-las
7745 When @option{-fgcse-las} is enabled, the global common subexpression
7746 elimination pass eliminates redundant loads that come after stores to the
7747 same memory location (both partial and full redundancies).
7749 Not enabled at any optimization level.
7751 @item -fgcse-after-reload
7752 @opindex fgcse-after-reload
7753 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7754 pass is performed after reload.  The purpose of this pass is to clean up
7755 redundant spilling.
7757 @item -faggressive-loop-optimizations
7758 @opindex faggressive-loop-optimizations
7759 This option tells the loop optimizer to use language constraints to
7760 derive bounds for the number of iterations of a loop.  This assumes that
7761 loop code does not invoke undefined behavior by for example causing signed
7762 integer overflows or out-of-bound array accesses.  The bounds for the
7763 number of iterations of a loop are used to guide loop unrolling and peeling
7764 and loop exit test optimizations.
7765 This option is enabled by default.
7767 @item -funconstrained-commons
7768 @opindex funconstrained-commons
7769 This option tells the compiler that variables declared in common blocks
7770 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7771 prevents certain optimizations that depend on knowing the array bounds.
7773 @item -fcrossjumping
7774 @opindex fcrossjumping
7775 Perform cross-jumping transformation.
7776 This transformation unifies equivalent code and saves code size.  The
7777 resulting code may or may not perform better than without cross-jumping.
7779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7781 @item -fauto-inc-dec
7782 @opindex fauto-inc-dec
7783 Combine increments or decrements of addresses with memory accesses.
7784 This pass is always skipped on architectures that do not have
7785 instructions to support this.  Enabled by default at @option{-O} and
7786 higher on architectures that support this.
7788 @item -fdce
7789 @opindex fdce
7790 Perform dead code elimination (DCE) on RTL@.
7791 Enabled by default at @option{-O} and higher.
7793 @item -fdse
7794 @opindex fdse
7795 Perform dead store elimination (DSE) on RTL@.
7796 Enabled by default at @option{-O} and higher.
7798 @item -fif-conversion
7799 @opindex fif-conversion
7800 Attempt to transform conditional jumps into branch-less equivalents.  This
7801 includes use of conditional moves, min, max, set flags and abs instructions, and
7802 some tricks doable by standard arithmetics.  The use of conditional execution
7803 on chips where it is available is controlled by @option{-fif-conversion2}.
7805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7807 @item -fif-conversion2
7808 @opindex fif-conversion2
7809 Use conditional execution (where available) to transform conditional jumps into
7810 branch-less equivalents.
7812 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7814 @item -fdeclone-ctor-dtor
7815 @opindex fdeclone-ctor-dtor
7816 The C++ ABI requires multiple entry points for constructors and
7817 destructors: one for a base subobject, one for a complete object, and
7818 one for a virtual destructor that calls operator delete afterwards.
7819 For a hierarchy with virtual bases, the base and complete variants are
7820 clones, which means two copies of the function.  With this option, the
7821 base and complete variants are changed to be thunks that call a common
7822 implementation.
7824 Enabled by @option{-Os}.
7826 @item -fdelete-null-pointer-checks
7827 @opindex fdelete-null-pointer-checks
7828 Assume that programs cannot safely dereference null pointers, and that
7829 no code or data element resides at address zero.
7830 This option enables simple constant
7831 folding optimizations at all optimization levels.  In addition, other
7832 optimization passes in GCC use this flag to control global dataflow
7833 analyses that eliminate useless checks for null pointers; these assume
7834 that a memory access to address zero always results in a trap, so
7835 that if a pointer is checked after it has already been dereferenced,
7836 it cannot be null.
7838 Note however that in some environments this assumption is not true.
7839 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7840 for programs that depend on that behavior.
7842 This option is enabled by default on most targets.  On Nios II ELF, it
7843 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7845 Passes that use the dataflow information
7846 are enabled independently at different optimization levels.
7848 @item -fdevirtualize
7849 @opindex fdevirtualize
7850 Attempt to convert calls to virtual functions to direct calls.  This
7851 is done both within a procedure and interprocedurally as part of
7852 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7853 propagation (@option{-fipa-cp}).
7854 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7856 @item -fdevirtualize-speculatively
7857 @opindex fdevirtualize-speculatively
7858 Attempt to convert calls to virtual functions to speculative direct calls.
7859 Based on the analysis of the type inheritance graph, determine for a given call
7860 the set of likely targets. If the set is small, preferably of size 1, change
7861 the call into a conditional deciding between direct and indirect calls.  The
7862 speculative calls enable more optimizations, such as inlining.  When they seem
7863 useless after further optimization, they are converted back into original form.
7865 @item -fdevirtualize-at-ltrans
7866 @opindex fdevirtualize-at-ltrans
7867 Stream extra information needed for aggressive devirtualization when running
7868 the link-time optimizer in local transformation mode.  
7869 This option enables more devirtualization but
7870 significantly increases the size of streamed data. For this reason it is
7871 disabled by default.
7873 @item -fexpensive-optimizations
7874 @opindex fexpensive-optimizations
7875 Perform a number of minor optimizations that are relatively expensive.
7877 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7879 @item -free
7880 @opindex free
7881 Attempt to remove redundant extension instructions.  This is especially
7882 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7883 registers after writing to their lower 32-bit half.
7885 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7886 @option{-O3}, @option{-Os}.
7888 @item -fno-lifetime-dse
7889 @opindex fno-lifetime-dse
7890 In C++ the value of an object is only affected by changes within its
7891 lifetime: when the constructor begins, the object has an indeterminate
7892 value, and any changes during the lifetime of the object are dead when
7893 the object is destroyed.  Normally dead store elimination will take
7894 advantage of this; if your code relies on the value of the object
7895 storage persisting beyond the lifetime of the object, you can use this
7896 flag to disable this optimization.  To preserve stores before the
7897 constructor starts (e.g. because your operator new clears the object
7898 storage) but still treat the object as dead after the destructor you,
7899 can use @option{-flifetime-dse=1}.  The default behavior can be
7900 explicitly selected with @option{-flifetime-dse=2}.
7901 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7903 @item -flive-range-shrinkage
7904 @opindex flive-range-shrinkage
7905 Attempt to decrease register pressure through register live range
7906 shrinkage.  This is helpful for fast processors with small or moderate
7907 size register sets.
7909 @item -fira-algorithm=@var{algorithm}
7910 @opindex fira-algorithm
7911 Use the specified coloring algorithm for the integrated register
7912 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7913 specifies Chow's priority coloring, or @samp{CB}, which specifies
7914 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7915 for all architectures, but for those targets that do support it, it is
7916 the default because it generates better code.
7918 @item -fira-region=@var{region}
7919 @opindex fira-region
7920 Use specified regions for the integrated register allocator.  The
7921 @var{region} argument should be one of the following:
7923 @table @samp
7925 @item all
7926 Use all loops as register allocation regions.
7927 This can give the best results for machines with a small and/or
7928 irregular register set.
7930 @item mixed
7931 Use all loops except for loops with small register pressure 
7932 as the regions.  This value usually gives
7933 the best results in most cases and for most architectures,
7934 and is enabled by default when compiling with optimization for speed
7935 (@option{-O}, @option{-O2}, @dots{}).
7937 @item one
7938 Use all functions as a single region.  
7939 This typically results in the smallest code size, and is enabled by default for
7940 @option{-Os} or @option{-O0}.
7942 @end table
7944 @item -fira-hoist-pressure
7945 @opindex fira-hoist-pressure
7946 Use IRA to evaluate register pressure in the code hoisting pass for
7947 decisions to hoist expressions.  This option usually results in smaller
7948 code, but it can slow the compiler down.
7950 This option is enabled at level @option{-Os} for all targets.
7952 @item -fira-loop-pressure
7953 @opindex fira-loop-pressure
7954 Use IRA to evaluate register pressure in loops for decisions to move
7955 loop invariants.  This option usually results in generation
7956 of faster and smaller code on machines with large register files (>= 32
7957 registers), but it can slow the compiler down.
7959 This option is enabled at level @option{-O3} for some targets.
7961 @item -fno-ira-share-save-slots
7962 @opindex fno-ira-share-save-slots
7963 Disable sharing of stack slots used for saving call-used hard
7964 registers living through a call.  Each hard register gets a
7965 separate stack slot, and as a result function stack frames are
7966 larger.
7968 @item -fno-ira-share-spill-slots
7969 @opindex fno-ira-share-spill-slots
7970 Disable sharing of stack slots allocated for pseudo-registers.  Each
7971 pseudo-register that does not get a hard register gets a separate
7972 stack slot, and as a result function stack frames are larger.
7974 @item -flra-remat
7975 @opindex flra-remat
7976 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7977 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7978 values if it is profitable.
7980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7982 @item -fdelayed-branch
7983 @opindex fdelayed-branch
7984 If supported for the target machine, attempt to reorder instructions
7985 to exploit instruction slots available after delayed branch
7986 instructions.
7988 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7990 @item -fschedule-insns
7991 @opindex fschedule-insns
7992 If supported for the target machine, attempt to reorder instructions to
7993 eliminate execution stalls due to required data being unavailable.  This
7994 helps machines that have slow floating point or memory load instructions
7995 by allowing other instructions to be issued until the result of the load
7996 or floating-point instruction is required.
7998 Enabled at levels @option{-O2}, @option{-O3}.
8000 @item -fschedule-insns2
8001 @opindex fschedule-insns2
8002 Similar to @option{-fschedule-insns}, but requests an additional pass of
8003 instruction scheduling after register allocation has been done.  This is
8004 especially useful on machines with a relatively small number of
8005 registers and where memory load instructions take more than one cycle.
8007 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8009 @item -fno-sched-interblock
8010 @opindex fno-sched-interblock
8011 Don't schedule instructions across basic blocks.  This is normally
8012 enabled by default when scheduling before register allocation, i.e.@:
8013 with @option{-fschedule-insns} or at @option{-O2} or higher.
8015 @item -fno-sched-spec
8016 @opindex fno-sched-spec
8017 Don't allow speculative motion of non-load instructions.  This is normally
8018 enabled by default when scheduling before register allocation, i.e.@:
8019 with @option{-fschedule-insns} or at @option{-O2} or higher.
8021 @item -fsched-pressure
8022 @opindex fsched-pressure
8023 Enable register pressure sensitive insn scheduling before register
8024 allocation.  This only makes sense when scheduling before register
8025 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8026 @option{-O2} or higher.  Usage of this option can improve the
8027 generated code and decrease its size by preventing register pressure
8028 increase above the number of available hard registers and subsequent
8029 spills in register allocation.
8031 @item -fsched-spec-load
8032 @opindex fsched-spec-load
8033 Allow speculative motion of some load instructions.  This only makes
8034 sense when scheduling before register allocation, i.e.@: with
8035 @option{-fschedule-insns} or at @option{-O2} or higher.
8037 @item -fsched-spec-load-dangerous
8038 @opindex fsched-spec-load-dangerous
8039 Allow speculative motion of more load instructions.  This only makes
8040 sense when scheduling before register allocation, i.e.@: with
8041 @option{-fschedule-insns} or at @option{-O2} or higher.
8043 @item -fsched-stalled-insns
8044 @itemx -fsched-stalled-insns=@var{n}
8045 @opindex fsched-stalled-insns
8046 Define how many insns (if any) can be moved prematurely from the queue
8047 of stalled insns into the ready list during the second scheduling pass.
8048 @option{-fno-sched-stalled-insns} means that no insns are moved
8049 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8050 on how many queued insns can be moved prematurely.
8051 @option{-fsched-stalled-insns} without a value is equivalent to
8052 @option{-fsched-stalled-insns=1}.
8054 @item -fsched-stalled-insns-dep
8055 @itemx -fsched-stalled-insns-dep=@var{n}
8056 @opindex fsched-stalled-insns-dep
8057 Define how many insn groups (cycles) are examined for a dependency
8058 on a stalled insn that is a candidate for premature removal from the queue
8059 of stalled insns.  This has an effect only during the second scheduling pass,
8060 and only if @option{-fsched-stalled-insns} is used.
8061 @option{-fno-sched-stalled-insns-dep} is equivalent to
8062 @option{-fsched-stalled-insns-dep=0}.
8063 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8064 @option{-fsched-stalled-insns-dep=1}.
8066 @item -fsched2-use-superblocks
8067 @opindex fsched2-use-superblocks
8068 When scheduling after register allocation, use superblock scheduling.
8069 This allows motion across basic block boundaries,
8070 resulting in faster schedules.  This option is experimental, as not all machine
8071 descriptions used by GCC model the CPU closely enough to avoid unreliable
8072 results from the algorithm.
8074 This only makes sense when scheduling after register allocation, i.e.@: with
8075 @option{-fschedule-insns2} or at @option{-O2} or higher.
8077 @item -fsched-group-heuristic
8078 @opindex fsched-group-heuristic
8079 Enable the group heuristic in the scheduler.  This heuristic favors
8080 the instruction that belongs to a schedule group.  This is enabled
8081 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8082 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8084 @item -fsched-critical-path-heuristic
8085 @opindex fsched-critical-path-heuristic
8086 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8087 instructions on the critical path.  This is enabled by default when
8088 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8089 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8091 @item -fsched-spec-insn-heuristic
8092 @opindex fsched-spec-insn-heuristic
8093 Enable the speculative instruction heuristic in the scheduler.  This
8094 heuristic favors speculative instructions with greater dependency weakness.
8095 This is enabled by default when scheduling is enabled, i.e.@:
8096 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8097 or at @option{-O2} or higher.
8099 @item -fsched-rank-heuristic
8100 @opindex fsched-rank-heuristic
8101 Enable the rank heuristic in the scheduler.  This heuristic favors
8102 the instruction belonging to a basic block with greater size or frequency.
8103 This is enabled by default when scheduling is enabled, i.e.@:
8104 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8105 at @option{-O2} or higher.
8107 @item -fsched-last-insn-heuristic
8108 @opindex fsched-last-insn-heuristic
8109 Enable the last-instruction heuristic in the scheduler.  This heuristic
8110 favors the instruction that is less dependent on the last instruction
8111 scheduled.  This is enabled by default when scheduling is enabled,
8112 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8113 at @option{-O2} or higher.
8115 @item -fsched-dep-count-heuristic
8116 @opindex fsched-dep-count-heuristic
8117 Enable the dependent-count heuristic in the scheduler.  This heuristic
8118 favors the instruction that has more instructions depending on it.
8119 This is enabled by default when scheduling is enabled, i.e.@:
8120 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8121 at @option{-O2} or higher.
8123 @item -freschedule-modulo-scheduled-loops
8124 @opindex freschedule-modulo-scheduled-loops
8125 Modulo scheduling is performed before traditional scheduling.  If a loop
8126 is modulo scheduled, later scheduling passes may change its schedule.  
8127 Use this option to control that behavior.
8129 @item -fselective-scheduling
8130 @opindex fselective-scheduling
8131 Schedule instructions using selective scheduling algorithm.  Selective
8132 scheduling runs instead of the first scheduler pass.
8134 @item -fselective-scheduling2
8135 @opindex fselective-scheduling2
8136 Schedule instructions using selective scheduling algorithm.  Selective
8137 scheduling runs instead of the second scheduler pass.
8139 @item -fsel-sched-pipelining
8140 @opindex fsel-sched-pipelining
8141 Enable software pipelining of innermost loops during selective scheduling.
8142 This option has no effect unless one of @option{-fselective-scheduling} or
8143 @option{-fselective-scheduling2} is turned on.
8145 @item -fsel-sched-pipelining-outer-loops
8146 @opindex fsel-sched-pipelining-outer-loops
8147 When pipelining loops during selective scheduling, also pipeline outer loops.
8148 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8150 @item -fsemantic-interposition
8151 @opindex fsemantic-interposition
8152 Some object formats, like ELF, allow interposing of symbols by the 
8153 dynamic linker.
8154 This means that for symbols exported from the DSO, the compiler cannot perform
8155 interprocedural propagation, inlining and other optimizations in anticipation
8156 that the function or variable in question may change. While this feature is
8157 useful, for example, to rewrite memory allocation functions by a debugging
8158 implementation, it is expensive in the terms of code quality.
8159 With @option{-fno-semantic-interposition} the compiler assumes that 
8160 if interposition happens for functions the overwriting function will have 
8161 precisely the same semantics (and side effects). 
8162 Similarly if interposition happens
8163 for variables, the constructor of the variable will be the same. The flag
8164 has no effect for functions explicitly declared inline 
8165 (where it is never allowed for interposition to change semantics) 
8166 and for symbols explicitly declared weak.
8168 @item -fshrink-wrap
8169 @opindex fshrink-wrap
8170 Emit function prologues only before parts of the function that need it,
8171 rather than at the top of the function.  This flag is enabled by default at
8172 @option{-O} and higher.
8174 @item -fshrink-wrap-separate
8175 @opindex fshrink-wrap-separate
8176 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8177 those parts are only executed when needed.
8178 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8179 is also turned on and the target supports this.
8181 @item -fcaller-saves
8182 @opindex fcaller-saves
8183 Enable allocation of values to registers that are clobbered by
8184 function calls, by emitting extra instructions to save and restore the
8185 registers around such calls.  Such allocation is done only when it
8186 seems to result in better code.
8188 This option is always enabled by default on certain machines, usually
8189 those which have no call-preserved registers to use instead.
8191 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8193 @item -fcombine-stack-adjustments
8194 @opindex fcombine-stack-adjustments
8195 Tracks stack adjustments (pushes and pops) and stack memory references
8196 and then tries to find ways to combine them.
8198 Enabled by default at @option{-O1} and higher.
8200 @item -fipa-ra
8201 @opindex fipa-ra
8202 Use caller save registers for allocation if those registers are not used by
8203 any called function.  In that case it is not necessary to save and restore
8204 them around calls.  This is only possible if called functions are part of
8205 same compilation unit as current function and they are compiled before it.
8207 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8208 is disabled if generated code will be instrumented for profiling
8209 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8210 exactly (this happens on targets that do not expose prologues
8211 and epilogues in RTL).
8213 @item -fconserve-stack
8214 @opindex fconserve-stack
8215 Attempt to minimize stack usage.  The compiler attempts to use less
8216 stack space, even if that makes the program slower.  This option
8217 implies setting the @option{large-stack-frame} parameter to 100
8218 and the @option{large-stack-frame-growth} parameter to 400.
8220 @item -ftree-reassoc
8221 @opindex ftree-reassoc
8222 Perform reassociation on trees.  This flag is enabled by default
8223 at @option{-O} and higher.
8225 @item -fcode-hoisting
8226 @opindex fcode-hoisting
8227 Perform code hoisting.  Code hoisting tries to move the
8228 evaluation of expressions executed on all paths to the function exit
8229 as early as possible.  This is especially useful as a code size
8230 optimization, but it often helps for code speed as well.
8231 This flag is enabled by default at @option{-O2} and higher.
8233 @item -ftree-pre
8234 @opindex ftree-pre
8235 Perform partial redundancy elimination (PRE) on trees.  This flag is
8236 enabled by default at @option{-O2} and @option{-O3}.
8238 @item -ftree-partial-pre
8239 @opindex ftree-partial-pre
8240 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8241 enabled by default at @option{-O3}.
8243 @item -ftree-forwprop
8244 @opindex ftree-forwprop
8245 Perform forward propagation on trees.  This flag is enabled by default
8246 at @option{-O} and higher.
8248 @item -ftree-fre
8249 @opindex ftree-fre
8250 Perform full redundancy elimination (FRE) on trees.  The difference
8251 between FRE and PRE is that FRE only considers expressions
8252 that are computed on all paths leading to the redundant computation.
8253 This analysis is faster than PRE, though it exposes fewer redundancies.
8254 This flag is enabled by default at @option{-O} and higher.
8256 @item -ftree-phiprop
8257 @opindex ftree-phiprop
8258 Perform hoisting of loads from conditional pointers on trees.  This
8259 pass is enabled by default at @option{-O} and higher.
8261 @item -fhoist-adjacent-loads
8262 @opindex fhoist-adjacent-loads
8263 Speculatively hoist loads from both branches of an if-then-else if the
8264 loads are from adjacent locations in the same structure and the target
8265 architecture has a conditional move instruction.  This flag is enabled
8266 by default at @option{-O2} and higher.
8268 @item -ftree-copy-prop
8269 @opindex ftree-copy-prop
8270 Perform copy propagation on trees.  This pass eliminates unnecessary
8271 copy operations.  This flag is enabled by default at @option{-O} and
8272 higher.
8274 @item -fipa-pure-const
8275 @opindex fipa-pure-const
8276 Discover which functions are pure or constant.
8277 Enabled by default at @option{-O} and higher.
8279 @item -fipa-reference
8280 @opindex fipa-reference
8281 Discover which static variables do not escape the
8282 compilation unit.
8283 Enabled by default at @option{-O} and higher.
8285 @item -fipa-pta
8286 @opindex fipa-pta
8287 Perform interprocedural pointer analysis and interprocedural modification
8288 and reference analysis.  This option can cause excessive memory and
8289 compile-time usage on large compilation units.  It is not enabled by
8290 default at any optimization level.
8292 @item -fipa-profile
8293 @opindex fipa-profile
8294 Perform interprocedural profile propagation.  The functions called only from
8295 cold functions are marked as cold. Also functions executed once (such as
8296 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8297 functions and loop less parts of functions executed once are then optimized for
8298 size.
8299 Enabled by default at @option{-O} and higher.
8301 @item -fipa-cp
8302 @opindex fipa-cp
8303 Perform interprocedural constant propagation.
8304 This optimization analyzes the program to determine when values passed
8305 to functions are constants and then optimizes accordingly.
8306 This optimization can substantially increase performance
8307 if the application has constants passed to functions.
8308 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8310 @item -fipa-cp-clone
8311 @opindex fipa-cp-clone
8312 Perform function cloning to make interprocedural constant propagation stronger.
8313 When enabled, interprocedural constant propagation performs function cloning
8314 when externally visible function can be called with constant arguments.
8315 Because this optimization can create multiple copies of functions,
8316 it may significantly increase code size
8317 (see @option{--param ipcp-unit-growth=@var{value}}).
8318 This flag is enabled by default at @option{-O3}.
8320 @item -fipa-bit-cp
8321 @opindex -fipa-bit-cp
8322 When enabled, perform interprocedural bitwise constant
8323 propagation. This flag is enabled by default at @option{-O2}. It
8324 requires that @option{-fipa-cp} is enabled.
8326 @item -fipa-vrp
8327 @opindex -fipa-vrp
8328 When enabled, perform interprocedural propagation of value
8329 ranges. This flag is enabled by default at @option{-O2}. It requires
8330 that @option{-fipa-cp} is enabled.
8332 @item -fipa-icf
8333 @opindex fipa-icf
8334 Perform Identical Code Folding for functions and read-only variables.
8335 The optimization reduces code size and may disturb unwind stacks by replacing
8336 a function by equivalent one with a different name. The optimization works
8337 more effectively with link-time optimization enabled.
8339 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8340 works on different levels and thus the optimizations are not same - there are
8341 equivalences that are found only by GCC and equivalences found only by Gold.
8343 This flag is enabled by default at @option{-O2} and @option{-Os}.
8345 @item -fisolate-erroneous-paths-dereference
8346 @opindex fisolate-erroneous-paths-dereference
8347 Detect paths that trigger erroneous or undefined behavior due to
8348 dereferencing a null pointer.  Isolate those paths from the main control
8349 flow and turn the statement with erroneous or undefined behavior into a trap.
8350 This flag is enabled by default at @option{-O2} and higher and depends on
8351 @option{-fdelete-null-pointer-checks} also being enabled.
8353 @item -fisolate-erroneous-paths-attribute
8354 @opindex fisolate-erroneous-paths-attribute
8355 Detect paths that trigger erroneous or undefined behavior due a null value
8356 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8357 attribute.  Isolate those paths from the main control flow and turn the
8358 statement with erroneous or undefined behavior into a trap.  This is not
8359 currently enabled, but may be enabled by @option{-O2} in the future.
8361 @item -ftree-sink
8362 @opindex ftree-sink
8363 Perform forward store motion on trees.  This flag is
8364 enabled by default at @option{-O} and higher.
8366 @item -ftree-bit-ccp
8367 @opindex ftree-bit-ccp
8368 Perform sparse conditional bit constant propagation on trees and propagate
8369 pointer alignment information.
8370 This pass only operates on local scalar variables and is enabled by default
8371 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8373 @item -ftree-ccp
8374 @opindex ftree-ccp
8375 Perform sparse conditional constant propagation (CCP) on trees.  This
8376 pass only operates on local scalar variables and is enabled by default
8377 at @option{-O} and higher.
8379 @item -fssa-backprop
8380 @opindex fssa-backprop
8381 Propagate information about uses of a value up the definition chain
8382 in order to simplify the definitions.  For example, this pass strips
8383 sign operations if the sign of a value never matters.  The flag is
8384 enabled by default at @option{-O} and higher.
8386 @item -fssa-phiopt
8387 @opindex fssa-phiopt
8388 Perform pattern matching on SSA PHI nodes to optimize conditional
8389 code.  This pass is enabled by default at @option{-O} and higher.
8391 @item -ftree-switch-conversion
8392 @opindex ftree-switch-conversion
8393 Perform conversion of simple initializations in a switch to
8394 initializations from a scalar array.  This flag is enabled by default
8395 at @option{-O2} and higher.
8397 @item -ftree-tail-merge
8398 @opindex ftree-tail-merge
8399 Look for identical code sequences.  When found, replace one with a jump to the
8400 other.  This optimization is known as tail merging or cross jumping.  This flag
8401 is enabled by default at @option{-O2} and higher.  The compilation time
8402 in this pass can
8403 be limited using @option{max-tail-merge-comparisons} parameter and
8404 @option{max-tail-merge-iterations} parameter.
8406 @item -ftree-dce
8407 @opindex ftree-dce
8408 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8409 default at @option{-O} and higher.
8411 @item -ftree-builtin-call-dce
8412 @opindex ftree-builtin-call-dce
8413 Perform conditional dead code elimination (DCE) for calls to built-in functions
8414 that may set @code{errno} but are otherwise side-effect free.  This flag is
8415 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8416 specified.
8418 @item -ftree-dominator-opts
8419 @opindex ftree-dominator-opts
8420 Perform a variety of simple scalar cleanups (constant/copy
8421 propagation, redundancy elimination, range propagation and expression
8422 simplification) based on a dominator tree traversal.  This also
8423 performs jump threading (to reduce jumps to jumps). This flag is
8424 enabled by default at @option{-O} and higher.
8426 @item -ftree-dse
8427 @opindex ftree-dse
8428 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8429 a memory location that is later overwritten by another store without
8430 any intervening loads.  In this case the earlier store can be deleted.  This
8431 flag is enabled by default at @option{-O} and higher.
8433 @item -ftree-ch
8434 @opindex ftree-ch
8435 Perform loop header copying on trees.  This is beneficial since it increases
8436 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8437 is enabled by default at @option{-O} and higher.  It is not enabled
8438 for @option{-Os}, since it usually increases code size.
8440 @item -ftree-loop-optimize
8441 @opindex ftree-loop-optimize
8442 Perform loop optimizations on trees.  This flag is enabled by default
8443 at @option{-O} and higher.
8445 @item -ftree-loop-linear
8446 @itemx -floop-interchange
8447 @itemx -floop-strip-mine
8448 @itemx -floop-block
8449 @itemx -floop-unroll-and-jam
8450 @opindex ftree-loop-linear
8451 @opindex floop-interchange
8452 @opindex floop-strip-mine
8453 @opindex floop-block
8454 @opindex floop-unroll-and-jam
8455 Perform loop nest optimizations.  Same as
8456 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8457 to be configured with @option{--with-isl} to enable the Graphite loop
8458 transformation infrastructure.
8460 @item -fgraphite-identity
8461 @opindex fgraphite-identity
8462 Enable the identity transformation for graphite.  For every SCoP we generate
8463 the polyhedral representation and transform it back to gimple.  Using
8464 @option{-fgraphite-identity} we can check the costs or benefits of the
8465 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8466 are also performed by the code generator isl, like index splitting and
8467 dead code elimination in loops.
8469 @item -floop-nest-optimize
8470 @opindex floop-nest-optimize
8471 Enable the isl based loop nest optimizer.  This is a generic loop nest
8472 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8473 structure optimized for data-locality and parallelism.  This option
8474 is experimental.
8476 @item -floop-parallelize-all
8477 @opindex floop-parallelize-all
8478 Use the Graphite data dependence analysis to identify loops that can
8479 be parallelized.  Parallelize all the loops that can be analyzed to
8480 not contain loop carried dependences without checking that it is
8481 profitable to parallelize the loops.
8483 @item -ftree-coalesce-vars
8484 @opindex ftree-coalesce-vars
8485 While transforming the program out of the SSA representation, attempt to
8486 reduce copying by coalescing versions of different user-defined
8487 variables, instead of just compiler temporaries.  This may severely
8488 limit the ability to debug an optimized program compiled with
8489 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8490 prevents SSA coalescing of user variables.  This option is enabled by
8491 default if optimization is enabled, and it does very little otherwise.
8493 @item -ftree-loop-if-convert
8494 @opindex ftree-loop-if-convert
8495 Attempt to transform conditional jumps in the innermost loops to
8496 branch-less equivalents.  The intent is to remove control-flow from
8497 the innermost loops in order to improve the ability of the
8498 vectorization pass to handle these loops.  This is enabled by default
8499 if vectorization is enabled.
8501 @item -ftree-loop-distribution
8502 @opindex ftree-loop-distribution
8503 Perform loop distribution.  This flag can improve cache performance on
8504 big loop bodies and allow further loop optimizations, like
8505 parallelization or vectorization, to take place.  For example, the loop
8506 @smallexample
8507 DO I = 1, N
8508   A(I) = B(I) + C
8509   D(I) = E(I) * F
8510 ENDDO
8511 @end smallexample
8512 is transformed to
8513 @smallexample
8514 DO I = 1, N
8515    A(I) = B(I) + C
8516 ENDDO
8517 DO I = 1, N
8518    D(I) = E(I) * F
8519 ENDDO
8520 @end smallexample
8522 @item -ftree-loop-distribute-patterns
8523 @opindex ftree-loop-distribute-patterns
8524 Perform loop distribution of patterns that can be code generated with
8525 calls to a library.  This flag is enabled by default at @option{-O3}.
8527 This pass distributes the initialization loops and generates a call to
8528 memset zero.  For example, the loop
8529 @smallexample
8530 DO I = 1, N
8531   A(I) = 0
8532   B(I) = A(I) + I
8533 ENDDO
8534 @end smallexample
8535 is transformed to
8536 @smallexample
8537 DO I = 1, N
8538    A(I) = 0
8539 ENDDO
8540 DO I = 1, N
8541    B(I) = A(I) + I
8542 ENDDO
8543 @end smallexample
8544 and the initialization loop is transformed into a call to memset zero.
8546 @item -ftree-loop-im
8547 @opindex ftree-loop-im
8548 Perform loop invariant motion on trees.  This pass moves only invariants that
8549 are hard to handle at RTL level (function calls, operations that expand to
8550 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8551 operands of conditions that are invariant out of the loop, so that we can use
8552 just trivial invariantness analysis in loop unswitching.  The pass also includes
8553 store motion.
8555 @item -ftree-loop-ivcanon
8556 @opindex ftree-loop-ivcanon
8557 Create a canonical counter for number of iterations in loops for which
8558 determining number of iterations requires complicated analysis.  Later
8559 optimizations then may determine the number easily.  Useful especially
8560 in connection with unrolling.
8562 @item -fivopts
8563 @opindex fivopts
8564 Perform induction variable optimizations (strength reduction, induction
8565 variable merging and induction variable elimination) on trees.
8567 @item -ftree-parallelize-loops=n
8568 @opindex ftree-parallelize-loops
8569 Parallelize loops, i.e., split their iteration space to run in n threads.
8570 This is only possible for loops whose iterations are independent
8571 and can be arbitrarily reordered.  The optimization is only
8572 profitable on multiprocessor machines, for loops that are CPU-intensive,
8573 rather than constrained e.g.@: by memory bandwidth.  This option
8574 implies @option{-pthread}, and thus is only supported on targets
8575 that have support for @option{-pthread}.
8577 @item -ftree-pta
8578 @opindex ftree-pta
8579 Perform function-local points-to analysis on trees.  This flag is
8580 enabled by default at @option{-O} and higher.
8582 @item -ftree-sra
8583 @opindex ftree-sra
8584 Perform scalar replacement of aggregates.  This pass replaces structure
8585 references with scalars to prevent committing structures to memory too
8586 early.  This flag is enabled by default at @option{-O} and higher.
8588 @item -fstore-merging
8589 @opindex fstore-merging
8590 Perform merging of narrow stores to consecutive memory addresses.  This pass
8591 merges contiguous stores of immediate values narrower than a word into fewer
8592 wider stores to reduce the number of instructions.  This is enabled by default
8593 at @option{-O2} and higher as well as @option{-Os}.
8595 @item -ftree-ter
8596 @opindex ftree-ter
8597 Perform temporary expression replacement during the SSA->normal phase.  Single
8598 use/single def temporaries are replaced at their use location with their
8599 defining expression.  This results in non-GIMPLE code, but gives the expanders
8600 much more complex trees to work on resulting in better RTL generation.  This is
8601 enabled by default at @option{-O} and higher.
8603 @item -ftree-slsr
8604 @opindex ftree-slsr
8605 Perform straight-line strength reduction on trees.  This recognizes related
8606 expressions involving multiplications and replaces them by less expensive
8607 calculations when possible.  This is enabled by default at @option{-O} and
8608 higher.
8610 @item -ftree-vectorize
8611 @opindex ftree-vectorize
8612 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8613 and @option{-ftree-slp-vectorize} if not explicitly specified.
8615 @item -ftree-loop-vectorize
8616 @opindex ftree-loop-vectorize
8617 Perform loop vectorization on trees. This flag is enabled by default at
8618 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8620 @item -ftree-slp-vectorize
8621 @opindex ftree-slp-vectorize
8622 Perform basic block vectorization on trees. This flag is enabled by default at
8623 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8625 @item -fvect-cost-model=@var{model}
8626 @opindex fvect-cost-model
8627 Alter the cost model used for vectorization.  The @var{model} argument
8628 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8629 With the @samp{unlimited} model the vectorized code-path is assumed
8630 to be profitable while with the @samp{dynamic} model a runtime check
8631 guards the vectorized code-path to enable it only for iteration
8632 counts that will likely execute faster than when executing the original
8633 scalar loop.  The @samp{cheap} model disables vectorization of
8634 loops where doing so would be cost prohibitive for example due to
8635 required runtime checks for data dependence or alignment but otherwise
8636 is equal to the @samp{dynamic} model.
8637 The default cost model depends on other optimization flags and is
8638 either @samp{dynamic} or @samp{cheap}.
8640 @item -fsimd-cost-model=@var{model}
8641 @opindex fsimd-cost-model
8642 Alter the cost model used for vectorization of loops marked with the OpenMP
8643 or Cilk Plus simd directive.  The @var{model} argument should be one of
8644 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8645 have the same meaning as described in @option{-fvect-cost-model} and by
8646 default a cost model defined with @option{-fvect-cost-model} is used.
8648 @item -ftree-vrp
8649 @opindex ftree-vrp
8650 Perform Value Range Propagation on trees.  This is similar to the
8651 constant propagation pass, but instead of values, ranges of values are
8652 propagated.  This allows the optimizers to remove unnecessary range
8653 checks like array bound checks and null pointer checks.  This is
8654 enabled by default at @option{-O2} and higher.  Null pointer check
8655 elimination is only done if @option{-fdelete-null-pointer-checks} is
8656 enabled.
8658 @item -fsplit-paths
8659 @opindex fsplit-paths
8660 Split paths leading to loop backedges.  This can improve dead code
8661 elimination and common subexpression elimination.  This is enabled by
8662 default at @option{-O2} and above.
8664 @item -fsplit-ivs-in-unroller
8665 @opindex fsplit-ivs-in-unroller
8666 Enables expression of values of induction variables in later iterations
8667 of the unrolled loop using the value in the first iteration.  This breaks
8668 long dependency chains, thus improving efficiency of the scheduling passes.
8670 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8671 same effect.  However, that is not reliable in cases where the loop body
8672 is more complicated than a single basic block.  It also does not work at all
8673 on some architectures due to restrictions in the CSE pass.
8675 This optimization is enabled by default.
8677 @item -fvariable-expansion-in-unroller
8678 @opindex fvariable-expansion-in-unroller
8679 With this option, the compiler creates multiple copies of some
8680 local variables when unrolling a loop, which can result in superior code.
8682 @item -fpartial-inlining
8683 @opindex fpartial-inlining
8684 Inline parts of functions.  This option has any effect only
8685 when inlining itself is turned on by the @option{-finline-functions}
8686 or @option{-finline-small-functions} options.
8688 Enabled at level @option{-O2}.
8690 @item -fpredictive-commoning
8691 @opindex fpredictive-commoning
8692 Perform predictive commoning optimization, i.e., reusing computations
8693 (especially memory loads and stores) performed in previous
8694 iterations of loops.
8696 This option is enabled at level @option{-O3}.
8698 @item -fprefetch-loop-arrays
8699 @opindex fprefetch-loop-arrays
8700 If supported by the target machine, generate instructions to prefetch
8701 memory to improve the performance of loops that access large arrays.
8703 This option may generate better or worse code; results are highly
8704 dependent on the structure of loops within the source code.
8706 Disabled at level @option{-Os}.
8708 @item -fno-printf-return-value
8709 @opindex fno-printf-return-value
8710 Do not substitute constants for known return value of formatted output
8711 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8712 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8713 transformation allows GCC to optimize or even eliminate branches based
8714 on the known return value of these functions called with arguments that
8715 are either constant, or whose values are known to be in a range that
8716 makes determining the exact return value possible.  For example, when
8717 @option{-fprintf-return-value} is in effect, both the branch and the
8718 body of the @code{if} statement (but not the call to @code{snprint})
8719 can be optimized away when @code{i} is a 32-bit or smaller integer
8720 because the return value is guaranteed to be at most 8.
8722 @smallexample
8723 char buf[9];
8724 if (snprintf (buf, "%08x", i) >= sizeof buf)
8725   @dots{}
8726 @end smallexample
8728 The @option{-fprintf-return-value} option relies on other optimizations
8729 and yields best results with @option{-O2}.  It works in tandem with the
8730 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8731 The @option{-fprintf-return-value} option is enabled by default.
8733 @item -fno-peephole
8734 @itemx -fno-peephole2
8735 @opindex fno-peephole
8736 @opindex fno-peephole2
8737 Disable any machine-specific peephole optimizations.  The difference
8738 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8739 are implemented in the compiler; some targets use one, some use the
8740 other, a few use both.
8742 @option{-fpeephole} is enabled by default.
8743 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8745 @item -fno-guess-branch-probability
8746 @opindex fno-guess-branch-probability
8747 Do not guess branch probabilities using heuristics.
8749 GCC uses heuristics to guess branch probabilities if they are
8750 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8751 heuristics are based on the control flow graph.  If some branch probabilities
8752 are specified by @code{__builtin_expect}, then the heuristics are
8753 used to guess branch probabilities for the rest of the control flow graph,
8754 taking the @code{__builtin_expect} info into account.  The interactions
8755 between the heuristics and @code{__builtin_expect} can be complex, and in
8756 some cases, it may be useful to disable the heuristics so that the effects
8757 of @code{__builtin_expect} are easier to understand.
8759 The default is @option{-fguess-branch-probability} at levels
8760 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8762 @item -freorder-blocks
8763 @opindex freorder-blocks
8764 Reorder basic blocks in the compiled function in order to reduce number of
8765 taken branches and improve code locality.
8767 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8769 @item -freorder-blocks-algorithm=@var{algorithm}
8770 @opindex freorder-blocks-algorithm
8771 Use the specified algorithm for basic block reordering.  The
8772 @var{algorithm} argument can be @samp{simple}, which does not increase
8773 code size (except sometimes due to secondary effects like alignment),
8774 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8775 put all often executed code together, minimizing the number of branches
8776 executed by making extra copies of code.
8778 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8779 @samp{stc} at levels @option{-O2}, @option{-O3}.
8781 @item -freorder-blocks-and-partition
8782 @opindex freorder-blocks-and-partition
8783 In addition to reordering basic blocks in the compiled function, in order
8784 to reduce number of taken branches, partitions hot and cold basic blocks
8785 into separate sections of the assembly and @file{.o} files, to improve
8786 paging and cache locality performance.
8788 This optimization is automatically turned off in the presence of
8789 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8790 section attribute and on any architecture that does not support named
8791 sections.  When @option{-fsplit-stack} is used this option is not
8792 enabled by default (to avoid linker errors), but may be enabled
8793 explicitly (if using a working linker).
8795 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8797 @item -freorder-functions
8798 @opindex freorder-functions
8799 Reorder functions in the object file in order to
8800 improve code locality.  This is implemented by using special
8801 subsections @code{.text.hot} for most frequently executed functions and
8802 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8803 the linker so object file format must support named sections and linker must
8804 place them in a reasonable way.
8806 Also profile feedback must be available to make this option effective.  See
8807 @option{-fprofile-arcs} for details.
8809 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8811 @item -fstrict-aliasing
8812 @opindex fstrict-aliasing
8813 Allow the compiler to assume the strictest aliasing rules applicable to
8814 the language being compiled.  For C (and C++), this activates
8815 optimizations based on the type of expressions.  In particular, an
8816 object of one type is assumed never to reside at the same address as an
8817 object of a different type, unless the types are almost the same.  For
8818 example, an @code{unsigned int} can alias an @code{int}, but not a
8819 @code{void*} or a @code{double}.  A character type may alias any other
8820 type.
8822 @anchor{Type-punning}Pay special attention to code like this:
8823 @smallexample
8824 union a_union @{
8825   int i;
8826   double d;
8829 int f() @{
8830   union a_union t;
8831   t.d = 3.0;
8832   return t.i;
8834 @end smallexample
8835 The practice of reading from a different union member than the one most
8836 recently written to (called ``type-punning'') is common.  Even with
8837 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8838 is accessed through the union type.  So, the code above works as
8839 expected.  @xref{Structures unions enumerations and bit-fields
8840 implementation}.  However, this code might not:
8841 @smallexample
8842 int f() @{
8843   union a_union t;
8844   int* ip;
8845   t.d = 3.0;
8846   ip = &t.i;
8847   return *ip;
8849 @end smallexample
8851 Similarly, access by taking the address, casting the resulting pointer
8852 and dereferencing the result has undefined behavior, even if the cast
8853 uses a union type, e.g.:
8854 @smallexample
8855 int f() @{
8856   double d = 3.0;
8857   return ((union a_union *) &d)->i;
8859 @end smallexample
8861 The @option{-fstrict-aliasing} option is enabled at levels
8862 @option{-O2}, @option{-O3}, @option{-Os}.
8864 @item -falign-functions
8865 @itemx -falign-functions=@var{n}
8866 @opindex falign-functions
8867 Align the start of functions to the next power-of-two greater than
8868 @var{n}, skipping up to @var{n} bytes.  For instance,
8869 @option{-falign-functions=32} aligns functions to the next 32-byte
8870 boundary, but @option{-falign-functions=24} aligns to the next
8871 32-byte boundary only if this can be done by skipping 23 bytes or less.
8873 @option{-fno-align-functions} and @option{-falign-functions=1} are
8874 equivalent and mean that functions are not aligned.
8876 Some assemblers only support this flag when @var{n} is a power of two;
8877 in that case, it is rounded up.
8879 If @var{n} is not specified or is zero, use a machine-dependent default.
8881 Enabled at levels @option{-O2}, @option{-O3}.
8883 @item -flimit-function-alignment
8884 If this option is enabled, the compiler tries to avoid unnecessarily
8885 overaligning functions. It attempts to instruct the assembler to align
8886 by the amount specified by @option{-falign-functions}, but not to
8887 skip more bytes than the size of the function.
8889 @item -falign-labels
8890 @itemx -falign-labels=@var{n}
8891 @opindex falign-labels
8892 Align all branch targets to a power-of-two boundary, skipping up to
8893 @var{n} bytes like @option{-falign-functions}.  This option can easily
8894 make code slower, because it must insert dummy operations for when the
8895 branch target is reached in the usual flow of the code.
8897 @option{-fno-align-labels} and @option{-falign-labels=1} are
8898 equivalent and mean that labels are not aligned.
8900 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8901 are greater than this value, then their values are used instead.
8903 If @var{n} is not specified or is zero, use a machine-dependent default
8904 which is very likely to be @samp{1}, meaning no alignment.
8906 Enabled at levels @option{-O2}, @option{-O3}.
8908 @item -falign-loops
8909 @itemx -falign-loops=@var{n}
8910 @opindex falign-loops
8911 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8912 like @option{-falign-functions}.  If the loops are
8913 executed many times, this makes up for any execution of the dummy
8914 operations.
8916 @option{-fno-align-loops} and @option{-falign-loops=1} are
8917 equivalent and mean that loops are not aligned.
8919 If @var{n} is not specified or is zero, use a machine-dependent default.
8921 Enabled at levels @option{-O2}, @option{-O3}.
8923 @item -falign-jumps
8924 @itemx -falign-jumps=@var{n}
8925 @opindex falign-jumps
8926 Align branch targets to a power-of-two boundary, for branch targets
8927 where the targets can only be reached by jumping, skipping up to @var{n}
8928 bytes like @option{-falign-functions}.  In this case, no dummy operations
8929 need be executed.
8931 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8932 equivalent and mean that loops are not aligned.
8934 If @var{n} is not specified or is zero, use a machine-dependent default.
8936 Enabled at levels @option{-O2}, @option{-O3}.
8938 @item -funit-at-a-time
8939 @opindex funit-at-a-time
8940 This option is left for compatibility reasons. @option{-funit-at-a-time}
8941 has no effect, while @option{-fno-unit-at-a-time} implies
8942 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8944 Enabled by default.
8946 @item -fno-toplevel-reorder
8947 @opindex fno-toplevel-reorder
8948 Do not reorder top-level functions, variables, and @code{asm}
8949 statements.  Output them in the same order that they appear in the
8950 input file.  When this option is used, unreferenced static variables
8951 are not removed.  This option is intended to support existing code
8952 that relies on a particular ordering.  For new code, it is better to
8953 use attributes when possible.
8955 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8956 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8957 targets.
8959 @item -fweb
8960 @opindex fweb
8961 Constructs webs as commonly used for register allocation purposes and assign
8962 each web individual pseudo register.  This allows the register allocation pass
8963 to operate on pseudos directly, but also strengthens several other optimization
8964 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8965 however, make debugging impossible, since variables no longer stay in a
8966 ``home register''.
8968 Enabled by default with @option{-funroll-loops}.
8970 @item -fwhole-program
8971 @opindex fwhole-program
8972 Assume that the current compilation unit represents the whole program being
8973 compiled.  All public functions and variables with the exception of @code{main}
8974 and those merged by attribute @code{externally_visible} become static functions
8975 and in effect are optimized more aggressively by interprocedural optimizers.
8977 This option should not be used in combination with @option{-flto}.
8978 Instead relying on a linker plugin should provide safer and more precise
8979 information.
8981 @item -flto[=@var{n}]
8982 @opindex flto
8983 This option runs the standard link-time optimizer.  When invoked
8984 with source code, it generates GIMPLE (one of GCC's internal
8985 representations) and writes it to special ELF sections in the object
8986 file.  When the object files are linked together, all the function
8987 bodies are read from these ELF sections and instantiated as if they
8988 had been part of the same translation unit.
8990 To use the link-time optimizer, @option{-flto} and optimization
8991 options should be specified at compile time and during the final link.
8992 It is recommended that you compile all the files participating in the
8993 same link with the same options and also specify those options at
8994 link time.  
8995 For example:
8997 @smallexample
8998 gcc -c -O2 -flto foo.c
8999 gcc -c -O2 -flto bar.c
9000 gcc -o myprog -flto -O2 foo.o bar.o
9001 @end smallexample
9003 The first two invocations to GCC save a bytecode representation
9004 of GIMPLE into special ELF sections inside @file{foo.o} and
9005 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9006 @file{foo.o} and @file{bar.o}, merges the two files into a single
9007 internal image, and compiles the result as usual.  Since both
9008 @file{foo.o} and @file{bar.o} are merged into a single image, this
9009 causes all the interprocedural analyses and optimizations in GCC to
9010 work across the two files as if they were a single one.  This means,
9011 for example, that the inliner is able to inline functions in
9012 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9014 Another (simpler) way to enable link-time optimization is:
9016 @smallexample
9017 gcc -o myprog -flto -O2 foo.c bar.c
9018 @end smallexample
9020 The above generates bytecode for @file{foo.c} and @file{bar.c},
9021 merges them together into a single GIMPLE representation and optimizes
9022 them as usual to produce @file{myprog}.
9024 The only important thing to keep in mind is that to enable link-time
9025 optimizations you need to use the GCC driver to perform the link step.
9026 GCC then automatically performs link-time optimization if any of the
9027 objects involved were compiled with the @option{-flto} command-line option.  
9028 You generally
9029 should specify the optimization options to be used for link-time
9030 optimization though GCC tries to be clever at guessing an
9031 optimization level to use from the options used at compile time
9032 if you fail to specify one at link time.  You can always override
9033 the automatic decision to do link-time optimization
9034 by passing @option{-fno-lto} to the link command.
9036 To make whole program optimization effective, it is necessary to make
9037 certain whole program assumptions.  The compiler needs to know
9038 what functions and variables can be accessed by libraries and runtime
9039 outside of the link-time optimized unit.  When supported by the linker,
9040 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9041 to the compiler about used and externally visible symbols.  When
9042 the linker plugin is not available, @option{-fwhole-program} should be
9043 used to allow the compiler to make these assumptions, which leads
9044 to more aggressive optimization decisions.
9046 When @option{-fuse-linker-plugin} is not enabled, when a file is
9047 compiled with @option{-flto}, the generated object file is larger than
9048 a regular object file because it contains GIMPLE bytecodes and the usual
9049 final code (see @option{-ffat-lto-objects}.  This means that
9050 object files with LTO information can be linked as normal object
9051 files; if @option{-fno-lto} is passed to the linker, no
9052 interprocedural optimizations are applied.  Note that when
9053 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9054 but you cannot perform a regular, non-LTO link on them.
9056 Additionally, the optimization flags used to compile individual files
9057 are not necessarily related to those used at link time.  For instance,
9059 @smallexample
9060 gcc -c -O0 -ffat-lto-objects -flto foo.c
9061 gcc -c -O0 -ffat-lto-objects -flto bar.c
9062 gcc -o myprog -O3 foo.o bar.o
9063 @end smallexample
9065 This produces individual object files with unoptimized assembler
9066 code, but the resulting binary @file{myprog} is optimized at
9067 @option{-O3}.  If, instead, the final binary is generated with
9068 @option{-fno-lto}, then @file{myprog} is not optimized.
9070 When producing the final binary, GCC only
9071 applies link-time optimizations to those files that contain bytecode.
9072 Therefore, you can mix and match object files and libraries with
9073 GIMPLE bytecodes and final object code.  GCC automatically selects
9074 which files to optimize in LTO mode and which files to link without
9075 further processing.
9077 There are some code generation flags preserved by GCC when
9078 generating bytecodes, as they need to be used during the final link
9079 stage.  Generally options specified at link time override those
9080 specified at compile time.
9082 If you do not specify an optimization level option @option{-O} at
9083 link time, then GCC uses the highest optimization level 
9084 used when compiling the object files.
9086 Currently, the following options and their settings are taken from
9087 the first object file that explicitly specifies them: 
9088 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9089 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9090 and all the @option{-m} target flags.
9092 Certain ABI-changing flags are required to match in all compilation units,
9093 and trying to override this at link time with a conflicting value
9094 is ignored.  This includes options such as @option{-freg-struct-return}
9095 and @option{-fpcc-struct-return}. 
9097 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9098 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9099 are passed through to the link stage and merged conservatively for
9100 conflicting translation units.  Specifically
9101 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9102 precedence; and for example @option{-ffp-contract=off} takes precedence
9103 over @option{-ffp-contract=fast}.  You can override them at link time.
9105 If LTO encounters objects with C linkage declared with incompatible
9106 types in separate translation units to be linked together (undefined
9107 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9108 issued.  The behavior is still undefined at run time.  Similar
9109 diagnostics may be raised for other languages.
9111 Another feature of LTO is that it is possible to apply interprocedural
9112 optimizations on files written in different languages:
9114 @smallexample
9115 gcc -c -flto foo.c
9116 g++ -c -flto bar.cc
9117 gfortran -c -flto baz.f90
9118 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9119 @end smallexample
9121 Notice that the final link is done with @command{g++} to get the C++
9122 runtime libraries and @option{-lgfortran} is added to get the Fortran
9123 runtime libraries.  In general, when mixing languages in LTO mode, you
9124 should use the same link command options as when mixing languages in a
9125 regular (non-LTO) compilation.
9127 If object files containing GIMPLE bytecode are stored in a library archive, say
9128 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9129 are using a linker with plugin support.  To create static libraries suitable
9130 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9131 and @command{ranlib}; 
9132 to show the symbols of object files with GIMPLE bytecode, use
9133 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9134 and @command{nm} have been compiled with plugin support.  At link time, use the the
9135 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9136 the LTO optimization process:
9138 @smallexample
9139 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9140 @end smallexample
9142 With the linker plugin enabled, the linker extracts the needed
9143 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9144 to make them part of the aggregated GIMPLE image to be optimized.
9146 If you are not using a linker with plugin support and/or do not
9147 enable the linker plugin, then the objects inside @file{libfoo.a}
9148 are extracted and linked as usual, but they do not participate
9149 in the LTO optimization process.  In order to make a static library suitable
9150 for both LTO optimization and usual linkage, compile its object files with
9151 @option{-flto} @option{-ffat-lto-objects}.
9153 Link-time optimizations do not require the presence of the whole program to
9154 operate.  If the program does not require any symbols to be exported, it is
9155 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9156 the interprocedural optimizers to use more aggressive assumptions which may
9157 lead to improved optimization opportunities.
9158 Use of @option{-fwhole-program} is not needed when linker plugin is
9159 active (see @option{-fuse-linker-plugin}).
9161 The current implementation of LTO makes no
9162 attempt to generate bytecode that is portable between different
9163 types of hosts.  The bytecode files are versioned and there is a
9164 strict version check, so bytecode files generated in one version of
9165 GCC do not work with an older or newer version of GCC.
9167 Link-time optimization does not work well with generation of debugging
9168 information.  Combining @option{-flto} with
9169 @option{-g} is currently experimental and expected to produce unexpected
9170 results.
9172 If you specify the optional @var{n}, the optimization and code
9173 generation done at link time is executed in parallel using @var{n}
9174 parallel jobs by utilizing an installed @command{make} program.  The
9175 environment variable @env{MAKE} may be used to override the program
9176 used.  The default value for @var{n} is 1.
9178 You can also specify @option{-flto=jobserver} to use GNU make's
9179 job server mode to determine the number of parallel jobs. This
9180 is useful when the Makefile calling GCC is already executing in parallel.
9181 You must prepend a @samp{+} to the command recipe in the parent Makefile
9182 for this to work.  This option likely only works if @env{MAKE} is
9183 GNU make.
9185 @item -flto-partition=@var{alg}
9186 @opindex flto-partition
9187 Specify the partitioning algorithm used by the link-time optimizer.
9188 The value is either @samp{1to1} to specify a partitioning mirroring
9189 the original source files or @samp{balanced} to specify partitioning
9190 into equally sized chunks (whenever possible) or @samp{max} to create
9191 new partition for every symbol where possible.  Specifying @samp{none}
9192 as an algorithm disables partitioning and streaming completely. 
9193 The default value is @samp{balanced}. While @samp{1to1} can be used
9194 as an workaround for various code ordering issues, the @samp{max}
9195 partitioning is intended for internal testing only.
9196 The value @samp{one} specifies that exactly one partition should be
9197 used while the value @samp{none} bypasses partitioning and executes
9198 the link-time optimization step directly from the WPA phase.
9200 @item -flto-odr-type-merging
9201 @opindex flto-odr-type-merging
9202 Enable streaming of mangled types names of C++ types and their unification
9203 at link time.  This increases size of LTO object files, but enables
9204 diagnostics about One Definition Rule violations.
9206 @item -flto-compression-level=@var{n}
9207 @opindex flto-compression-level
9208 This option specifies the level of compression used for intermediate
9209 language written to LTO object files, and is only meaningful in
9210 conjunction with LTO mode (@option{-flto}).  Valid
9211 values are 0 (no compression) to 9 (maximum compression).  Values
9212 outside this range are clamped to either 0 or 9.  If the option is not
9213 given, a default balanced compression setting is used.
9215 @item -fuse-linker-plugin
9216 @opindex fuse-linker-plugin
9217 Enables the use of a linker plugin during link-time optimization.  This
9218 option relies on plugin support in the linker, which is available in gold
9219 or in GNU ld 2.21 or newer.
9221 This option enables the extraction of object files with GIMPLE bytecode out
9222 of library archives. This improves the quality of optimization by exposing
9223 more code to the link-time optimizer.  This information specifies what
9224 symbols can be accessed externally (by non-LTO object or during dynamic
9225 linking).  Resulting code quality improvements on binaries (and shared
9226 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9227 See @option{-flto} for a description of the effect of this flag and how to
9228 use it.
9230 This option is enabled by default when LTO support in GCC is enabled
9231 and GCC was configured for use with
9232 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9234 @item -ffat-lto-objects
9235 @opindex ffat-lto-objects
9236 Fat LTO objects are object files that contain both the intermediate language
9237 and the object code. This makes them usable for both LTO linking and normal
9238 linking. This option is effective only when compiling with @option{-flto}
9239 and is ignored at link time.
9241 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9242 requires the complete toolchain to be aware of LTO. It requires a linker with
9243 linker plugin support for basic functionality.  Additionally,
9244 @command{nm}, @command{ar} and @command{ranlib}
9245 need to support linker plugins to allow a full-featured build environment
9246 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9247 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9248 to these tools. With non fat LTO makefiles need to be modified to use them.
9250 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9251 support.
9253 @item -fcompare-elim
9254 @opindex fcompare-elim
9255 After register allocation and post-register allocation instruction splitting,
9256 identify arithmetic instructions that compute processor flags similar to a
9257 comparison operation based on that arithmetic.  If possible, eliminate the
9258 explicit comparison operation.
9260 This pass only applies to certain targets that cannot explicitly represent
9261 the comparison operation before register allocation is complete.
9263 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9265 @item -fcprop-registers
9266 @opindex fcprop-registers
9267 After register allocation and post-register allocation instruction splitting,
9268 perform a copy-propagation pass to try to reduce scheduling dependencies
9269 and occasionally eliminate the copy.
9271 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9273 @item -fprofile-correction
9274 @opindex fprofile-correction
9275 Profiles collected using an instrumented binary for multi-threaded programs may
9276 be inconsistent due to missed counter updates. When this option is specified,
9277 GCC uses heuristics to correct or smooth out such inconsistencies. By
9278 default, GCC emits an error message when an inconsistent profile is detected.
9280 @item -fprofile-use
9281 @itemx -fprofile-use=@var{path}
9282 @opindex fprofile-use
9283 Enable profile feedback-directed optimizations, 
9284 and the following optimizations
9285 which are generally profitable only with profile feedback available:
9286 @option{-fbranch-probabilities}, @option{-fvpt},
9287 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9288 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9290 Before you can use this option, you must first generate profiling information.
9291 @xref{Instrumentation Options}, for information about the
9292 @option{-fprofile-generate} option.
9294 By default, GCC emits an error message if the feedback profiles do not
9295 match the source code.  This error can be turned into a warning by using
9296 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9297 code.
9299 If @var{path} is specified, GCC looks at the @var{path} to find
9300 the profile feedback data files. See @option{-fprofile-dir}.
9302 @item -fauto-profile
9303 @itemx -fauto-profile=@var{path}
9304 @opindex fauto-profile
9305 Enable sampling-based feedback-directed optimizations, 
9306 and the following optimizations
9307 which are generally profitable only with profile feedback available:
9308 @option{-fbranch-probabilities}, @option{-fvpt},
9309 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9310 @option{-ftree-vectorize},
9311 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9312 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9313 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9315 @var{path} is the name of a file containing AutoFDO profile information.
9316 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9318 Producing an AutoFDO profile data file requires running your program
9319 with the @command{perf} utility on a supported GNU/Linux target system.
9320 For more information, see @uref{https://perf.wiki.kernel.org/}.
9322 E.g.
9323 @smallexample
9324 perf record -e br_inst_retired:near_taken -b -o perf.data \
9325     -- your_program
9326 @end smallexample
9328 Then use the @command{create_gcov} tool to convert the raw profile data
9329 to a format that can be used by GCC.@  You must also supply the 
9330 unstripped binary for your program to this tool.  
9331 See @uref{https://github.com/google/autofdo}.
9333 E.g.
9334 @smallexample
9335 create_gcov --binary=your_program.unstripped --profile=perf.data \
9336     --gcov=profile.afdo
9337 @end smallexample
9338 @end table
9340 The following options control compiler behavior regarding floating-point 
9341 arithmetic.  These options trade off between speed and
9342 correctness.  All must be specifically enabled.
9344 @table @gcctabopt
9345 @item -ffloat-store
9346 @opindex ffloat-store
9347 Do not store floating-point variables in registers, and inhibit other
9348 options that might change whether a floating-point value is taken from a
9349 register or memory.
9351 @cindex floating-point precision
9352 This option prevents undesirable excess precision on machines such as
9353 the 68000 where the floating registers (of the 68881) keep more
9354 precision than a @code{double} is supposed to have.  Similarly for the
9355 x86 architecture.  For most programs, the excess precision does only
9356 good, but a few programs rely on the precise definition of IEEE floating
9357 point.  Use @option{-ffloat-store} for such programs, after modifying
9358 them to store all pertinent intermediate computations into variables.
9360 @item -fexcess-precision=@var{style}
9361 @opindex fexcess-precision
9362 This option allows further control over excess precision on machines
9363 where floating-point operations occur in a format with more precision or
9364 range than the IEEE standard and interchange floating-point types.  By
9365 default, @option{-fexcess-precision=fast} is in effect; this means that
9366 operations may be carried out in a wider precision than the types specified
9367 in the source if that would result in faster code, and it is unpredictable
9368 when rounding to the types specified in the source code takes place.
9369 When compiling C, if @option{-fexcess-precision=standard} is specified then
9370 excess precision follows the rules specified in ISO C99; in particular,
9371 both casts and assignments cause values to be rounded to their
9372 semantic types (whereas @option{-ffloat-store} only affects
9373 assignments).  This option is enabled by default for C if a strict
9374 conformance option such as @option{-std=c99} is used.
9375 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9376 regardless of whether a strict conformance option is used.
9378 @opindex mfpmath
9379 @option{-fexcess-precision=standard} is not implemented for languages
9380 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9381 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9382 semantics apply without excess precision, and in the latter, rounding
9383 is unpredictable.
9385 @item -ffast-math
9386 @opindex ffast-math
9387 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9388 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9389 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9390 @option{-fexcess-precision=fast}.
9392 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9394 This option is not turned on by any @option{-O} option besides
9395 @option{-Ofast} since it can result in incorrect output for programs
9396 that depend on an exact implementation of IEEE or ISO rules/specifications
9397 for math functions. It may, however, yield faster code for programs
9398 that do not require the guarantees of these specifications.
9400 @item -fno-math-errno
9401 @opindex fno-math-errno
9402 Do not set @code{errno} after calling math functions that are executed
9403 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9404 IEEE exceptions for math error handling may want to use this flag
9405 for speed while maintaining IEEE arithmetic compatibility.
9407 This option is not turned on by any @option{-O} option since
9408 it can result in incorrect output for programs that depend on
9409 an exact implementation of IEEE or ISO rules/specifications for
9410 math functions. It may, however, yield faster code for programs
9411 that do not require the guarantees of these specifications.
9413 The default is @option{-fmath-errno}.
9415 On Darwin systems, the math library never sets @code{errno}.  There is
9416 therefore no reason for the compiler to consider the possibility that
9417 it might, and @option{-fno-math-errno} is the default.
9419 @item -funsafe-math-optimizations
9420 @opindex funsafe-math-optimizations
9422 Allow optimizations for floating-point arithmetic that (a) assume
9423 that arguments and results are valid and (b) may violate IEEE or
9424 ANSI standards.  When used at link time, it may include libraries
9425 or startup files that change the default FPU control word or other
9426 similar optimizations.
9428 This option is not turned on by any @option{-O} option since
9429 it can result in incorrect output for programs that depend on
9430 an exact implementation of IEEE or ISO rules/specifications for
9431 math functions. It may, however, yield faster code for programs
9432 that do not require the guarantees of these specifications.
9433 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9434 @option{-fassociative-math} and @option{-freciprocal-math}.
9436 The default is @option{-fno-unsafe-math-optimizations}.
9438 @item -fassociative-math
9439 @opindex fassociative-math
9441 Allow re-association of operands in series of floating-point operations.
9442 This violates the ISO C and C++ language standard by possibly changing
9443 computation result.  NOTE: re-ordering may change the sign of zero as
9444 well as ignore NaNs and inhibit or create underflow or overflow (and
9445 thus cannot be used on code that relies on rounding behavior like
9446 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9447 and thus may not be used when ordered comparisons are required.
9448 This option requires that both @option{-fno-signed-zeros} and
9449 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9450 much sense with @option{-frounding-math}. For Fortran the option
9451 is automatically enabled when both @option{-fno-signed-zeros} and
9452 @option{-fno-trapping-math} are in effect.
9454 The default is @option{-fno-associative-math}.
9456 @item -freciprocal-math
9457 @opindex freciprocal-math
9459 Allow the reciprocal of a value to be used instead of dividing by
9460 the value if this enables optimizations.  For example @code{x / y}
9461 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9462 is subject to common subexpression elimination.  Note that this loses
9463 precision and increases the number of flops operating on the value.
9465 The default is @option{-fno-reciprocal-math}.
9467 @item -ffinite-math-only
9468 @opindex ffinite-math-only
9469 Allow optimizations for floating-point arithmetic that assume
9470 that arguments and results are not NaNs or +-Infs.
9472 This option is not turned on by any @option{-O} option since
9473 it can result in incorrect output for programs that depend on
9474 an exact implementation of IEEE or ISO rules/specifications for
9475 math functions. It may, however, yield faster code for programs
9476 that do not require the guarantees of these specifications.
9478 The default is @option{-fno-finite-math-only}.
9480 @item -fno-signed-zeros
9481 @opindex fno-signed-zeros
9482 Allow optimizations for floating-point arithmetic that ignore the
9483 signedness of zero.  IEEE arithmetic specifies the behavior of
9484 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9485 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9486 This option implies that the sign of a zero result isn't significant.
9488 The default is @option{-fsigned-zeros}.
9490 @item -fno-trapping-math
9491 @opindex fno-trapping-math
9492 Compile code assuming that floating-point operations cannot generate
9493 user-visible traps.  These traps include division by zero, overflow,
9494 underflow, inexact result and invalid operation.  This option requires
9495 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9496 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9498 This option should never be turned on by any @option{-O} option since
9499 it can result in incorrect output for programs that depend on
9500 an exact implementation of IEEE or ISO rules/specifications for
9501 math functions.
9503 The default is @option{-ftrapping-math}.
9505 @item -frounding-math
9506 @opindex frounding-math
9507 Disable transformations and optimizations that assume default floating-point
9508 rounding behavior.  This is round-to-zero for all floating point
9509 to integer conversions, and round-to-nearest for all other arithmetic
9510 truncations.  This option should be specified for programs that change
9511 the FP rounding mode dynamically, or that may be executed with a
9512 non-default rounding mode.  This option disables constant folding of
9513 floating-point expressions at compile time (which may be affected by
9514 rounding mode) and arithmetic transformations that are unsafe in the
9515 presence of sign-dependent rounding modes.
9517 The default is @option{-fno-rounding-math}.
9519 This option is experimental and does not currently guarantee to
9520 disable all GCC optimizations that are affected by rounding mode.
9521 Future versions of GCC may provide finer control of this setting
9522 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9523 will be used to specify the default state for @code{FENV_ACCESS}.
9525 @item -fsignaling-nans
9526 @opindex fsignaling-nans
9527 Compile code assuming that IEEE signaling NaNs may generate user-visible
9528 traps during floating-point operations.  Setting this option disables
9529 optimizations that may change the number of exceptions visible with
9530 signaling NaNs.  This option implies @option{-ftrapping-math}.
9532 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9533 be defined.
9535 The default is @option{-fno-signaling-nans}.
9537 This option is experimental and does not currently guarantee to
9538 disable all GCC optimizations that affect signaling NaN behavior.
9540 @item -fno-fp-int-builtin-inexact
9541 @opindex fno-fp-int-builtin-inexact
9542 Do not allow the built-in functions @code{ceil}, @code{floor},
9543 @code{round} and @code{trunc}, and their @code{float} and @code{long
9544 double} variants, to generate code that raises the ``inexact''
9545 floating-point exception for noninteger arguments.  ISO C99 and C11
9546 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9547 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9548 functions to do so.
9550 The default is @option{-ffp-int-builtin-inexact}, allowing the
9551 exception to be raised.  This option does nothing unless
9552 @option{-ftrapping-math} is in effect.
9554 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9555 generate a call to a library function then the ``inexact'' exception
9556 may be raised if the library implementation does not follow TS 18661.
9558 @item -fsingle-precision-constant
9559 @opindex fsingle-precision-constant
9560 Treat floating-point constants as single precision instead of
9561 implicitly converting them to double-precision constants.
9563 @item -fcx-limited-range
9564 @opindex fcx-limited-range
9565 When enabled, this option states that a range reduction step is not
9566 needed when performing complex division.  Also, there is no checking
9567 whether the result of a complex multiplication or division is @code{NaN
9568 + I*NaN}, with an attempt to rescue the situation in that case.  The
9569 default is @option{-fno-cx-limited-range}, but is enabled by
9570 @option{-ffast-math}.
9572 This option controls the default setting of the ISO C99
9573 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9574 all languages.
9576 @item -fcx-fortran-rules
9577 @opindex fcx-fortran-rules
9578 Complex multiplication and division follow Fortran rules.  Range
9579 reduction is done as part of complex division, but there is no checking
9580 whether the result of a complex multiplication or division is @code{NaN
9581 + I*NaN}, with an attempt to rescue the situation in that case.
9583 The default is @option{-fno-cx-fortran-rules}.
9585 @end table
9587 The following options control optimizations that may improve
9588 performance, but are not enabled by any @option{-O} options.  This
9589 section includes experimental options that may produce broken code.
9591 @table @gcctabopt
9592 @item -fbranch-probabilities
9593 @opindex fbranch-probabilities
9594 After running a program compiled with @option{-fprofile-arcs}
9595 (@pxref{Instrumentation Options}),
9596 you can compile it a second time using
9597 @option{-fbranch-probabilities}, to improve optimizations based on
9598 the number of times each branch was taken.  When a program
9599 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9600 counts to a file called @file{@var{sourcename}.gcda} for each source
9601 file.  The information in this data file is very dependent on the
9602 structure of the generated code, so you must use the same source code
9603 and the same optimization options for both compilations.
9605 With @option{-fbranch-probabilities}, GCC puts a
9606 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9607 These can be used to improve optimization.  Currently, they are only
9608 used in one place: in @file{reorg.c}, instead of guessing which path a
9609 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9610 exactly determine which path is taken more often.
9612 @item -fprofile-values
9613 @opindex fprofile-values
9614 If combined with @option{-fprofile-arcs}, it adds code so that some
9615 data about values of expressions in the program is gathered.
9617 With @option{-fbranch-probabilities}, it reads back the data gathered
9618 from profiling values of expressions for usage in optimizations.
9620 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9622 @item -fprofile-reorder-functions
9623 @opindex fprofile-reorder-functions
9624 Function reordering based on profile instrumentation collects
9625 first time of execution of a function and orders these functions
9626 in ascending order.
9628 Enabled with @option{-fprofile-use}.
9630 @item -fvpt
9631 @opindex fvpt
9632 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9633 to add code to gather information about values of expressions.
9635 With @option{-fbranch-probabilities}, it reads back the data gathered
9636 and actually performs the optimizations based on them.
9637 Currently the optimizations include specialization of division operations
9638 using the knowledge about the value of the denominator.
9640 @item -frename-registers
9641 @opindex frename-registers
9642 Attempt to avoid false dependencies in scheduled code by making use
9643 of registers left over after register allocation.  This optimization
9644 most benefits processors with lots of registers.  Depending on the
9645 debug information format adopted by the target, however, it can
9646 make debugging impossible, since variables no longer stay in
9647 a ``home register''.
9649 Enabled by default with @option{-funroll-loops}.
9651 @item -fschedule-fusion
9652 @opindex fschedule-fusion
9653 Performs a target dependent pass over the instruction stream to schedule
9654 instructions of same type together because target machine can execute them
9655 more efficiently if they are adjacent to each other in the instruction flow.
9657 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9659 @item -ftracer
9660 @opindex ftracer
9661 Perform tail duplication to enlarge superblock size.  This transformation
9662 simplifies the control flow of the function allowing other optimizations to do
9663 a better job.
9665 Enabled with @option{-fprofile-use}.
9667 @item -funroll-loops
9668 @opindex funroll-loops
9669 Unroll loops whose number of iterations can be determined at compile time or
9670 upon entry to the loop.  @option{-funroll-loops} implies
9671 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9672 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9673 a small constant number of iterations).  This option makes code larger, and may
9674 or may not make it run faster.
9676 Enabled with @option{-fprofile-use}.
9678 @item -funroll-all-loops
9679 @opindex funroll-all-loops
9680 Unroll all loops, even if their number of iterations is uncertain when
9681 the loop is entered.  This usually makes programs run more slowly.
9682 @option{-funroll-all-loops} implies the same options as
9683 @option{-funroll-loops}.
9685 @item -fpeel-loops
9686 @opindex fpeel-loops
9687 Peels loops for which there is enough information that they do not
9688 roll much (from profile feedback or static analysis).  It also turns on
9689 complete loop peeling (i.e.@: complete removal of loops with small constant
9690 number of iterations).
9692 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9694 @item -fmove-loop-invariants
9695 @opindex fmove-loop-invariants
9696 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9697 at level @option{-O1}
9699 @item -fsplit-loops
9700 @opindex fsplit-loops
9701 Split a loop into two if it contains a condition that's always true
9702 for one side of the iteration space and false for the other.
9704 @item -funswitch-loops
9705 @opindex funswitch-loops
9706 Move branches with loop invariant conditions out of the loop, with duplicates
9707 of the loop on both branches (modified according to result of the condition).
9709 @item -ffunction-sections
9710 @itemx -fdata-sections
9711 @opindex ffunction-sections
9712 @opindex fdata-sections
9713 Place each function or data item into its own section in the output
9714 file if the target supports arbitrary sections.  The name of the
9715 function or the name of the data item determines the section's name
9716 in the output file.
9718 Use these options on systems where the linker can perform optimizations to
9719 improve locality of reference in the instruction space.  Most systems using the
9720 ELF object format have linkers with such optimizations.  On AIX, the linker
9721 rearranges sections (CSECTs) based on the call graph.  The performance impact
9722 varies.
9724 Together with a linker garbage collection (linker @option{--gc-sections}
9725 option) these options may lead to smaller statically-linked executables (after
9726 stripping).
9728 On ELF/DWARF systems these options do not degenerate the quality of the debug
9729 information.  There could be issues with other object files/debug info formats.
9731 Only use these options when there are significant benefits from doing so.  When
9732 you specify these options, the assembler and linker create larger object and
9733 executable files and are also slower.  These options affect code generation.
9734 They prevent optimizations by the compiler and assembler using relative
9735 locations inside a translation unit since the locations are unknown until
9736 link time.  An example of such an optimization is relaxing calls to short call
9737 instructions.
9739 @item -fbranch-target-load-optimize
9740 @opindex fbranch-target-load-optimize
9741 Perform branch target register load optimization before prologue / epilogue
9742 threading.
9743 The use of target registers can typically be exposed only during reload,
9744 thus hoisting loads out of loops and doing inter-block scheduling needs
9745 a separate optimization pass.
9747 @item -fbranch-target-load-optimize2
9748 @opindex fbranch-target-load-optimize2
9749 Perform branch target register load optimization after prologue / epilogue
9750 threading.
9752 @item -fbtr-bb-exclusive
9753 @opindex fbtr-bb-exclusive
9754 When performing branch target register load optimization, don't reuse
9755 branch target registers within any basic block.
9757 @item -fstdarg-opt
9758 @opindex fstdarg-opt
9759 Optimize the prologue of variadic argument functions with respect to usage of
9760 those arguments.
9762 @item -fsection-anchors
9763 @opindex fsection-anchors
9764 Try to reduce the number of symbolic address calculations by using
9765 shared ``anchor'' symbols to address nearby objects.  This transformation
9766 can help to reduce the number of GOT entries and GOT accesses on some
9767 targets.
9769 For example, the implementation of the following function @code{foo}:
9771 @smallexample
9772 static int a, b, c;
9773 int foo (void) @{ return a + b + c; @}
9774 @end smallexample
9776 @noindent
9777 usually calculates the addresses of all three variables, but if you
9778 compile it with @option{-fsection-anchors}, it accesses the variables
9779 from a common anchor point instead.  The effect is similar to the
9780 following pseudocode (which isn't valid C):
9782 @smallexample
9783 int foo (void)
9785   register int *xr = &x;
9786   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9788 @end smallexample
9790 Not all targets support this option.
9792 @item --param @var{name}=@var{value}
9793 @opindex param
9794 In some places, GCC uses various constants to control the amount of
9795 optimization that is done.  For example, GCC does not inline functions
9796 that contain more than a certain number of instructions.  You can
9797 control some of these constants on the command line using the
9798 @option{--param} option.
9800 The names of specific parameters, and the meaning of the values, are
9801 tied to the internals of the compiler, and are subject to change
9802 without notice in future releases.
9804 In each case, the @var{value} is an integer.  The allowable choices for
9805 @var{name} are:
9807 @table @gcctabopt
9808 @item predictable-branch-outcome
9809 When branch is predicted to be taken with probability lower than this threshold
9810 (in percent), then it is considered well predictable. The default is 10.
9812 @item max-rtl-if-conversion-insns
9813 RTL if-conversion tries to remove conditional branches around a block and
9814 replace them with conditionally executed instructions.  This parameter
9815 gives the maximum number of instructions in a block which should be
9816 considered for if-conversion.  The default is 10, though the compiler will
9817 also use other heuristics to decide whether if-conversion is likely to be
9818 profitable.
9820 @item max-rtl-if-conversion-predictable-cost
9821 @item max-rtl-if-conversion-unpredictable-cost
9822 RTL if-conversion will try to remove conditional branches around a block
9823 and replace them with conditionally executed instructions.  These parameters
9824 give the maximum permissible cost for the sequence that would be generated
9825 by if-conversion depending on whether the branch is statically determined
9826 to be predictable or not.  The units for this parameter are the same as
9827 those for the GCC internal seq_cost metric.  The compiler will try to
9828 provide a reasonable default for this parameter using the BRANCH_COST
9829 target macro.
9831 @item max-crossjump-edges
9832 The maximum number of incoming edges to consider for cross-jumping.
9833 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9834 the number of edges incoming to each block.  Increasing values mean
9835 more aggressive optimization, making the compilation time increase with
9836 probably small improvement in executable size.
9838 @item min-crossjump-insns
9839 The minimum number of instructions that must be matched at the end
9840 of two blocks before cross-jumping is performed on them.  This
9841 value is ignored in the case where all instructions in the block being
9842 cross-jumped from are matched.  The default value is 5.
9844 @item max-grow-copy-bb-insns
9845 The maximum code size expansion factor when copying basic blocks
9846 instead of jumping.  The expansion is relative to a jump instruction.
9847 The default value is 8.
9849 @item max-goto-duplication-insns
9850 The maximum number of instructions to duplicate to a block that jumps
9851 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9852 passes, GCC factors computed gotos early in the compilation process,
9853 and unfactors them as late as possible.  Only computed jumps at the
9854 end of a basic blocks with no more than max-goto-duplication-insns are
9855 unfactored.  The default value is 8.
9857 @item max-delay-slot-insn-search
9858 The maximum number of instructions to consider when looking for an
9859 instruction to fill a delay slot.  If more than this arbitrary number of
9860 instructions are searched, the time savings from filling the delay slot
9861 are minimal, so stop searching.  Increasing values mean more
9862 aggressive optimization, making the compilation time increase with probably
9863 small improvement in execution time.
9865 @item max-delay-slot-live-search
9866 When trying to fill delay slots, the maximum number of instructions to
9867 consider when searching for a block with valid live register
9868 information.  Increasing this arbitrarily chosen value means more
9869 aggressive optimization, increasing the compilation time.  This parameter
9870 should be removed when the delay slot code is rewritten to maintain the
9871 control-flow graph.
9873 @item max-gcse-memory
9874 The approximate maximum amount of memory that can be allocated in
9875 order to perform the global common subexpression elimination
9876 optimization.  If more memory than specified is required, the
9877 optimization is not done.
9879 @item max-gcse-insertion-ratio
9880 If the ratio of expression insertions to deletions is larger than this value
9881 for any expression, then RTL PRE inserts or removes the expression and thus
9882 leaves partially redundant computations in the instruction stream.  The default value is 20.
9884 @item max-pending-list-length
9885 The maximum number of pending dependencies scheduling allows
9886 before flushing the current state and starting over.  Large functions
9887 with few branches or calls can create excessively large lists which
9888 needlessly consume memory and resources.
9890 @item max-modulo-backtrack-attempts
9891 The maximum number of backtrack attempts the scheduler should make
9892 when modulo scheduling a loop.  Larger values can exponentially increase
9893 compilation time.
9895 @item max-inline-insns-single
9896 Several parameters control the tree inliner used in GCC@.
9897 This number sets the maximum number of instructions (counted in GCC's
9898 internal representation) in a single function that the tree inliner
9899 considers for inlining.  This only affects functions declared
9900 inline and methods implemented in a class declaration (C++).
9901 The default value is 400.
9903 @item max-inline-insns-auto
9904 When you use @option{-finline-functions} (included in @option{-O3}),
9905 a lot of functions that would otherwise not be considered for inlining
9906 by the compiler are investigated.  To those functions, a different
9907 (more restrictive) limit compared to functions declared inline can
9908 be applied.
9909 The default value is 40.
9911 @item inline-min-speedup
9912 When estimated performance improvement of caller + callee runtime exceeds this
9913 threshold (in percent), the function can be inlined regardless of the limit on
9914 @option{--param max-inline-insns-single} and @option{--param
9915 max-inline-insns-auto}.
9917 @item large-function-insns
9918 The limit specifying really large functions.  For functions larger than this
9919 limit after inlining, inlining is constrained by
9920 @option{--param large-function-growth}.  This parameter is useful primarily
9921 to avoid extreme compilation time caused by non-linear algorithms used by the
9922 back end.
9923 The default value is 2700.
9925 @item large-function-growth
9926 Specifies maximal growth of large function caused by inlining in percents.
9927 The default value is 100 which limits large function growth to 2.0 times
9928 the original size.
9930 @item large-unit-insns
9931 The limit specifying large translation unit.  Growth caused by inlining of
9932 units larger than this limit is limited by @option{--param inline-unit-growth}.
9933 For small units this might be too tight.
9934 For example, consider a unit consisting of function A
9935 that is inline and B that just calls A three times.  If B is small relative to
9936 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9937 large units consisting of small inlineable functions, however, the overall unit
9938 growth limit is needed to avoid exponential explosion of code size.  Thus for
9939 smaller units, the size is increased to @option{--param large-unit-insns}
9940 before applying @option{--param inline-unit-growth}.  The default is 10000.
9942 @item inline-unit-growth
9943 Specifies maximal overall growth of the compilation unit caused by inlining.
9944 The default value is 20 which limits unit growth to 1.2 times the original
9945 size. Cold functions (either marked cold via an attribute or by profile
9946 feedback) are not accounted into the unit size.
9948 @item ipcp-unit-growth
9949 Specifies maximal overall growth of the compilation unit caused by
9950 interprocedural constant propagation.  The default value is 10 which limits
9951 unit growth to 1.1 times the original size.
9953 @item large-stack-frame
9954 The limit specifying large stack frames.  While inlining the algorithm is trying
9955 to not grow past this limit too much.  The default value is 256 bytes.
9957 @item large-stack-frame-growth
9958 Specifies maximal growth of large stack frames caused by inlining in percents.
9959 The default value is 1000 which limits large stack frame growth to 11 times
9960 the original size.
9962 @item max-inline-insns-recursive
9963 @itemx max-inline-insns-recursive-auto
9964 Specifies the maximum number of instructions an out-of-line copy of a
9965 self-recursive inline
9966 function can grow into by performing recursive inlining.
9968 @option{--param max-inline-insns-recursive} applies to functions
9969 declared inline.
9970 For functions not declared inline, recursive inlining
9971 happens only when @option{-finline-functions} (included in @option{-O3}) is
9972 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9973 default value is 450.
9975 @item max-inline-recursive-depth
9976 @itemx max-inline-recursive-depth-auto
9977 Specifies the maximum recursion depth used for recursive inlining.
9979 @option{--param max-inline-recursive-depth} applies to functions
9980 declared inline.  For functions not declared inline, recursive inlining
9981 happens only when @option{-finline-functions} (included in @option{-O3}) is
9982 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9983 default value is 8.
9985 @item min-inline-recursive-probability
9986 Recursive inlining is profitable only for function having deep recursion
9987 in average and can hurt for function having little recursion depth by
9988 increasing the prologue size or complexity of function body to other
9989 optimizers.
9991 When profile feedback is available (see @option{-fprofile-generate}) the actual
9992 recursion depth can be guessed from the probability that function recurses
9993 via a given call expression.  This parameter limits inlining only to call
9994 expressions whose probability exceeds the given threshold (in percents).
9995 The default value is 10.
9997 @item early-inlining-insns
9998 Specify growth that the early inliner can make.  In effect it increases
9999 the amount of inlining for code having a large abstraction penalty.
10000 The default value is 14.
10002 @item max-early-inliner-iterations
10003 Limit of iterations of the early inliner.  This basically bounds
10004 the number of nested indirect calls the early inliner can resolve.
10005 Deeper chains are still handled by late inlining.
10007 @item comdat-sharing-probability
10008 Probability (in percent) that C++ inline function with comdat visibility
10009 are shared across multiple compilation units.  The default value is 20.
10011 @item profile-func-internal-id
10012 A parameter to control whether to use function internal id in profile
10013 database lookup. If the value is 0, the compiler uses an id that
10014 is based on function assembler name and filename, which makes old profile
10015 data more tolerant to source changes such as function reordering etc.
10016 The default value is 0.
10018 @item min-vect-loop-bound
10019 The minimum number of iterations under which loops are not vectorized
10020 when @option{-ftree-vectorize} is used.  The number of iterations after
10021 vectorization needs to be greater than the value specified by this option
10022 to allow vectorization.  The default value is 0.
10024 @item gcse-cost-distance-ratio
10025 Scaling factor in calculation of maximum distance an expression
10026 can be moved by GCSE optimizations.  This is currently supported only in the
10027 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10028 is with simple expressions, i.e., the expressions that have cost
10029 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10030 hoisting of simple expressions.  The default value is 10.
10032 @item gcse-unrestricted-cost
10033 Cost, roughly measured as the cost of a single typical machine
10034 instruction, at which GCSE optimizations do not constrain
10035 the distance an expression can travel.  This is currently
10036 supported only in the code hoisting pass.  The lesser the cost,
10037 the more aggressive code hoisting is.  Specifying 0 
10038 allows all expressions to travel unrestricted distances.
10039 The default value is 3.
10041 @item max-hoist-depth
10042 The depth of search in the dominator tree for expressions to hoist.
10043 This is used to avoid quadratic behavior in hoisting algorithm.
10044 The value of 0 does not limit on the search, but may slow down compilation
10045 of huge functions.  The default value is 30.
10047 @item max-tail-merge-comparisons
10048 The maximum amount of similar bbs to compare a bb with.  This is used to
10049 avoid quadratic behavior in tree tail merging.  The default value is 10.
10051 @item max-tail-merge-iterations
10052 The maximum amount of iterations of the pass over the function.  This is used to
10053 limit compilation time in tree tail merging.  The default value is 2.
10055 @item store-merging-allow-unaligned
10056 Allow the store merging pass to introduce unaligned stores if it is legal to
10057 do so.  The default value is 1.
10059 @item max-stores-to-merge
10060 The maximum number of stores to attempt to merge into wider stores in the store
10061 merging pass.  The minimum value is 2 and the default is 64.
10063 @item max-unrolled-insns
10064 The maximum number of instructions that a loop may have to be unrolled.
10065 If a loop is unrolled, this parameter also determines how many times
10066 the loop code is unrolled.
10068 @item max-average-unrolled-insns
10069 The maximum number of instructions biased by probabilities of their execution
10070 that a loop may have to be unrolled.  If a loop is unrolled,
10071 this parameter also determines how many times the loop code is unrolled.
10073 @item max-unroll-times
10074 The maximum number of unrollings of a single loop.
10076 @item max-peeled-insns
10077 The maximum number of instructions that a loop may have to be peeled.
10078 If a loop is peeled, this parameter also determines how many times
10079 the loop code is peeled.
10081 @item max-peel-times
10082 The maximum number of peelings of a single loop.
10084 @item max-peel-branches
10085 The maximum number of branches on the hot path through the peeled sequence.
10087 @item max-completely-peeled-insns
10088 The maximum number of insns of a completely peeled loop.
10090 @item max-completely-peel-times
10091 The maximum number of iterations of a loop to be suitable for complete peeling.
10093 @item max-completely-peel-loop-nest-depth
10094 The maximum depth of a loop nest suitable for complete peeling.
10096 @item max-unswitch-insns
10097 The maximum number of insns of an unswitched loop.
10099 @item max-unswitch-level
10100 The maximum number of branches unswitched in a single loop.
10102 @item max-loop-headers-insns
10103 The maximum number of insns in loop header duplicated by the copy loop headers
10104 pass.
10106 @item lim-expensive
10107 The minimum cost of an expensive expression in the loop invariant motion.
10109 @item iv-consider-all-candidates-bound
10110 Bound on number of candidates for induction variables, below which
10111 all candidates are considered for each use in induction variable
10112 optimizations.  If there are more candidates than this,
10113 only the most relevant ones are considered to avoid quadratic time complexity.
10115 @item iv-max-considered-uses
10116 The induction variable optimizations give up on loops that contain more
10117 induction variable uses.
10119 @item iv-always-prune-cand-set-bound
10120 If the number of candidates in the set is smaller than this value,
10121 always try to remove unnecessary ivs from the set
10122 when adding a new one.
10124 @item avg-loop-niter
10125 Average number of iterations of a loop.
10127 @item dse-max-object-size
10128 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10129 Larger values may result in larger compilation times.
10131 @item scev-max-expr-size
10132 Bound on size of expressions used in the scalar evolutions analyzer.
10133 Large expressions slow the analyzer.
10135 @item scev-max-expr-complexity
10136 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10137 Complex expressions slow the analyzer.
10139 @item max-tree-if-conversion-phi-args
10140 Maximum number of arguments in a PHI supported by TREE if conversion
10141 unless the loop is marked with simd pragma.
10143 @item vect-max-version-for-alignment-checks
10144 The maximum number of run-time checks that can be performed when
10145 doing loop versioning for alignment in the vectorizer.
10147 @item vect-max-version-for-alias-checks
10148 The maximum number of run-time checks that can be performed when
10149 doing loop versioning for alias in the vectorizer.
10151 @item vect-max-peeling-for-alignment
10152 The maximum number of loop peels to enhance access alignment
10153 for vectorizer. Value -1 means no limit.
10155 @item max-iterations-to-track
10156 The maximum number of iterations of a loop the brute-force algorithm
10157 for analysis of the number of iterations of the loop tries to evaluate.
10159 @item hot-bb-count-ws-permille
10160 A basic block profile count is considered hot if it contributes to 
10161 the given permillage (i.e. 0...1000) of the entire profiled execution.
10163 @item hot-bb-frequency-fraction
10164 Select fraction of the entry block frequency of executions of basic block in
10165 function given basic block needs to have to be considered hot.
10167 @item max-predicted-iterations
10168 The maximum number of loop iterations we predict statically.  This is useful
10169 in cases where a function contains a single loop with known bound and
10170 another loop with unknown bound.
10171 The known number of iterations is predicted correctly, while
10172 the unknown number of iterations average to roughly 10.  This means that the
10173 loop without bounds appears artificially cold relative to the other one.
10175 @item builtin-expect-probability
10176 Control the probability of the expression having the specified value. This
10177 parameter takes a percentage (i.e. 0 ... 100) as input.
10178 The default probability of 90 is obtained empirically.
10180 @item align-threshold
10182 Select fraction of the maximal frequency of executions of a basic block in
10183 a function to align the basic block.
10185 @item align-loop-iterations
10187 A loop expected to iterate at least the selected number of iterations is
10188 aligned.
10190 @item tracer-dynamic-coverage
10191 @itemx tracer-dynamic-coverage-feedback
10193 This value is used to limit superblock formation once the given percentage of
10194 executed instructions is covered.  This limits unnecessary code size
10195 expansion.
10197 The @option{tracer-dynamic-coverage-feedback} parameter
10198 is used only when profile
10199 feedback is available.  The real profiles (as opposed to statically estimated
10200 ones) are much less balanced allowing the threshold to be larger value.
10202 @item tracer-max-code-growth
10203 Stop tail duplication once code growth has reached given percentage.  This is
10204 a rather artificial limit, as most of the duplicates are eliminated later in
10205 cross jumping, so it may be set to much higher values than is the desired code
10206 growth.
10208 @item tracer-min-branch-ratio
10210 Stop reverse growth when the reverse probability of best edge is less than this
10211 threshold (in percent).
10213 @item tracer-min-branch-probability
10214 @itemx tracer-min-branch-probability-feedback
10216 Stop forward growth if the best edge has probability lower than this
10217 threshold.
10219 Similarly to @option{tracer-dynamic-coverage} two parameters are
10220 provided.  @option{tracer-min-branch-probability-feedback} is used for
10221 compilation with profile feedback and @option{tracer-min-branch-probability}
10222 compilation without.  The value for compilation with profile feedback
10223 needs to be more conservative (higher) in order to make tracer
10224 effective.
10226 @item stack-clash-protection-guard-size
10227 Specify the size of the operating system provided stack guard as
10228 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10229 Acceptable values are between 12 and 30.  Higher values may reduce the
10230 number of explicit probes, but a value larger than the operating system
10231 provided guard will leave code vulnerable to stack clash style attacks.
10233 @item stack-clash-protection-probe-interval
10234 Stack clash protection involves probing stack space as it is allocated.  This
10235 param controls the maximum distance between probes into the stack as 2 raised
10236 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10237 12.  Higher values may reduce the number of explicit probes, but a value
10238 larger than the operating system provided guard will leave code vulnerable to
10239 stack clash style attacks.
10241 @item max-cse-path-length
10243 The maximum number of basic blocks on path that CSE considers.
10244 The default is 10.
10246 @item max-cse-insns
10247 The maximum number of instructions CSE processes before flushing.
10248 The default is 1000.
10250 @item ggc-min-expand
10252 GCC uses a garbage collector to manage its own memory allocation.  This
10253 parameter specifies the minimum percentage by which the garbage
10254 collector's heap should be allowed to expand between collections.
10255 Tuning this may improve compilation speed; it has no effect on code
10256 generation.
10258 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10259 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10260 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10261 GCC is not able to calculate RAM on a particular platform, the lower
10262 bound of 30% is used.  Setting this parameter and
10263 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10264 every opportunity.  This is extremely slow, but can be useful for
10265 debugging.
10267 @item ggc-min-heapsize
10269 Minimum size of the garbage collector's heap before it begins bothering
10270 to collect garbage.  The first collection occurs after the heap expands
10271 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10272 tuning this may improve compilation speed, and has no effect on code
10273 generation.
10275 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10276 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10277 with a lower bound of 4096 (four megabytes) and an upper bound of
10278 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10279 particular platform, the lower bound is used.  Setting this parameter
10280 very large effectively disables garbage collection.  Setting this
10281 parameter and @option{ggc-min-expand} to zero causes a full collection
10282 to occur at every opportunity.
10284 @item max-reload-search-insns
10285 The maximum number of instruction reload should look backward for equivalent
10286 register.  Increasing values mean more aggressive optimization, making the
10287 compilation time increase with probably slightly better performance.
10288 The default value is 100.
10290 @item max-cselib-memory-locations
10291 The maximum number of memory locations cselib should take into account.
10292 Increasing values mean more aggressive optimization, making the compilation time
10293 increase with probably slightly better performance.  The default value is 500.
10295 @item max-sched-ready-insns
10296 The maximum number of instructions ready to be issued the scheduler should
10297 consider at any given time during the first scheduling pass.  Increasing
10298 values mean more thorough searches, making the compilation time increase
10299 with probably little benefit.  The default value is 100.
10301 @item max-sched-region-blocks
10302 The maximum number of blocks in a region to be considered for
10303 interblock scheduling.  The default value is 10.
10305 @item max-pipeline-region-blocks
10306 The maximum number of blocks in a region to be considered for
10307 pipelining in the selective scheduler.  The default value is 15.
10309 @item max-sched-region-insns
10310 The maximum number of insns in a region to be considered for
10311 interblock scheduling.  The default value is 100.
10313 @item max-pipeline-region-insns
10314 The maximum number of insns in a region to be considered for
10315 pipelining in the selective scheduler.  The default value is 200.
10317 @item min-spec-prob
10318 The minimum probability (in percents) of reaching a source block
10319 for interblock speculative scheduling.  The default value is 40.
10321 @item max-sched-extend-regions-iters
10322 The maximum number of iterations through CFG to extend regions.
10323 A value of 0 (the default) disables region extensions.
10325 @item max-sched-insn-conflict-delay
10326 The maximum conflict delay for an insn to be considered for speculative motion.
10327 The default value is 3.
10329 @item sched-spec-prob-cutoff
10330 The minimal probability of speculation success (in percents), so that
10331 speculative insns are scheduled.
10332 The default value is 40.
10334 @item sched-state-edge-prob-cutoff
10335 The minimum probability an edge must have for the scheduler to save its
10336 state across it.
10337 The default value is 10.
10339 @item sched-mem-true-dep-cost
10340 Minimal distance (in CPU cycles) between store and load targeting same
10341 memory locations.  The default value is 1.
10343 @item selsched-max-lookahead
10344 The maximum size of the lookahead window of selective scheduling.  It is a
10345 depth of search for available instructions.
10346 The default value is 50.
10348 @item selsched-max-sched-times
10349 The maximum number of times that an instruction is scheduled during
10350 selective scheduling.  This is the limit on the number of iterations
10351 through which the instruction may be pipelined.  The default value is 2.
10353 @item selsched-insns-to-rename
10354 The maximum number of best instructions in the ready list that are considered
10355 for renaming in the selective scheduler.  The default value is 2.
10357 @item sms-min-sc
10358 The minimum value of stage count that swing modulo scheduler
10359 generates.  The default value is 2.
10361 @item max-last-value-rtl
10362 The maximum size measured as number of RTLs that can be recorded in an expression
10363 in combiner for a pseudo register as last known value of that register.  The default
10364 is 10000.
10366 @item max-combine-insns
10367 The maximum number of instructions the RTL combiner tries to combine.
10368 The default value is 2 at @option{-Og} and 4 otherwise.
10370 @item integer-share-limit
10371 Small integer constants can use a shared data structure, reducing the
10372 compiler's memory usage and increasing its speed.  This sets the maximum
10373 value of a shared integer constant.  The default value is 256.
10375 @item ssp-buffer-size
10376 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10377 protection when @option{-fstack-protection} is used.
10379 @item min-size-for-stack-sharing
10380 The minimum size of variables taking part in stack slot sharing when not
10381 optimizing. The default value is 32.
10383 @item max-jump-thread-duplication-stmts
10384 Maximum number of statements allowed in a block that needs to be
10385 duplicated when threading jumps.
10387 @item max-fields-for-field-sensitive
10388 Maximum number of fields in a structure treated in
10389 a field sensitive manner during pointer analysis.  The default is zero
10390 for @option{-O0} and @option{-O1},
10391 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10393 @item prefetch-latency
10394 Estimate on average number of instructions that are executed before
10395 prefetch finishes.  The distance prefetched ahead is proportional
10396 to this constant.  Increasing this number may also lead to less
10397 streams being prefetched (see @option{simultaneous-prefetches}).
10399 @item simultaneous-prefetches
10400 Maximum number of prefetches that can run at the same time.
10402 @item l1-cache-line-size
10403 The size of cache line in L1 cache, in bytes.
10405 @item l1-cache-size
10406 The size of L1 cache, in kilobytes.
10408 @item l2-cache-size
10409 The size of L2 cache, in kilobytes.
10411 @item min-insn-to-prefetch-ratio
10412 The minimum ratio between the number of instructions and the
10413 number of prefetches to enable prefetching in a loop.
10415 @item prefetch-min-insn-to-mem-ratio
10416 The minimum ratio between the number of instructions and the
10417 number of memory references to enable prefetching in a loop.
10419 @item use-canonical-types
10420 Whether the compiler should use the ``canonical'' type system.  By
10421 default, this should always be 1, which uses a more efficient internal
10422 mechanism for comparing types in C++ and Objective-C++.  However, if
10423 bugs in the canonical type system are causing compilation failures,
10424 set this value to 0 to disable canonical types.
10426 @item switch-conversion-max-branch-ratio
10427 Switch initialization conversion refuses to create arrays that are
10428 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10429 branches in the switch.
10431 @item max-partial-antic-length
10432 Maximum length of the partial antic set computed during the tree
10433 partial redundancy elimination optimization (@option{-ftree-pre}) when
10434 optimizing at @option{-O3} and above.  For some sorts of source code
10435 the enhanced partial redundancy elimination optimization can run away,
10436 consuming all of the memory available on the host machine.  This
10437 parameter sets a limit on the length of the sets that are computed,
10438 which prevents the runaway behavior.  Setting a value of 0 for
10439 this parameter allows an unlimited set length.
10441 @item sccvn-max-scc-size
10442 Maximum size of a strongly connected component (SCC) during SCCVN
10443 processing.  If this limit is hit, SCCVN processing for the whole
10444 function is not done and optimizations depending on it are
10445 disabled.  The default maximum SCC size is 10000.
10447 @item sccvn-max-alias-queries-per-access
10448 Maximum number of alias-oracle queries we perform when looking for
10449 redundancies for loads and stores.  If this limit is hit the search
10450 is aborted and the load or store is not considered redundant.  The
10451 number of queries is algorithmically limited to the number of
10452 stores on all paths from the load to the function entry.
10453 The default maximum number of queries is 1000.
10455 @item ira-max-loops-num
10456 IRA uses regional register allocation by default.  If a function
10457 contains more loops than the number given by this parameter, only at most
10458 the given number of the most frequently-executed loops form regions
10459 for regional register allocation.  The default value of the
10460 parameter is 100.
10462 @item ira-max-conflict-table-size 
10463 Although IRA uses a sophisticated algorithm to compress the conflict
10464 table, the table can still require excessive amounts of memory for
10465 huge functions.  If the conflict table for a function could be more
10466 than the size in MB given by this parameter, the register allocator
10467 instead uses a faster, simpler, and lower-quality
10468 algorithm that does not require building a pseudo-register conflict table.  
10469 The default value of the parameter is 2000.
10471 @item ira-loop-reserved-regs
10472 IRA can be used to evaluate more accurate register pressure in loops
10473 for decisions to move loop invariants (see @option{-O3}).  The number
10474 of available registers reserved for some other purposes is given
10475 by this parameter.  The default value of the parameter is 2, which is
10476 the minimal number of registers needed by typical instructions.
10477 This value is the best found from numerous experiments.
10479 @item lra-inheritance-ebb-probability-cutoff
10480 LRA tries to reuse values reloaded in registers in subsequent insns.
10481 This optimization is called inheritance.  EBB is used as a region to
10482 do this optimization.  The parameter defines a minimal fall-through
10483 edge probability in percentage used to add BB to inheritance EBB in
10484 LRA.  The default value of the parameter is 40.  The value was chosen
10485 from numerous runs of SPEC2000 on x86-64.
10487 @item loop-invariant-max-bbs-in-loop
10488 Loop invariant motion can be very expensive, both in compilation time and
10489 in amount of needed compile-time memory, with very large loops.  Loops
10490 with more basic blocks than this parameter won't have loop invariant
10491 motion optimization performed on them.  The default value of the
10492 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10494 @item loop-max-datarefs-for-datadeps
10495 Building data dependencies is expensive for very large loops.  This
10496 parameter limits the number of data references in loops that are
10497 considered for data dependence analysis.  These large loops are no
10498 handled by the optimizations using loop data dependencies.
10499 The default value is 1000.
10501 @item max-vartrack-size
10502 Sets a maximum number of hash table slots to use during variable
10503 tracking dataflow analysis of any function.  If this limit is exceeded
10504 with variable tracking at assignments enabled, analysis for that
10505 function is retried without it, after removing all debug insns from
10506 the function.  If the limit is exceeded even without debug insns, var
10507 tracking analysis is completely disabled for the function.  Setting
10508 the parameter to zero makes it unlimited.
10510 @item max-vartrack-expr-depth
10511 Sets a maximum number of recursion levels when attempting to map
10512 variable names or debug temporaries to value expressions.  This trades
10513 compilation time for more complete debug information.  If this is set too
10514 low, value expressions that are available and could be represented in
10515 debug information may end up not being used; setting this higher may
10516 enable the compiler to find more complex debug expressions, but compile
10517 time and memory use may grow.  The default is 12.
10519 @item min-nondebug-insn-uid
10520 Use uids starting at this parameter for nondebug insns.  The range below
10521 the parameter is reserved exclusively for debug insns created by
10522 @option{-fvar-tracking-assignments}, but debug insns may get
10523 (non-overlapping) uids above it if the reserved range is exhausted.
10525 @item ipa-sra-ptr-growth-factor
10526 IPA-SRA replaces a pointer to an aggregate with one or more new
10527 parameters only when their cumulative size is less or equal to
10528 @option{ipa-sra-ptr-growth-factor} times the size of the original
10529 pointer parameter.
10531 @item sra-max-scalarization-size-Ospeed
10532 @item sra-max-scalarization-size-Osize
10533 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10534 replace scalar parts of aggregates with uses of independent scalar
10535 variables.  These parameters control the maximum size, in storage units,
10536 of aggregate which is considered for replacement when compiling for
10537 speed
10538 (@option{sra-max-scalarization-size-Ospeed}) or size
10539 (@option{sra-max-scalarization-size-Osize}) respectively.
10541 @item tm-max-aggregate-size
10542 When making copies of thread-local variables in a transaction, this
10543 parameter specifies the size in bytes after which variables are
10544 saved with the logging functions as opposed to save/restore code
10545 sequence pairs.  This option only applies when using
10546 @option{-fgnu-tm}.
10548 @item graphite-max-nb-scop-params
10549 To avoid exponential effects in the Graphite loop transforms, the
10550 number of parameters in a Static Control Part (SCoP) is bounded.  The
10551 default value is 10 parameters, a value of zero can be used to lift
10552 the bound.  A variable whose value is unknown at compilation time and
10553 defined outside a SCoP is a parameter of the SCoP.
10555 @item loop-block-tile-size
10556 Loop blocking or strip mining transforms, enabled with
10557 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10558 loop in the loop nest by a given number of iterations.  The strip
10559 length can be changed using the @option{loop-block-tile-size}
10560 parameter.  The default value is 51 iterations.
10562 @item loop-unroll-jam-size
10563 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10564 default value is 4.
10566 @item loop-unroll-jam-depth
10567 Specify the dimension to be unrolled (counting from the most inner loop)
10568 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10570 @item ipa-cp-value-list-size
10571 IPA-CP attempts to track all possible values and types passed to a function's
10572 parameter in order to propagate them and perform devirtualization.
10573 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10574 stores per one formal parameter of a function.
10576 @item ipa-cp-eval-threshold
10577 IPA-CP calculates its own score of cloning profitability heuristics
10578 and performs those cloning opportunities with scores that exceed
10579 @option{ipa-cp-eval-threshold}.
10581 @item ipa-cp-recursion-penalty
10582 Percentage penalty the recursive functions will receive when they
10583 are evaluated for cloning.
10585 @item ipa-cp-single-call-penalty
10586 Percentage penalty functions containing a single call to another
10587 function will receive when they are evaluated for cloning.
10590 @item ipa-max-agg-items
10591 IPA-CP is also capable to propagate a number of scalar values passed
10592 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10593 number of such values per one parameter.
10595 @item ipa-cp-loop-hint-bonus
10596 When IPA-CP determines that a cloning candidate would make the number
10597 of iterations of a loop known, it adds a bonus of
10598 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10599 the candidate.
10601 @item ipa-cp-array-index-hint-bonus
10602 When IPA-CP determines that a cloning candidate would make the index of
10603 an array access known, it adds a bonus of
10604 @option{ipa-cp-array-index-hint-bonus} to the profitability
10605 score of the candidate.
10607 @item ipa-max-aa-steps
10608 During its analysis of function bodies, IPA-CP employs alias analysis
10609 in order to track values pointed to by function parameters.  In order
10610 not spend too much time analyzing huge functions, it gives up and
10611 consider all memory clobbered after examining
10612 @option{ipa-max-aa-steps} statements modifying memory.
10614 @item lto-partitions
10615 Specify desired number of partitions produced during WHOPR compilation.
10616 The number of partitions should exceed the number of CPUs used for compilation.
10617 The default value is 32.
10619 @item lto-min-partition
10620 Size of minimal partition for WHOPR (in estimated instructions).
10621 This prevents expenses of splitting very small programs into too many
10622 partitions.
10624 @item lto-max-partition
10625 Size of max partition for WHOPR (in estimated instructions).
10626 to provide an upper bound for individual size of partition.
10627 Meant to be used only with balanced partitioning.
10629 @item cxx-max-namespaces-for-diagnostic-help
10630 The maximum number of namespaces to consult for suggestions when C++
10631 name lookup fails for an identifier.  The default is 1000.
10633 @item sink-frequency-threshold
10634 The maximum relative execution frequency (in percents) of the target block
10635 relative to a statement's original block to allow statement sinking of a
10636 statement.  Larger numbers result in more aggressive statement sinking.
10637 The default value is 75.  A small positive adjustment is applied for
10638 statements with memory operands as those are even more profitable so sink.
10640 @item max-stores-to-sink
10641 The maximum number of conditional store pairs that can be sunk.  Set to 0
10642 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10643 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10645 @item allow-store-data-races
10646 Allow optimizers to introduce new data races on stores.
10647 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10648 at optimization level @option{-Ofast}.
10650 @item case-values-threshold
10651 The smallest number of different values for which it is best to use a
10652 jump-table instead of a tree of conditional branches.  If the value is
10653 0, use the default for the machine.  The default is 0.
10655 @item tree-reassoc-width
10656 Set the maximum number of instructions executed in parallel in
10657 reassociated tree. This parameter overrides target dependent
10658 heuristics used by default if has non zero value.
10660 @item sched-pressure-algorithm
10661 Choose between the two available implementations of
10662 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10663 and is the more likely to prevent instructions from being reordered.
10664 Algorithm 2 was designed to be a compromise between the relatively
10665 conservative approach taken by algorithm 1 and the rather aggressive
10666 approach taken by the default scheduler.  It relies more heavily on
10667 having a regular register file and accurate register pressure classes.
10668 See @file{haifa-sched.c} in the GCC sources for more details.
10670 The default choice depends on the target.
10672 @item max-slsr-cand-scan
10673 Set the maximum number of existing candidates that are considered when
10674 seeking a basis for a new straight-line strength reduction candidate.
10676 @item asan-globals
10677 Enable buffer overflow detection for global objects.  This kind
10678 of protection is enabled by default if you are using
10679 @option{-fsanitize=address} option.
10680 To disable global objects protection use @option{--param asan-globals=0}.
10682 @item asan-stack
10683 Enable buffer overflow detection for stack objects.  This kind of
10684 protection is enabled by default when using @option{-fsanitize=address}.
10685 To disable stack protection use @option{--param asan-stack=0} option.
10687 @item asan-instrument-reads
10688 Enable buffer overflow detection for memory reads.  This kind of
10689 protection is enabled by default when using @option{-fsanitize=address}.
10690 To disable memory reads protection use
10691 @option{--param asan-instrument-reads=0}.
10693 @item asan-instrument-writes
10694 Enable buffer overflow detection for memory writes.  This kind of
10695 protection is enabled by default when using @option{-fsanitize=address}.
10696 To disable memory writes protection use
10697 @option{--param asan-instrument-writes=0} option.
10699 @item asan-memintrin
10700 Enable detection for built-in functions.  This kind of protection
10701 is enabled by default when using @option{-fsanitize=address}.
10702 To disable built-in functions protection use
10703 @option{--param asan-memintrin=0}.
10705 @item asan-use-after-return
10706 Enable detection of use-after-return.  This kind of protection
10707 is enabled by default when using the @option{-fsanitize=address} option.
10708 To disable it use @option{--param asan-use-after-return=0}.
10710 Note: By default the check is disabled at run time.  To enable it,
10711 add @code{detect_stack_use_after_return=1} to the environment variable
10712 @env{ASAN_OPTIONS}.
10714 @item asan-instrumentation-with-call-threshold
10715 If number of memory accesses in function being instrumented
10716 is greater or equal to this number, use callbacks instead of inline checks.
10717 E.g. to disable inline code use
10718 @option{--param asan-instrumentation-with-call-threshold=0}.
10720 @item use-after-scope-direct-emission-threshold
10721 If the size of a local variable in bytes is smaller or equal to this
10722 number, directly poison (or unpoison) shadow memory instead of using
10723 run-time callbacks.  The default value is 256.
10725 @item chkp-max-ctor-size
10726 Static constructors generated by Pointer Bounds Checker may become very
10727 large and significantly increase compile time at optimization level
10728 @option{-O1} and higher.  This parameter is a maximum number of statements
10729 in a single generated constructor.  Default value is 5000.
10731 @item max-fsm-thread-path-insns
10732 Maximum number of instructions to copy when duplicating blocks on a
10733 finite state automaton jump thread path.  The default is 100.
10735 @item max-fsm-thread-length
10736 Maximum number of basic blocks on a finite state automaton jump thread
10737 path.  The default is 10.
10739 @item max-fsm-thread-paths
10740 Maximum number of new jump thread paths to create for a finite state
10741 automaton.  The default is 50.
10743 @item parloops-chunk-size
10744 Chunk size of omp schedule for loops parallelized by parloops.  The default
10745 is 0.
10747 @item parloops-schedule
10748 Schedule type of omp schedule for loops parallelized by parloops (static,
10749 dynamic, guided, auto, runtime).  The default is static.
10751 @item max-ssa-name-query-depth
10752 Maximum depth of recursion when querying properties of SSA names in things
10753 like fold routines.  One level of recursion corresponds to following a
10754 use-def chain.
10756 @item hsa-gen-debug-stores
10757 Enable emission of special debug stores within HSA kernels which are
10758 then read and reported by libgomp plugin.  Generation of these stores
10759 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10760 enable it.
10762 @item max-speculative-devirt-maydefs
10763 The maximum number of may-defs we analyze when looking for a must-def
10764 specifying the dynamic type of an object that invokes a virtual call
10765 we may be able to devirtualize speculatively.
10767 @item max-vrp-switch-assertions
10768 The maximum number of assertions to add along the default edge of a switch
10769 statement during VRP.  The default is 10.
10770 @end table
10771 @end table
10773 @node Instrumentation Options
10774 @section Program Instrumentation Options
10775 @cindex instrumentation options
10776 @cindex program instrumentation options
10777 @cindex run-time error checking options
10778 @cindex profiling options
10779 @cindex options, program instrumentation
10780 @cindex options, run-time error checking
10781 @cindex options, profiling
10783 GCC supports a number of command-line options that control adding
10784 run-time instrumentation to the code it normally generates.  
10785 For example, one purpose of instrumentation is collect profiling
10786 statistics for use in finding program hot spots, code coverage
10787 analysis, or profile-guided optimizations.
10788 Another class of program instrumentation is adding run-time checking 
10789 to detect programming errors like invalid pointer
10790 dereferences or out-of-bounds array accesses, as well as deliberately
10791 hostile attacks such as stack smashing or C++ vtable hijacking.
10792 There is also a general hook which can be used to implement other
10793 forms of tracing or function-level instrumentation for debug or
10794 program analysis purposes.
10796 @table @gcctabopt
10797 @cindex @command{prof}
10798 @item -p
10799 @opindex p
10800 Generate extra code to write profile information suitable for the
10801 analysis program @command{prof}.  You must use this option when compiling
10802 the source files you want data about, and you must also use it when
10803 linking.
10805 @cindex @command{gprof}
10806 @item -pg
10807 @opindex pg
10808 Generate extra code to write profile information suitable for the
10809 analysis program @command{gprof}.  You must use this option when compiling
10810 the source files you want data about, and you must also use it when
10811 linking.
10813 @item -fprofile-arcs
10814 @opindex fprofile-arcs
10815 Add code so that program flow @dfn{arcs} are instrumented.  During
10816 execution the program records how many times each branch and call is
10817 executed and how many times it is taken or returns.  On targets that support
10818 constructors with priority support, profiling properly handles constructors,
10819 destructors and C++ constructors (and destructors) of classes which are used
10820 as a type of a global variable.
10822 When the compiled
10823 program exits it saves this data to a file called
10824 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10825 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10826 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10827 @var{auxname} is generated from the name of the output file, if
10828 explicitly specified and it is not the final executable, otherwise it is
10829 the basename of the source file.  In both cases any suffix is removed
10830 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10831 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10832 @xref{Cross-profiling}.
10834 @cindex @command{gcov}
10835 @item --coverage
10836 @opindex coverage
10838 This option is used to compile and link code instrumented for coverage
10839 analysis.  The option is a synonym for @option{-fprofile-arcs}
10840 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10841 linking).  See the documentation for those options for more details.
10843 @itemize
10845 @item
10846 Compile the source files with @option{-fprofile-arcs} plus optimization
10847 and code generation options.  For test coverage analysis, use the
10848 additional @option{-ftest-coverage} option.  You do not need to profile
10849 every source file in a program.
10851 @item
10852 Compile the source files additionally with @option{-fprofile-abs-path}
10853 to create absolute path names in the @file{.gcno} files.  This allows
10854 @command{gcov} to find the correct sources in projects where compilations
10855 occur with different working directories.
10857 @item
10858 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10859 (the latter implies the former).
10861 @item
10862 Run the program on a representative workload to generate the arc profile
10863 information.  This may be repeated any number of times.  You can run
10864 concurrent instances of your program, and provided that the file system
10865 supports locking, the data files will be correctly updated.  Also
10866 @code{fork} calls are detected and correctly handled (double counting
10867 will not happen).
10869 @item
10870 For profile-directed optimizations, compile the source files again with
10871 the same optimization and code generation options plus
10872 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10873 Control Optimization}).
10875 @item
10876 For test coverage analysis, use @command{gcov} to produce human readable
10877 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10878 @command{gcov} documentation for further information.
10880 @end itemize
10882 With @option{-fprofile-arcs}, for each function of your program GCC
10883 creates a program flow graph, then finds a spanning tree for the graph.
10884 Only arcs that are not on the spanning tree have to be instrumented: the
10885 compiler adds code to count the number of times that these arcs are
10886 executed.  When an arc is the only exit or only entrance to a block, the
10887 instrumentation code can be added to the block; otherwise, a new basic
10888 block must be created to hold the instrumentation code.
10890 @need 2000
10891 @item -ftest-coverage
10892 @opindex ftest-coverage
10893 Produce a notes file that the @command{gcov} code-coverage utility
10894 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10895 show program coverage.  Each source file's note file is called
10896 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10897 above for a description of @var{auxname} and instructions on how to
10898 generate test coverage data.  Coverage data matches the source files
10899 more closely if you do not optimize.
10901 @item -fprofile-abs-path
10902 @opindex fprofile-abs-path
10903 Automatically convert relative source file names to absolute path names
10904 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10905 sources in projects where compilations occur with different working
10906 directories.
10908 @item -fprofile-dir=@var{path}
10909 @opindex fprofile-dir
10911 Set the directory to search for the profile data files in to @var{path}.
10912 This option affects only the profile data generated by
10913 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10914 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10915 and its related options.  Both absolute and relative paths can be used.
10916 By default, GCC uses the current directory as @var{path}, thus the
10917 profile data file appears in the same directory as the object file.
10919 @item -fprofile-generate
10920 @itemx -fprofile-generate=@var{path}
10921 @opindex fprofile-generate
10923 Enable options usually used for instrumenting application to produce
10924 profile useful for later recompilation with profile feedback based
10925 optimization.  You must use @option{-fprofile-generate} both when
10926 compiling and when linking your program.
10928 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10930 If @var{path} is specified, GCC looks at the @var{path} to find
10931 the profile feedback data files. See @option{-fprofile-dir}.
10933 To optimize the program based on the collected profile information, use
10934 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10936 @item -fprofile-update=@var{method}
10937 @opindex fprofile-update
10939 Alter the update method for an application instrumented for profile
10940 feedback based optimization.  The @var{method} argument should be one of
10941 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10942 The first one is useful for single-threaded applications,
10943 while the second one prevents profile corruption by emitting thread-safe code.
10945 @strong{Warning:} When an application does not properly join all threads
10946 (or creates an detached thread), a profile file can be still corrupted.
10948 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10949 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10950 automatically selects @samp{prefer-atomic} when @option{-pthread}
10951 is present in the command line.
10953 @item -fsanitize=address
10954 @opindex fsanitize=address
10955 Enable AddressSanitizer, a fast memory error detector.
10956 Memory access instructions are instrumented to detect
10957 out-of-bounds and use-after-free bugs.
10958 The option enables @option{-fsanitize-address-use-after-scope}.
10959 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10960 more details.  The run-time behavior can be influenced using the
10961 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10962 the available options are shown at startup of the instrumented program.  See
10963 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10964 for a list of supported options.
10965 The option cannot be combined with @option{-fsanitize=thread}
10966 and/or @option{-fcheck-pointer-bounds}.
10968 @item -fsanitize=kernel-address
10969 @opindex fsanitize=kernel-address
10970 Enable AddressSanitizer for Linux kernel.
10971 See @uref{https://github.com/google/kasan/wiki} for more details.
10972 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10974 @item -fsanitize=thread
10975 @opindex fsanitize=thread
10976 Enable ThreadSanitizer, a fast data race detector.
10977 Memory access instructions are instrumented to detect
10978 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10979 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10980 environment variable; see
10981 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10982 supported options.
10983 The option cannot be combined with @option{-fsanitize=address},
10984 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10986 Note that sanitized atomic builtins cannot throw exceptions when
10987 operating on invalid memory addresses with non-call exceptions
10988 (@option{-fnon-call-exceptions}).
10990 @item -fsanitize=leak
10991 @opindex fsanitize=leak
10992 Enable LeakSanitizer, a memory leak detector.
10993 This option only matters for linking of executables and
10994 the executable is linked against a library that overrides @code{malloc}
10995 and other allocator functions.  See
10996 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10997 details.  The run-time behavior can be influenced using the
10998 @env{LSAN_OPTIONS} environment variable.
10999 The option cannot be combined with @option{-fsanitize=thread}.
11001 @item -fsanitize=undefined
11002 @opindex fsanitize=undefined
11003 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11004 Various computations are instrumented to detect undefined behavior
11005 at runtime.  Current suboptions are:
11007 @table @gcctabopt
11009 @item -fsanitize=shift
11010 @opindex fsanitize=shift
11011 This option enables checking that the result of a shift operation is
11012 not undefined.  Note that what exactly is considered undefined differs
11013 slightly between C and C++, as well as between ISO C90 and C99, etc.
11014 This option has two suboptions, @option{-fsanitize=shift-base} and
11015 @option{-fsanitize=shift-exponent}.
11017 @item -fsanitize=shift-exponent
11018 @opindex fsanitize=shift-exponent
11019 This option enables checking that the second argument of a shift operation
11020 is not negative and is smaller than the precision of the promoted first
11021 argument.
11023 @item -fsanitize=shift-base
11024 @opindex fsanitize=shift-base
11025 If the second argument of a shift operation is within range, check that the
11026 result of a shift operation is not undefined.  Note that what exactly is
11027 considered undefined differs slightly between C and C++, as well as between
11028 ISO C90 and C99, etc.
11030 @item -fsanitize=integer-divide-by-zero
11031 @opindex fsanitize=integer-divide-by-zero
11032 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11034 @item -fsanitize=unreachable
11035 @opindex fsanitize=unreachable
11036 With this option, the compiler turns the @code{__builtin_unreachable}
11037 call into a diagnostics message call instead.  When reaching the
11038 @code{__builtin_unreachable} call, the behavior is undefined.
11040 @item -fsanitize=vla-bound
11041 @opindex fsanitize=vla-bound
11042 This option instructs the compiler to check that the size of a variable
11043 length array is positive.
11045 @item -fsanitize=null
11046 @opindex fsanitize=null
11047 This option enables pointer checking.  Particularly, the application
11048 built with this option turned on will issue an error message when it
11049 tries to dereference a NULL pointer, or if a reference (possibly an
11050 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11051 on an object pointed by a NULL pointer.
11053 @item -fsanitize=return
11054 @opindex fsanitize=return
11055 This option enables return statement checking.  Programs
11056 built with this option turned on will issue an error message
11057 when the end of a non-void function is reached without actually
11058 returning a value.  This option works in C++ only.
11060 @item -fsanitize=signed-integer-overflow
11061 @opindex fsanitize=signed-integer-overflow
11062 This option enables signed integer overflow checking.  We check that
11063 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11064 does not overflow in the signed arithmetics.  Note, integer promotion
11065 rules must be taken into account.  That is, the following is not an
11066 overflow:
11067 @smallexample
11068 signed char a = SCHAR_MAX;
11069 a++;
11070 @end smallexample
11072 @item -fsanitize=bounds
11073 @opindex fsanitize=bounds
11074 This option enables instrumentation of array bounds.  Various out of bounds
11075 accesses are detected.  Flexible array members, flexible array member-like
11076 arrays, and initializers of variables with static storage are not instrumented.
11077 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11079 @item -fsanitize=bounds-strict
11080 @opindex fsanitize=bounds-strict
11081 This option enables strict instrumentation of array bounds.  Most out of bounds
11082 accesses are detected, including flexible array members and flexible array
11083 member-like arrays.  Initializers of variables with static storage are not
11084 instrumented.  The option cannot be combined
11085 with @option{-fcheck-pointer-bounds}.
11087 @item -fsanitize=alignment
11088 @opindex fsanitize=alignment
11090 This option enables checking of alignment of pointers when they are
11091 dereferenced, or when a reference is bound to insufficiently aligned target,
11092 or when a method or constructor is invoked on insufficiently aligned object.
11094 @item -fsanitize=object-size
11095 @opindex fsanitize=object-size
11096 This option enables instrumentation of memory references using the
11097 @code{__builtin_object_size} function.  Various out of bounds pointer
11098 accesses are detected.
11100 @item -fsanitize=float-divide-by-zero
11101 @opindex fsanitize=float-divide-by-zero
11102 Detect floating-point division by zero.  Unlike other similar options,
11103 @option{-fsanitize=float-divide-by-zero} is not enabled by
11104 @option{-fsanitize=undefined}, since floating-point division by zero can
11105 be a legitimate way of obtaining infinities and NaNs.
11107 @item -fsanitize=float-cast-overflow
11108 @opindex fsanitize=float-cast-overflow
11109 This option enables floating-point type to integer conversion checking.
11110 We check that the result of the conversion does not overflow.
11111 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11112 not enabled by @option{-fsanitize=undefined}.
11113 This option does not work well with @code{FE_INVALID} exceptions enabled.
11115 @item -fsanitize=nonnull-attribute
11116 @opindex fsanitize=nonnull-attribute
11118 This option enables instrumentation of calls, checking whether null values
11119 are not passed to arguments marked as requiring a non-null value by the
11120 @code{nonnull} function attribute.
11122 @item -fsanitize=returns-nonnull-attribute
11123 @opindex fsanitize=returns-nonnull-attribute
11125 This option enables instrumentation of return statements in functions
11126 marked with @code{returns_nonnull} function attribute, to detect returning
11127 of null values from such functions.
11129 @item -fsanitize=bool
11130 @opindex fsanitize=bool
11132 This option enables instrumentation of loads from bool.  If a value other
11133 than 0/1 is loaded, a run-time error is issued.
11135 @item -fsanitize=enum
11136 @opindex fsanitize=enum
11138 This option enables instrumentation of loads from an enum type.  If
11139 a value outside the range of values for the enum type is loaded,
11140 a run-time error is issued.
11142 @item -fsanitize=vptr
11143 @opindex fsanitize=vptr
11145 This option enables instrumentation of C++ member function calls, member
11146 accesses and some conversions between pointers to base and derived classes,
11147 to verify the referenced object has the correct dynamic type.
11149 @item -fsanitize=pointer-overflow
11150 @opindex fsanitize=pointer-overflow
11152 This option enables instrumentation of pointer arithmetics.  If the pointer
11153 arithmetics overflows, a run-time error is issued.
11155 @item -fsanitize=builtin
11156 @opindex fsanitize=builtin
11158 This option enables instrumentation of arguments to selected builtin
11159 functions.  If an invalid value is passed to such arguments, a run-time
11160 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11161 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11162 by this option.
11164 @end table
11166 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11167 @option{-fsanitize=undefined} gives a diagnostic message.
11168 This currently works only for the C family of languages.
11170 @item -fno-sanitize=all
11171 @opindex fno-sanitize=all
11173 This option disables all previously enabled sanitizers.
11174 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11175 together.
11177 @item -fasan-shadow-offset=@var{number}
11178 @opindex fasan-shadow-offset
11179 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11180 It is useful for experimenting with different shadow memory layouts in
11181 Kernel AddressSanitizer.
11183 @item -fsanitize-sections=@var{s1},@var{s2},...
11184 @opindex fsanitize-sections
11185 Sanitize global variables in selected user-defined sections.  @var{si} may
11186 contain wildcards.
11188 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11189 @opindex fsanitize-recover
11190 @opindex fno-sanitize-recover
11191 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11192 mentioned in comma-separated list of @var{opts}.  Enabling this option
11193 for a sanitizer component causes it to attempt to continue
11194 running the program as if no error happened.  This means multiple
11195 runtime errors can be reported in a single program run, and the exit
11196 code of the program may indicate success even when errors
11197 have been reported.  The @option{-fno-sanitize-recover=} option
11198 can be used to alter
11199 this behavior: only the first detected error is reported
11200 and program then exits with a non-zero exit code.
11202 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11203 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11204 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11205 @option{-fsanitize=bounds-strict},
11206 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11207 For these sanitizers error recovery is turned on by default,
11208 except @option{-fsanitize=address}, for which this feature is experimental.
11209 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11210 accepted, the former enables recovery for all sanitizers that support it,
11211 the latter disables recovery for all sanitizers that support it.
11213 Even if a recovery mode is turned on the compiler side, it needs to be also
11214 enabled on the runtime library side, otherwise the failures are still fatal.
11215 The runtime library defaults to @code{halt_on_error=0} for
11216 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11217 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11218 setting the @code{halt_on_error} flag in the corresponding environment variable.
11220 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11221 equivalent to specifying an @var{opts} list of:
11223 @smallexample
11224 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11225 @end smallexample
11227 @item -fsanitize-address-use-after-scope
11228 @opindex fsanitize-address-use-after-scope
11229 Enable sanitization of local variables to detect use-after-scope bugs.
11230 The option sets @option{-fstack-reuse} to @samp{none}.
11232 @item -fsanitize-undefined-trap-on-error
11233 @opindex fsanitize-undefined-trap-on-error
11234 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11235 report undefined behavior using @code{__builtin_trap} rather than
11236 a @code{libubsan} library routine.  The advantage of this is that the
11237 @code{libubsan} library is not needed and is not linked in, so this
11238 is usable even in freestanding environments.
11240 @item -fsanitize-coverage=trace-pc
11241 @opindex fsanitize-coverage=trace-pc
11242 Enable coverage-guided fuzzing code instrumentation.
11243 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11245 @item -fsanitize-coverage=trace-cmp
11246 @opindex fsanitize-coverage=trace-cmp
11247 Enable dataflow guided fuzzing code instrumentation.
11248 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11249 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11250 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11251 variable or @code{__sanitizer_cov_trace_const_cmp1},
11252 @code{__sanitizer_cov_trace_const_cmp2},
11253 @code{__sanitizer_cov_trace_const_cmp4} or
11254 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11255 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11256 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11257 @code{__sanitizer_cov_trace_switch} for switch statements.
11259 @item -fbounds-check
11260 @opindex fbounds-check
11261 For front ends that support it, generate additional code to check that
11262 indices used to access arrays are within the declared range.  This is
11263 currently only supported by the Fortran front end, where this option
11264 defaults to false.
11266 @item -fcheck-pointer-bounds
11267 @opindex fcheck-pointer-bounds
11268 @opindex fno-check-pointer-bounds
11269 @cindex Pointer Bounds Checker options
11270 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11271 is instrumented with checks of the pointer used for memory access against
11272 bounds associated with that pointer.  
11274 Currently there
11275 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11276 and @option{-mmpx} are required to enable this feature.  
11277 MPX-based instrumentation requires
11278 a runtime library to enable MPX in hardware and handle bounds
11279 violation signals.  By default when @option{-fcheck-pointer-bounds}
11280 and @option{-mmpx} options are used to link a program, the GCC driver
11281 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11282 Bounds checking on calls to dynamic libraries requires a linker
11283 with @option{-z bndplt} support; if GCC was configured with a linker
11284 without support for this option (including the Gold linker and older
11285 versions of ld), a warning is given if you link with @option{-mmpx}
11286 without also specifying @option{-static}, since the overall effectiveness
11287 of the bounds checking protection is reduced.
11288 See also @option{-static-libmpxwrappers}.
11290 MPX-based instrumentation
11291 may be used for debugging and also may be included in production code
11292 to increase program security.  Depending on usage, you may
11293 have different requirements for the runtime library.  The current version
11294 of the MPX runtime library is more oriented for use as a debugging
11295 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11296 also @option{-static-libmpx}.  The runtime library  behavior can be
11297 influenced using various @env{CHKP_RT_*} environment variables.  See
11298 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11299 for more details.
11301 Generated instrumentation may be controlled by various
11302 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11303 structure field attribute (@pxref{Type Attributes}) and
11304 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11305 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11306 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11307 Bounds Checker builtins}, for more information.
11309 @item -fchkp-check-incomplete-type
11310 @opindex fchkp-check-incomplete-type
11311 @opindex fno-chkp-check-incomplete-type
11312 Generate pointer bounds checks for variables with incomplete type.
11313 Enabled by default.
11315 @item -fchkp-narrow-bounds
11316 @opindex fchkp-narrow-bounds
11317 @opindex fno-chkp-narrow-bounds
11318 Controls bounds used by Pointer Bounds Checker for pointers to object
11319 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11320 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11321 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11323 @item -fchkp-first-field-has-own-bounds
11324 @opindex fchkp-first-field-has-own-bounds
11325 @opindex fno-chkp-first-field-has-own-bounds
11326 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11327 first field in the structure.  By default a pointer to the first field has
11328 the same bounds as a pointer to the whole structure.
11330 @item -fchkp-flexible-struct-trailing-arrays
11331 @opindex fchkp-flexible-struct-trailing-arrays
11332 @opindex fno-chkp-flexible-struct-trailing-arrays
11333 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11334 possibly flexible.  By default only array fields with zero length or that are
11335 marked with attribute bnd_variable_size are treated as flexible.
11337 @item -fchkp-narrow-to-innermost-array
11338 @opindex fchkp-narrow-to-innermost-array
11339 @opindex fno-chkp-narrow-to-innermost-array
11340 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11341 case of nested static array access.  By default this option is disabled and
11342 bounds of the outermost array are used.
11344 @item -fchkp-optimize
11345 @opindex fchkp-optimize
11346 @opindex fno-chkp-optimize
11347 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11348 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11350 @item -fchkp-use-fast-string-functions
11351 @opindex fchkp-use-fast-string-functions
11352 @opindex fno-chkp-use-fast-string-functions
11353 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11354 by Pointer Bounds Checker.  Disabled by default.
11356 @item -fchkp-use-nochk-string-functions
11357 @opindex fchkp-use-nochk-string-functions
11358 @opindex fno-chkp-use-nochk-string-functions
11359 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11360 by Pointer Bounds Checker.  Disabled by default.
11362 @item -fchkp-use-static-bounds
11363 @opindex fchkp-use-static-bounds
11364 @opindex fno-chkp-use-static-bounds
11365 Allow Pointer Bounds Checker to generate static bounds holding
11366 bounds of static variables.  Enabled by default.
11368 @item -fchkp-use-static-const-bounds
11369 @opindex fchkp-use-static-const-bounds
11370 @opindex fno-chkp-use-static-const-bounds
11371 Use statically-initialized bounds for constant bounds instead of
11372 generating them each time they are required.  By default enabled when
11373 @option{-fchkp-use-static-bounds} is enabled.
11375 @item -fchkp-treat-zero-dynamic-size-as-infinite
11376 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11377 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11378 With this option, objects with incomplete type whose
11379 dynamically-obtained size is zero are treated as having infinite size
11380 instead by Pointer Bounds
11381 Checker.  This option may be helpful if a program is linked with a library
11382 missing size information for some symbols.  Disabled by default.
11384 @item -fchkp-check-read
11385 @opindex fchkp-check-read
11386 @opindex fno-chkp-check-read
11387 Instructs Pointer Bounds Checker to generate checks for all read
11388 accesses to memory.  Enabled by default.
11390 @item -fchkp-check-write
11391 @opindex fchkp-check-write
11392 @opindex fno-chkp-check-write
11393 Instructs Pointer Bounds Checker to generate checks for all write
11394 accesses to memory.  Enabled by default.
11396 @item -fchkp-store-bounds
11397 @opindex fchkp-store-bounds
11398 @opindex fno-chkp-store-bounds
11399 Instructs Pointer Bounds Checker to generate bounds stores for
11400 pointer writes.  Enabled by default.
11402 @item -fchkp-instrument-calls
11403 @opindex fchkp-instrument-calls
11404 @opindex fno-chkp-instrument-calls
11405 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11406 Enabled by default.
11408 @item -fchkp-instrument-marked-only
11409 @opindex fchkp-instrument-marked-only
11410 @opindex fno-chkp-instrument-marked-only
11411 Instructs Pointer Bounds Checker to instrument only functions
11412 marked with the @code{bnd_instrument} attribute
11413 (@pxref{Function Attributes}).  Disabled by default.
11415 @item -fchkp-use-wrappers
11416 @opindex fchkp-use-wrappers
11417 @opindex fno-chkp-use-wrappers
11418 Allows Pointer Bounds Checker to replace calls to built-in functions
11419 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11420 is used to link a program, the GCC driver automatically links
11421 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11422 Enabled by default.
11424 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11425 @opindex fcf-protection
11426 Enable code instrumentation of control-flow transfers to increase
11427 program security by checking that target addresses of control-flow
11428 transfer instructions (such as indirect function call, function return,
11429 indirect jump) are valid.  This prevents diverting the flow of control
11430 to an unexpected target.  This is intended to protect against such
11431 threats as Return-oriented Programming (ROP), and similarly
11432 call/jmp-oriented programming (COP/JOP).
11434 The value @code{branch} tells the compiler to implement checking of
11435 validity of control-flow transfer at the point of indirect branch
11436 instructions, i.e. call/jmp instructions.  The value @code{return}
11437 implements checking of validity at the point of returning from a
11438 function.  The value @code{full} is an alias for specifying both
11439 @code{branch} and @code{return}. The value @code{none} turns off
11440 instrumentation.
11442 You can also use the @code{nocf_check} attribute to identify
11443 which functions and calls should be skipped from instrumentation
11444 (@pxref{Function Attributes}).
11446 Currently the x86 GNU/Linux target provides an implementation based
11447 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11448 for x86 is controlled by target-specific options @option{-mcet},
11449 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11451 @item -fstack-protector
11452 @opindex fstack-protector
11453 Emit extra code to check for buffer overflows, such as stack smashing
11454 attacks.  This is done by adding a guard variable to functions with
11455 vulnerable objects.  This includes functions that call @code{alloca}, and
11456 functions with buffers larger than 8 bytes.  The guards are initialized
11457 when a function is entered and then checked when the function exits.
11458 If a guard check fails, an error message is printed and the program exits.
11460 @item -fstack-protector-all
11461 @opindex fstack-protector-all
11462 Like @option{-fstack-protector} except that all functions are protected.
11464 @item -fstack-protector-strong
11465 @opindex fstack-protector-strong
11466 Like @option{-fstack-protector} but includes additional functions to
11467 be protected --- those that have local array definitions, or have
11468 references to local frame addresses.
11470 @item -fstack-protector-explicit
11471 @opindex fstack-protector-explicit
11472 Like @option{-fstack-protector} but only protects those functions which
11473 have the @code{stack_protect} attribute.
11475 @item -fstack-check
11476 @opindex fstack-check
11477 Generate code to verify that you do not go beyond the boundary of the
11478 stack.  You should specify this flag if you are running in an
11479 environment with multiple threads, but you only rarely need to specify it in
11480 a single-threaded environment since stack overflow is automatically
11481 detected on nearly all systems if there is only one stack.
11483 Note that this switch does not actually cause checking to be done; the
11484 operating system or the language runtime must do that.  The switch causes
11485 generation of code to ensure that they see the stack being extended.
11487 You can additionally specify a string parameter: @samp{no} means no
11488 checking, @samp{generic} means force the use of old-style checking,
11489 @samp{specific} means use the best checking method and is equivalent
11490 to bare @option{-fstack-check}.
11492 Old-style checking is a generic mechanism that requires no specific
11493 target support in the compiler but comes with the following drawbacks:
11495 @enumerate
11496 @item
11497 Modified allocation strategy for large objects: they are always
11498 allocated dynamically if their size exceeds a fixed threshold.  Note this
11499 may change the semantics of some code.
11501 @item
11502 Fixed limit on the size of the static frame of functions: when it is
11503 topped by a particular function, stack checking is not reliable and
11504 a warning is issued by the compiler.
11506 @item
11507 Inefficiency: because of both the modified allocation strategy and the
11508 generic implementation, code performance is hampered.
11509 @end enumerate
11511 Note that old-style stack checking is also the fallback method for
11512 @samp{specific} if no target support has been added in the compiler.
11514 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11515 and stack overflows.  @samp{specific} is an excellent choice when compiling
11516 Ada code.  It is not generally sufficient to protect against stack-clash
11517 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11519 @item -fstack-clash-protection
11520 @opindex fstack-clash-protection
11521 Generate code to prevent stack clash style attacks.  When this option is
11522 enabled, the compiler will only allocate one page of stack space at a time
11523 and each page is accessed immediately after allocation.  Thus, it prevents
11524 allocations from jumping over any stack guard page provided by the
11525 operating system.
11527 Most targets do not fully support stack clash protection.  However, on
11528 those targets @option{-fstack-clash-protection} will protect dynamic stack
11529 allocations.  @option{-fstack-clash-protection} may also provide limited
11530 protection for static stack allocations if the target supports
11531 @option{-fstack-check=specific}.
11533 @item -fstack-limit-register=@var{reg}
11534 @itemx -fstack-limit-symbol=@var{sym}
11535 @itemx -fno-stack-limit
11536 @opindex fstack-limit-register
11537 @opindex fstack-limit-symbol
11538 @opindex fno-stack-limit
11539 Generate code to ensure that the stack does not grow beyond a certain value,
11540 either the value of a register or the address of a symbol.  If a larger
11541 stack is required, a signal is raised at run time.  For most targets,
11542 the signal is raised before the stack overruns the boundary, so
11543 it is possible to catch the signal without taking special precautions.
11545 For instance, if the stack starts at absolute address @samp{0x80000000}
11546 and grows downwards, you can use the flags
11547 @option{-fstack-limit-symbol=__stack_limit} and
11548 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11549 of 128KB@.  Note that this may only work with the GNU linker.
11551 You can locally override stack limit checking by using the
11552 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11554 @item -fsplit-stack
11555 @opindex fsplit-stack
11556 Generate code to automatically split the stack before it overflows.
11557 The resulting program has a discontiguous stack which can only
11558 overflow if the program is unable to allocate any more memory.  This
11559 is most useful when running threaded programs, as it is no longer
11560 necessary to calculate a good stack size to use for each thread.  This
11561 is currently only implemented for the x86 targets running
11562 GNU/Linux.
11564 When code compiled with @option{-fsplit-stack} calls code compiled
11565 without @option{-fsplit-stack}, there may not be much stack space
11566 available for the latter code to run.  If compiling all code,
11567 including library code, with @option{-fsplit-stack} is not an option,
11568 then the linker can fix up these calls so that the code compiled
11569 without @option{-fsplit-stack} always has a large stack.  Support for
11570 this is implemented in the gold linker in GNU binutils release 2.21
11571 and later.
11573 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11574 @opindex fvtable-verify
11575 This option is only available when compiling C++ code.
11576 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11577 feature that verifies at run time, for every virtual call, that
11578 the vtable pointer through which the call is made is valid for the type of
11579 the object, and has not been corrupted or overwritten.  If an invalid vtable
11580 pointer is detected at run time, an error is reported and execution of the
11581 program is immediately halted.
11583 This option causes run-time data structures to be built at program startup,
11584 which are used for verifying the vtable pointers.  
11585 The options @samp{std} and @samp{preinit}
11586 control the timing of when these data structures are built.  In both cases the
11587 data structures are built before execution reaches @code{main}.  Using
11588 @option{-fvtable-verify=std} causes the data structures to be built after
11589 shared libraries have been loaded and initialized.
11590 @option{-fvtable-verify=preinit} causes them to be built before shared
11591 libraries have been loaded and initialized.
11593 If this option appears multiple times in the command line with different
11594 values specified, @samp{none} takes highest priority over both @samp{std} and
11595 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11597 @item -fvtv-debug
11598 @opindex fvtv-debug
11599 When used in conjunction with @option{-fvtable-verify=std} or 
11600 @option{-fvtable-verify=preinit}, causes debug versions of the 
11601 runtime functions for the vtable verification feature to be called.  
11602 This flag also causes the compiler to log information about which 
11603 vtable pointers it finds for each class.
11604 This information is written to a file named @file{vtv_set_ptr_data.log} 
11605 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11606 if that is defined or the current working directory otherwise.
11608 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11609 file, be sure to delete any existing one.
11611 @item -fvtv-counts
11612 @opindex fvtv-counts
11613 This is a debugging flag.  When used in conjunction with
11614 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11615 causes the compiler to keep track of the total number of virtual calls
11616 it encounters and the number of verifications it inserts.  It also
11617 counts the number of calls to certain run-time library functions
11618 that it inserts and logs this information for each compilation unit.
11619 The compiler writes this information to a file named
11620 @file{vtv_count_data.log} in the directory named by the environment
11621 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11622 directory otherwise.  It also counts the size of the vtable pointer sets
11623 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11624 in the same directory.
11626 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11627 files, be sure to delete any existing ones.
11629 @item -finstrument-functions
11630 @opindex finstrument-functions
11631 Generate instrumentation calls for entry and exit to functions.  Just
11632 after function entry and just before function exit, the following
11633 profiling functions are called with the address of the current
11634 function and its call site.  (On some platforms,
11635 @code{__builtin_return_address} does not work beyond the current
11636 function, so the call site information may not be available to the
11637 profiling functions otherwise.)
11639 @smallexample
11640 void __cyg_profile_func_enter (void *this_fn,
11641                                void *call_site);
11642 void __cyg_profile_func_exit  (void *this_fn,
11643                                void *call_site);
11644 @end smallexample
11646 The first argument is the address of the start of the current function,
11647 which may be looked up exactly in the symbol table.
11649 This instrumentation is also done for functions expanded inline in other
11650 functions.  The profiling calls indicate where, conceptually, the
11651 inline function is entered and exited.  This means that addressable
11652 versions of such functions must be available.  If all your uses of a
11653 function are expanded inline, this may mean an additional expansion of
11654 code size.  If you use @code{extern inline} in your C code, an
11655 addressable version of such functions must be provided.  (This is
11656 normally the case anyway, but if you get lucky and the optimizer always
11657 expands the functions inline, you might have gotten away without
11658 providing static copies.)
11660 A function may be given the attribute @code{no_instrument_function}, in
11661 which case this instrumentation is not done.  This can be used, for
11662 example, for the profiling functions listed above, high-priority
11663 interrupt routines, and any functions from which the profiling functions
11664 cannot safely be called (perhaps signal handlers, if the profiling
11665 routines generate output or allocate memory).
11667 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11668 @opindex finstrument-functions-exclude-file-list
11670 Set the list of functions that are excluded from instrumentation (see
11671 the description of @option{-finstrument-functions}).  If the file that
11672 contains a function definition matches with one of @var{file}, then
11673 that function is not instrumented.  The match is done on substrings:
11674 if the @var{file} parameter is a substring of the file name, it is
11675 considered to be a match.
11677 For example:
11679 @smallexample
11680 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11681 @end smallexample
11683 @noindent
11684 excludes any inline function defined in files whose pathnames
11685 contain @file{/bits/stl} or @file{include/sys}.
11687 If, for some reason, you want to include letter @samp{,} in one of
11688 @var{sym}, write @samp{\,}. For example,
11689 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11690 (note the single quote surrounding the option).
11692 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11693 @opindex finstrument-functions-exclude-function-list
11695 This is similar to @option{-finstrument-functions-exclude-file-list},
11696 but this option sets the list of function names to be excluded from
11697 instrumentation.  The function name to be matched is its user-visible
11698 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11699 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11700 match is done on substrings: if the @var{sym} parameter is a substring
11701 of the function name, it is considered to be a match.  For C99 and C++
11702 extended identifiers, the function name must be given in UTF-8, not
11703 using universal character names.
11705 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11706 @opindex fpatchable-function-entry
11707 Generate @var{N} NOPs right at the beginning
11708 of each function, with the function entry point before the @var{M}th NOP.
11709 If @var{M} is omitted, it defaults to @code{0} so the
11710 function entry points to the address just at the first NOP.
11711 The NOP instructions reserve extra space which can be used to patch in
11712 any desired instrumentation at run time, provided that the code segment
11713 is writable.  The amount of space is controllable indirectly via
11714 the number of NOPs; the NOP instruction used corresponds to the instruction
11715 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11716 is target-specific and may also depend on the architecture variant and/or
11717 other compilation options.
11719 For run-time identification, the starting addresses of these areas,
11720 which correspond to their respective function entries minus @var{M},
11721 are additionally collected in the @code{__patchable_function_entries}
11722 section of the resulting binary.
11724 Note that the value of @code{__attribute__ ((patchable_function_entry
11725 (N,M)))} takes precedence over command-line option
11726 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11727 the area size or to remove it completely on a single function.
11728 If @code{N=0}, no pad location is recorded.
11730 The NOP instructions are inserted at---and maybe before, depending on
11731 @var{M}---the function entry address, even before the prologue.
11733 @end table
11736 @node Preprocessor Options
11737 @section Options Controlling the Preprocessor
11738 @cindex preprocessor options
11739 @cindex options, preprocessor
11741 These options control the C preprocessor, which is run on each C source
11742 file before actual compilation.
11744 If you use the @option{-E} option, nothing is done except preprocessing.
11745 Some of these options make sense only together with @option{-E} because
11746 they cause the preprocessor output to be unsuitable for actual
11747 compilation.
11749 In addition to the options listed here, there are a number of options 
11750 to control search paths for include files documented in 
11751 @ref{Directory Options}.  
11752 Options to control preprocessor diagnostics are listed in 
11753 @ref{Warning Options}.
11755 @table @gcctabopt
11756 @include cppopts.texi
11758 @item -Wp,@var{option}
11759 @opindex Wp
11760 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11761 and pass @var{option} directly through to the preprocessor.  If
11762 @var{option} contains commas, it is split into multiple options at the
11763 commas.  However, many options are modified, translated or interpreted
11764 by the compiler driver before being passed to the preprocessor, and
11765 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11766 interface is undocumented and subject to change, so whenever possible
11767 you should avoid using @option{-Wp} and let the driver handle the
11768 options instead.
11770 @item -Xpreprocessor @var{option}
11771 @opindex Xpreprocessor
11772 Pass @var{option} as an option to the preprocessor.  You can use this to
11773 supply system-specific preprocessor options that GCC does not 
11774 recognize.
11776 If you want to pass an option that takes an argument, you must use
11777 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11779 @item -no-integrated-cpp
11780 @opindex no-integrated-cpp
11781 Perform preprocessing as a separate pass before compilation.
11782 By default, GCC performs preprocessing as an integrated part of
11783 input tokenization and parsing.
11784 If this option is provided, the appropriate language front end
11785 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11786 and Objective-C, respectively) is instead invoked twice,
11787 once for preprocessing only and once for actual compilation
11788 of the preprocessed input.
11789 This option may be useful in conjunction with the @option{-B} or
11790 @option{-wrapper} options to specify an alternate preprocessor or
11791 perform additional processing of the program source between
11792 normal preprocessing and compilation.
11794 @end table
11796 @node Assembler Options
11797 @section Passing Options to the Assembler
11799 @c prevent bad page break with this line
11800 You can pass options to the assembler.
11802 @table @gcctabopt
11803 @item -Wa,@var{option}
11804 @opindex Wa
11805 Pass @var{option} as an option to the assembler.  If @var{option}
11806 contains commas, it is split into multiple options at the commas.
11808 @item -Xassembler @var{option}
11809 @opindex Xassembler
11810 Pass @var{option} as an option to the assembler.  You can use this to
11811 supply system-specific assembler options that GCC does not
11812 recognize.
11814 If you want to pass an option that takes an argument, you must use
11815 @option{-Xassembler} twice, once for the option and once for the argument.
11817 @end table
11819 @node Link Options
11820 @section Options for Linking
11821 @cindex link options
11822 @cindex options, linking
11824 These options come into play when the compiler links object files into
11825 an executable output file.  They are meaningless if the compiler is
11826 not doing a link step.
11828 @table @gcctabopt
11829 @cindex file names
11830 @item @var{object-file-name}
11831 A file name that does not end in a special recognized suffix is
11832 considered to name an object file or library.  (Object files are
11833 distinguished from libraries by the linker according to the file
11834 contents.)  If linking is done, these object files are used as input
11835 to the linker.
11837 @item -c
11838 @itemx -S
11839 @itemx -E
11840 @opindex c
11841 @opindex S
11842 @opindex E
11843 If any of these options is used, then the linker is not run, and
11844 object file names should not be used as arguments.  @xref{Overall
11845 Options}.
11847 @item -fuse-ld=bfd
11848 @opindex fuse-ld=bfd
11849 Use the @command{bfd} linker instead of the default linker.
11851 @item -fuse-ld=gold
11852 @opindex fuse-ld=gold
11853 Use the @command{gold} linker instead of the default linker.
11855 @cindex Libraries
11856 @item -l@var{library}
11857 @itemx -l @var{library}
11858 @opindex l
11859 Search the library named @var{library} when linking.  (The second
11860 alternative with the library as a separate argument is only for
11861 POSIX compliance and is not recommended.)
11863 It makes a difference where in the command you write this option; the
11864 linker searches and processes libraries and object files in the order they
11865 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11866 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11867 to functions in @samp{z}, those functions may not be loaded.
11869 The linker searches a standard list of directories for the library,
11870 which is actually a file named @file{lib@var{library}.a}.  The linker
11871 then uses this file as if it had been specified precisely by name.
11873 The directories searched include several standard system directories
11874 plus any that you specify with @option{-L}.
11876 Normally the files found this way are library files---archive files
11877 whose members are object files.  The linker handles an archive file by
11878 scanning through it for members which define symbols that have so far
11879 been referenced but not defined.  But if the file that is found is an
11880 ordinary object file, it is linked in the usual fashion.  The only
11881 difference between using an @option{-l} option and specifying a file name
11882 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11883 and searches several directories.
11885 @item -lobjc
11886 @opindex lobjc
11887 You need this special case of the @option{-l} option in order to
11888 link an Objective-C or Objective-C++ program.
11890 @item -nostartfiles
11891 @opindex nostartfiles
11892 Do not use the standard system startup files when linking.
11893 The standard system libraries are used normally, unless @option{-nostdlib}
11894 or @option{-nodefaultlibs} is used.
11896 @item -nodefaultlibs
11897 @opindex nodefaultlibs
11898 Do not use the standard system libraries when linking.
11899 Only the libraries you specify are passed to the linker, and options
11900 specifying linkage of the system libraries, such as @option{-static-libgcc}
11901 or @option{-shared-libgcc}, are ignored.  
11902 The standard startup files are used normally, unless @option{-nostartfiles}
11903 is used.  
11905 The compiler may generate calls to @code{memcmp},
11906 @code{memset}, @code{memcpy} and @code{memmove}.
11907 These entries are usually resolved by entries in
11908 libc.  These entry points should be supplied through some other
11909 mechanism when this option is specified.
11911 @item -nostdlib
11912 @opindex nostdlib
11913 Do not use the standard system startup files or libraries when linking.
11914 No startup files and only the libraries you specify are passed to
11915 the linker, and options specifying linkage of the system libraries, such as
11916 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11918 The compiler may generate calls to @code{memcmp}, @code{memset},
11919 @code{memcpy} and @code{memmove}.
11920 These entries are usually resolved by entries in
11921 libc.  These entry points should be supplied through some other
11922 mechanism when this option is specified.
11924 @cindex @option{-lgcc}, use with @option{-nostdlib}
11925 @cindex @option{-nostdlib} and unresolved references
11926 @cindex unresolved references and @option{-nostdlib}
11927 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11928 @cindex @option{-nodefaultlibs} and unresolved references
11929 @cindex unresolved references and @option{-nodefaultlibs}
11930 One of the standard libraries bypassed by @option{-nostdlib} and
11931 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11932 which GCC uses to overcome shortcomings of particular machines, or special
11933 needs for some languages.
11934 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11935 Collection (GCC) Internals},
11936 for more discussion of @file{libgcc.a}.)
11937 In most cases, you need @file{libgcc.a} even when you want to avoid
11938 other standard libraries.  In other words, when you specify @option{-nostdlib}
11939 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11940 This ensures that you have no unresolved references to internal GCC
11941 library subroutines.
11942 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11943 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11944 GNU Compiler Collection (GCC) Internals}.)
11946 @item -pie
11947 @opindex pie
11948 Produce a dynamically linked position independent executable on targets
11949 that support it.  For predictable results, you must also specify the same
11950 set of options used for compilation (@option{-fpie}, @option{-fPIE},
11951 or model suboptions) when you specify this linker option.
11953 @item -no-pie
11954 @opindex no-pie
11955 Don't produce a dynamically linked position independent executable.
11957 @item -static-pie
11958 @opindex static-pie
11959 Produce a static position independent executable on targets that support
11960 it.  A static position independent executable is similar to a static
11961 executable, but can be loaded at any address without a dynamic linker.
11962 For predictable results, you must also specify the same set of options
11963 used for compilation (@option{-fpie}, @option{-fPIE}, or model
11964 suboptions) when you specify this linker option.
11966 @item -pthread
11967 @opindex pthread
11968 Link with the POSIX threads library.  This option is supported on 
11969 GNU/Linux targets, most other Unix derivatives, and also on 
11970 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11971 flags for the preprocessor, so it should be used consistently for both
11972 compilation and linking.
11974 @item -rdynamic
11975 @opindex rdynamic
11976 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11977 that support it. This instructs the linker to add all symbols, not
11978 only used ones, to the dynamic symbol table. This option is needed
11979 for some uses of @code{dlopen} or to allow obtaining backtraces
11980 from within a program.
11982 @item -s
11983 @opindex s
11984 Remove all symbol table and relocation information from the executable.
11986 @item -static
11987 @opindex static
11988 On systems that support dynamic linking, this overrides @option{-pie}
11989 and prevents linking with the shared libraries.  On other systems, this
11990 option has no effect.
11992 @item -shared
11993 @opindex shared
11994 Produce a shared object which can then be linked with other objects to
11995 form an executable.  Not all systems support this option.  For predictable
11996 results, you must also specify the same set of options used for compilation
11997 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11998 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11999 needs to build supplementary stub code for constructors to work.  On
12000 multi-libbed systems, @samp{gcc -shared} must select the correct support
12001 libraries to link against.  Failing to supply the correct flags may lead
12002 to subtle defects.  Supplying them in cases where they are not necessary
12003 is innocuous.}
12005 @item -shared-libgcc
12006 @itemx -static-libgcc
12007 @opindex shared-libgcc
12008 @opindex static-libgcc
12009 On systems that provide @file{libgcc} as a shared library, these options
12010 force the use of either the shared or static version, respectively.
12011 If no shared version of @file{libgcc} was built when the compiler was
12012 configured, these options have no effect.
12014 There are several situations in which an application should use the
12015 shared @file{libgcc} instead of the static version.  The most common
12016 of these is when the application wishes to throw and catch exceptions
12017 across different shared libraries.  In that case, each of the libraries
12018 as well as the application itself should use the shared @file{libgcc}.
12020 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12021  whenever you build a shared library or a main executable, because C++
12022  programs typically use exceptions, so this is the right thing to do.
12024 If, instead, you use the GCC driver to create shared libraries, you may
12025 find that they are not always linked with the shared @file{libgcc}.
12026 If GCC finds, at its configuration time, that you have a non-GNU linker
12027 or a GNU linker that does not support option @option{--eh-frame-hdr},
12028 it links the shared version of @file{libgcc} into shared libraries
12029 by default.  Otherwise, it takes advantage of the linker and optimizes
12030 away the linking with the shared version of @file{libgcc}, linking with
12031 the static version of libgcc by default.  This allows exceptions to
12032 propagate through such shared libraries, without incurring relocation
12033 costs at library load time.
12035 However, if a library or main executable is supposed to throw or catch
12036 exceptions, you must link it using the G++ driver, as appropriate
12037 for the languages used in the program, or using the option
12038 @option{-shared-libgcc}, such that it is linked with the shared
12039 @file{libgcc}.
12041 @item -static-libasan
12042 @opindex static-libasan
12043 When the @option{-fsanitize=address} option is used to link a program,
12044 the GCC driver automatically links against @option{libasan}.  If
12045 @file{libasan} is available as a shared library, and the @option{-static}
12046 option is not used, then this links against the shared version of
12047 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12048 driver to link @file{libasan} statically, without necessarily linking
12049 other libraries statically.
12051 @item -static-libtsan
12052 @opindex static-libtsan
12053 When the @option{-fsanitize=thread} option is used to link a program,
12054 the GCC driver automatically links against @option{libtsan}.  If
12055 @file{libtsan} is available as a shared library, and the @option{-static}
12056 option is not used, then this links against the shared version of
12057 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12058 driver to link @file{libtsan} statically, without necessarily linking
12059 other libraries statically.
12061 @item -static-liblsan
12062 @opindex static-liblsan
12063 When the @option{-fsanitize=leak} option is used to link a program,
12064 the GCC driver automatically links against @option{liblsan}.  If
12065 @file{liblsan} is available as a shared library, and the @option{-static}
12066 option is not used, then this links against the shared version of
12067 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12068 driver to link @file{liblsan} statically, without necessarily linking
12069 other libraries statically.
12071 @item -static-libubsan
12072 @opindex static-libubsan
12073 When the @option{-fsanitize=undefined} option is used to link a program,
12074 the GCC driver automatically links against @option{libubsan}.  If
12075 @file{libubsan} is available as a shared library, and the @option{-static}
12076 option is not used, then this links against the shared version of
12077 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12078 driver to link @file{libubsan} statically, without necessarily linking
12079 other libraries statically.
12081 @item -static-libmpx
12082 @opindex static-libmpx
12083 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12084 used to link a program, the GCC driver automatically links against
12085 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12086 and the @option{-static} option is not used, then this links against
12087 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12088 option directs the GCC driver to link @file{libmpx} statically,
12089 without necessarily linking other libraries statically.
12091 @item -static-libmpxwrappers
12092 @opindex static-libmpxwrappers
12093 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12094 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12095 GCC driver automatically links against @file{libmpxwrappers}.  If
12096 @file{libmpxwrappers} is available as a shared library, and the
12097 @option{-static} option is not used, then this links against the shared
12098 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12099 option directs the GCC driver to link @file{libmpxwrappers} statically,
12100 without necessarily linking other libraries statically.
12102 @item -static-libstdc++
12103 @opindex static-libstdc++
12104 When the @command{g++} program is used to link a C++ program, it
12105 normally automatically links against @option{libstdc++}.  If
12106 @file{libstdc++} is available as a shared library, and the
12107 @option{-static} option is not used, then this links against the
12108 shared version of @file{libstdc++}.  That is normally fine.  However, it
12109 is sometimes useful to freeze the version of @file{libstdc++} used by
12110 the program without going all the way to a fully static link.  The
12111 @option{-static-libstdc++} option directs the @command{g++} driver to
12112 link @file{libstdc++} statically, without necessarily linking other
12113 libraries statically.
12115 @item -symbolic
12116 @opindex symbolic
12117 Bind references to global symbols when building a shared object.  Warn
12118 about any unresolved references (unless overridden by the link editor
12119 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12120 this option.
12122 @item -T @var{script}
12123 @opindex T
12124 @cindex linker script
12125 Use @var{script} as the linker script.  This option is supported by most
12126 systems using the GNU linker.  On some targets, such as bare-board
12127 targets without an operating system, the @option{-T} option may be required
12128 when linking to avoid references to undefined symbols.
12130 @item -Xlinker @var{option}
12131 @opindex Xlinker
12132 Pass @var{option} as an option to the linker.  You can use this to
12133 supply system-specific linker options that GCC does not recognize.
12135 If you want to pass an option that takes a separate argument, you must use
12136 @option{-Xlinker} twice, once for the option and once for the argument.
12137 For example, to pass @option{-assert definitions}, you must write
12138 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12139 @option{-Xlinker "-assert definitions"}, because this passes the entire
12140 string as a single argument, which is not what the linker expects.
12142 When using the GNU linker, it is usually more convenient to pass
12143 arguments to linker options using the @option{@var{option}=@var{value}}
12144 syntax than as separate arguments.  For example, you can specify
12145 @option{-Xlinker -Map=output.map} rather than
12146 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12147 this syntax for command-line options.
12149 @item -Wl,@var{option}
12150 @opindex Wl
12151 Pass @var{option} as an option to the linker.  If @var{option} contains
12152 commas, it is split into multiple options at the commas.  You can use this
12153 syntax to pass an argument to the option.
12154 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12155 linker.  When using the GNU linker, you can also get the same effect with
12156 @option{-Wl,-Map=output.map}.
12158 @item -u @var{symbol}
12159 @opindex u
12160 Pretend the symbol @var{symbol} is undefined, to force linking of
12161 library modules to define it.  You can use @option{-u} multiple times with
12162 different symbols to force loading of additional library modules.
12164 @item -z @var{keyword}
12165 @opindex z
12166 @option{-z} is passed directly on to the linker along with the keyword
12167 @var{keyword}. See the section in the documentation of your linker for
12168 permitted values and their meanings.
12169 @end table
12171 @node Directory Options
12172 @section Options for Directory Search
12173 @cindex directory options
12174 @cindex options, directory search
12175 @cindex search path
12177 These options specify directories to search for header files, for
12178 libraries and for parts of the compiler:
12180 @table @gcctabopt
12181 @include cppdiropts.texi
12183 @item -iplugindir=@var{dir}
12184 @opindex iplugindir=
12185 Set the directory to search for plugins that are passed
12186 by @option{-fplugin=@var{name}} instead of
12187 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12188 to be used by the user, but only passed by the driver.
12190 @item -L@var{dir}
12191 @opindex L
12192 Add directory @var{dir} to the list of directories to be searched
12193 for @option{-l}.
12195 @item -B@var{prefix}
12196 @opindex B
12197 This option specifies where to find the executables, libraries,
12198 include files, and data files of the compiler itself.
12200 The compiler driver program runs one or more of the subprograms
12201 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12202 @var{prefix} as a prefix for each program it tries to run, both with and
12203 without @samp{@var{machine}/@var{version}/} for the corresponding target
12204 machine and compiler version.
12206 For each subprogram to be run, the compiler driver first tries the
12207 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12208 is not specified, the driver tries two standard prefixes, 
12209 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12210 those results in a file name that is found, the unmodified program
12211 name is searched for using the directories specified in your
12212 @env{PATH} environment variable.
12214 The compiler checks to see if the path provided by @option{-B}
12215 refers to a directory, and if necessary it adds a directory
12216 separator character at the end of the path.
12218 @option{-B} prefixes that effectively specify directory names also apply
12219 to libraries in the linker, because the compiler translates these
12220 options into @option{-L} options for the linker.  They also apply to
12221 include files in the preprocessor, because the compiler translates these
12222 options into @option{-isystem} options for the preprocessor.  In this case,
12223 the compiler appends @samp{include} to the prefix.
12225 The runtime support file @file{libgcc.a} can also be searched for using
12226 the @option{-B} prefix, if needed.  If it is not found there, the two
12227 standard prefixes above are tried, and that is all.  The file is left
12228 out of the link if it is not found by those means.
12230 Another way to specify a prefix much like the @option{-B} prefix is to use
12231 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12232 Variables}.
12234 As a special kludge, if the path provided by @option{-B} is
12235 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12236 9, then it is replaced by @file{[dir/]include}.  This is to help
12237 with boot-strapping the compiler.
12239 @item -no-canonical-prefixes
12240 @opindex no-canonical-prefixes
12241 Do not expand any symbolic links, resolve references to @samp{/../}
12242 or @samp{/./}, or make the path absolute when generating a relative
12243 prefix.
12245 @item --sysroot=@var{dir}
12246 @opindex sysroot
12247 Use @var{dir} as the logical root directory for headers and libraries.
12248 For example, if the compiler normally searches for headers in
12249 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12250 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12252 If you use both this option and the @option{-isysroot} option, then
12253 the @option{--sysroot} option applies to libraries, but the
12254 @option{-isysroot} option applies to header files.
12256 The GNU linker (beginning with version 2.16) has the necessary support
12257 for this option.  If your linker does not support this option, the
12258 header file aspect of @option{--sysroot} still works, but the
12259 library aspect does not.
12261 @item --no-sysroot-suffix
12262 @opindex no-sysroot-suffix
12263 For some targets, a suffix is added to the root directory specified
12264 with @option{--sysroot}, depending on the other options used, so that
12265 headers may for example be found in
12266 @file{@var{dir}/@var{suffix}/usr/include} instead of
12267 @file{@var{dir}/usr/include}.  This option disables the addition of
12268 such a suffix.
12270 @end table
12272 @node Code Gen Options
12273 @section Options for Code Generation Conventions
12274 @cindex code generation conventions
12275 @cindex options, code generation
12276 @cindex run-time options
12278 These machine-independent options control the interface conventions
12279 used in code generation.
12281 Most of them have both positive and negative forms; the negative form
12282 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12283 one of the forms is listed---the one that is not the default.  You
12284 can figure out the other form by either removing @samp{no-} or adding
12287 @table @gcctabopt
12288 @item -fstack-reuse=@var{reuse-level}
12289 @opindex fstack_reuse
12290 This option controls stack space reuse for user declared local/auto variables
12291 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12292 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12293 local variables and temporaries, @samp{named_vars} enables the reuse only for
12294 user defined local variables with names, and @samp{none} disables stack reuse
12295 completely. The default value is @samp{all}. The option is needed when the
12296 program extends the lifetime of a scoped local variable or a compiler generated
12297 temporary beyond the end point defined by the language.  When a lifetime of
12298 a variable ends, and if the variable lives in memory, the optimizing compiler
12299 has the freedom to reuse its stack space with other temporaries or scoped
12300 local variables whose live range does not overlap with it. Legacy code extending
12301 local lifetime is likely to break with the stack reuse optimization.
12303 For example,
12305 @smallexample
12306    int *p;
12307    @{
12308      int local1;
12310      p = &local1;
12311      local1 = 10;
12312      ....
12313    @}
12314    @{
12315       int local2;
12316       local2 = 20;
12317       ...
12318    @}
12320    if (*p == 10)  // out of scope use of local1
12321      @{
12323      @}
12324 @end smallexample
12326 Another example:
12327 @smallexample
12329    struct A
12330    @{
12331        A(int k) : i(k), j(k) @{ @}
12332        int i;
12333        int j;
12334    @};
12336    A *ap;
12338    void foo(const A& ar)
12339    @{
12340       ap = &ar;
12341    @}
12343    void bar()
12344    @{
12345       foo(A(10)); // temp object's lifetime ends when foo returns
12347       @{
12348         A a(20);
12349         ....
12350       @}
12351       ap->i+= 10;  // ap references out of scope temp whose space
12352                    // is reused with a. What is the value of ap->i?
12353    @}
12355 @end smallexample
12357 The lifetime of a compiler generated temporary is well defined by the C++
12358 standard. When a lifetime of a temporary ends, and if the temporary lives
12359 in memory, the optimizing compiler has the freedom to reuse its stack
12360 space with other temporaries or scoped local variables whose live range
12361 does not overlap with it. However some of the legacy code relies on
12362 the behavior of older compilers in which temporaries' stack space is
12363 not reused, the aggressive stack reuse can lead to runtime errors. This
12364 option is used to control the temporary stack reuse optimization.
12366 @item -ftrapv
12367 @opindex ftrapv
12368 This option generates traps for signed overflow on addition, subtraction,
12369 multiplication operations.
12370 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12371 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12372 @option{-fwrapv} being effective.  Note that only active options override, so
12373 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12374 results in @option{-ftrapv} being effective.
12376 @item -fwrapv
12377 @opindex fwrapv
12378 This option instructs the compiler to assume that signed arithmetic
12379 overflow of addition, subtraction and multiplication wraps around
12380 using twos-complement representation.  This flag enables some optimizations
12381 and disables others.
12382 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12383 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12384 @option{-fwrapv} being effective.  Note that only active options override, so
12385 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12386 results in @option{-ftrapv} being effective.
12388 @item -fexceptions
12389 @opindex fexceptions
12390 Enable exception handling.  Generates extra code needed to propagate
12391 exceptions.  For some targets, this implies GCC generates frame
12392 unwind information for all functions, which can produce significant data
12393 size overhead, although it does not affect execution.  If you do not
12394 specify this option, GCC enables it by default for languages like
12395 C++ that normally require exception handling, and disables it for
12396 languages like C that do not normally require it.  However, you may need
12397 to enable this option when compiling C code that needs to interoperate
12398 properly with exception handlers written in C++.  You may also wish to
12399 disable this option if you are compiling older C++ programs that don't
12400 use exception handling.
12402 @item -fnon-call-exceptions
12403 @opindex fnon-call-exceptions
12404 Generate code that allows trapping instructions to throw exceptions.
12405 Note that this requires platform-specific runtime support that does
12406 not exist everywhere.  Moreover, it only allows @emph{trapping}
12407 instructions to throw exceptions, i.e.@: memory references or floating-point
12408 instructions.  It does not allow exceptions to be thrown from
12409 arbitrary signal handlers such as @code{SIGALRM}.
12411 @item -fdelete-dead-exceptions
12412 @opindex fdelete-dead-exceptions
12413 Consider that instructions that may throw exceptions but don't otherwise
12414 contribute to the execution of the program can be optimized away.
12415 This option is enabled by default for the Ada front end, as permitted by
12416 the Ada language specification.
12417 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12419 @item -funwind-tables
12420 @opindex funwind-tables
12421 Similar to @option{-fexceptions}, except that it just generates any needed
12422 static data, but does not affect the generated code in any other way.
12423 You normally do not need to enable this option; instead, a language processor
12424 that needs this handling enables it on your behalf.
12426 @item -fasynchronous-unwind-tables
12427 @opindex fasynchronous-unwind-tables
12428 Generate unwind table in DWARF format, if supported by target machine.  The
12429 table is exact at each instruction boundary, so it can be used for stack
12430 unwinding from asynchronous events (such as debugger or garbage collector).
12432 @item -fno-gnu-unique
12433 @opindex fno-gnu-unique
12434 On systems with recent GNU assembler and C library, the C++ compiler
12435 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12436 of template static data members and static local variables in inline
12437 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12438 is necessary to avoid problems with a library used by two different
12439 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12440 therefore disagreeing with the other one about the binding of the
12441 symbol.  But this causes @code{dlclose} to be ignored for affected
12442 DSOs; if your program relies on reinitialization of a DSO via
12443 @code{dlclose} and @code{dlopen}, you can use
12444 @option{-fno-gnu-unique}.
12446 @item -fpcc-struct-return
12447 @opindex fpcc-struct-return
12448 Return ``short'' @code{struct} and @code{union} values in memory like
12449 longer ones, rather than in registers.  This convention is less
12450 efficient, but it has the advantage of allowing intercallability between
12451 GCC-compiled files and files compiled with other compilers, particularly
12452 the Portable C Compiler (pcc).
12454 The precise convention for returning structures in memory depends
12455 on the target configuration macros.
12457 Short structures and unions are those whose size and alignment match
12458 that of some integer type.
12460 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12461 switch is not binary compatible with code compiled with the
12462 @option{-freg-struct-return} switch.
12463 Use it to conform to a non-default application binary interface.
12465 @item -freg-struct-return
12466 @opindex freg-struct-return
12467 Return @code{struct} and @code{union} values in registers when possible.
12468 This is more efficient for small structures than
12469 @option{-fpcc-struct-return}.
12471 If you specify neither @option{-fpcc-struct-return} nor
12472 @option{-freg-struct-return}, GCC defaults to whichever convention is
12473 standard for the target.  If there is no standard convention, GCC
12474 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12475 the principal compiler.  In those cases, we can choose the standard, and
12476 we chose the more efficient register return alternative.
12478 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12479 switch is not binary compatible with code compiled with the
12480 @option{-fpcc-struct-return} switch.
12481 Use it to conform to a non-default application binary interface.
12483 @item -fshort-enums
12484 @opindex fshort-enums
12485 Allocate to an @code{enum} type only as many bytes as it needs for the
12486 declared range of possible values.  Specifically, the @code{enum} type
12487 is equivalent to the smallest integer type that has enough room.
12489 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12490 code that is not binary compatible with code generated without that switch.
12491 Use it to conform to a non-default application binary interface.
12493 @item -fshort-wchar
12494 @opindex fshort-wchar
12495 Override the underlying type for @code{wchar_t} to be @code{short
12496 unsigned int} instead of the default for the target.  This option is
12497 useful for building programs to run under WINE@.
12499 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12500 code that is not binary compatible with code generated without that switch.
12501 Use it to conform to a non-default application binary interface.
12503 @item -fno-common
12504 @opindex fno-common
12505 @cindex tentative definitions
12506 In C code, this option controls the placement of global variables 
12507 defined without an initializer, known as @dfn{tentative definitions} 
12508 in the C standard.  Tentative definitions are distinct from declarations 
12509 of a variable with the @code{extern} keyword, which do not allocate storage.
12511 Unix C compilers have traditionally allocated storage for
12512 uninitialized global variables in a common block.  This allows the
12513 linker to resolve all tentative definitions of the same variable
12514 in different compilation units to the same object, or to a non-tentative
12515 definition.  
12516 This is the behavior specified by @option{-fcommon}, and is the default for 
12517 GCC on most targets.  
12518 On the other hand, this behavior is not required by ISO
12519 C, and on some targets may carry a speed or code size penalty on
12520 variable references.
12522 The @option{-fno-common} option specifies that the compiler should instead
12523 place uninitialized global variables in the data section of the object file.
12524 This inhibits the merging of tentative definitions by the linker so
12525 you get a multiple-definition error if the same 
12526 variable is defined in more than one compilation unit.
12527 Compiling with @option{-fno-common} is useful on targets for which
12528 it provides better performance, or if you wish to verify that the
12529 program will work on other systems that always treat uninitialized
12530 variable definitions this way.
12532 @item -fno-ident
12533 @opindex fno-ident
12534 Ignore the @code{#ident} directive.
12536 @item -finhibit-size-directive
12537 @opindex finhibit-size-directive
12538 Don't output a @code{.size} assembler directive, or anything else that
12539 would cause trouble if the function is split in the middle, and the
12540 two halves are placed at locations far apart in memory.  This option is
12541 used when compiling @file{crtstuff.c}; you should not need to use it
12542 for anything else.
12544 @item -fverbose-asm
12545 @opindex fverbose-asm
12546 Put extra commentary information in the generated assembly code to
12547 make it more readable.  This option is generally only of use to those
12548 who actually need to read the generated assembly code (perhaps while
12549 debugging the compiler itself).
12551 @option{-fno-verbose-asm}, the default, causes the
12552 extra information to be omitted and is useful when comparing two assembler
12553 files.
12555 The added comments include:
12557 @itemize @bullet
12559 @item
12560 information on the compiler version and command-line options,
12562 @item
12563 the source code lines associated with the assembly instructions,
12564 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12566 @item
12567 hints on which high-level expressions correspond to
12568 the various assembly instruction operands.
12570 @end itemize
12572 For example, given this C source file:
12574 @smallexample
12575 int test (int n)
12577   int i;
12578   int total = 0;
12580   for (i = 0; i < n; i++)
12581     total += i * i;
12583   return total;
12585 @end smallexample
12587 compiling to (x86_64) assembly via @option{-S} and emitting the result
12588 direct to stdout via @option{-o} @option{-}
12590 @smallexample
12591 gcc -S test.c -fverbose-asm -Os -o -
12592 @end smallexample
12594 gives output similar to this:
12596 @smallexample
12597         .file   "test.c"
12598 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12599   [...snip...]
12600 # options passed:
12601   [...snip...]
12603         .text
12604         .globl  test
12605         .type   test, @@function
12606 test:
12607 .LFB0:
12608         .cfi_startproc
12609 # test.c:4:   int total = 0;
12610         xorl    %eax, %eax      # <retval>
12611 # test.c:6:   for (i = 0; i < n; i++)
12612         xorl    %edx, %edx      # i
12613 .L2:
12614 # test.c:6:   for (i = 0; i < n; i++)
12615         cmpl    %edi, %edx      # n, i
12616         jge     .L5     #,
12617 # test.c:7:     total += i * i;
12618         movl    %edx, %ecx      # i, tmp92
12619         imull   %edx, %ecx      # i, tmp92
12620 # test.c:6:   for (i = 0; i < n; i++)
12621         incl    %edx    # i
12622 # test.c:7:     total += i * i;
12623         addl    %ecx, %eax      # tmp92, <retval>
12624         jmp     .L2     #
12625 .L5:
12626 # test.c:10: @}
12627         ret
12628         .cfi_endproc
12629 .LFE0:
12630         .size   test, .-test
12631         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12632         .section        .note.GNU-stack,"",@@progbits
12633 @end smallexample
12635 The comments are intended for humans rather than machines and hence the
12636 precise format of the comments is subject to change.
12638 @item -frecord-gcc-switches
12639 @opindex frecord-gcc-switches
12640 This switch causes the command line used to invoke the
12641 compiler to be recorded into the object file that is being created.
12642 This switch is only implemented on some targets and the exact format
12643 of the recording is target and binary file format dependent, but it
12644 usually takes the form of a section containing ASCII text.  This
12645 switch is related to the @option{-fverbose-asm} switch, but that
12646 switch only records information in the assembler output file as
12647 comments, so it never reaches the object file.
12648 See also @option{-grecord-gcc-switches} for another
12649 way of storing compiler options into the object file.
12651 @item -fpic
12652 @opindex fpic
12653 @cindex global offset table
12654 @cindex PIC
12655 Generate position-independent code (PIC) suitable for use in a shared
12656 library, if supported for the target machine.  Such code accesses all
12657 constant addresses through a global offset table (GOT)@.  The dynamic
12658 loader resolves the GOT entries when the program starts (the dynamic
12659 loader is not part of GCC; it is part of the operating system).  If
12660 the GOT size for the linked executable exceeds a machine-specific
12661 maximum size, you get an error message from the linker indicating that
12662 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12663 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12664 on the m68k and RS/6000.  The x86 has no such limit.)
12666 Position-independent code requires special support, and therefore works
12667 only on certain machines.  For the x86, GCC supports PIC for System V
12668 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12669 position-independent.
12671 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12672 are defined to 1.
12674 @item -fPIC
12675 @opindex fPIC
12676 If supported for the target machine, emit position-independent code,
12677 suitable for dynamic linking and avoiding any limit on the size of the
12678 global offset table.  This option makes a difference on AArch64, m68k,
12679 PowerPC and SPARC@.
12681 Position-independent code requires special support, and therefore works
12682 only on certain machines.
12684 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12685 are defined to 2.
12687 @item -fpie
12688 @itemx -fPIE
12689 @opindex fpie
12690 @opindex fPIE
12691 These options are similar to @option{-fpic} and @option{-fPIC}, but
12692 generated position independent code can be only linked into executables.
12693 Usually these options are used when @option{-pie} GCC option is
12694 used during linking.
12696 @option{-fpie} and @option{-fPIE} both define the macros
12697 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12698 for @option{-fpie} and 2 for @option{-fPIE}.
12700 @item -fno-plt
12701 @opindex fno-plt
12702 Do not use the PLT for external function calls in position-independent code.
12703 Instead, load the callee address at call sites from the GOT and branch to it.
12704 This leads to more efficient code by eliminating PLT stubs and exposing
12705 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12706 PLT stubs expect the GOT pointer in a specific register, this gives more
12707 register allocation freedom to the compiler.
12708 Lazy binding requires use of the PLT; 
12709 with @option{-fno-plt} all external symbols are resolved at load time.
12711 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12712 through the PLT for specific external functions.
12714 In position-dependent code, a few targets also convert calls to
12715 functions that are marked to not use the PLT to use the GOT instead.
12717 @item -fno-jump-tables
12718 @opindex fno-jump-tables
12719 Do not use jump tables for switch statements even where it would be
12720 more efficient than other code generation strategies.  This option is
12721 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12722 building code that forms part of a dynamic linker and cannot
12723 reference the address of a jump table.  On some targets, jump tables
12724 do not require a GOT and this option is not needed.
12726 @item -ffixed-@var{reg}
12727 @opindex ffixed
12728 Treat the register named @var{reg} as a fixed register; generated code
12729 should never refer to it (except perhaps as a stack pointer, frame
12730 pointer or in some other fixed role).
12732 @var{reg} must be the name of a register.  The register names accepted
12733 are machine-specific and are defined in the @code{REGISTER_NAMES}
12734 macro in the machine description macro file.
12736 This flag does not have a negative form, because it specifies a
12737 three-way choice.
12739 @item -fcall-used-@var{reg}
12740 @opindex fcall-used
12741 Treat the register named @var{reg} as an allocable register that is
12742 clobbered by function calls.  It may be allocated for temporaries or
12743 variables that do not live across a call.  Functions compiled this way
12744 do not save and restore the register @var{reg}.
12746 It is an error to use this flag with the frame pointer or stack pointer.
12747 Use of this flag for other registers that have fixed pervasive roles in
12748 the machine's execution model produces disastrous results.
12750 This flag does not have a negative form, because it specifies a
12751 three-way choice.
12753 @item -fcall-saved-@var{reg}
12754 @opindex fcall-saved
12755 Treat the register named @var{reg} as an allocable register saved by
12756 functions.  It may be allocated even for temporaries or variables that
12757 live across a call.  Functions compiled this way save and restore
12758 the register @var{reg} if they use it.
12760 It is an error to use this flag with the frame pointer or stack pointer.
12761 Use of this flag for other registers that have fixed pervasive roles in
12762 the machine's execution model produces disastrous results.
12764 A different sort of disaster results from the use of this flag for
12765 a register in which function values may be returned.
12767 This flag does not have a negative form, because it specifies a
12768 three-way choice.
12770 @item -fpack-struct[=@var{n}]
12771 @opindex fpack-struct
12772 Without a value specified, pack all structure members together without
12773 holes.  When a value is specified (which must be a small power of two), pack
12774 structure members according to this value, representing the maximum
12775 alignment (that is, objects with default alignment requirements larger than
12776 this are output potentially unaligned at the next fitting location.
12778 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12779 code that is not binary compatible with code generated without that switch.
12780 Additionally, it makes the code suboptimal.
12781 Use it to conform to a non-default application binary interface.
12783 @item -fleading-underscore
12784 @opindex fleading-underscore
12785 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12786 change the way C symbols are represented in the object file.  One use
12787 is to help link with legacy assembly code.
12789 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12790 generate code that is not binary compatible with code generated without that
12791 switch.  Use it to conform to a non-default application binary interface.
12792 Not all targets provide complete support for this switch.
12794 @item -ftls-model=@var{model}
12795 @opindex ftls-model
12796 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12797 The @var{model} argument should be one of @samp{global-dynamic},
12798 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12799 Note that the choice is subject to optimization: the compiler may use
12800 a more efficient model for symbols not visible outside of the translation
12801 unit, or if @option{-fpic} is not given on the command line.
12803 The default without @option{-fpic} is @samp{initial-exec}; with
12804 @option{-fpic} the default is @samp{global-dynamic}.
12806 @item -ftrampolines
12807 @opindex ftrampolines
12808 For targets that normally need trampolines for nested functions, always
12809 generate them instead of using descriptors.  Otherwise, for targets that
12810 do not need them, like for example HP-PA or IA-64, do nothing.
12812 A trampoline is a small piece of code that is created at run time on the
12813 stack when the address of a nested function is taken, and is used to call
12814 the nested function indirectly.  Therefore, it requires the stack to be
12815 made executable in order for the program to work properly.
12817 @option{-fno-trampolines} is enabled by default on a language by language
12818 basis to let the compiler avoid generating them, if it computes that this
12819 is safe, and replace them with descriptors.  Descriptors are made up of data
12820 only, but the generated code must be prepared to deal with them.  As of this
12821 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12823 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12824 @option{-fno-trampolines} are not binary compatible if nested functions are
12825 present.  This option must therefore be used on a program-wide basis and be
12826 manipulated with extreme care.
12828 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12829 @opindex fvisibility
12830 Set the default ELF image symbol visibility to the specified option---all
12831 symbols are marked with this unless overridden within the code.
12832 Using this feature can very substantially improve linking and
12833 load times of shared object libraries, produce more optimized
12834 code, provide near-perfect API export and prevent symbol clashes.
12835 It is @strong{strongly} recommended that you use this in any shared objects
12836 you distribute.
12838 Despite the nomenclature, @samp{default} always means public; i.e.,
12839 available to be linked against from outside the shared object.
12840 @samp{protected} and @samp{internal} are pretty useless in real-world
12841 usage so the only other commonly used option is @samp{hidden}.
12842 The default if @option{-fvisibility} isn't specified is
12843 @samp{default}, i.e., make every symbol public.
12845 A good explanation of the benefits offered by ensuring ELF
12846 symbols have the correct visibility is given by ``How To Write
12847 Shared Libraries'' by Ulrich Drepper (which can be found at
12848 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12849 solution made possible by this option to marking things hidden when
12850 the default is public is to make the default hidden and mark things
12851 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12852 and @code{__attribute__ ((visibility("default")))} instead of
12853 @code{__declspec(dllexport)} you get almost identical semantics with
12854 identical syntax.  This is a great boon to those working with
12855 cross-platform projects.
12857 For those adding visibility support to existing code, you may find
12858 @code{#pragma GCC visibility} of use.  This works by you enclosing
12859 the declarations you wish to set visibility for with (for example)
12860 @code{#pragma GCC visibility push(hidden)} and
12861 @code{#pragma GCC visibility pop}.
12862 Bear in mind that symbol visibility should be viewed @strong{as
12863 part of the API interface contract} and thus all new code should
12864 always specify visibility when it is not the default; i.e., declarations
12865 only for use within the local DSO should @strong{always} be marked explicitly
12866 as hidden as so to avoid PLT indirection overheads---making this
12867 abundantly clear also aids readability and self-documentation of the code.
12868 Note that due to ISO C++ specification requirements, @code{operator new} and
12869 @code{operator delete} must always be of default visibility.
12871 Be aware that headers from outside your project, in particular system
12872 headers and headers from any other library you use, may not be
12873 expecting to be compiled with visibility other than the default.  You
12874 may need to explicitly say @code{#pragma GCC visibility push(default)}
12875 before including any such headers.
12877 @code{extern} declarations are not affected by @option{-fvisibility}, so
12878 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12879 no modifications.  However, this means that calls to @code{extern}
12880 functions with no explicit visibility use the PLT, so it is more
12881 effective to use @code{__attribute ((visibility))} and/or
12882 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12883 declarations should be treated as hidden.
12885 Note that @option{-fvisibility} does affect C++ vague linkage
12886 entities. This means that, for instance, an exception class that is
12887 be thrown between DSOs must be explicitly marked with default
12888 visibility so that the @samp{type_info} nodes are unified between
12889 the DSOs.
12891 An overview of these techniques, their benefits and how to use them
12892 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12894 @item -fstrict-volatile-bitfields
12895 @opindex fstrict-volatile-bitfields
12896 This option should be used if accesses to volatile bit-fields (or other
12897 structure fields, although the compiler usually honors those types
12898 anyway) should use a single access of the width of the
12899 field's type, aligned to a natural alignment if possible.  For
12900 example, targets with memory-mapped peripheral registers might require
12901 all such accesses to be 16 bits wide; with this flag you can
12902 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12903 is 16 bits on these targets) to force GCC to use 16-bit accesses
12904 instead of, perhaps, a more efficient 32-bit access.
12906 If this option is disabled, the compiler uses the most efficient
12907 instruction.  In the previous example, that might be a 32-bit load
12908 instruction, even though that accesses bytes that do not contain
12909 any portion of the bit-field, or memory-mapped registers unrelated to
12910 the one being updated.
12912 In some cases, such as when the @code{packed} attribute is applied to a 
12913 structure field, it may not be possible to access the field with a single
12914 read or write that is correctly aligned for the target machine.  In this
12915 case GCC falls back to generating multiple accesses rather than code that 
12916 will fault or truncate the result at run time.
12918 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12919 not allowed to touch non bit-field members.  It is therefore recommended
12920 to define all bits of the field's type as bit-field members.
12922 The default value of this option is determined by the application binary
12923 interface for the target processor.
12925 @item -fsync-libcalls
12926 @opindex fsync-libcalls
12927 This option controls whether any out-of-line instance of the @code{__sync}
12928 family of functions may be used to implement the C++11 @code{__atomic}
12929 family of functions.
12931 The default value of this option is enabled, thus the only useful form
12932 of the option is @option{-fno-sync-libcalls}.  This option is used in
12933 the implementation of the @file{libatomic} runtime library.
12935 @end table
12937 @node Developer Options
12938 @section GCC Developer Options
12939 @cindex developer options
12940 @cindex debugging GCC
12941 @cindex debug dump options
12942 @cindex dump options
12943 @cindex compilation statistics
12945 This section describes command-line options that are primarily of
12946 interest to GCC developers, including options to support compiler
12947 testing and investigation of compiler bugs and compile-time
12948 performance problems.  This includes options that produce debug dumps
12949 at various points in the compilation; that print statistics such as
12950 memory use and execution time; and that print information about GCC's
12951 configuration, such as where it searches for libraries.  You should
12952 rarely need to use any of these options for ordinary compilation and
12953 linking tasks.
12955 @table @gcctabopt
12957 @item -d@var{letters}
12958 @itemx -fdump-rtl-@var{pass}
12959 @itemx -fdump-rtl-@var{pass}=@var{filename}
12960 @opindex d
12961 @opindex fdump-rtl-@var{pass}
12962 Says to make debugging dumps during compilation at times specified by
12963 @var{letters}.  This is used for debugging the RTL-based passes of the
12964 compiler.  The file names for most of the dumps are made by appending
12965 a pass number and a word to the @var{dumpname}, and the files are
12966 created in the directory of the output file.  In case of
12967 @option{=@var{filename}} option, the dump is output on the given file
12968 instead of the pass numbered dump files.  Note that the pass number is
12969 assigned as passes are registered into the pass manager.  Most passes
12970 are registered in the order that they will execute and for these passes
12971 the number corresponds to the pass execution order.  However, passes
12972 registered by plugins, passes specific to compilation targets, or
12973 passes that are otherwise registered after all the other passes are
12974 numbered higher than a pass named "final", even if they are executed
12975 earlier.  @var{dumpname} is generated from the name of the output
12976 file if explicitly specified and not an executable, otherwise it is
12977 the basename of the source file.  
12979 Some @option{-d@var{letters}} switches have different meaning when
12980 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12981 for information about preprocessor-specific dump options.
12983 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12984 @option{-d} option @var{letters}.  Here are the possible
12985 letters for use in @var{pass} and @var{letters}, and their meanings:
12987 @table @gcctabopt
12989 @item -fdump-rtl-alignments
12990 @opindex fdump-rtl-alignments
12991 Dump after branch alignments have been computed.
12993 @item -fdump-rtl-asmcons
12994 @opindex fdump-rtl-asmcons
12995 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12997 @item -fdump-rtl-auto_inc_dec
12998 @opindex fdump-rtl-auto_inc_dec
12999 Dump after auto-inc-dec discovery.  This pass is only run on
13000 architectures that have auto inc or auto dec instructions.
13002 @item -fdump-rtl-barriers
13003 @opindex fdump-rtl-barriers
13004 Dump after cleaning up the barrier instructions.
13006 @item -fdump-rtl-bbpart
13007 @opindex fdump-rtl-bbpart
13008 Dump after partitioning hot and cold basic blocks.
13010 @item -fdump-rtl-bbro
13011 @opindex fdump-rtl-bbro
13012 Dump after block reordering.
13014 @item -fdump-rtl-btl1
13015 @itemx -fdump-rtl-btl2
13016 @opindex fdump-rtl-btl2
13017 @opindex fdump-rtl-btl2
13018 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13019 after the two branch
13020 target load optimization passes.
13022 @item -fdump-rtl-bypass
13023 @opindex fdump-rtl-bypass
13024 Dump after jump bypassing and control flow optimizations.
13026 @item -fdump-rtl-combine
13027 @opindex fdump-rtl-combine
13028 Dump after the RTL instruction combination pass.
13030 @item -fdump-rtl-compgotos
13031 @opindex fdump-rtl-compgotos
13032 Dump after duplicating the computed gotos.
13034 @item -fdump-rtl-ce1
13035 @itemx -fdump-rtl-ce2
13036 @itemx -fdump-rtl-ce3
13037 @opindex fdump-rtl-ce1
13038 @opindex fdump-rtl-ce2
13039 @opindex fdump-rtl-ce3
13040 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13041 @option{-fdump-rtl-ce3} enable dumping after the three
13042 if conversion passes.
13044 @item -fdump-rtl-cprop_hardreg
13045 @opindex fdump-rtl-cprop_hardreg
13046 Dump after hard register copy propagation.
13048 @item -fdump-rtl-csa
13049 @opindex fdump-rtl-csa
13050 Dump after combining stack adjustments.
13052 @item -fdump-rtl-cse1
13053 @itemx -fdump-rtl-cse2
13054 @opindex fdump-rtl-cse1
13055 @opindex fdump-rtl-cse2
13056 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13057 the two common subexpression elimination passes.
13059 @item -fdump-rtl-dce
13060 @opindex fdump-rtl-dce
13061 Dump after the standalone dead code elimination passes.
13063 @item -fdump-rtl-dbr
13064 @opindex fdump-rtl-dbr
13065 Dump after delayed branch scheduling.
13067 @item -fdump-rtl-dce1
13068 @itemx -fdump-rtl-dce2
13069 @opindex fdump-rtl-dce1
13070 @opindex fdump-rtl-dce2
13071 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13072 the two dead store elimination passes.
13074 @item -fdump-rtl-eh
13075 @opindex fdump-rtl-eh
13076 Dump after finalization of EH handling code.
13078 @item -fdump-rtl-eh_ranges
13079 @opindex fdump-rtl-eh_ranges
13080 Dump after conversion of EH handling range regions.
13082 @item -fdump-rtl-expand
13083 @opindex fdump-rtl-expand
13084 Dump after RTL generation.
13086 @item -fdump-rtl-fwprop1
13087 @itemx -fdump-rtl-fwprop2
13088 @opindex fdump-rtl-fwprop1
13089 @opindex fdump-rtl-fwprop2
13090 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13091 dumping after the two forward propagation passes.
13093 @item -fdump-rtl-gcse1
13094 @itemx -fdump-rtl-gcse2
13095 @opindex fdump-rtl-gcse1
13096 @opindex fdump-rtl-gcse2
13097 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13098 after global common subexpression elimination.
13100 @item -fdump-rtl-init-regs
13101 @opindex fdump-rtl-init-regs
13102 Dump after the initialization of the registers.
13104 @item -fdump-rtl-initvals
13105 @opindex fdump-rtl-initvals
13106 Dump after the computation of the initial value sets.
13108 @item -fdump-rtl-into_cfglayout
13109 @opindex fdump-rtl-into_cfglayout
13110 Dump after converting to cfglayout mode.
13112 @item -fdump-rtl-ira
13113 @opindex fdump-rtl-ira
13114 Dump after iterated register allocation.
13116 @item -fdump-rtl-jump
13117 @opindex fdump-rtl-jump
13118 Dump after the second jump optimization.
13120 @item -fdump-rtl-loop2
13121 @opindex fdump-rtl-loop2
13122 @option{-fdump-rtl-loop2} enables dumping after the rtl
13123 loop optimization passes.
13125 @item -fdump-rtl-mach
13126 @opindex fdump-rtl-mach
13127 Dump after performing the machine dependent reorganization pass, if that
13128 pass exists.
13130 @item -fdump-rtl-mode_sw
13131 @opindex fdump-rtl-mode_sw
13132 Dump after removing redundant mode switches.
13134 @item -fdump-rtl-rnreg
13135 @opindex fdump-rtl-rnreg
13136 Dump after register renumbering.
13138 @item -fdump-rtl-outof_cfglayout
13139 @opindex fdump-rtl-outof_cfglayout
13140 Dump after converting from cfglayout mode.
13142 @item -fdump-rtl-peephole2
13143 @opindex fdump-rtl-peephole2
13144 Dump after the peephole pass.
13146 @item -fdump-rtl-postreload
13147 @opindex fdump-rtl-postreload
13148 Dump after post-reload optimizations.
13150 @item -fdump-rtl-pro_and_epilogue
13151 @opindex fdump-rtl-pro_and_epilogue
13152 Dump after generating the function prologues and epilogues.
13154 @item -fdump-rtl-sched1
13155 @itemx -fdump-rtl-sched2
13156 @opindex fdump-rtl-sched1
13157 @opindex fdump-rtl-sched2
13158 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13159 after the basic block scheduling passes.
13161 @item -fdump-rtl-ree
13162 @opindex fdump-rtl-ree
13163 Dump after sign/zero extension elimination.
13165 @item -fdump-rtl-seqabstr
13166 @opindex fdump-rtl-seqabstr
13167 Dump after common sequence discovery.
13169 @item -fdump-rtl-shorten
13170 @opindex fdump-rtl-shorten
13171 Dump after shortening branches.
13173 @item -fdump-rtl-sibling
13174 @opindex fdump-rtl-sibling
13175 Dump after sibling call optimizations.
13177 @item -fdump-rtl-split1
13178 @itemx -fdump-rtl-split2
13179 @itemx -fdump-rtl-split3
13180 @itemx -fdump-rtl-split4
13181 @itemx -fdump-rtl-split5
13182 @opindex fdump-rtl-split1
13183 @opindex fdump-rtl-split2
13184 @opindex fdump-rtl-split3
13185 @opindex fdump-rtl-split4
13186 @opindex fdump-rtl-split5
13187 These options enable dumping after five rounds of
13188 instruction splitting.
13190 @item -fdump-rtl-sms
13191 @opindex fdump-rtl-sms
13192 Dump after modulo scheduling.  This pass is only run on some
13193 architectures.
13195 @item -fdump-rtl-stack
13196 @opindex fdump-rtl-stack
13197 Dump after conversion from GCC's ``flat register file'' registers to the
13198 x87's stack-like registers.  This pass is only run on x86 variants.
13200 @item -fdump-rtl-subreg1
13201 @itemx -fdump-rtl-subreg2
13202 @opindex fdump-rtl-subreg1
13203 @opindex fdump-rtl-subreg2
13204 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13205 the two subreg expansion passes.
13207 @item -fdump-rtl-unshare
13208 @opindex fdump-rtl-unshare
13209 Dump after all rtl has been unshared.
13211 @item -fdump-rtl-vartrack
13212 @opindex fdump-rtl-vartrack
13213 Dump after variable tracking.
13215 @item -fdump-rtl-vregs
13216 @opindex fdump-rtl-vregs
13217 Dump after converting virtual registers to hard registers.
13219 @item -fdump-rtl-web
13220 @opindex fdump-rtl-web
13221 Dump after live range splitting.
13223 @item -fdump-rtl-regclass
13224 @itemx -fdump-rtl-subregs_of_mode_init
13225 @itemx -fdump-rtl-subregs_of_mode_finish
13226 @itemx -fdump-rtl-dfinit
13227 @itemx -fdump-rtl-dfinish
13228 @opindex fdump-rtl-regclass
13229 @opindex fdump-rtl-subregs_of_mode_init
13230 @opindex fdump-rtl-subregs_of_mode_finish
13231 @opindex fdump-rtl-dfinit
13232 @opindex fdump-rtl-dfinish
13233 These dumps are defined but always produce empty files.
13235 @item -da
13236 @itemx -fdump-rtl-all
13237 @opindex da
13238 @opindex fdump-rtl-all
13239 Produce all the dumps listed above.
13241 @item -dA
13242 @opindex dA
13243 Annotate the assembler output with miscellaneous debugging information.
13245 @item -dD
13246 @opindex dD
13247 Dump all macro definitions, at the end of preprocessing, in addition to
13248 normal output.
13250 @item -dH
13251 @opindex dH
13252 Produce a core dump whenever an error occurs.
13254 @item -dp
13255 @opindex dp
13256 Annotate the assembler output with a comment indicating which
13257 pattern and alternative is used.  The length of each instruction is
13258 also printed.
13260 @item -dP
13261 @opindex dP
13262 Dump the RTL in the assembler output as a comment before each instruction.
13263 Also turns on @option{-dp} annotation.
13265 @item -dx
13266 @opindex dx
13267 Just generate RTL for a function instead of compiling it.  Usually used
13268 with @option{-fdump-rtl-expand}.
13269 @end table
13271 @item -fdump-noaddr
13272 @opindex fdump-noaddr
13273 When doing debugging dumps, suppress address output.  This makes it more
13274 feasible to use diff on debugging dumps for compiler invocations with
13275 different compiler binaries and/or different
13276 text / bss / data / heap / stack / dso start locations.
13278 @item -freport-bug
13279 @opindex freport-bug
13280 Collect and dump debug information into a temporary file if an
13281 internal compiler error (ICE) occurs.
13283 @item -fdump-unnumbered
13284 @opindex fdump-unnumbered
13285 When doing debugging dumps, suppress instruction numbers and address output.
13286 This makes it more feasible to use diff on debugging dumps for compiler
13287 invocations with different options, in particular with and without
13288 @option{-g}.
13290 @item -fdump-unnumbered-links
13291 @opindex fdump-unnumbered-links
13292 When doing debugging dumps (see @option{-d} option above), suppress
13293 instruction numbers for the links to the previous and next instructions
13294 in a sequence.
13296 @item -fdump-ipa-@var{switch}
13297 @opindex fdump-ipa
13298 Control the dumping at various stages of inter-procedural analysis
13299 language tree to a file.  The file name is generated by appending a
13300 switch specific suffix to the source file name, and the file is created
13301 in the same directory as the output file.  The following dumps are
13302 possible:
13304 @table @samp
13305 @item all
13306 Enables all inter-procedural analysis dumps.
13308 @item cgraph
13309 Dumps information about call-graph optimization, unused function removal,
13310 and inlining decisions.
13312 @item inline
13313 Dump after function inlining.
13315 @end table
13317 @item -fdump-lang-all
13318 @itemx -fdump-lang-@var{switch}
13319 @itemx -fdump-lang-@var{switch}-@var{options}
13320 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13321 @opindex fdump-lang-all
13322 @opindex fdump-lang
13323 Control the dumping of language-specific information.  The @var{options}
13324 and @var{filename} portions behave as described in the
13325 @option{-fdump-tree} option.  The following @var{switch} values are
13326 accepted:
13328 @table @samp
13329 @item all
13331 Enable all language-specific dumps.
13333 @item class
13334 Dump class hierarchy information.  Virtual table information is emitted
13335 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13337 @item raw
13338 Dump the raw internal tree data.  This option is applicable to C++ only.
13340 @end table
13342 @item -fdump-passes
13343 @opindex fdump-passes
13344 Print on @file{stderr} the list of optimization passes that are turned
13345 on and off by the current command-line options.
13347 @item -fdump-statistics-@var{option}
13348 @opindex fdump-statistics
13349 Enable and control dumping of pass statistics in a separate file.  The
13350 file name is generated by appending a suffix ending in
13351 @samp{.statistics} to the source file name, and the file is created in
13352 the same directory as the output file.  If the @samp{-@var{option}}
13353 form is used, @samp{-stats} causes counters to be summed over the
13354 whole compilation unit while @samp{-details} dumps every event as
13355 the passes generate them.  The default with no option is to sum
13356 counters for each function compiled.
13358 @item -fdump-tree-all
13359 @itemx -fdump-tree-@var{switch}
13360 @itemx -fdump-tree-@var{switch}-@var{options}
13361 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13362 @opindex fdump-tree-all
13363 @opindex fdump-tree
13364 Control the dumping at various stages of processing the intermediate
13365 language tree to a file.  The file name is generated by appending a
13366 switch-specific suffix to the source file name, and the file is
13367 created in the same directory as the output file. In case of
13368 @option{=@var{filename}} option, the dump is output on the given file
13369 instead of the auto named dump files.  If the @samp{-@var{options}}
13370 form is used, @var{options} is a list of @samp{-} separated options
13371 which control the details of the dump.  Not all options are applicable
13372 to all dumps; those that are not meaningful are ignored.  The
13373 following options are available
13375 @table @samp
13376 @item address
13377 Print the address of each node.  Usually this is not meaningful as it
13378 changes according to the environment and source file.  Its primary use
13379 is for tying up a dump file with a debug environment.
13380 @item asmname
13381 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13382 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13383 use working backward from mangled names in the assembly file.
13384 @item slim
13385 When dumping front-end intermediate representations, inhibit dumping
13386 of members of a scope or body of a function merely because that scope
13387 has been reached.  Only dump such items when they are directly reachable
13388 by some other path.
13390 When dumping pretty-printed trees, this option inhibits dumping the
13391 bodies of control structures.
13393 When dumping RTL, print the RTL in slim (condensed) form instead of
13394 the default LISP-like representation.
13395 @item raw
13396 Print a raw representation of the tree.  By default, trees are
13397 pretty-printed into a C-like representation.
13398 @item details
13399 Enable more detailed dumps (not honored by every dump option). Also
13400 include information from the optimization passes.
13401 @item stats
13402 Enable dumping various statistics about the pass (not honored by every dump
13403 option).
13404 @item blocks
13405 Enable showing basic block boundaries (disabled in raw dumps).
13406 @item graph
13407 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13408 dump a representation of the control flow graph suitable for viewing with
13409 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13410 the file is pretty-printed as a subgraph, so that GraphViz can render them
13411 all in a single plot.
13413 This option currently only works for RTL dumps, and the RTL is always
13414 dumped in slim form.
13415 @item vops
13416 Enable showing virtual operands for every statement.
13417 @item lineno
13418 Enable showing line numbers for statements.
13419 @item uid
13420 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13421 @item verbose
13422 Enable showing the tree dump for each statement.
13423 @item eh
13424 Enable showing the EH region number holding each statement.
13425 @item scev
13426 Enable showing scalar evolution analysis details.
13427 @item optimized
13428 Enable showing optimization information (only available in certain
13429 passes).
13430 @item missed
13431 Enable showing missed optimization information (only available in certain
13432 passes).
13433 @item note
13434 Enable other detailed optimization information (only available in
13435 certain passes).
13436 @item =@var{filename}
13437 Instead of an auto named dump file, output into the given file
13438 name. The file names @file{stdout} and @file{stderr} are treated
13439 specially and are considered already open standard streams. For
13440 example,
13442 @smallexample
13443 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13444      -fdump-tree-pre=/dev/stderr file.c
13445 @end smallexample
13447 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13448 output on to @file{stderr}. If two conflicting dump filenames are
13449 given for the same pass, then the latter option overrides the earlier
13450 one.
13452 @item all
13453 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13454 and @option{lineno}.
13456 @item optall
13457 Turn on all optimization options, i.e., @option{optimized},
13458 @option{missed}, and @option{note}.
13459 @end table
13461 To determine what tree dumps are available or find the dump for a pass
13462 of interest follow the steps below.
13464 @enumerate
13465 @item
13466 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13467 look for a code that corresponds to the pass you are interested in.
13468 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13469 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13470 The number at the end distinguishes distinct invocations of the same pass.
13471 @item
13472 To enable the creation of the dump file, append the pass code to
13473 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13474 to enable the dump from the Early Value Range Propagation pass, invoke
13475 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13476 specify the name of the dump file.  If you don't specify one, GCC
13477 creates as described below.
13478 @item
13479 Find the pass dump in a file whose name is composed of three components
13480 separated by a period: the name of the source file GCC was invoked to
13481 compile, a numeric suffix indicating the pass number followed by the
13482 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13483 and finally the pass code.  For example, the Early VRP pass dump might
13484 be in a file named @file{myfile.c.038t.evrp} in the current working
13485 directory.  Note that the numeric codes are not stable and may change
13486 from one version of GCC to another.
13487 @end enumerate
13489 @item -fopt-info
13490 @itemx -fopt-info-@var{options}
13491 @itemx -fopt-info-@var{options}=@var{filename}
13492 @opindex fopt-info
13493 Controls optimization dumps from various optimization passes. If the
13494 @samp{-@var{options}} form is used, @var{options} is a list of
13495 @samp{-} separated option keywords to select the dump details and
13496 optimizations.  
13498 The @var{options} can be divided into two groups: options describing the
13499 verbosity of the dump, and options describing which optimizations
13500 should be included. The options from both the groups can be freely
13501 mixed as they are non-overlapping. However, in case of any conflicts,
13502 the later options override the earlier options on the command
13503 line. 
13505 The following options control the dump verbosity:
13507 @table @samp
13508 @item optimized
13509 Print information when an optimization is successfully applied. It is
13510 up to a pass to decide which information is relevant. For example, the
13511 vectorizer passes print the source location of loops which are
13512 successfully vectorized.
13513 @item missed
13514 Print information about missed optimizations. Individual passes
13515 control which information to include in the output. 
13516 @item note
13517 Print verbose information about optimizations, such as certain
13518 transformations, more detailed messages about decisions etc.
13519 @item all
13520 Print detailed optimization information. This includes
13521 @samp{optimized}, @samp{missed}, and @samp{note}.
13522 @end table
13524 One or more of the following option keywords can be used to describe a
13525 group of optimizations:
13527 @table @samp
13528 @item ipa
13529 Enable dumps from all interprocedural optimizations.
13530 @item loop
13531 Enable dumps from all loop optimizations.
13532 @item inline
13533 Enable dumps from all inlining optimizations.
13534 @item omp
13535 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13536 @item vec
13537 Enable dumps from all vectorization optimizations.
13538 @item optall
13539 Enable dumps from all optimizations. This is a superset of
13540 the optimization groups listed above.
13541 @end table
13543 If @var{options} is
13544 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13545 info about successful optimizations from all the passes.  
13547 If the @var{filename} is provided, then the dumps from all the
13548 applicable optimizations are concatenated into the @var{filename}.
13549 Otherwise the dump is output onto @file{stderr}. Though multiple
13550 @option{-fopt-info} options are accepted, only one of them can include
13551 a @var{filename}. If other filenames are provided then all but the
13552 first such option are ignored.
13554 Note that the output @var{filename} is overwritten
13555 in case of multiple translation units. If a combined output from
13556 multiple translation units is desired, @file{stderr} should be used
13557 instead.
13559 In the following example, the optimization info is output to
13560 @file{stderr}:
13562 @smallexample
13563 gcc -O3 -fopt-info
13564 @end smallexample
13566 This example:
13567 @smallexample
13568 gcc -O3 -fopt-info-missed=missed.all
13569 @end smallexample
13571 @noindent
13572 outputs missed optimization report from all the passes into
13573 @file{missed.all}, and this one:
13575 @smallexample
13576 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13577 @end smallexample
13579 @noindent
13580 prints information about missed optimization opportunities from
13581 vectorization passes on @file{stderr}.  
13582 Note that @option{-fopt-info-vec-missed} is equivalent to 
13583 @option{-fopt-info-missed-vec}.  The order of the optimization group
13584 names and message types listed after @option{-fopt-info} does not matter.
13586 As another example,
13587 @smallexample
13588 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13589 @end smallexample
13591 @noindent
13592 outputs information about missed optimizations as well as
13593 optimized locations from all the inlining passes into
13594 @file{inline.txt}.
13596 Finally, consider:
13598 @smallexample
13599 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13600 @end smallexample
13602 @noindent
13603 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13604 in conflict since only one output file is allowed. In this case, only
13605 the first option takes effect and the subsequent options are
13606 ignored. Thus only @file{vec.miss} is produced which contains
13607 dumps from the vectorizer about missed opportunities.
13609 @item -fsched-verbose=@var{n}
13610 @opindex fsched-verbose
13611 On targets that use instruction scheduling, this option controls the
13612 amount of debugging output the scheduler prints to the dump files.
13614 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13615 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13616 For @var{n} greater than one, it also output basic block probabilities,
13617 detailed ready list information and unit/insn info.  For @var{n} greater
13618 than two, it includes RTL at abort point, control-flow and regions info.
13619 And for @var{n} over four, @option{-fsched-verbose} also includes
13620 dependence info.
13624 @item -fenable-@var{kind}-@var{pass}
13625 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13626 @opindex fdisable-
13627 @opindex fenable-
13629 This is a set of options that are used to explicitly disable/enable
13630 optimization passes.  These options are intended for use for debugging GCC.
13631 Compiler users should use regular options for enabling/disabling
13632 passes instead.
13634 @table @gcctabopt
13636 @item -fdisable-ipa-@var{pass}
13637 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13638 statically invoked in the compiler multiple times, the pass name should be
13639 appended with a sequential number starting from 1.
13641 @item -fdisable-rtl-@var{pass}
13642 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13643 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13644 statically invoked in the compiler multiple times, the pass name should be
13645 appended with a sequential number starting from 1.  @var{range-list} is a 
13646 comma-separated list of function ranges or assembler names.  Each range is a number
13647 pair separated by a colon.  The range is inclusive in both ends.  If the range
13648 is trivial, the number pair can be simplified as a single number.  If the
13649 function's call graph node's @var{uid} falls within one of the specified ranges,
13650 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13651 function header of a dump file, and the pass names can be dumped by using
13652 option @option{-fdump-passes}.
13654 @item -fdisable-tree-@var{pass}
13655 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13656 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13657 option arguments.
13659 @item -fenable-ipa-@var{pass}
13660 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13661 statically invoked in the compiler multiple times, the pass name should be
13662 appended with a sequential number starting from 1.
13664 @item -fenable-rtl-@var{pass}
13665 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13666 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13667 description and examples.
13669 @item -fenable-tree-@var{pass}
13670 @itemx -fenable-tree-@var{pass}=@var{range-list}
13671 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13672 of option arguments.
13674 @end table
13676 Here are some examples showing uses of these options.
13678 @smallexample
13680 # disable ccp1 for all functions
13681    -fdisable-tree-ccp1
13682 # disable complete unroll for function whose cgraph node uid is 1
13683    -fenable-tree-cunroll=1
13684 # disable gcse2 for functions at the following ranges [1,1],
13685 # [300,400], and [400,1000]
13686 # disable gcse2 for functions foo and foo2
13687    -fdisable-rtl-gcse2=foo,foo2
13688 # disable early inlining
13689    -fdisable-tree-einline
13690 # disable ipa inlining
13691    -fdisable-ipa-inline
13692 # enable tree full unroll
13693    -fenable-tree-unroll
13695 @end smallexample
13697 @item -fchecking
13698 @itemx -fchecking=@var{n}
13699 @opindex fchecking
13700 @opindex fno-checking
13701 Enable internal consistency checking.  The default depends on
13702 the compiler configuration.  @option{-fchecking=2} enables further
13703 internal consistency checking that might affect code generation.
13705 @item -frandom-seed=@var{string}
13706 @opindex frandom-seed
13707 This option provides a seed that GCC uses in place of
13708 random numbers in generating certain symbol names
13709 that have to be different in every compiled file.  It is also used to
13710 place unique stamps in coverage data files and the object files that
13711 produce them.  You can use the @option{-frandom-seed} option to produce
13712 reproducibly identical object files.
13714 The @var{string} can either be a number (decimal, octal or hex) or an
13715 arbitrary string (in which case it's converted to a number by
13716 computing CRC32).
13718 The @var{string} should be different for every file you compile.
13720 @item -save-temps
13721 @itemx -save-temps=cwd
13722 @opindex save-temps
13723 Store the usual ``temporary'' intermediate files permanently; place them
13724 in the current directory and name them based on the source file.  Thus,
13725 compiling @file{foo.c} with @option{-c -save-temps} produces files
13726 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13727 preprocessed @file{foo.i} output file even though the compiler now
13728 normally uses an integrated preprocessor.
13730 When used in combination with the @option{-x} command-line option,
13731 @option{-save-temps} is sensible enough to avoid over writing an
13732 input source file with the same extension as an intermediate file.
13733 The corresponding intermediate file may be obtained by renaming the
13734 source file before using @option{-save-temps}.
13736 If you invoke GCC in parallel, compiling several different source
13737 files that share a common base name in different subdirectories or the
13738 same source file compiled for multiple output destinations, it is
13739 likely that the different parallel compilers will interfere with each
13740 other, and overwrite the temporary files.  For instance:
13742 @smallexample
13743 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13744 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13745 @end smallexample
13747 may result in @file{foo.i} and @file{foo.o} being written to
13748 simultaneously by both compilers.
13750 @item -save-temps=obj
13751 @opindex save-temps=obj
13752 Store the usual ``temporary'' intermediate files permanently.  If the
13753 @option{-o} option is used, the temporary files are based on the
13754 object file.  If the @option{-o} option is not used, the
13755 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13757 For example:
13759 @smallexample
13760 gcc -save-temps=obj -c foo.c
13761 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13762 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13763 @end smallexample
13765 @noindent
13766 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13767 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13768 @file{dir2/yfoobar.o}.
13770 @item -time@r{[}=@var{file}@r{]}
13771 @opindex time
13772 Report the CPU time taken by each subprocess in the compilation
13773 sequence.  For C source files, this is the compiler proper and assembler
13774 (plus the linker if linking is done).
13776 Without the specification of an output file, the output looks like this:
13778 @smallexample
13779 # cc1 0.12 0.01
13780 # as 0.00 0.01
13781 @end smallexample
13783 The first number on each line is the ``user time'', that is time spent
13784 executing the program itself.  The second number is ``system time'',
13785 time spent executing operating system routines on behalf of the program.
13786 Both numbers are in seconds.
13788 With the specification of an output file, the output is appended to the
13789 named file, and it looks like this:
13791 @smallexample
13792 0.12 0.01 cc1 @var{options}
13793 0.00 0.01 as @var{options}
13794 @end smallexample
13796 The ``user time'' and the ``system time'' are moved before the program
13797 name, and the options passed to the program are displayed, so that one
13798 can later tell what file was being compiled, and with which options.
13800 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13801 @opindex fdump-final-insns
13802 Dump the final internal representation (RTL) to @var{file}.  If the
13803 optional argument is omitted (or if @var{file} is @code{.}), the name
13804 of the dump file is determined by appending @code{.gkd} to the
13805 compilation output file name.
13807 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13808 @opindex fcompare-debug
13809 @opindex fno-compare-debug
13810 If no error occurs during compilation, run the compiler a second time,
13811 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13812 passed to the second compilation.  Dump the final internal
13813 representation in both compilations, and print an error if they differ.
13815 If the equal sign is omitted, the default @option{-gtoggle} is used.
13817 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13818 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13819 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13820 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13821 is used.
13823 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13824 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13825 of the final representation and the second compilation, preventing even
13826 @env{GCC_COMPARE_DEBUG} from taking effect.
13828 To verify full coverage during @option{-fcompare-debug} testing, set
13829 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13830 which GCC rejects as an invalid option in any actual compilation
13831 (rather than preprocessing, assembly or linking).  To get just a
13832 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13833 not overridden} will do.
13835 @item -fcompare-debug-second
13836 @opindex fcompare-debug-second
13837 This option is implicitly passed to the compiler for the second
13838 compilation requested by @option{-fcompare-debug}, along with options to
13839 silence warnings, and omitting other options that would cause
13840 side-effect compiler outputs to files or to the standard output.  Dump
13841 files and preserved temporary files are renamed so as to contain the
13842 @code{.gk} additional extension during the second compilation, to avoid
13843 overwriting those generated by the first.
13845 When this option is passed to the compiler driver, it causes the
13846 @emph{first} compilation to be skipped, which makes it useful for little
13847 other than debugging the compiler proper.
13849 @item -gtoggle
13850 @opindex gtoggle
13851 Turn off generation of debug info, if leaving out this option
13852 generates it, or turn it on at level 2 otherwise.  The position of this
13853 argument in the command line does not matter; it takes effect after all
13854 other options are processed, and it does so only once, no matter how
13855 many times it is given.  This is mainly intended to be used with
13856 @option{-fcompare-debug}.
13858 @item -fvar-tracking-assignments-toggle
13859 @opindex fvar-tracking-assignments-toggle
13860 @opindex fno-var-tracking-assignments-toggle
13861 Toggle @option{-fvar-tracking-assignments}, in the same way that
13862 @option{-gtoggle} toggles @option{-g}.
13864 @item -Q
13865 @opindex Q
13866 Makes the compiler print out each function name as it is compiled, and
13867 print some statistics about each pass when it finishes.
13869 @item -ftime-report
13870 @opindex ftime-report
13871 Makes the compiler print some statistics about the time consumed by each
13872 pass when it finishes.
13874 @item -ftime-report-details
13875 @opindex ftime-report-details
13876 Record the time consumed by infrastructure parts separately for each pass.
13878 @item -fira-verbose=@var{n}
13879 @opindex fira-verbose
13880 Control the verbosity of the dump file for the integrated register allocator.
13881 The default value is 5.  If the value @var{n} is greater or equal to 10,
13882 the dump output is sent to stderr using the same format as @var{n} minus 10.
13884 @item -flto-report
13885 @opindex flto-report
13886 Prints a report with internal details on the workings of the link-time
13887 optimizer.  The contents of this report vary from version to version.
13888 It is meant to be useful to GCC developers when processing object
13889 files in LTO mode (via @option{-flto}).
13891 Disabled by default.
13893 @item -flto-report-wpa
13894 @opindex flto-report-wpa
13895 Like @option{-flto-report}, but only print for the WPA phase of Link
13896 Time Optimization.
13898 @item -fmem-report
13899 @opindex fmem-report
13900 Makes the compiler print some statistics about permanent memory
13901 allocation when it finishes.
13903 @item -fmem-report-wpa
13904 @opindex fmem-report-wpa
13905 Makes the compiler print some statistics about permanent memory
13906 allocation for the WPA phase only.
13908 @item -fpre-ipa-mem-report
13909 @opindex fpre-ipa-mem-report
13910 @item -fpost-ipa-mem-report
13911 @opindex fpost-ipa-mem-report
13912 Makes the compiler print some statistics about permanent memory
13913 allocation before or after interprocedural optimization.
13915 @item -fprofile-report
13916 @opindex fprofile-report
13917 Makes the compiler print some statistics about consistency of the
13918 (estimated) profile and effect of individual passes.
13920 @item -fstack-usage
13921 @opindex fstack-usage
13922 Makes the compiler output stack usage information for the program, on a
13923 per-function basis.  The filename for the dump is made by appending
13924 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13925 the output file, if explicitly specified and it is not an executable,
13926 otherwise it is the basename of the source file.  An entry is made up
13927 of three fields:
13929 @itemize
13930 @item
13931 The name of the function.
13932 @item
13933 A number of bytes.
13934 @item
13935 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13936 @end itemize
13938 The qualifier @code{static} means that the function manipulates the stack
13939 statically: a fixed number of bytes are allocated for the frame on function
13940 entry and released on function exit; no stack adjustments are otherwise made
13941 in the function.  The second field is this fixed number of bytes.
13943 The qualifier @code{dynamic} means that the function manipulates the stack
13944 dynamically: in addition to the static allocation described above, stack
13945 adjustments are made in the body of the function, for example to push/pop
13946 arguments around function calls.  If the qualifier @code{bounded} is also
13947 present, the amount of these adjustments is bounded at compile time and
13948 the second field is an upper bound of the total amount of stack used by
13949 the function.  If it is not present, the amount of these adjustments is
13950 not bounded at compile time and the second field only represents the
13951 bounded part.
13953 @item -fstats
13954 @opindex fstats
13955 Emit statistics about front-end processing at the end of the compilation.
13956 This option is supported only by the C++ front end, and
13957 the information is generally only useful to the G++ development team.
13959 @item -fdbg-cnt-list
13960 @opindex fdbg-cnt-list
13961 Print the name and the counter upper bound for all debug counters.
13964 @item -fdbg-cnt=@var{counter-value-list}
13965 @opindex fdbg-cnt
13966 Set the internal debug counter upper bound.  @var{counter-value-list}
13967 is a comma-separated list of @var{name}:@var{value} pairs
13968 which sets the upper bound of each debug counter @var{name} to @var{value}.
13969 All debug counters have the initial upper bound of @code{UINT_MAX};
13970 thus @code{dbg_cnt} returns true always unless the upper bound
13971 is set by this option.
13972 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13973 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13975 @item -print-file-name=@var{library}
13976 @opindex print-file-name
13977 Print the full absolute name of the library file @var{library} that
13978 would be used when linking---and don't do anything else.  With this
13979 option, GCC does not compile or link anything; it just prints the
13980 file name.
13982 @item -print-multi-directory
13983 @opindex print-multi-directory
13984 Print the directory name corresponding to the multilib selected by any
13985 other switches present in the command line.  This directory is supposed
13986 to exist in @env{GCC_EXEC_PREFIX}.
13988 @item -print-multi-lib
13989 @opindex print-multi-lib
13990 Print the mapping from multilib directory names to compiler switches
13991 that enable them.  The directory name is separated from the switches by
13992 @samp{;}, and each switch starts with an @samp{@@} instead of the
13993 @samp{-}, without spaces between multiple switches.  This is supposed to
13994 ease shell processing.
13996 @item -print-multi-os-directory
13997 @opindex print-multi-os-directory
13998 Print the path to OS libraries for the selected
13999 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14000 present in the @file{lib} subdirectory and no multilibs are used, this is
14001 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14002 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14003 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14004 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14006 @item -print-multiarch
14007 @opindex print-multiarch
14008 Print the path to OS libraries for the selected multiarch,
14009 relative to some @file{lib} subdirectory.
14011 @item -print-prog-name=@var{program}
14012 @opindex print-prog-name
14013 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14015 @item -print-libgcc-file-name
14016 @opindex print-libgcc-file-name
14017 Same as @option{-print-file-name=libgcc.a}.
14019 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14020 but you do want to link with @file{libgcc.a}.  You can do:
14022 @smallexample
14023 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14024 @end smallexample
14026 @item -print-search-dirs
14027 @opindex print-search-dirs
14028 Print the name of the configured installation directory and a list of
14029 program and library directories @command{gcc} searches---and don't do anything else.
14031 This is useful when @command{gcc} prints the error message
14032 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14033 To resolve this you either need to put @file{cpp0} and the other compiler
14034 components where @command{gcc} expects to find them, or you can set the environment
14035 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14036 Don't forget the trailing @samp{/}.
14037 @xref{Environment Variables}.
14039 @item -print-sysroot
14040 @opindex print-sysroot
14041 Print the target sysroot directory that is used during
14042 compilation.  This is the target sysroot specified either at configure
14043 time or using the @option{--sysroot} option, possibly with an extra
14044 suffix that depends on compilation options.  If no target sysroot is
14045 specified, the option prints nothing.
14047 @item -print-sysroot-headers-suffix
14048 @opindex print-sysroot-headers-suffix
14049 Print the suffix added to the target sysroot when searching for
14050 headers, or give an error if the compiler is not configured with such
14051 a suffix---and don't do anything else.
14053 @item -dumpmachine
14054 @opindex dumpmachine
14055 Print the compiler's target machine (for example,
14056 @samp{i686-pc-linux-gnu})---and don't do anything else.
14058 @item -dumpversion
14059 @opindex dumpversion
14060 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14061 anything else.  This is the compiler version used in filesystem paths,
14062 specs, can be depending on how the compiler has been configured just
14063 a single number (major version), two numbers separated by dot (major and
14064 minor version) or three numbers separated by dots (major, minor and patchlevel
14065 version).
14067 @item -dumpfullversion
14068 @opindex dumpfullversion
14069 Print the full compiler version, always 3 numbers separated by dots,
14070 major, minor and patchlevel version.
14072 @item -dumpspecs
14073 @opindex dumpspecs
14074 Print the compiler's built-in specs---and don't do anything else.  (This
14075 is used when GCC itself is being built.)  @xref{Spec Files}.
14076 @end table
14078 @node Submodel Options
14079 @section Machine-Dependent Options
14080 @cindex submodel options
14081 @cindex specifying hardware config
14082 @cindex hardware models and configurations, specifying
14083 @cindex target-dependent options
14084 @cindex machine-dependent options
14086 Each target machine supported by GCC can have its own options---for
14087 example, to allow you to compile for a particular processor variant or
14088 ABI, or to control optimizations specific to that machine.  By
14089 convention, the names of machine-specific options start with
14090 @samp{-m}.
14092 Some configurations of the compiler also support additional target-specific
14093 options, usually for compatibility with other compilers on the same
14094 platform.
14096 @c This list is ordered alphanumerically by subsection name.
14097 @c It should be the same order and spelling as these options are listed
14098 @c in Machine Dependent Options
14100 @menu
14101 * AArch64 Options::
14102 * Adapteva Epiphany Options::
14103 * ARC Options::
14104 * ARM Options::
14105 * AVR Options::
14106 * Blackfin Options::
14107 * C6X Options::
14108 * CRIS Options::
14109 * CR16 Options::
14110 * Darwin Options::
14111 * DEC Alpha Options::
14112 * FR30 Options::
14113 * FT32 Options::
14114 * FRV Options::
14115 * GNU/Linux Options::
14116 * H8/300 Options::
14117 * HPPA Options::
14118 * IA-64 Options::
14119 * LM32 Options::
14120 * M32C Options::
14121 * M32R/D Options::
14122 * M680x0 Options::
14123 * MCore Options::
14124 * MeP Options::
14125 * MicroBlaze Options::
14126 * MIPS Options::
14127 * MMIX Options::
14128 * MN10300 Options::
14129 * Moxie Options::
14130 * MSP430 Options::
14131 * NDS32 Options::
14132 * Nios II Options::
14133 * Nvidia PTX Options::
14134 * PDP-11 Options::
14135 * picoChip Options::
14136 * PowerPC Options::
14137 * RISC-V Options::
14138 * RL78 Options::
14139 * RS/6000 and PowerPC Options::
14140 * RX Options::
14141 * S/390 and zSeries Options::
14142 * Score Options::
14143 * SH Options::
14144 * Solaris 2 Options::
14145 * SPARC Options::
14146 * SPU Options::
14147 * System V Options::
14148 * TILE-Gx Options::
14149 * TILEPro Options::
14150 * V850 Options::
14151 * VAX Options::
14152 * Visium Options::
14153 * VMS Options::
14154 * VxWorks Options::
14155 * x86 Options::
14156 * x86 Windows Options::
14157 * Xstormy16 Options::
14158 * Xtensa Options::
14159 * zSeries Options::
14160 @end menu
14162 @node AArch64 Options
14163 @subsection AArch64 Options
14164 @cindex AArch64 Options
14166 These options are defined for AArch64 implementations:
14168 @table @gcctabopt
14170 @item -mabi=@var{name}
14171 @opindex mabi
14172 Generate code for the specified data model.  Permissible values
14173 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14174 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14175 but long int and pointers are 64 bits.
14177 The default depends on the specific target configuration.  Note that
14178 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14179 entire program with the same ABI, and link with a compatible set of libraries.
14181 @item -mbig-endian
14182 @opindex mbig-endian
14183 Generate big-endian code.  This is the default when GCC is configured for an
14184 @samp{aarch64_be-*-*} target.
14186 @item -mgeneral-regs-only
14187 @opindex mgeneral-regs-only
14188 Generate code which uses only the general-purpose registers.  This will prevent
14189 the compiler from using floating-point and Advanced SIMD registers but will not
14190 impose any restrictions on the assembler.
14192 @item -mlittle-endian
14193 @opindex mlittle-endian
14194 Generate little-endian code.  This is the default when GCC is configured for an
14195 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14197 @item -mcmodel=tiny
14198 @opindex mcmodel=tiny
14199 Generate code for the tiny code model.  The program and its statically defined
14200 symbols must be within 1MB of each other.  Programs can be statically or
14201 dynamically linked.
14203 @item -mcmodel=small
14204 @opindex mcmodel=small
14205 Generate code for the small code model.  The program and its statically defined
14206 symbols must be within 4GB of each other.  Programs can be statically or
14207 dynamically linked.  This is the default code model.
14209 @item -mcmodel=large
14210 @opindex mcmodel=large
14211 Generate code for the large code model.  This makes no assumptions about
14212 addresses and sizes of sections.  Programs can be statically linked only.
14214 @item -mstrict-align
14215 @opindex mstrict-align
14216 Avoid generating memory accesses that may not be aligned on a natural object
14217 boundary as described in the architecture specification.
14219 @item -momit-leaf-frame-pointer
14220 @itemx -mno-omit-leaf-frame-pointer
14221 @opindex momit-leaf-frame-pointer
14222 @opindex mno-omit-leaf-frame-pointer
14223 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14224 default.
14226 @item -mtls-dialect=desc
14227 @opindex mtls-dialect=desc
14228 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14229 of TLS variables.  This is the default.
14231 @item -mtls-dialect=traditional
14232 @opindex mtls-dialect=traditional
14233 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14234 of TLS variables.
14236 @item -mtls-size=@var{size}
14237 @opindex mtls-size
14238 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14239 This option requires binutils 2.26 or newer.
14241 @item -mfix-cortex-a53-835769
14242 @itemx -mno-fix-cortex-a53-835769
14243 @opindex mfix-cortex-a53-835769
14244 @opindex mno-fix-cortex-a53-835769
14245 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14246 This involves inserting a NOP instruction between memory instructions and
14247 64-bit integer multiply-accumulate instructions.
14249 @item -mfix-cortex-a53-843419
14250 @itemx -mno-fix-cortex-a53-843419
14251 @opindex mfix-cortex-a53-843419
14252 @opindex mno-fix-cortex-a53-843419
14253 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14254 This erratum workaround is made at link time and this will only pass the
14255 corresponding flag to the linker.
14257 @item -mlow-precision-recip-sqrt
14258 @item -mno-low-precision-recip-sqrt
14259 @opindex mlow-precision-recip-sqrt
14260 @opindex mno-low-precision-recip-sqrt
14261 Enable or disable the reciprocal square root approximation.
14262 This option only has an effect if @option{-ffast-math} or
14263 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14264 precision of reciprocal square root results to about 16 bits for
14265 single precision and to 32 bits for double precision.
14267 @item -mlow-precision-sqrt
14268 @item -mno-low-precision-sqrt
14269 @opindex -mlow-precision-sqrt
14270 @opindex -mno-low-precision-sqrt
14271 Enable or disable the square root approximation.
14272 This option only has an effect if @option{-ffast-math} or
14273 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14274 precision of square root results to about 16 bits for
14275 single precision and to 32 bits for double precision.
14276 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14278 @item -mlow-precision-div
14279 @item -mno-low-precision-div
14280 @opindex -mlow-precision-div
14281 @opindex -mno-low-precision-div
14282 Enable or disable the division approximation.
14283 This option only has an effect if @option{-ffast-math} or
14284 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14285 precision of division results to about 16 bits for
14286 single precision and to 32 bits for double precision.
14288 @item -march=@var{name}
14289 @opindex march
14290 Specify the name of the target architecture and, optionally, one or
14291 more feature modifiers.  This option has the form
14292 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14294 The permissible values for @var{arch} are @samp{armv8-a},
14295 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14297 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14298 support for the ARMv8.3-A architecture extensions.
14300 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14301 support for the ARMv8.2-A architecture extensions.
14303 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14304 support for the ARMv8.1-A architecture extension.  In particular, it
14305 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14307 The value @samp{native} is available on native AArch64 GNU/Linux and
14308 causes the compiler to pick the architecture of the host system.  This
14309 option has no effect if the compiler is unable to recognize the
14310 architecture of the host system,
14312 The permissible values for @var{feature} are listed in the sub-section
14313 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14314 Feature Modifiers}.  Where conflicting feature modifiers are
14315 specified, the right-most feature is used.
14317 GCC uses @var{name} to determine what kind of instructions it can emit
14318 when generating assembly code.  If @option{-march} is specified
14319 without either of @option{-mtune} or @option{-mcpu} also being
14320 specified, the code is tuned to perform well across a range of target
14321 processors implementing the target architecture.
14323 @item -mtune=@var{name}
14324 @opindex mtune
14325 Specify the name of the target processor for which GCC should tune the
14326 performance of the code.  Permissible values for this option are:
14327 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14328 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14329 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14330 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14331 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14332 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14333 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14334 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14335 @samp{native}.
14337 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14338 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14339 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14340 big.LITTLE system.
14342 Additionally on native AArch64 GNU/Linux systems the value
14343 @samp{native} tunes performance to the host system.  This option has no effect
14344 if the compiler is unable to recognize the processor of the host system.
14346 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14347 are specified, the code is tuned to perform well across a range
14348 of target processors.
14350 This option cannot be suffixed by feature modifiers.
14352 @item -mcpu=@var{name}
14353 @opindex mcpu
14354 Specify the name of the target processor, optionally suffixed by one
14355 or more feature modifiers.  This option has the form
14356 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14357 the permissible values for @var{cpu} are the same as those available
14358 for @option{-mtune}.  The permissible values for @var{feature} are
14359 documented in the sub-section on
14360 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14361 Feature Modifiers}.  Where conflicting feature modifiers are
14362 specified, the right-most feature is used.
14364 GCC uses @var{name} to determine what kind of instructions it can emit when
14365 generating assembly code (as if by @option{-march}) and to determine
14366 the target processor for which to tune for performance (as if
14367 by @option{-mtune}).  Where this option is used in conjunction
14368 with @option{-march} or @option{-mtune}, those options take precedence
14369 over the appropriate part of this option.
14371 @item -moverride=@var{string}
14372 @opindex moverride
14373 Override tuning decisions made by the back-end in response to a
14374 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14375 for @var{string} in this option are not guaranteed to be consistent
14376 across releases.
14378 This option is only intended to be useful when developing GCC.
14380 @item -mpc-relative-literal-loads
14381 @itemx -mno-pc-relative-literal-loads
14382 @opindex mpc-relative-literal-loads
14383 @opindex mno-pc-relative-literal-loads
14384 Enable or disable PC-relative literal loads.  With this option literal pools are
14385 accessed using a single instruction and emitted after each function.  This
14386 limits the maximum size of functions to 1MB.  This is enabled by default for
14387 @option{-mcmodel=tiny}.
14389 @item -msign-return-address=@var{scope}
14390 @opindex msign-return-address
14391 Select the function scope on which return address signing will be applied.
14392 Permissible values are @samp{none}, which disables return address signing,
14393 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14394 functions, and @samp{all}, which enables pointer signing for all functions.  The
14395 default value is @samp{none}.
14397 @end table
14399 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14400 @anchor{aarch64-feature-modifiers}
14401 @cindex @option{-march} feature modifiers
14402 @cindex @option{-mcpu} feature modifiers
14403 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14404 the following and their inverses @option{no@var{feature}}:
14406 @table @samp
14407 @item crc
14408 Enable CRC extension.  This is on by default for
14409 @option{-march=armv8.1-a}.
14410 @item crypto
14411 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14412 instructions.
14413 @item fp
14414 Enable floating-point instructions.  This is on by default for all possible
14415 values for options @option{-march} and @option{-mcpu}.
14416 @item simd
14417 Enable Advanced SIMD instructions.  This also enables floating-point
14418 instructions.  This is on by default for all possible values for options
14419 @option{-march} and @option{-mcpu}.
14420 @item lse
14421 Enable Large System Extension instructions.  This is on by default for
14422 @option{-march=armv8.1-a}.
14423 @item rdma
14424 Enable Round Double Multiply Accumulate instructions.  This is on by default
14425 for @option{-march=armv8.1-a}.
14426 @item fp16
14427 Enable FP16 extension.  This also enables floating-point instructions.
14428 @item rcpc
14429 Enable the RcPc extension.  This does not change code generation from GCC,
14430 but is passed on to the assembler, enabling inline asm statements to use
14431 instructions from the RcPc extension.
14432 @item dotprod
14433 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14435 @end table
14437 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14438 Conversely, @option{nofp} implies @option{nosimd}, which implies
14439 @option{nocrypto}.
14441 @node Adapteva Epiphany Options
14442 @subsection Adapteva Epiphany Options
14444 These @samp{-m} options are defined for Adapteva Epiphany:
14446 @table @gcctabopt
14447 @item -mhalf-reg-file
14448 @opindex mhalf-reg-file
14449 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14450 That allows code to run on hardware variants that lack these registers.
14452 @item -mprefer-short-insn-regs
14453 @opindex mprefer-short-insn-regs
14454 Preferentially allocate registers that allow short instruction generation.
14455 This can result in increased instruction count, so this may either reduce or
14456 increase overall code size.
14458 @item -mbranch-cost=@var{num}
14459 @opindex mbranch-cost
14460 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14461 This cost is only a heuristic and is not guaranteed to produce
14462 consistent results across releases.
14464 @item -mcmove
14465 @opindex mcmove
14466 Enable the generation of conditional moves.
14468 @item -mnops=@var{num}
14469 @opindex mnops
14470 Emit @var{num} NOPs before every other generated instruction.
14472 @item -mno-soft-cmpsf
14473 @opindex mno-soft-cmpsf
14474 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14475 and test the flags.  This is faster than a software comparison, but can
14476 get incorrect results in the presence of NaNs, or when two different small
14477 numbers are compared such that their difference is calculated as zero.
14478 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14479 software comparisons.
14481 @item -mstack-offset=@var{num}
14482 @opindex mstack-offset
14483 Set the offset between the top of the stack and the stack pointer.
14484 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14485 can be used by leaf functions without stack allocation.
14486 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14487 Note also that this option changes the ABI; compiling a program with a
14488 different stack offset than the libraries have been compiled with
14489 generally does not work.
14490 This option can be useful if you want to evaluate if a different stack
14491 offset would give you better code, but to actually use a different stack
14492 offset to build working programs, it is recommended to configure the
14493 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14495 @item -mno-round-nearest
14496 @opindex mno-round-nearest
14497 Make the scheduler assume that the rounding mode has been set to
14498 truncating.  The default is @option{-mround-nearest}.
14500 @item -mlong-calls
14501 @opindex mlong-calls
14502 If not otherwise specified by an attribute, assume all calls might be beyond
14503 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14504 function address into a register before performing a (otherwise direct) call.
14505 This is the default.
14507 @item -mshort-calls
14508 @opindex short-calls
14509 If not otherwise specified by an attribute, assume all direct calls are
14510 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14511 for direct calls.  The default is @option{-mlong-calls}.
14513 @item -msmall16
14514 @opindex msmall16
14515 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14516 apply to function addresses for which @option{-mlong-calls} semantics
14517 are in effect.
14519 @item -mfp-mode=@var{mode}
14520 @opindex mfp-mode
14521 Set the prevailing mode of the floating-point unit.
14522 This determines the floating-point mode that is provided and expected
14523 at function call and return time.  Making this mode match the mode you
14524 predominantly need at function start can make your programs smaller and
14525 faster by avoiding unnecessary mode switches.
14527 @var{mode} can be set to one the following values:
14529 @table @samp
14530 @item caller
14531 Any mode at function entry is valid, and retained or restored when
14532 the function returns, and when it calls other functions.
14533 This mode is useful for compiling libraries or other compilation units
14534 you might want to incorporate into different programs with different
14535 prevailing FPU modes, and the convenience of being able to use a single
14536 object file outweighs the size and speed overhead for any extra
14537 mode switching that might be needed, compared with what would be needed
14538 with a more specific choice of prevailing FPU mode.
14540 @item truncate
14541 This is the mode used for floating-point calculations with
14542 truncating (i.e.@: round towards zero) rounding mode.  That includes
14543 conversion from floating point to integer.
14545 @item round-nearest
14546 This is the mode used for floating-point calculations with
14547 round-to-nearest-or-even rounding mode.
14549 @item int
14550 This is the mode used to perform integer calculations in the FPU, e.g.@:
14551 integer multiply, or integer multiply-and-accumulate.
14552 @end table
14554 The default is @option{-mfp-mode=caller}
14556 @item -mnosplit-lohi
14557 @itemx -mno-postinc
14558 @itemx -mno-postmodify
14559 @opindex mnosplit-lohi
14560 @opindex mno-postinc
14561 @opindex mno-postmodify
14562 Code generation tweaks that disable, respectively, splitting of 32-bit
14563 loads, generation of post-increment addresses, and generation of
14564 post-modify addresses.  The defaults are @option{msplit-lohi},
14565 @option{-mpost-inc}, and @option{-mpost-modify}.
14567 @item -mnovect-double
14568 @opindex mno-vect-double
14569 Change the preferred SIMD mode to SImode.  The default is
14570 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14572 @item -max-vect-align=@var{num}
14573 @opindex max-vect-align
14574 The maximum alignment for SIMD vector mode types.
14575 @var{num} may be 4 or 8.  The default is 8.
14576 Note that this is an ABI change, even though many library function
14577 interfaces are unaffected if they don't use SIMD vector modes
14578 in places that affect size and/or alignment of relevant types.
14580 @item -msplit-vecmove-early
14581 @opindex msplit-vecmove-early
14582 Split vector moves into single word moves before reload.  In theory this
14583 can give better register allocation, but so far the reverse seems to be
14584 generally the case.
14586 @item -m1reg-@var{reg}
14587 @opindex m1reg-
14588 Specify a register to hold the constant @minus{}1, which makes loading small negative
14589 constants and certain bitmasks faster.
14590 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14591 which specify use of that register as a fixed register,
14592 and @samp{none}, which means that no register is used for this
14593 purpose.  The default is @option{-m1reg-none}.
14595 @end table
14597 @node ARC Options
14598 @subsection ARC Options
14599 @cindex ARC options
14601 The following options control the architecture variant for which code
14602 is being compiled:
14604 @c architecture variants
14605 @table @gcctabopt
14607 @item -mbarrel-shifter
14608 @opindex mbarrel-shifter
14609 Generate instructions supported by barrel shifter.  This is the default
14610 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14612 @item -mcpu=@var{cpu}
14613 @opindex mcpu
14614 Set architecture type, register usage, and instruction scheduling
14615 parameters for @var{cpu}.  There are also shortcut alias options
14616 available for backward compatibility and convenience.  Supported
14617 values for @var{cpu} are
14619 @table @samp
14620 @opindex mA6
14621 @opindex mARC600
14622 @item arc600
14623 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14625 @item arc601
14626 @opindex mARC601
14627 Compile for ARC601.  Alias: @option{-mARC601}.
14629 @item arc700
14630 @opindex mA7
14631 @opindex mARC700
14632 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14633 This is the default when configured with @option{--with-cpu=arc700}@.
14635 @item arcem
14636 Compile for ARC EM.
14638 @item archs
14639 Compile for ARC HS.
14641 @item em
14642 Compile for ARC EM CPU with no hardware extensions.
14644 @item em4
14645 Compile for ARC EM4 CPU.
14647 @item em4_dmips
14648 Compile for ARC EM4 DMIPS CPU.
14650 @item em4_fpus
14651 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14652 extension.
14654 @item em4_fpuda
14655 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14656 double assist instructions.
14658 @item hs
14659 Compile for ARC HS CPU with no hardware extensions except the atomic
14660 instructions.
14662 @item hs34
14663 Compile for ARC HS34 CPU.
14665 @item hs38
14666 Compile for ARC HS38 CPU.
14668 @item hs38_linux
14669 Compile for ARC HS38 CPU with all hardware extensions on.
14671 @item arc600_norm
14672 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14674 @item arc600_mul32x16
14675 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14676 instructions enabled.
14678 @item arc600_mul64
14679 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14680 instructions enabled.
14682 @item arc601_norm
14683 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14685 @item arc601_mul32x16
14686 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14687 instructions enabled.
14689 @item arc601_mul64
14690 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14691 instructions enabled.
14693 @item nps400
14694 Compile for ARC 700 on NPS400 chip.
14696 @end table
14698 @item -mdpfp
14699 @opindex mdpfp
14700 @itemx -mdpfp-compact
14701 @opindex mdpfp-compact
14702 Generate double-precision FPX instructions, tuned for the compact
14703 implementation.
14705 @item -mdpfp-fast
14706 @opindex mdpfp-fast
14707 Generate double-precision FPX instructions, tuned for the fast
14708 implementation.
14710 @item -mno-dpfp-lrsr
14711 @opindex mno-dpfp-lrsr
14712 Disable @code{lr} and @code{sr} instructions from using FPX extension
14713 aux registers.
14715 @item -mea
14716 @opindex mea
14717 Generate extended arithmetic instructions.  Currently only
14718 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14719 supported.  This is always enabled for @option{-mcpu=ARC700}.
14721 @item -mno-mpy
14722 @opindex mno-mpy
14723 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14724 deprecated.
14726 @item -mmul32x16
14727 @opindex mmul32x16
14728 Generate 32x16-bit multiply and multiply-accumulate instructions.
14730 @item -mmul64
14731 @opindex mmul64
14732 Generate @code{mul64} and @code{mulu64} instructions.  
14733 Only valid for @option{-mcpu=ARC600}.
14735 @item -mnorm
14736 @opindex mnorm
14737 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14738 is in effect.
14740 @item -mspfp
14741 @opindex mspfp
14742 @itemx -mspfp-compact
14743 @opindex mspfp-compact
14744 Generate single-precision FPX instructions, tuned for the compact
14745 implementation.
14747 @item -mspfp-fast
14748 @opindex mspfp-fast
14749 Generate single-precision FPX instructions, tuned for the fast
14750 implementation.
14752 @item -msimd
14753 @opindex msimd
14754 Enable generation of ARC SIMD instructions via target-specific
14755 builtins.  Only valid for @option{-mcpu=ARC700}.
14757 @item -msoft-float
14758 @opindex msoft-float
14759 This option ignored; it is provided for compatibility purposes only.
14760 Software floating-point code is emitted by default, and this default
14761 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14762 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14763 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14765 @item -mswap
14766 @opindex mswap
14767 Generate @code{swap} instructions.
14769 @item -matomic
14770 @opindex matomic
14771 This enables use of the locked load/store conditional extension to implement
14772 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14773 EM cores.
14775 @item -mdiv-rem
14776 @opindex mdiv-rem
14777 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14779 @item -mcode-density
14780 @opindex mcode-density
14781 Enable code density instructions for ARC EM.  
14782 This option is on by default for ARC HS.
14784 @item -mll64
14785 @opindex mll64
14786 Enable double load/store operations for ARC HS cores.
14788 @item -mtp-regno=@var{regno}
14789 @opindex mtp-regno
14790 Specify thread pointer register number.
14792 @item -mmpy-option=@var{multo}
14793 @opindex mmpy-option
14794 Compile ARCv2 code with a multiplier design option.  You can specify 
14795 the option using either a string or numeric value for @var{multo}.  
14796 @samp{wlh1} is the default value.  The recognized values are:
14798 @table @samp
14799 @item 0
14800 @itemx none
14801 No multiplier available.
14803 @item 1
14804 @itemx w
14805 16x16 multiplier, fully pipelined.
14806 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14808 @item 2
14809 @itemx wlh1
14810 32x32 multiplier, fully
14811 pipelined (1 stage).  The following instructions are additionally
14812 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14814 @item 3
14815 @itemx wlh2
14816 32x32 multiplier, fully pipelined
14817 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14818 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14820 @item 4
14821 @itemx wlh3
14822 Two 16x16 multipliers, blocking,
14823 sequential.  The following instructions are additionally enabled: @code{mpy},
14824 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14826 @item 5
14827 @itemx wlh4
14828 One 16x16 multiplier, blocking,
14829 sequential.  The following instructions are additionally enabled: @code{mpy},
14830 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14832 @item 6
14833 @itemx wlh5
14834 One 32x4 multiplier, blocking,
14835 sequential.  The following instructions are additionally enabled: @code{mpy},
14836 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14838 @item 7
14839 @itemx plus_dmpy
14840 ARC HS SIMD support.
14842 @item 8
14843 @itemx plus_macd
14844 ARC HS SIMD support.
14846 @item 9
14847 @itemx plus_qmacw
14848 ARC HS SIMD support.
14850 @end table
14852 This option is only available for ARCv2 cores@.
14854 @item -mfpu=@var{fpu}
14855 @opindex mfpu
14856 Enables support for specific floating-point hardware extensions for ARCv2
14857 cores.  Supported values for @var{fpu} are:
14859 @table @samp
14861 @item fpus
14862 Enables support for single-precision floating-point hardware
14863 extensions@.
14865 @item fpud
14866 Enables support for double-precision floating-point hardware
14867 extensions.  The single-precision floating-point extension is also
14868 enabled.  Not available for ARC EM@.
14870 @item fpuda
14871 Enables support for double-precision floating-point hardware
14872 extensions using double-precision assist instructions.  The single-precision
14873 floating-point extension is also enabled.  This option is
14874 only available for ARC EM@.
14876 @item fpuda_div
14877 Enables support for double-precision floating-point hardware
14878 extensions using double-precision assist instructions.
14879 The single-precision floating-point, square-root, and divide 
14880 extensions are also enabled.  This option is
14881 only available for ARC EM@.
14883 @item fpuda_fma
14884 Enables support for double-precision floating-point hardware
14885 extensions using double-precision assist instructions.
14886 The single-precision floating-point and fused multiply and add 
14887 hardware extensions are also enabled.  This option is
14888 only available for ARC EM@.
14890 @item fpuda_all
14891 Enables support for double-precision floating-point hardware
14892 extensions using double-precision assist instructions.
14893 All single-precision floating-point hardware extensions are also
14894 enabled.  This option is only available for ARC EM@.
14896 @item fpus_div
14897 Enables support for single-precision floating-point, square-root and divide 
14898 hardware extensions@.
14900 @item fpud_div
14901 Enables support for double-precision floating-point, square-root and divide 
14902 hardware extensions.  This option
14903 includes option @samp{fpus_div}. Not available for ARC EM@.
14905 @item fpus_fma
14906 Enables support for single-precision floating-point and 
14907 fused multiply and add hardware extensions@.
14909 @item fpud_fma
14910 Enables support for double-precision floating-point and 
14911 fused multiply and add hardware extensions.  This option
14912 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14914 @item fpus_all
14915 Enables support for all single-precision floating-point hardware
14916 extensions@.
14918 @item fpud_all
14919 Enables support for all single- and double-precision floating-point
14920 hardware extensions.  Not available for ARC EM@.
14922 @end table
14924 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14925 @opindex mirq-ctrl-saved
14926 Specifies general-purposes registers that the processor automatically
14927 saves/restores on interrupt entry and exit.  @var{register-range} is
14928 specified as two registers separated by a dash.  The register range
14929 always starts with @code{r0}, the upper limit is @code{fp} register.
14930 @var{blink} and @var{lp_count} are optional.  This option is only
14931 valid for ARC EM and ARC HS cores.
14933 @item -mrgf-banked-regs=@var{number}
14934 @opindex mrgf-banked-regs
14935 Specifies the number of registers replicated in second register bank
14936 on entry to fast interrupt.  Fast interrupts are interrupts with the
14937 highest priority level P0.  These interrupts save only PC and STATUS32
14938 registers to avoid memory transactions during interrupt entry and exit
14939 sequences.  Use this option when you are using fast interrupts in an
14940 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14942 @item -mlpc-width=@var{width}
14943 @opindex mlpc-width
14944 Specify the width of the @code{lp_count} register.  Valid values for
14945 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
14946 fixed to 32 bits.  If the width is less than 32, the compiler does not
14947 attempt to transform loops in your program to use the zero-delay loop
14948 mechanism unless it is known that the @code{lp_count} register can
14949 hold the required loop-counter value.  Depending on the width
14950 specified, the compiler and run-time library might continue to use the
14951 loop mechanism for various needs.  This option defines macro
14952 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
14954 @end table
14956 The following options are passed through to the assembler, and also
14957 define preprocessor macro symbols.
14959 @c Flags used by the assembler, but for which we define preprocessor
14960 @c macro symbols as well.
14961 @table @gcctabopt
14962 @item -mdsp-packa
14963 @opindex mdsp-packa
14964 Passed down to the assembler to enable the DSP Pack A extensions.
14965 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14966 deprecated.
14968 @item -mdvbf
14969 @opindex mdvbf
14970 Passed down to the assembler to enable the dual Viterbi butterfly
14971 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14972 option is deprecated.
14974 @c ARC700 4.10 extension instruction
14975 @item -mlock
14976 @opindex mlock
14977 Passed down to the assembler to enable the locked load/store
14978 conditional extension.  Also sets the preprocessor symbol
14979 @code{__Xlock}.
14981 @item -mmac-d16
14982 @opindex mmac-d16
14983 Passed down to the assembler.  Also sets the preprocessor symbol
14984 @code{__Xxmac_d16}.  This option is deprecated.
14986 @item -mmac-24
14987 @opindex mmac-24
14988 Passed down to the assembler.  Also sets the preprocessor symbol
14989 @code{__Xxmac_24}.  This option is deprecated.
14991 @c ARC700 4.10 extension instruction
14992 @item -mrtsc
14993 @opindex mrtsc
14994 Passed down to the assembler to enable the 64-bit time-stamp counter
14995 extension instruction.  Also sets the preprocessor symbol
14996 @code{__Xrtsc}.  This option is deprecated.
14998 @c ARC700 4.10 extension instruction
14999 @item -mswape
15000 @opindex mswape
15001 Passed down to the assembler to enable the swap byte ordering
15002 extension instruction.  Also sets the preprocessor symbol
15003 @code{__Xswape}.
15005 @item -mtelephony
15006 @opindex mtelephony
15007 Passed down to the assembler to enable dual- and single-operand
15008 instructions for telephony.  Also sets the preprocessor symbol
15009 @code{__Xtelephony}.  This option is deprecated.
15011 @item -mxy
15012 @opindex mxy
15013 Passed down to the assembler to enable the XY memory extension.  Also
15014 sets the preprocessor symbol @code{__Xxy}.
15016 @end table
15018 The following options control how the assembly code is annotated:
15020 @c Assembly annotation options
15021 @table @gcctabopt
15022 @item -misize
15023 @opindex misize
15024 Annotate assembler instructions with estimated addresses.
15026 @item -mannotate-align
15027 @opindex mannotate-align
15028 Explain what alignment considerations lead to the decision to make an
15029 instruction short or long.
15031 @end table
15033 The following options are passed through to the linker:
15035 @c options passed through to the linker
15036 @table @gcctabopt
15037 @item -marclinux
15038 @opindex marclinux
15039 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15040 This option is enabled by default in tool chains built for
15041 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15042 when profiling is not requested.
15044 @item -marclinux_prof
15045 @opindex marclinux_prof
15046 Passed through to the linker, to specify use of the
15047 @code{arclinux_prof} emulation.  This option is enabled by default in
15048 tool chains built for @w{@code{arc-linux-uclibc}} and
15049 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15051 @end table
15053 The following options control the semantics of generated code:
15055 @c semantically relevant code generation options
15056 @table @gcctabopt
15057 @item -mlong-calls
15058 @opindex mlong-calls
15059 Generate calls as register indirect calls, thus providing access
15060 to the full 32-bit address range.
15062 @item -mmedium-calls
15063 @opindex mmedium-calls
15064 Don't use less than 25-bit addressing range for calls, which is the
15065 offset available for an unconditional branch-and-link
15066 instruction.  Conditional execution of function calls is suppressed, to
15067 allow use of the 25-bit range, rather than the 21-bit range with
15068 conditional branch-and-link.  This is the default for tool chains built
15069 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15071 @item -G @var{num}
15072 @opindex G
15073 Put definitions of externally-visible data in a small data section if
15074 that data is no bigger than @var{num} bytes.  The default value of
15075 @var{num} is 4 for any ARC configuration, or 8 when we have double
15076 load/store operations.
15078 @item -mno-sdata
15079 @opindex mno-sdata
15080 Do not generate sdata references.  This is the default for tool chains
15081 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15082 targets.
15084 @item -mvolatile-cache
15085 @opindex mvolatile-cache
15086 Use ordinarily cached memory accesses for volatile references.  This is the
15087 default.
15089 @item -mno-volatile-cache
15090 @opindex mno-volatile-cache
15091 Enable cache bypass for volatile references.
15093 @end table
15095 The following options fine tune code generation:
15096 @c code generation tuning options
15097 @table @gcctabopt
15098 @item -malign-call
15099 @opindex malign-call
15100 Do alignment optimizations for call instructions.
15102 @item -mauto-modify-reg
15103 @opindex mauto-modify-reg
15104 Enable the use of pre/post modify with register displacement.
15106 @item -mbbit-peephole
15107 @opindex mbbit-peephole
15108 Enable bbit peephole2.
15110 @item -mno-brcc
15111 @opindex mno-brcc
15112 This option disables a target-specific pass in @file{arc_reorg} to
15113 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15114 It has no effect on
15115 generation of these instructions driven by the combiner pass.
15117 @item -mcase-vector-pcrel
15118 @opindex mcase-vector-pcrel
15119 Use PC-relative switch case tables to enable case table shortening.
15120 This is the default for @option{-Os}.
15122 @item -mcompact-casesi
15123 @opindex mcompact-casesi
15124 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15125 and only available for ARCv1 cores.
15127 @item -mno-cond-exec
15128 @opindex mno-cond-exec
15129 Disable the ARCompact-specific pass to generate conditional 
15130 execution instructions.
15132 Due to delay slot scheduling and interactions between operand numbers,
15133 literal sizes, instruction lengths, and the support for conditional execution,
15134 the target-independent pass to generate conditional execution is often lacking,
15135 so the ARC port has kept a special pass around that tries to find more
15136 conditional execution generation opportunities after register allocation,
15137 branch shortening, and delay slot scheduling have been done.  This pass
15138 generally, but not always, improves performance and code size, at the cost of
15139 extra compilation time, which is why there is an option to switch it off.
15140 If you have a problem with call instructions exceeding their allowable
15141 offset range because they are conditionalized, you should consider using
15142 @option{-mmedium-calls} instead.
15144 @item -mearly-cbranchsi
15145 @opindex mearly-cbranchsi
15146 Enable pre-reload use of the @code{cbranchsi} pattern.
15148 @item -mexpand-adddi
15149 @opindex mexpand-adddi
15150 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15151 @code{add.f}, @code{adc} etc.  This option is deprecated.
15153 @item -mindexed-loads
15154 @opindex mindexed-loads
15155 Enable the use of indexed loads.  This can be problematic because some
15156 optimizers then assume that indexed stores exist, which is not
15157 the case.
15159 @opindex mlra
15160 Enable Local Register Allocation.  This is still experimental for ARC,
15161 so by default the compiler uses standard reload
15162 (i.e. @option{-mno-lra}).
15164 @item -mlra-priority-none
15165 @opindex mlra-priority-none
15166 Don't indicate any priority for target registers.
15168 @item -mlra-priority-compact
15169 @opindex mlra-priority-compact
15170 Indicate target register priority for r0..r3 / r12..r15.
15172 @item -mlra-priority-noncompact
15173 @opindex mlra-priority-noncompact
15174 Reduce target register priority for r0..r3 / r12..r15.
15176 @item -mno-millicode
15177 @opindex mno-millicode
15178 When optimizing for size (using @option{-Os}), prologues and epilogues
15179 that have to save or restore a large number of registers are often
15180 shortened by using call to a special function in libgcc; this is
15181 referred to as a @emph{millicode} call.  As these calls can pose
15182 performance issues, and/or cause linking issues when linking in a
15183 nonstandard way, this option is provided to turn off millicode call
15184 generation.
15186 @item -mmixed-code
15187 @opindex mmixed-code
15188 Tweak register allocation to help 16-bit instruction generation.
15189 This generally has the effect of decreasing the average instruction size
15190 while increasing the instruction count.
15192 @item -mq-class
15193 @opindex mq-class
15194 Enable @samp{q} instruction alternatives.
15195 This is the default for @option{-Os}.
15197 @item -mRcq
15198 @opindex mRcq
15199 Enable @samp{Rcq} constraint handling.  
15200 Most short code generation depends on this.
15201 This is the default.
15203 @item -mRcw
15204 @opindex mRcw
15205 Enable @samp{Rcw} constraint handling.  
15206 Most ccfsm condexec mostly depends on this.
15207 This is the default.
15209 @item -msize-level=@var{level}
15210 @opindex msize-level
15211 Fine-tune size optimization with regards to instruction lengths and alignment.
15212 The recognized values for @var{level} are:
15213 @table @samp
15214 @item 0
15215 No size optimization.  This level is deprecated and treated like @samp{1}.
15217 @item 1
15218 Short instructions are used opportunistically.
15220 @item 2
15221 In addition, alignment of loops and of code after barriers are dropped.
15223 @item 3
15224 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15226 @end table
15228 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15229 the behavior when this is not set is equivalent to level @samp{1}.
15231 @item -mtune=@var{cpu}
15232 @opindex mtune
15233 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15234 by @option{-mcpu=}.
15236 Supported values for @var{cpu} are
15238 @table @samp
15239 @item ARC600
15240 Tune for ARC600 CPU.
15242 @item ARC601
15243 Tune for ARC601 CPU.
15245 @item ARC700
15246 Tune for ARC700 CPU with standard multiplier block.
15248 @item ARC700-xmac
15249 Tune for ARC700 CPU with XMAC block.
15251 @item ARC725D
15252 Tune for ARC725D CPU.
15254 @item ARC750D
15255 Tune for ARC750D CPU.
15257 @end table
15259 @item -mmultcost=@var{num}
15260 @opindex mmultcost
15261 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15262 normal instruction.
15264 @item -munalign-prob-threshold=@var{probability}
15265 @opindex munalign-prob-threshold
15266 Set probability threshold for unaligning branches.
15267 When tuning for @samp{ARC700} and optimizing for speed, branches without
15268 filled delay slot are preferably emitted unaligned and long, unless
15269 profiling indicates that the probability for the branch to be taken
15270 is below @var{probability}.  @xref{Cross-profiling}.
15271 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15273 @end table
15275 The following options are maintained for backward compatibility, but
15276 are now deprecated and will be removed in a future release:
15278 @c Deprecated options
15279 @table @gcctabopt
15281 @item -margonaut
15282 @opindex margonaut
15283 Obsolete FPX.
15285 @item -mbig-endian
15286 @opindex mbig-endian
15287 @itemx -EB
15288 @opindex EB
15289 Compile code for big-endian targets.  Use of these options is now
15290 deprecated.  Big-endian code is supported by configuring GCC to build
15291 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15292 for which big endian is the default.
15294 @item -mlittle-endian
15295 @opindex mlittle-endian
15296 @itemx -EL
15297 @opindex EL
15298 Compile code for little-endian targets.  Use of these options is now
15299 deprecated.  Little-endian code is supported by configuring GCC to build 
15300 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15301 for which little endian is the default.
15303 @item -mbarrel_shifter
15304 @opindex mbarrel_shifter
15305 Replaced by @option{-mbarrel-shifter}.
15307 @item -mdpfp_compact
15308 @opindex mdpfp_compact
15309 Replaced by @option{-mdpfp-compact}.
15311 @item -mdpfp_fast
15312 @opindex mdpfp_fast
15313 Replaced by @option{-mdpfp-fast}.
15315 @item -mdsp_packa
15316 @opindex mdsp_packa
15317 Replaced by @option{-mdsp-packa}.
15319 @item -mEA
15320 @opindex mEA
15321 Replaced by @option{-mea}.
15323 @item -mmac_24
15324 @opindex mmac_24
15325 Replaced by @option{-mmac-24}.
15327 @item -mmac_d16
15328 @opindex mmac_d16
15329 Replaced by @option{-mmac-d16}.
15331 @item -mspfp_compact
15332 @opindex mspfp_compact
15333 Replaced by @option{-mspfp-compact}.
15335 @item -mspfp_fast
15336 @opindex mspfp_fast
15337 Replaced by @option{-mspfp-fast}.
15339 @item -mtune=@var{cpu}
15340 @opindex mtune
15341 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15342 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15343 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15345 @item -multcost=@var{num}
15346 @opindex multcost
15347 Replaced by @option{-mmultcost}.
15349 @end table
15351 @node ARM Options
15352 @subsection ARM Options
15353 @cindex ARM options
15355 These @samp{-m} options are defined for the ARM port:
15357 @table @gcctabopt
15358 @item -mabi=@var{name}
15359 @opindex mabi
15360 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15361 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15363 @item -mapcs-frame
15364 @opindex mapcs-frame
15365 Generate a stack frame that is compliant with the ARM Procedure Call
15366 Standard for all functions, even if this is not strictly necessary for
15367 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15368 with this option causes the stack frames not to be generated for
15369 leaf functions.  The default is @option{-mno-apcs-frame}.
15370 This option is deprecated.
15372 @item -mapcs
15373 @opindex mapcs
15374 This is a synonym for @option{-mapcs-frame} and is deprecated.
15376 @ignore
15377 @c not currently implemented
15378 @item -mapcs-stack-check
15379 @opindex mapcs-stack-check
15380 Generate code to check the amount of stack space available upon entry to
15381 every function (that actually uses some stack space).  If there is
15382 insufficient space available then either the function
15383 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15384 called, depending upon the amount of stack space required.  The runtime
15385 system is required to provide these functions.  The default is
15386 @option{-mno-apcs-stack-check}, since this produces smaller code.
15388 @c not currently implemented
15389 @item -mapcs-reentrant
15390 @opindex mapcs-reentrant
15391 Generate reentrant, position-independent code.  The default is
15392 @option{-mno-apcs-reentrant}.
15393 @end ignore
15395 @item -mthumb-interwork
15396 @opindex mthumb-interwork
15397 Generate code that supports calling between the ARM and Thumb
15398 instruction sets.  Without this option, on pre-v5 architectures, the
15399 two instruction sets cannot be reliably used inside one program.  The
15400 default is @option{-mno-thumb-interwork}, since slightly larger code
15401 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15402 configurations this option is meaningless.
15404 @item -mno-sched-prolog
15405 @opindex mno-sched-prolog
15406 Prevent the reordering of instructions in the function prologue, or the
15407 merging of those instruction with the instructions in the function's
15408 body.  This means that all functions start with a recognizable set
15409 of instructions (or in fact one of a choice from a small set of
15410 different function prologues), and this information can be used to
15411 locate the start of functions inside an executable piece of code.  The
15412 default is @option{-msched-prolog}.
15414 @item -mfloat-abi=@var{name}
15415 @opindex mfloat-abi
15416 Specifies which floating-point ABI to use.  Permissible values
15417 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15419 Specifying @samp{soft} causes GCC to generate output containing
15420 library calls for floating-point operations.
15421 @samp{softfp} allows the generation of code using hardware floating-point
15422 instructions, but still uses the soft-float calling conventions.
15423 @samp{hard} allows generation of floating-point instructions
15424 and uses FPU-specific calling conventions.
15426 The default depends on the specific target configuration.  Note that
15427 the hard-float and soft-float ABIs are not link-compatible; you must
15428 compile your entire program with the same ABI, and link with a
15429 compatible set of libraries.
15431 @item -mlittle-endian
15432 @opindex mlittle-endian
15433 Generate code for a processor running in little-endian mode.  This is
15434 the default for all standard configurations.
15436 @item -mbig-endian
15437 @opindex mbig-endian
15438 Generate code for a processor running in big-endian mode; the default is
15439 to compile code for a little-endian processor.
15441 @item -mbe8
15442 @itemx -mbe32
15443 @opindex mbe8
15444 When linking a big-endian image select between BE8 and BE32 formats.
15445 The option has no effect for little-endian images and is ignored.  The
15446 default is dependent on the selected target architecture.  For ARMv6
15447 and later architectures the default is BE8, for older architectures
15448 the default is BE32.  BE32 format has been deprecated by ARM.
15450 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15451 @opindex march
15452 This specifies the name of the target ARM architecture.  GCC uses this
15453 name to determine what kind of instructions it can emit when generating
15454 assembly code.  This option can be used in conjunction with or instead
15455 of the @option{-mcpu=} option.
15457 Permissible names are:
15458 @samp{armv4t},
15459 @samp{armv5t}, @samp{armv5te},
15460 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15461 @samp{armv6z}, @samp{armv6zk},
15462 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15463 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15464 @samp{armv7-r},
15465 @samp{armv8-r},
15466 @samp{armv6-m}, @samp{armv6s-m},
15467 @samp{armv7-m}, @samp{armv7e-m},
15468 @samp{armv8-m.base}, @samp{armv8-m.main},
15469 @samp{iwmmxt} and @samp{iwmmxt2}.
15471 Additionally, the following architectures, which lack support for the
15472 Thumb exection state, are recognized but support is deprecated:
15473 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15474 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15476 Many of the architectures support extensions.  These can be added by
15477 appending @samp{+@var{extension}} to the architecture name.  Extension
15478 options are processed in order and capabilities accumulate.  An extension
15479 will also enable any necessary base extensions
15480 upon which it depends.  For example, the @samp{+crypto} extension
15481 will always enable the @samp{+simd} extension.  The exception to the
15482 additive construction is for extensions that are prefixed with
15483 @samp{+no@dots{}}: these extensions disable the specified option and
15484 any other extensions that may depend on the presence of that
15485 extension.
15487 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15488 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15489 entirely disabled by the @samp{+nofp} option that follows it.
15491 Most extension names are generically named, but have an effect that is
15492 dependent upon the architecture to which it is applied.  For example,
15493 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15494 @samp{armv8-a} architectures, but will enable the original ARMv7
15495 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15496 variant for @samp{armv8-a}.
15498 The table below lists the supported extensions for each architecture.
15499 Architectures not mentioned do not support any extensions.
15501 @table @samp
15502 @item  armv5e
15503 @itemx armv5te
15504 @itemx armv6
15505 @itemx armv6j
15506 @itemx armv6k
15507 @itemx armv6kz
15508 @itemx armv6t2
15509 @itemx armv6z
15510 @itemx armv6zk
15511 @table @samp
15512 @item +fp
15513 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15514 used as an alias for this extension.
15516 @item +nofp
15517 Disable the floating-point instructions.
15518 @end table
15520 @item armv7
15521 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15522 @table @samp
15523 @item +fp
15524 The VFPv3 floating-point instructions, with 16 double-precision
15525 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15526 for this extension.  Note that floating-point is not supported by the
15527 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15528 ARMv7-R architectures.
15530 @item +nofp
15531 Disable the floating-point instructions.
15532 @end table
15534 @item armv7-a
15535 @table @samp
15536 @item +fp
15537 The VFPv3 floating-point instructions, with 16 double-precision
15538 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15539 for this extension.
15541 @item +simd
15542 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15543 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15544 for this extension.
15546 @item +vfpv3
15547 The VFPv3 floating-point instructions, with 32 double-precision
15548 registers.
15550 @item +vfpv3-d16-fp16
15551 The VFPv3 floating-point instructions, with 16 double-precision
15552 registers and the half-precision floating-point conversion operations.
15554 @item +vfpv3-fp16
15555 The VFPv3 floating-point instructions, with 32 double-precision
15556 registers and the half-precision floating-point conversion operations.
15558 @item +vfpv4-d16
15559 The VFPv4 floating-point instructions, with 16 double-precision
15560 registers.
15562 @item +vfpv4
15563 The VFPv4 floating-point instructions, with 32 double-precision
15564 registers.
15566 @item +neon-fp16
15567 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15568 the half-precision floating-point conversion operations.
15570 @item +neon-vfpv4
15571 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15573 @item +nosimd
15574 Disable the Advanced SIMD instructions (does not disable floating point).
15576 @item +nofp
15577 Disable the floating-point and Advanced SIMD instructions.
15578 @end table
15580 @item armv7ve
15581 The extended version of the ARMv7-A architecture with support for
15582 virtualization.
15583 @table @samp
15584 @item +fp
15585 The VFPv4 floating-point instructions, with 16 double-precision registers.
15586 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15588 @item +simd
15589 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15590 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15592 @item +vfpv3-d16
15593 The VFPv3 floating-point instructions, with 16 double-precision
15594 registers.
15596 @item +vfpv3
15597 The VFPv3 floating-point instructions, with 32 double-precision
15598 registers.
15600 @item +vfpv3-d16-fp16
15601 The VFPv3 floating-point instructions, with 16 double-precision
15602 registers and the half-precision floating-point conversion operations.
15604 @item +vfpv3-fp16
15605 The VFPv3 floating-point instructions, with 32 double-precision
15606 registers and the half-precision floating-point conversion operations.
15608 @item +vfpv4-d16
15609 The VFPv4 floating-point instructions, with 16 double-precision
15610 registers.
15612 @item +vfpv4
15613 The VFPv4 floating-point instructions, with 32 double-precision
15614 registers.
15616 @item +neon
15617 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15618 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15620 @item +neon-fp16
15621 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15622 the half-precision floating-point conversion operations.
15624 @item +nosimd
15625 Disable the Advanced SIMD instructions (does not disable floating point).
15627 @item +nofp
15628 Disable the floating-point and Advanced SIMD instructions.
15629 @end table
15631 @item armv8-a
15632 @table @samp
15633 @item +crc
15634 The Cyclic Redundancy Check (CRC) instructions.
15635 @item +simd
15636 The ARMv8 Advanced SIMD and floating-point instructions.
15637 @item +crypto
15638 The cryptographic instructions.
15639 @item +nocrypto
15640 Disable the cryptographic isntructions.
15641 @item +nofp
15642 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15643 @end table
15645 @item armv8.1-a
15646 @table @samp
15647 @item +simd
15648 The ARMv8.1 Advanced SIMD and floating-point instructions.
15650 @item +crypto
15651 The cryptographic instructions.  This also enables the Advanced SIMD and
15652 floating-point instructions.
15654 @item +nocrypto
15655 Disable the cryptographic isntructions.
15657 @item +nofp
15658 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15659 @end table
15661 @item armv8.2-a
15662 @table @samp
15663 @item +fp16
15664 The half-precision floating-point data processing instructions.
15665 This also enables the Advanced SIMD and floating-point instructions.
15667 @item +simd
15668 The ARMv8.1 Advanced SIMD and floating-point instructions.
15670 @item +crypto
15671 The cryptographic instructions.  This also enables the Advanced SIMD and
15672 floating-point instructions.
15674 @item +dotprod
15675 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15677 @item +nocrypto
15678 Disable the cryptographic extension.
15680 @item +nofp
15681 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15682 @end table
15684 @item armv7-r
15685 @table @samp
15686 @item +fp.sp
15687 The single-precision VFPv3 floating-point instructions.  The extension
15688 @samp{+vfpv3xd} can be used as an alias for this extension.
15690 @item +fp
15691 The VFPv3 floating-point instructions with 16 double-precision registers.
15692 The extension +vfpv3-d16 can be used as an alias for this extension.
15694 @item +nofp
15695 Disable the floating-point extension.
15697 @item +idiv
15698 The ARM-state integer division instructions.
15700 @item +noidiv
15701 Disable the ARM-state integer division extension.
15702 @end table
15704 @item armv7e-m
15705 @table @samp
15706 @item +fp
15707 The single-precision VFPv4 floating-point instructions.
15709 @item +fpv5
15710 The single-precision FPv5 floating-point instructions.
15712 @item +fp.dp
15713 The single- and double-precision FPv5 floating-point instructions.
15715 @item +nofp
15716 Disable the floating-point extensions.
15717 @end table
15719 @item  armv8-m.main
15720 @table @samp
15721 @item +dsp
15722 The DSP instructions.
15724 @item +nodsp
15725 Disable the DSP extension.
15727 @item +fp
15728 The single-precision floating-point instructions.
15730 @item +fp.dp
15731 The single- and double-precision floating-point instructions.
15733 @item +nofp
15734 Disable the floating-point extension.
15735 @end table
15737 @item armv8-r
15738 @table @samp
15739 @item +crc
15740 The Cyclic Redundancy Check (CRC) instructions.
15741 @item +fp.sp
15742 The single-precision FPv5 floating-point instructions.
15743 @item +simd
15744 The ARMv8 Advanced SIMD and floating-point instructions.
15745 @item +crypto
15746 The cryptographic instructions.
15747 @item +nocrypto
15748 Disable the cryptographic isntructions.
15749 @item +nofp
15750 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15751 @end table
15753 @end table
15755 @option{-march=native} causes the compiler to auto-detect the architecture
15756 of the build computer.  At present, this feature is only supported on
15757 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15758 is unsuccessful the option has no effect.
15760 @item -mtune=@var{name}
15761 @opindex mtune
15762 This option specifies the name of the target ARM processor for
15763 which GCC should tune the performance of the code.
15764 For some ARM implementations better performance can be obtained by using
15765 this option.
15766 Permissible names are: @samp{arm2}, @samp{arm250},
15767 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15768 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15769 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15770 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15771 @samp{arm720},
15772 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15773 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15774 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15775 @samp{strongarm1110},
15776 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15777 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15778 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15779 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15780 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15781 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15782 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15783 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15784 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15785 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15786 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15787 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15788 @samp{cortex-r8}, @samp{cortex-r52},
15789 @samp{cortex-m33},
15790 @samp{cortex-m23},
15791 @samp{cortex-m7},
15792 @samp{cortex-m4},
15793 @samp{cortex-m3},
15794 @samp{cortex-m1},
15795 @samp{cortex-m0},
15796 @samp{cortex-m0plus},
15797 @samp{cortex-m1.small-multiply},
15798 @samp{cortex-m0.small-multiply},
15799 @samp{cortex-m0plus.small-multiply},
15800 @samp{exynos-m1},
15801 @samp{marvell-pj4},
15802 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15803 @samp{fa526}, @samp{fa626},
15804 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15805 @samp{xgene1}.
15807 Additionally, this option can specify that GCC should tune the performance
15808 of the code for a big.LITTLE system.  Permissible names are:
15809 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15810 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15811 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15812 @samp{cortex-a75.cortex-a55}.
15814 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15815 performance for a blend of processors within architecture @var{arch}.
15816 The aim is to generate code that run well on the current most popular
15817 processors, balancing between optimizations that benefit some CPUs in the
15818 range, and avoiding performance pitfalls of other CPUs.  The effects of
15819 this option may change in future GCC versions as CPU models come and go.
15821 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15822 the extension options do not affect the tuning of the generated code.
15824 @option{-mtune=native} causes the compiler to auto-detect the CPU
15825 of the build computer.  At present, this feature is only supported on
15826 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15827 unsuccessful the option has no effect.
15829 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15830 @opindex mcpu
15831 This specifies the name of the target ARM processor.  GCC uses this name
15832 to derive the name of the target ARM architecture (as if specified
15833 by @option{-march}) and the ARM processor type for which to tune for
15834 performance (as if specified by @option{-mtune}).  Where this option
15835 is used in conjunction with @option{-march} or @option{-mtune},
15836 those options take precedence over the appropriate part of this option.
15838 Many of the supported CPUs implement optional architectural
15839 extensions.  Where this is so the architectural extensions are
15840 normally enabled by default.  If implementations that lack the
15841 extension exist, then the extension syntax can be used to disable
15842 those extensions that have been omitted.  For floating-point and
15843 Advanced SIMD (Neon) instructions, the settings of the options
15844 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15845 floating-point and Advanced SIMD instructions will only be used if
15846 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15847 @option{-mfpu} other than @samp{auto} will override the available
15848 floating-point and SIMD extension instructions.
15850 For example, @samp{cortex-a9} can be found in three major
15851 configurations: integer only, with just a floating-point unit or with
15852 floating-point and Advanced SIMD.  The default is to enable all the
15853 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15854 be used to disable just the SIMD or both the SIMD and floating-point
15855 instructions respectively.
15857 Permissible names for this option are the same as those for
15858 @option{-mtune}.
15860 The following extension options are common to the listed CPUs:
15862 @table @samp
15863 @item +nodsp
15864 Disable the DSP instructions on @samp{cortex-m33}.
15866 @item  +nofp
15867 Disables the floating-point instructions on @samp{arm9e},
15868 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15869 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15870 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15871 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15872 Disables the floating-point and SIMD instructions on
15873 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15874 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15875 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15876 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15877 @samp{cortex-a53} and @samp{cortex-a55}.
15879 @item +nofp.dp
15880 Disables the double-precision component of the floating-point instructions
15881 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15883 @item +nosimd
15884 Disables the SIMD (but not floating-point) instructions on
15885 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15886 and @samp{cortex-a9}.
15888 @item +crypto
15889 Enables the cryptographic instructions on @samp{cortex-a32},
15890 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15891 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15892 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15893 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15894 @samp{cortex-a75.cortex-a55}.
15895 @end table
15897 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15898 VFPv3 with 16 double-precision registers.  It supports the following
15899 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15900 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15901 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15902 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15903 @option{-march=armv7-a}.
15905 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15906 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15907 See @option{-mtune} for more information.
15909 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15910 of the build computer.  At present, this feature is only supported on
15911 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15912 is unsuccessful the option has no effect.
15914 @item -mfpu=@var{name}
15915 @opindex mfpu
15916 This specifies what floating-point hardware (or hardware emulation) is
15917 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15918 @samp{vfpv3},
15919 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15920 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15921 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15922 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15923 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15924 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15925 is an alias for @samp{vfpv2}.
15927 The setting @samp{auto} is the default and is special.  It causes the
15928 compiler to select the floating-point and Advanced SIMD instructions
15929 based on the settings of @option{-mcpu} and @option{-march}.
15931 If the selected floating-point hardware includes the NEON extension
15932 (e.g. @option{-mfpu=neon}), note that floating-point
15933 operations are not generated by GCC's auto-vectorization pass unless
15934 @option{-funsafe-math-optimizations} is also specified.  This is
15935 because NEON hardware does not fully implement the IEEE 754 standard for
15936 floating-point arithmetic (in particular denormal values are treated as
15937 zero), so the use of NEON instructions may lead to a loss of precision.
15939 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}).
15941 @item -mfp16-format=@var{name}
15942 @opindex mfp16-format
15943 Specify the format of the @code{__fp16} half-precision floating-point type.
15944 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15945 the default is @samp{none}, in which case the @code{__fp16} type is not
15946 defined.  @xref{Half-Precision}, for more information.
15948 @item -mstructure-size-boundary=@var{n}
15949 @opindex mstructure-size-boundary
15950 The sizes of all structures and unions are rounded up to a multiple
15951 of the number of bits set by this option.  Permissible values are 8, 32
15952 and 64.  The default value varies for different toolchains.  For the COFF
15953 targeted toolchain the default value is 8.  A value of 64 is only allowed
15954 if the underlying ABI supports it.
15956 Specifying a larger number can produce faster, more efficient code, but
15957 can also increase the size of the program.  Different values are potentially
15958 incompatible.  Code compiled with one value cannot necessarily expect to
15959 work with code or libraries compiled with another value, if they exchange
15960 information using structures or unions.
15962 This option is deprecated.
15964 @item -mabort-on-noreturn
15965 @opindex mabort-on-noreturn
15966 Generate a call to the function @code{abort} at the end of a
15967 @code{noreturn} function.  It is executed if the function tries to
15968 return.
15970 @item -mlong-calls
15971 @itemx -mno-long-calls
15972 @opindex mlong-calls
15973 @opindex mno-long-calls
15974 Tells the compiler to perform function calls by first loading the
15975 address of the function into a register and then performing a subroutine
15976 call on this register.  This switch is needed if the target function
15977 lies outside of the 64-megabyte addressing range of the offset-based
15978 version of subroutine call instruction.
15980 Even if this switch is enabled, not all function calls are turned
15981 into long calls.  The heuristic is that static functions, functions
15982 that have the @code{short_call} attribute, functions that are inside
15983 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15984 definitions have already been compiled within the current compilation
15985 unit are not turned into long calls.  The exceptions to this rule are
15986 that weak function definitions, functions with the @code{long_call}
15987 attribute or the @code{section} attribute, and functions that are within
15988 the scope of a @code{#pragma long_calls} directive are always
15989 turned into long calls.
15991 This feature is not enabled by default.  Specifying
15992 @option{-mno-long-calls} restores the default behavior, as does
15993 placing the function calls within the scope of a @code{#pragma
15994 long_calls_off} directive.  Note these switches have no effect on how
15995 the compiler generates code to handle function calls via function
15996 pointers.
15998 @item -msingle-pic-base
15999 @opindex msingle-pic-base
16000 Treat the register used for PIC addressing as read-only, rather than
16001 loading it in the prologue for each function.  The runtime system is
16002 responsible for initializing this register with an appropriate value
16003 before execution begins.
16005 @item -mpic-register=@var{reg}
16006 @opindex mpic-register
16007 Specify the register to be used for PIC addressing.
16008 For standard PIC base case, the default is any suitable register
16009 determined by compiler.  For single PIC base case, the default is
16010 @samp{R9} if target is EABI based or stack-checking is enabled,
16011 otherwise the default is @samp{R10}.
16013 @item -mpic-data-is-text-relative
16014 @opindex mpic-data-is-text-relative
16015 Assume that the displacement between the text and data segments is fixed
16016 at static link time.  This permits using PC-relative addressing
16017 operations to access data known to be in the data segment.  For
16018 non-VxWorks RTP targets, this option is enabled by default.  When
16019 disabled on such targets, it will enable @option{-msingle-pic-base} by
16020 default.
16022 @item -mpoke-function-name
16023 @opindex mpoke-function-name
16024 Write the name of each function into the text section, directly
16025 preceding the function prologue.  The generated code is similar to this:
16027 @smallexample
16028      t0
16029          .ascii "arm_poke_function_name", 0
16030          .align
16031      t1
16032          .word 0xff000000 + (t1 - t0)
16033      arm_poke_function_name
16034          mov     ip, sp
16035          stmfd   sp!, @{fp, ip, lr, pc@}
16036          sub     fp, ip, #4
16037 @end smallexample
16039 When performing a stack backtrace, code can inspect the value of
16040 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16041 location @code{pc - 12} and the top 8 bits are set, then we know that
16042 there is a function name embedded immediately preceding this location
16043 and has length @code{((pc[-3]) & 0xff000000)}.
16045 @item -mthumb
16046 @itemx -marm
16047 @opindex marm
16048 @opindex mthumb
16050 Select between generating code that executes in ARM and Thumb
16051 states.  The default for most configurations is to generate code
16052 that executes in ARM state, but the default can be changed by
16053 configuring GCC with the @option{--with-mode=}@var{state}
16054 configure option.
16056 You can also override the ARM and Thumb mode for each function
16057 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16058 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16060 @item -mtpcs-frame
16061 @opindex mtpcs-frame
16062 Generate a stack frame that is compliant with the Thumb Procedure Call
16063 Standard for all non-leaf functions.  (A leaf function is one that does
16064 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16066 @item -mtpcs-leaf-frame
16067 @opindex mtpcs-leaf-frame
16068 Generate a stack frame that is compliant with the Thumb Procedure Call
16069 Standard for all leaf functions.  (A leaf function is one that does
16070 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16072 @item -mcallee-super-interworking
16073 @opindex mcallee-super-interworking
16074 Gives all externally visible functions in the file being compiled an ARM
16075 instruction set header which switches to Thumb mode before executing the
16076 rest of the function.  This allows these functions to be called from
16077 non-interworking code.  This option is not valid in AAPCS configurations
16078 because interworking is enabled by default.
16080 @item -mcaller-super-interworking
16081 @opindex mcaller-super-interworking
16082 Allows calls via function pointers (including virtual functions) to
16083 execute correctly regardless of whether the target code has been
16084 compiled for interworking or not.  There is a small overhead in the cost
16085 of executing a function pointer if this option is enabled.  This option
16086 is not valid in AAPCS configurations because interworking is enabled
16087 by default.
16089 @item -mtp=@var{name}
16090 @opindex mtp
16091 Specify the access model for the thread local storage pointer.  The valid
16092 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16093 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16094 (supported in the arm6k architecture), and @samp{auto}, which uses the
16095 best available method for the selected processor.  The default setting is
16096 @samp{auto}.
16098 @item -mtls-dialect=@var{dialect}
16099 @opindex mtls-dialect
16100 Specify the dialect to use for accessing thread local storage.  Two
16101 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16102 @samp{gnu} dialect selects the original GNU scheme for supporting
16103 local and global dynamic TLS models.  The @samp{gnu2} dialect
16104 selects the GNU descriptor scheme, which provides better performance
16105 for shared libraries.  The GNU descriptor scheme is compatible with
16106 the original scheme, but does require new assembler, linker and
16107 library support.  Initial and local exec TLS models are unaffected by
16108 this option and always use the original scheme.
16110 @item -mword-relocations
16111 @opindex mword-relocations
16112 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16113 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16114 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16115 is specified.
16117 @item -mfix-cortex-m3-ldrd
16118 @opindex mfix-cortex-m3-ldrd
16119 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16120 with overlapping destination and base registers are used.  This option avoids
16121 generating these instructions.  This option is enabled by default when
16122 @option{-mcpu=cortex-m3} is specified.
16124 @item -munaligned-access
16125 @itemx -mno-unaligned-access
16126 @opindex munaligned-access
16127 @opindex mno-unaligned-access
16128 Enables (or disables) reading and writing of 16- and 32- bit values
16129 from addresses that are not 16- or 32- bit aligned.  By default
16130 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16131 ARMv8-M Baseline architectures, and enabled for all other
16132 architectures.  If unaligned access is not enabled then words in packed
16133 data structures are accessed a byte at a time.
16135 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16136 generated object file to either true or false, depending upon the
16137 setting of this option.  If unaligned access is enabled then the
16138 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16139 defined.
16141 @item -mneon-for-64bits
16142 @opindex mneon-for-64bits
16143 Enables using Neon to handle scalar 64-bits operations. This is
16144 disabled by default since the cost of moving data from core registers
16145 to Neon is high.
16147 @item -mslow-flash-data
16148 @opindex mslow-flash-data
16149 Assume loading data from flash is slower than fetching instruction.
16150 Therefore literal load is minimized for better performance.
16151 This option is only supported when compiling for ARMv7 M-profile and
16152 off by default.
16154 @item -masm-syntax-unified
16155 @opindex masm-syntax-unified
16156 Assume inline assembler is using unified asm syntax.  The default is
16157 currently off which implies divided syntax.  This option has no impact
16158 on Thumb2. However, this may change in future releases of GCC.
16159 Divided syntax should be considered deprecated.
16161 @item -mrestrict-it
16162 @opindex mrestrict-it
16163 Restricts generation of IT blocks to conform to the rules of ARMv8.
16164 IT blocks can only contain a single 16-bit instruction from a select
16165 set of instructions. This option is on by default for ARMv8 Thumb mode.
16167 @item -mprint-tune-info
16168 @opindex mprint-tune-info
16169 Print CPU tuning information as comment in assembler file.  This is
16170 an option used only for regression testing of the compiler and not
16171 intended for ordinary use in compiling code.  This option is disabled
16172 by default.
16174 @item -mpure-code
16175 @opindex mpure-code
16176 Do not allow constant data to be placed in code sections.
16177 Additionally, when compiling for ELF object format give all text sections the
16178 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16179 is only available when generating non-pic code for M-profile targets with the
16180 MOVT instruction.
16182 @item -mcmse
16183 @opindex mcmse
16184 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16185 Development Tools Engineering Specification", which can be found on
16186 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16187 @end table
16189 @node AVR Options
16190 @subsection AVR Options
16191 @cindex AVR Options
16193 These options are defined for AVR implementations:
16195 @table @gcctabopt
16196 @item -mmcu=@var{mcu}
16197 @opindex mmcu
16198 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16200 The default for this option is@tie{}@samp{avr2}.
16202 GCC supports the following AVR devices and ISAs:
16204 @include avr-mmcu.texi
16206 @item -mabsdata
16207 @opindex mabsdata
16209 Assume that all data in static storage can be accessed by LDS / STS
16210 instructions.  This option has only an effect on reduced Tiny devices like
16211 ATtiny40.  See also the @code{absdata}
16212 @ref{AVR Variable Attributes,variable attribute}.
16214 @item -maccumulate-args
16215 @opindex maccumulate-args
16216 Accumulate outgoing function arguments and acquire/release the needed
16217 stack space for outgoing function arguments once in function
16218 prologue/epilogue.  Without this option, outgoing arguments are pushed
16219 before calling a function and popped afterwards.
16221 Popping the arguments after the function call can be expensive on
16222 AVR so that accumulating the stack space might lead to smaller
16223 executables because arguments need not be removed from the
16224 stack after such a function call.
16226 This option can lead to reduced code size for functions that perform
16227 several calls to functions that get their arguments on the stack like
16228 calls to printf-like functions.
16230 @item -mbranch-cost=@var{cost}
16231 @opindex mbranch-cost
16232 Set the branch costs for conditional branch instructions to
16233 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16234 integers. The default branch cost is 0.
16236 @item -mcall-prologues
16237 @opindex mcall-prologues
16238 Functions prologues/epilogues are expanded as calls to appropriate
16239 subroutines.  Code size is smaller.
16241 @item -mgas-isr-prologues
16242 @opindex mgas-isr-prologues
16243 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16244 instruction supported by GNU Binutils.
16245 If this option is on, the feature can still be disabled for individual
16246 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16247 function attribute.  This feature is activated per default
16248 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16249 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16251 @item -mint8
16252 @opindex mint8
16253 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16254 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16255 and @code{long long} is 4 bytes.  Please note that this option does not
16256 conform to the C standards, but it results in smaller code
16257 size.
16259 @item -mn-flash=@var{num}
16260 @opindex mn-flash
16261 Assume that the flash memory has a size of 
16262 @var{num} times 64@tie{}KiB.
16264 @item -mno-interrupts
16265 @opindex mno-interrupts
16266 Generated code is not compatible with hardware interrupts.
16267 Code size is smaller.
16269 @item -mrelax
16270 @opindex mrelax
16271 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16272 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16273 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16274 the assembler's command line and the @option{--relax} option to the
16275 linker's command line.
16277 Jump relaxing is performed by the linker because jump offsets are not
16278 known before code is located. Therefore, the assembler code generated by the
16279 compiler is the same, but the instructions in the executable may
16280 differ from instructions in the assembler code.
16282 Relaxing must be turned on if linker stubs are needed, see the
16283 section on @code{EIND} and linker stubs below.
16285 @item -mrmw
16286 @opindex mrmw
16287 Assume that the device supports the Read-Modify-Write
16288 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16290 @item -mshort-calls
16291 @opindex mshort-calls
16293 Assume that @code{RJMP} and @code{RCALL} can target the whole
16294 program memory.
16296 This option is used internally for multilib selection.  It is
16297 not an optimization option, and you don't need to set it by hand.
16299 @item -msp8
16300 @opindex msp8
16301 Treat the stack pointer register as an 8-bit register,
16302 i.e.@: assume the high byte of the stack pointer is zero.
16303 In general, you don't need to set this option by hand.
16305 This option is used internally by the compiler to select and
16306 build multilibs for architectures @code{avr2} and @code{avr25}.
16307 These architectures mix devices with and without @code{SPH}.
16308 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16309 the compiler driver adds or removes this option from the compiler
16310 proper's command line, because the compiler then knows if the device
16311 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16312 register or not.
16314 @item -mstrict-X
16315 @opindex mstrict-X
16316 Use address register @code{X} in a way proposed by the hardware.  This means
16317 that @code{X} is only used in indirect, post-increment or
16318 pre-decrement addressing.
16320 Without this option, the @code{X} register may be used in the same way
16321 as @code{Y} or @code{Z} which then is emulated by additional
16322 instructions.  
16323 For example, loading a value with @code{X+const} addressing with a
16324 small non-negative @code{const < 64} to a register @var{Rn} is
16325 performed as
16327 @example
16328 adiw r26, const   ; X += const
16329 ld   @var{Rn}, X        ; @var{Rn} = *X
16330 sbiw r26, const   ; X -= const
16331 @end example
16333 @item -mtiny-stack
16334 @opindex mtiny-stack
16335 Only change the lower 8@tie{}bits of the stack pointer.
16337 @item -mfract-convert-truncate
16338 @opindex mfract-convert-truncate
16339 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16341 @item -nodevicelib
16342 @opindex nodevicelib
16343 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16345 @item -Waddr-space-convert
16346 @opindex Waddr-space-convert
16347 Warn about conversions between address spaces in the case where the
16348 resulting address space is not contained in the incoming address space.
16350 @item -Wmisspelled-isr
16351 @opindex Wmisspelled-isr
16352 Warn if the ISR is misspelled, i.e. without __vector prefix.
16353 Enabled by default.
16354 @end table
16356 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16357 @cindex @code{EIND}
16358 Pointers in the implementation are 16@tie{}bits wide.
16359 The address of a function or label is represented as word address so
16360 that indirect jumps and calls can target any code address in the
16361 range of 64@tie{}Ki words.
16363 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16364 bytes of program memory space, there is a special function register called
16365 @code{EIND} that serves as most significant part of the target address
16366 when @code{EICALL} or @code{EIJMP} instructions are used.
16368 Indirect jumps and calls on these devices are handled as follows by
16369 the compiler and are subject to some limitations:
16371 @itemize @bullet
16373 @item
16374 The compiler never sets @code{EIND}.
16376 @item
16377 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16378 instructions or might read @code{EIND} directly in order to emulate an
16379 indirect call/jump by means of a @code{RET} instruction.
16381 @item
16382 The compiler assumes that @code{EIND} never changes during the startup
16383 code or during the application. In particular, @code{EIND} is not
16384 saved/restored in function or interrupt service routine
16385 prologue/epilogue.
16387 @item
16388 For indirect calls to functions and computed goto, the linker
16389 generates @emph{stubs}. Stubs are jump pads sometimes also called
16390 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16391 The stub contains a direct jump to the desired address.
16393 @item
16394 Linker relaxation must be turned on so that the linker generates
16395 the stubs correctly in all situations. See the compiler option
16396 @option{-mrelax} and the linker option @option{--relax}.
16397 There are corner cases where the linker is supposed to generate stubs
16398 but aborts without relaxation and without a helpful error message.
16400 @item
16401 The default linker script is arranged for code with @code{EIND = 0}.
16402 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16403 linker script has to be used in order to place the sections whose
16404 name start with @code{.trampolines} into the segment where @code{EIND}
16405 points to.
16407 @item
16408 The startup code from libgcc never sets @code{EIND}.
16409 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16410 For the impact of AVR-LibC on @code{EIND}, see the
16411 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16413 @item
16414 It is legitimate for user-specific startup code to set up @code{EIND}
16415 early, for example by means of initialization code located in
16416 section @code{.init3}. Such code runs prior to general startup code
16417 that initializes RAM and calls constructors, but after the bit
16418 of startup code from AVR-LibC that sets @code{EIND} to the segment
16419 where the vector table is located.
16420 @example
16421 #include <avr/io.h>
16423 static void
16424 __attribute__((section(".init3"),naked,used,no_instrument_function))
16425 init3_set_eind (void)
16427   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16428                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16430 @end example
16432 @noindent
16433 The @code{__trampolines_start} symbol is defined in the linker script.
16435 @item
16436 Stubs are generated automatically by the linker if
16437 the following two conditions are met:
16438 @itemize @minus
16440 @item The address of a label is taken by means of the @code{gs} modifier
16441 (short for @emph{generate stubs}) like so:
16442 @example
16443 LDI r24, lo8(gs(@var{func}))
16444 LDI r25, hi8(gs(@var{func}))
16445 @end example
16446 @item The final location of that label is in a code segment
16447 @emph{outside} the segment where the stubs are located.
16448 @end itemize
16450 @item
16451 The compiler emits such @code{gs} modifiers for code labels in the
16452 following situations:
16453 @itemize @minus
16454 @item Taking address of a function or code label.
16455 @item Computed goto.
16456 @item If prologue-save function is used, see @option{-mcall-prologues}
16457 command-line option.
16458 @item Switch/case dispatch tables. If you do not want such dispatch
16459 tables you can specify the @option{-fno-jump-tables} command-line option.
16460 @item C and C++ constructors/destructors called during startup/shutdown.
16461 @item If the tools hit a @code{gs()} modifier explained above.
16462 @end itemize
16464 @item
16465 Jumping to non-symbolic addresses like so is @emph{not} supported:
16467 @example
16468 int main (void)
16470     /* Call function at word address 0x2 */
16471     return ((int(*)(void)) 0x2)();
16473 @end example
16475 Instead, a stub has to be set up, i.e.@: the function has to be called
16476 through a symbol (@code{func_4} in the example):
16478 @example
16479 int main (void)
16481     extern int func_4 (void);
16483     /* Call function at byte address 0x4 */
16484     return func_4();
16486 @end example
16488 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16489 Alternatively, @code{func_4} can be defined in the linker script.
16490 @end itemize
16492 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16493 @cindex @code{RAMPD}
16494 @cindex @code{RAMPX}
16495 @cindex @code{RAMPY}
16496 @cindex @code{RAMPZ}
16497 Some AVR devices support memories larger than the 64@tie{}KiB range
16498 that can be accessed with 16-bit pointers.  To access memory locations
16499 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16500 register is used as high part of the address:
16501 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16502 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16503 register, respectively, to get a wide address. Similarly,
16504 @code{RAMPD} is used together with direct addressing.
16506 @itemize
16507 @item
16508 The startup code initializes the @code{RAMP} special function
16509 registers with zero.
16511 @item
16512 If a @ref{AVR Named Address Spaces,named address space} other than
16513 generic or @code{__flash} is used, then @code{RAMPZ} is set
16514 as needed before the operation.
16516 @item
16517 If the device supports RAM larger than 64@tie{}KiB and the compiler
16518 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16519 is reset to zero after the operation.
16521 @item
16522 If the device comes with a specific @code{RAMP} register, the ISR
16523 prologue/epilogue saves/restores that SFR and initializes it with
16524 zero in case the ISR code might (implicitly) use it.
16526 @item
16527 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16528 If you use inline assembler to read from locations outside the
16529 16-bit address range and change one of the @code{RAMP} registers,
16530 you must reset it to zero after the access.
16532 @end itemize
16534 @subsubsection AVR Built-in Macros
16536 GCC defines several built-in macros so that the user code can test
16537 for the presence or absence of features.  Almost any of the following
16538 built-in macros are deduced from device capabilities and thus
16539 triggered by the @option{-mmcu=} command-line option.
16541 For even more AVR-specific built-in macros see
16542 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16544 @table @code
16546 @item __AVR_ARCH__
16547 Build-in macro that resolves to a decimal number that identifies the
16548 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16549 Possible values are:
16551 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16552 @code{4}, @code{5}, @code{51}, @code{6}
16554 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16555 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16557 respectively and
16559 @code{100},
16560 @code{102}, @code{103}, @code{104},
16561 @code{105}, @code{106}, @code{107}
16563 for @var{mcu}=@code{avrtiny},
16564 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16565 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16566 If @var{mcu} specifies a device, this built-in macro is set
16567 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16568 defined to @code{4}.
16570 @item __AVR_@var{Device}__
16571 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16572 the device's name. For example, @option{-mmcu=atmega8} defines the
16573 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16574 @code{__AVR_ATtiny261A__}, etc.
16576 The built-in macros' names follow
16577 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16578 the device name as from the AVR user manual. The difference between
16579 @var{Device} in the built-in macro and @var{device} in
16580 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16582 If @var{device} is not a device but only a core architecture like
16583 @samp{avr51}, this macro is not defined.
16585 @item __AVR_DEVICE_NAME__
16586 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16587 the device's name. For example, with @option{-mmcu=atmega8} the macro
16588 is defined to @code{atmega8}.
16590 If @var{device} is not a device but only a core architecture like
16591 @samp{avr51}, this macro is not defined.
16593 @item __AVR_XMEGA__
16594 The device / architecture belongs to the XMEGA family of devices.
16596 @item __AVR_HAVE_ELPM__
16597 The device has the @code{ELPM} instruction.
16599 @item __AVR_HAVE_ELPMX__
16600 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16601 R@var{n},Z+} instructions.
16603 @item __AVR_HAVE_MOVW__
16604 The device has the @code{MOVW} instruction to perform 16-bit
16605 register-register moves.
16607 @item __AVR_HAVE_LPMX__
16608 The device has the @code{LPM R@var{n},Z} and
16609 @code{LPM R@var{n},Z+} instructions.
16611 @item __AVR_HAVE_MUL__
16612 The device has a hardware multiplier. 
16614 @item __AVR_HAVE_JMP_CALL__
16615 The device has the @code{JMP} and @code{CALL} instructions.
16616 This is the case for devices with more than 8@tie{}KiB of program
16617 memory.
16619 @item __AVR_HAVE_EIJMP_EICALL__
16620 @itemx __AVR_3_BYTE_PC__
16621 The device has the @code{EIJMP} and @code{EICALL} instructions.
16622 This is the case for devices with more than 128@tie{}KiB of program memory.
16623 This also means that the program counter
16624 (PC) is 3@tie{}bytes wide.
16626 @item __AVR_2_BYTE_PC__
16627 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16628 with up to 128@tie{}KiB of program memory.
16630 @item __AVR_HAVE_8BIT_SP__
16631 @itemx __AVR_HAVE_16BIT_SP__
16632 The stack pointer (SP) register is treated as 8-bit respectively
16633 16-bit register by the compiler.
16634 The definition of these macros is affected by @option{-mtiny-stack}.
16636 @item __AVR_HAVE_SPH__
16637 @itemx __AVR_SP8__
16638 The device has the SPH (high part of stack pointer) special function
16639 register or has an 8-bit stack pointer, respectively.
16640 The definition of these macros is affected by @option{-mmcu=} and
16641 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16642 by @option{-msp8}.
16644 @item __AVR_HAVE_RAMPD__
16645 @itemx __AVR_HAVE_RAMPX__
16646 @itemx __AVR_HAVE_RAMPY__
16647 @itemx __AVR_HAVE_RAMPZ__
16648 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16649 @code{RAMPZ} special function register, respectively.
16651 @item __NO_INTERRUPTS__
16652 This macro reflects the @option{-mno-interrupts} command-line option.
16654 @item __AVR_ERRATA_SKIP__
16655 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16656 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16657 instructions because of a hardware erratum.  Skip instructions are
16658 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16659 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16660 set.
16662 @item __AVR_ISA_RMW__
16663 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16665 @item __AVR_SFR_OFFSET__=@var{offset}
16666 Instructions that can address I/O special function registers directly
16667 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16668 address as if addressed by an instruction to access RAM like @code{LD}
16669 or @code{STS}. This offset depends on the device architecture and has
16670 to be subtracted from the RAM address in order to get the
16671 respective I/O@tie{}address.
16673 @item __AVR_SHORT_CALLS__
16674 The @option{-mshort-calls} command line option is set.
16676 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16677 Some devices support reading from flash memory by means of @code{LD*}
16678 instructions.  The flash memory is seen in the data address space
16679 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16680 is not defined, this feature is not available.  If defined,
16681 the address space is linear and there is no need to put
16682 @code{.rodata} into RAM.  This is handled by the default linker
16683 description file, and is currently available for
16684 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16685 there is no need to use address spaces like @code{__flash} or
16686 features like attribute @code{progmem} and @code{pgm_read_*}.
16688 @item __WITH_AVRLIBC__
16689 The compiler is configured to be used together with AVR-Libc.
16690 See the @option{--with-avrlibc} configure option.
16692 @end table
16694 @node Blackfin Options
16695 @subsection Blackfin Options
16696 @cindex Blackfin Options
16698 @table @gcctabopt
16699 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16700 @opindex mcpu=
16701 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16702 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16703 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16704 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16705 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16706 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16707 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16708 @samp{bf561}, @samp{bf592}.
16710 The optional @var{sirevision} specifies the silicon revision of the target
16711 Blackfin processor.  Any workarounds available for the targeted silicon revision
16712 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16713 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16714 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16715 hexadecimal digits representing the major and minor numbers in the silicon
16716 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16717 is not defined.  If @var{sirevision} is @samp{any}, the
16718 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16719 If this optional @var{sirevision} is not used, GCC assumes the latest known
16720 silicon revision of the targeted Blackfin processor.
16722 GCC defines a preprocessor macro for the specified @var{cpu}.
16723 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16724 provided by libgloss to be linked in if @option{-msim} is not given.
16726 Without this option, @samp{bf532} is used as the processor by default.
16728 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16729 only the preprocessor macro is defined.
16731 @item -msim
16732 @opindex msim
16733 Specifies that the program will be run on the simulator.  This causes
16734 the simulator BSP provided by libgloss to be linked in.  This option
16735 has effect only for @samp{bfin-elf} toolchain.
16736 Certain other options, such as @option{-mid-shared-library} and
16737 @option{-mfdpic}, imply @option{-msim}.
16739 @item -momit-leaf-frame-pointer
16740 @opindex momit-leaf-frame-pointer
16741 Don't keep the frame pointer in a register for leaf functions.  This
16742 avoids the instructions to save, set up and restore frame pointers and
16743 makes an extra register available in leaf functions.  The option
16744 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16745 which might make debugging harder.
16747 @item -mspecld-anomaly
16748 @opindex mspecld-anomaly
16749 When enabled, the compiler ensures that the generated code does not
16750 contain speculative loads after jump instructions. If this option is used,
16751 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16753 @item -mno-specld-anomaly
16754 @opindex mno-specld-anomaly
16755 Don't generate extra code to prevent speculative loads from occurring.
16757 @item -mcsync-anomaly
16758 @opindex mcsync-anomaly
16759 When enabled, the compiler ensures that the generated code does not
16760 contain CSYNC or SSYNC instructions too soon after conditional branches.
16761 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16763 @item -mno-csync-anomaly
16764 @opindex mno-csync-anomaly
16765 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16766 occurring too soon after a conditional branch.
16768 @item -mlow-64k
16769 @opindex mlow-64k
16770 When enabled, the compiler is free to take advantage of the knowledge that
16771 the entire program fits into the low 64k of memory.
16773 @item -mno-low-64k
16774 @opindex mno-low-64k
16775 Assume that the program is arbitrarily large.  This is the default.
16777 @item -mstack-check-l1
16778 @opindex mstack-check-l1
16779 Do stack checking using information placed into L1 scratchpad memory by the
16780 uClinux kernel.
16782 @item -mid-shared-library
16783 @opindex mid-shared-library
16784 Generate code that supports shared libraries via the library ID method.
16785 This allows for execute in place and shared libraries in an environment
16786 without virtual memory management.  This option implies @option{-fPIC}.
16787 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16789 @item -mno-id-shared-library
16790 @opindex mno-id-shared-library
16791 Generate code that doesn't assume ID-based shared libraries are being used.
16792 This is the default.
16794 @item -mleaf-id-shared-library
16795 @opindex mleaf-id-shared-library
16796 Generate code that supports shared libraries via the library ID method,
16797 but assumes that this library or executable won't link against any other
16798 ID shared libraries.  That allows the compiler to use faster code for jumps
16799 and calls.
16801 @item -mno-leaf-id-shared-library
16802 @opindex mno-leaf-id-shared-library
16803 Do not assume that the code being compiled won't link against any ID shared
16804 libraries.  Slower code is generated for jump and call insns.
16806 @item -mshared-library-id=n
16807 @opindex mshared-library-id
16808 Specifies the identification number of the ID-based shared library being
16809 compiled.  Specifying a value of 0 generates more compact code; specifying
16810 other values forces the allocation of that number to the current
16811 library but is no more space- or time-efficient than omitting this option.
16813 @item -msep-data
16814 @opindex msep-data
16815 Generate code that allows the data segment to be located in a different
16816 area of memory from the text segment.  This allows for execute in place in
16817 an environment without virtual memory management by eliminating relocations
16818 against the text section.
16820 @item -mno-sep-data
16821 @opindex mno-sep-data
16822 Generate code that assumes that the data segment follows the text segment.
16823 This is the default.
16825 @item -mlong-calls
16826 @itemx -mno-long-calls
16827 @opindex mlong-calls
16828 @opindex mno-long-calls
16829 Tells the compiler to perform function calls by first loading the
16830 address of the function into a register and then performing a subroutine
16831 call on this register.  This switch is needed if the target function
16832 lies outside of the 24-bit addressing range of the offset-based
16833 version of subroutine call instruction.
16835 This feature is not enabled by default.  Specifying
16836 @option{-mno-long-calls} restores the default behavior.  Note these
16837 switches have no effect on how the compiler generates code to handle
16838 function calls via function pointers.
16840 @item -mfast-fp
16841 @opindex mfast-fp
16842 Link with the fast floating-point library. This library relaxes some of
16843 the IEEE floating-point standard's rules for checking inputs against
16844 Not-a-Number (NAN), in the interest of performance.
16846 @item -minline-plt
16847 @opindex minline-plt
16848 Enable inlining of PLT entries in function calls to functions that are
16849 not known to bind locally.  It has no effect without @option{-mfdpic}.
16851 @item -mmulticore
16852 @opindex mmulticore
16853 Build a standalone application for multicore Blackfin processors. 
16854 This option causes proper start files and link scripts supporting 
16855 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16856 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16858 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16859 selects the one-application-per-core programming model.  Without
16860 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16861 programming model is used. In this model, the main function of Core B
16862 should be named as @code{coreb_main}.
16864 If this option is not used, the single-core application programming
16865 model is used.
16867 @item -mcorea
16868 @opindex mcorea
16869 Build a standalone application for Core A of BF561 when using
16870 the one-application-per-core programming model. Proper start files
16871 and link scripts are used to support Core A, and the macro
16872 @code{__BFIN_COREA} is defined.
16873 This option can only be used in conjunction with @option{-mmulticore}.
16875 @item -mcoreb
16876 @opindex mcoreb
16877 Build a standalone application for Core B of BF561 when using
16878 the one-application-per-core programming model. Proper start files
16879 and link scripts are used to support Core B, and the macro
16880 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16881 should be used instead of @code{main}. 
16882 This option can only be used in conjunction with @option{-mmulticore}.
16884 @item -msdram
16885 @opindex msdram
16886 Build a standalone application for SDRAM. Proper start files and
16887 link scripts are used to put the application into SDRAM, and the macro
16888 @code{__BFIN_SDRAM} is defined.
16889 The loader should initialize SDRAM before loading the application.
16891 @item -micplb
16892 @opindex micplb
16893 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16894 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16895 are enabled; for standalone applications the default is off.
16896 @end table
16898 @node C6X Options
16899 @subsection C6X Options
16900 @cindex C6X Options
16902 @table @gcctabopt
16903 @item -march=@var{name}
16904 @opindex march
16905 This specifies the name of the target architecture.  GCC uses this
16906 name to determine what kind of instructions it can emit when generating
16907 assembly code.  Permissible names are: @samp{c62x},
16908 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16910 @item -mbig-endian
16911 @opindex mbig-endian
16912 Generate code for a big-endian target.
16914 @item -mlittle-endian
16915 @opindex mlittle-endian
16916 Generate code for a little-endian target.  This is the default.
16918 @item -msim
16919 @opindex msim
16920 Choose startup files and linker script suitable for the simulator.
16922 @item -msdata=default
16923 @opindex msdata=default
16924 Put small global and static data in the @code{.neardata} section,
16925 which is pointed to by register @code{B14}.  Put small uninitialized
16926 global and static data in the @code{.bss} section, which is adjacent
16927 to the @code{.neardata} section.  Put small read-only data into the
16928 @code{.rodata} section.  The corresponding sections used for large
16929 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16931 @item -msdata=all
16932 @opindex msdata=all
16933 Put all data, not just small objects, into the sections reserved for
16934 small data, and use addressing relative to the @code{B14} register to
16935 access them.
16937 @item -msdata=none
16938 @opindex msdata=none
16939 Make no use of the sections reserved for small data, and use absolute
16940 addresses to access all data.  Put all initialized global and static
16941 data in the @code{.fardata} section, and all uninitialized data in the
16942 @code{.far} section.  Put all constant data into the @code{.const}
16943 section.
16944 @end table
16946 @node CRIS Options
16947 @subsection CRIS Options
16948 @cindex CRIS Options
16950 These options are defined specifically for the CRIS ports.
16952 @table @gcctabopt
16953 @item -march=@var{architecture-type}
16954 @itemx -mcpu=@var{architecture-type}
16955 @opindex march
16956 @opindex mcpu
16957 Generate code for the specified architecture.  The choices for
16958 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16959 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16960 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16961 @samp{v10}.
16963 @item -mtune=@var{architecture-type}
16964 @opindex mtune
16965 Tune to @var{architecture-type} everything applicable about the generated
16966 code, except for the ABI and the set of available instructions.  The
16967 choices for @var{architecture-type} are the same as for
16968 @option{-march=@var{architecture-type}}.
16970 @item -mmax-stack-frame=@var{n}
16971 @opindex mmax-stack-frame
16972 Warn when the stack frame of a function exceeds @var{n} bytes.
16974 @item -metrax4
16975 @itemx -metrax100
16976 @opindex metrax4
16977 @opindex metrax100
16978 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16979 @option{-march=v3} and @option{-march=v8} respectively.
16981 @item -mmul-bug-workaround
16982 @itemx -mno-mul-bug-workaround
16983 @opindex mmul-bug-workaround
16984 @opindex mno-mul-bug-workaround
16985 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16986 models where it applies.  This option is active by default.
16988 @item -mpdebug
16989 @opindex mpdebug
16990 Enable CRIS-specific verbose debug-related information in the assembly
16991 code.  This option also has the effect of turning off the @samp{#NO_APP}
16992 formatted-code indicator to the assembler at the beginning of the
16993 assembly file.
16995 @item -mcc-init
16996 @opindex mcc-init
16997 Do not use condition-code results from previous instruction; always emit
16998 compare and test instructions before use of condition codes.
17000 @item -mno-side-effects
17001 @opindex mno-side-effects
17002 Do not emit instructions with side effects in addressing modes other than
17003 post-increment.
17005 @item -mstack-align
17006 @itemx -mno-stack-align
17007 @itemx -mdata-align
17008 @itemx -mno-data-align
17009 @itemx -mconst-align
17010 @itemx -mno-const-align
17011 @opindex mstack-align
17012 @opindex mno-stack-align
17013 @opindex mdata-align
17014 @opindex mno-data-align
17015 @opindex mconst-align
17016 @opindex mno-const-align
17017 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17018 stack frame, individual data and constants to be aligned for the maximum
17019 single data access size for the chosen CPU model.  The default is to
17020 arrange for 32-bit alignment.  ABI details such as structure layout are
17021 not affected by these options.
17023 @item -m32-bit
17024 @itemx -m16-bit
17025 @itemx -m8-bit
17026 @opindex m32-bit
17027 @opindex m16-bit
17028 @opindex m8-bit
17029 Similar to the stack- data- and const-align options above, these options
17030 arrange for stack frame, writable data and constants to all be 32-bit,
17031 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17033 @item -mno-prologue-epilogue
17034 @itemx -mprologue-epilogue
17035 @opindex mno-prologue-epilogue
17036 @opindex mprologue-epilogue
17037 With @option{-mno-prologue-epilogue}, the normal function prologue and
17038 epilogue which set up the stack frame are omitted and no return
17039 instructions or return sequences are generated in the code.  Use this
17040 option only together with visual inspection of the compiled code: no
17041 warnings or errors are generated when call-saved registers must be saved,
17042 or storage for local variables needs to be allocated.
17044 @item -mno-gotplt
17045 @itemx -mgotplt
17046 @opindex mno-gotplt
17047 @opindex mgotplt
17048 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17049 instruction sequences that load addresses for functions from the PLT part
17050 of the GOT rather than (traditional on other architectures) calls to the
17051 PLT@.  The default is @option{-mgotplt}.
17053 @item -melf
17054 @opindex melf
17055 Legacy no-op option only recognized with the cris-axis-elf and
17056 cris-axis-linux-gnu targets.
17058 @item -mlinux
17059 @opindex mlinux
17060 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17062 @item -sim
17063 @opindex sim
17064 This option, recognized for the cris-axis-elf, arranges
17065 to link with input-output functions from a simulator library.  Code,
17066 initialized data and zero-initialized data are allocated consecutively.
17068 @item -sim2
17069 @opindex sim2
17070 Like @option{-sim}, but pass linker options to locate initialized data at
17071 0x40000000 and zero-initialized data at 0x80000000.
17072 @end table
17074 @node CR16 Options
17075 @subsection CR16 Options
17076 @cindex CR16 Options
17078 These options are defined specifically for the CR16 ports.
17080 @table @gcctabopt
17082 @item -mmac
17083 @opindex mmac
17084 Enable the use of multiply-accumulate instructions. Disabled by default.
17086 @item -mcr16cplus
17087 @itemx -mcr16c
17088 @opindex mcr16cplus
17089 @opindex mcr16c
17090 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17091 is default.
17093 @item -msim
17094 @opindex msim
17095 Links the library libsim.a which is in compatible with simulator. Applicable
17096 to ELF compiler only.
17098 @item -mint32
17099 @opindex mint32
17100 Choose integer type as 32-bit wide.
17102 @item -mbit-ops
17103 @opindex mbit-ops
17104 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17106 @item -mdata-model=@var{model}
17107 @opindex mdata-model
17108 Choose a data model. The choices for @var{model} are @samp{near},
17109 @samp{far} or @samp{medium}. @samp{medium} is default.
17110 However, @samp{far} is not valid with @option{-mcr16c}, as the
17111 CR16C architecture does not support the far data model.
17112 @end table
17114 @node Darwin Options
17115 @subsection Darwin Options
17116 @cindex Darwin options
17118 These options are defined for all architectures running the Darwin operating
17119 system.
17121 FSF GCC on Darwin does not create ``fat'' object files; it creates
17122 an object file for the single architecture that GCC was built to
17123 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17124 @option{-arch} options are used; it does so by running the compiler or
17125 linker multiple times and joining the results together with
17126 @file{lipo}.
17128 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17129 @samp{i686}) is determined by the flags that specify the ISA
17130 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17131 @option{-force_cpusubtype_ALL} option can be used to override this.
17133 The Darwin tools vary in their behavior when presented with an ISA
17134 mismatch.  The assembler, @file{as}, only permits instructions to
17135 be used that are valid for the subtype of the file it is generating,
17136 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17137 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17138 and prints an error if asked to create a shared library with a less
17139 restrictive subtype than its input files (for instance, trying to put
17140 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17141 for executables, @command{ld}, quietly gives the executable the most
17142 restrictive subtype of any of its input files.
17144 @table @gcctabopt
17145 @item -F@var{dir}
17146 @opindex F
17147 Add the framework directory @var{dir} to the head of the list of
17148 directories to be searched for header files.  These directories are
17149 interleaved with those specified by @option{-I} options and are
17150 scanned in a left-to-right order.
17152 A framework directory is a directory with frameworks in it.  A
17153 framework is a directory with a @file{Headers} and/or
17154 @file{PrivateHeaders} directory contained directly in it that ends
17155 in @file{.framework}.  The name of a framework is the name of this
17156 directory excluding the @file{.framework}.  Headers associated with
17157 the framework are found in one of those two directories, with
17158 @file{Headers} being searched first.  A subframework is a framework
17159 directory that is in a framework's @file{Frameworks} directory.
17160 Includes of subframework headers can only appear in a header of a
17161 framework that contains the subframework, or in a sibling subframework
17162 header.  Two subframeworks are siblings if they occur in the same
17163 framework.  A subframework should not have the same name as a
17164 framework; a warning is issued if this is violated.  Currently a
17165 subframework cannot have subframeworks; in the future, the mechanism
17166 may be extended to support this.  The standard frameworks can be found
17167 in @file{/System/Library/Frameworks} and
17168 @file{/Library/Frameworks}.  An example include looks like
17169 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17170 the name of the framework and @file{header.h} is found in the
17171 @file{PrivateHeaders} or @file{Headers} directory.
17173 @item -iframework@var{dir}
17174 @opindex iframework
17175 Like @option{-F} except the directory is a treated as a system
17176 directory.  The main difference between this @option{-iframework} and
17177 @option{-F} is that with @option{-iframework} the compiler does not
17178 warn about constructs contained within header files found via
17179 @var{dir}.  This option is valid only for the C family of languages.
17181 @item -gused
17182 @opindex gused
17183 Emit debugging information for symbols that are used.  For stabs
17184 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17185 This is by default ON@.
17187 @item -gfull
17188 @opindex gfull
17189 Emit debugging information for all symbols and types.
17191 @item -mmacosx-version-min=@var{version}
17192 The earliest version of MacOS X that this executable will run on
17193 is @var{version}.  Typical values of @var{version} include @code{10.1},
17194 @code{10.2}, and @code{10.3.9}.
17196 If the compiler was built to use the system's headers by default,
17197 then the default for this option is the system version on which the
17198 compiler is running, otherwise the default is to make choices that
17199 are compatible with as many systems and code bases as possible.
17201 @item -mkernel
17202 @opindex mkernel
17203 Enable kernel development mode.  The @option{-mkernel} option sets
17204 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17205 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17206 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17207 applicable.  This mode also sets @option{-mno-altivec},
17208 @option{-msoft-float}, @option{-fno-builtin} and
17209 @option{-mlong-branch} for PowerPC targets.
17211 @item -mone-byte-bool
17212 @opindex mone-byte-bool
17213 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17214 By default @code{sizeof(bool)} is @code{4} when compiling for
17215 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17216 option has no effect on x86.
17218 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17219 to generate code that is not binary compatible with code generated
17220 without that switch.  Using this switch may require recompiling all
17221 other modules in a program, including system libraries.  Use this
17222 switch to conform to a non-default data model.
17224 @item -mfix-and-continue
17225 @itemx -ffix-and-continue
17226 @itemx -findirect-data
17227 @opindex mfix-and-continue
17228 @opindex ffix-and-continue
17229 @opindex findirect-data
17230 Generate code suitable for fast turnaround development, such as to
17231 allow GDB to dynamically load @file{.o} files into already-running
17232 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17233 are provided for backwards compatibility.
17235 @item -all_load
17236 @opindex all_load
17237 Loads all members of static archive libraries.
17238 See man ld(1) for more information.
17240 @item -arch_errors_fatal
17241 @opindex arch_errors_fatal
17242 Cause the errors having to do with files that have the wrong architecture
17243 to be fatal.
17245 @item -bind_at_load
17246 @opindex bind_at_load
17247 Causes the output file to be marked such that the dynamic linker will
17248 bind all undefined references when the file is loaded or launched.
17250 @item -bundle
17251 @opindex bundle
17252 Produce a Mach-o bundle format file.
17253 See man ld(1) for more information.
17255 @item -bundle_loader @var{executable}
17256 @opindex bundle_loader
17257 This option specifies the @var{executable} that will load the build
17258 output file being linked.  See man ld(1) for more information.
17260 @item -dynamiclib
17261 @opindex dynamiclib
17262 When passed this option, GCC produces a dynamic library instead of
17263 an executable when linking, using the Darwin @file{libtool} command.
17265 @item -force_cpusubtype_ALL
17266 @opindex force_cpusubtype_ALL
17267 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17268 one controlled by the @option{-mcpu} or @option{-march} option.
17270 @item -allowable_client  @var{client_name}
17271 @itemx -client_name
17272 @itemx -compatibility_version
17273 @itemx -current_version
17274 @itemx -dead_strip
17275 @itemx -dependency-file
17276 @itemx -dylib_file
17277 @itemx -dylinker_install_name
17278 @itemx -dynamic
17279 @itemx -exported_symbols_list
17280 @itemx -filelist
17281 @need 800
17282 @itemx -flat_namespace
17283 @itemx -force_flat_namespace
17284 @itemx -headerpad_max_install_names
17285 @itemx -image_base
17286 @itemx -init
17287 @itemx -install_name
17288 @itemx -keep_private_externs
17289 @itemx -multi_module
17290 @itemx -multiply_defined
17291 @itemx -multiply_defined_unused
17292 @need 800
17293 @itemx -noall_load
17294 @itemx -no_dead_strip_inits_and_terms
17295 @itemx -nofixprebinding
17296 @itemx -nomultidefs
17297 @itemx -noprebind
17298 @itemx -noseglinkedit
17299 @itemx -pagezero_size
17300 @itemx -prebind
17301 @itemx -prebind_all_twolevel_modules
17302 @itemx -private_bundle
17303 @need 800
17304 @itemx -read_only_relocs
17305 @itemx -sectalign
17306 @itemx -sectobjectsymbols
17307 @itemx -whyload
17308 @itemx -seg1addr
17309 @itemx -sectcreate
17310 @itemx -sectobjectsymbols
17311 @itemx -sectorder
17312 @itemx -segaddr
17313 @itemx -segs_read_only_addr
17314 @need 800
17315 @itemx -segs_read_write_addr
17316 @itemx -seg_addr_table
17317 @itemx -seg_addr_table_filename
17318 @itemx -seglinkedit
17319 @itemx -segprot
17320 @itemx -segs_read_only_addr
17321 @itemx -segs_read_write_addr
17322 @itemx -single_module
17323 @itemx -static
17324 @itemx -sub_library
17325 @need 800
17326 @itemx -sub_umbrella
17327 @itemx -twolevel_namespace
17328 @itemx -umbrella
17329 @itemx -undefined
17330 @itemx -unexported_symbols_list
17331 @itemx -weak_reference_mismatches
17332 @itemx -whatsloaded
17333 @opindex allowable_client
17334 @opindex client_name
17335 @opindex compatibility_version
17336 @opindex current_version
17337 @opindex dead_strip
17338 @opindex dependency-file
17339 @opindex dylib_file
17340 @opindex dylinker_install_name
17341 @opindex dynamic
17342 @opindex exported_symbols_list
17343 @opindex filelist
17344 @opindex flat_namespace
17345 @opindex force_flat_namespace
17346 @opindex headerpad_max_install_names
17347 @opindex image_base
17348 @opindex init
17349 @opindex install_name
17350 @opindex keep_private_externs
17351 @opindex multi_module
17352 @opindex multiply_defined
17353 @opindex multiply_defined_unused
17354 @opindex noall_load
17355 @opindex no_dead_strip_inits_and_terms
17356 @opindex nofixprebinding
17357 @opindex nomultidefs
17358 @opindex noprebind
17359 @opindex noseglinkedit
17360 @opindex pagezero_size
17361 @opindex prebind
17362 @opindex prebind_all_twolevel_modules
17363 @opindex private_bundle
17364 @opindex read_only_relocs
17365 @opindex sectalign
17366 @opindex sectobjectsymbols
17367 @opindex whyload
17368 @opindex seg1addr
17369 @opindex sectcreate
17370 @opindex sectobjectsymbols
17371 @opindex sectorder
17372 @opindex segaddr
17373 @opindex segs_read_only_addr
17374 @opindex segs_read_write_addr
17375 @opindex seg_addr_table
17376 @opindex seg_addr_table_filename
17377 @opindex seglinkedit
17378 @opindex segprot
17379 @opindex segs_read_only_addr
17380 @opindex segs_read_write_addr
17381 @opindex single_module
17382 @opindex static
17383 @opindex sub_library
17384 @opindex sub_umbrella
17385 @opindex twolevel_namespace
17386 @opindex umbrella
17387 @opindex undefined
17388 @opindex unexported_symbols_list
17389 @opindex weak_reference_mismatches
17390 @opindex whatsloaded
17391 These options are passed to the Darwin linker.  The Darwin linker man page
17392 describes them in detail.
17393 @end table
17395 @node DEC Alpha Options
17396 @subsection DEC Alpha Options
17398 These @samp{-m} options are defined for the DEC Alpha implementations:
17400 @table @gcctabopt
17401 @item -mno-soft-float
17402 @itemx -msoft-float
17403 @opindex mno-soft-float
17404 @opindex msoft-float
17405 Use (do not use) the hardware floating-point instructions for
17406 floating-point operations.  When @option{-msoft-float} is specified,
17407 functions in @file{libgcc.a} are used to perform floating-point
17408 operations.  Unless they are replaced by routines that emulate the
17409 floating-point operations, or compiled in such a way as to call such
17410 emulations routines, these routines issue floating-point
17411 operations.   If you are compiling for an Alpha without floating-point
17412 operations, you must ensure that the library is built so as not to call
17413 them.
17415 Note that Alpha implementations without floating-point operations are
17416 required to have floating-point registers.
17418 @item -mfp-reg
17419 @itemx -mno-fp-regs
17420 @opindex mfp-reg
17421 @opindex mno-fp-regs
17422 Generate code that uses (does not use) the floating-point register set.
17423 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17424 register set is not used, floating-point operands are passed in integer
17425 registers as if they were integers and floating-point results are passed
17426 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17427 so any function with a floating-point argument or return value called by code
17428 compiled with @option{-mno-fp-regs} must also be compiled with that
17429 option.
17431 A typical use of this option is building a kernel that does not use,
17432 and hence need not save and restore, any floating-point registers.
17434 @item -mieee
17435 @opindex mieee
17436 The Alpha architecture implements floating-point hardware optimized for
17437 maximum performance.  It is mostly compliant with the IEEE floating-point
17438 standard.  However, for full compliance, software assistance is
17439 required.  This option generates code fully IEEE-compliant code
17440 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17441 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17442 defined during compilation.  The resulting code is less efficient but is
17443 able to correctly support denormalized numbers and exceptional IEEE
17444 values such as not-a-number and plus/minus infinity.  Other Alpha
17445 compilers call this option @option{-ieee_with_no_inexact}.
17447 @item -mieee-with-inexact
17448 @opindex mieee-with-inexact
17449 This is like @option{-mieee} except the generated code also maintains
17450 the IEEE @var{inexact-flag}.  Turning on this option causes the
17451 generated code to implement fully-compliant IEEE math.  In addition to
17452 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17453 macro.  On some Alpha implementations the resulting code may execute
17454 significantly slower than the code generated by default.  Since there is
17455 very little code that depends on the @var{inexact-flag}, you should
17456 normally not specify this option.  Other Alpha compilers call this
17457 option @option{-ieee_with_inexact}.
17459 @item -mfp-trap-mode=@var{trap-mode}
17460 @opindex mfp-trap-mode
17461 This option controls what floating-point related traps are enabled.
17462 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17463 The trap mode can be set to one of four values:
17465 @table @samp
17466 @item n
17467 This is the default (normal) setting.  The only traps that are enabled
17468 are the ones that cannot be disabled in software (e.g., division by zero
17469 trap).
17471 @item u
17472 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17473 as well.
17475 @item su
17476 Like @samp{u}, but the instructions are marked to be safe for software
17477 completion (see Alpha architecture manual for details).
17479 @item sui
17480 Like @samp{su}, but inexact traps are enabled as well.
17481 @end table
17483 @item -mfp-rounding-mode=@var{rounding-mode}
17484 @opindex mfp-rounding-mode
17485 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17486 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17489 @table @samp
17490 @item n
17491 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17492 the nearest machine number or towards the even machine number in case
17493 of a tie.
17495 @item m
17496 Round towards minus infinity.
17498 @item c
17499 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17501 @item d
17502 Dynamic rounding mode.  A field in the floating-point control register
17503 (@var{fpcr}, see Alpha architecture reference manual) controls the
17504 rounding mode in effect.  The C library initializes this register for
17505 rounding towards plus infinity.  Thus, unless your program modifies the
17506 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17507 @end table
17509 @item -mtrap-precision=@var{trap-precision}
17510 @opindex mtrap-precision
17511 In the Alpha architecture, floating-point traps are imprecise.  This
17512 means without software assistance it is impossible to recover from a
17513 floating trap and program execution normally needs to be terminated.
17514 GCC can generate code that can assist operating system trap handlers
17515 in determining the exact location that caused a floating-point trap.
17516 Depending on the requirements of an application, different levels of
17517 precisions can be selected:
17519 @table @samp
17520 @item p
17521 Program precision.  This option is the default and means a trap handler
17522 can only identify which program caused a floating-point exception.
17524 @item f
17525 Function precision.  The trap handler can determine the function that
17526 caused a floating-point exception.
17528 @item i
17529 Instruction precision.  The trap handler can determine the exact
17530 instruction that caused a floating-point exception.
17531 @end table
17533 Other Alpha compilers provide the equivalent options called
17534 @option{-scope_safe} and @option{-resumption_safe}.
17536 @item -mieee-conformant
17537 @opindex mieee-conformant
17538 This option marks the generated code as IEEE conformant.  You must not
17539 use this option unless you also specify @option{-mtrap-precision=i} and either
17540 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17541 is to emit the line @samp{.eflag 48} in the function prologue of the
17542 generated assembly file.
17544 @item -mbuild-constants
17545 @opindex mbuild-constants
17546 Normally GCC examines a 32- or 64-bit integer constant to
17547 see if it can construct it from smaller constants in two or three
17548 instructions.  If it cannot, it outputs the constant as a literal and
17549 generates code to load it from the data segment at run time.
17551 Use this option to require GCC to construct @emph{all} integer constants
17552 using code, even if it takes more instructions (the maximum is six).
17554 You typically use this option to build a shared library dynamic
17555 loader.  Itself a shared library, it must relocate itself in memory
17556 before it can find the variables and constants in its own data segment.
17558 @item -mbwx
17559 @itemx -mno-bwx
17560 @itemx -mcix
17561 @itemx -mno-cix
17562 @itemx -mfix
17563 @itemx -mno-fix
17564 @itemx -mmax
17565 @itemx -mno-max
17566 @opindex mbwx
17567 @opindex mno-bwx
17568 @opindex mcix
17569 @opindex mno-cix
17570 @opindex mfix
17571 @opindex mno-fix
17572 @opindex mmax
17573 @opindex mno-max
17574 Indicate whether GCC should generate code to use the optional BWX,
17575 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17576 sets supported by the CPU type specified via @option{-mcpu=} option or that
17577 of the CPU on which GCC was built if none is specified.
17579 @item -mfloat-vax
17580 @itemx -mfloat-ieee
17581 @opindex mfloat-vax
17582 @opindex mfloat-ieee
17583 Generate code that uses (does not use) VAX F and G floating-point
17584 arithmetic instead of IEEE single and double precision.
17586 @item -mexplicit-relocs
17587 @itemx -mno-explicit-relocs
17588 @opindex mexplicit-relocs
17589 @opindex mno-explicit-relocs
17590 Older Alpha assemblers provided no way to generate symbol relocations
17591 except via assembler macros.  Use of these macros does not allow
17592 optimal instruction scheduling.  GNU binutils as of version 2.12
17593 supports a new syntax that allows the compiler to explicitly mark
17594 which relocations should apply to which instructions.  This option
17595 is mostly useful for debugging, as GCC detects the capabilities of
17596 the assembler when it is built and sets the default accordingly.
17598 @item -msmall-data
17599 @itemx -mlarge-data
17600 @opindex msmall-data
17601 @opindex mlarge-data
17602 When @option{-mexplicit-relocs} is in effect, static data is
17603 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17604 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17605 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17606 16-bit relocations off of the @code{$gp} register.  This limits the
17607 size of the small data area to 64KB, but allows the variables to be
17608 directly accessed via a single instruction.
17610 The default is @option{-mlarge-data}.  With this option the data area
17611 is limited to just below 2GB@.  Programs that require more than 2GB of
17612 data must use @code{malloc} or @code{mmap} to allocate the data in the
17613 heap instead of in the program's data segment.
17615 When generating code for shared libraries, @option{-fpic} implies
17616 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17618 @item -msmall-text
17619 @itemx -mlarge-text
17620 @opindex msmall-text
17621 @opindex mlarge-text
17622 When @option{-msmall-text} is used, the compiler assumes that the
17623 code of the entire program (or shared library) fits in 4MB, and is
17624 thus reachable with a branch instruction.  When @option{-msmall-data}
17625 is used, the compiler can assume that all local symbols share the
17626 same @code{$gp} value, and thus reduce the number of instructions
17627 required for a function call from 4 to 1.
17629 The default is @option{-mlarge-text}.
17631 @item -mcpu=@var{cpu_type}
17632 @opindex mcpu
17633 Set the instruction set and instruction scheduling parameters for
17634 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17635 style name or the corresponding chip number.  GCC supports scheduling
17636 parameters for the EV4, EV5 and EV6 family of processors and
17637 chooses the default values for the instruction set from the processor
17638 you specify.  If you do not specify a processor type, GCC defaults
17639 to the processor on which the compiler was built.
17641 Supported values for @var{cpu_type} are
17643 @table @samp
17644 @item ev4
17645 @itemx ev45
17646 @itemx 21064
17647 Schedules as an EV4 and has no instruction set extensions.
17649 @item ev5
17650 @itemx 21164
17651 Schedules as an EV5 and has no instruction set extensions.
17653 @item ev56
17654 @itemx 21164a
17655 Schedules as an EV5 and supports the BWX extension.
17657 @item pca56
17658 @itemx 21164pc
17659 @itemx 21164PC
17660 Schedules as an EV5 and supports the BWX and MAX extensions.
17662 @item ev6
17663 @itemx 21264
17664 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17666 @item ev67
17667 @itemx 21264a
17668 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17669 @end table
17671 Native toolchains also support the value @samp{native},
17672 which selects the best architecture option for the host processor.
17673 @option{-mcpu=native} has no effect if GCC does not recognize
17674 the processor.
17676 @item -mtune=@var{cpu_type}
17677 @opindex mtune
17678 Set only the instruction scheduling parameters for machine type
17679 @var{cpu_type}.  The instruction set is not changed.
17681 Native toolchains also support the value @samp{native},
17682 which selects the best architecture option for the host processor.
17683 @option{-mtune=native} has no effect if GCC does not recognize
17684 the processor.
17686 @item -mmemory-latency=@var{time}
17687 @opindex mmemory-latency
17688 Sets the latency the scheduler should assume for typical memory
17689 references as seen by the application.  This number is highly
17690 dependent on the memory access patterns used by the application
17691 and the size of the external cache on the machine.
17693 Valid options for @var{time} are
17695 @table @samp
17696 @item @var{number}
17697 A decimal number representing clock cycles.
17699 @item L1
17700 @itemx L2
17701 @itemx L3
17702 @itemx main
17703 The compiler contains estimates of the number of clock cycles for
17704 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17705 (also called Dcache, Scache, and Bcache), as well as to main memory.
17706 Note that L3 is only valid for EV5.
17708 @end table
17709 @end table
17711 @node FR30 Options
17712 @subsection FR30 Options
17713 @cindex FR30 Options
17715 These options are defined specifically for the FR30 port.
17717 @table @gcctabopt
17719 @item -msmall-model
17720 @opindex msmall-model
17721 Use the small address space model.  This can produce smaller code, but
17722 it does assume that all symbolic values and addresses fit into a
17723 20-bit range.
17725 @item -mno-lsim
17726 @opindex mno-lsim
17727 Assume that runtime support has been provided and so there is no need
17728 to include the simulator library (@file{libsim.a}) on the linker
17729 command line.
17731 @end table
17733 @node FT32 Options
17734 @subsection FT32 Options
17735 @cindex FT32 Options
17737 These options are defined specifically for the FT32 port.
17739 @table @gcctabopt
17741 @item -msim
17742 @opindex msim
17743 Specifies that the program will be run on the simulator.  This causes
17744 an alternate runtime startup and library to be linked.
17745 You must not use this option when generating programs that will run on
17746 real hardware; you must provide your own runtime library for whatever
17747 I/O functions are needed.
17749 @item -mlra
17750 @opindex mlra
17751 Enable Local Register Allocation.  This is still experimental for FT32,
17752 so by default the compiler uses standard reload.
17754 @item -mnodiv
17755 @opindex mnodiv
17756 Do not use div and mod instructions.
17758 @end table
17760 @node FRV Options
17761 @subsection FRV Options
17762 @cindex FRV Options
17764 @table @gcctabopt
17765 @item -mgpr-32
17766 @opindex mgpr-32
17768 Only use the first 32 general-purpose registers.
17770 @item -mgpr-64
17771 @opindex mgpr-64
17773 Use all 64 general-purpose registers.
17775 @item -mfpr-32
17776 @opindex mfpr-32
17778 Use only the first 32 floating-point registers.
17780 @item -mfpr-64
17781 @opindex mfpr-64
17783 Use all 64 floating-point registers.
17785 @item -mhard-float
17786 @opindex mhard-float
17788 Use hardware instructions for floating-point operations.
17790 @item -msoft-float
17791 @opindex msoft-float
17793 Use library routines for floating-point operations.
17795 @item -malloc-cc
17796 @opindex malloc-cc
17798 Dynamically allocate condition code registers.
17800 @item -mfixed-cc
17801 @opindex mfixed-cc
17803 Do not try to dynamically allocate condition code registers, only
17804 use @code{icc0} and @code{fcc0}.
17806 @item -mdword
17807 @opindex mdword
17809 Change ABI to use double word insns.
17811 @item -mno-dword
17812 @opindex mno-dword
17814 Do not use double word instructions.
17816 @item -mdouble
17817 @opindex mdouble
17819 Use floating-point double instructions.
17821 @item -mno-double
17822 @opindex mno-double
17824 Do not use floating-point double instructions.
17826 @item -mmedia
17827 @opindex mmedia
17829 Use media instructions.
17831 @item -mno-media
17832 @opindex mno-media
17834 Do not use media instructions.
17836 @item -mmuladd
17837 @opindex mmuladd
17839 Use multiply and add/subtract instructions.
17841 @item -mno-muladd
17842 @opindex mno-muladd
17844 Do not use multiply and add/subtract instructions.
17846 @item -mfdpic
17847 @opindex mfdpic
17849 Select the FDPIC ABI, which uses function descriptors to represent
17850 pointers to functions.  Without any PIC/PIE-related options, it
17851 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17852 assumes GOT entries and small data are within a 12-bit range from the
17853 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17854 are computed with 32 bits.
17855 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17857 @item -minline-plt
17858 @opindex minline-plt
17860 Enable inlining of PLT entries in function calls to functions that are
17861 not known to bind locally.  It has no effect without @option{-mfdpic}.
17862 It's enabled by default if optimizing for speed and compiling for
17863 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17864 optimization option such as @option{-O3} or above is present in the
17865 command line.
17867 @item -mTLS
17868 @opindex mTLS
17870 Assume a large TLS segment when generating thread-local code.
17872 @item -mtls
17873 @opindex mtls
17875 Do not assume a large TLS segment when generating thread-local code.
17877 @item -mgprel-ro
17878 @opindex mgprel-ro
17880 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17881 that is known to be in read-only sections.  It's enabled by default,
17882 except for @option{-fpic} or @option{-fpie}: even though it may help
17883 make the global offset table smaller, it trades 1 instruction for 4.
17884 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17885 one of which may be shared by multiple symbols, and it avoids the need
17886 for a GOT entry for the referenced symbol, so it's more likely to be a
17887 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17889 @item -multilib-library-pic
17890 @opindex multilib-library-pic
17892 Link with the (library, not FD) pic libraries.  It's implied by
17893 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17894 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17895 it explicitly.
17897 @item -mlinked-fp
17898 @opindex mlinked-fp
17900 Follow the EABI requirement of always creating a frame pointer whenever
17901 a stack frame is allocated.  This option is enabled by default and can
17902 be disabled with @option{-mno-linked-fp}.
17904 @item -mlong-calls
17905 @opindex mlong-calls
17907 Use indirect addressing to call functions outside the current
17908 compilation unit.  This allows the functions to be placed anywhere
17909 within the 32-bit address space.
17911 @item -malign-labels
17912 @opindex malign-labels
17914 Try to align labels to an 8-byte boundary by inserting NOPs into the
17915 previous packet.  This option only has an effect when VLIW packing
17916 is enabled.  It doesn't create new packets; it merely adds NOPs to
17917 existing ones.
17919 @item -mlibrary-pic
17920 @opindex mlibrary-pic
17922 Generate position-independent EABI code.
17924 @item -macc-4
17925 @opindex macc-4
17927 Use only the first four media accumulator registers.
17929 @item -macc-8
17930 @opindex macc-8
17932 Use all eight media accumulator registers.
17934 @item -mpack
17935 @opindex mpack
17937 Pack VLIW instructions.
17939 @item -mno-pack
17940 @opindex mno-pack
17942 Do not pack VLIW instructions.
17944 @item -mno-eflags
17945 @opindex mno-eflags
17947 Do not mark ABI switches in e_flags.
17949 @item -mcond-move
17950 @opindex mcond-move
17952 Enable the use of conditional-move instructions (default).
17954 This switch is mainly for debugging the compiler and will likely be removed
17955 in a future version.
17957 @item -mno-cond-move
17958 @opindex mno-cond-move
17960 Disable the use of conditional-move instructions.
17962 This switch is mainly for debugging the compiler and will likely be removed
17963 in a future version.
17965 @item -mscc
17966 @opindex mscc
17968 Enable the use of conditional set instructions (default).
17970 This switch is mainly for debugging the compiler and will likely be removed
17971 in a future version.
17973 @item -mno-scc
17974 @opindex mno-scc
17976 Disable the use of conditional set instructions.
17978 This switch is mainly for debugging the compiler and will likely be removed
17979 in a future version.
17981 @item -mcond-exec
17982 @opindex mcond-exec
17984 Enable the use of conditional execution (default).
17986 This switch is mainly for debugging the compiler and will likely be removed
17987 in a future version.
17989 @item -mno-cond-exec
17990 @opindex mno-cond-exec
17992 Disable the use of conditional execution.
17994 This switch is mainly for debugging the compiler and will likely be removed
17995 in a future version.
17997 @item -mvliw-branch
17998 @opindex mvliw-branch
18000 Run a pass to pack branches into VLIW instructions (default).
18002 This switch is mainly for debugging the compiler and will likely be removed
18003 in a future version.
18005 @item -mno-vliw-branch
18006 @opindex mno-vliw-branch
18008 Do not run a pass to pack branches into VLIW instructions.
18010 This switch is mainly for debugging the compiler and will likely be removed
18011 in a future version.
18013 @item -mmulti-cond-exec
18014 @opindex mmulti-cond-exec
18016 Enable optimization of @code{&&} and @code{||} in conditional execution
18017 (default).
18019 This switch is mainly for debugging the compiler and will likely be removed
18020 in a future version.
18022 @item -mno-multi-cond-exec
18023 @opindex mno-multi-cond-exec
18025 Disable optimization of @code{&&} and @code{||} in conditional execution.
18027 This switch is mainly for debugging the compiler and will likely be removed
18028 in a future version.
18030 @item -mnested-cond-exec
18031 @opindex mnested-cond-exec
18033 Enable nested conditional execution optimizations (default).
18035 This switch is mainly for debugging the compiler and will likely be removed
18036 in a future version.
18038 @item -mno-nested-cond-exec
18039 @opindex mno-nested-cond-exec
18041 Disable nested conditional execution optimizations.
18043 This switch is mainly for debugging the compiler and will likely be removed
18044 in a future version.
18046 @item -moptimize-membar
18047 @opindex moptimize-membar
18049 This switch removes redundant @code{membar} instructions from the
18050 compiler-generated code.  It is enabled by default.
18052 @item -mno-optimize-membar
18053 @opindex mno-optimize-membar
18055 This switch disables the automatic removal of redundant @code{membar}
18056 instructions from the generated code.
18058 @item -mtomcat-stats
18059 @opindex mtomcat-stats
18061 Cause gas to print out tomcat statistics.
18063 @item -mcpu=@var{cpu}
18064 @opindex mcpu
18066 Select the processor type for which to generate code.  Possible values are
18067 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18068 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18070 @end table
18072 @node GNU/Linux Options
18073 @subsection GNU/Linux Options
18075 These @samp{-m} options are defined for GNU/Linux targets:
18077 @table @gcctabopt
18078 @item -mglibc
18079 @opindex mglibc
18080 Use the GNU C library.  This is the default except
18081 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18082 @samp{*-*-linux-*android*} targets.
18084 @item -muclibc
18085 @opindex muclibc
18086 Use uClibc C library.  This is the default on
18087 @samp{*-*-linux-*uclibc*} targets.
18089 @item -mmusl
18090 @opindex mmusl
18091 Use the musl C library.  This is the default on
18092 @samp{*-*-linux-*musl*} targets.
18094 @item -mbionic
18095 @opindex mbionic
18096 Use Bionic C library.  This is the default on
18097 @samp{*-*-linux-*android*} targets.
18099 @item -mandroid
18100 @opindex mandroid
18101 Compile code compatible with Android platform.  This is the default on
18102 @samp{*-*-linux-*android*} targets.
18104 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18105 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18106 this option makes the GCC driver pass Android-specific options to the linker.
18107 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18108 to be defined.
18110 @item -tno-android-cc
18111 @opindex tno-android-cc
18112 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18113 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18114 @option{-fno-rtti} by default.
18116 @item -tno-android-ld
18117 @opindex tno-android-ld
18118 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18119 linking options to the linker.
18121 @end table
18123 @node H8/300 Options
18124 @subsection H8/300 Options
18126 These @samp{-m} options are defined for the H8/300 implementations:
18128 @table @gcctabopt
18129 @item -mrelax
18130 @opindex mrelax
18131 Shorten some address references at link time, when possible; uses the
18132 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18133 ld, Using ld}, for a fuller description.
18135 @item -mh
18136 @opindex mh
18137 Generate code for the H8/300H@.
18139 @item -ms
18140 @opindex ms
18141 Generate code for the H8S@.
18143 @item -mn
18144 @opindex mn
18145 Generate code for the H8S and H8/300H in the normal mode.  This switch
18146 must be used either with @option{-mh} or @option{-ms}.
18148 @item -ms2600
18149 @opindex ms2600
18150 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18152 @item -mexr
18153 @opindex mexr
18154 Extended registers are stored on stack before execution of function
18155 with monitor attribute. Default option is @option{-mexr}.
18156 This option is valid only for H8S targets.
18158 @item -mno-exr
18159 @opindex mno-exr
18160 Extended registers are not stored on stack before execution of function 
18161 with monitor attribute. Default option is @option{-mno-exr}. 
18162 This option is valid only for H8S targets.
18164 @item -mint32
18165 @opindex mint32
18166 Make @code{int} data 32 bits by default.
18168 @item -malign-300
18169 @opindex malign-300
18170 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18171 The default for the H8/300H and H8S is to align longs and floats on
18172 4-byte boundaries.
18173 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18174 This option has no effect on the H8/300.
18175 @end table
18177 @node HPPA Options
18178 @subsection HPPA Options
18179 @cindex HPPA Options
18181 These @samp{-m} options are defined for the HPPA family of computers:
18183 @table @gcctabopt
18184 @item -march=@var{architecture-type}
18185 @opindex march
18186 Generate code for the specified architecture.  The choices for
18187 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18188 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18189 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18190 architecture option for your machine.  Code compiled for lower numbered
18191 architectures runs on higher numbered architectures, but not the
18192 other way around.
18194 @item -mpa-risc-1-0
18195 @itemx -mpa-risc-1-1
18196 @itemx -mpa-risc-2-0
18197 @opindex mpa-risc-1-0
18198 @opindex mpa-risc-1-1
18199 @opindex mpa-risc-2-0
18200 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18202 @item -mcaller-copies
18203 @opindex mcaller-copies
18204 The caller copies function arguments passed by hidden reference.  This
18205 option should be used with care as it is not compatible with the default
18206 32-bit runtime.  However, only aggregates larger than eight bytes are
18207 passed by hidden reference and the option provides better compatibility
18208 with OpenMP.
18210 @item -mjump-in-delay
18211 @opindex mjump-in-delay
18212 This option is ignored and provided for compatibility purposes only.
18214 @item -mdisable-fpregs
18215 @opindex mdisable-fpregs
18216 Prevent floating-point registers from being used in any manner.  This is
18217 necessary for compiling kernels that perform lazy context switching of
18218 floating-point registers.  If you use this option and attempt to perform
18219 floating-point operations, the compiler aborts.
18221 @item -mdisable-indexing
18222 @opindex mdisable-indexing
18223 Prevent the compiler from using indexing address modes.  This avoids some
18224 rather obscure problems when compiling MIG generated code under MACH@.
18226 @item -mno-space-regs
18227 @opindex mno-space-regs
18228 Generate code that assumes the target has no space registers.  This allows
18229 GCC to generate faster indirect calls and use unscaled index address modes.
18231 Such code is suitable for level 0 PA systems and kernels.
18233 @item -mfast-indirect-calls
18234 @opindex mfast-indirect-calls
18235 Generate code that assumes calls never cross space boundaries.  This
18236 allows GCC to emit code that performs faster indirect calls.
18238 This option does not work in the presence of shared libraries or nested
18239 functions.
18241 @item -mfixed-range=@var{register-range}
18242 @opindex mfixed-range
18243 Generate code treating the given register range as fixed registers.
18244 A fixed register is one that the register allocator cannot use.  This is
18245 useful when compiling kernel code.  A register range is specified as
18246 two registers separated by a dash.  Multiple register ranges can be
18247 specified separated by a comma.
18249 @item -mlong-load-store
18250 @opindex mlong-load-store
18251 Generate 3-instruction load and store sequences as sometimes required by
18252 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18253 the HP compilers.
18255 @item -mportable-runtime
18256 @opindex mportable-runtime
18257 Use the portable calling conventions proposed by HP for ELF systems.
18259 @item -mgas
18260 @opindex mgas
18261 Enable the use of assembler directives only GAS understands.
18263 @item -mschedule=@var{cpu-type}
18264 @opindex mschedule
18265 Schedule code according to the constraints for the machine type
18266 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18267 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18268 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18269 proper scheduling option for your machine.  The default scheduling is
18270 @samp{8000}.
18272 @item -mlinker-opt
18273 @opindex mlinker-opt
18274 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18275 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18276 linkers in which they give bogus error messages when linking some programs.
18278 @item -msoft-float
18279 @opindex msoft-float
18280 Generate output containing library calls for floating point.
18281 @strong{Warning:} the requisite libraries are not available for all HPPA
18282 targets.  Normally the facilities of the machine's usual C compiler are
18283 used, but this cannot be done directly in cross-compilation.  You must make
18284 your own arrangements to provide suitable library functions for
18285 cross-compilation.
18287 @option{-msoft-float} changes the calling convention in the output file;
18288 therefore, it is only useful if you compile @emph{all} of a program with
18289 this option.  In particular, you need to compile @file{libgcc.a}, the
18290 library that comes with GCC, with @option{-msoft-float} in order for
18291 this to work.
18293 @item -msio
18294 @opindex msio
18295 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18296 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18297 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18298 options are available under HP-UX and HI-UX@.
18300 @item -mgnu-ld
18301 @opindex mgnu-ld
18302 Use options specific to GNU @command{ld}.
18303 This passes @option{-shared} to @command{ld} when
18304 building a shared library.  It is the default when GCC is configured,
18305 explicitly or implicitly, with the GNU linker.  This option does not
18306 affect which @command{ld} is called; it only changes what parameters
18307 are passed to that @command{ld}.
18308 The @command{ld} that is called is determined by the
18309 @option{--with-ld} configure option, GCC's program search path, and
18310 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18311 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18312 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18314 @item -mhp-ld
18315 @opindex mhp-ld
18316 Use options specific to HP @command{ld}.
18317 This passes @option{-b} to @command{ld} when building
18318 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18319 links.  It is the default when GCC is configured, explicitly or
18320 implicitly, with the HP linker.  This option does not affect
18321 which @command{ld} is called; it only changes what parameters are passed to that
18322 @command{ld}.
18323 The @command{ld} that is called is determined by the @option{--with-ld}
18324 configure option, GCC's program search path, and finally by the user's
18325 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18326 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18327 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18329 @item -mlong-calls
18330 @opindex mno-long-calls
18331 Generate code that uses long call sequences.  This ensures that a call
18332 is always able to reach linker generated stubs.  The default is to generate
18333 long calls only when the distance from the call site to the beginning
18334 of the function or translation unit, as the case may be, exceeds a
18335 predefined limit set by the branch type being used.  The limits for
18336 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18337 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18338 240,000 bytes.
18340 Distances are measured from the beginning of functions when using the
18341 @option{-ffunction-sections} option, or when using the @option{-mgas}
18342 and @option{-mno-portable-runtime} options together under HP-UX with
18343 the SOM linker.
18345 It is normally not desirable to use this option as it degrades
18346 performance.  However, it may be useful in large applications,
18347 particularly when partial linking is used to build the application.
18349 The types of long calls used depends on the capabilities of the
18350 assembler and linker, and the type of code being generated.  The
18351 impact on systems that support long absolute calls, and long pic
18352 symbol-difference or pc-relative calls should be relatively small.
18353 However, an indirect call is used on 32-bit ELF systems in pic code
18354 and it is quite long.
18356 @item -munix=@var{unix-std}
18357 @opindex march
18358 Generate compiler predefines and select a startfile for the specified
18359 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18360 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18361 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18362 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18363 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18364 and later.
18366 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18367 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18368 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18369 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18370 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18371 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18373 It is @emph{important} to note that this option changes the interfaces
18374 for various library routines.  It also affects the operational behavior
18375 of the C library.  Thus, @emph{extreme} care is needed in using this
18376 option.
18378 Library code that is intended to operate with more than one UNIX
18379 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18380 as appropriate.  Most GNU software doesn't provide this capability.
18382 @item -nolibdld
18383 @opindex nolibdld
18384 Suppress the generation of link options to search libdld.sl when the
18385 @option{-static} option is specified on HP-UX 10 and later.
18387 @item -static
18388 @opindex static
18389 The HP-UX implementation of setlocale in libc has a dependency on
18390 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18391 when the @option{-static} option is specified, special link options
18392 are needed to resolve this dependency.
18394 On HP-UX 10 and later, the GCC driver adds the necessary options to
18395 link with libdld.sl when the @option{-static} option is specified.
18396 This causes the resulting binary to be dynamic.  On the 64-bit port,
18397 the linkers generate dynamic binaries by default in any case.  The
18398 @option{-nolibdld} option can be used to prevent the GCC driver from
18399 adding these link options.
18401 @item -threads
18402 @opindex threads
18403 Add support for multithreading with the @dfn{dce thread} library
18404 under HP-UX@.  This option sets flags for both the preprocessor and
18405 linker.
18406 @end table
18408 @node IA-64 Options
18409 @subsection IA-64 Options
18410 @cindex IA-64 Options
18412 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18414 @table @gcctabopt
18415 @item -mbig-endian
18416 @opindex mbig-endian
18417 Generate code for a big-endian target.  This is the default for HP-UX@.
18419 @item -mlittle-endian
18420 @opindex mlittle-endian
18421 Generate code for a little-endian target.  This is the default for AIX5
18422 and GNU/Linux.
18424 @item -mgnu-as
18425 @itemx -mno-gnu-as
18426 @opindex mgnu-as
18427 @opindex mno-gnu-as
18428 Generate (or don't) code for the GNU assembler.  This is the default.
18429 @c Also, this is the default if the configure option @option{--with-gnu-as}
18430 @c is used.
18432 @item -mgnu-ld
18433 @itemx -mno-gnu-ld
18434 @opindex mgnu-ld
18435 @opindex mno-gnu-ld
18436 Generate (or don't) code for the GNU linker.  This is the default.
18437 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18438 @c is used.
18440 @item -mno-pic
18441 @opindex mno-pic
18442 Generate code that does not use a global pointer register.  The result
18443 is not position independent code, and violates the IA-64 ABI@.
18445 @item -mvolatile-asm-stop
18446 @itemx -mno-volatile-asm-stop
18447 @opindex mvolatile-asm-stop
18448 @opindex mno-volatile-asm-stop
18449 Generate (or don't) a stop bit immediately before and after volatile asm
18450 statements.
18452 @item -mregister-names
18453 @itemx -mno-register-names
18454 @opindex mregister-names
18455 @opindex mno-register-names
18456 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18457 the stacked registers.  This may make assembler output more readable.
18459 @item -mno-sdata
18460 @itemx -msdata
18461 @opindex mno-sdata
18462 @opindex msdata
18463 Disable (or enable) optimizations that use the small data section.  This may
18464 be useful for working around optimizer bugs.
18466 @item -mconstant-gp
18467 @opindex mconstant-gp
18468 Generate code that uses a single constant global pointer value.  This is
18469 useful when compiling kernel code.
18471 @item -mauto-pic
18472 @opindex mauto-pic
18473 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18474 This is useful when compiling firmware code.
18476 @item -minline-float-divide-min-latency
18477 @opindex minline-float-divide-min-latency
18478 Generate code for inline divides of floating-point values
18479 using the minimum latency algorithm.
18481 @item -minline-float-divide-max-throughput
18482 @opindex minline-float-divide-max-throughput
18483 Generate code for inline divides of floating-point values
18484 using the maximum throughput algorithm.
18486 @item -mno-inline-float-divide
18487 @opindex mno-inline-float-divide
18488 Do not generate inline code for divides of floating-point values.
18490 @item -minline-int-divide-min-latency
18491 @opindex minline-int-divide-min-latency
18492 Generate code for inline divides of integer values
18493 using the minimum latency algorithm.
18495 @item -minline-int-divide-max-throughput
18496 @opindex minline-int-divide-max-throughput
18497 Generate code for inline divides of integer values
18498 using the maximum throughput algorithm.
18500 @item -mno-inline-int-divide
18501 @opindex mno-inline-int-divide
18502 Do not generate inline code for divides of integer values.
18504 @item -minline-sqrt-min-latency
18505 @opindex minline-sqrt-min-latency
18506 Generate code for inline square roots
18507 using the minimum latency algorithm.
18509 @item -minline-sqrt-max-throughput
18510 @opindex minline-sqrt-max-throughput
18511 Generate code for inline square roots
18512 using the maximum throughput algorithm.
18514 @item -mno-inline-sqrt
18515 @opindex mno-inline-sqrt
18516 Do not generate inline code for @code{sqrt}.
18518 @item -mfused-madd
18519 @itemx -mno-fused-madd
18520 @opindex mfused-madd
18521 @opindex mno-fused-madd
18522 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18523 instructions.  The default is to use these instructions.
18525 @item -mno-dwarf2-asm
18526 @itemx -mdwarf2-asm
18527 @opindex mno-dwarf2-asm
18528 @opindex mdwarf2-asm
18529 Don't (or do) generate assembler code for the DWARF line number debugging
18530 info.  This may be useful when not using the GNU assembler.
18532 @item -mearly-stop-bits
18533 @itemx -mno-early-stop-bits
18534 @opindex mearly-stop-bits
18535 @opindex mno-early-stop-bits
18536 Allow stop bits to be placed earlier than immediately preceding the
18537 instruction that triggered the stop bit.  This can improve instruction
18538 scheduling, but does not always do so.
18540 @item -mfixed-range=@var{register-range}
18541 @opindex mfixed-range
18542 Generate code treating the given register range as fixed registers.
18543 A fixed register is one that the register allocator cannot use.  This is
18544 useful when compiling kernel code.  A register range is specified as
18545 two registers separated by a dash.  Multiple register ranges can be
18546 specified separated by a comma.
18548 @item -mtls-size=@var{tls-size}
18549 @opindex mtls-size
18550 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18553 @item -mtune=@var{cpu-type}
18554 @opindex mtune
18555 Tune the instruction scheduling for a particular CPU, Valid values are
18556 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18557 and @samp{mckinley}.
18559 @item -milp32
18560 @itemx -mlp64
18561 @opindex milp32
18562 @opindex mlp64
18563 Generate code for a 32-bit or 64-bit environment.
18564 The 32-bit environment sets int, long and pointer to 32 bits.
18565 The 64-bit environment sets int to 32 bits and long and pointer
18566 to 64 bits.  These are HP-UX specific flags.
18568 @item -mno-sched-br-data-spec
18569 @itemx -msched-br-data-spec
18570 @opindex mno-sched-br-data-spec
18571 @opindex msched-br-data-spec
18572 (Dis/En)able data speculative scheduling before reload.
18573 This results in generation of @code{ld.a} instructions and
18574 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18575 The default setting is disabled.
18577 @item -msched-ar-data-spec
18578 @itemx -mno-sched-ar-data-spec
18579 @opindex msched-ar-data-spec
18580 @opindex mno-sched-ar-data-spec
18581 (En/Dis)able data speculative scheduling after reload.
18582 This results in generation of @code{ld.a} instructions and
18583 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18584 The default setting is enabled.
18586 @item -mno-sched-control-spec
18587 @itemx -msched-control-spec
18588 @opindex mno-sched-control-spec
18589 @opindex msched-control-spec
18590 (Dis/En)able control speculative scheduling.  This feature is
18591 available only during region scheduling (i.e.@: before reload).
18592 This results in generation of the @code{ld.s} instructions and
18593 the corresponding check instructions @code{chk.s}.
18594 The default setting is disabled.
18596 @item -msched-br-in-data-spec
18597 @itemx -mno-sched-br-in-data-spec
18598 @opindex msched-br-in-data-spec
18599 @opindex mno-sched-br-in-data-spec
18600 (En/Dis)able speculative scheduling of the instructions that
18601 are dependent on the data speculative loads before reload.
18602 This is effective only with @option{-msched-br-data-spec} enabled.
18603 The default setting is enabled.
18605 @item -msched-ar-in-data-spec
18606 @itemx -mno-sched-ar-in-data-spec
18607 @opindex msched-ar-in-data-spec
18608 @opindex mno-sched-ar-in-data-spec
18609 (En/Dis)able speculative scheduling of the instructions that
18610 are dependent on the data speculative loads after reload.
18611 This is effective only with @option{-msched-ar-data-spec} enabled.
18612 The default setting is enabled.
18614 @item -msched-in-control-spec
18615 @itemx -mno-sched-in-control-spec
18616 @opindex msched-in-control-spec
18617 @opindex mno-sched-in-control-spec
18618 (En/Dis)able speculative scheduling of the instructions that
18619 are dependent on the control speculative loads.
18620 This is effective only with @option{-msched-control-spec} enabled.
18621 The default setting is enabled.
18623 @item -mno-sched-prefer-non-data-spec-insns
18624 @itemx -msched-prefer-non-data-spec-insns
18625 @opindex mno-sched-prefer-non-data-spec-insns
18626 @opindex msched-prefer-non-data-spec-insns
18627 If enabled, data-speculative instructions are chosen for schedule
18628 only if there are no other choices at the moment.  This makes
18629 the use of the data speculation much more conservative.
18630 The default setting is disabled.
18632 @item -mno-sched-prefer-non-control-spec-insns
18633 @itemx -msched-prefer-non-control-spec-insns
18634 @opindex mno-sched-prefer-non-control-spec-insns
18635 @opindex msched-prefer-non-control-spec-insns
18636 If enabled, control-speculative instructions are chosen for schedule
18637 only if there are no other choices at the moment.  This makes
18638 the use of the control speculation much more conservative.
18639 The default setting is disabled.
18641 @item -mno-sched-count-spec-in-critical-path
18642 @itemx -msched-count-spec-in-critical-path
18643 @opindex mno-sched-count-spec-in-critical-path
18644 @opindex msched-count-spec-in-critical-path
18645 If enabled, speculative dependencies are considered during
18646 computation of the instructions priorities.  This makes the use of the
18647 speculation a bit more conservative.
18648 The default setting is disabled.
18650 @item -msched-spec-ldc
18651 @opindex msched-spec-ldc
18652 Use a simple data speculation check.  This option is on by default.
18654 @item -msched-control-spec-ldc
18655 @opindex msched-spec-ldc
18656 Use a simple check for control speculation.  This option is on by default.
18658 @item -msched-stop-bits-after-every-cycle
18659 @opindex msched-stop-bits-after-every-cycle
18660 Place a stop bit after every cycle when scheduling.  This option is on
18661 by default.
18663 @item -msched-fp-mem-deps-zero-cost
18664 @opindex msched-fp-mem-deps-zero-cost
18665 Assume that floating-point stores and loads are not likely to cause a conflict
18666 when placed into the same instruction group.  This option is disabled by
18667 default.
18669 @item -msel-sched-dont-check-control-spec
18670 @opindex msel-sched-dont-check-control-spec
18671 Generate checks for control speculation in selective scheduling.
18672 This flag is disabled by default.
18674 @item -msched-max-memory-insns=@var{max-insns}
18675 @opindex msched-max-memory-insns
18676 Limit on the number of memory insns per instruction group, giving lower
18677 priority to subsequent memory insns attempting to schedule in the same
18678 instruction group. Frequently useful to prevent cache bank conflicts.
18679 The default value is 1.
18681 @item -msched-max-memory-insns-hard-limit
18682 @opindex msched-max-memory-insns-hard-limit
18683 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18684 disallowing more than that number in an instruction group.
18685 Otherwise, the limit is ``soft'', meaning that non-memory operations
18686 are preferred when the limit is reached, but memory operations may still
18687 be scheduled.
18689 @end table
18691 @node LM32 Options
18692 @subsection LM32 Options
18693 @cindex LM32 options
18695 These @option{-m} options are defined for the LatticeMico32 architecture:
18697 @table @gcctabopt
18698 @item -mbarrel-shift-enabled
18699 @opindex mbarrel-shift-enabled
18700 Enable barrel-shift instructions.
18702 @item -mdivide-enabled
18703 @opindex mdivide-enabled
18704 Enable divide and modulus instructions.
18706 @item -mmultiply-enabled
18707 @opindex multiply-enabled
18708 Enable multiply instructions.
18710 @item -msign-extend-enabled
18711 @opindex msign-extend-enabled
18712 Enable sign extend instructions.
18714 @item -muser-enabled
18715 @opindex muser-enabled
18716 Enable user-defined instructions.
18718 @end table
18720 @node M32C Options
18721 @subsection M32C Options
18722 @cindex M32C options
18724 @table @gcctabopt
18725 @item -mcpu=@var{name}
18726 @opindex mcpu=
18727 Select the CPU for which code is generated.  @var{name} may be one of
18728 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18729 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18730 the M32C/80 series.
18732 @item -msim
18733 @opindex msim
18734 Specifies that the program will be run on the simulator.  This causes
18735 an alternate runtime library to be linked in which supports, for
18736 example, file I/O@.  You must not use this option when generating
18737 programs that will run on real hardware; you must provide your own
18738 runtime library for whatever I/O functions are needed.
18740 @item -memregs=@var{number}
18741 @opindex memregs=
18742 Specifies the number of memory-based pseudo-registers GCC uses
18743 during code generation.  These pseudo-registers are used like real
18744 registers, so there is a tradeoff between GCC's ability to fit the
18745 code into available registers, and the performance penalty of using
18746 memory instead of registers.  Note that all modules in a program must
18747 be compiled with the same value for this option.  Because of that, you
18748 must not use this option with GCC's default runtime libraries.
18750 @end table
18752 @node M32R/D Options
18753 @subsection M32R/D Options
18754 @cindex M32R/D options
18756 These @option{-m} options are defined for Renesas M32R/D architectures:
18758 @table @gcctabopt
18759 @item -m32r2
18760 @opindex m32r2
18761 Generate code for the M32R/2@.
18763 @item -m32rx
18764 @opindex m32rx
18765 Generate code for the M32R/X@.
18767 @item -m32r
18768 @opindex m32r
18769 Generate code for the M32R@.  This is the default.
18771 @item -mmodel=small
18772 @opindex mmodel=small
18773 Assume all objects live in the lower 16MB of memory (so that their addresses
18774 can be loaded with the @code{ld24} instruction), and assume all subroutines
18775 are reachable with the @code{bl} instruction.
18776 This is the default.
18778 The addressability of a particular object can be set with the
18779 @code{model} attribute.
18781 @item -mmodel=medium
18782 @opindex mmodel=medium
18783 Assume objects may be anywhere in the 32-bit address space (the compiler
18784 generates @code{seth/add3} instructions to load their addresses), and
18785 assume all subroutines are reachable with the @code{bl} instruction.
18787 @item -mmodel=large
18788 @opindex mmodel=large
18789 Assume objects may be anywhere in the 32-bit address space (the compiler
18790 generates @code{seth/add3} instructions to load their addresses), and
18791 assume subroutines may not be reachable with the @code{bl} instruction
18792 (the compiler generates the much slower @code{seth/add3/jl}
18793 instruction sequence).
18795 @item -msdata=none
18796 @opindex msdata=none
18797 Disable use of the small data area.  Variables are put into
18798 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18799 @code{section} attribute has been specified).
18800 This is the default.
18802 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18803 Objects may be explicitly put in the small data area with the
18804 @code{section} attribute using one of these sections.
18806 @item -msdata=sdata
18807 @opindex msdata=sdata
18808 Put small global and static data in the small data area, but do not
18809 generate special code to reference them.
18811 @item -msdata=use
18812 @opindex msdata=use
18813 Put small global and static data in the small data area, and generate
18814 special instructions to reference them.
18816 @item -G @var{num}
18817 @opindex G
18818 @cindex smaller data references
18819 Put global and static objects less than or equal to @var{num} bytes
18820 into the small data or BSS sections instead of the normal data or BSS
18821 sections.  The default value of @var{num} is 8.
18822 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18823 for this option to have any effect.
18825 All modules should be compiled with the same @option{-G @var{num}} value.
18826 Compiling with different values of @var{num} may or may not work; if it
18827 doesn't the linker gives an error message---incorrect code is not
18828 generated.
18830 @item -mdebug
18831 @opindex mdebug
18832 Makes the M32R-specific code in the compiler display some statistics
18833 that might help in debugging programs.
18835 @item -malign-loops
18836 @opindex malign-loops
18837 Align all loops to a 32-byte boundary.
18839 @item -mno-align-loops
18840 @opindex mno-align-loops
18841 Do not enforce a 32-byte alignment for loops.  This is the default.
18843 @item -missue-rate=@var{number}
18844 @opindex missue-rate=@var{number}
18845 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18846 or 2.
18848 @item -mbranch-cost=@var{number}
18849 @opindex mbranch-cost=@var{number}
18850 @var{number} can only be 1 or 2.  If it is 1 then branches are
18851 preferred over conditional code, if it is 2, then the opposite applies.
18853 @item -mflush-trap=@var{number}
18854 @opindex mflush-trap=@var{number}
18855 Specifies the trap number to use to flush the cache.  The default is
18856 12.  Valid numbers are between 0 and 15 inclusive.
18858 @item -mno-flush-trap
18859 @opindex mno-flush-trap
18860 Specifies that the cache cannot be flushed by using a trap.
18862 @item -mflush-func=@var{name}
18863 @opindex mflush-func=@var{name}
18864 Specifies the name of the operating system function to call to flush
18865 the cache.  The default is @samp{_flush_cache}, but a function call
18866 is only used if a trap is not available.
18868 @item -mno-flush-func
18869 @opindex mno-flush-func
18870 Indicates that there is no OS function for flushing the cache.
18872 @end table
18874 @node M680x0 Options
18875 @subsection M680x0 Options
18876 @cindex M680x0 options
18878 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18879 The default settings depend on which architecture was selected when
18880 the compiler was configured; the defaults for the most common choices
18881 are given below.
18883 @table @gcctabopt
18884 @item -march=@var{arch}
18885 @opindex march
18886 Generate code for a specific M680x0 or ColdFire instruction set
18887 architecture.  Permissible values of @var{arch} for M680x0
18888 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18889 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18890 architectures are selected according to Freescale's ISA classification
18891 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18892 @samp{isab} and @samp{isac}.
18894 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18895 code for a ColdFire target.  The @var{arch} in this macro is one of the
18896 @option{-march} arguments given above.
18898 When used together, @option{-march} and @option{-mtune} select code
18899 that runs on a family of similar processors but that is optimized
18900 for a particular microarchitecture.
18902 @item -mcpu=@var{cpu}
18903 @opindex mcpu
18904 Generate code for a specific M680x0 or ColdFire processor.
18905 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18906 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18907 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18908 below, which also classifies the CPUs into families:
18910 @multitable @columnfractions 0.20 0.80
18911 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18912 @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}
18913 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18914 @item @samp{5206e} @tab @samp{5206e}
18915 @item @samp{5208} @tab @samp{5207} @samp{5208}
18916 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18917 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18918 @item @samp{5216} @tab @samp{5214} @samp{5216}
18919 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18920 @item @samp{5225} @tab @samp{5224} @samp{5225}
18921 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18922 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18923 @item @samp{5249} @tab @samp{5249}
18924 @item @samp{5250} @tab @samp{5250}
18925 @item @samp{5271} @tab @samp{5270} @samp{5271}
18926 @item @samp{5272} @tab @samp{5272}
18927 @item @samp{5275} @tab @samp{5274} @samp{5275}
18928 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18929 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18930 @item @samp{5307} @tab @samp{5307}
18931 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18932 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18933 @item @samp{5407} @tab @samp{5407}
18934 @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}
18935 @end multitable
18937 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18938 @var{arch} is compatible with @var{cpu}.  Other combinations of
18939 @option{-mcpu} and @option{-march} are rejected.
18941 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18942 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18943 where the value of @var{family} is given by the table above.
18945 @item -mtune=@var{tune}
18946 @opindex mtune
18947 Tune the code for a particular microarchitecture within the
18948 constraints set by @option{-march} and @option{-mcpu}.
18949 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18950 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18951 and @samp{cpu32}.  The ColdFire microarchitectures
18952 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18954 You can also use @option{-mtune=68020-40} for code that needs
18955 to run relatively well on 68020, 68030 and 68040 targets.
18956 @option{-mtune=68020-60} is similar but includes 68060 targets
18957 as well.  These two options select the same tuning decisions as
18958 @option{-m68020-40} and @option{-m68020-60} respectively.
18960 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18961 when tuning for 680x0 architecture @var{arch}.  It also defines
18962 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18963 option is used.  If GCC is tuning for a range of architectures,
18964 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18965 it defines the macros for every architecture in the range.
18967 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18968 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18969 of the arguments given above.
18971 @item -m68000
18972 @itemx -mc68000
18973 @opindex m68000
18974 @opindex mc68000
18975 Generate output for a 68000.  This is the default
18976 when the compiler is configured for 68000-based systems.
18977 It is equivalent to @option{-march=68000}.
18979 Use this option for microcontrollers with a 68000 or EC000 core,
18980 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18982 @item -m68010
18983 @opindex m68010
18984 Generate output for a 68010.  This is the default
18985 when the compiler is configured for 68010-based systems.
18986 It is equivalent to @option{-march=68010}.
18988 @item -m68020
18989 @itemx -mc68020
18990 @opindex m68020
18991 @opindex mc68020
18992 Generate output for a 68020.  This is the default
18993 when the compiler is configured for 68020-based systems.
18994 It is equivalent to @option{-march=68020}.
18996 @item -m68030
18997 @opindex m68030
18998 Generate output for a 68030.  This is the default when the compiler is
18999 configured for 68030-based systems.  It is equivalent to
19000 @option{-march=68030}.
19002 @item -m68040
19003 @opindex m68040
19004 Generate output for a 68040.  This is the default when the compiler is
19005 configured for 68040-based systems.  It is equivalent to
19006 @option{-march=68040}.
19008 This option inhibits the use of 68881/68882 instructions that have to be
19009 emulated by software on the 68040.  Use this option if your 68040 does not
19010 have code to emulate those instructions.
19012 @item -m68060
19013 @opindex m68060
19014 Generate output for a 68060.  This is the default when the compiler is
19015 configured for 68060-based systems.  It is equivalent to
19016 @option{-march=68060}.
19018 This option inhibits the use of 68020 and 68881/68882 instructions that
19019 have to be emulated by software on the 68060.  Use this option if your 68060
19020 does not have code to emulate those instructions.
19022 @item -mcpu32
19023 @opindex mcpu32
19024 Generate output for a CPU32.  This is the default
19025 when the compiler is configured for CPU32-based systems.
19026 It is equivalent to @option{-march=cpu32}.
19028 Use this option for microcontrollers with a
19029 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19030 68336, 68340, 68341, 68349 and 68360.
19032 @item -m5200
19033 @opindex m5200
19034 Generate output for a 520X ColdFire CPU@.  This is the default
19035 when the compiler is configured for 520X-based systems.
19036 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19037 in favor of that option.
19039 Use this option for microcontroller with a 5200 core, including
19040 the MCF5202, MCF5203, MCF5204 and MCF5206.
19042 @item -m5206e
19043 @opindex m5206e
19044 Generate output for a 5206e ColdFire CPU@.  The option is now
19045 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19047 @item -m528x
19048 @opindex m528x
19049 Generate output for a member of the ColdFire 528X family.
19050 The option is now deprecated in favor of the equivalent
19051 @option{-mcpu=528x}.
19053 @item -m5307
19054 @opindex m5307
19055 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19056 in favor of the equivalent @option{-mcpu=5307}.
19058 @item -m5407
19059 @opindex m5407
19060 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19061 in favor of the equivalent @option{-mcpu=5407}.
19063 @item -mcfv4e
19064 @opindex mcfv4e
19065 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19066 This includes use of hardware floating-point instructions.
19067 The option is equivalent to @option{-mcpu=547x}, and is now
19068 deprecated in favor of that option.
19070 @item -m68020-40
19071 @opindex m68020-40
19072 Generate output for a 68040, without using any of the new instructions.
19073 This results in code that can run relatively efficiently on either a
19074 68020/68881 or a 68030 or a 68040.  The generated code does use the
19075 68881 instructions that are emulated on the 68040.
19077 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19079 @item -m68020-60
19080 @opindex m68020-60
19081 Generate output for a 68060, without using any of the new instructions.
19082 This results in code that can run relatively efficiently on either a
19083 68020/68881 or a 68030 or a 68040.  The generated code does use the
19084 68881 instructions that are emulated on the 68060.
19086 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19088 @item -mhard-float
19089 @itemx -m68881
19090 @opindex mhard-float
19091 @opindex m68881
19092 Generate floating-point instructions.  This is the default for 68020
19093 and above, and for ColdFire devices that have an FPU@.  It defines the
19094 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19095 on ColdFire targets.
19097 @item -msoft-float
19098 @opindex msoft-float
19099 Do not generate floating-point instructions; use library calls instead.
19100 This is the default for 68000, 68010, and 68832 targets.  It is also
19101 the default for ColdFire devices that have no FPU.
19103 @item -mdiv
19104 @itemx -mno-div
19105 @opindex mdiv
19106 @opindex mno-div
19107 Generate (do not generate) ColdFire hardware divide and remainder
19108 instructions.  If @option{-march} is used without @option{-mcpu},
19109 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19110 architectures.  Otherwise, the default is taken from the target CPU
19111 (either the default CPU, or the one specified by @option{-mcpu}).  For
19112 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19113 @option{-mcpu=5206e}.
19115 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19117 @item -mshort
19118 @opindex mshort
19119 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19120 Additionally, parameters passed on the stack are also aligned to a
19121 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19123 @item -mno-short
19124 @opindex mno-short
19125 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19127 @item -mnobitfield
19128 @itemx -mno-bitfield
19129 @opindex mnobitfield
19130 @opindex mno-bitfield
19131 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19132 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19134 @item -mbitfield
19135 @opindex mbitfield
19136 Do use the bit-field instructions.  The @option{-m68020} option implies
19137 @option{-mbitfield}.  This is the default if you use a configuration
19138 designed for a 68020.
19140 @item -mrtd
19141 @opindex mrtd
19142 Use a different function-calling convention, in which functions
19143 that take a fixed number of arguments return with the @code{rtd}
19144 instruction, which pops their arguments while returning.  This
19145 saves one instruction in the caller since there is no need to pop
19146 the arguments there.
19148 This calling convention is incompatible with the one normally
19149 used on Unix, so you cannot use it if you need to call libraries
19150 compiled with the Unix compiler.
19152 Also, you must provide function prototypes for all functions that
19153 take variable numbers of arguments (including @code{printf});
19154 otherwise incorrect code is generated for calls to those
19155 functions.
19157 In addition, seriously incorrect code results if you call a
19158 function with too many arguments.  (Normally, extra arguments are
19159 harmlessly ignored.)
19161 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19162 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19164 @item -mno-rtd
19165 @opindex mno-rtd
19166 Do not use the calling conventions selected by @option{-mrtd}.
19167 This is the default.
19169 @item -malign-int
19170 @itemx -mno-align-int
19171 @opindex malign-int
19172 @opindex mno-align-int
19173 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19174 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19175 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19176 Aligning variables on 32-bit boundaries produces code that runs somewhat
19177 faster on processors with 32-bit busses at the expense of more memory.
19179 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19180 aligns structures containing the above types differently than
19181 most published application binary interface specifications for the m68k.
19183 @item -mpcrel
19184 @opindex mpcrel
19185 Use the pc-relative addressing mode of the 68000 directly, instead of
19186 using a global offset table.  At present, this option implies @option{-fpic},
19187 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19188 not presently supported with @option{-mpcrel}, though this could be supported for
19189 68020 and higher processors.
19191 @item -mno-strict-align
19192 @itemx -mstrict-align
19193 @opindex mno-strict-align
19194 @opindex mstrict-align
19195 Do not (do) assume that unaligned memory references are handled by
19196 the system.
19198 @item -msep-data
19199 Generate code that allows the data segment to be located in a different
19200 area of memory from the text segment.  This allows for execute-in-place in
19201 an environment without virtual memory management.  This option implies
19202 @option{-fPIC}.
19204 @item -mno-sep-data
19205 Generate code that assumes that the data segment follows the text segment.
19206 This is the default.
19208 @item -mid-shared-library
19209 Generate code that supports shared libraries via the library ID method.
19210 This allows for execute-in-place and shared libraries in an environment
19211 without virtual memory management.  This option implies @option{-fPIC}.
19213 @item -mno-id-shared-library
19214 Generate code that doesn't assume ID-based shared libraries are being used.
19215 This is the default.
19217 @item -mshared-library-id=n
19218 Specifies the identification number of the ID-based shared library being
19219 compiled.  Specifying a value of 0 generates more compact code; specifying
19220 other values forces the allocation of that number to the current
19221 library, but is no more space- or time-efficient than omitting this option.
19223 @item -mxgot
19224 @itemx -mno-xgot
19225 @opindex mxgot
19226 @opindex mno-xgot
19227 When generating position-independent code for ColdFire, generate code
19228 that works if the GOT has more than 8192 entries.  This code is
19229 larger and slower than code generated without this option.  On M680x0
19230 processors, this option is not needed; @option{-fPIC} suffices.
19232 GCC normally uses a single instruction to load values from the GOT@.
19233 While this is relatively efficient, it only works if the GOT
19234 is smaller than about 64k.  Anything larger causes the linker
19235 to report an error such as:
19237 @cindex relocation truncated to fit (ColdFire)
19238 @smallexample
19239 relocation truncated to fit: R_68K_GOT16O foobar
19240 @end smallexample
19242 If this happens, you should recompile your code with @option{-mxgot}.
19243 It should then work with very large GOTs.  However, code generated with
19244 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19245 the value of a global symbol.
19247 Note that some linkers, including newer versions of the GNU linker,
19248 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19249 you should only need to use @option{-mxgot} when compiling a single
19250 object file that accesses more than 8192 GOT entries.  Very few do.
19252 These options have no effect unless GCC is generating
19253 position-independent code.
19255 @item -mlong-jump-table-offsets
19256 @opindex mlong-jump-table-offsets
19257 Use 32-bit offsets in @code{switch} tables.  The default is to use
19258 16-bit offsets.
19260 @end table
19262 @node MCore Options
19263 @subsection MCore Options
19264 @cindex MCore options
19266 These are the @samp{-m} options defined for the Motorola M*Core
19267 processors.
19269 @table @gcctabopt
19271 @item -mhardlit
19272 @itemx -mno-hardlit
19273 @opindex mhardlit
19274 @opindex mno-hardlit
19275 Inline constants into the code stream if it can be done in two
19276 instructions or less.
19278 @item -mdiv
19279 @itemx -mno-div
19280 @opindex mdiv
19281 @opindex mno-div
19282 Use the divide instruction.  (Enabled by default).
19284 @item -mrelax-immediate
19285 @itemx -mno-relax-immediate
19286 @opindex mrelax-immediate
19287 @opindex mno-relax-immediate
19288 Allow arbitrary-sized immediates in bit operations.
19290 @item -mwide-bitfields
19291 @itemx -mno-wide-bitfields
19292 @opindex mwide-bitfields
19293 @opindex mno-wide-bitfields
19294 Always treat bit-fields as @code{int}-sized.
19296 @item -m4byte-functions
19297 @itemx -mno-4byte-functions
19298 @opindex m4byte-functions
19299 @opindex mno-4byte-functions
19300 Force all functions to be aligned to a 4-byte boundary.
19302 @item -mcallgraph-data
19303 @itemx -mno-callgraph-data
19304 @opindex mcallgraph-data
19305 @opindex mno-callgraph-data
19306 Emit callgraph information.
19308 @item -mslow-bytes
19309 @itemx -mno-slow-bytes
19310 @opindex mslow-bytes
19311 @opindex mno-slow-bytes
19312 Prefer word access when reading byte quantities.
19314 @item -mlittle-endian
19315 @itemx -mbig-endian
19316 @opindex mlittle-endian
19317 @opindex mbig-endian
19318 Generate code for a little-endian target.
19320 @item -m210
19321 @itemx -m340
19322 @opindex m210
19323 @opindex m340
19324 Generate code for the 210 processor.
19326 @item -mno-lsim
19327 @opindex mno-lsim
19328 Assume that runtime support has been provided and so omit the
19329 simulator library (@file{libsim.a)} from the linker command line.
19331 @item -mstack-increment=@var{size}
19332 @opindex mstack-increment
19333 Set the maximum amount for a single stack increment operation.  Large
19334 values can increase the speed of programs that contain functions
19335 that need a large amount of stack space, but they can also trigger a
19336 segmentation fault if the stack is extended too much.  The default
19337 value is 0x1000.
19339 @end table
19341 @node MeP Options
19342 @subsection MeP Options
19343 @cindex MeP options
19345 @table @gcctabopt
19347 @item -mabsdiff
19348 @opindex mabsdiff
19349 Enables the @code{abs} instruction, which is the absolute difference
19350 between two registers.
19352 @item -mall-opts
19353 @opindex mall-opts
19354 Enables all the optional instructions---average, multiply, divide, bit
19355 operations, leading zero, absolute difference, min/max, clip, and
19356 saturation.
19359 @item -maverage
19360 @opindex maverage
19361 Enables the @code{ave} instruction, which computes the average of two
19362 registers.
19364 @item -mbased=@var{n}
19365 @opindex mbased=
19366 Variables of size @var{n} bytes or smaller are placed in the
19367 @code{.based} section by default.  Based variables use the @code{$tp}
19368 register as a base register, and there is a 128-byte limit to the
19369 @code{.based} section.
19371 @item -mbitops
19372 @opindex mbitops
19373 Enables the bit operation instructions---bit test (@code{btstm}), set
19374 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19375 test-and-set (@code{tas}).
19377 @item -mc=@var{name}
19378 @opindex mc=
19379 Selects which section constant data is placed in.  @var{name} may
19380 be @samp{tiny}, @samp{near}, or @samp{far}.
19382 @item -mclip
19383 @opindex mclip
19384 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19385 useful unless you also provide @option{-mminmax}.
19387 @item -mconfig=@var{name}
19388 @opindex mconfig=
19389 Selects one of the built-in core configurations.  Each MeP chip has
19390 one or more modules in it; each module has a core CPU and a variety of
19391 coprocessors, optional instructions, and peripherals.  The
19392 @code{MeP-Integrator} tool, not part of GCC, provides these
19393 configurations through this option; using this option is the same as
19394 using all the corresponding command-line options.  The default
19395 configuration is @samp{default}.
19397 @item -mcop
19398 @opindex mcop
19399 Enables the coprocessor instructions.  By default, this is a 32-bit
19400 coprocessor.  Note that the coprocessor is normally enabled via the
19401 @option{-mconfig=} option.
19403 @item -mcop32
19404 @opindex mcop32
19405 Enables the 32-bit coprocessor's instructions.
19407 @item -mcop64
19408 @opindex mcop64
19409 Enables the 64-bit coprocessor's instructions.
19411 @item -mivc2
19412 @opindex mivc2
19413 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19415 @item -mdc
19416 @opindex mdc
19417 Causes constant variables to be placed in the @code{.near} section.
19419 @item -mdiv
19420 @opindex mdiv
19421 Enables the @code{div} and @code{divu} instructions.
19423 @item -meb
19424 @opindex meb
19425 Generate big-endian code.
19427 @item -mel
19428 @opindex mel
19429 Generate little-endian code.
19431 @item -mio-volatile
19432 @opindex mio-volatile
19433 Tells the compiler that any variable marked with the @code{io}
19434 attribute is to be considered volatile.
19436 @item -ml
19437 @opindex ml
19438 Causes variables to be assigned to the @code{.far} section by default.
19440 @item -mleadz
19441 @opindex mleadz
19442 Enables the @code{leadz} (leading zero) instruction.
19444 @item -mm
19445 @opindex mm
19446 Causes variables to be assigned to the @code{.near} section by default.
19448 @item -mminmax
19449 @opindex mminmax
19450 Enables the @code{min} and @code{max} instructions.
19452 @item -mmult
19453 @opindex mmult
19454 Enables the multiplication and multiply-accumulate instructions.
19456 @item -mno-opts
19457 @opindex mno-opts
19458 Disables all the optional instructions enabled by @option{-mall-opts}.
19460 @item -mrepeat
19461 @opindex mrepeat
19462 Enables the @code{repeat} and @code{erepeat} instructions, used for
19463 low-overhead looping.
19465 @item -ms
19466 @opindex ms
19467 Causes all variables to default to the @code{.tiny} section.  Note
19468 that there is a 65536-byte limit to this section.  Accesses to these
19469 variables use the @code{%gp} base register.
19471 @item -msatur
19472 @opindex msatur
19473 Enables the saturation instructions.  Note that the compiler does not
19474 currently generate these itself, but this option is included for
19475 compatibility with other tools, like @code{as}.
19477 @item -msdram
19478 @opindex msdram
19479 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19481 @item -msim
19482 @opindex msim
19483 Link the simulator run-time libraries.
19485 @item -msimnovec
19486 @opindex msimnovec
19487 Link the simulator runtime libraries, excluding built-in support
19488 for reset and exception vectors and tables.
19490 @item -mtf
19491 @opindex mtf
19492 Causes all functions to default to the @code{.far} section.  Without
19493 this option, functions default to the @code{.near} section.
19495 @item -mtiny=@var{n}
19496 @opindex mtiny=
19497 Variables that are @var{n} bytes or smaller are allocated to the
19498 @code{.tiny} section.  These variables use the @code{$gp} base
19499 register.  The default for this option is 4, but note that there's a
19500 65536-byte limit to the @code{.tiny} section.
19502 @end table
19504 @node MicroBlaze Options
19505 @subsection MicroBlaze Options
19506 @cindex MicroBlaze Options
19508 @table @gcctabopt
19510 @item -msoft-float
19511 @opindex msoft-float
19512 Use software emulation for floating point (default).
19514 @item -mhard-float
19515 @opindex mhard-float
19516 Use hardware floating-point instructions.
19518 @item -mmemcpy
19519 @opindex mmemcpy
19520 Do not optimize block moves, use @code{memcpy}.
19522 @item -mno-clearbss
19523 @opindex mno-clearbss
19524 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19526 @item -mcpu=@var{cpu-type}
19527 @opindex mcpu=
19528 Use features of, and schedule code for, the given CPU.
19529 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19530 where @var{X} is a major version, @var{YY} is the minor version, and
19531 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19532 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19534 @item -mxl-soft-mul
19535 @opindex mxl-soft-mul
19536 Use software multiply emulation (default).
19538 @item -mxl-soft-div
19539 @opindex mxl-soft-div
19540 Use software emulation for divides (default).
19542 @item -mxl-barrel-shift
19543 @opindex mxl-barrel-shift
19544 Use the hardware barrel shifter.
19546 @item -mxl-pattern-compare
19547 @opindex mxl-pattern-compare
19548 Use pattern compare instructions.
19550 @item -msmall-divides
19551 @opindex msmall-divides
19552 Use table lookup optimization for small signed integer divisions.
19554 @item -mxl-stack-check
19555 @opindex mxl-stack-check
19556 This option is deprecated.  Use @option{-fstack-check} instead.
19558 @item -mxl-gp-opt
19559 @opindex mxl-gp-opt
19560 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19562 @item -mxl-multiply-high
19563 @opindex mxl-multiply-high
19564 Use multiply high instructions for high part of 32x32 multiply.
19566 @item -mxl-float-convert
19567 @opindex mxl-float-convert
19568 Use hardware floating-point conversion instructions.
19570 @item -mxl-float-sqrt
19571 @opindex mxl-float-sqrt
19572 Use hardware floating-point square root instruction.
19574 @item -mbig-endian
19575 @opindex mbig-endian
19576 Generate code for a big-endian target.
19578 @item -mlittle-endian
19579 @opindex mlittle-endian
19580 Generate code for a little-endian target.
19582 @item -mxl-reorder
19583 @opindex mxl-reorder
19584 Use reorder instructions (swap and byte reversed load/store).
19586 @item -mxl-mode-@var{app-model}
19587 Select application model @var{app-model}.  Valid models are
19588 @table @samp
19589 @item executable
19590 normal executable (default), uses startup code @file{crt0.o}.
19592 @item xmdstub
19593 for use with Xilinx Microprocessor Debugger (XMD) based
19594 software intrusive debug agent called xmdstub. This uses startup file
19595 @file{crt1.o} and sets the start address of the program to 0x800.
19597 @item bootstrap
19598 for applications that are loaded using a bootloader.
19599 This model uses startup file @file{crt2.o} which does not contain a processor
19600 reset vector handler. This is suitable for transferring control on a
19601 processor reset to the bootloader rather than the application.
19603 @item novectors
19604 for applications that do not require any of the
19605 MicroBlaze vectors. This option may be useful for applications running
19606 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19607 @end table
19609 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19610 @option{-mxl-mode-@var{app-model}}.
19612 @end table
19614 @node MIPS Options
19615 @subsection MIPS Options
19616 @cindex MIPS options
19618 @table @gcctabopt
19620 @item -EB
19621 @opindex EB
19622 Generate big-endian code.
19624 @item -EL
19625 @opindex EL
19626 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19627 configurations.
19629 @item -march=@var{arch}
19630 @opindex march
19631 Generate code that runs on @var{arch}, which can be the name of a
19632 generic MIPS ISA, or the name of a particular processor.
19633 The ISA names are:
19634 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19635 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19636 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19637 @samp{mips64r5} and @samp{mips64r6}.
19638 The processor names are:
19639 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19640 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19641 @samp{5kc}, @samp{5kf},
19642 @samp{20kc},
19643 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19644 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19645 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19646 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19647 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19648 @samp{i6400},
19649 @samp{interaptiv},
19650 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19651 @samp{m4k},
19652 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19653 @samp{m5100}, @samp{m5101},
19654 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19655 @samp{orion},
19656 @samp{p5600},
19657 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19658 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19659 @samp{rm7000}, @samp{rm9000},
19660 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19661 @samp{sb1},
19662 @samp{sr71000},
19663 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19664 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19665 @samp{xlr} and @samp{xlp}.
19666 The special value @samp{from-abi} selects the
19667 most compatible architecture for the selected ABI (that is,
19668 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19670 The native Linux/GNU toolchain also supports the value @samp{native},
19671 which selects the best architecture option for the host processor.
19672 @option{-march=native} has no effect if GCC does not recognize
19673 the processor.
19675 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19676 (for example, @option{-march=r2k}).  Prefixes are optional, and
19677 @samp{vr} may be written @samp{r}.
19679 Names of the form @samp{@var{n}f2_1} refer to processors with
19680 FPUs clocked at half the rate of the core, names of the form
19681 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19682 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19683 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19684 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19685 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19686 accepted as synonyms for @samp{@var{n}f1_1}.
19688 GCC defines two macros based on the value of this option.  The first
19689 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19690 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19691 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19692 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19693 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19695 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19696 above.  In other words, it has the full prefix and does not
19697 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19698 the macro names the resolved architecture (either @code{"mips1"} or
19699 @code{"mips3"}).  It names the default architecture when no
19700 @option{-march} option is given.
19702 @item -mtune=@var{arch}
19703 @opindex mtune
19704 Optimize for @var{arch}.  Among other things, this option controls
19705 the way instructions are scheduled, and the perceived cost of arithmetic
19706 operations.  The list of @var{arch} values is the same as for
19707 @option{-march}.
19709 When this option is not used, GCC optimizes for the processor
19710 specified by @option{-march}.  By using @option{-march} and
19711 @option{-mtune} together, it is possible to generate code that
19712 runs on a family of processors, but optimize the code for one
19713 particular member of that family.
19715 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19716 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19717 @option{-march} ones described above.
19719 @item -mips1
19720 @opindex mips1
19721 Equivalent to @option{-march=mips1}.
19723 @item -mips2
19724 @opindex mips2
19725 Equivalent to @option{-march=mips2}.
19727 @item -mips3
19728 @opindex mips3
19729 Equivalent to @option{-march=mips3}.
19731 @item -mips4
19732 @opindex mips4
19733 Equivalent to @option{-march=mips4}.
19735 @item -mips32
19736 @opindex mips32
19737 Equivalent to @option{-march=mips32}.
19739 @item -mips32r3
19740 @opindex mips32r3
19741 Equivalent to @option{-march=mips32r3}.
19743 @item -mips32r5
19744 @opindex mips32r5
19745 Equivalent to @option{-march=mips32r5}.
19747 @item -mips32r6
19748 @opindex mips32r6
19749 Equivalent to @option{-march=mips32r6}.
19751 @item -mips64
19752 @opindex mips64
19753 Equivalent to @option{-march=mips64}.
19755 @item -mips64r2
19756 @opindex mips64r2
19757 Equivalent to @option{-march=mips64r2}.
19759 @item -mips64r3
19760 @opindex mips64r3
19761 Equivalent to @option{-march=mips64r3}.
19763 @item -mips64r5
19764 @opindex mips64r5
19765 Equivalent to @option{-march=mips64r5}.
19767 @item -mips64r6
19768 @opindex mips64r6
19769 Equivalent to @option{-march=mips64r6}.
19771 @item -mips16
19772 @itemx -mno-mips16
19773 @opindex mips16
19774 @opindex mno-mips16
19775 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19776 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19778 MIPS16 code generation can also be controlled on a per-function basis
19779 by means of @code{mips16} and @code{nomips16} attributes.
19780 @xref{Function Attributes}, for more information.
19782 @item -mflip-mips16
19783 @opindex mflip-mips16
19784 Generate MIPS16 code on alternating functions.  This option is provided
19785 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19786 not intended for ordinary use in compiling user code.
19788 @item -minterlink-compressed
19789 @item -mno-interlink-compressed
19790 @opindex minterlink-compressed
19791 @opindex mno-interlink-compressed
19792 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19793 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19795 For example, code using the standard ISA encoding cannot jump directly
19796 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19797 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19798 knows that the target of the jump is not compressed.
19800 @item -minterlink-mips16
19801 @itemx -mno-interlink-mips16
19802 @opindex minterlink-mips16
19803 @opindex mno-interlink-mips16
19804 Aliases of @option{-minterlink-compressed} and
19805 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19806 and are retained for backwards compatibility.
19808 @item -mabi=32
19809 @itemx -mabi=o64
19810 @itemx -mabi=n32
19811 @itemx -mabi=64
19812 @itemx -mabi=eabi
19813 @opindex mabi=32
19814 @opindex mabi=o64
19815 @opindex mabi=n32
19816 @opindex mabi=64
19817 @opindex mabi=eabi
19818 Generate code for the given ABI@.
19820 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19821 generates 64-bit code when you select a 64-bit architecture, but you
19822 can use @option{-mgp32} to get 32-bit code instead.
19824 For information about the O64 ABI, see
19825 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19827 GCC supports a variant of the o32 ABI in which floating-point registers
19828 are 64 rather than 32 bits wide.  You can select this combination with
19829 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19830 and @code{mfhc1} instructions and is therefore only supported for
19831 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19833 The register assignments for arguments and return values remain the
19834 same, but each scalar value is passed in a single 64-bit register
19835 rather than a pair of 32-bit registers.  For example, scalar
19836 floating-point values are returned in @samp{$f0} only, not a
19837 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19838 remains the same in that the even-numbered double-precision registers
19839 are saved.
19841 Two additional variants of the o32 ABI are supported to enable
19842 a transition from 32-bit to 64-bit registers.  These are FPXX
19843 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19844 The FPXX extension mandates that all code must execute correctly
19845 when run using 32-bit or 64-bit registers.  The code can be interlinked
19846 with either FP32 or FP64, but not both.
19847 The FP64A extension is similar to the FP64 extension but forbids the
19848 use of odd-numbered single-precision registers.  This can be used
19849 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19850 processors and allows both FP32 and FP64A code to interlink and
19851 run in the same process without changing FPU modes.
19853 @item -mabicalls
19854 @itemx -mno-abicalls
19855 @opindex mabicalls
19856 @opindex mno-abicalls
19857 Generate (do not generate) code that is suitable for SVR4-style
19858 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19859 systems.
19861 @item -mshared
19862 @itemx -mno-shared
19863 Generate (do not generate) code that is fully position-independent,
19864 and that can therefore be linked into shared libraries.  This option
19865 only affects @option{-mabicalls}.
19867 All @option{-mabicalls} code has traditionally been position-independent,
19868 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19869 as an extension, the GNU toolchain allows executables to use absolute
19870 accesses for locally-binding symbols.  It can also use shorter GP
19871 initialization sequences and generate direct calls to locally-defined
19872 functions.  This mode is selected by @option{-mno-shared}.
19874 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19875 objects that can only be linked by the GNU linker.  However, the option
19876 does not affect the ABI of the final executable; it only affects the ABI
19877 of relocatable objects.  Using @option{-mno-shared} generally makes
19878 executables both smaller and quicker.
19880 @option{-mshared} is the default.
19882 @item -mplt
19883 @itemx -mno-plt
19884 @opindex mplt
19885 @opindex mno-plt
19886 Assume (do not assume) that the static and dynamic linkers
19887 support PLTs and copy relocations.  This option only affects
19888 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19889 has no effect without @option{-msym32}.
19891 You can make @option{-mplt} the default by configuring
19892 GCC with @option{--with-mips-plt}.  The default is
19893 @option{-mno-plt} otherwise.
19895 @item -mxgot
19896 @itemx -mno-xgot
19897 @opindex mxgot
19898 @opindex mno-xgot
19899 Lift (do not lift) the usual restrictions on the size of the global
19900 offset table.
19902 GCC normally uses a single instruction to load values from the GOT@.
19903 While this is relatively efficient, it only works if the GOT
19904 is smaller than about 64k.  Anything larger causes the linker
19905 to report an error such as:
19907 @cindex relocation truncated to fit (MIPS)
19908 @smallexample
19909 relocation truncated to fit: R_MIPS_GOT16 foobar
19910 @end smallexample
19912 If this happens, you should recompile your code with @option{-mxgot}.
19913 This works with very large GOTs, although the code is also
19914 less efficient, since it takes three instructions to fetch the
19915 value of a global symbol.
19917 Note that some linkers can create multiple GOTs.  If you have such a
19918 linker, you should only need to use @option{-mxgot} when a single object
19919 file accesses more than 64k's worth of GOT entries.  Very few do.
19921 These options have no effect unless GCC is generating position
19922 independent code.
19924 @item -mgp32
19925 @opindex mgp32
19926 Assume that general-purpose registers are 32 bits wide.
19928 @item -mgp64
19929 @opindex mgp64
19930 Assume that general-purpose registers are 64 bits wide.
19932 @item -mfp32
19933 @opindex mfp32
19934 Assume that floating-point registers are 32 bits wide.
19936 @item -mfp64
19937 @opindex mfp64
19938 Assume that floating-point registers are 64 bits wide.
19940 @item -mfpxx
19941 @opindex mfpxx
19942 Do not assume the width of floating-point registers.
19944 @item -mhard-float
19945 @opindex mhard-float
19946 Use floating-point coprocessor instructions.
19948 @item -msoft-float
19949 @opindex msoft-float
19950 Do not use floating-point coprocessor instructions.  Implement
19951 floating-point calculations using library calls instead.
19953 @item -mno-float
19954 @opindex mno-float
19955 Equivalent to @option{-msoft-float}, but additionally asserts that the
19956 program being compiled does not perform any floating-point operations.
19957 This option is presently supported only by some bare-metal MIPS
19958 configurations, where it may select a special set of libraries
19959 that lack all floating-point support (including, for example, the
19960 floating-point @code{printf} formats).  
19961 If code compiled with @option{-mno-float} accidentally contains
19962 floating-point operations, it is likely to suffer a link-time
19963 or run-time failure.
19965 @item -msingle-float
19966 @opindex msingle-float
19967 Assume that the floating-point coprocessor only supports single-precision
19968 operations.
19970 @item -mdouble-float
19971 @opindex mdouble-float
19972 Assume that the floating-point coprocessor supports double-precision
19973 operations.  This is the default.
19975 @item -modd-spreg
19976 @itemx -mno-odd-spreg
19977 @opindex modd-spreg
19978 @opindex mno-odd-spreg
19979 Enable the use of odd-numbered single-precision floating-point registers
19980 for the o32 ABI.  This is the default for processors that are known to
19981 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19982 is set by default.
19984 @item -mabs=2008
19985 @itemx -mabs=legacy
19986 @opindex mabs=2008
19987 @opindex mabs=legacy
19988 These options control the treatment of the special not-a-number (NaN)
19989 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19990 @code{neg.@i{fmt}} machine instructions.
19992 By default or when @option{-mabs=legacy} is used the legacy
19993 treatment is selected.  In this case these instructions are considered
19994 arithmetic and avoided where correct operation is required and the
19995 input operand might be a NaN.  A longer sequence of instructions that
19996 manipulate the sign bit of floating-point datum manually is used
19997 instead unless the @option{-ffinite-math-only} option has also been
19998 specified.
20000 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20001 this case these instructions are considered non-arithmetic and therefore
20002 operating correctly in all cases, including in particular where the
20003 input operand is a NaN.  These instructions are therefore always used
20004 for the respective operations.
20006 @item -mnan=2008
20007 @itemx -mnan=legacy
20008 @opindex mnan=2008
20009 @opindex mnan=legacy
20010 These options control the encoding of the special not-a-number (NaN)
20011 IEEE 754 floating-point data.
20013 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20014 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20015 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20016 by the first bit of their trailing significand field being 1.
20018 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20019 this case qNaNs are denoted by the first bit of their trailing
20020 significand field being 1, whereas sNaNs are denoted by the first bit of
20021 their trailing significand field being 0.
20023 The default is @option{-mnan=legacy} unless GCC has been configured with
20024 @option{--with-nan=2008}.
20026 @item -mllsc
20027 @itemx -mno-llsc
20028 @opindex mllsc
20029 @opindex mno-llsc
20030 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20031 implement atomic memory built-in functions.  When neither option is
20032 specified, GCC uses the instructions if the target architecture
20033 supports them.
20035 @option{-mllsc} is useful if the runtime environment can emulate the
20036 instructions and @option{-mno-llsc} can be useful when compiling for
20037 nonstandard ISAs.  You can make either option the default by
20038 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20039 respectively.  @option{--with-llsc} is the default for some
20040 configurations; see the installation documentation for details.
20042 @item -mdsp
20043 @itemx -mno-dsp
20044 @opindex mdsp
20045 @opindex mno-dsp
20046 Use (do not use) revision 1 of the MIPS DSP ASE@.
20047 @xref{MIPS DSP Built-in Functions}.  This option defines the
20048 preprocessor macro @code{__mips_dsp}.  It also defines
20049 @code{__mips_dsp_rev} to 1.
20051 @item -mdspr2
20052 @itemx -mno-dspr2
20053 @opindex mdspr2
20054 @opindex mno-dspr2
20055 Use (do not use) revision 2 of the MIPS DSP ASE@.
20056 @xref{MIPS DSP Built-in Functions}.  This option defines the
20057 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20058 It also defines @code{__mips_dsp_rev} to 2.
20060 @item -msmartmips
20061 @itemx -mno-smartmips
20062 @opindex msmartmips
20063 @opindex mno-smartmips
20064 Use (do not use) the MIPS SmartMIPS ASE.
20066 @item -mpaired-single
20067 @itemx -mno-paired-single
20068 @opindex mpaired-single
20069 @opindex mno-paired-single
20070 Use (do not use) paired-single floating-point instructions.
20071 @xref{MIPS Paired-Single Support}.  This option requires
20072 hardware floating-point support to be enabled.
20074 @item -mdmx
20075 @itemx -mno-mdmx
20076 @opindex mdmx
20077 @opindex mno-mdmx
20078 Use (do not use) MIPS Digital Media Extension instructions.
20079 This option can only be used when generating 64-bit code and requires
20080 hardware floating-point support to be enabled.
20082 @item -mips3d
20083 @itemx -mno-mips3d
20084 @opindex mips3d
20085 @opindex mno-mips3d
20086 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20087 The option @option{-mips3d} implies @option{-mpaired-single}.
20089 @item -mmicromips
20090 @itemx -mno-micromips
20091 @opindex mmicromips
20092 @opindex mno-mmicromips
20093 Generate (do not generate) microMIPS code.
20095 MicroMIPS code generation can also be controlled on a per-function basis
20096 by means of @code{micromips} and @code{nomicromips} attributes.
20097 @xref{Function Attributes}, for more information.
20099 @item -mmt
20100 @itemx -mno-mt
20101 @opindex mmt
20102 @opindex mno-mt
20103 Use (do not use) MT Multithreading instructions.
20105 @item -mmcu
20106 @itemx -mno-mcu
20107 @opindex mmcu
20108 @opindex mno-mcu
20109 Use (do not use) the MIPS MCU ASE instructions.
20111 @item -meva
20112 @itemx -mno-eva
20113 @opindex meva
20114 @opindex mno-eva
20115 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20117 @item -mvirt
20118 @itemx -mno-virt
20119 @opindex mvirt
20120 @opindex mno-virt
20121 Use (do not use) the MIPS Virtualization (VZ) instructions.
20123 @item -mxpa
20124 @itemx -mno-xpa
20125 @opindex mxpa
20126 @opindex mno-xpa
20127 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20129 @item -mlong64
20130 @opindex mlong64
20131 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20132 an explanation of the default and the way that the pointer size is
20133 determined.
20135 @item -mlong32
20136 @opindex mlong32
20137 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20139 The default size of @code{int}s, @code{long}s and pointers depends on
20140 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20141 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20142 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20143 or the same size as integer registers, whichever is smaller.
20145 @item -msym32
20146 @itemx -mno-sym32
20147 @opindex msym32
20148 @opindex mno-sym32
20149 Assume (do not assume) that all symbols have 32-bit values, regardless
20150 of the selected ABI@.  This option is useful in combination with
20151 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20152 to generate shorter and faster references to symbolic addresses.
20154 @item -G @var{num}
20155 @opindex G
20156 Put definitions of externally-visible data in a small data section
20157 if that data is no bigger than @var{num} bytes.  GCC can then generate
20158 more efficient accesses to the data; see @option{-mgpopt} for details.
20160 The default @option{-G} option depends on the configuration.
20162 @item -mlocal-sdata
20163 @itemx -mno-local-sdata
20164 @opindex mlocal-sdata
20165 @opindex mno-local-sdata
20166 Extend (do not extend) the @option{-G} behavior to local data too,
20167 such as to static variables in C@.  @option{-mlocal-sdata} is the
20168 default for all configurations.
20170 If the linker complains that an application is using too much small data,
20171 you might want to try rebuilding the less performance-critical parts with
20172 @option{-mno-local-sdata}.  You might also want to build large
20173 libraries with @option{-mno-local-sdata}, so that the libraries leave
20174 more room for the main program.
20176 @item -mextern-sdata
20177 @itemx -mno-extern-sdata
20178 @opindex mextern-sdata
20179 @opindex mno-extern-sdata
20180 Assume (do not assume) that externally-defined data is in
20181 a small data section if the size of that data is within the @option{-G} limit.
20182 @option{-mextern-sdata} is the default for all configurations.
20184 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20185 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20186 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20187 is placed in a small data section.  If @var{Var} is defined by another
20188 module, you must either compile that module with a high-enough
20189 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20190 definition.  If @var{Var} is common, you must link the application
20191 with a high-enough @option{-G} setting.
20193 The easiest way of satisfying these restrictions is to compile
20194 and link every module with the same @option{-G} option.  However,
20195 you may wish to build a library that supports several different
20196 small data limits.  You can do this by compiling the library with
20197 the highest supported @option{-G} setting and additionally using
20198 @option{-mno-extern-sdata} to stop the library from making assumptions
20199 about externally-defined data.
20201 @item -mgpopt
20202 @itemx -mno-gpopt
20203 @opindex mgpopt
20204 @opindex mno-gpopt
20205 Use (do not use) GP-relative accesses for symbols that are known to be
20206 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20207 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20208 configurations.
20210 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20211 might not hold the value of @code{_gp}.  For example, if the code is
20212 part of a library that might be used in a boot monitor, programs that
20213 call boot monitor routines pass an unknown value in @code{$gp}.
20214 (In such situations, the boot monitor itself is usually compiled
20215 with @option{-G0}.)
20217 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20218 @option{-mno-extern-sdata}.
20220 @item -membedded-data
20221 @itemx -mno-embedded-data
20222 @opindex membedded-data
20223 @opindex mno-embedded-data
20224 Allocate variables to the read-only data section first if possible, then
20225 next in the small data section if possible, otherwise in data.  This gives
20226 slightly slower code than the default, but reduces the amount of RAM required
20227 when executing, and thus may be preferred for some embedded systems.
20229 @item -muninit-const-in-rodata
20230 @itemx -mno-uninit-const-in-rodata
20231 @opindex muninit-const-in-rodata
20232 @opindex mno-uninit-const-in-rodata
20233 Put uninitialized @code{const} variables in the read-only data section.
20234 This option is only meaningful in conjunction with @option{-membedded-data}.
20236 @item -mcode-readable=@var{setting}
20237 @opindex mcode-readable
20238 Specify whether GCC may generate code that reads from executable sections.
20239 There are three possible settings:
20241 @table @gcctabopt
20242 @item -mcode-readable=yes
20243 Instructions may freely access executable sections.  This is the
20244 default setting.
20246 @item -mcode-readable=pcrel
20247 MIPS16 PC-relative load instructions can access executable sections,
20248 but other instructions must not do so.  This option is useful on 4KSc
20249 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20250 It is also useful on processors that can be configured to have a dual
20251 instruction/data SRAM interface and that, like the M4K, automatically
20252 redirect PC-relative loads to the instruction RAM.
20254 @item -mcode-readable=no
20255 Instructions must not access executable sections.  This option can be
20256 useful on targets that are configured to have a dual instruction/data
20257 SRAM interface but that (unlike the M4K) do not automatically redirect
20258 PC-relative loads to the instruction RAM.
20259 @end table
20261 @item -msplit-addresses
20262 @itemx -mno-split-addresses
20263 @opindex msplit-addresses
20264 @opindex mno-split-addresses
20265 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20266 relocation operators.  This option has been superseded by
20267 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20269 @item -mexplicit-relocs
20270 @itemx -mno-explicit-relocs
20271 @opindex mexplicit-relocs
20272 @opindex mno-explicit-relocs
20273 Use (do not use) assembler relocation operators when dealing with symbolic
20274 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20275 is to use assembler macros instead.
20277 @option{-mexplicit-relocs} is the default if GCC was configured
20278 to use an assembler that supports relocation operators.
20280 @item -mcheck-zero-division
20281 @itemx -mno-check-zero-division
20282 @opindex mcheck-zero-division
20283 @opindex mno-check-zero-division
20284 Trap (do not trap) on integer division by zero.
20286 The default is @option{-mcheck-zero-division}.
20288 @item -mdivide-traps
20289 @itemx -mdivide-breaks
20290 @opindex mdivide-traps
20291 @opindex mdivide-breaks
20292 MIPS systems check for division by zero by generating either a
20293 conditional trap or a break instruction.  Using traps results in
20294 smaller code, but is only supported on MIPS II and later.  Also, some
20295 versions of the Linux kernel have a bug that prevents trap from
20296 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20297 allow conditional traps on architectures that support them and
20298 @option{-mdivide-breaks} to force the use of breaks.
20300 The default is usually @option{-mdivide-traps}, but this can be
20301 overridden at configure time using @option{--with-divide=breaks}.
20302 Divide-by-zero checks can be completely disabled using
20303 @option{-mno-check-zero-division}.
20305 @item -mload-store-pairs
20306 @itemx -mno-load-store-pairs
20307 @opindex mload-store-pairs
20308 @opindex mno-load-store-pairs
20309 Enable (disable) an optimization that pairs consecutive load or store
20310 instructions to enable load/store bonding.  This option is enabled by
20311 default but only takes effect when the selected architecture is known
20312 to support bonding.
20314 @item -mmemcpy
20315 @itemx -mno-memcpy
20316 @opindex mmemcpy
20317 @opindex mno-memcpy
20318 Force (do not force) the use of @code{memcpy} for non-trivial block
20319 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20320 most constant-sized copies.
20322 @item -mlong-calls
20323 @itemx -mno-long-calls
20324 @opindex mlong-calls
20325 @opindex mno-long-calls
20326 Disable (do not disable) use of the @code{jal} instruction.  Calling
20327 functions using @code{jal} is more efficient but requires the caller
20328 and callee to be in the same 256 megabyte segment.
20330 This option has no effect on abicalls code.  The default is
20331 @option{-mno-long-calls}.
20333 @item -mmad
20334 @itemx -mno-mad
20335 @opindex mmad
20336 @opindex mno-mad
20337 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20338 instructions, as provided by the R4650 ISA@.
20340 @item -mimadd
20341 @itemx -mno-imadd
20342 @opindex mimadd
20343 @opindex mno-imadd
20344 Enable (disable) use of the @code{madd} and @code{msub} integer
20345 instructions.  The default is @option{-mimadd} on architectures
20346 that support @code{madd} and @code{msub} except for the 74k 
20347 architecture where it was found to generate slower code.
20349 @item -mfused-madd
20350 @itemx -mno-fused-madd
20351 @opindex mfused-madd
20352 @opindex mno-fused-madd
20353 Enable (disable) use of the floating-point multiply-accumulate
20354 instructions, when they are available.  The default is
20355 @option{-mfused-madd}.
20357 On the R8000 CPU when multiply-accumulate instructions are used,
20358 the intermediate product is calculated to infinite precision
20359 and is not subject to the FCSR Flush to Zero bit.  This may be
20360 undesirable in some circumstances.  On other processors the result
20361 is numerically identical to the equivalent computation using
20362 separate multiply, add, subtract and negate instructions.
20364 @item -nocpp
20365 @opindex nocpp
20366 Tell the MIPS assembler to not run its preprocessor over user
20367 assembler files (with a @samp{.s} suffix) when assembling them.
20369 @item -mfix-24k
20370 @item -mno-fix-24k
20371 @opindex mfix-24k
20372 @opindex mno-fix-24k
20373 Work around the 24K E48 (lost data on stores during refill) errata.
20374 The workarounds are implemented by the assembler rather than by GCC@.
20376 @item -mfix-r4000
20377 @itemx -mno-fix-r4000
20378 @opindex mfix-r4000
20379 @opindex mno-fix-r4000
20380 Work around certain R4000 CPU errata:
20381 @itemize @minus
20382 @item
20383 A double-word or a variable shift may give an incorrect result if executed
20384 immediately after starting an integer division.
20385 @item
20386 A double-word or a variable shift may give an incorrect result if executed
20387 while an integer multiplication is in progress.
20388 @item
20389 An integer division may give an incorrect result if started in a delay slot
20390 of a taken branch or a jump.
20391 @end itemize
20393 @item -mfix-r4400
20394 @itemx -mno-fix-r4400
20395 @opindex mfix-r4400
20396 @opindex mno-fix-r4400
20397 Work around certain R4400 CPU errata:
20398 @itemize @minus
20399 @item
20400 A double-word or a variable shift may give an incorrect result if executed
20401 immediately after starting an integer division.
20402 @end itemize
20404 @item -mfix-r10000
20405 @itemx -mno-fix-r10000
20406 @opindex mfix-r10000
20407 @opindex mno-fix-r10000
20408 Work around certain R10000 errata:
20409 @itemize @minus
20410 @item
20411 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20412 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20413 @end itemize
20415 This option can only be used if the target architecture supports
20416 branch-likely instructions.  @option{-mfix-r10000} is the default when
20417 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20418 otherwise.
20420 @item -mfix-rm7000
20421 @itemx -mno-fix-rm7000
20422 @opindex mfix-rm7000
20423 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20424 workarounds are implemented by the assembler rather than by GCC@.
20426 @item -mfix-vr4120
20427 @itemx -mno-fix-vr4120
20428 @opindex mfix-vr4120
20429 Work around certain VR4120 errata:
20430 @itemize @minus
20431 @item
20432 @code{dmultu} does not always produce the correct result.
20433 @item
20434 @code{div} and @code{ddiv} do not always produce the correct result if one
20435 of the operands is negative.
20436 @end itemize
20437 The workarounds for the division errata rely on special functions in
20438 @file{libgcc.a}.  At present, these functions are only provided by
20439 the @code{mips64vr*-elf} configurations.
20441 Other VR4120 errata require a NOP to be inserted between certain pairs of
20442 instructions.  These errata are handled by the assembler, not by GCC itself.
20444 @item -mfix-vr4130
20445 @opindex mfix-vr4130
20446 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20447 workarounds are implemented by the assembler rather than by GCC,
20448 although GCC avoids using @code{mflo} and @code{mfhi} if the
20449 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20450 instructions are available instead.
20452 @item -mfix-sb1
20453 @itemx -mno-fix-sb1
20454 @opindex mfix-sb1
20455 Work around certain SB-1 CPU core errata.
20456 (This flag currently works around the SB-1 revision 2
20457 ``F1'' and ``F2'' floating-point errata.)
20459 @item -mr10k-cache-barrier=@var{setting}
20460 @opindex mr10k-cache-barrier
20461 Specify whether GCC should insert cache barriers to avoid the
20462 side-effects of speculation on R10K processors.
20464 In common with many processors, the R10K tries to predict the outcome
20465 of a conditional branch and speculatively executes instructions from
20466 the ``taken'' branch.  It later aborts these instructions if the
20467 predicted outcome is wrong.  However, on the R10K, even aborted
20468 instructions can have side effects.
20470 This problem only affects kernel stores and, depending on the system,
20471 kernel loads.  As an example, a speculatively-executed store may load
20472 the target memory into cache and mark the cache line as dirty, even if
20473 the store itself is later aborted.  If a DMA operation writes to the
20474 same area of memory before the ``dirty'' line is flushed, the cached
20475 data overwrites the DMA-ed data.  See the R10K processor manual
20476 for a full description, including other potential problems.
20478 One workaround is to insert cache barrier instructions before every memory
20479 access that might be speculatively executed and that might have side
20480 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20481 controls GCC's implementation of this workaround.  It assumes that
20482 aborted accesses to any byte in the following regions does not have
20483 side effects:
20485 @enumerate
20486 @item
20487 the memory occupied by the current function's stack frame;
20489 @item
20490 the memory occupied by an incoming stack argument;
20492 @item
20493 the memory occupied by an object with a link-time-constant address.
20494 @end enumerate
20496 It is the kernel's responsibility to ensure that speculative
20497 accesses to these regions are indeed safe.
20499 If the input program contains a function declaration such as:
20501 @smallexample
20502 void foo (void);
20503 @end smallexample
20505 then the implementation of @code{foo} must allow @code{j foo} and
20506 @code{jal foo} to be executed speculatively.  GCC honors this
20507 restriction for functions it compiles itself.  It expects non-GCC
20508 functions (such as hand-written assembly code) to do the same.
20510 The option has three forms:
20512 @table @gcctabopt
20513 @item -mr10k-cache-barrier=load-store
20514 Insert a cache barrier before a load or store that might be
20515 speculatively executed and that might have side effects even
20516 if aborted.
20518 @item -mr10k-cache-barrier=store
20519 Insert a cache barrier before a store that might be speculatively
20520 executed and that might have side effects even if aborted.
20522 @item -mr10k-cache-barrier=none
20523 Disable the insertion of cache barriers.  This is the default setting.
20524 @end table
20526 @item -mflush-func=@var{func}
20527 @itemx -mno-flush-func
20528 @opindex mflush-func
20529 Specifies the function to call to flush the I and D caches, or to not
20530 call any such function.  If called, the function must take the same
20531 arguments as the common @code{_flush_func}, that is, the address of the
20532 memory range for which the cache is being flushed, the size of the
20533 memory range, and the number 3 (to flush both caches).  The default
20534 depends on the target GCC was configured for, but commonly is either
20535 @code{_flush_func} or @code{__cpu_flush}.
20537 @item mbranch-cost=@var{num}
20538 @opindex mbranch-cost
20539 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20540 This cost is only a heuristic and is not guaranteed to produce
20541 consistent results across releases.  A zero cost redundantly selects
20542 the default, which is based on the @option{-mtune} setting.
20544 @item -mbranch-likely
20545 @itemx -mno-branch-likely
20546 @opindex mbranch-likely
20547 @opindex mno-branch-likely
20548 Enable or disable use of Branch Likely instructions, regardless of the
20549 default for the selected architecture.  By default, Branch Likely
20550 instructions may be generated if they are supported by the selected
20551 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20552 and processors that implement those architectures; for those, Branch
20553 Likely instructions are not be generated by default because the MIPS32
20554 and MIPS64 architectures specifically deprecate their use.
20556 @item -mcompact-branches=never
20557 @itemx -mcompact-branches=optimal
20558 @itemx -mcompact-branches=always
20559 @opindex mcompact-branches=never
20560 @opindex mcompact-branches=optimal
20561 @opindex mcompact-branches=always
20562 These options control which form of branches will be generated.  The
20563 default is @option{-mcompact-branches=optimal}.
20565 The @option{-mcompact-branches=never} option ensures that compact branch
20566 instructions will never be generated.
20568 The @option{-mcompact-branches=always} option ensures that a compact
20569 branch instruction will be generated if available.  If a compact branch
20570 instruction is not available, a delay slot form of the branch will be
20571 used instead.
20573 This option is supported from MIPS Release 6 onwards.
20575 The @option{-mcompact-branches=optimal} option will cause a delay slot
20576 branch to be used if one is available in the current ISA and the delay
20577 slot is successfully filled.  If the delay slot is not filled, a compact
20578 branch will be chosen if one is available.
20580 @item -mfp-exceptions
20581 @itemx -mno-fp-exceptions
20582 @opindex mfp-exceptions
20583 Specifies whether FP exceptions are enabled.  This affects how
20584 FP instructions are scheduled for some processors.
20585 The default is that FP exceptions are
20586 enabled.
20588 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20589 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20590 FP pipe.
20592 @item -mvr4130-align
20593 @itemx -mno-vr4130-align
20594 @opindex mvr4130-align
20595 The VR4130 pipeline is two-way superscalar, but can only issue two
20596 instructions together if the first one is 8-byte aligned.  When this
20597 option is enabled, GCC aligns pairs of instructions that it
20598 thinks should execute in parallel.
20600 This option only has an effect when optimizing for the VR4130.
20601 It normally makes code faster, but at the expense of making it bigger.
20602 It is enabled by default at optimization level @option{-O3}.
20604 @item -msynci
20605 @itemx -mno-synci
20606 @opindex msynci
20607 Enable (disable) generation of @code{synci} instructions on
20608 architectures that support it.  The @code{synci} instructions (if
20609 enabled) are generated when @code{__builtin___clear_cache} is
20610 compiled.
20612 This option defaults to @option{-mno-synci}, but the default can be
20613 overridden by configuring GCC with @option{--with-synci}.
20615 When compiling code for single processor systems, it is generally safe
20616 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20617 does not invalidate the instruction caches on all cores and may lead
20618 to undefined behavior.
20620 @item -mrelax-pic-calls
20621 @itemx -mno-relax-pic-calls
20622 @opindex mrelax-pic-calls
20623 Try to turn PIC calls that are normally dispatched via register
20624 @code{$25} into direct calls.  This is only possible if the linker can
20625 resolve the destination at link time and if the destination is within
20626 range for a direct call.
20628 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20629 an assembler and a linker that support the @code{.reloc} assembly
20630 directive and @option{-mexplicit-relocs} is in effect.  With
20631 @option{-mno-explicit-relocs}, this optimization can be performed by the
20632 assembler and the linker alone without help from the compiler.
20634 @item -mmcount-ra-address
20635 @itemx -mno-mcount-ra-address
20636 @opindex mmcount-ra-address
20637 @opindex mno-mcount-ra-address
20638 Emit (do not emit) code that allows @code{_mcount} to modify the
20639 calling function's return address.  When enabled, this option extends
20640 the usual @code{_mcount} interface with a new @var{ra-address}
20641 parameter, which has type @code{intptr_t *} and is passed in register
20642 @code{$12}.  @code{_mcount} can then modify the return address by
20643 doing both of the following:
20644 @itemize
20645 @item
20646 Returning the new address in register @code{$31}.
20647 @item
20648 Storing the new address in @code{*@var{ra-address}},
20649 if @var{ra-address} is nonnull.
20650 @end itemize
20652 The default is @option{-mno-mcount-ra-address}.
20654 @item -mframe-header-opt
20655 @itemx -mno-frame-header-opt
20656 @opindex mframe-header-opt
20657 Enable (disable) frame header optimization in the o32 ABI.  When using the
20658 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20659 function to write out register arguments.  When enabled, this optimization
20660 will suppress the allocation of the frame header if it can be determined that
20661 it is unused.
20663 This optimization is off by default at all optimization levels.
20665 @item -mlxc1-sxc1
20666 @itemx -mno-lxc1-sxc1
20667 @opindex mlxc1-sxc1
20668 When applicable, enable (disable) the generation of @code{lwxc1},
20669 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20671 @item -mmadd4
20672 @itemx -mno-madd4
20673 @opindex mmadd4
20674 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20675 @code{madd.d} and related instructions.  Enabled by default.
20677 @end table
20679 @node MMIX Options
20680 @subsection MMIX Options
20681 @cindex MMIX Options
20683 These options are defined for the MMIX:
20685 @table @gcctabopt
20686 @item -mlibfuncs
20687 @itemx -mno-libfuncs
20688 @opindex mlibfuncs
20689 @opindex mno-libfuncs
20690 Specify that intrinsic library functions are being compiled, passing all
20691 values in registers, no matter the size.
20693 @item -mepsilon
20694 @itemx -mno-epsilon
20695 @opindex mepsilon
20696 @opindex mno-epsilon
20697 Generate floating-point comparison instructions that compare with respect
20698 to the @code{rE} epsilon register.
20700 @item -mabi=mmixware
20701 @itemx -mabi=gnu
20702 @opindex mabi=mmixware
20703 @opindex mabi=gnu
20704 Generate code that passes function parameters and return values that (in
20705 the called function) are seen as registers @code{$0} and up, as opposed to
20706 the GNU ABI which uses global registers @code{$231} and up.
20708 @item -mzero-extend
20709 @itemx -mno-zero-extend
20710 @opindex mzero-extend
20711 @opindex mno-zero-extend
20712 When reading data from memory in sizes shorter than 64 bits, use (do not
20713 use) zero-extending load instructions by default, rather than
20714 sign-extending ones.
20716 @item -mknuthdiv
20717 @itemx -mno-knuthdiv
20718 @opindex mknuthdiv
20719 @opindex mno-knuthdiv
20720 Make the result of a division yielding a remainder have the same sign as
20721 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20722 remainder follows the sign of the dividend.  Both methods are
20723 arithmetically valid, the latter being almost exclusively used.
20725 @item -mtoplevel-symbols
20726 @itemx -mno-toplevel-symbols
20727 @opindex mtoplevel-symbols
20728 @opindex mno-toplevel-symbols
20729 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20730 code can be used with the @code{PREFIX} assembly directive.
20732 @item -melf
20733 @opindex melf
20734 Generate an executable in the ELF format, rather than the default
20735 @samp{mmo} format used by the @command{mmix} simulator.
20737 @item -mbranch-predict
20738 @itemx -mno-branch-predict
20739 @opindex mbranch-predict
20740 @opindex mno-branch-predict
20741 Use (do not use) the probable-branch instructions, when static branch
20742 prediction indicates a probable branch.
20744 @item -mbase-addresses
20745 @itemx -mno-base-addresses
20746 @opindex mbase-addresses
20747 @opindex mno-base-addresses
20748 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20749 base address automatically generates a request (handled by the assembler
20750 and the linker) for a constant to be set up in a global register.  The
20751 register is used for one or more base address requests within the range 0
20752 to 255 from the value held in the register.  The generally leads to short
20753 and fast code, but the number of different data items that can be
20754 addressed is limited.  This means that a program that uses lots of static
20755 data may require @option{-mno-base-addresses}.
20757 @item -msingle-exit
20758 @itemx -mno-single-exit
20759 @opindex msingle-exit
20760 @opindex mno-single-exit
20761 Force (do not force) generated code to have a single exit point in each
20762 function.
20763 @end table
20765 @node MN10300 Options
20766 @subsection MN10300 Options
20767 @cindex MN10300 options
20769 These @option{-m} options are defined for Matsushita MN10300 architectures:
20771 @table @gcctabopt
20772 @item -mmult-bug
20773 @opindex mmult-bug
20774 Generate code to avoid bugs in the multiply instructions for the MN10300
20775 processors.  This is the default.
20777 @item -mno-mult-bug
20778 @opindex mno-mult-bug
20779 Do not generate code to avoid bugs in the multiply instructions for the
20780 MN10300 processors.
20782 @item -mam33
20783 @opindex mam33
20784 Generate code using features specific to the AM33 processor.
20786 @item -mno-am33
20787 @opindex mno-am33
20788 Do not generate code using features specific to the AM33 processor.  This
20789 is the default.
20791 @item -mam33-2
20792 @opindex mam33-2
20793 Generate code using features specific to the AM33/2.0 processor.
20795 @item -mam34
20796 @opindex mam34
20797 Generate code using features specific to the AM34 processor.
20799 @item -mtune=@var{cpu-type}
20800 @opindex mtune
20801 Use the timing characteristics of the indicated CPU type when
20802 scheduling instructions.  This does not change the targeted processor
20803 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20804 @samp{am33-2} or @samp{am34}.
20806 @item -mreturn-pointer-on-d0
20807 @opindex mreturn-pointer-on-d0
20808 When generating a function that returns a pointer, return the pointer
20809 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20810 only in @code{a0}, and attempts to call such functions without a prototype
20811 result in errors.  Note that this option is on by default; use
20812 @option{-mno-return-pointer-on-d0} to disable it.
20814 @item -mno-crt0
20815 @opindex mno-crt0
20816 Do not link in the C run-time initialization object file.
20818 @item -mrelax
20819 @opindex mrelax
20820 Indicate to the linker that it should perform a relaxation optimization pass
20821 to shorten branches, calls and absolute memory addresses.  This option only
20822 has an effect when used on the command line for the final link step.
20824 This option makes symbolic debugging impossible.
20826 @item -mliw
20827 @opindex mliw
20828 Allow the compiler to generate @emph{Long Instruction Word}
20829 instructions if the target is the @samp{AM33} or later.  This is the
20830 default.  This option defines the preprocessor macro @code{__LIW__}.
20832 @item -mnoliw
20833 @opindex mnoliw
20834 Do not allow the compiler to generate @emph{Long Instruction Word}
20835 instructions.  This option defines the preprocessor macro
20836 @code{__NO_LIW__}.
20838 @item -msetlb
20839 @opindex msetlb
20840 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20841 instructions if the target is the @samp{AM33} or later.  This is the
20842 default.  This option defines the preprocessor macro @code{__SETLB__}.
20844 @item -mnosetlb
20845 @opindex mnosetlb
20846 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20847 instructions.  This option defines the preprocessor macro
20848 @code{__NO_SETLB__}.
20850 @end table
20852 @node Moxie Options
20853 @subsection Moxie Options
20854 @cindex Moxie Options
20856 @table @gcctabopt
20858 @item -meb
20859 @opindex meb
20860 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20861 configurations.
20863 @item -mel
20864 @opindex mel
20865 Generate little-endian code.
20867 @item -mmul.x
20868 @opindex mmul.x
20869 Generate mul.x and umul.x instructions.  This is the default for
20870 @samp{moxiebox-*-*} configurations.
20872 @item -mno-crt0
20873 @opindex mno-crt0
20874 Do not link in the C run-time initialization object file.
20876 @end table
20878 @node MSP430 Options
20879 @subsection MSP430 Options
20880 @cindex MSP430 Options
20882 These options are defined for the MSP430:
20884 @table @gcctabopt
20886 @item -masm-hex
20887 @opindex masm-hex
20888 Force assembly output to always use hex constants.  Normally such
20889 constants are signed decimals, but this option is available for
20890 testsuite and/or aesthetic purposes.
20892 @item -mmcu=
20893 @opindex mmcu=
20894 Select the MCU to target.  This is used to create a C preprocessor
20895 symbol based upon the MCU name, converted to upper case and pre- and
20896 post-fixed with @samp{__}.  This in turn is used by the
20897 @file{msp430.h} header file to select an MCU-specific supplementary
20898 header file.
20900 The option also sets the ISA to use.  If the MCU name is one that is
20901 known to only support the 430 ISA then that is selected, otherwise the
20902 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20903 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20904 name selects the 430X ISA.
20906 In addition an MCU-specific linker script is added to the linker
20907 command line.  The script's name is the name of the MCU with
20908 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20909 command line defines the C preprocessor symbol @code{__XXX__} and
20910 cause the linker to search for a script called @file{xxx.ld}.
20912 This option is also passed on to the assembler.
20914 @item -mwarn-mcu
20915 @itemx -mno-warn-mcu
20916 @opindex mwarn-mcu
20917 @opindex mno-warn-mcu
20918 This option enables or disables warnings about conflicts between the
20919 MCU name specified by the @option{-mmcu} option and the ISA set by the
20920 @option{-mcpu} option and/or the hardware multiply support set by the
20921 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20922 MCU names.  This option is on by default.
20924 @item -mcpu=
20925 @opindex mcpu=
20926 Specifies the ISA to use.  Accepted values are @samp{msp430},
20927 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20928 @option{-mmcu=} option should be used to select the ISA.
20930 @item -msim
20931 @opindex msim
20932 Link to the simulator runtime libraries and linker script.  Overrides
20933 any scripts that would be selected by the @option{-mmcu=} option.
20935 @item -mlarge
20936 @opindex mlarge
20937 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20939 @item -msmall
20940 @opindex msmall
20941 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20943 @item -mrelax
20944 @opindex mrelax
20945 This option is passed to the assembler and linker, and allows the
20946 linker to perform certain optimizations that cannot be done until
20947 the final link.
20949 @item mhwmult=
20950 @opindex mhwmult=
20951 Describes the type of hardware multiply supported by the target.
20952 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20953 for the original 16-bit-only multiply supported by early MCUs.
20954 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20955 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20956 A value of @samp{auto} can also be given.  This tells GCC to deduce
20957 the hardware multiply support based upon the MCU name provided by the
20958 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20959 the MCU name is not recognized then no hardware multiply support is
20960 assumed.  @code{auto} is the default setting.
20962 Hardware multiplies are normally performed by calling a library
20963 routine.  This saves space in the generated code.  When compiling at
20964 @option{-O3} or higher however the hardware multiplier is invoked
20965 inline.  This makes for bigger, but faster code.
20967 The hardware multiply routines disable interrupts whilst running and
20968 restore the previous interrupt state when they finish.  This makes
20969 them safe to use inside interrupt handlers as well as in normal code.
20971 @item -minrt
20972 @opindex minrt
20973 Enable the use of a minimum runtime environment - no static
20974 initializers or constructors.  This is intended for memory-constrained
20975 devices.  The compiler includes special symbols in some objects
20976 that tell the linker and runtime which code fragments are required.
20978 @item -mcode-region=
20979 @itemx -mdata-region=
20980 @opindex mcode-region
20981 @opindex mdata-region
20982 These options tell the compiler where to place functions and data that
20983 do not have one of the @code{lower}, @code{upper}, @code{either} or
20984 @code{section} attributes.  Possible values are @code{lower},
20985 @code{upper}, @code{either} or @code{any}.  The first three behave
20986 like the corresponding attribute.  The fourth possible value -
20987 @code{any} - is the default.  It leaves placement entirely up to the
20988 linker script and how it assigns the standard sections
20989 (@code{.text}, @code{.data}, etc) to the memory regions.
20991 @item -msilicon-errata=
20992 @opindex msilicon-errata
20993 This option passes on a request to assembler to enable the fixes for
20994 the named silicon errata.
20996 @item -msilicon-errata-warn=
20997 @opindex msilicon-errata-warn
20998 This option passes on a request to the assembler to enable warning
20999 messages when a silicon errata might need to be applied.
21001 @end table
21003 @node NDS32 Options
21004 @subsection NDS32 Options
21005 @cindex NDS32 Options
21007 These options are defined for NDS32 implementations:
21009 @table @gcctabopt
21011 @item -mbig-endian
21012 @opindex mbig-endian
21013 Generate code in big-endian mode.
21015 @item -mlittle-endian
21016 @opindex mlittle-endian
21017 Generate code in little-endian mode.
21019 @item -mreduced-regs
21020 @opindex mreduced-regs
21021 Use reduced-set registers for register allocation.
21023 @item -mfull-regs
21024 @opindex mfull-regs
21025 Use full-set registers for register allocation.
21027 @item -mcmov
21028 @opindex mcmov
21029 Generate conditional move instructions.
21031 @item -mno-cmov
21032 @opindex mno-cmov
21033 Do not generate conditional move instructions.
21035 @item -mperf-ext
21036 @opindex mperf-ext
21037 Generate performance extension instructions.
21039 @item -mno-perf-ext
21040 @opindex mno-perf-ext
21041 Do not generate performance extension instructions.
21043 @item -mv3push
21044 @opindex mv3push
21045 Generate v3 push25/pop25 instructions.
21047 @item -mno-v3push
21048 @opindex mno-v3push
21049 Do not generate v3 push25/pop25 instructions.
21051 @item -m16-bit
21052 @opindex m16-bit
21053 Generate 16-bit instructions.
21055 @item -mno-16-bit
21056 @opindex mno-16-bit
21057 Do not generate 16-bit instructions.
21059 @item -misr-vector-size=@var{num}
21060 @opindex misr-vector-size
21061 Specify the size of each interrupt vector, which must be 4 or 16.
21063 @item -mcache-block-size=@var{num}
21064 @opindex mcache-block-size
21065 Specify the size of each cache block,
21066 which must be a power of 2 between 4 and 512.
21068 @item -march=@var{arch}
21069 @opindex march
21070 Specify the name of the target architecture.
21072 @item -mcmodel=@var{code-model}
21073 @opindex mcmodel
21074 Set the code model to one of
21075 @table @asis
21076 @item @samp{small}
21077 All the data and read-only data segments must be within 512KB addressing space.
21078 The text segment must be within 16MB addressing space.
21079 @item @samp{medium}
21080 The data segment must be within 512KB while the read-only data segment can be
21081 within 4GB addressing space.  The text segment should be still within 16MB
21082 addressing space.
21083 @item @samp{large}
21084 All the text and data segments can be within 4GB addressing space.
21085 @end table
21087 @item -mctor-dtor
21088 @opindex mctor-dtor
21089 Enable constructor/destructor feature.
21091 @item -mrelax
21092 @opindex mrelax
21093 Guide linker to relax instructions.
21095 @end table
21097 @node Nios II Options
21098 @subsection Nios II Options
21099 @cindex Nios II options
21100 @cindex Altera Nios II options
21102 These are the options defined for the Altera Nios II processor.
21104 @table @gcctabopt
21106 @item -G @var{num}
21107 @opindex G
21108 @cindex smaller data references
21109 Put global and static objects less than or equal to @var{num} bytes
21110 into the small data or BSS sections instead of the normal data or BSS
21111 sections.  The default value of @var{num} is 8.
21113 @item -mgpopt=@var{option}
21114 @item -mgpopt
21115 @itemx -mno-gpopt
21116 @opindex mgpopt
21117 @opindex mno-gpopt
21118 Generate (do not generate) GP-relative accesses.  The following 
21119 @var{option} names are recognized:
21121 @table @samp
21123 @item none
21124 Do not generate GP-relative accesses.
21126 @item local
21127 Generate GP-relative accesses for small data objects that are not 
21128 external, weak, or uninitialized common symbols.  
21129 Also use GP-relative addressing for objects that
21130 have been explicitly placed in a small data section via a @code{section}
21131 attribute.
21133 @item global
21134 As for @samp{local}, but also generate GP-relative accesses for
21135 small data objects that are external, weak, or common.  If you use this option,
21136 you must ensure that all parts of your program (including libraries) are
21137 compiled with the same @option{-G} setting.
21139 @item data
21140 Generate GP-relative accesses for all data objects in the program.  If you
21141 use this option, the entire data and BSS segments
21142 of your program must fit in 64K of memory and you must use an appropriate
21143 linker script to allocate them within the addressable range of the
21144 global pointer.
21146 @item all
21147 Generate GP-relative addresses for function pointers as well as data
21148 pointers.  If you use this option, the entire text, data, and BSS segments
21149 of your program must fit in 64K of memory and you must use an appropriate
21150 linker script to allocate them within the addressable range of the
21151 global pointer.
21153 @end table
21155 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21156 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21158 The default is @option{-mgpopt} except when @option{-fpic} or
21159 @option{-fPIC} is specified to generate position-independent code.
21160 Note that the Nios II ABI does not permit GP-relative accesses from
21161 shared libraries.
21163 You may need to specify @option{-mno-gpopt} explicitly when building
21164 programs that include large amounts of small data, including large
21165 GOT data sections.  In this case, the 16-bit offset for GP-relative
21166 addressing may not be large enough to allow access to the entire 
21167 small data section.
21169 @item -mel
21170 @itemx -meb
21171 @opindex mel
21172 @opindex meb
21173 Generate little-endian (default) or big-endian (experimental) code,
21174 respectively.
21176 @item -march=@var{arch}
21177 @opindex march
21178 This specifies the name of the target Nios II architecture.  GCC uses this
21179 name to determine what kind of instructions it can emit when generating
21180 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21182 The preprocessor macro @code{__nios2_arch__} is available to programs,
21183 with value 1 or 2, indicating the targeted ISA level.
21185 @item -mbypass-cache
21186 @itemx -mno-bypass-cache
21187 @opindex mno-bypass-cache
21188 @opindex mbypass-cache
21189 Force all load and store instructions to always bypass cache by 
21190 using I/O variants of the instructions. The default is not to
21191 bypass the cache.
21193 @item -mno-cache-volatile 
21194 @itemx -mcache-volatile       
21195 @opindex mcache-volatile 
21196 @opindex mno-cache-volatile
21197 Volatile memory access bypass the cache using the I/O variants of 
21198 the load and store instructions. The default is not to bypass the cache.
21200 @item -mno-fast-sw-div
21201 @itemx -mfast-sw-div
21202 @opindex mno-fast-sw-div
21203 @opindex mfast-sw-div
21204 Do not use table-based fast divide for small numbers. The default 
21205 is to use the fast divide at @option{-O3} and above.
21207 @item -mno-hw-mul
21208 @itemx -mhw-mul
21209 @itemx -mno-hw-mulx
21210 @itemx -mhw-mulx
21211 @itemx -mno-hw-div
21212 @itemx -mhw-div
21213 @opindex mno-hw-mul
21214 @opindex mhw-mul
21215 @opindex mno-hw-mulx
21216 @opindex mhw-mulx
21217 @opindex mno-hw-div
21218 @opindex mhw-div
21219 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21220 instructions by the compiler. The default is to emit @code{mul}
21221 and not emit @code{div} and @code{mulx}.
21223 @item -mbmx
21224 @itemx -mno-bmx
21225 @itemx -mcdx
21226 @itemx -mno-cdx
21227 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21228 CDX (code density) instructions.  Enabling these instructions also
21229 requires @option{-march=r2}.  Since these instructions are optional
21230 extensions to the R2 architecture, the default is not to emit them.
21232 @item -mcustom-@var{insn}=@var{N}
21233 @itemx -mno-custom-@var{insn}
21234 @opindex mcustom-@var{insn}
21235 @opindex mno-custom-@var{insn}
21236 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21237 custom instruction with encoding @var{N} when generating code that uses 
21238 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21239 instruction 253 for single-precision floating-point add operations instead
21240 of the default behavior of using a library call.
21242 The following values of @var{insn} are supported.  Except as otherwise
21243 noted, floating-point operations are expected to be implemented with
21244 normal IEEE 754 semantics and correspond directly to the C operators or the
21245 equivalent GCC built-in functions (@pxref{Other Builtins}).
21247 Single-precision floating point:
21248 @table @asis
21250 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21251 Binary arithmetic operations.
21253 @item @samp{fnegs}
21254 Unary negation.
21256 @item @samp{fabss}
21257 Unary absolute value.
21259 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21260 Comparison operations.
21262 @item @samp{fmins}, @samp{fmaxs}
21263 Floating-point minimum and maximum.  These instructions are only
21264 generated if @option{-ffinite-math-only} is specified.
21266 @item @samp{fsqrts}
21267 Unary square root operation.
21269 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21270 Floating-point trigonometric and exponential functions.  These instructions
21271 are only generated if @option{-funsafe-math-optimizations} is also specified.
21273 @end table
21275 Double-precision floating point:
21276 @table @asis
21278 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21279 Binary arithmetic operations.
21281 @item @samp{fnegd}
21282 Unary negation.
21284 @item @samp{fabsd}
21285 Unary absolute value.
21287 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21288 Comparison operations.
21290 @item @samp{fmind}, @samp{fmaxd}
21291 Double-precision minimum and maximum.  These instructions are only
21292 generated if @option{-ffinite-math-only} is specified.
21294 @item @samp{fsqrtd}
21295 Unary square root operation.
21297 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21298 Double-precision trigonometric and exponential functions.  These instructions
21299 are only generated if @option{-funsafe-math-optimizations} is also specified.
21301 @end table
21303 Conversions:
21304 @table @asis
21305 @item @samp{fextsd}
21306 Conversion from single precision to double precision.
21308 @item @samp{ftruncds}
21309 Conversion from double precision to single precision.
21311 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21312 Conversion from floating point to signed or unsigned integer types, with
21313 truncation towards zero.
21315 @item @samp{round}
21316 Conversion from single-precision floating point to signed integer,
21317 rounding to the nearest integer and ties away from zero.
21318 This corresponds to the @code{__builtin_lroundf} function when
21319 @option{-fno-math-errno} is used.
21321 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21322 Conversion from signed or unsigned integer types to floating-point types.
21324 @end table
21326 In addition, all of the following transfer instructions for internal
21327 registers X and Y must be provided to use any of the double-precision
21328 floating-point instructions.  Custom instructions taking two
21329 double-precision source operands expect the first operand in the
21330 64-bit register X.  The other operand (or only operand of a unary
21331 operation) is given to the custom arithmetic instruction with the
21332 least significant half in source register @var{src1} and the most
21333 significant half in @var{src2}.  A custom instruction that returns a
21334 double-precision result returns the most significant 32 bits in the
21335 destination register and the other half in 32-bit register Y.  
21336 GCC automatically generates the necessary code sequences to write
21337 register X and/or read register Y when double-precision floating-point
21338 instructions are used.
21340 @table @asis
21342 @item @samp{fwrx}
21343 Write @var{src1} into the least significant half of X and @var{src2} into
21344 the most significant half of X.
21346 @item @samp{fwry}
21347 Write @var{src1} into Y.
21349 @item @samp{frdxhi}, @samp{frdxlo}
21350 Read the most or least (respectively) significant half of X and store it in
21351 @var{dest}.
21353 @item @samp{frdy}
21354 Read the value of Y and store it into @var{dest}.
21355 @end table
21357 Note that you can gain more local control over generation of Nios II custom
21358 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21359 and @code{target("no-custom-@var{insn}")} function attributes
21360 (@pxref{Function Attributes})
21361 or pragmas (@pxref{Function Specific Option Pragmas}).
21363 @item -mcustom-fpu-cfg=@var{name}
21364 @opindex mcustom-fpu-cfg
21366 This option enables a predefined, named set of custom instruction encodings
21367 (see @option{-mcustom-@var{insn}} above).  
21368 Currently, the following sets are defined:
21370 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21371 @gccoptlist{-mcustom-fmuls=252 @gol
21372 -mcustom-fadds=253 @gol
21373 -mcustom-fsubs=254 @gol
21374 -fsingle-precision-constant}
21376 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21377 @gccoptlist{-mcustom-fmuls=252 @gol
21378 -mcustom-fadds=253 @gol
21379 -mcustom-fsubs=254 @gol
21380 -mcustom-fdivs=255 @gol
21381 -fsingle-precision-constant}
21383 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21384 @gccoptlist{-mcustom-floatus=243 @gol
21385 -mcustom-fixsi=244 @gol
21386 -mcustom-floatis=245 @gol
21387 -mcustom-fcmpgts=246 @gol
21388 -mcustom-fcmples=249 @gol
21389 -mcustom-fcmpeqs=250 @gol
21390 -mcustom-fcmpnes=251 @gol
21391 -mcustom-fmuls=252 @gol
21392 -mcustom-fadds=253 @gol
21393 -mcustom-fsubs=254 @gol
21394 -mcustom-fdivs=255 @gol
21395 -fsingle-precision-constant}
21397 Custom instruction assignments given by individual
21398 @option{-mcustom-@var{insn}=} options override those given by
21399 @option{-mcustom-fpu-cfg=}, regardless of the
21400 order of the options on the command line.
21402 Note that you can gain more local control over selection of a FPU
21403 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21404 function attribute (@pxref{Function Attributes})
21405 or pragma (@pxref{Function Specific Option Pragmas}).
21407 @end table
21409 These additional @samp{-m} options are available for the Altera Nios II
21410 ELF (bare-metal) target:
21412 @table @gcctabopt
21414 @item -mhal
21415 @opindex mhal
21416 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21417 startup and termination code, and is typically used in conjunction with
21418 @option{-msys-crt0=} to specify the location of the alternate startup code
21419 provided by the HAL BSP.
21421 @item -msmallc
21422 @opindex msmallc
21423 Link with a limited version of the C library, @option{-lsmallc}, rather than
21424 Newlib.
21426 @item -msys-crt0=@var{startfile}
21427 @opindex msys-crt0
21428 @var{startfile} is the file name of the startfile (crt0) to use 
21429 when linking.  This option is only useful in conjunction with @option{-mhal}.
21431 @item -msys-lib=@var{systemlib}
21432 @opindex msys-lib
21433 @var{systemlib} is the library name of the library that provides
21434 low-level system calls required by the C library,
21435 e.g. @code{read} and @code{write}.
21436 This option is typically used to link with a library provided by a HAL BSP.
21438 @end table
21440 @node Nvidia PTX Options
21441 @subsection Nvidia PTX Options
21442 @cindex Nvidia PTX options
21443 @cindex nvptx options
21445 These options are defined for Nvidia PTX:
21447 @table @gcctabopt
21449 @item -m32
21450 @itemx -m64
21451 @opindex m32
21452 @opindex m64
21453 Generate code for 32-bit or 64-bit ABI.
21455 @item -mmainkernel
21456 @opindex mmainkernel
21457 Link in code for a __main kernel.  This is for stand-alone instead of
21458 offloading execution.
21460 @item -moptimize
21461 @opindex moptimize
21462 Apply partitioned execution optimizations.  This is the default when any
21463 level of optimization is selected.
21465 @item -msoft-stack
21466 @opindex msoft-stack
21467 Generate code that does not use @code{.local} memory
21468 directly for stack storage. Instead, a per-warp stack pointer is
21469 maintained explicitly. This enables variable-length stack allocation (with
21470 variable-length arrays or @code{alloca}), and when global memory is used for
21471 underlying storage, makes it possible to access automatic variables from other
21472 threads, or with atomic instructions. This code generation variant is used
21473 for OpenMP offloading, but the option is exposed on its own for the purpose
21474 of testing the compiler; to generate code suitable for linking into programs
21475 using OpenMP offloading, use option @option{-mgomp}.
21477 @item -muniform-simt
21478 @opindex muniform-simt
21479 Switch to code generation variant that allows to execute all threads in each
21480 warp, while maintaining memory state and side effects as if only one thread
21481 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21482 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21483 current lane index equals the master lane index), and the register being
21484 assigned is copied via a shuffle instruction from the master lane.  Outside of
21485 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21486 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21487 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21488 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21489 with current lane index to compute the master lane index.
21491 @item -mgomp
21492 @opindex mgomp
21493 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21494 @option{-muniform-simt} options, and selects corresponding multilib variant.
21496 @end table
21498 @node PDP-11 Options
21499 @subsection PDP-11 Options
21500 @cindex PDP-11 Options
21502 These options are defined for the PDP-11:
21504 @table @gcctabopt
21505 @item -mfpu
21506 @opindex mfpu
21507 Use hardware FPP floating point.  This is the default.  (FIS floating
21508 point on the PDP-11/40 is not supported.)
21510 @item -msoft-float
21511 @opindex msoft-float
21512 Do not use hardware floating point.
21514 @item -mac0
21515 @opindex mac0
21516 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21518 @item -mno-ac0
21519 @opindex mno-ac0
21520 Return floating-point results in memory.  This is the default.
21522 @item -m40
21523 @opindex m40
21524 Generate code for a PDP-11/40.
21526 @item -m45
21527 @opindex m45
21528 Generate code for a PDP-11/45.  This is the default.
21530 @item -m10
21531 @opindex m10
21532 Generate code for a PDP-11/10.
21534 @item -mbcopy-builtin
21535 @opindex mbcopy-builtin
21536 Use inline @code{movmemhi} patterns for copying memory.  This is the
21537 default.
21539 @item -mbcopy
21540 @opindex mbcopy
21541 Do not use inline @code{movmemhi} patterns for copying memory.
21543 @item -mint16
21544 @itemx -mno-int32
21545 @opindex mint16
21546 @opindex mno-int32
21547 Use 16-bit @code{int}.  This is the default.
21549 @item -mint32
21550 @itemx -mno-int16
21551 @opindex mint32
21552 @opindex mno-int16
21553 Use 32-bit @code{int}.
21555 @item -mfloat64
21556 @itemx -mno-float32
21557 @opindex mfloat64
21558 @opindex mno-float32
21559 Use 64-bit @code{float}.  This is the default.
21561 @item -mfloat32
21562 @itemx -mno-float64
21563 @opindex mfloat32
21564 @opindex mno-float64
21565 Use 32-bit @code{float}.
21567 @item -mabshi
21568 @opindex mabshi
21569 Use @code{abshi2} pattern.  This is the default.
21571 @item -mno-abshi
21572 @opindex mno-abshi
21573 Do not use @code{abshi2} pattern.
21575 @item -mbranch-expensive
21576 @opindex mbranch-expensive
21577 Pretend that branches are expensive.  This is for experimenting with
21578 code generation only.
21580 @item -mbranch-cheap
21581 @opindex mbranch-cheap
21582 Do not pretend that branches are expensive.  This is the default.
21584 @item -munix-asm
21585 @opindex munix-asm
21586 Use Unix assembler syntax.  This is the default when configured for
21587 @samp{pdp11-*-bsd}.
21589 @item -mdec-asm
21590 @opindex mdec-asm
21591 Use DEC assembler syntax.  This is the default when configured for any
21592 PDP-11 target other than @samp{pdp11-*-bsd}.
21593 @end table
21595 @node picoChip Options
21596 @subsection picoChip Options
21597 @cindex picoChip options
21599 These @samp{-m} options are defined for picoChip implementations:
21601 @table @gcctabopt
21603 @item -mae=@var{ae_type}
21604 @opindex mcpu
21605 Set the instruction set, register set, and instruction scheduling
21606 parameters for array element type @var{ae_type}.  Supported values
21607 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21609 @option{-mae=ANY} selects a completely generic AE type.  Code
21610 generated with this option runs on any of the other AE types.  The
21611 code is not as efficient as it would be if compiled for a specific
21612 AE type, and some types of operation (e.g., multiplication) do not
21613 work properly on all types of AE.
21615 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21616 for compiled code, and is the default.
21618 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21619 option may suffer from poor performance of byte (char) manipulation,
21620 since the DSP AE does not provide hardware support for byte load/stores.
21622 @item -msymbol-as-address
21623 Enable the compiler to directly use a symbol name as an address in a
21624 load/store instruction, without first loading it into a
21625 register.  Typically, the use of this option generates larger
21626 programs, which run faster than when the option isn't used.  However, the
21627 results vary from program to program, so it is left as a user option,
21628 rather than being permanently enabled.
21630 @item -mno-inefficient-warnings
21631 Disables warnings about the generation of inefficient code.  These
21632 warnings can be generated, for example, when compiling code that
21633 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21634 no hardware support for byte-level memory operations, so all byte
21635 load/stores must be synthesized from word load/store operations.  This is
21636 inefficient and a warning is generated to indicate
21637 that you should rewrite the code to avoid byte operations, or to target
21638 an AE type that has the necessary hardware support.  This option disables
21639 these warnings.
21641 @end table
21643 @node PowerPC Options
21644 @subsection PowerPC Options
21645 @cindex PowerPC options
21647 These are listed under @xref{RS/6000 and PowerPC Options}.
21649 @node RISC-V Options
21650 @subsection RISC-V Options
21651 @cindex RISC-V Options
21653 These command-line options are defined for RISC-V targets:
21655 @table @gcctabopt
21656 @item -mbranch-cost=@var{n}
21657 @opindex mbranch-cost
21658 Set the cost of branches to roughly @var{n} instructions.
21660 @item -mmemcpy
21661 @itemx -mno-memcpy
21662 @opindex mmemcpy
21663 Don't optimize block moves.
21665 @item -mplt
21666 @itemx -mno-plt
21667 @opindex plt
21668 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21670 @item -mabi=@var{ABI-string}
21671 @opindex mabi
21672 Specify integer and floating-point calling convention.  This defaults to the
21673 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21674 RV64G.
21676 @item -mfdiv
21677 @itemx -mno-fdiv
21678 @opindex mfdiv
21679 Use hardware floating-point divide and square root instructions.  This requires
21680 the F or D extensions for floating-point registers.
21682 @item -mdiv
21683 @itemx -mno-div
21684 @opindex mdiv
21685 Use hardware instructions for integer division.  This requires the M extension.
21687 @item -march=@var{ISA-string}
21688 @opindex march
21689 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21690 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21692 @item -mtune=@var{processor-string}
21693 @opindex mtune
21694 Optimize the output for the given processor, specified by microarchitecture
21695 name.
21697 @item -msmall-data-limit=@var{n}
21698 @opindex msmall-data-limit
21699 Put global and static data smaller than @var{n} bytes into a special section
21700 (on some targets).
21702 @item -msave-restore
21703 @itemx -mno-save-restore
21704 @opindex msave-restore
21705 Use smaller but slower prologue and epilogue code.
21707 @item -mstrict-align
21708 @itemx -mno-strict-align
21709 @opindex mstrict-align
21710 Do not generate unaligned memory accesses.
21712 @item -mcmodel=@var{code-model}
21713 @opindex mcmodel
21714 Specify the code model.
21716 @end table
21718 @node RL78 Options
21719 @subsection RL78 Options
21720 @cindex RL78 Options
21722 @table @gcctabopt
21724 @item -msim
21725 @opindex msim
21726 Links in additional target libraries to support operation within a
21727 simulator.
21729 @item -mmul=none
21730 @itemx -mmul=g10
21731 @itemx -mmul=g13
21732 @itemx -mmul=g14
21733 @itemx -mmul=rl78
21734 @opindex mmul
21735 Specifies the type of hardware multiplication and division support to
21736 be used.  The simplest is @code{none}, which uses software for both
21737 multiplication and division.  This is the default.  The @code{g13}
21738 value is for the hardware multiply/divide peripheral found on the
21739 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21740 the multiplication and division instructions supported by the RL78/G14
21741 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21742 the value @code{mg10} is an alias for @code{none}.
21744 In addition a C preprocessor macro is defined, based upon the setting
21745 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21746 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21748 @item -mcpu=g10
21749 @itemx -mcpu=g13
21750 @itemx -mcpu=g14
21751 @itemx -mcpu=rl78
21752 @opindex mcpu
21753 Specifies the RL78 core to target.  The default is the G14 core, also
21754 known as an S3 core or just RL78.  The G13 or S2 core does not have
21755 multiply or divide instructions, instead it uses a hardware peripheral
21756 for these operations.  The G10 or S1 core does not have register
21757 banks, so it uses a different calling convention.
21759 If this option is set it also selects the type of hardware multiply
21760 support to use, unless this is overridden by an explicit
21761 @option{-mmul=none} option on the command line.  Thus specifying
21762 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21763 peripheral and specifying @option{-mcpu=g10} disables the use of
21764 hardware multiplications altogether.
21766 Note, although the RL78/G14 core is the default target, specifying
21767 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21768 change the behavior of the toolchain since it also enables G14
21769 hardware multiply support.  If these options are not specified on the
21770 command line then software multiplication routines will be used even
21771 though the code targets the RL78 core.  This is for backwards
21772 compatibility with older toolchains which did not have hardware
21773 multiply and divide support.
21775 In addition a C preprocessor macro is defined, based upon the setting
21776 of this option.  Possible values are: @code{__RL78_G10__},
21777 @code{__RL78_G13__} or @code{__RL78_G14__}.
21779 @item -mg10
21780 @itemx -mg13
21781 @itemx -mg14
21782 @itemx -mrl78
21783 @opindex mg10
21784 @opindex mg13
21785 @opindex mg14
21786 @opindex mrl78
21787 These are aliases for the corresponding @option{-mcpu=} option.  They
21788 are provided for backwards compatibility.
21790 @item -mallregs
21791 @opindex mallregs
21792 Allow the compiler to use all of the available registers.  By default
21793 registers @code{r24..r31} are reserved for use in interrupt handlers.
21794 With this option enabled these registers can be used in ordinary
21795 functions as well.
21797 @item -m64bit-doubles
21798 @itemx -m32bit-doubles
21799 @opindex m64bit-doubles
21800 @opindex m32bit-doubles
21801 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21802 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21803 @option{-m32bit-doubles}.
21805 @item -msave-mduc-in-interrupts
21806 @item -mno-save-mduc-in-interrupts
21807 @opindex msave-mduc-in-interrupts
21808 @opindex mno-save-mduc-in-interrupts
21809 Specifies that interrupt handler functions should preserve the
21810 MDUC registers.  This is only necessary if normal code might use
21811 the MDUC registers, for example because it performs multiplication
21812 and division operations.  The default is to ignore the MDUC registers
21813 as this makes the interrupt handlers faster.  The target option -mg13
21814 needs to be passed for this to work as this feature is only available
21815 on the G13 target (S2 core).  The MDUC registers will only be saved
21816 if the interrupt handler performs a multiplication or division
21817 operation or it calls another function.
21819 @end table
21821 @node RS/6000 and PowerPC Options
21822 @subsection IBM RS/6000 and PowerPC Options
21823 @cindex RS/6000 and PowerPC Options
21824 @cindex IBM RS/6000 and PowerPC Options
21826 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21827 @table @gcctabopt
21828 @item -mpowerpc-gpopt
21829 @itemx -mno-powerpc-gpopt
21830 @itemx -mpowerpc-gfxopt
21831 @itemx -mno-powerpc-gfxopt
21832 @need 800
21833 @itemx -mpowerpc64
21834 @itemx -mno-powerpc64
21835 @itemx -mmfcrf
21836 @itemx -mno-mfcrf
21837 @itemx -mpopcntb
21838 @itemx -mno-popcntb
21839 @itemx -mpopcntd
21840 @itemx -mno-popcntd
21841 @itemx -mfprnd
21842 @itemx -mno-fprnd
21843 @need 800
21844 @itemx -mcmpb
21845 @itemx -mno-cmpb
21846 @itemx -mmfpgpr
21847 @itemx -mno-mfpgpr
21848 @itemx -mhard-dfp
21849 @itemx -mno-hard-dfp
21850 @opindex mpowerpc-gpopt
21851 @opindex mno-powerpc-gpopt
21852 @opindex mpowerpc-gfxopt
21853 @opindex mno-powerpc-gfxopt
21854 @opindex mpowerpc64
21855 @opindex mno-powerpc64
21856 @opindex mmfcrf
21857 @opindex mno-mfcrf
21858 @opindex mpopcntb
21859 @opindex mno-popcntb
21860 @opindex mpopcntd
21861 @opindex mno-popcntd
21862 @opindex mfprnd
21863 @opindex mno-fprnd
21864 @opindex mcmpb
21865 @opindex mno-cmpb
21866 @opindex mmfpgpr
21867 @opindex mno-mfpgpr
21868 @opindex mhard-dfp
21869 @opindex mno-hard-dfp
21870 You use these options to specify which instructions are available on the
21871 processor you are using.  The default value of these options is
21872 determined when configuring GCC@.  Specifying the
21873 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21874 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21875 rather than the options listed above.
21877 Specifying @option{-mpowerpc-gpopt} allows
21878 GCC to use the optional PowerPC architecture instructions in the
21879 General Purpose group, including floating-point square root.  Specifying
21880 @option{-mpowerpc-gfxopt} allows GCC to
21881 use the optional PowerPC architecture instructions in the Graphics
21882 group, including floating-point select.
21884 The @option{-mmfcrf} option allows GCC to generate the move from
21885 condition register field instruction implemented on the POWER4
21886 processor and other processors that support the PowerPC V2.01
21887 architecture.
21888 The @option{-mpopcntb} option allows GCC to generate the popcount and
21889 double-precision FP reciprocal estimate instruction implemented on the
21890 POWER5 processor and other processors that support the PowerPC V2.02
21891 architecture.
21892 The @option{-mpopcntd} option allows GCC to generate the popcount
21893 instruction implemented on the POWER7 processor and other processors
21894 that support the PowerPC V2.06 architecture.
21895 The @option{-mfprnd} option allows GCC to generate the FP round to
21896 integer instructions implemented on the POWER5+ processor and other
21897 processors that support the PowerPC V2.03 architecture.
21898 The @option{-mcmpb} option allows GCC to generate the compare bytes
21899 instruction implemented on the POWER6 processor and other processors
21900 that support the PowerPC V2.05 architecture.
21901 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21902 general-purpose register instructions implemented on the POWER6X
21903 processor and other processors that support the extended PowerPC V2.05
21904 architecture.
21905 The @option{-mhard-dfp} option allows GCC to generate the decimal
21906 floating-point instructions implemented on some POWER processors.
21908 The @option{-mpowerpc64} option allows GCC to generate the additional
21909 64-bit instructions that are found in the full PowerPC64 architecture
21910 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21911 @option{-mno-powerpc64}.
21913 @item -mcpu=@var{cpu_type}
21914 @opindex mcpu
21915 Set architecture type, register usage, and
21916 instruction scheduling parameters for machine type @var{cpu_type}.
21917 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21918 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21919 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21920 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21921 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21922 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21923 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21924 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21925 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21926 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21927 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21928 and @samp{rs64}.
21930 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21931 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21932 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21933 architecture machine types, with an appropriate, generic processor
21934 model assumed for scheduling purposes.
21936 The other options specify a specific processor.  Code generated under
21937 those options runs best on that processor, and may not run at all on
21938 others.
21940 The @option{-mcpu} options automatically enable or disable the
21941 following options:
21943 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21944 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21945 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21946 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21947 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21948 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21950 The particular options set for any particular CPU varies between
21951 compiler versions, depending on what setting seems to produce optimal
21952 code for that CPU; it doesn't necessarily reflect the actual hardware's
21953 capabilities.  If you wish to set an individual option to a particular
21954 value, you may specify it after the @option{-mcpu} option, like
21955 @option{-mcpu=970 -mno-altivec}.
21957 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21958 not enabled or disabled by the @option{-mcpu} option at present because
21959 AIX does not have full support for these options.  You may still
21960 enable or disable them individually if you're sure it'll work in your
21961 environment.
21963 @item -mtune=@var{cpu_type}
21964 @opindex mtune
21965 Set the instruction scheduling parameters for machine type
21966 @var{cpu_type}, but do not set the architecture type or register usage,
21967 as @option{-mcpu=@var{cpu_type}} does.  The same
21968 values for @var{cpu_type} are used for @option{-mtune} as for
21969 @option{-mcpu}.  If both are specified, the code generated uses the
21970 architecture and registers set by @option{-mcpu}, but the
21971 scheduling parameters set by @option{-mtune}.
21973 @item -mcmodel=small
21974 @opindex mcmodel=small
21975 Generate PowerPC64 code for the small model: The TOC is limited to
21976 64k.
21978 @item -mcmodel=medium
21979 @opindex mcmodel=medium
21980 Generate PowerPC64 code for the medium model: The TOC and other static
21981 data may be up to a total of 4G in size.  This is the default for 64-bit
21982 Linux.
21984 @item -mcmodel=large
21985 @opindex mcmodel=large
21986 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21987 in size.  Other data and code is only limited by the 64-bit address
21988 space.
21990 @item -maltivec
21991 @itemx -mno-altivec
21992 @opindex maltivec
21993 @opindex mno-altivec
21994 Generate code that uses (does not use) AltiVec instructions, and also
21995 enable the use of built-in functions that allow more direct access to
21996 the AltiVec instruction set.  You may also need to set
21997 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21998 enhancements.
22000 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22001 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22002 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22003 match array element order corresponding to the endianness of the
22004 target.  That is, element zero identifies the leftmost element in a
22005 vector register when targeting a big-endian platform, and identifies
22006 the rightmost element in a vector register when targeting a
22007 little-endian platform.
22009 @item -maltivec=be
22010 @opindex maltivec=be
22011 Generate AltiVec instructions using big-endian element order,
22012 regardless of whether the target is big- or little-endian.  This is
22013 the default when targeting a big-endian platform.
22015 The element order is used to interpret element numbers in AltiVec
22016 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22017 @code{vec_insert}.  By default, these match array element order
22018 corresponding to the endianness for the target.
22020 @item -maltivec=le
22021 @opindex maltivec=le
22022 Generate AltiVec instructions using little-endian element order,
22023 regardless of whether the target is big- or little-endian.  This is
22024 the default when targeting a little-endian platform.  This option is
22025 currently ignored when targeting a big-endian platform.
22027 The element order is used to interpret element numbers in AltiVec
22028 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22029 @code{vec_insert}.  By default, these match array element order
22030 corresponding to the endianness for the target.
22032 @item -mvrsave
22033 @itemx -mno-vrsave
22034 @opindex mvrsave
22035 @opindex mno-vrsave
22036 Generate VRSAVE instructions when generating AltiVec code.
22038 @item -msecure-plt
22039 @opindex msecure-plt
22040 Generate code that allows @command{ld} and @command{ld.so}
22041 to build executables and shared
22042 libraries with non-executable @code{.plt} and @code{.got} sections.
22043 This is a PowerPC
22044 32-bit SYSV ABI option.
22046 @item -mbss-plt
22047 @opindex mbss-plt
22048 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22049 fills in, and
22050 requires @code{.plt} and @code{.got}
22051 sections that are both writable and executable.
22052 This is a PowerPC 32-bit SYSV ABI option.
22054 @item -misel
22055 @itemx -mno-isel
22056 @opindex misel
22057 @opindex mno-isel
22058 This switch enables or disables the generation of ISEL instructions.
22060 @item -misel=@var{yes/no}
22061 This switch has been deprecated.  Use @option{-misel} and
22062 @option{-mno-isel} instead.
22064 @item -mspe
22065 @itemx -mno-spe
22066 @opindex mspe
22067 @opindex mno-spe
22068 This switch enables or disables the generation of SPE simd
22069 instructions.
22071 @item -mpaired
22072 @itemx -mno-paired
22073 @opindex mpaired
22074 @opindex mno-paired
22075 This switch enables or disables the generation of PAIRED simd
22076 instructions.
22078 @item -mspe=@var{yes/no}
22079 This option has been deprecated.  Use @option{-mspe} and
22080 @option{-mno-spe} instead.
22082 @item -mvsx
22083 @itemx -mno-vsx
22084 @opindex mvsx
22085 @opindex mno-vsx
22086 Generate code that uses (does not use) vector/scalar (VSX)
22087 instructions, and also enable the use of built-in functions that allow
22088 more direct access to the VSX instruction set.
22090 @item -mcrypto
22091 @itemx -mno-crypto
22092 @opindex mcrypto
22093 @opindex mno-crypto
22094 Enable the use (disable) of the built-in functions that allow direct
22095 access to the cryptographic instructions that were added in version
22096 2.07 of the PowerPC ISA.
22098 @item -mdirect-move
22099 @itemx -mno-direct-move
22100 @opindex mdirect-move
22101 @opindex mno-direct-move
22102 Generate code that uses (does not use) the instructions to move data
22103 between the general purpose registers and the vector/scalar (VSX)
22104 registers that were added in version 2.07 of the PowerPC ISA.
22106 @item -mhtm
22107 @itemx -mno-htm
22108 @opindex mhtm
22109 @opindex mno-htm
22110 Enable (disable) the use of the built-in functions that allow direct
22111 access to the Hardware Transactional Memory (HTM) instructions that
22112 were added in version 2.07 of the PowerPC ISA.
22114 @item -mpower8-fusion
22115 @itemx -mno-power8-fusion
22116 @opindex mpower8-fusion
22117 @opindex mno-power8-fusion
22118 Generate code that keeps (does not keeps) some integer operations
22119 adjacent so that the instructions can be fused together on power8 and
22120 later processors.
22122 @item -mpower8-vector
22123 @itemx -mno-power8-vector
22124 @opindex mpower8-vector
22125 @opindex mno-power8-vector
22126 Generate code that uses (does not use) the vector and scalar
22127 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22128 enable the use of built-in functions that allow more direct access to
22129 the vector instructions.
22131 @item -mquad-memory
22132 @itemx -mno-quad-memory
22133 @opindex mquad-memory
22134 @opindex mno-quad-memory
22135 Generate code that uses (does not use) the non-atomic quad word memory
22136 instructions.  The @option{-mquad-memory} option requires use of
22137 64-bit mode.
22139 @item -mquad-memory-atomic
22140 @itemx -mno-quad-memory-atomic
22141 @opindex mquad-memory-atomic
22142 @opindex mno-quad-memory-atomic
22143 Generate code that uses (does not use) the atomic quad word memory
22144 instructions.  The @option{-mquad-memory-atomic} option requires use of
22145 64-bit mode.
22147 @item -mfloat128
22148 @itemx -mno-float128
22149 @opindex mfloat128
22150 @opindex mno-float128
22151 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22152 and use either software emulation for IEEE 128-bit floating point or
22153 hardware instructions.
22155 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22156 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22157 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22158 floating point support only works on PowerPC Linux systems.
22160 The default for @option{-mfloat128} is enabled on PowerPC Linux
22161 systems using the VSX instruction set, and disabled on other systems.
22163 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22164 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22165 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22166 floating point instructions.  Otherwise, if you do not specify to
22167 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22168 system, IEEE 128-bit floating point will be done with software
22169 emulation.
22171 @item -mfloat128-hardware
22172 @itemx -mno-float128-hardware
22173 @opindex mfloat128-hardware
22174 @opindex mno-float128-hardware
22175 Enable/disable using ISA 3.0 hardware instructions to support the
22176 @var{__float128} data type.
22178 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22179 Linux systems using the ISA 3.0 instruction set, and disabled on other
22180 systems.
22182 @item -mfloat-gprs=@var{yes/single/double/no}
22183 @itemx -mfloat-gprs
22184 @opindex mfloat-gprs
22185 This switch enables or disables the generation of floating-point
22186 operations on the general-purpose registers for architectures that
22187 support it.
22189 The argument @samp{yes} or @samp{single} enables the use of
22190 single-precision floating-point operations.
22192 The argument @samp{double} enables the use of single and
22193 double-precision floating-point operations.
22195 The argument @samp{no} disables floating-point operations on the
22196 general-purpose registers.
22198 This option is currently only available on the MPC854x.
22200 @item -m32
22201 @itemx -m64
22202 @opindex m32
22203 @opindex m64
22204 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22205 targets (including GNU/Linux).  The 32-bit environment sets int, long
22206 and pointer to 32 bits and generates code that runs on any PowerPC
22207 variant.  The 64-bit environment sets int to 32 bits and long and
22208 pointer to 64 bits, and generates code for PowerPC64, as for
22209 @option{-mpowerpc64}.
22211 @item -mfull-toc
22212 @itemx -mno-fp-in-toc
22213 @itemx -mno-sum-in-toc
22214 @itemx -mminimal-toc
22215 @opindex mfull-toc
22216 @opindex mno-fp-in-toc
22217 @opindex mno-sum-in-toc
22218 @opindex mminimal-toc
22219 Modify generation of the TOC (Table Of Contents), which is created for
22220 every executable file.  The @option{-mfull-toc} option is selected by
22221 default.  In that case, GCC allocates at least one TOC entry for
22222 each unique non-automatic variable reference in your program.  GCC
22223 also places floating-point constants in the TOC@.  However, only
22224 16,384 entries are available in the TOC@.
22226 If you receive a linker error message that saying you have overflowed
22227 the available TOC space, you can reduce the amount of TOC space used
22228 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22229 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22230 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22231 generate code to calculate the sum of an address and a constant at
22232 run time instead of putting that sum into the TOC@.  You may specify one
22233 or both of these options.  Each causes GCC to produce very slightly
22234 slower and larger code at the expense of conserving TOC space.
22236 If you still run out of space in the TOC even when you specify both of
22237 these options, specify @option{-mminimal-toc} instead.  This option causes
22238 GCC to make only one TOC entry for every file.  When you specify this
22239 option, GCC produces code that is slower and larger but which
22240 uses extremely little TOC space.  You may wish to use this option
22241 only on files that contain less frequently-executed code.
22243 @item -maix64
22244 @itemx -maix32
22245 @opindex maix64
22246 @opindex maix32
22247 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22248 @code{long} type, and the infrastructure needed to support them.
22249 Specifying @option{-maix64} implies @option{-mpowerpc64},
22250 while @option{-maix32} disables the 64-bit ABI and
22251 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22253 @item -mxl-compat
22254 @itemx -mno-xl-compat
22255 @opindex mxl-compat
22256 @opindex mno-xl-compat
22257 Produce code that conforms more closely to IBM XL compiler semantics
22258 when using AIX-compatible ABI@.  Pass floating-point arguments to
22259 prototyped functions beyond the register save area (RSA) on the stack
22260 in addition to argument FPRs.  Do not assume that most significant
22261 double in 128-bit long double value is properly rounded when comparing
22262 values and converting to double.  Use XL symbol names for long double
22263 support routines.
22265 The AIX calling convention was extended but not initially documented to
22266 handle an obscure K&R C case of calling a function that takes the
22267 address of its arguments with fewer arguments than declared.  IBM XL
22268 compilers access floating-point arguments that do not fit in the
22269 RSA from the stack when a subroutine is compiled without
22270 optimization.  Because always storing floating-point arguments on the
22271 stack is inefficient and rarely needed, this option is not enabled by
22272 default and only is necessary when calling subroutines compiled by IBM
22273 XL compilers without optimization.
22275 @item -mpe
22276 @opindex mpe
22277 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22278 application written to use message passing with special startup code to
22279 enable the application to run.  The system must have PE installed in the
22280 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22281 must be overridden with the @option{-specs=} option to specify the
22282 appropriate directory location.  The Parallel Environment does not
22283 support threads, so the @option{-mpe} option and the @option{-pthread}
22284 option are incompatible.
22286 @item -malign-natural
22287 @itemx -malign-power
22288 @opindex malign-natural
22289 @opindex malign-power
22290 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22291 @option{-malign-natural} overrides the ABI-defined alignment of larger
22292 types, such as floating-point doubles, on their natural size-based boundary.
22293 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22294 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22296 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22297 is not supported.
22299 @item -msoft-float
22300 @itemx -mhard-float
22301 @opindex msoft-float
22302 @opindex mhard-float
22303 Generate code that does not use (uses) the floating-point register set.
22304 Software floating-point emulation is provided if you use the
22305 @option{-msoft-float} option, and pass the option to GCC when linking.
22307 @item -msingle-float
22308 @itemx -mdouble-float
22309 @opindex msingle-float
22310 @opindex mdouble-float
22311 Generate code for single- or double-precision floating-point operations.
22312 @option{-mdouble-float} implies @option{-msingle-float}.
22314 @item -msimple-fpu
22315 @opindex msimple-fpu
22316 Do not generate @code{sqrt} and @code{div} instructions for hardware
22317 floating-point unit.
22319 @item -mfpu=@var{name}
22320 @opindex mfpu
22321 Specify type of floating-point unit.  Valid values for @var{name} are
22322 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22323 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22324 @samp{sp_full} (equivalent to @option{-msingle-float}),
22325 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22327 @item -mxilinx-fpu
22328 @opindex mxilinx-fpu
22329 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22331 @item -mmultiple
22332 @itemx -mno-multiple
22333 @opindex mmultiple
22334 @opindex mno-multiple
22335 Generate code that uses (does not use) the load multiple word
22336 instructions and the store multiple word instructions.  These
22337 instructions are generated by default on POWER systems, and not
22338 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22339 PowerPC systems, since those instructions do not work when the
22340 processor is in little-endian mode.  The exceptions are PPC740 and
22341 PPC750 which permit these instructions in little-endian mode.
22343 @item -mstring
22344 @itemx -mno-string
22345 @opindex mstring
22346 @opindex mno-string
22347 Generate code that uses (does not use) the load string instructions
22348 and the store string word instructions to save multiple registers and
22349 do small block moves.  These instructions are generated by default on
22350 POWER systems, and not generated on PowerPC systems.  Do not use
22351 @option{-mstring} on little-endian PowerPC systems, since those
22352 instructions do not work when the processor is in little-endian mode.
22353 The exceptions are PPC740 and PPC750 which permit these instructions
22354 in little-endian mode.
22356 @item -mupdate
22357 @itemx -mno-update
22358 @opindex mupdate
22359 @opindex mno-update
22360 Generate code that uses (does not use) the load or store instructions
22361 that update the base register to the address of the calculated memory
22362 location.  These instructions are generated by default.  If you use
22363 @option{-mno-update}, there is a small window between the time that the
22364 stack pointer is updated and the address of the previous frame is
22365 stored, which means code that walks the stack frame across interrupts or
22366 signals may get corrupted data.
22368 @item -mavoid-indexed-addresses
22369 @itemx -mno-avoid-indexed-addresses
22370 @opindex mavoid-indexed-addresses
22371 @opindex mno-avoid-indexed-addresses
22372 Generate code that tries to avoid (not avoid) the use of indexed load
22373 or store instructions. These instructions can incur a performance
22374 penalty on Power6 processors in certain situations, such as when
22375 stepping through large arrays that cross a 16M boundary.  This option
22376 is enabled by default when targeting Power6 and disabled otherwise.
22378 @item -mfused-madd
22379 @itemx -mno-fused-madd
22380 @opindex mfused-madd
22381 @opindex mno-fused-madd
22382 Generate code that uses (does not use) the floating-point multiply and
22383 accumulate instructions.  These instructions are generated by default
22384 if hardware floating point is used.  The machine-dependent
22385 @option{-mfused-madd} option is now mapped to the machine-independent
22386 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22387 mapped to @option{-ffp-contract=off}.
22389 @item -mmulhw
22390 @itemx -mno-mulhw
22391 @opindex mmulhw
22392 @opindex mno-mulhw
22393 Generate code that uses (does not use) the half-word multiply and
22394 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22395 These instructions are generated by default when targeting those
22396 processors.
22398 @item -mdlmzb
22399 @itemx -mno-dlmzb
22400 @opindex mdlmzb
22401 @opindex mno-dlmzb
22402 Generate code that uses (does not use) the string-search @samp{dlmzb}
22403 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22404 generated by default when targeting those processors.
22406 @item -mno-bit-align
22407 @itemx -mbit-align
22408 @opindex mno-bit-align
22409 @opindex mbit-align
22410 On System V.4 and embedded PowerPC systems do not (do) force structures
22411 and unions that contain bit-fields to be aligned to the base type of the
22412 bit-field.
22414 For example, by default a structure containing nothing but 8
22415 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22416 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22417 the structure is aligned to a 1-byte boundary and is 1 byte in
22418 size.
22420 @item -mno-strict-align
22421 @itemx -mstrict-align
22422 @opindex mno-strict-align
22423 @opindex mstrict-align
22424 On System V.4 and embedded PowerPC systems do not (do) assume that
22425 unaligned memory references are handled by the system.
22427 @item -mrelocatable
22428 @itemx -mno-relocatable
22429 @opindex mrelocatable
22430 @opindex mno-relocatable
22431 Generate code that allows (does not allow) a static executable to be
22432 relocated to a different address at run time.  A simple embedded
22433 PowerPC system loader should relocate the entire contents of
22434 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22435 a table of 32-bit addresses generated by this option.  For this to
22436 work, all objects linked together must be compiled with
22437 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22438 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22440 @item -mrelocatable-lib
22441 @itemx -mno-relocatable-lib
22442 @opindex mrelocatable-lib
22443 @opindex mno-relocatable-lib
22444 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22445 @code{.fixup} section to allow static executables to be relocated at
22446 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22447 alignment of @option{-mrelocatable}.  Objects compiled with
22448 @option{-mrelocatable-lib} may be linked with objects compiled with
22449 any combination of the @option{-mrelocatable} options.
22451 @item -mno-toc
22452 @itemx -mtoc
22453 @opindex mno-toc
22454 @opindex mtoc
22455 On System V.4 and embedded PowerPC systems do not (do) assume that
22456 register 2 contains a pointer to a global area pointing to the addresses
22457 used in the program.
22459 @item -mlittle
22460 @itemx -mlittle-endian
22461 @opindex mlittle
22462 @opindex mlittle-endian
22463 On System V.4 and embedded PowerPC systems compile code for the
22464 processor in little-endian mode.  The @option{-mlittle-endian} option is
22465 the same as @option{-mlittle}.
22467 @item -mbig
22468 @itemx -mbig-endian
22469 @opindex mbig
22470 @opindex mbig-endian
22471 On System V.4 and embedded PowerPC systems compile code for the
22472 processor in big-endian mode.  The @option{-mbig-endian} option is
22473 the same as @option{-mbig}.
22475 @item -mdynamic-no-pic
22476 @opindex mdynamic-no-pic
22477 On Darwin and Mac OS X systems, compile code so that it is not
22478 relocatable, but that its external references are relocatable.  The
22479 resulting code is suitable for applications, but not shared
22480 libraries.
22482 @item -msingle-pic-base
22483 @opindex msingle-pic-base
22484 Treat the register used for PIC addressing as read-only, rather than
22485 loading it in the prologue for each function.  The runtime system is
22486 responsible for initializing this register with an appropriate value
22487 before execution begins.
22489 @item -mprioritize-restricted-insns=@var{priority}
22490 @opindex mprioritize-restricted-insns
22491 This option controls the priority that is assigned to
22492 dispatch-slot restricted instructions during the second scheduling
22493 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22494 or @samp{2} to assign no, highest, or second-highest (respectively) 
22495 priority to dispatch-slot restricted
22496 instructions.
22498 @item -msched-costly-dep=@var{dependence_type}
22499 @opindex msched-costly-dep
22500 This option controls which dependences are considered costly
22501 by the target during instruction scheduling.  The argument
22502 @var{dependence_type} takes one of the following values:
22504 @table @asis
22505 @item @samp{no}
22506 No dependence is costly.
22508 @item @samp{all}
22509 All dependences are costly.
22511 @item @samp{true_store_to_load}
22512 A true dependence from store to load is costly.
22514 @item @samp{store_to_load}
22515 Any dependence from store to load is costly.
22517 @item @var{number}
22518 Any dependence for which the latency is greater than or equal to 
22519 @var{number} is costly.
22520 @end table
22522 @item -minsert-sched-nops=@var{scheme}
22523 @opindex minsert-sched-nops
22524 This option controls which NOP insertion scheme is used during
22525 the second scheduling pass.  The argument @var{scheme} takes one of the
22526 following values:
22528 @table @asis
22529 @item @samp{no}
22530 Don't insert NOPs.
22532 @item @samp{pad}
22533 Pad with NOPs any dispatch group that has vacant issue slots,
22534 according to the scheduler's grouping.
22536 @item @samp{regroup_exact}
22537 Insert NOPs to force costly dependent insns into
22538 separate groups.  Insert exactly as many NOPs as needed to force an insn
22539 to a new group, according to the estimated processor grouping.
22541 @item @var{number}
22542 Insert NOPs to force costly dependent insns into
22543 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22544 @end table
22546 @item -mcall-sysv
22547 @opindex mcall-sysv
22548 On System V.4 and embedded PowerPC systems compile code using calling
22549 conventions that adhere to the March 1995 draft of the System V
22550 Application Binary Interface, PowerPC processor supplement.  This is the
22551 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22553 @item -mcall-sysv-eabi
22554 @itemx -mcall-eabi
22555 @opindex mcall-sysv-eabi
22556 @opindex mcall-eabi
22557 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22559 @item -mcall-sysv-noeabi
22560 @opindex mcall-sysv-noeabi
22561 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22563 @item -mcall-aixdesc
22564 @opindex m
22565 On System V.4 and embedded PowerPC systems compile code for the AIX
22566 operating system.
22568 @item -mcall-linux
22569 @opindex mcall-linux
22570 On System V.4 and embedded PowerPC systems compile code for the
22571 Linux-based GNU system.
22573 @item -mcall-freebsd
22574 @opindex mcall-freebsd
22575 On System V.4 and embedded PowerPC systems compile code for the
22576 FreeBSD operating system.
22578 @item -mcall-netbsd
22579 @opindex mcall-netbsd
22580 On System V.4 and embedded PowerPC systems compile code for the
22581 NetBSD operating system.
22583 @item -mcall-openbsd
22584 @opindex mcall-netbsd
22585 On System V.4 and embedded PowerPC systems compile code for the
22586 OpenBSD operating system.
22588 @item -maix-struct-return
22589 @opindex maix-struct-return
22590 Return all structures in memory (as specified by the AIX ABI)@.
22592 @item -msvr4-struct-return
22593 @opindex msvr4-struct-return
22594 Return structures smaller than 8 bytes in registers (as specified by the
22595 SVR4 ABI)@.
22597 @item -mabi=@var{abi-type}
22598 @opindex mabi
22599 Extend the current ABI with a particular extension, or remove such extension.
22600 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22601 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22602 @samp{elfv1}, @samp{elfv2}@.
22604 @item -mabi=spe
22605 @opindex mabi=spe
22606 Extend the current ABI with SPE ABI extensions.  This does not change
22607 the default ABI, instead it adds the SPE ABI extensions to the current
22608 ABI@.
22610 @item -mabi=no-spe
22611 @opindex mabi=no-spe
22612 Disable Book-E SPE ABI extensions for the current ABI@.
22614 @item -mabi=ibmlongdouble
22615 @opindex mabi=ibmlongdouble
22616 Change the current ABI to use IBM extended-precision long double.
22617 This is a PowerPC 32-bit SYSV ABI option.
22619 @item -mabi=ieeelongdouble
22620 @opindex mabi=ieeelongdouble
22621 Change the current ABI to use IEEE extended-precision long double.
22622 This is a PowerPC 32-bit Linux ABI option.
22624 @item -mabi=elfv1
22625 @opindex mabi=elfv1
22626 Change the current ABI to use the ELFv1 ABI.
22627 This is the default ABI for big-endian PowerPC 64-bit Linux.
22628 Overriding the default ABI requires special system support and is
22629 likely to fail in spectacular ways.
22631 @item -mabi=elfv2
22632 @opindex mabi=elfv2
22633 Change the current ABI to use the ELFv2 ABI.
22634 This is the default ABI for little-endian PowerPC 64-bit Linux.
22635 Overriding the default ABI requires special system support and is
22636 likely to fail in spectacular ways.
22638 @item -mgnu-attribute
22639 @itemx -mno-gnu-attribute
22640 @opindex mgnu-attribute
22641 @opindex mno-gnu-attribute
22642 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22643 .gnu.attributes section that specify ABI variations in function
22644 parameters or return values.
22646 @item -mprototype
22647 @itemx -mno-prototype
22648 @opindex mprototype
22649 @opindex mno-prototype
22650 On System V.4 and embedded PowerPC systems assume that all calls to
22651 variable argument functions are properly prototyped.  Otherwise, the
22652 compiler must insert an instruction before every non-prototyped call to
22653 set or clear bit 6 of the condition code register (@code{CR}) to
22654 indicate whether floating-point values are passed in the floating-point
22655 registers in case the function takes variable arguments.  With
22656 @option{-mprototype}, only calls to prototyped variable argument functions
22657 set or clear the bit.
22659 @item -msim
22660 @opindex msim
22661 On embedded PowerPC systems, assume that the startup module is called
22662 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22663 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22664 configurations.
22666 @item -mmvme
22667 @opindex mmvme
22668 On embedded PowerPC systems, assume that the startup module is called
22669 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22670 @file{libc.a}.
22672 @item -mads
22673 @opindex mads
22674 On embedded PowerPC systems, assume that the startup module is called
22675 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22676 @file{libc.a}.
22678 @item -myellowknife
22679 @opindex myellowknife
22680 On embedded PowerPC systems, assume that the startup module is called
22681 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22682 @file{libc.a}.
22684 @item -mvxworks
22685 @opindex mvxworks
22686 On System V.4 and embedded PowerPC systems, specify that you are
22687 compiling for a VxWorks system.
22689 @item -memb
22690 @opindex memb
22691 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22692 header to indicate that @samp{eabi} extended relocations are used.
22694 @item -meabi
22695 @itemx -mno-eabi
22696 @opindex meabi
22697 @opindex mno-eabi
22698 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22699 Embedded Applications Binary Interface (EABI), which is a set of
22700 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22701 means that the stack is aligned to an 8-byte boundary, a function
22702 @code{__eabi} is called from @code{main} to set up the EABI
22703 environment, and the @option{-msdata} option can use both @code{r2} and
22704 @code{r13} to point to two separate small data areas.  Selecting
22705 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22706 no EABI initialization function is called from @code{main}, and the
22707 @option{-msdata} option only uses @code{r13} to point to a single
22708 small data area.  The @option{-meabi} option is on by default if you
22709 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22711 @item -msdata=eabi
22712 @opindex msdata=eabi
22713 On System V.4 and embedded PowerPC systems, put small initialized
22714 @code{const} global and static data in the @code{.sdata2} section, which
22715 is pointed to by register @code{r2}.  Put small initialized
22716 non-@code{const} global and static data in the @code{.sdata} section,
22717 which is pointed to by register @code{r13}.  Put small uninitialized
22718 global and static data in the @code{.sbss} section, which is adjacent to
22719 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22720 incompatible with the @option{-mrelocatable} option.  The
22721 @option{-msdata=eabi} option also sets the @option{-memb} option.
22723 @item -msdata=sysv
22724 @opindex msdata=sysv
22725 On System V.4 and embedded PowerPC systems, put small global and static
22726 data in the @code{.sdata} section, which is pointed to by register
22727 @code{r13}.  Put small uninitialized global and static data in the
22728 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22729 The @option{-msdata=sysv} option is incompatible with the
22730 @option{-mrelocatable} option.
22732 @item -msdata=default
22733 @itemx -msdata
22734 @opindex msdata=default
22735 @opindex msdata
22736 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22737 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22738 same as @option{-msdata=sysv}.
22740 @item -msdata=data
22741 @opindex msdata=data
22742 On System V.4 and embedded PowerPC systems, put small global
22743 data in the @code{.sdata} section.  Put small uninitialized global
22744 data in the @code{.sbss} section.  Do not use register @code{r13}
22745 to address small data however.  This is the default behavior unless
22746 other @option{-msdata} options are used.
22748 @item -msdata=none
22749 @itemx -mno-sdata
22750 @opindex msdata=none
22751 @opindex mno-sdata
22752 On embedded PowerPC systems, put all initialized global and static data
22753 in the @code{.data} section, and all uninitialized data in the
22754 @code{.bss} section.
22756 @item -mblock-move-inline-limit=@var{num}
22757 @opindex mblock-move-inline-limit
22758 Inline all block moves (such as calls to @code{memcpy} or structure
22759 copies) less than or equal to @var{num} bytes.  The minimum value for
22760 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22761 targets.  The default value is target-specific.
22763 @item -G @var{num}
22764 @opindex G
22765 @cindex smaller data references (PowerPC)
22766 @cindex .sdata/.sdata2 references (PowerPC)
22767 On embedded PowerPC systems, put global and static items less than or
22768 equal to @var{num} bytes into the small data or BSS sections instead of
22769 the normal data or BSS section.  By default, @var{num} is 8.  The
22770 @option{-G @var{num}} switch is also passed to the linker.
22771 All modules should be compiled with the same @option{-G @var{num}} value.
22773 @item -mregnames
22774 @itemx -mno-regnames
22775 @opindex mregnames
22776 @opindex mno-regnames
22777 On System V.4 and embedded PowerPC systems do (do not) emit register
22778 names in the assembly language output using symbolic forms.
22780 @item -mlongcall
22781 @itemx -mno-longcall
22782 @opindex mlongcall
22783 @opindex mno-longcall
22784 By default assume that all calls are far away so that a longer and more
22785 expensive calling sequence is required.  This is required for calls
22786 farther than 32 megabytes (33,554,432 bytes) from the current location.
22787 A short call is generated if the compiler knows
22788 the call cannot be that far away.  This setting can be overridden by
22789 the @code{shortcall} function attribute, or by @code{#pragma
22790 longcall(0)}.
22792 Some linkers are capable of detecting out-of-range calls and generating
22793 glue code on the fly.  On these systems, long calls are unnecessary and
22794 generate slower code.  As of this writing, the AIX linker can do this,
22795 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22796 to the GNU linker for 32-bit PowerPC systems as well.
22798 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22799 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22800 addresses represent the callee and the branch island.  The
22801 Darwin/PPC linker prefers the first address and generates a @code{bl
22802 callee} if the PPC @code{bl} instruction reaches the callee directly;
22803 otherwise, the linker generates @code{bl L42} to call the branch
22804 island.  The branch island is appended to the body of the
22805 calling function; it computes the full 32-bit address of the callee
22806 and jumps to it.
22808 On Mach-O (Darwin) systems, this option directs the compiler emit to
22809 the glue for every direct call, and the Darwin linker decides whether
22810 to use or discard it.
22812 In the future, GCC may ignore all longcall specifications
22813 when the linker is known to generate glue.
22815 @item -mtls-markers
22816 @itemx -mno-tls-markers
22817 @opindex mtls-markers
22818 @opindex mno-tls-markers
22819 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22820 specifying the function argument.  The relocation allows the linker to
22821 reliably associate function call with argument setup instructions for
22822 TLS optimization, which in turn allows GCC to better schedule the
22823 sequence.
22825 @item -mrecip
22826 @itemx -mno-recip
22827 @opindex mrecip
22828 This option enables use of the reciprocal estimate and
22829 reciprocal square root estimate instructions with additional
22830 Newton-Raphson steps to increase precision instead of doing a divide or
22831 square root and divide for floating-point arguments.  You should use
22832 the @option{-ffast-math} option when using @option{-mrecip} (or at
22833 least @option{-funsafe-math-optimizations},
22834 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22835 @option{-fno-trapping-math}).  Note that while the throughput of the
22836 sequence is generally higher than the throughput of the non-reciprocal
22837 instruction, the precision of the sequence can be decreased by up to 2
22838 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22839 roots.
22841 @item -mrecip=@var{opt}
22842 @opindex mrecip=opt
22843 This option controls which reciprocal estimate instructions
22844 may be used.  @var{opt} is a comma-separated list of options, which may
22845 be preceded by a @code{!} to invert the option:
22847 @table @samp
22849 @item all
22850 Enable all estimate instructions.
22852 @item default 
22853 Enable the default instructions, equivalent to @option{-mrecip}.
22855 @item none 
22856 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22858 @item div 
22859 Enable the reciprocal approximation instructions for both 
22860 single and double precision.
22862 @item divf 
22863 Enable the single-precision reciprocal approximation instructions.
22865 @item divd 
22866 Enable the double-precision reciprocal approximation instructions.
22868 @item rsqrt 
22869 Enable the reciprocal square root approximation instructions for both
22870 single and double precision.
22872 @item rsqrtf 
22873 Enable the single-precision reciprocal square root approximation instructions.
22875 @item rsqrtd 
22876 Enable the double-precision reciprocal square root approximation instructions.
22878 @end table
22880 So, for example, @option{-mrecip=all,!rsqrtd} enables
22881 all of the reciprocal estimate instructions, except for the
22882 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22883 which handle the double-precision reciprocal square root calculations.
22885 @item -mrecip-precision
22886 @itemx -mno-recip-precision
22887 @opindex mrecip-precision
22888 Assume (do not assume) that the reciprocal estimate instructions
22889 provide higher-precision estimates than is mandated by the PowerPC
22890 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22891 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22892 The double-precision square root estimate instructions are not generated by
22893 default on low-precision machines, since they do not provide an
22894 estimate that converges after three steps.
22896 @item -mveclibabi=@var{type}
22897 @opindex mveclibabi
22898 Specifies the ABI type to use for vectorizing intrinsics using an
22899 external library.  The only type supported at present is @samp{mass},
22900 which specifies to use IBM's Mathematical Acceleration Subsystem
22901 (MASS) libraries for vectorizing intrinsics using external libraries.
22902 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22903 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22904 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22905 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22906 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22907 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22908 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22909 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22910 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22911 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22912 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22913 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22914 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22915 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22916 for power7.  Both @option{-ftree-vectorize} and
22917 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22918 libraries must be specified at link time.
22920 @item -mfriz
22921 @itemx -mno-friz
22922 @opindex mfriz
22923 Generate (do not generate) the @code{friz} instruction when the
22924 @option{-funsafe-math-optimizations} option is used to optimize
22925 rounding of floating-point values to 64-bit integer and back to floating
22926 point.  The @code{friz} instruction does not return the same value if
22927 the floating-point number is too large to fit in an integer.
22929 @item -mpointers-to-nested-functions
22930 @itemx -mno-pointers-to-nested-functions
22931 @opindex mpointers-to-nested-functions
22932 Generate (do not generate) code to load up the static chain register
22933 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22934 systems where a function pointer points to a 3-word descriptor giving
22935 the function address, TOC value to be loaded in register @code{r2}, and
22936 static chain value to be loaded in register @code{r11}.  The
22937 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22938 call through pointers to nested functions or pointers
22939 to functions compiled in other languages that use the static chain if
22940 you use @option{-mno-pointers-to-nested-functions}.
22942 @item -msave-toc-indirect
22943 @itemx -mno-save-toc-indirect
22944 @opindex msave-toc-indirect
22945 Generate (do not generate) code to save the TOC value in the reserved
22946 stack location in the function prologue if the function calls through
22947 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22948 saved in the prologue, it is saved just before the call through the
22949 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22951 @item -mcompat-align-parm
22952 @itemx -mno-compat-align-parm
22953 @opindex mcompat-align-parm
22954 Generate (do not generate) code to pass structure parameters with a
22955 maximum alignment of 64 bits, for compatibility with older versions
22956 of GCC.
22958 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22959 structure parameter on a 128-bit boundary when that structure contained
22960 a member requiring 128-bit alignment.  This is corrected in more
22961 recent versions of GCC.  This option may be used to generate code
22962 that is compatible with functions compiled with older versions of
22963 GCC.
22965 The @option{-mno-compat-align-parm} option is the default.
22967 @item -mstack-protector-guard=@var{guard}
22968 @itemx -mstack-protector-guard-reg=@var{reg}
22969 @itemx -mstack-protector-guard-offset=@var{offset}
22970 @itemx -mstack-protector-guard-symbol=@var{symbol}
22971 @opindex mstack-protector-guard
22972 @opindex mstack-protector-guard-reg
22973 @opindex mstack-protector-guard-offset
22974 @opindex mstack-protector-guard-symbol
22975 Generate stack protection code using canary at @var{guard}.  Supported
22976 locations are @samp{global} for global canary or @samp{tls} for per-thread
22977 canary in the TLS block (the default with GNU libc version 2.4 or later).
22979 With the latter choice the options
22980 @option{-mstack-protector-guard-reg=@var{reg}} and
22981 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22982 which register to use as base register for reading the canary, and from what
22983 offset from that base register. The default for those is as specified in the
22984 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22985 the offset with a symbol reference to a canary in the TLS block.
22986 @end table
22988 @node RX Options
22989 @subsection RX Options
22990 @cindex RX Options
22992 These command-line options are defined for RX targets:
22994 @table @gcctabopt
22995 @item -m64bit-doubles
22996 @itemx -m32bit-doubles
22997 @opindex m64bit-doubles
22998 @opindex m32bit-doubles
22999 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23000 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23001 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23002 works on 32-bit values, which is why the default is
23003 @option{-m32bit-doubles}.
23005 @item -fpu
23006 @itemx -nofpu
23007 @opindex fpu
23008 @opindex nofpu
23009 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23010 floating-point hardware.  The default is enabled for the RX600
23011 series and disabled for the RX200 series.
23013 Floating-point instructions are only generated for 32-bit floating-point 
23014 values, however, so the FPU hardware is not used for doubles if the
23015 @option{-m64bit-doubles} option is used.
23017 @emph{Note} If the @option{-fpu} option is enabled then
23018 @option{-funsafe-math-optimizations} is also enabled automatically.
23019 This is because the RX FPU instructions are themselves unsafe.
23021 @item -mcpu=@var{name}
23022 @opindex mcpu
23023 Selects the type of RX CPU to be targeted.  Currently three types are
23024 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23025 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23027 The only difference between @samp{RX600} and @samp{RX610} is that the
23028 @samp{RX610} does not support the @code{MVTIPL} instruction.
23030 The @samp{RX200} series does not have a hardware floating-point unit
23031 and so @option{-nofpu} is enabled by default when this type is
23032 selected.
23034 @item -mbig-endian-data
23035 @itemx -mlittle-endian-data
23036 @opindex mbig-endian-data
23037 @opindex mlittle-endian-data
23038 Store data (but not code) in the big-endian format.  The default is
23039 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23040 format.
23042 @item -msmall-data-limit=@var{N}
23043 @opindex msmall-data-limit
23044 Specifies the maximum size in bytes of global and static variables
23045 which can be placed into the small data area.  Using the small data
23046 area can lead to smaller and faster code, but the size of area is
23047 limited and it is up to the programmer to ensure that the area does
23048 not overflow.  Also when the small data area is used one of the RX's
23049 registers (usually @code{r13}) is reserved for use pointing to this
23050 area, so it is no longer available for use by the compiler.  This
23051 could result in slower and/or larger code if variables are pushed onto
23052 the stack instead of being held in this register.
23054 Note, common variables (variables that have not been initialized) and
23055 constants are not placed into the small data area as they are assigned
23056 to other sections in the output executable.
23058 The default value is zero, which disables this feature.  Note, this
23059 feature is not enabled by default with higher optimization levels
23060 (@option{-O2} etc) because of the potentially detrimental effects of
23061 reserving a register.  It is up to the programmer to experiment and
23062 discover whether this feature is of benefit to their program.  See the
23063 description of the @option{-mpid} option for a description of how the
23064 actual register to hold the small data area pointer is chosen.
23066 @item -msim
23067 @itemx -mno-sim
23068 @opindex msim
23069 @opindex mno-sim
23070 Use the simulator runtime.  The default is to use the libgloss
23071 board-specific runtime.
23073 @item -mas100-syntax
23074 @itemx -mno-as100-syntax
23075 @opindex mas100-syntax
23076 @opindex mno-as100-syntax
23077 When generating assembler output use a syntax that is compatible with
23078 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23079 assembler, but it has some restrictions so it is not generated by default.
23081 @item -mmax-constant-size=@var{N}
23082 @opindex mmax-constant-size
23083 Specifies the maximum size, in bytes, of a constant that can be used as
23084 an operand in a RX instruction.  Although the RX instruction set does
23085 allow constants of up to 4 bytes in length to be used in instructions,
23086 a longer value equates to a longer instruction.  Thus in some
23087 circumstances it can be beneficial to restrict the size of constants
23088 that are used in instructions.  Constants that are too big are instead
23089 placed into a constant pool and referenced via register indirection.
23091 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23092 or 4 means that constants of any size are allowed.
23094 @item -mrelax
23095 @opindex mrelax
23096 Enable linker relaxation.  Linker relaxation is a process whereby the
23097 linker attempts to reduce the size of a program by finding shorter
23098 versions of various instructions.  Disabled by default.
23100 @item -mint-register=@var{N}
23101 @opindex mint-register
23102 Specify the number of registers to reserve for fast interrupt handler
23103 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23104 means that register @code{r13} is reserved for the exclusive use
23105 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23106 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23107 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23108 A value of 0, the default, does not reserve any registers.
23110 @item -msave-acc-in-interrupts
23111 @opindex msave-acc-in-interrupts
23112 Specifies that interrupt handler functions should preserve the
23113 accumulator register.  This is only necessary if normal code might use
23114 the accumulator register, for example because it performs 64-bit
23115 multiplications.  The default is to ignore the accumulator as this
23116 makes the interrupt handlers faster.
23118 @item -mpid
23119 @itemx -mno-pid
23120 @opindex mpid
23121 @opindex mno-pid
23122 Enables the generation of position independent data.  When enabled any
23123 access to constant data is done via an offset from a base address
23124 held in a register.  This allows the location of constant data to be
23125 determined at run time without requiring the executable to be
23126 relocated, which is a benefit to embedded applications with tight
23127 memory constraints.  Data that can be modified is not affected by this
23128 option.
23130 Note, using this feature reserves a register, usually @code{r13}, for
23131 the constant data base address.  This can result in slower and/or
23132 larger code, especially in complicated functions.
23134 The actual register chosen to hold the constant data base address
23135 depends upon whether the @option{-msmall-data-limit} and/or the
23136 @option{-mint-register} command-line options are enabled.  Starting
23137 with register @code{r13} and proceeding downwards, registers are
23138 allocated first to satisfy the requirements of @option{-mint-register},
23139 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23140 is possible for the small data area register to be @code{r8} if both
23141 @option{-mint-register=4} and @option{-mpid} are specified on the
23142 command line.
23144 By default this feature is not enabled.  The default can be restored
23145 via the @option{-mno-pid} command-line option.
23147 @item -mno-warn-multiple-fast-interrupts
23148 @itemx -mwarn-multiple-fast-interrupts
23149 @opindex mno-warn-multiple-fast-interrupts
23150 @opindex mwarn-multiple-fast-interrupts
23151 Prevents GCC from issuing a warning message if it finds more than one
23152 fast interrupt handler when it is compiling a file.  The default is to
23153 issue a warning for each extra fast interrupt handler found, as the RX
23154 only supports one such interrupt.
23156 @item -mallow-string-insns
23157 @itemx -mno-allow-string-insns
23158 @opindex mallow-string-insns
23159 @opindex mno-allow-string-insns
23160 Enables or disables the use of the string manipulation instructions
23161 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23162 @code{SWHILE} and also the @code{RMPA} instruction.  These
23163 instructions may prefetch data, which is not safe to do if accessing
23164 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23165 for more information).
23167 The default is to allow these instructions, but it is not possible for
23168 GCC to reliably detect all circumstances where a string instruction
23169 might be used to access an I/O register, so their use cannot be
23170 disabled automatically.  Instead it is reliant upon the programmer to
23171 use the @option{-mno-allow-string-insns} option if their program
23172 accesses I/O space.
23174 When the instructions are enabled GCC defines the C preprocessor
23175 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23176 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23178 @item -mjsr
23179 @itemx -mno-jsr
23180 @opindex mjsr
23181 @opindex mno-jsr
23182 Use only (or not only) @code{JSR} instructions to access functions.
23183 This option can be used when code size exceeds the range of @code{BSR}
23184 instructions.  Note that @option{-mno-jsr} does not mean to not use
23185 @code{JSR} but instead means that any type of branch may be used.
23186 @end table
23188 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23189 has special significance to the RX port when used with the
23190 @code{interrupt} function attribute.  This attribute indicates a
23191 function intended to process fast interrupts.  GCC ensures
23192 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23193 and/or @code{r13} and only provided that the normal use of the
23194 corresponding registers have been restricted via the
23195 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23196 options.
23198 @node S/390 and zSeries Options
23199 @subsection S/390 and zSeries Options
23200 @cindex S/390 and zSeries Options
23202 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23204 @table @gcctabopt
23205 @item -mhard-float
23206 @itemx -msoft-float
23207 @opindex mhard-float
23208 @opindex msoft-float
23209 Use (do not use) the hardware floating-point instructions and registers
23210 for floating-point operations.  When @option{-msoft-float} is specified,
23211 functions in @file{libgcc.a} are used to perform floating-point
23212 operations.  When @option{-mhard-float} is specified, the compiler
23213 generates IEEE floating-point instructions.  This is the default.
23215 @item -mhard-dfp
23216 @itemx -mno-hard-dfp
23217 @opindex mhard-dfp
23218 @opindex mno-hard-dfp
23219 Use (do not use) the hardware decimal-floating-point instructions for
23220 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23221 specified, functions in @file{libgcc.a} are used to perform
23222 decimal-floating-point operations.  When @option{-mhard-dfp} is
23223 specified, the compiler generates decimal-floating-point hardware
23224 instructions.  This is the default for @option{-march=z9-ec} or higher.
23226 @item -mlong-double-64
23227 @itemx -mlong-double-128
23228 @opindex mlong-double-64
23229 @opindex mlong-double-128
23230 These switches control the size of @code{long double} type. A size
23231 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23232 type. This is the default.
23234 @item -mbackchain
23235 @itemx -mno-backchain
23236 @opindex mbackchain
23237 @opindex mno-backchain
23238 Store (do not store) the address of the caller's frame as backchain pointer
23239 into the callee's stack frame.
23240 A backchain may be needed to allow debugging using tools that do not understand
23241 DWARF call frame information.
23242 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23243 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23244 the backchain is placed into the topmost word of the 96/160 byte register
23245 save area.
23247 In general, code compiled with @option{-mbackchain} is call-compatible with
23248 code compiled with @option{-mmo-backchain}; however, use of the backchain
23249 for debugging purposes usually requires that the whole binary is built with
23250 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23251 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23252 to build a linux kernel use @option{-msoft-float}.
23254 The default is to not maintain the backchain.
23256 @item -mpacked-stack
23257 @itemx -mno-packed-stack
23258 @opindex mpacked-stack
23259 @opindex mno-packed-stack
23260 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23261 specified, the compiler uses the all fields of the 96/160 byte register save
23262 area only for their default purpose; unused fields still take up stack space.
23263 When @option{-mpacked-stack} is specified, register save slots are densely
23264 packed at the top of the register save area; unused space is reused for other
23265 purposes, allowing for more efficient use of the available stack space.
23266 However, when @option{-mbackchain} is also in effect, the topmost word of
23267 the save area is always used to store the backchain, and the return address
23268 register is always saved two words below the backchain.
23270 As long as the stack frame backchain is not used, code generated with
23271 @option{-mpacked-stack} is call-compatible with code generated with
23272 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23273 S/390 or zSeries generated code that uses the stack frame backchain at run
23274 time, not just for debugging purposes.  Such code is not call-compatible
23275 with code compiled with @option{-mpacked-stack}.  Also, note that the
23276 combination of @option{-mbackchain},
23277 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23278 to build a linux kernel use @option{-msoft-float}.
23280 The default is to not use the packed stack layout.
23282 @item -msmall-exec
23283 @itemx -mno-small-exec
23284 @opindex msmall-exec
23285 @opindex mno-small-exec
23286 Generate (or do not generate) code using the @code{bras} instruction
23287 to do subroutine calls.
23288 This only works reliably if the total executable size does not
23289 exceed 64k.  The default is to use the @code{basr} instruction instead,
23290 which does not have this limitation.
23292 @item -m64
23293 @itemx -m31
23294 @opindex m64
23295 @opindex m31
23296 When @option{-m31} is specified, generate code compliant to the
23297 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23298 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23299 particular to generate 64-bit instructions.  For the @samp{s390}
23300 targets, the default is @option{-m31}, while the @samp{s390x}
23301 targets default to @option{-m64}.
23303 @item -mzarch
23304 @itemx -mesa
23305 @opindex mzarch
23306 @opindex mesa
23307 When @option{-mzarch} is specified, generate code using the
23308 instructions available on z/Architecture.
23309 When @option{-mesa} is specified, generate code using the
23310 instructions available on ESA/390.  Note that @option{-mesa} is
23311 not possible with @option{-m64}.
23312 When generating code compliant to the GNU/Linux for S/390 ABI,
23313 the default is @option{-mesa}.  When generating code compliant
23314 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23316 @item -mhtm
23317 @itemx -mno-htm
23318 @opindex mhtm
23319 @opindex mno-htm
23320 The @option{-mhtm} option enables a set of builtins making use of
23321 instructions available with the transactional execution facility
23322 introduced with the IBM zEnterprise EC12 machine generation
23323 @ref{S/390 System z Built-in Functions}.
23324 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23326 @item -mvx
23327 @itemx -mno-vx
23328 @opindex mvx
23329 @opindex mno-vx
23330 When @option{-mvx} is specified, generate code using the instructions
23331 available with the vector extension facility introduced with the IBM
23332 z13 machine generation.
23333 This option changes the ABI for some vector type values with regard to
23334 alignment and calling conventions.  In case vector type values are
23335 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23336 command will be added to mark the resulting binary with the ABI used.
23337 @option{-mvx} is enabled by default when using @option{-march=z13}.
23339 @item -mzvector
23340 @itemx -mno-zvector
23341 @opindex mzvector
23342 @opindex mno-zvector
23343 The @option{-mzvector} option enables vector language extensions and
23344 builtins using instructions available with the vector extension
23345 facility introduced with the IBM z13 machine generation.
23346 This option adds support for @samp{vector} to be used as a keyword to
23347 define vector type variables and arguments.  @samp{vector} is only
23348 available when GNU extensions are enabled.  It will not be expanded
23349 when requesting strict standard compliance e.g. with @option{-std=c99}.
23350 In addition to the GCC low-level builtins @option{-mzvector} enables
23351 a set of builtins added for compatibility with AltiVec-style
23352 implementations like Power and Cell.  In order to make use of these
23353 builtins the header file @file{vecintrin.h} needs to be included.
23354 @option{-mzvector} is disabled by default.
23356 @item -mmvcle
23357 @itemx -mno-mvcle
23358 @opindex mmvcle
23359 @opindex mno-mvcle
23360 Generate (or do not generate) code using the @code{mvcle} instruction
23361 to perform block moves.  When @option{-mno-mvcle} is specified,
23362 use a @code{mvc} loop instead.  This is the default unless optimizing for
23363 size.
23365 @item -mdebug
23366 @itemx -mno-debug
23367 @opindex mdebug
23368 @opindex mno-debug
23369 Print (or do not print) additional debug information when compiling.
23370 The default is to not print debug information.
23372 @item -march=@var{cpu-type}
23373 @opindex march
23374 Generate code that runs on @var{cpu-type}, which is the name of a
23375 system representing a certain processor type.  Possible values for
23376 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23377 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23378 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23379 @samp{native}.
23381 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23382 @samp{g6} are deprecated and will be removed with future releases.
23384 Specifying @samp{native} as cpu type can be used to select the best
23385 architecture option for the host processor.
23386 @option{-march=native} has no effect if GCC does not recognize the
23387 processor.
23389 @item -mtune=@var{cpu-type}
23390 @opindex mtune
23391 Tune to @var{cpu-type} everything applicable about the generated code,
23392 except for the ABI and the set of available instructions.
23393 The list of @var{cpu-type} values is the same as for @option{-march}.
23394 The default is the value used for @option{-march}.
23396 @item -mtpf-trace
23397 @itemx -mno-tpf-trace
23398 @opindex mtpf-trace
23399 @opindex mno-tpf-trace
23400 Generate code that adds (does not add) in TPF OS specific branches to trace
23401 routines in the operating system.  This option is off by default, even
23402 when compiling for the TPF OS@.
23404 @item -mfused-madd
23405 @itemx -mno-fused-madd
23406 @opindex mfused-madd
23407 @opindex mno-fused-madd
23408 Generate code that uses (does not use) the floating-point multiply and
23409 accumulate instructions.  These instructions are generated by default if
23410 hardware floating point is used.
23412 @item -mwarn-framesize=@var{framesize}
23413 @opindex mwarn-framesize
23414 Emit a warning if the current function exceeds the given frame size.  Because
23415 this is a compile-time check it doesn't need to be a real problem when the program
23416 runs.  It is intended to identify functions that most probably cause
23417 a stack overflow.  It is useful to be used in an environment with limited stack
23418 size e.g.@: the linux kernel.
23420 @item -mwarn-dynamicstack
23421 @opindex mwarn-dynamicstack
23422 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23423 arrays.  This is generally a bad idea with a limited stack size.
23425 @item -mstack-guard=@var{stack-guard}
23426 @itemx -mstack-size=@var{stack-size}
23427 @opindex mstack-guard
23428 @opindex mstack-size
23429 If these options are provided the S/390 back end emits additional instructions in
23430 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23431 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23432 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23433 the frame size of the compiled function is chosen.
23434 These options are intended to be used to help debugging stack overflow problems.
23435 The additionally emitted code causes only little overhead and hence can also be
23436 used in production-like systems without greater performance degradation.  The given
23437 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23438 @var{stack-guard} without exceeding 64k.
23439 In order to be efficient the extra code makes the assumption that the stack starts
23440 at an address aligned to the value given by @var{stack-size}.
23441 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23443 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23444 @opindex mhotpatch
23445 If the hotpatch option is enabled, a ``hot-patching'' function
23446 prologue is generated for all functions in the compilation unit.
23447 The funtion label is prepended with the given number of two-byte
23448 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23449 the label, 2 * @var{post-halfwords} bytes are appended, using the
23450 largest NOP like instructions the architecture allows (maximum
23451 1000000).
23453 If both arguments are zero, hotpatching is disabled.
23455 This option can be overridden for individual functions with the
23456 @code{hotpatch} attribute.
23457 @end table
23459 @node Score Options
23460 @subsection Score Options
23461 @cindex Score Options
23463 These options are defined for Score implementations:
23465 @table @gcctabopt
23466 @item -meb
23467 @opindex meb
23468 Compile code for big-endian mode.  This is the default.
23470 @item -mel
23471 @opindex mel
23472 Compile code for little-endian mode.
23474 @item -mnhwloop
23475 @opindex mnhwloop
23476 Disable generation of @code{bcnz} instructions.
23478 @item -muls
23479 @opindex muls
23480 Enable generation of unaligned load and store instructions.
23482 @item -mmac
23483 @opindex mmac
23484 Enable the use of multiply-accumulate instructions. Disabled by default.
23486 @item -mscore5
23487 @opindex mscore5
23488 Specify the SCORE5 as the target architecture.
23490 @item -mscore5u
23491 @opindex mscore5u
23492 Specify the SCORE5U of the target architecture.
23494 @item -mscore7
23495 @opindex mscore7
23496 Specify the SCORE7 as the target architecture. This is the default.
23498 @item -mscore7d
23499 @opindex mscore7d
23500 Specify the SCORE7D as the target architecture.
23501 @end table
23503 @node SH Options
23504 @subsection SH Options
23506 These @samp{-m} options are defined for the SH implementations:
23508 @table @gcctabopt
23509 @item -m1
23510 @opindex m1
23511 Generate code for the SH1.
23513 @item -m2
23514 @opindex m2
23515 Generate code for the SH2.
23517 @item -m2e
23518 Generate code for the SH2e.
23520 @item -m2a-nofpu
23521 @opindex m2a-nofpu
23522 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23523 that the floating-point unit is not used.
23525 @item -m2a-single-only
23526 @opindex m2a-single-only
23527 Generate code for the SH2a-FPU, in such a way that no double-precision
23528 floating-point operations are used.
23530 @item -m2a-single
23531 @opindex m2a-single
23532 Generate code for the SH2a-FPU assuming the floating-point unit is in
23533 single-precision mode by default.
23535 @item -m2a
23536 @opindex m2a
23537 Generate code for the SH2a-FPU assuming the floating-point unit is in
23538 double-precision mode by default.
23540 @item -m3
23541 @opindex m3
23542 Generate code for the SH3.
23544 @item -m3e
23545 @opindex m3e
23546 Generate code for the SH3e.
23548 @item -m4-nofpu
23549 @opindex m4-nofpu
23550 Generate code for the SH4 without a floating-point unit.
23552 @item -m4-single-only
23553 @opindex m4-single-only
23554 Generate code for the SH4 with a floating-point unit that only
23555 supports single-precision arithmetic.
23557 @item -m4-single
23558 @opindex m4-single
23559 Generate code for the SH4 assuming the floating-point unit is in
23560 single-precision mode by default.
23562 @item -m4
23563 @opindex m4
23564 Generate code for the SH4.
23566 @item -m4-100
23567 @opindex m4-100
23568 Generate code for SH4-100.
23570 @item -m4-100-nofpu
23571 @opindex m4-100-nofpu
23572 Generate code for SH4-100 in such a way that the
23573 floating-point unit is not used.
23575 @item -m4-100-single
23576 @opindex m4-100-single
23577 Generate code for SH4-100 assuming the floating-point unit is in
23578 single-precision mode by default.
23580 @item -m4-100-single-only
23581 @opindex m4-100-single-only
23582 Generate code for SH4-100 in such a way that no double-precision
23583 floating-point operations are used.
23585 @item -m4-200
23586 @opindex m4-200
23587 Generate code for SH4-200.
23589 @item -m4-200-nofpu
23590 @opindex m4-200-nofpu
23591 Generate code for SH4-200 without in such a way that the
23592 floating-point unit is not used.
23594 @item -m4-200-single
23595 @opindex m4-200-single
23596 Generate code for SH4-200 assuming the floating-point unit is in
23597 single-precision mode by default.
23599 @item -m4-200-single-only
23600 @opindex m4-200-single-only
23601 Generate code for SH4-200 in such a way that no double-precision
23602 floating-point operations are used.
23604 @item -m4-300
23605 @opindex m4-300
23606 Generate code for SH4-300.
23608 @item -m4-300-nofpu
23609 @opindex m4-300-nofpu
23610 Generate code for SH4-300 without in such a way that the
23611 floating-point unit is not used.
23613 @item -m4-300-single
23614 @opindex m4-300-single
23615 Generate code for SH4-300 in such a way that no double-precision
23616 floating-point operations are used.
23618 @item -m4-300-single-only
23619 @opindex m4-300-single-only
23620 Generate code for SH4-300 in such a way that no double-precision
23621 floating-point operations are used.
23623 @item -m4-340
23624 @opindex m4-340
23625 Generate code for SH4-340 (no MMU, no FPU).
23627 @item -m4-500
23628 @opindex m4-500
23629 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23630 assembler.
23632 @item -m4a-nofpu
23633 @opindex m4a-nofpu
23634 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23635 floating-point unit is not used.
23637 @item -m4a-single-only
23638 @opindex m4a-single-only
23639 Generate code for the SH4a, in such a way that no double-precision
23640 floating-point operations are used.
23642 @item -m4a-single
23643 @opindex m4a-single
23644 Generate code for the SH4a assuming the floating-point unit is in
23645 single-precision mode by default.
23647 @item -m4a
23648 @opindex m4a
23649 Generate code for the SH4a.
23651 @item -m4al
23652 @opindex m4al
23653 Same as @option{-m4a-nofpu}, except that it implicitly passes
23654 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23655 instructions at the moment.
23657 @item -mb
23658 @opindex mb
23659 Compile code for the processor in big-endian mode.
23661 @item -ml
23662 @opindex ml
23663 Compile code for the processor in little-endian mode.
23665 @item -mdalign
23666 @opindex mdalign
23667 Align doubles at 64-bit boundaries.  Note that this changes the calling
23668 conventions, and thus some functions from the standard C library do
23669 not work unless you recompile it first with @option{-mdalign}.
23671 @item -mrelax
23672 @opindex mrelax
23673 Shorten some address references at link time, when possible; uses the
23674 linker option @option{-relax}.
23676 @item -mbigtable
23677 @opindex mbigtable
23678 Use 32-bit offsets in @code{switch} tables.  The default is to use
23679 16-bit offsets.
23681 @item -mbitops
23682 @opindex mbitops
23683 Enable the use of bit manipulation instructions on SH2A.
23685 @item -mfmovd
23686 @opindex mfmovd
23687 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23688 alignment constraints.
23690 @item -mrenesas
23691 @opindex mrenesas
23692 Comply with the calling conventions defined by Renesas.
23694 @item -mno-renesas
23695 @opindex mno-renesas
23696 Comply with the calling conventions defined for GCC before the Renesas
23697 conventions were available.  This option is the default for all
23698 targets of the SH toolchain.
23700 @item -mnomacsave
23701 @opindex mnomacsave
23702 Mark the @code{MAC} register as call-clobbered, even if
23703 @option{-mrenesas} is given.
23705 @item -mieee
23706 @itemx -mno-ieee
23707 @opindex mieee
23708 @opindex mno-ieee
23709 Control the IEEE compliance of floating-point comparisons, which affects the
23710 handling of cases where the result of a comparison is unordered.  By default
23711 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23712 enabled @option{-mno-ieee} is implicitly set, which results in faster
23713 floating-point greater-equal and less-equal comparisons.  The implicit settings
23714 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23716 @item -minline-ic_invalidate
23717 @opindex minline-ic_invalidate
23718 Inline code to invalidate instruction cache entries after setting up
23719 nested function trampolines.
23720 This option has no effect if @option{-musermode} is in effect and the selected
23721 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23722 instruction.
23723 If the selected code generation option does not allow the use of the @code{icbi}
23724 instruction, and @option{-musermode} is not in effect, the inlined code
23725 manipulates the instruction cache address array directly with an associative
23726 write.  This not only requires privileged mode at run time, but it also
23727 fails if the cache line had been mapped via the TLB and has become unmapped.
23729 @item -misize
23730 @opindex misize
23731 Dump instruction size and location in the assembly code.
23733 @item -mpadstruct
23734 @opindex mpadstruct
23735 This option is deprecated.  It pads structures to multiple of 4 bytes,
23736 which is incompatible with the SH ABI@.
23738 @item -matomic-model=@var{model}
23739 @opindex matomic-model=@var{model}
23740 Sets the model of atomic operations and additional parameters as a comma
23741 separated list.  For details on the atomic built-in functions see
23742 @ref{__atomic Builtins}.  The following models and parameters are supported:
23744 @table @samp
23746 @item none
23747 Disable compiler generated atomic sequences and emit library calls for atomic
23748 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23750 @item soft-gusa
23751 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23752 built-in functions.  The generated atomic sequences require additional support
23753 from the interrupt/exception handling code of the system and are only suitable
23754 for SH3* and SH4* single-core systems.  This option is enabled by default when
23755 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23756 this option also partially utilizes the hardware atomic instructions
23757 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23758 @samp{strict} is specified.  
23760 @item soft-tcb
23761 Generate software atomic sequences that use a variable in the thread control
23762 block.  This is a variation of the gUSA sequences which can also be used on
23763 SH1* and SH2* targets.  The generated atomic sequences require additional
23764 support from the interrupt/exception handling code of the system and are only
23765 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23766 parameter has to be specified as well.
23768 @item soft-imask
23769 Generate software atomic sequences that temporarily disable interrupts by
23770 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23771 in privileged mode and is only suitable for single-core systems.  Additional
23772 support from the interrupt/exception handling code of the system is not
23773 required.  This model is enabled by default when the target is
23774 @code{sh*-*-linux*} and SH1* or SH2*.
23776 @item hard-llcs
23777 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23778 instructions only.  This is only available on SH4A and is suitable for
23779 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23780 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23781 Code compiled with this option is also compatible with other software
23782 atomic model interrupt/exception handling systems if executed on an SH4A
23783 system.  Additional support from the interrupt/exception handling code of the
23784 system is not required for this model.
23786 @item gbr-offset=
23787 This parameter specifies the offset in bytes of the variable in the thread
23788 control block structure that should be used by the generated atomic sequences
23789 when the @samp{soft-tcb} model has been selected.  For other models this
23790 parameter is ignored.  The specified value must be an integer multiple of four
23791 and in the range 0-1020.
23793 @item strict
23794 This parameter prevents mixed usage of multiple atomic models, even if they
23795 are compatible, and makes the compiler generate atomic sequences of the
23796 specified model only.
23798 @end table
23800 @item -mtas
23801 @opindex mtas
23802 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23803 Notice that depending on the particular hardware and software configuration
23804 this can degrade overall performance due to the operand cache line flushes
23805 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23806 processors the @code{tas.b} instruction must be used with caution since it
23807 can result in data corruption for certain cache configurations.
23809 @item -mprefergot
23810 @opindex mprefergot
23811 When generating position-independent code, emit function calls using
23812 the Global Offset Table instead of the Procedure Linkage Table.
23814 @item -musermode
23815 @itemx -mno-usermode
23816 @opindex musermode
23817 @opindex mno-usermode
23818 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23819 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23820 inlined code would not work in user mode.  @option{-musermode} is the default
23821 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23822 @option{-musermode} has no effect, since there is no user mode.
23824 @item -multcost=@var{number}
23825 @opindex multcost=@var{number}
23826 Set the cost to assume for a multiply insn.
23828 @item -mdiv=@var{strategy}
23829 @opindex mdiv=@var{strategy}
23830 Set the division strategy to be used for integer division operations.
23831 @var{strategy} can be one of: 
23833 @table @samp
23835 @item call-div1
23836 Calls a library function that uses the single-step division instruction
23837 @code{div1} to perform the operation.  Division by zero calculates an
23838 unspecified result and does not trap.  This is the default except for SH4,
23839 SH2A and SHcompact.
23841 @item call-fp
23842 Calls a library function that performs the operation in double precision
23843 floating point.  Division by zero causes a floating-point exception.  This is
23844 the default for SHcompact with FPU.  Specifying this for targets that do not
23845 have a double precision FPU defaults to @code{call-div1}.
23847 @item call-table
23848 Calls a library function that uses a lookup table for small divisors and
23849 the @code{div1} instruction with case distinction for larger divisors.  Division
23850 by zero calculates an unspecified result and does not trap.  This is the default
23851 for SH4.  Specifying this for targets that do not have dynamic shift
23852 instructions defaults to @code{call-div1}.
23854 @end table
23856 When a division strategy has not been specified the default strategy is
23857 selected based on the current target.  For SH2A the default strategy is to
23858 use the @code{divs} and @code{divu} instructions instead of library function
23859 calls.
23861 @item -maccumulate-outgoing-args
23862 @opindex maccumulate-outgoing-args
23863 Reserve space once for outgoing arguments in the function prologue rather
23864 than around each call.  Generally beneficial for performance and size.  Also
23865 needed for unwinding to avoid changing the stack frame around conditional code.
23867 @item -mdivsi3_libfunc=@var{name}
23868 @opindex mdivsi3_libfunc=@var{name}
23869 Set the name of the library function used for 32-bit signed division to
23870 @var{name}.
23871 This only affects the name used in the @samp{call} division strategies, and
23872 the compiler still expects the same sets of input/output/clobbered registers as
23873 if this option were not present.
23875 @item -mfixed-range=@var{register-range}
23876 @opindex mfixed-range
23877 Generate code treating the given register range as fixed registers.
23878 A fixed register is one that the register allocator can not use.  This is
23879 useful when compiling kernel code.  A register range is specified as
23880 two registers separated by a dash.  Multiple register ranges can be
23881 specified separated by a comma.
23883 @item -mbranch-cost=@var{num}
23884 @opindex mbranch-cost=@var{num}
23885 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23886 make the compiler try to generate more branch-free code if possible.  
23887 If not specified the value is selected depending on the processor type that
23888 is being compiled for.
23890 @item -mzdcbranch
23891 @itemx -mno-zdcbranch
23892 @opindex mzdcbranch
23893 @opindex mno-zdcbranch
23894 Assume (do not assume) that zero displacement conditional branch instructions
23895 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23896 compiler prefers zero displacement branch code sequences.  This is
23897 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23898 disabled by specifying @option{-mno-zdcbranch}.
23900 @item -mcbranch-force-delay-slot
23901 @opindex mcbranch-force-delay-slot
23902 Force the usage of delay slots for conditional branches, which stuffs the delay
23903 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23904 this option is disabled.  It can be enabled to work around hardware bugs as
23905 found in the original SH7055.
23907 @item -mfused-madd
23908 @itemx -mno-fused-madd
23909 @opindex mfused-madd
23910 @opindex mno-fused-madd
23911 Generate code that uses (does not use) the floating-point multiply and
23912 accumulate instructions.  These instructions are generated by default
23913 if hardware floating point is used.  The machine-dependent
23914 @option{-mfused-madd} option is now mapped to the machine-independent
23915 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23916 mapped to @option{-ffp-contract=off}.
23918 @item -mfsca
23919 @itemx -mno-fsca
23920 @opindex mfsca
23921 @opindex mno-fsca
23922 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23923 and cosine approximations.  The option @option{-mfsca} must be used in
23924 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23925 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23926 approximations even if @option{-funsafe-math-optimizations} is in effect.
23928 @item -mfsrra
23929 @itemx -mno-fsrra
23930 @opindex mfsrra
23931 @opindex mno-fsrra
23932 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23933 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23934 in combination with @option{-funsafe-math-optimizations} and
23935 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23936 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23937 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23938 in effect.
23940 @item -mpretend-cmove
23941 @opindex mpretend-cmove
23942 Prefer zero-displacement conditional branches for conditional move instruction
23943 patterns.  This can result in faster code on the SH4 processor.
23945 @item -mfdpic
23946 @opindex fdpic
23947 Generate code using the FDPIC ABI.
23949 @end table
23951 @node Solaris 2 Options
23952 @subsection Solaris 2 Options
23953 @cindex Solaris 2 options
23955 These @samp{-m} options are supported on Solaris 2:
23957 @table @gcctabopt
23958 @item -mclear-hwcap
23959 @opindex mclear-hwcap
23960 @option{-mclear-hwcap} tells the compiler to remove the hardware
23961 capabilities generated by the Solaris assembler.  This is only necessary
23962 when object files use ISA extensions not supported by the current
23963 machine, but check at runtime whether or not to use them.
23965 @item -mimpure-text
23966 @opindex mimpure-text
23967 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23968 the compiler to not pass @option{-z text} to the linker when linking a
23969 shared object.  Using this option, you can link position-dependent
23970 code into a shared object.
23972 @option{-mimpure-text} suppresses the ``relocations remain against
23973 allocatable but non-writable sections'' linker error message.
23974 However, the necessary relocations trigger copy-on-write, and the
23975 shared object is not actually shared across processes.  Instead of
23976 using @option{-mimpure-text}, you should compile all source code with
23977 @option{-fpic} or @option{-fPIC}.
23979 @end table
23981 These switches are supported in addition to the above on Solaris 2:
23983 @table @gcctabopt
23984 @item -pthreads
23985 @opindex pthreads
23986 This is a synonym for @option{-pthread}.
23987 @end table
23989 @node SPARC Options
23990 @subsection SPARC Options
23991 @cindex SPARC options
23993 These @samp{-m} options are supported on the SPARC:
23995 @table @gcctabopt
23996 @item -mno-app-regs
23997 @itemx -mapp-regs
23998 @opindex mno-app-regs
23999 @opindex mapp-regs
24000 Specify @option{-mapp-regs} to generate output using the global registers
24001 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24002 global register 1, each global register 2 through 4 is then treated as an
24003 allocable register that is clobbered by function calls.  This is the default.
24005 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24006 specify @option{-mno-app-regs}.  You should compile libraries and system
24007 software with this option.
24009 @item -mflat
24010 @itemx -mno-flat
24011 @opindex mflat
24012 @opindex mno-flat
24013 With @option{-mflat}, the compiler does not generate save/restore instructions
24014 and uses a ``flat'' or single register window model.  This model is compatible
24015 with the regular register window model.  The local registers and the input
24016 registers (0--5) are still treated as ``call-saved'' registers and are
24017 saved on the stack as needed.
24019 With @option{-mno-flat} (the default), the compiler generates save/restore
24020 instructions (except for leaf functions).  This is the normal operating mode.
24022 @item -mfpu
24023 @itemx -mhard-float
24024 @opindex mfpu
24025 @opindex mhard-float
24026 Generate output containing floating-point instructions.  This is the
24027 default.
24029 @item -mno-fpu
24030 @itemx -msoft-float
24031 @opindex mno-fpu
24032 @opindex msoft-float
24033 Generate output containing library calls for floating point.
24034 @strong{Warning:} the requisite libraries are not available for all SPARC
24035 targets.  Normally the facilities of the machine's usual C compiler are
24036 used, but this cannot be done directly in cross-compilation.  You must make
24037 your own arrangements to provide suitable library functions for
24038 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24039 @samp{sparclite-*-*} do provide software floating-point support.
24041 @option{-msoft-float} changes the calling convention in the output file;
24042 therefore, it is only useful if you compile @emph{all} of a program with
24043 this option.  In particular, you need to compile @file{libgcc.a}, the
24044 library that comes with GCC, with @option{-msoft-float} in order for
24045 this to work.
24047 @item -mhard-quad-float
24048 @opindex mhard-quad-float
24049 Generate output containing quad-word (long double) floating-point
24050 instructions.
24052 @item -msoft-quad-float
24053 @opindex msoft-quad-float
24054 Generate output containing library calls for quad-word (long double)
24055 floating-point instructions.  The functions called are those specified
24056 in the SPARC ABI@.  This is the default.
24058 As of this writing, there are no SPARC implementations that have hardware
24059 support for the quad-word floating-point instructions.  They all invoke
24060 a trap handler for one of these instructions, and then the trap handler
24061 emulates the effect of the instruction.  Because of the trap handler overhead,
24062 this is much slower than calling the ABI library routines.  Thus the
24063 @option{-msoft-quad-float} option is the default.
24065 @item -mno-unaligned-doubles
24066 @itemx -munaligned-doubles
24067 @opindex mno-unaligned-doubles
24068 @opindex munaligned-doubles
24069 Assume that doubles have 8-byte alignment.  This is the default.
24071 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24072 alignment only if they are contained in another type, or if they have an
24073 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24074 Specifying this option avoids some rare compatibility problems with code
24075 generated by other compilers.  It is not the default because it results
24076 in a performance loss, especially for floating-point code.
24078 @item -muser-mode
24079 @itemx -mno-user-mode
24080 @opindex muser-mode
24081 @opindex mno-user-mode
24082 Do not generate code that can only run in supervisor mode.  This is relevant
24083 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24084 is the default.
24086 @item -mfaster-structs
24087 @itemx -mno-faster-structs
24088 @opindex mfaster-structs
24089 @opindex mno-faster-structs
24090 With @option{-mfaster-structs}, the compiler assumes that structures
24091 should have 8-byte alignment.  This enables the use of pairs of
24092 @code{ldd} and @code{std} instructions for copies in structure
24093 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24094 However, the use of this changed alignment directly violates the SPARC
24095 ABI@.  Thus, it's intended only for use on targets where the developer
24096 acknowledges that their resulting code is not directly in line with
24097 the rules of the ABI@.
24099 @item -mstd-struct-return
24100 @itemx -mno-std-struct-return
24101 @opindex mstd-struct-return
24102 @opindex mno-std-struct-return
24103 With @option{-mstd-struct-return}, the compiler generates checking code
24104 in functions returning structures or unions to detect size mismatches
24105 between the two sides of function calls, as per the 32-bit ABI@.
24107 The default is @option{-mno-std-struct-return}.  This option has no effect
24108 in 64-bit mode.
24110 @item -mlra
24111 @itemx -mno-lra
24112 @opindex mlra
24113 @opindex mno-lra
24114 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24115 so @option{-mno-lra} needs to be passed to get old Reload.
24117 @item -mcpu=@var{cpu_type}
24118 @opindex mcpu
24119 Set the instruction set, register set, and instruction scheduling parameters
24120 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24121 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24122 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24123 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24124 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24125 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24127 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24128 which selects the best architecture option for the host processor.
24129 @option{-mcpu=native} has no effect if GCC does not recognize
24130 the processor.
24132 Default instruction scheduling parameters are used for values that select
24133 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24134 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24136 Here is a list of each supported architecture and their supported
24137 implementations.
24139 @table @asis
24140 @item v7
24141 cypress, leon3v7
24143 @item v8
24144 supersparc, hypersparc, leon, leon3
24146 @item sparclite
24147 f930, f934, sparclite86x
24149 @item sparclet
24150 tsc701
24152 @item v9
24153 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24154 niagara7, m8
24155 @end table
24157 By default (unless configured otherwise), GCC generates code for the V7
24158 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24159 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24160 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24161 SPARCStation 1, 2, IPX etc.
24163 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24164 architecture.  The only difference from V7 code is that the compiler emits
24165 the integer multiply and integer divide instructions which exist in SPARC-V8
24166 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24167 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24168 2000 series.
24170 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24171 the SPARC architecture.  This adds the integer multiply, integer divide step
24172 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24173 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24174 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24175 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24176 MB86934 chip, which is the more recent SPARClite with FPU@.
24178 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24179 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24180 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24181 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24182 optimizes it for the TEMIC SPARClet chip.
24184 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24185 architecture.  This adds 64-bit integer and floating-point move instructions,
24186 3 additional floating-point condition code registers and conditional move
24187 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24188 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24189 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24190 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24191 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24192 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24193 additionally optimizes it for Sun UltraSPARC T2 chips. With
24194 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24195 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24196 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24197 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24198 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24199 additionally optimizes it for Oracle M8 chips.
24201 @item -mtune=@var{cpu_type}
24202 @opindex mtune
24203 Set the instruction scheduling parameters for machine type
24204 @var{cpu_type}, but do not set the instruction set or register set that the
24205 option @option{-mcpu=@var{cpu_type}} does.
24207 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24208 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24209 that select a particular CPU implementation.  Those are
24210 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24211 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24212 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24213 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24214 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24215 and GNU/Linux toolchains, @samp{native} can also be used.
24217 @item -mv8plus
24218 @itemx -mno-v8plus
24219 @opindex mv8plus
24220 @opindex mno-v8plus
24221 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24222 difference from the V8 ABI is that the global and out registers are
24223 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24224 mode for all SPARC-V9 processors.
24226 @item -mvis
24227 @itemx -mno-vis
24228 @opindex mvis
24229 @opindex mno-vis
24230 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24231 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24233 @item -mvis2
24234 @itemx -mno-vis2
24235 @opindex mvis2
24236 @opindex mno-vis2
24237 With @option{-mvis2}, GCC generates code that takes advantage of
24238 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24239 default is @option{-mvis2} when targeting a cpu that supports such
24240 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24241 also sets @option{-mvis}.
24243 @item -mvis3
24244 @itemx -mno-vis3
24245 @opindex mvis3
24246 @opindex mno-vis3
24247 With @option{-mvis3}, GCC generates code that takes advantage of
24248 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24249 default is @option{-mvis3} when targeting a cpu that supports such
24250 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24251 also sets @option{-mvis2} and @option{-mvis}.
24253 @item -mvis4
24254 @itemx -mno-vis4
24255 @opindex mvis4
24256 @opindex mno-vis4
24257 With @option{-mvis4}, GCC generates code that takes advantage of
24258 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24259 default is @option{-mvis4} when targeting a cpu that supports such
24260 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24261 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24263 @item -mvis4b
24264 @itemx -mno-vis4b
24265 @opindex mvis4b
24266 @opindex mno-vis4b
24267 With @option{-mvis4b}, GCC generates code that takes advantage of
24268 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24269 the additional VIS instructions introduced in the Oracle SPARC
24270 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24271 cpu that supports such instructions, such as m8 and later.  Setting
24272 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24273 @option{-mvis2} and @option{-mvis}.
24275 @item -mcbcond
24276 @itemx -mno-cbcond
24277 @opindex mcbcond
24278 @opindex mno-cbcond
24279 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24280 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24281 when targeting a CPU that supports such instructions, such as Niagara-4 and
24282 later.
24284 @item -mfmaf
24285 @itemx -mno-fmaf
24286 @opindex mfmaf
24287 @opindex mno-fmaf
24288 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24289 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24290 when targeting a CPU that supports such instructions, such as Niagara-3 and
24291 later.
24293 @item -mfsmuld
24294 @itemx -mno-fsmuld
24295 @opindex mfsmuld
24296 @opindex mno-fsmuld
24297 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24298 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24299 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24300 or V9 with FPU except @option{-mcpu=leon}.
24302 @item -mpopc
24303 @itemx -mno-popc
24304 @opindex mpopc
24305 @opindex mno-popc
24306 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24307 Population Count instruction.  The default is @option{-mpopc}
24308 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24309 later.
24311 @item -msubxc
24312 @itemx -mno-subxc
24313 @opindex msubxc
24314 @opindex mno-subxc
24315 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24316 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24317 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24318 later.
24320 @item -mfix-at697f
24321 @opindex mfix-at697f
24322 Enable the documented workaround for the single erratum of the Atmel AT697F
24323 processor (which corresponds to erratum #13 of the AT697E processor).
24325 @item -mfix-ut699
24326 @opindex mfix-ut699
24327 Enable the documented workarounds for the floating-point errata and the data
24328 cache nullify errata of the UT699 processor.
24330 @item -mfix-ut700
24331 @opindex mfix-ut700
24332 Enable the documented workaround for the back-to-back store errata of
24333 the UT699E/UT700 processor.
24335 @item -mfix-gr712rc
24336 @opindex mfix-gr712rc
24337 Enable the documented workaround for the back-to-back store errata of
24338 the GR712RC processor.
24339 @end table
24341 These @samp{-m} options are supported in addition to the above
24342 on SPARC-V9 processors in 64-bit environments:
24344 @table @gcctabopt
24345 @item -m32
24346 @itemx -m64
24347 @opindex m32
24348 @opindex m64
24349 Generate code for a 32-bit or 64-bit environment.
24350 The 32-bit environment sets int, long and pointer to 32 bits.
24351 The 64-bit environment sets int to 32 bits and long and pointer
24352 to 64 bits.
24354 @item -mcmodel=@var{which}
24355 @opindex mcmodel
24356 Set the code model to one of
24358 @table @samp
24359 @item medlow
24360 The Medium/Low code model: 64-bit addresses, programs
24361 must be linked in the low 32 bits of memory.  Programs can be statically
24362 or dynamically linked.
24364 @item medmid
24365 The Medium/Middle code model: 64-bit addresses, programs
24366 must be linked in the low 44 bits of memory, the text and data segments must
24367 be less than 2GB in size and the data segment must be located within 2GB of
24368 the text segment.
24370 @item medany
24371 The Medium/Anywhere code model: 64-bit addresses, programs
24372 may be linked anywhere in memory, the text and data segments must be less
24373 than 2GB in size and the data segment must be located within 2GB of the
24374 text segment.
24376 @item embmedany
24377 The Medium/Anywhere code model for embedded systems:
24378 64-bit addresses, the text and data segments must be less than 2GB in
24379 size, both starting anywhere in memory (determined at link time).  The
24380 global register %g4 points to the base of the data segment.  Programs
24381 are statically linked and PIC is not supported.
24382 @end table
24384 @item -mmemory-model=@var{mem-model}
24385 @opindex mmemory-model
24386 Set the memory model in force on the processor to one of
24388 @table @samp
24389 @item default
24390 The default memory model for the processor and operating system.
24392 @item rmo
24393 Relaxed Memory Order
24395 @item pso
24396 Partial Store Order
24398 @item tso
24399 Total Store Order
24401 @item sc
24402 Sequential Consistency
24403 @end table
24405 These memory models are formally defined in Appendix D of the SPARC-V9
24406 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24408 @item -mstack-bias
24409 @itemx -mno-stack-bias
24410 @opindex mstack-bias
24411 @opindex mno-stack-bias
24412 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24413 frame pointer if present, are offset by @minus{}2047 which must be added back
24414 when making stack frame references.  This is the default in 64-bit mode.
24415 Otherwise, assume no such offset is present.
24416 @end table
24418 @node SPU Options
24419 @subsection SPU Options
24420 @cindex SPU options
24422 These @samp{-m} options are supported on the SPU:
24424 @table @gcctabopt
24425 @item -mwarn-reloc
24426 @itemx -merror-reloc
24427 @opindex mwarn-reloc
24428 @opindex merror-reloc
24430 The loader for SPU does not handle dynamic relocations.  By default, GCC
24431 gives an error when it generates code that requires a dynamic
24432 relocation.  @option{-mno-error-reloc} disables the error,
24433 @option{-mwarn-reloc} generates a warning instead.
24435 @item -msafe-dma
24436 @itemx -munsafe-dma
24437 @opindex msafe-dma
24438 @opindex munsafe-dma
24440 Instructions that initiate or test completion of DMA must not be
24441 reordered with respect to loads and stores of the memory that is being
24442 accessed.
24443 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24444 memory accesses, but that can lead to inefficient code in places where the
24445 memory is known to not change.  Rather than mark the memory as volatile,
24446 you can use @option{-msafe-dma} to tell the compiler to treat
24447 the DMA instructions as potentially affecting all memory.  
24449 @item -mbranch-hints
24450 @opindex mbranch-hints
24452 By default, GCC generates a branch hint instruction to avoid
24453 pipeline stalls for always-taken or probably-taken branches.  A hint
24454 is not generated closer than 8 instructions away from its branch.
24455 There is little reason to disable them, except for debugging purposes,
24456 or to make an object a little bit smaller.
24458 @item -msmall-mem
24459 @itemx -mlarge-mem
24460 @opindex msmall-mem
24461 @opindex mlarge-mem
24463 By default, GCC generates code assuming that addresses are never larger
24464 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24465 a full 32-bit address.
24467 @item -mstdmain
24468 @opindex mstdmain
24470 By default, GCC links against startup code that assumes the SPU-style
24471 main function interface (which has an unconventional parameter list).
24472 With @option{-mstdmain}, GCC links your program against startup
24473 code that assumes a C99-style interface to @code{main}, including a
24474 local copy of @code{argv} strings.
24476 @item -mfixed-range=@var{register-range}
24477 @opindex mfixed-range
24478 Generate code treating the given register range as fixed registers.
24479 A fixed register is one that the register allocator cannot use.  This is
24480 useful when compiling kernel code.  A register range is specified as
24481 two registers separated by a dash.  Multiple register ranges can be
24482 specified separated by a comma.
24484 @item -mea32
24485 @itemx -mea64
24486 @opindex mea32
24487 @opindex mea64
24488 Compile code assuming that pointers to the PPU address space accessed
24489 via the @code{__ea} named address space qualifier are either 32 or 64
24490 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24491 all object code in an executable must be compiled with the same setting.
24493 @item -maddress-space-conversion
24494 @itemx -mno-address-space-conversion
24495 @opindex maddress-space-conversion
24496 @opindex mno-address-space-conversion
24497 Allow/disallow treating the @code{__ea} address space as superset
24498 of the generic address space.  This enables explicit type casts
24499 between @code{__ea} and generic pointer as well as implicit
24500 conversions of generic pointers to @code{__ea} pointers.  The
24501 default is to allow address space pointer conversions.
24503 @item -mcache-size=@var{cache-size}
24504 @opindex mcache-size
24505 This option controls the version of libgcc that the compiler links to an
24506 executable and selects a software-managed cache for accessing variables
24507 in the @code{__ea} address space with a particular cache size.  Possible
24508 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24509 and @samp{128}.  The default cache size is 64KB.
24511 @item -matomic-updates
24512 @itemx -mno-atomic-updates
24513 @opindex matomic-updates
24514 @opindex mno-atomic-updates
24515 This option controls the version of libgcc that the compiler links to an
24516 executable and selects whether atomic updates to the software-managed
24517 cache of PPU-side variables are used.  If you use atomic updates, changes
24518 to a PPU variable from SPU code using the @code{__ea} named address space
24519 qualifier do not interfere with changes to other PPU variables residing
24520 in the same cache line from PPU code.  If you do not use atomic updates,
24521 such interference may occur; however, writing back cache lines is
24522 more efficient.  The default behavior is to use atomic updates.
24524 @item -mdual-nops
24525 @itemx -mdual-nops=@var{n}
24526 @opindex mdual-nops
24527 By default, GCC inserts NOPs to increase dual issue when it expects
24528 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24529 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24530 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24532 @item -mhint-max-nops=@var{n}
24533 @opindex mhint-max-nops
24534 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24535 be at least 8 instructions away from the branch it is affecting.  GCC
24536 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24537 generate the branch hint.
24539 @item -mhint-max-distance=@var{n}
24540 @opindex mhint-max-distance
24541 The encoding of the branch hint instruction limits the hint to be within
24542 256 instructions of the branch it is affecting.  By default, GCC makes
24543 sure it is within 125.
24545 @item -msafe-hints
24546 @opindex msafe-hints
24547 Work around a hardware bug that causes the SPU to stall indefinitely.
24548 By default, GCC inserts the @code{hbrp} instruction to make sure
24549 this stall won't happen.
24551 @end table
24553 @node System V Options
24554 @subsection Options for System V
24556 These additional options are available on System V Release 4 for
24557 compatibility with other compilers on those systems:
24559 @table @gcctabopt
24560 @item -G
24561 @opindex G
24562 Create a shared object.
24563 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24565 @item -Qy
24566 @opindex Qy
24567 Identify the versions of each tool used by the compiler, in a
24568 @code{.ident} assembler directive in the output.
24570 @item -Qn
24571 @opindex Qn
24572 Refrain from adding @code{.ident} directives to the output file (this is
24573 the default).
24575 @item -YP,@var{dirs}
24576 @opindex YP
24577 Search the directories @var{dirs}, and no others, for libraries
24578 specified with @option{-l}.
24580 @item -Ym,@var{dir}
24581 @opindex Ym
24582 Look in the directory @var{dir} to find the M4 preprocessor.
24583 The assembler uses this option.
24584 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24585 @c the generic assembler that comes with Solaris takes just -Ym.
24586 @end table
24588 @node TILE-Gx Options
24589 @subsection TILE-Gx Options
24590 @cindex TILE-Gx options
24592 These @samp{-m} options are supported on the TILE-Gx:
24594 @table @gcctabopt
24595 @item -mcmodel=small
24596 @opindex mcmodel=small
24597 Generate code for the small model.  The distance for direct calls is
24598 limited to 500M in either direction.  PC-relative addresses are 32
24599 bits.  Absolute addresses support the full address range.
24601 @item -mcmodel=large
24602 @opindex mcmodel=large
24603 Generate code for the large model.  There is no limitation on call
24604 distance, pc-relative addresses, or absolute addresses.
24606 @item -mcpu=@var{name}
24607 @opindex mcpu
24608 Selects the type of CPU to be targeted.  Currently the only supported
24609 type is @samp{tilegx}.
24611 @item -m32
24612 @itemx -m64
24613 @opindex m32
24614 @opindex m64
24615 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24616 environment sets int, long, and pointer to 32 bits.  The 64-bit
24617 environment sets int to 32 bits and long and pointer to 64 bits.
24619 @item -mbig-endian
24620 @itemx -mlittle-endian
24621 @opindex mbig-endian
24622 @opindex mlittle-endian
24623 Generate code in big/little endian mode, respectively.
24624 @end table
24626 @node TILEPro Options
24627 @subsection TILEPro Options
24628 @cindex TILEPro options
24630 These @samp{-m} options are supported on the TILEPro:
24632 @table @gcctabopt
24633 @item -mcpu=@var{name}
24634 @opindex mcpu
24635 Selects the type of CPU to be targeted.  Currently the only supported
24636 type is @samp{tilepro}.
24638 @item -m32
24639 @opindex m32
24640 Generate code for a 32-bit environment, which sets int, long, and
24641 pointer to 32 bits.  This is the only supported behavior so the flag
24642 is essentially ignored.
24643 @end table
24645 @node V850 Options
24646 @subsection V850 Options
24647 @cindex V850 Options
24649 These @samp{-m} options are defined for V850 implementations:
24651 @table @gcctabopt
24652 @item -mlong-calls
24653 @itemx -mno-long-calls
24654 @opindex mlong-calls
24655 @opindex mno-long-calls
24656 Treat all calls as being far away (near).  If calls are assumed to be
24657 far away, the compiler always loads the function's address into a
24658 register, and calls indirect through the pointer.
24660 @item -mno-ep
24661 @itemx -mep
24662 @opindex mno-ep
24663 @opindex mep
24664 Do not optimize (do optimize) basic blocks that use the same index
24665 pointer 4 or more times to copy pointer into the @code{ep} register, and
24666 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24667 option is on by default if you optimize.
24669 @item -mno-prolog-function
24670 @itemx -mprolog-function
24671 @opindex mno-prolog-function
24672 @opindex mprolog-function
24673 Do not use (do use) external functions to save and restore registers
24674 at the prologue and epilogue of a function.  The external functions
24675 are slower, but use less code space if more than one function saves
24676 the same number of registers.  The @option{-mprolog-function} option
24677 is on by default if you optimize.
24679 @item -mspace
24680 @opindex mspace
24681 Try to make the code as small as possible.  At present, this just turns
24682 on the @option{-mep} and @option{-mprolog-function} options.
24684 @item -mtda=@var{n}
24685 @opindex mtda
24686 Put static or global variables whose size is @var{n} bytes or less into
24687 the tiny data area that register @code{ep} points to.  The tiny data
24688 area can hold up to 256 bytes in total (128 bytes for byte references).
24690 @item -msda=@var{n}
24691 @opindex msda
24692 Put static or global variables whose size is @var{n} bytes or less into
24693 the small data area that register @code{gp} points to.  The small data
24694 area can hold up to 64 kilobytes.
24696 @item -mzda=@var{n}
24697 @opindex mzda
24698 Put static or global variables whose size is @var{n} bytes or less into
24699 the first 32 kilobytes of memory.
24701 @item -mv850
24702 @opindex mv850
24703 Specify that the target processor is the V850.
24705 @item -mv850e3v5
24706 @opindex mv850e3v5
24707 Specify that the target processor is the V850E3V5.  The preprocessor
24708 constant @code{__v850e3v5__} is defined if this option is used.
24710 @item -mv850e2v4
24711 @opindex mv850e2v4
24712 Specify that the target processor is the V850E3V5.  This is an alias for
24713 the @option{-mv850e3v5} option.
24715 @item -mv850e2v3
24716 @opindex mv850e2v3
24717 Specify that the target processor is the V850E2V3.  The preprocessor
24718 constant @code{__v850e2v3__} is defined if this option is used.
24720 @item -mv850e2
24721 @opindex mv850e2
24722 Specify that the target processor is the V850E2.  The preprocessor
24723 constant @code{__v850e2__} is defined if this option is used.
24725 @item -mv850e1
24726 @opindex mv850e1
24727 Specify that the target processor is the V850E1.  The preprocessor
24728 constants @code{__v850e1__} and @code{__v850e__} are defined if
24729 this option is used.
24731 @item -mv850es
24732 @opindex mv850es
24733 Specify that the target processor is the V850ES.  This is an alias for
24734 the @option{-mv850e1} option.
24736 @item -mv850e
24737 @opindex mv850e
24738 Specify that the target processor is the V850E@.  The preprocessor
24739 constant @code{__v850e__} is defined if this option is used.
24741 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24742 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24743 are defined then a default target processor is chosen and the
24744 relevant @samp{__v850*__} preprocessor constant is defined.
24746 The preprocessor constants @code{__v850} and @code{__v851__} are always
24747 defined, regardless of which processor variant is the target.
24749 @item -mdisable-callt
24750 @itemx -mno-disable-callt
24751 @opindex mdisable-callt
24752 @opindex mno-disable-callt
24753 This option suppresses generation of the @code{CALLT} instruction for the
24754 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24755 architecture.
24757 This option is enabled by default when the RH850 ABI is
24758 in use (see @option{-mrh850-abi}), and disabled by default when the
24759 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24760 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24762 @item -mrelax
24763 @itemx -mno-relax
24764 @opindex mrelax
24765 @opindex mno-relax
24766 Pass on (or do not pass on) the @option{-mrelax} command-line option
24767 to the assembler.
24769 @item -mlong-jumps
24770 @itemx -mno-long-jumps
24771 @opindex mlong-jumps
24772 @opindex mno-long-jumps
24773 Disable (or re-enable) the generation of PC-relative jump instructions.
24775 @item -msoft-float
24776 @itemx -mhard-float
24777 @opindex msoft-float
24778 @opindex mhard-float
24779 Disable (or re-enable) the generation of hardware floating point
24780 instructions.  This option is only significant when the target
24781 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24782 instructions are being generated then the C preprocessor symbol
24783 @code{__FPU_OK__} is defined, otherwise the symbol
24784 @code{__NO_FPU__} is defined.
24786 @item -mloop
24787 @opindex mloop
24788 Enables the use of the e3v5 LOOP instruction.  The use of this
24789 instruction is not enabled by default when the e3v5 architecture is
24790 selected because its use is still experimental.
24792 @item -mrh850-abi
24793 @itemx -mghs
24794 @opindex mrh850-abi
24795 @opindex mghs
24796 Enables support for the RH850 version of the V850 ABI.  This is the
24797 default.  With this version of the ABI the following rules apply:
24799 @itemize
24800 @item
24801 Integer sized structures and unions are returned via a memory pointer
24802 rather than a register.
24804 @item
24805 Large structures and unions (more than 8 bytes in size) are passed by
24806 value.
24808 @item
24809 Functions are aligned to 16-bit boundaries.
24811 @item
24812 The @option{-m8byte-align} command-line option is supported.
24814 @item
24815 The @option{-mdisable-callt} command-line option is enabled by
24816 default.  The @option{-mno-disable-callt} command-line option is not
24817 supported.
24818 @end itemize
24820 When this version of the ABI is enabled the C preprocessor symbol
24821 @code{__V850_RH850_ABI__} is defined.
24823 @item -mgcc-abi
24824 @opindex mgcc-abi
24825 Enables support for the old GCC version of the V850 ABI.  With this
24826 version of the ABI the following rules apply:
24828 @itemize
24829 @item
24830 Integer sized structures and unions are returned in register @code{r10}.
24832 @item
24833 Large structures and unions (more than 8 bytes in size) are passed by
24834 reference.
24836 @item
24837 Functions are aligned to 32-bit boundaries, unless optimizing for
24838 size.
24840 @item
24841 The @option{-m8byte-align} command-line option is not supported.
24843 @item
24844 The @option{-mdisable-callt} command-line option is supported but not
24845 enabled by default.
24846 @end itemize
24848 When this version of the ABI is enabled the C preprocessor symbol
24849 @code{__V850_GCC_ABI__} is defined.
24851 @item -m8byte-align
24852 @itemx -mno-8byte-align
24853 @opindex m8byte-align
24854 @opindex mno-8byte-align
24855 Enables support for @code{double} and @code{long long} types to be
24856 aligned on 8-byte boundaries.  The default is to restrict the
24857 alignment of all objects to at most 4-bytes.  When
24858 @option{-m8byte-align} is in effect the C preprocessor symbol
24859 @code{__V850_8BYTE_ALIGN__} is defined.
24861 @item -mbig-switch
24862 @opindex mbig-switch
24863 Generate code suitable for big switch tables.  Use this option only if
24864 the assembler/linker complain about out of range branches within a switch
24865 table.
24867 @item -mapp-regs
24868 @opindex mapp-regs
24869 This option causes r2 and r5 to be used in the code generated by
24870 the compiler.  This setting is the default.
24872 @item -mno-app-regs
24873 @opindex mno-app-regs
24874 This option causes r2 and r5 to be treated as fixed registers.
24876 @end table
24878 @node VAX Options
24879 @subsection VAX Options
24880 @cindex VAX options
24882 These @samp{-m} options are defined for the VAX:
24884 @table @gcctabopt
24885 @item -munix
24886 @opindex munix
24887 Do not output certain jump instructions (@code{aobleq} and so on)
24888 that the Unix assembler for the VAX cannot handle across long
24889 ranges.
24891 @item -mgnu
24892 @opindex mgnu
24893 Do output those jump instructions, on the assumption that the
24894 GNU assembler is being used.
24896 @item -mg
24897 @opindex mg
24898 Output code for G-format floating-point numbers instead of D-format.
24899 @end table
24901 @node Visium Options
24902 @subsection Visium Options
24903 @cindex Visium options
24905 @table @gcctabopt
24907 @item -mdebug
24908 @opindex mdebug
24909 A program which performs file I/O and is destined to run on an MCM target
24910 should be linked with this option.  It causes the libraries libc.a and
24911 libdebug.a to be linked.  The program should be run on the target under
24912 the control of the GDB remote debugging stub.
24914 @item -msim
24915 @opindex msim
24916 A program which performs file I/O and is destined to run on the simulator
24917 should be linked with option.  This causes libraries libc.a and libsim.a to
24918 be linked.
24920 @item -mfpu
24921 @itemx -mhard-float
24922 @opindex mfpu
24923 @opindex mhard-float
24924 Generate code containing floating-point instructions.  This is the
24925 default.
24927 @item -mno-fpu
24928 @itemx -msoft-float
24929 @opindex mno-fpu
24930 @opindex msoft-float
24931 Generate code containing library calls for floating-point.
24933 @option{-msoft-float} changes the calling convention in the output file;
24934 therefore, it is only useful if you compile @emph{all} of a program with
24935 this option.  In particular, you need to compile @file{libgcc.a}, the
24936 library that comes with GCC, with @option{-msoft-float} in order for
24937 this to work.
24939 @item -mcpu=@var{cpu_type}
24940 @opindex mcpu
24941 Set the instruction set, register set, and instruction scheduling parameters
24942 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24943 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24945 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24947 By default (unless configured otherwise), GCC generates code for the GR5
24948 variant of the Visium architecture.  
24950 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24951 architecture.  The only difference from GR5 code is that the compiler will
24952 generate block move instructions.
24954 @item -mtune=@var{cpu_type}
24955 @opindex mtune
24956 Set the instruction scheduling parameters for machine type @var{cpu_type},
24957 but do not set the instruction set or register set that the option
24958 @option{-mcpu=@var{cpu_type}} would.
24960 @item -msv-mode
24961 @opindex msv-mode
24962 Generate code for the supervisor mode, where there are no restrictions on
24963 the access to general registers.  This is the default.
24965 @item -muser-mode
24966 @opindex muser-mode
24967 Generate code for the user mode, where the access to some general registers
24968 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24969 mode; on the GR6, only registers r29 to r31 are affected.
24970 @end table
24972 @node VMS Options
24973 @subsection VMS Options
24975 These @samp{-m} options are defined for the VMS implementations:
24977 @table @gcctabopt
24978 @item -mvms-return-codes
24979 @opindex mvms-return-codes
24980 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24981 condition (e.g.@ error) codes.
24983 @item -mdebug-main=@var{prefix}
24984 @opindex mdebug-main=@var{prefix}
24985 Flag the first routine whose name starts with @var{prefix} as the main
24986 routine for the debugger.
24988 @item -mmalloc64
24989 @opindex mmalloc64
24990 Default to 64-bit memory allocation routines.
24992 @item -mpointer-size=@var{size}
24993 @opindex mpointer-size=@var{size}
24994 Set the default size of pointers. Possible options for @var{size} are
24995 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24996 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24997 The later option disables @code{pragma pointer_size}.
24998 @end table
25000 @node VxWorks Options
25001 @subsection VxWorks Options
25002 @cindex VxWorks Options
25004 The options in this section are defined for all VxWorks targets.
25005 Options specific to the target hardware are listed with the other
25006 options for that target.
25008 @table @gcctabopt
25009 @item -mrtp
25010 @opindex mrtp
25011 GCC can generate code for both VxWorks kernels and real time processes
25012 (RTPs).  This option switches from the former to the latter.  It also
25013 defines the preprocessor macro @code{__RTP__}.
25015 @item -non-static
25016 @opindex non-static
25017 Link an RTP executable against shared libraries rather than static
25018 libraries.  The options @option{-static} and @option{-shared} can
25019 also be used for RTPs (@pxref{Link Options}); @option{-static}
25020 is the default.
25022 @item -Bstatic
25023 @itemx -Bdynamic
25024 @opindex Bstatic
25025 @opindex Bdynamic
25026 These options are passed down to the linker.  They are defined for
25027 compatibility with Diab.
25029 @item -Xbind-lazy
25030 @opindex Xbind-lazy
25031 Enable lazy binding of function calls.  This option is equivalent to
25032 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25034 @item -Xbind-now
25035 @opindex Xbind-now
25036 Disable lazy binding of function calls.  This option is the default and
25037 is defined for compatibility with Diab.
25038 @end table
25040 @node x86 Options
25041 @subsection x86 Options
25042 @cindex x86 Options
25044 These @samp{-m} options are defined for the x86 family of computers.
25046 @table @gcctabopt
25048 @item -march=@var{cpu-type}
25049 @opindex march
25050 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25051 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25052 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25053 to generate code that may not run at all on processors other than the one
25054 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25055 @option{-mtune=@var{cpu-type}}.
25057 The choices for @var{cpu-type} are:
25059 @table @samp
25060 @item native
25061 This selects the CPU to generate code for at compilation time by determining
25062 the processor type of the compiling machine.  Using @option{-march=native}
25063 enables all instruction subsets supported by the local machine (hence
25064 the result might not run on different machines).  Using @option{-mtune=native}
25065 produces code optimized for the local machine under the constraints
25066 of the selected instruction set.  
25068 @item i386
25069 Original Intel i386 CPU@.
25071 @item i486
25072 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25074 @item i586
25075 @itemx pentium
25076 Intel Pentium CPU with no MMX support.
25078 @item lakemont
25079 Intel Lakemont MCU, based on Intel Pentium CPU.
25081 @item pentium-mmx
25082 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25084 @item pentiumpro
25085 Intel Pentium Pro CPU@.
25087 @item i686
25088 When used with @option{-march}, the Pentium Pro
25089 instruction set is used, so the code runs on all i686 family chips.
25090 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25092 @item pentium2
25093 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25094 support.
25096 @item pentium3
25097 @itemx pentium3m
25098 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25099 set support.
25101 @item pentium-m
25102 Intel Pentium M; low-power version of Intel Pentium III CPU
25103 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25105 @item pentium4
25106 @itemx pentium4m
25107 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25109 @item prescott
25110 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25111 set support.
25113 @item nocona
25114 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25115 SSE2 and SSE3 instruction set support.
25117 @item core2
25118 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25119 instruction set support.
25121 @item nehalem
25122 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25123 SSE4.1, SSE4.2 and POPCNT instruction set support.
25125 @item westmere
25126 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25127 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25129 @item sandybridge
25130 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25131 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25133 @item ivybridge
25134 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25135 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25136 instruction set support.
25138 @item haswell
25139 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25140 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25141 BMI, BMI2 and F16C instruction set support.
25143 @item broadwell
25144 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25145 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25146 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25148 @item skylake
25149 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25150 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25151 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25152 XSAVES instruction set support.
25154 @item bonnell
25155 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25156 instruction set support.
25158 @item silvermont
25159 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25160 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25162 @item knl
25163 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25164 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25165 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25166 AVX512CD instruction set support.
25168 @item knm
25169 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25170 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25171 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25172 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25174 @item skylake-avx512
25175 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25176 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25177 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25178 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25180 @item k6
25181 AMD K6 CPU with MMX instruction set support.
25183 @item k6-2
25184 @itemx k6-3
25185 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25187 @item athlon
25188 @itemx athlon-tbird
25189 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25190 support.
25192 @item athlon-4
25193 @itemx athlon-xp
25194 @itemx athlon-mp
25195 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25196 instruction set support.
25198 @item k8
25199 @itemx opteron
25200 @itemx athlon64
25201 @itemx athlon-fx
25202 Processors based on the AMD K8 core with x86-64 instruction set support,
25203 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25204 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25205 instruction set extensions.)
25207 @item k8-sse3
25208 @itemx opteron-sse3
25209 @itemx athlon64-sse3
25210 Improved versions of AMD K8 cores with SSE3 instruction set support.
25212 @item amdfam10
25213 @itemx barcelona
25214 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25215 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25216 instruction set extensions.)
25218 @item bdver1
25219 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25220 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25221 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25222 @item bdver2
25223 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25224 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25225 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25226 extensions.)
25227 @item bdver3
25228 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25229 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25230 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25231 64-bit instruction set extensions.
25232 @item bdver4
25233 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25234 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25235 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25236 SSE4.2, ABM and 64-bit instruction set extensions.
25238 @item znver1
25239 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25240 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25241 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25242 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25243 instruction set extensions.
25245 @item btver1
25246 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25247 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25248 instruction set extensions.)
25250 @item btver2
25251 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25252 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25253 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25255 @item winchip-c6
25256 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25257 set support.
25259 @item winchip2
25260 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25261 instruction set support.
25263 @item c3
25264 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25265 (No scheduling is implemented for this chip.)
25267 @item c3-2
25268 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25269 (No scheduling is implemented for this chip.)
25271 @item c7
25272 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25273 (No scheduling is implemented for this chip.)
25275 @item samuel-2
25276 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25277 (No scheduling is implemented for this chip.)
25279 @item nehemiah
25280 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25281 (No scheduling is implemented for this chip.)
25283 @item esther
25284 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25285 (No scheduling is implemented for this chip.)
25287 @item eden-x2
25288 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25289 (No scheduling is implemented for this chip.)
25291 @item eden-x4
25292 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25293 AVX and AVX2 instruction set support.
25294 (No scheduling is implemented for this chip.)
25296 @item nano
25297 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25298 instruction set support.
25299 (No scheduling is implemented for this chip.)
25301 @item nano-1000
25302 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25303 instruction set support.
25304 (No scheduling is implemented for this chip.)
25306 @item nano-2000
25307 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25308 instruction set support.
25309 (No scheduling is implemented for this chip.)
25311 @item nano-3000
25312 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25313 instruction set support.
25314 (No scheduling is implemented for this chip.)
25316 @item nano-x2
25317 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25318 instruction set support.
25319 (No scheduling is implemented for this chip.)
25321 @item nano-x4
25322 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25323 instruction set support.
25324 (No scheduling is implemented for this chip.)
25326 @item geode
25327 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25328 @end table
25330 @item -mtune=@var{cpu-type}
25331 @opindex mtune
25332 Tune to @var{cpu-type} everything applicable about the generated code, except
25333 for the ABI and the set of available instructions.  
25334 While picking a specific @var{cpu-type} schedules things appropriately
25335 for that particular chip, the compiler does not generate any code that
25336 cannot run on the default machine type unless you use a
25337 @option{-march=@var{cpu-type}} option.
25338 For example, if GCC is configured for i686-pc-linux-gnu
25339 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25340 but still runs on i686 machines.
25342 The choices for @var{cpu-type} are the same as for @option{-march}.
25343 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25345 @table @samp
25346 @item generic
25347 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25348 If you know the CPU on which your code will run, then you should use
25349 the corresponding @option{-mtune} or @option{-march} option instead of
25350 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25351 of your application will have, then you should use this option.
25353 As new processors are deployed in the marketplace, the behavior of this
25354 option will change.  Therefore, if you upgrade to a newer version of
25355 GCC, code generation controlled by this option will change to reflect
25356 the processors
25357 that are most common at the time that version of GCC is released.
25359 There is no @option{-march=generic} option because @option{-march}
25360 indicates the instruction set the compiler can use, and there is no
25361 generic instruction set applicable to all processors.  In contrast,
25362 @option{-mtune} indicates the processor (or, in this case, collection of
25363 processors) for which the code is optimized.
25365 @item intel
25366 Produce code optimized for the most current Intel processors, which are
25367 Haswell and Silvermont for this version of GCC.  If you know the CPU
25368 on which your code will run, then you should use the corresponding
25369 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25370 But, if you want your application performs better on both Haswell and
25371 Silvermont, then you should use this option.
25373 As new Intel processors are deployed in the marketplace, the behavior of
25374 this option will change.  Therefore, if you upgrade to a newer version of
25375 GCC, code generation controlled by this option will change to reflect
25376 the most current Intel processors at the time that version of GCC is
25377 released.
25379 There is no @option{-march=intel} option because @option{-march} indicates
25380 the instruction set the compiler can use, and there is no common
25381 instruction set applicable to all processors.  In contrast,
25382 @option{-mtune} indicates the processor (or, in this case, collection of
25383 processors) for which the code is optimized.
25384 @end table
25386 @item -mcpu=@var{cpu-type}
25387 @opindex mcpu
25388 A deprecated synonym for @option{-mtune}.
25390 @item -mfpmath=@var{unit}
25391 @opindex mfpmath
25392 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25393 for @var{unit} are:
25395 @table @samp
25396 @item 387
25397 Use the standard 387 floating-point coprocessor present on the majority of chips and
25398 emulated otherwise.  Code compiled with this option runs almost everywhere.
25399 The temporary results are computed in 80-bit precision instead of the precision
25400 specified by the type, resulting in slightly different results compared to most
25401 of other chips.  See @option{-ffloat-store} for more detailed description.
25403 This is the default choice for non-Darwin x86-32 targets.
25405 @item sse
25406 Use scalar floating-point instructions present in the SSE instruction set.
25407 This instruction set is supported by Pentium III and newer chips,
25408 and in the AMD line
25409 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25410 instruction set supports only single-precision arithmetic, thus the double and
25411 extended-precision arithmetic are still done using 387.  A later version, present
25412 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25413 arithmetic too.
25415 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25416 or @option{-msse2} switches to enable SSE extensions and make this option
25417 effective.  For the x86-64 compiler, these extensions are enabled by default.
25419 The resulting code should be considerably faster in the majority of cases and avoid
25420 the numerical instability problems of 387 code, but may break some existing
25421 code that expects temporaries to be 80 bits.
25423 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25424 and the default choice for x86-32 targets with the SSE2 instruction set
25425 when @option{-ffast-math} is enabled.
25427 @item sse,387
25428 @itemx sse+387
25429 @itemx both
25430 Attempt to utilize both instruction sets at once.  This effectively doubles the
25431 amount of available registers, and on chips with separate execution units for
25432 387 and SSE the execution resources too.  Use this option with care, as it is
25433 still experimental, because the GCC register allocator does not model separate
25434 functional units well, resulting in unstable performance.
25435 @end table
25437 @item -masm=@var{dialect}
25438 @opindex masm=@var{dialect}
25439 Output assembly instructions using selected @var{dialect}.  Also affects
25440 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25441 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25442 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25443 not support @samp{intel}.
25445 @item -mieee-fp
25446 @itemx -mno-ieee-fp
25447 @opindex mieee-fp
25448 @opindex mno-ieee-fp
25449 Control whether or not the compiler uses IEEE floating-point
25450 comparisons.  These correctly handle the case where the result of a
25451 comparison is unordered.
25453 @item -m80387
25454 @item -mhard-float
25455 @opindex 80387
25456 @opindex mhard-float
25457 Generate output containing 80387 instructions for floating point.
25459 @item -mno-80387
25460 @item -msoft-float
25461 @opindex no-80387
25462 @opindex msoft-float
25463 Generate output containing library calls for floating point.
25465 @strong{Warning:} the requisite libraries are not part of GCC@.
25466 Normally the facilities of the machine's usual C compiler are used, but
25467 this cannot be done directly in cross-compilation.  You must make your
25468 own arrangements to provide suitable library functions for
25469 cross-compilation.
25471 On machines where a function returns floating-point results in the 80387
25472 register stack, some floating-point opcodes may be emitted even if
25473 @option{-msoft-float} is used.
25475 @item -mno-fp-ret-in-387
25476 @opindex mno-fp-ret-in-387
25477 Do not use the FPU registers for return values of functions.
25479 The usual calling convention has functions return values of types
25480 @code{float} and @code{double} in an FPU register, even if there
25481 is no FPU@.  The idea is that the operating system should emulate
25482 an FPU@.
25484 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25485 in ordinary CPU registers instead.
25487 @item -mno-fancy-math-387
25488 @opindex mno-fancy-math-387
25489 Some 387 emulators do not support the @code{sin}, @code{cos} and
25490 @code{sqrt} instructions for the 387.  Specify this option to avoid
25491 generating those instructions.  This option is the default on
25492 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25493 indicates that the target CPU always has an FPU and so the
25494 instruction does not need emulation.  These
25495 instructions are not generated unless you also use the
25496 @option{-funsafe-math-optimizations} switch.
25498 @item -malign-double
25499 @itemx -mno-align-double
25500 @opindex malign-double
25501 @opindex mno-align-double
25502 Control whether GCC aligns @code{double}, @code{long double}, and
25503 @code{long long} variables on a two-word boundary or a one-word
25504 boundary.  Aligning @code{double} variables on a two-word boundary
25505 produces code that runs somewhat faster on a Pentium at the
25506 expense of more memory.
25508 On x86-64, @option{-malign-double} is enabled by default.
25510 @strong{Warning:} if you use the @option{-malign-double} switch,
25511 structures containing the above types are aligned differently than
25512 the published application binary interface specifications for the x86-32
25513 and are not binary compatible with structures in code compiled
25514 without that switch.
25516 @item -m96bit-long-double
25517 @itemx -m128bit-long-double
25518 @opindex m96bit-long-double
25519 @opindex m128bit-long-double
25520 These switches control the size of @code{long double} type.  The x86-32
25521 application binary interface specifies the size to be 96 bits,
25522 so @option{-m96bit-long-double} is the default in 32-bit mode.
25524 Modern architectures (Pentium and newer) prefer @code{long double}
25525 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25526 conforming to the ABI, this is not possible.  So specifying
25527 @option{-m128bit-long-double} aligns @code{long double}
25528 to a 16-byte boundary by padding the @code{long double} with an additional
25529 32-bit zero.
25531 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25532 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25534 Notice that neither of these options enable any extra precision over the x87
25535 standard of 80 bits for a @code{long double}.
25537 @strong{Warning:} if you override the default value for your target ABI, this
25538 changes the size of 
25539 structures and arrays containing @code{long double} variables,
25540 as well as modifying the function calling convention for functions taking
25541 @code{long double}.  Hence they are not binary-compatible
25542 with code compiled without that switch.
25544 @item -mlong-double-64
25545 @itemx -mlong-double-80
25546 @itemx -mlong-double-128
25547 @opindex mlong-double-64
25548 @opindex mlong-double-80
25549 @opindex mlong-double-128
25550 These switches control the size of @code{long double} type. A size
25551 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25552 type. This is the default for 32-bit Bionic C library.  A size
25553 of 128 bits makes the @code{long double} type equivalent to the
25554 @code{__float128} type. This is the default for 64-bit Bionic C library.
25556 @strong{Warning:} if you override the default value for your target ABI, this
25557 changes the size of
25558 structures and arrays containing @code{long double} variables,
25559 as well as modifying the function calling convention for functions taking
25560 @code{long double}.  Hence they are not binary-compatible
25561 with code compiled without that switch.
25563 @item -malign-data=@var{type}
25564 @opindex malign-data
25565 Control how GCC aligns variables.  Supported values for @var{type} are
25566 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25567 and earlier, @samp{abi} uses alignment value as specified by the
25568 psABI, and @samp{cacheline} uses increased alignment value to match
25569 the cache line size.  @samp{compat} is the default.
25571 @item -mlarge-data-threshold=@var{threshold}
25572 @opindex mlarge-data-threshold
25573 When @option{-mcmodel=medium} is specified, data objects larger than
25574 @var{threshold} are placed in the large data section.  This value must be the
25575 same across all objects linked into the binary, and defaults to 65535.
25577 @item -mrtd
25578 @opindex mrtd
25579 Use a different function-calling convention, in which functions that
25580 take a fixed number of arguments return with the @code{ret @var{num}}
25581 instruction, which pops their arguments while returning.  This saves one
25582 instruction in the caller since there is no need to pop the arguments
25583 there.
25585 You can specify that an individual function is called with this calling
25586 sequence with the function attribute @code{stdcall}.  You can also
25587 override the @option{-mrtd} option by using the function attribute
25588 @code{cdecl}.  @xref{Function Attributes}.
25590 @strong{Warning:} this calling convention is incompatible with the one
25591 normally used on Unix, so you cannot use it if you need to call
25592 libraries compiled with the Unix compiler.
25594 Also, you must provide function prototypes for all functions that
25595 take variable numbers of arguments (including @code{printf});
25596 otherwise incorrect code is generated for calls to those
25597 functions.
25599 In addition, seriously incorrect code results if you call a
25600 function with too many arguments.  (Normally, extra arguments are
25601 harmlessly ignored.)
25603 @item -mregparm=@var{num}
25604 @opindex mregparm
25605 Control how many registers are used to pass integer arguments.  By
25606 default, no registers are used to pass arguments, and at most 3
25607 registers can be used.  You can control this behavior for a specific
25608 function by using the function attribute @code{regparm}.
25609 @xref{Function Attributes}.
25611 @strong{Warning:} if you use this switch, and
25612 @var{num} is nonzero, then you must build all modules with the same
25613 value, including any libraries.  This includes the system libraries and
25614 startup modules.
25616 @item -msseregparm
25617 @opindex msseregparm
25618 Use SSE register passing conventions for float and double arguments
25619 and return values.  You can control this behavior for a specific
25620 function by using the function attribute @code{sseregparm}.
25621 @xref{Function Attributes}.
25623 @strong{Warning:} if you use this switch then you must build all
25624 modules with the same value, including any libraries.  This includes
25625 the system libraries and startup modules.
25627 @item -mvect8-ret-in-mem
25628 @opindex mvect8-ret-in-mem
25629 Return 8-byte vectors in memory instead of MMX registers.  This is the
25630 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25631 Studio compilers until version 12.  Later compiler versions (starting
25632 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25633 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25634 you need to remain compatible with existing code produced by those
25635 previous compiler versions or older versions of GCC@.
25637 @item -mpc32
25638 @itemx -mpc64
25639 @itemx -mpc80
25640 @opindex mpc32
25641 @opindex mpc64
25642 @opindex mpc80
25644 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25645 is specified, the significands of results of floating-point operations are
25646 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25647 significands of results of floating-point operations to 53 bits (double
25648 precision) and @option{-mpc80} rounds the significands of results of
25649 floating-point operations to 64 bits (extended double precision), which is
25650 the default.  When this option is used, floating-point operations in higher
25651 precisions are not available to the programmer without setting the FPU
25652 control word explicitly.
25654 Setting the rounding of floating-point operations to less than the default
25655 80 bits can speed some programs by 2% or more.  Note that some mathematical
25656 libraries assume that extended-precision (80-bit) floating-point operations
25657 are enabled by default; routines in such libraries could suffer significant
25658 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25659 when this option is used to set the precision to less than extended precision.
25661 @item -mstackrealign
25662 @opindex mstackrealign
25663 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25664 option generates an alternate prologue and epilogue that realigns the
25665 run-time stack if necessary.  This supports mixing legacy codes that keep
25666 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25667 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25668 applicable to individual functions.
25670 @item -mpreferred-stack-boundary=@var{num}
25671 @opindex mpreferred-stack-boundary
25672 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25673 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25674 the default is 4 (16 bytes or 128 bits).
25676 @strong{Warning:} When generating code for the x86-64 architecture with
25677 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25678 used to keep the stack boundary aligned to 8 byte boundary.  Since
25679 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25680 intended to be used in controlled environment where stack space is
25681 important limitation.  This option leads to wrong code when functions
25682 compiled with 16 byte stack alignment (such as functions from a standard
25683 library) are called with misaligned stack.  In this case, SSE
25684 instructions may lead to misaligned memory access traps.  In addition,
25685 variable arguments are handled incorrectly for 16 byte aligned
25686 objects (including x87 long double and __int128), leading to wrong
25687 results.  You must build all modules with
25688 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25689 includes the system libraries and startup modules.
25691 @item -mincoming-stack-boundary=@var{num}
25692 @opindex mincoming-stack-boundary
25693 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25694 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25695 the one specified by @option{-mpreferred-stack-boundary} is used.
25697 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25698 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25699 suffer significant run time performance penalties.  On Pentium III, the
25700 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25701 properly if it is not 16-byte aligned.
25703 To ensure proper alignment of this values on the stack, the stack boundary
25704 must be as aligned as that required by any value stored on the stack.
25705 Further, every function must be generated such that it keeps the stack
25706 aligned.  Thus calling a function compiled with a higher preferred
25707 stack boundary from a function compiled with a lower preferred stack
25708 boundary most likely misaligns the stack.  It is recommended that
25709 libraries that use callbacks always use the default setting.
25711 This extra alignment does consume extra stack space, and generally
25712 increases code size.  Code that is sensitive to stack space usage, such
25713 as embedded systems and operating system kernels, may want to reduce the
25714 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25716 @need 200
25717 @item -mmmx
25718 @opindex mmmx
25719 @need 200
25720 @itemx -msse
25721 @opindex msse
25722 @need 200
25723 @itemx -msse2
25724 @opindex msse2
25725 @need 200
25726 @itemx -msse3
25727 @opindex msse3
25728 @need 200
25729 @itemx -mssse3
25730 @opindex mssse3
25731 @need 200
25732 @itemx -msse4
25733 @opindex msse4
25734 @need 200
25735 @itemx -msse4a
25736 @opindex msse4a
25737 @need 200
25738 @itemx -msse4.1
25739 @opindex msse4.1
25740 @need 200
25741 @itemx -msse4.2
25742 @opindex msse4.2
25743 @need 200
25744 @itemx -mavx
25745 @opindex mavx
25746 @need 200
25747 @itemx -mavx2
25748 @opindex mavx2
25749 @need 200
25750 @itemx -mavx512f
25751 @opindex mavx512f
25752 @need 200
25753 @itemx -mavx512pf
25754 @opindex mavx512pf
25755 @need 200
25756 @itemx -mavx512er
25757 @opindex mavx512er
25758 @need 200
25759 @itemx -mavx512cd
25760 @opindex mavx512cd
25761 @need 200
25762 @itemx -mavx512vl
25763 @opindex mavx512vl
25764 @need 200
25765 @itemx -mavx512bw
25766 @opindex mavx512bw
25767 @need 200
25768 @itemx -mavx512dq
25769 @opindex mavx512dq
25770 @need 200
25771 @itemx -mavx512ifma
25772 @opindex mavx512ifma
25773 @need 200
25774 @itemx -mavx512vbmi
25775 @opindex mavx512vbmi
25776 @need 200
25777 @itemx -msha
25778 @opindex msha
25779 @need 200
25780 @itemx -maes
25781 @opindex maes
25782 @need 200
25783 @itemx -mpclmul
25784 @opindex mpclmul
25785 @need 200
25786 @itemx -mclfushopt
25787 @opindex mclfushopt
25788 @need 200
25789 @itemx -mfsgsbase
25790 @opindex mfsgsbase
25791 @need 200
25792 @itemx -mrdrnd
25793 @opindex mrdrnd
25794 @need 200
25795 @itemx -mf16c
25796 @opindex mf16c
25797 @need 200
25798 @itemx -mfma
25799 @opindex mfma
25800 @need 200
25801 @itemx -mfma4
25802 @opindex mfma4
25803 @need 200
25804 @itemx -mprefetchwt1
25805 @opindex mprefetchwt1
25806 @need 200
25807 @itemx -mxop
25808 @opindex mxop
25809 @need 200
25810 @itemx -mlwp
25811 @opindex mlwp
25812 @need 200
25813 @itemx -m3dnow
25814 @opindex m3dnow
25815 @need 200
25816 @itemx -m3dnowa
25817 @opindex m3dnowa
25818 @need 200
25819 @itemx -mpopcnt
25820 @opindex mpopcnt
25821 @need 200
25822 @itemx -mabm
25823 @opindex mabm
25824 @need 200
25825 @itemx -mbmi
25826 @opindex mbmi
25827 @need 200
25828 @itemx -mbmi2
25829 @need 200
25830 @itemx -mlzcnt
25831 @opindex mlzcnt
25832 @need 200
25833 @itemx -mfxsr
25834 @opindex mfxsr
25835 @need 200
25836 @itemx -mxsave
25837 @opindex mxsave
25838 @need 200
25839 @itemx -mxsaveopt
25840 @opindex mxsaveopt
25841 @need 200
25842 @itemx -mxsavec
25843 @opindex mxsavec
25844 @need 200
25845 @itemx -mxsaves
25846 @opindex mxsaves
25847 @need 200
25848 @itemx -mrtm
25849 @opindex mrtm
25850 @need 200
25851 @itemx -mtbm
25852 @opindex mtbm
25853 @need 200
25854 @itemx -mmpx
25855 @opindex mmpx
25856 @need 200
25857 @itemx -mmwaitx
25858 @opindex mmwaitx
25859 @need 200
25860 @itemx -mclzero
25861 @opindex mclzero
25862 @need 200
25863 @itemx -mpku
25864 @opindex mpku
25865 @need 200
25866 @itemx -mcet
25867 @opindex mcet
25868 These switches enable the use of instructions in the MMX, SSE,
25869 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25870 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25871 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25872 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK,
25873 3DNow!@: or enhanced 3DNow!@: extended instruction sets.  Each has a
25874 corresponding @option{-mno-} option to disable use of these instructions.
25876 These extensions are also available as built-in functions: see
25877 @ref{x86 Built-in Functions}, for details of the functions enabled and
25878 disabled by these switches.
25880 To generate SSE/SSE2 instructions automatically from floating-point
25881 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25883 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25884 generates new AVX instructions or AVX equivalence for all SSEx instructions
25885 when needed.
25887 These options enable GCC to use these extended instructions in
25888 generated code, even without @option{-mfpmath=sse}.  Applications that
25889 perform run-time CPU detection must compile separate files for each
25890 supported architecture, using the appropriate flags.  In particular,
25891 the file containing the CPU detection code should be compiled without
25892 these options.
25894 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
25895 options.  The @option{-mibt} option enables indirect branch tracking support
25896 and the @option{-mshstk} option enables shadow stack support from
25897 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
25898 a number of built-in functions for fine-grained control in a CET-based
25899 application.  See @xref{x86 Built-in Functions}, for more information.
25901 @item -mdump-tune-features
25902 @opindex mdump-tune-features
25903 This option instructs GCC to dump the names of the x86 performance 
25904 tuning features and default settings. The names can be used in 
25905 @option{-mtune-ctrl=@var{feature-list}}.
25907 @item -mtune-ctrl=@var{feature-list}
25908 @opindex mtune-ctrl=@var{feature-list}
25909 This option is used to do fine grain control of x86 code generation features.
25910 @var{feature-list} is a comma separated list of @var{feature} names. See also
25911 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25912 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25913 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25914 developers. Using it may lead to code paths not covered by testing and can
25915 potentially result in compiler ICEs or runtime errors.
25917 @item -mno-default
25918 @opindex mno-default
25919 This option instructs GCC to turn off all tunable features. See also 
25920 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25922 @item -mcld
25923 @opindex mcld
25924 This option instructs GCC to emit a @code{cld} instruction in the prologue
25925 of functions that use string instructions.  String instructions depend on
25926 the DF flag to select between autoincrement or autodecrement mode.  While the
25927 ABI specifies the DF flag to be cleared on function entry, some operating
25928 systems violate this specification by not clearing the DF flag in their
25929 exception dispatchers.  The exception handler can be invoked with the DF flag
25930 set, which leads to wrong direction mode when string instructions are used.
25931 This option can be enabled by default on 32-bit x86 targets by configuring
25932 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25933 instructions can be suppressed with the @option{-mno-cld} compiler option
25934 in this case.
25936 @item -mvzeroupper
25937 @opindex mvzeroupper
25938 This option instructs GCC to emit a @code{vzeroupper} instruction
25939 before a transfer of control flow out of the function to minimize
25940 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25941 intrinsics.
25943 @item -mprefer-avx128
25944 @opindex mprefer-avx128
25945 This option instructs GCC to use 128-bit AVX instructions instead of
25946 256-bit AVX instructions in the auto-vectorizer.
25948 @item -mprefer-avx256
25949 @opindex mprefer-avx256
25950 This option instructs GCC to use 256-bit AVX instructions instead of
25951 512-bit AVX instructions in the auto-vectorizer.
25953 @item -mcx16
25954 @opindex mcx16
25955 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25956 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25957 objects.  This is useful for atomic updates of data structures exceeding one
25958 machine word in size.  The compiler uses this instruction to implement
25959 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25960 128-bit integers, a library call is always used.
25962 @item -msahf
25963 @opindex msahf
25964 This option enables generation of @code{SAHF} instructions in 64-bit code.
25965 Early Intel Pentium 4 CPUs with Intel 64 support,
25966 prior to the introduction of Pentium 4 G1 step in December 2005,
25967 lacked the @code{LAHF} and @code{SAHF} instructions
25968 which are supported by AMD64.
25969 These are load and store instructions, respectively, for certain status flags.
25970 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25971 @code{drem}, and @code{remainder} built-in functions;
25972 see @ref{Other Builtins} for details.
25974 @item -mmovbe
25975 @opindex mmovbe
25976 This option enables use of the @code{movbe} instruction to implement
25977 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25979 @item -mibt
25980 @opindex mibt
25981 This option tells the compiler to use indirect branch tracking support
25982 (for indirect calls and jumps) from x86 Control-flow Enforcement
25983 Technology (CET).  The option has effect only if the
25984 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
25985 is specified. The option @option{-mibt} is on by default when the
25986 @code{-mcet} option is specified.
25988 @item -mshstk
25989 @opindex mshstk
25990 This option tells the compiler to use shadow stack support (return
25991 address tracking) from x86 Control-flow Enforcement Technology (CET).
25992 The option has effect only if the @option{-fcf-protection=full} or
25993 @option{-fcf-protection=return} option is specified.  The option
25994 @option{-mshstk} is on by default when the @option{-mcet} option is
25995 specified.
25997 @item -mcrc32
25998 @opindex mcrc32
25999 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26000 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26001 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26003 @item -mrecip
26004 @opindex mrecip
26005 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26006 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26007 with an additional Newton-Raphson step
26008 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26009 (and their vectorized
26010 variants) for single-precision floating-point arguments.  These instructions
26011 are generated only when @option{-funsafe-math-optimizations} is enabled
26012 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26013 Note that while the throughput of the sequence is higher than the throughput
26014 of the non-reciprocal instruction, the precision of the sequence can be
26015 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26017 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26018 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26019 combination), and doesn't need @option{-mrecip}.
26021 Also note that GCC emits the above sequence with additional Newton-Raphson step
26022 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26023 already with @option{-ffast-math} (or the above option combination), and
26024 doesn't need @option{-mrecip}.
26026 @item -mrecip=@var{opt}
26027 @opindex mrecip=opt
26028 This option controls which reciprocal estimate instructions
26029 may be used.  @var{opt} is a comma-separated list of options, which may
26030 be preceded by a @samp{!} to invert the option:
26032 @table @samp
26033 @item all
26034 Enable all estimate instructions.
26036 @item default
26037 Enable the default instructions, equivalent to @option{-mrecip}.
26039 @item none
26040 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26042 @item div
26043 Enable the approximation for scalar division.
26045 @item vec-div
26046 Enable the approximation for vectorized division.
26048 @item sqrt
26049 Enable the approximation for scalar square root.
26051 @item vec-sqrt
26052 Enable the approximation for vectorized square root.
26053 @end table
26055 So, for example, @option{-mrecip=all,!sqrt} enables
26056 all of the reciprocal approximations, except for square root.
26058 @item -mveclibabi=@var{type}
26059 @opindex mveclibabi
26060 Specifies the ABI type to use for vectorizing intrinsics using an
26061 external library.  Supported values for @var{type} are @samp{svml} 
26062 for the Intel short
26063 vector math library and @samp{acml} for the AMD math core library.
26064 To use this option, both @option{-ftree-vectorize} and
26065 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26066 ABI-compatible library must be specified at link time.
26068 GCC currently emits calls to @code{vmldExp2},
26069 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26070 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26071 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26072 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26073 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26074 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26075 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26076 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26077 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26078 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26079 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26080 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26081 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26082 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26083 when @option{-mveclibabi=acml} is used.  
26085 @item -mabi=@var{name}
26086 @opindex mabi
26087 Generate code for the specified calling convention.  Permissible values
26088 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26089 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26090 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26091 You can control this behavior for specific functions by
26092 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26093 @xref{Function Attributes}.
26095 @item -mcall-ms2sysv-xlogues
26096 @opindex mcall-ms2sysv-xlogues
26097 @opindex mno-call-ms2sysv-xlogues
26098 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26099 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26100 default, the code for saving and restoring these registers is emitted inline,
26101 resulting in fairly lengthy prologues and epilogues.  Using
26102 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26103 use stubs in the static portion of libgcc to perform these saves and restores,
26104 thus reducing function size at the cost of a few extra instructions.
26106 @item -mtls-dialect=@var{type}
26107 @opindex mtls-dialect
26108 Generate code to access thread-local storage using the @samp{gnu} or
26109 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26110 @samp{gnu2} is more efficient, but it may add compile- and run-time
26111 requirements that cannot be satisfied on all systems.
26113 @item -mpush-args
26114 @itemx -mno-push-args
26115 @opindex mpush-args
26116 @opindex mno-push-args
26117 Use PUSH operations to store outgoing parameters.  This method is shorter
26118 and usually equally fast as method using SUB/MOV operations and is enabled
26119 by default.  In some cases disabling it may improve performance because of
26120 improved scheduling and reduced dependencies.
26122 @item -maccumulate-outgoing-args
26123 @opindex maccumulate-outgoing-args
26124 If enabled, the maximum amount of space required for outgoing arguments is
26125 computed in the function prologue.  This is faster on most modern CPUs
26126 because of reduced dependencies, improved scheduling and reduced stack usage
26127 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26128 increase in code size.  This switch implies @option{-mno-push-args}.
26130 @item -mthreads
26131 @opindex mthreads
26132 Support thread-safe exception handling on MinGW.  Programs that rely
26133 on thread-safe exception handling must compile and link all code with the
26134 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26135 @option{-D_MT}; when linking, it links in a special thread helper library
26136 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26138 @item -mms-bitfields
26139 @itemx -mno-ms-bitfields
26140 @opindex mms-bitfields
26141 @opindex mno-ms-bitfields
26143 Enable/disable bit-field layout compatible with the native Microsoft
26144 Windows compiler.  
26146 If @code{packed} is used on a structure, or if bit-fields are used,
26147 it may be that the Microsoft ABI lays out the structure differently
26148 than the way GCC normally does.  Particularly when moving packed
26149 data between functions compiled with GCC and the native Microsoft compiler
26150 (either via function call or as data in a file), it may be necessary to access
26151 either format.
26153 This option is enabled by default for Microsoft Windows
26154 targets.  This behavior can also be controlled locally by use of variable
26155 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26156 and @ref{x86 Type Attributes}.
26158 The Microsoft structure layout algorithm is fairly simple with the exception
26159 of the bit-field packing.  
26160 The padding and alignment of members of structures and whether a bit-field 
26161 can straddle a storage-unit boundary are determine by these rules:
26163 @enumerate
26164 @item Structure members are stored sequentially in the order in which they are
26165 declared: the first member has the lowest memory address and the last member
26166 the highest.
26168 @item Every data object has an alignment requirement.  The alignment requirement
26169 for all data except structures, unions, and arrays is either the size of the
26170 object or the current packing size (specified with either the
26171 @code{aligned} attribute or the @code{pack} pragma),
26172 whichever is less.  For structures, unions, and arrays,
26173 the alignment requirement is the largest alignment requirement of its members.
26174 Every object is allocated an offset so that:
26176 @smallexample
26177 offset % alignment_requirement == 0
26178 @end smallexample
26180 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26181 unit if the integral types are the same size and if the next bit-field fits
26182 into the current allocation unit without crossing the boundary imposed by the
26183 common alignment requirements of the bit-fields.
26184 @end enumerate
26186 MSVC interprets zero-length bit-fields in the following ways:
26188 @enumerate
26189 @item If a zero-length bit-field is inserted between two bit-fields that
26190 are normally coalesced, the bit-fields are not coalesced.
26192 For example:
26194 @smallexample
26195 struct
26196  @{
26197    unsigned long bf_1 : 12;
26198    unsigned long : 0;
26199    unsigned long bf_2 : 12;
26200  @} t1;
26201 @end smallexample
26203 @noindent
26204 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26205 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26207 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26208 alignment of the zero-length bit-field is greater than the member that follows it,
26209 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26211 For example:
26213 @smallexample
26214 struct
26215  @{
26216    char foo : 4;
26217    short : 0;
26218    char bar;
26219  @} t2;
26221 struct
26222  @{
26223    char foo : 4;
26224    short : 0;
26225    double bar;
26226  @} t3;
26227 @end smallexample
26229 @noindent
26230 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26231 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26232 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26233 of the structure.
26235 Taking this into account, it is important to note the following:
26237 @enumerate
26238 @item If a zero-length bit-field follows a normal bit-field, the type of the
26239 zero-length bit-field may affect the alignment of the structure as whole. For
26240 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26241 normal bit-field, and is of type short.
26243 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26244 still affect the alignment of the structure:
26246 @smallexample
26247 struct
26248  @{
26249    char foo : 6;
26250    long : 0;
26251  @} t4;
26252 @end smallexample
26254 @noindent
26255 Here, @code{t4} takes up 4 bytes.
26256 @end enumerate
26258 @item Zero-length bit-fields following non-bit-field members are ignored:
26260 @smallexample
26261 struct
26262  @{
26263    char foo;
26264    long : 0;
26265    char bar;
26266  @} t5;
26267 @end smallexample
26269 @noindent
26270 Here, @code{t5} takes up 2 bytes.
26271 @end enumerate
26274 @item -mno-align-stringops
26275 @opindex mno-align-stringops
26276 Do not align the destination of inlined string operations.  This switch reduces
26277 code size and improves performance in case the destination is already aligned,
26278 but GCC doesn't know about it.
26280 @item -minline-all-stringops
26281 @opindex minline-all-stringops
26282 By default GCC inlines string operations only when the destination is 
26283 known to be aligned to least a 4-byte boundary.  
26284 This enables more inlining and increases code
26285 size, but may improve performance of code that depends on fast
26286 @code{memcpy}, @code{strlen},
26287 and @code{memset} for short lengths.
26289 @item -minline-stringops-dynamically
26290 @opindex minline-stringops-dynamically
26291 For string operations of unknown size, use run-time checks with
26292 inline code for small blocks and a library call for large blocks.
26294 @item -mstringop-strategy=@var{alg}
26295 @opindex mstringop-strategy=@var{alg}
26296 Override the internal decision heuristic for the particular algorithm to use
26297 for inlining string operations.  The allowed values for @var{alg} are:
26299 @table @samp
26300 @item rep_byte
26301 @itemx rep_4byte
26302 @itemx rep_8byte
26303 Expand using i386 @code{rep} prefix of the specified size.
26305 @item byte_loop
26306 @itemx loop
26307 @itemx unrolled_loop
26308 Expand into an inline loop.
26310 @item libcall
26311 Always use a library call.
26312 @end table
26314 @item -mmemcpy-strategy=@var{strategy}
26315 @opindex mmemcpy-strategy=@var{strategy}
26316 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26317 should be inlined and what inline algorithm to use when the expected size
26318 of the copy operation is known. @var{strategy} 
26319 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26320 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26321 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26322 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26323 in the list must be specified in increasing order.  The minimal byte size for 
26324 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26325 preceding range.
26327 @item -mmemset-strategy=@var{strategy}
26328 @opindex mmemset-strategy=@var{strategy}
26329 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26330 @code{__builtin_memset} expansion.
26332 @item -momit-leaf-frame-pointer
26333 @opindex momit-leaf-frame-pointer
26334 Don't keep the frame pointer in a register for leaf functions.  This
26335 avoids the instructions to save, set up, and restore frame pointers and
26336 makes an extra register available in leaf functions.  The option
26337 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26338 which might make debugging harder.
26340 @item -mtls-direct-seg-refs
26341 @itemx -mno-tls-direct-seg-refs
26342 @opindex mtls-direct-seg-refs
26343 Controls whether TLS variables may be accessed with offsets from the
26344 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26345 or whether the thread base pointer must be added.  Whether or not this
26346 is valid depends on the operating system, and whether it maps the
26347 segment to cover the entire TLS area.
26349 For systems that use the GNU C Library, the default is on.
26351 @item -msse2avx
26352 @itemx -mno-sse2avx
26353 @opindex msse2avx
26354 Specify that the assembler should encode SSE instructions with VEX
26355 prefix.  The option @option{-mavx} turns this on by default.
26357 @item -mfentry
26358 @itemx -mno-fentry
26359 @opindex mfentry
26360 If profiling is active (@option{-pg}), put the profiling
26361 counter call before the prologue.
26362 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26363 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26365 @item -mrecord-mcount
26366 @itemx -mno-record-mcount
26367 @opindex mrecord-mcount
26368 If profiling is active (@option{-pg}), generate a __mcount_loc section
26369 that contains pointers to each profiling call. This is useful for
26370 automatically patching and out calls.
26372 @item -mnop-mcount
26373 @itemx -mno-nop-mcount
26374 @opindex mnop-mcount
26375 If profiling is active (@option{-pg}), generate the calls to
26376 the profiling functions as NOPs. This is useful when they
26377 should be patched in later dynamically. This is likely only
26378 useful together with @option{-mrecord-mcount}.
26380 @item -mskip-rax-setup
26381 @itemx -mno-skip-rax-setup
26382 @opindex mskip-rax-setup
26383 When generating code for the x86-64 architecture with SSE extensions
26384 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26385 register when there are no variable arguments passed in vector registers.
26387 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26388 saving vector registers on stack when passing variable arguments, the
26389 impacts of this option are callees may waste some stack space,
26390 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26391 those issues, regardless the RAX register value.
26393 @item -m8bit-idiv
26394 @itemx -mno-8bit-idiv
26395 @opindex m8bit-idiv
26396 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26397 much faster than 32-bit/64-bit integer divide.  This option generates a
26398 run-time check.  If both dividend and divisor are within range of 0
26399 to 255, 8-bit unsigned integer divide is used instead of
26400 32-bit/64-bit integer divide.
26402 @item -mavx256-split-unaligned-load
26403 @itemx -mavx256-split-unaligned-store
26404 @opindex mavx256-split-unaligned-load
26405 @opindex mavx256-split-unaligned-store
26406 Split 32-byte AVX unaligned load and store.
26408 @item -mstack-protector-guard=@var{guard}
26409 @itemx -mstack-protector-guard-reg=@var{reg}
26410 @itemx -mstack-protector-guard-offset=@var{offset}
26411 @opindex mstack-protector-guard
26412 @opindex mstack-protector-guard-reg
26413 @opindex mstack-protector-guard-offset
26414 Generate stack protection code using canary at @var{guard}.  Supported
26415 locations are @samp{global} for global canary or @samp{tls} for per-thread
26416 canary in the TLS block (the default).  This option has effect only when
26417 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26419 With the latter choice the options
26420 @option{-mstack-protector-guard-reg=@var{reg}} and
26421 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26422 which segment register (@code{%fs} or @code{%gs}) to use as base register
26423 for reading the canary, and from what offset from that base register.
26424 The default for those is as specified in the relevant ABI.
26426 @item -mmitigate-rop
26427 @opindex mmitigate-rop
26428 Try to avoid generating code sequences that contain unintended return
26429 opcodes, to mitigate against certain forms of attack. At the moment,
26430 this option is limited in what it can do and should not be relied
26431 on to provide serious protection.
26433 @item -mgeneral-regs-only
26434 @opindex mgeneral-regs-only
26435 Generate code that uses only the general-purpose registers.  This
26436 prevents the compiler from using floating-point, vector, mask and bound
26437 registers.
26439 @end table
26441 These @samp{-m} switches are supported in addition to the above
26442 on x86-64 processors in 64-bit environments.
26444 @table @gcctabopt
26445 @item -m32
26446 @itemx -m64
26447 @itemx -mx32
26448 @itemx -m16
26449 @itemx -miamcu
26450 @opindex m32
26451 @opindex m64
26452 @opindex mx32
26453 @opindex m16
26454 @opindex miamcu
26455 Generate code for a 16-bit, 32-bit or 64-bit environment.
26456 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26457 to 32 bits, and
26458 generates code that runs on any i386 system.
26460 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26461 types to 64 bits, and generates code for the x86-64 architecture.
26462 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26463 and @option{-mdynamic-no-pic} options.
26465 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26466 to 32 bits, and
26467 generates code for the x86-64 architecture.
26469 The @option{-m16} option is the same as @option{-m32}, except for that
26470 it outputs the @code{.code16gcc} assembly directive at the beginning of
26471 the assembly output so that the binary can run in 16-bit mode.
26473 The @option{-miamcu} option generates code which conforms to Intel MCU
26474 psABI.  It requires the @option{-m32} option to be turned on.
26476 @item -mno-red-zone
26477 @opindex mno-red-zone
26478 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26479 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26480 stack pointer that is not modified by signal or interrupt handlers
26481 and therefore can be used for temporary data without adjusting the stack
26482 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26484 @item -mcmodel=small
26485 @opindex mcmodel=small
26486 Generate code for the small code model: the program and its symbols must
26487 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26488 Programs can be statically or dynamically linked.  This is the default
26489 code model.
26491 @item -mcmodel=kernel
26492 @opindex mcmodel=kernel
26493 Generate code for the kernel code model.  The kernel runs in the
26494 negative 2 GB of the address space.
26495 This model has to be used for Linux kernel code.
26497 @item -mcmodel=medium
26498 @opindex mcmodel=medium
26499 Generate code for the medium model: the program is linked in the lower 2
26500 GB of the address space.  Small symbols are also placed there.  Symbols
26501 with sizes larger than @option{-mlarge-data-threshold} are put into
26502 large data or BSS sections and can be located above 2GB.  Programs can
26503 be statically or dynamically linked.
26505 @item -mcmodel=large
26506 @opindex mcmodel=large
26507 Generate code for the large model.  This model makes no assumptions
26508 about addresses and sizes of sections.
26510 @item -maddress-mode=long
26511 @opindex maddress-mode=long
26512 Generate code for long address mode.  This is only supported for 64-bit
26513 and x32 environments.  It is the default address mode for 64-bit
26514 environments.
26516 @item -maddress-mode=short
26517 @opindex maddress-mode=short
26518 Generate code for short address mode.  This is only supported for 32-bit
26519 and x32 environments.  It is the default address mode for 32-bit and
26520 x32 environments.
26521 @end table
26523 @node x86 Windows Options
26524 @subsection x86 Windows Options
26525 @cindex x86 Windows Options
26526 @cindex Windows Options for x86
26528 These additional options are available for Microsoft Windows targets:
26530 @table @gcctabopt
26531 @item -mconsole
26532 @opindex mconsole
26533 This option
26534 specifies that a console application is to be generated, by
26535 instructing the linker to set the PE header subsystem type
26536 required for console applications.
26537 This option is available for Cygwin and MinGW targets and is
26538 enabled by default on those targets.
26540 @item -mdll
26541 @opindex mdll
26542 This option is available for Cygwin and MinGW targets.  It
26543 specifies that a DLL---a dynamic link library---is to be
26544 generated, enabling the selection of the required runtime
26545 startup object and entry point.
26547 @item -mnop-fun-dllimport
26548 @opindex mnop-fun-dllimport
26549 This option is available for Cygwin and MinGW targets.  It
26550 specifies that the @code{dllimport} attribute should be ignored.
26552 @item -mthread
26553 @opindex mthread
26554 This option is available for MinGW targets. It specifies
26555 that MinGW-specific thread support is to be used.
26557 @item -municode
26558 @opindex municode
26559 This option is available for MinGW-w64 targets.  It causes
26560 the @code{UNICODE} preprocessor macro to be predefined, and
26561 chooses Unicode-capable runtime startup code.
26563 @item -mwin32
26564 @opindex mwin32
26565 This option is available for Cygwin and MinGW targets.  It
26566 specifies that the typical Microsoft Windows predefined macros are to
26567 be set in the pre-processor, but does not influence the choice
26568 of runtime library/startup code.
26570 @item -mwindows
26571 @opindex mwindows
26572 This option is available for Cygwin and MinGW targets.  It
26573 specifies that a GUI application is to be generated by
26574 instructing the linker to set the PE header subsystem type
26575 appropriately.
26577 @item -fno-set-stack-executable
26578 @opindex fno-set-stack-executable
26579 This option is available for MinGW targets. It specifies that
26580 the executable flag for the stack used by nested functions isn't
26581 set. This is necessary for binaries running in kernel mode of
26582 Microsoft Windows, as there the User32 API, which is used to set executable
26583 privileges, isn't available.
26585 @item -fwritable-relocated-rdata
26586 @opindex fno-writable-relocated-rdata
26587 This option is available for MinGW and Cygwin targets.  It specifies
26588 that relocated-data in read-only section is put into the @code{.data}
26589 section.  This is a necessary for older runtimes not supporting
26590 modification of @code{.rdata} sections for pseudo-relocation.
26592 @item -mpe-aligned-commons
26593 @opindex mpe-aligned-commons
26594 This option is available for Cygwin and MinGW targets.  It
26595 specifies that the GNU extension to the PE file format that
26596 permits the correct alignment of COMMON variables should be
26597 used when generating code.  It is enabled by default if
26598 GCC detects that the target assembler found during configuration
26599 supports the feature.
26600 @end table
26602 See also under @ref{x86 Options} for standard options.
26604 @node Xstormy16 Options
26605 @subsection Xstormy16 Options
26606 @cindex Xstormy16 Options
26608 These options are defined for Xstormy16:
26610 @table @gcctabopt
26611 @item -msim
26612 @opindex msim
26613 Choose startup files and linker script suitable for the simulator.
26614 @end table
26616 @node Xtensa Options
26617 @subsection Xtensa Options
26618 @cindex Xtensa Options
26620 These options are supported for Xtensa targets:
26622 @table @gcctabopt
26623 @item -mconst16
26624 @itemx -mno-const16
26625 @opindex mconst16
26626 @opindex mno-const16
26627 Enable or disable use of @code{CONST16} instructions for loading
26628 constant values.  The @code{CONST16} instruction is currently not a
26629 standard option from Tensilica.  When enabled, @code{CONST16}
26630 instructions are always used in place of the standard @code{L32R}
26631 instructions.  The use of @code{CONST16} is enabled by default only if
26632 the @code{L32R} instruction is not available.
26634 @item -mfused-madd
26635 @itemx -mno-fused-madd
26636 @opindex mfused-madd
26637 @opindex mno-fused-madd
26638 Enable or disable use of fused multiply/add and multiply/subtract
26639 instructions in the floating-point option.  This has no effect if the
26640 floating-point option is not also enabled.  Disabling fused multiply/add
26641 and multiply/subtract instructions forces the compiler to use separate
26642 instructions for the multiply and add/subtract operations.  This may be
26643 desirable in some cases where strict IEEE 754-compliant results are
26644 required: the fused multiply add/subtract instructions do not round the
26645 intermediate result, thereby producing results with @emph{more} bits of
26646 precision than specified by the IEEE standard.  Disabling fused multiply
26647 add/subtract instructions also ensures that the program output is not
26648 sensitive to the compiler's ability to combine multiply and add/subtract
26649 operations.
26651 @item -mserialize-volatile
26652 @itemx -mno-serialize-volatile
26653 @opindex mserialize-volatile
26654 @opindex mno-serialize-volatile
26655 When this option is enabled, GCC inserts @code{MEMW} instructions before
26656 @code{volatile} memory references to guarantee sequential consistency.
26657 The default is @option{-mserialize-volatile}.  Use
26658 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26660 @item -mforce-no-pic
26661 @opindex mforce-no-pic
26662 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26663 position-independent code (PIC), this option disables PIC for compiling
26664 kernel code.
26666 @item -mtext-section-literals
26667 @itemx -mno-text-section-literals
26668 @opindex mtext-section-literals
26669 @opindex mno-text-section-literals
26670 These options control the treatment of literal pools.  The default is
26671 @option{-mno-text-section-literals}, which places literals in a separate
26672 section in the output file.  This allows the literal pool to be placed
26673 in a data RAM/ROM, and it also allows the linker to combine literal
26674 pools from separate object files to remove redundant literals and
26675 improve code size.  With @option{-mtext-section-literals}, the literals
26676 are interspersed in the text section in order to keep them as close as
26677 possible to their references.  This may be necessary for large assembly
26678 files.  Literals for each function are placed right before that function.
26680 @item -mauto-litpools
26681 @itemx -mno-auto-litpools
26682 @opindex mauto-litpools
26683 @opindex mno-auto-litpools
26684 These options control the treatment of literal pools.  The default is
26685 @option{-mno-auto-litpools}, which places literals in a separate
26686 section in the output file unless @option{-mtext-section-literals} is
26687 used.  With @option{-mauto-litpools} the literals are interspersed in
26688 the text section by the assembler.  Compiler does not produce explicit
26689 @code{.literal} directives and loads literals into registers with
26690 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26691 do relaxation and place literals as necessary.  This option allows
26692 assembler to create several literal pools per function and assemble
26693 very big functions, which may not be possible with
26694 @option{-mtext-section-literals}.
26696 @item -mtarget-align
26697 @itemx -mno-target-align
26698 @opindex mtarget-align
26699 @opindex mno-target-align
26700 When this option is enabled, GCC instructs the assembler to
26701 automatically align instructions to reduce branch penalties at the
26702 expense of some code density.  The assembler attempts to widen density
26703 instructions to align branch targets and the instructions following call
26704 instructions.  If there are not enough preceding safe density
26705 instructions to align a target, no widening is performed.  The
26706 default is @option{-mtarget-align}.  These options do not affect the
26707 treatment of auto-aligned instructions like @code{LOOP}, which the
26708 assembler always aligns, either by widening density instructions or
26709 by inserting NOP instructions.
26711 @item -mlongcalls
26712 @itemx -mno-longcalls
26713 @opindex mlongcalls
26714 @opindex mno-longcalls
26715 When this option is enabled, GCC instructs the assembler to translate
26716 direct calls to indirect calls unless it can determine that the target
26717 of a direct call is in the range allowed by the call instruction.  This
26718 translation typically occurs for calls to functions in other source
26719 files.  Specifically, the assembler translates a direct @code{CALL}
26720 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26721 The default is @option{-mno-longcalls}.  This option should be used in
26722 programs where the call target can potentially be out of range.  This
26723 option is implemented in the assembler, not the compiler, so the
26724 assembly code generated by GCC still shows direct call
26725 instructions---look at the disassembled object code to see the actual
26726 instructions.  Note that the assembler uses an indirect call for
26727 every cross-file call, not just those that really are out of range.
26728 @end table
26730 @node zSeries Options
26731 @subsection zSeries Options
26732 @cindex zSeries options
26734 These are listed under @xref{S/390 and zSeries Options}.
26737 @c man end
26739 @node Spec Files
26740 @section Specifying Subprocesses and the Switches to Pass to Them
26741 @cindex Spec Files
26743 @command{gcc} is a driver program.  It performs its job by invoking a
26744 sequence of other programs to do the work of compiling, assembling and
26745 linking.  GCC interprets its command-line parameters and uses these to
26746 deduce which programs it should invoke, and which command-line options
26747 it ought to place on their command lines.  This behavior is controlled
26748 by @dfn{spec strings}.  In most cases there is one spec string for each
26749 program that GCC can invoke, but a few programs have multiple spec
26750 strings to control their behavior.  The spec strings built into GCC can
26751 be overridden by using the @option{-specs=} command-line switch to specify
26752 a spec file.
26754 @dfn{Spec files} are plain-text files that are used to construct spec
26755 strings.  They consist of a sequence of directives separated by blank
26756 lines.  The type of directive is determined by the first non-whitespace
26757 character on the line, which can be one of the following:
26759 @table @code
26760 @item %@var{command}
26761 Issues a @var{command} to the spec file processor.  The commands that can
26762 appear here are:
26764 @table @code
26765 @item %include <@var{file}>
26766 @cindex @code{%include}
26767 Search for @var{file} and insert its text at the current point in the
26768 specs file.
26770 @item %include_noerr <@var{file}>
26771 @cindex @code{%include_noerr}
26772 Just like @samp{%include}, but do not generate an error message if the include
26773 file cannot be found.
26775 @item %rename @var{old_name} @var{new_name}
26776 @cindex @code{%rename}
26777 Rename the spec string @var{old_name} to @var{new_name}.
26779 @end table
26781 @item *[@var{spec_name}]:
26782 This tells the compiler to create, override or delete the named spec
26783 string.  All lines after this directive up to the next directive or
26784 blank line are considered to be the text for the spec string.  If this
26785 results in an empty string then the spec is deleted.  (Or, if the
26786 spec did not exist, then nothing happens.)  Otherwise, if the spec
26787 does not currently exist a new spec is created.  If the spec does
26788 exist then its contents are overridden by the text of this
26789 directive, unless the first character of that text is the @samp{+}
26790 character, in which case the text is appended to the spec.
26792 @item [@var{suffix}]:
26793 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26794 and up to the next directive or blank line are considered to make up the
26795 spec string for the indicated suffix.  When the compiler encounters an
26796 input file with the named suffix, it processes the spec string in
26797 order to work out how to compile that file.  For example:
26799 @smallexample
26800 .ZZ:
26801 z-compile -input %i
26802 @end smallexample
26804 This says that any input file whose name ends in @samp{.ZZ} should be
26805 passed to the program @samp{z-compile}, which should be invoked with the
26806 command-line switch @option{-input} and with the result of performing the
26807 @samp{%i} substitution.  (See below.)
26809 As an alternative to providing a spec string, the text following a
26810 suffix directive can be one of the following:
26812 @table @code
26813 @item @@@var{language}
26814 This says that the suffix is an alias for a known @var{language}.  This is
26815 similar to using the @option{-x} command-line switch to GCC to specify a
26816 language explicitly.  For example:
26818 @smallexample
26819 .ZZ:
26820 @@c++
26821 @end smallexample
26823 Says that .ZZ files are, in fact, C++ source files.
26825 @item #@var{name}
26826 This causes an error messages saying:
26828 @smallexample
26829 @var{name} compiler not installed on this system.
26830 @end smallexample
26831 @end table
26833 GCC already has an extensive list of suffixes built into it.
26834 This directive adds an entry to the end of the list of suffixes, but
26835 since the list is searched from the end backwards, it is effectively
26836 possible to override earlier entries using this technique.
26838 @end table
26840 GCC has the following spec strings built into it.  Spec files can
26841 override these strings or create their own.  Note that individual
26842 targets can also add their own spec strings to this list.
26844 @smallexample
26845 asm          Options to pass to the assembler
26846 asm_final    Options to pass to the assembler post-processor
26847 cpp          Options to pass to the C preprocessor
26848 cc1          Options to pass to the C compiler
26849 cc1plus      Options to pass to the C++ compiler
26850 endfile      Object files to include at the end of the link
26851 link         Options to pass to the linker
26852 lib          Libraries to include on the command line to the linker
26853 libgcc       Decides which GCC support library to pass to the linker
26854 linker       Sets the name of the linker
26855 predefines   Defines to be passed to the C preprocessor
26856 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26857              by default
26858 startfile    Object files to include at the start of the link
26859 @end smallexample
26861 Here is a small example of a spec file:
26863 @smallexample
26864 %rename lib                 old_lib
26866 *lib:
26867 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26868 @end smallexample
26870 This example renames the spec called @samp{lib} to @samp{old_lib} and
26871 then overrides the previous definition of @samp{lib} with a new one.
26872 The new definition adds in some extra command-line options before
26873 including the text of the old definition.
26875 @dfn{Spec strings} are a list of command-line options to be passed to their
26876 corresponding program.  In addition, the spec strings can contain
26877 @samp{%}-prefixed sequences to substitute variable text or to
26878 conditionally insert text into the command line.  Using these constructs
26879 it is possible to generate quite complex command lines.
26881 Here is a table of all defined @samp{%}-sequences for spec
26882 strings.  Note that spaces are not generated automatically around the
26883 results of expanding these sequences.  Therefore you can concatenate them
26884 together or combine them with constant text in a single argument.
26886 @table @code
26887 @item %%
26888 Substitute one @samp{%} into the program name or argument.
26890 @item %i
26891 Substitute the name of the input file being processed.
26893 @item %b
26894 Substitute the basename of the input file being processed.
26895 This is the substring up to (and not including) the last period
26896 and not including the directory.
26898 @item %B
26899 This is the same as @samp{%b}, but include the file suffix (text after
26900 the last period).
26902 @item %d
26903 Marks the argument containing or following the @samp{%d} as a
26904 temporary file name, so that that file is deleted if GCC exits
26905 successfully.  Unlike @samp{%g}, this contributes no text to the
26906 argument.
26908 @item %g@var{suffix}
26909 Substitute a file name that has suffix @var{suffix} and is chosen
26910 once per compilation, and mark the argument in the same way as
26911 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26912 name is now chosen in a way that is hard to predict even when previously
26913 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26914 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26915 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26916 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26917 was simply substituted with a file name chosen once per compilation,
26918 without regard to any appended suffix (which was therefore treated
26919 just like ordinary text), making such attacks more likely to succeed.
26921 @item %u@var{suffix}
26922 Like @samp{%g}, but generates a new temporary file name
26923 each time it appears instead of once per compilation.
26925 @item %U@var{suffix}
26926 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26927 new one if there is no such last file name.  In the absence of any
26928 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26929 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26930 involves the generation of two distinct file names, one
26931 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26932 simply substituted with a file name chosen for the previous @samp{%u},
26933 without regard to any appended suffix.
26935 @item %j@var{suffix}
26936 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26937 writable, and if @option{-save-temps} is not used; 
26938 otherwise, substitute the name
26939 of a temporary file, just like @samp{%u}.  This temporary file is not
26940 meant for communication between processes, but rather as a junk
26941 disposal mechanism.
26943 @item %|@var{suffix}
26944 @itemx %m@var{suffix}
26945 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26946 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26947 all.  These are the two most common ways to instruct a program that it
26948 should read from standard input or write to standard output.  If you
26949 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26950 construct: see for example @file{f/lang-specs.h}.
26952 @item %.@var{SUFFIX}
26953 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26954 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26955 terminated by the next space or %.
26957 @item %w
26958 Marks the argument containing or following the @samp{%w} as the
26959 designated output file of this compilation.  This puts the argument
26960 into the sequence of arguments that @samp{%o} substitutes.
26962 @item %o
26963 Substitutes the names of all the output files, with spaces
26964 automatically placed around them.  You should write spaces
26965 around the @samp{%o} as well or the results are undefined.
26966 @samp{%o} is for use in the specs for running the linker.
26967 Input files whose names have no recognized suffix are not compiled
26968 at all, but they are included among the output files, so they are
26969 linked.
26971 @item %O
26972 Substitutes the suffix for object files.  Note that this is
26973 handled specially when it immediately follows @samp{%g, %u, or %U},
26974 because of the need for those to form complete file names.  The
26975 handling is such that @samp{%O} is treated exactly as if it had already
26976 been substituted, except that @samp{%g, %u, and %U} do not currently
26977 support additional @var{suffix} characters following @samp{%O} as they do
26978 following, for example, @samp{.o}.
26980 @item %p
26981 Substitutes the standard macro predefinitions for the
26982 current target machine.  Use this when running @command{cpp}.
26984 @item %P
26985 Like @samp{%p}, but puts @samp{__} before and after the name of each
26986 predefined macro, except for macros that start with @samp{__} or with
26987 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26990 @item %I
26991 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26992 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26993 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26994 and @option{-imultilib} as necessary.
26996 @item %s
26997 Current argument is the name of a library or startup file of some sort.
26998 Search for that file in a standard list of directories and substitute
26999 the full name found.  The current working directory is included in the
27000 list of directories scanned.
27002 @item %T
27003 Current argument is the name of a linker script.  Search for that file
27004 in the current list of directories to scan for libraries. If the file
27005 is located insert a @option{--script} option into the command line
27006 followed by the full path name found.  If the file is not found then
27007 generate an error message.  Note: the current working directory is not
27008 searched.
27010 @item %e@var{str}
27011 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27012 Use this when inconsistent options are detected.
27014 @item %(@var{name})
27015 Substitute the contents of spec string @var{name} at this point.
27017 @item %x@{@var{option}@}
27018 Accumulate an option for @samp{%X}.
27020 @item %X
27021 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27022 spec string.
27024 @item %Y
27025 Output the accumulated assembler options specified by @option{-Wa}.
27027 @item %Z
27028 Output the accumulated preprocessor options specified by @option{-Wp}.
27030 @item %a
27031 Process the @code{asm} spec.  This is used to compute the
27032 switches to be passed to the assembler.
27034 @item %A
27035 Process the @code{asm_final} spec.  This is a spec string for
27036 passing switches to an assembler post-processor, if such a program is
27037 needed.
27039 @item %l
27040 Process the @code{link} spec.  This is the spec for computing the
27041 command line passed to the linker.  Typically it makes use of the
27042 @samp{%L %G %S %D and %E} sequences.
27044 @item %D
27045 Dump out a @option{-L} option for each directory that GCC believes might
27046 contain startup files.  If the target supports multilibs then the
27047 current multilib directory is prepended to each of these paths.
27049 @item %L
27050 Process the @code{lib} spec.  This is a spec string for deciding which
27051 libraries are included on the command line to the linker.
27053 @item %G
27054 Process the @code{libgcc} spec.  This is a spec string for deciding
27055 which GCC support library is included on the command line to the linker.
27057 @item %S
27058 Process the @code{startfile} spec.  This is a spec for deciding which
27059 object files are the first ones passed to the linker.  Typically
27060 this might be a file named @file{crt0.o}.
27062 @item %E
27063 Process the @code{endfile} spec.  This is a spec string that specifies
27064 the last object files that are passed to the linker.
27066 @item %C
27067 Process the @code{cpp} spec.  This is used to construct the arguments
27068 to be passed to the C preprocessor.
27070 @item %1
27071 Process the @code{cc1} spec.  This is used to construct the options to be
27072 passed to the actual C compiler (@command{cc1}).
27074 @item %2
27075 Process the @code{cc1plus} spec.  This is used to construct the options to be
27076 passed to the actual C++ compiler (@command{cc1plus}).
27078 @item %*
27079 Substitute the variable part of a matched option.  See below.
27080 Note that each comma in the substituted string is replaced by
27081 a single space.
27083 @item %<S
27084 Remove all occurrences of @code{-S} from the command line.  Note---this
27085 command is position dependent.  @samp{%} commands in the spec string
27086 before this one see @code{-S}, @samp{%} commands in the spec string
27087 after this one do not.
27089 @item %:@var{function}(@var{args})
27090 Call the named function @var{function}, passing it @var{args}.
27091 @var{args} is first processed as a nested spec string, then split
27092 into an argument vector in the usual fashion.  The function returns
27093 a string which is processed as if it had appeared literally as part
27094 of the current spec.
27096 The following built-in spec functions are provided:
27098 @table @code
27099 @item @code{getenv}
27100 The @code{getenv} spec function takes two arguments: an environment
27101 variable name and a string.  If the environment variable is not
27102 defined, a fatal error is issued.  Otherwise, the return value is the
27103 value of the environment variable concatenated with the string.  For
27104 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27106 @smallexample
27107 %:getenv(TOPDIR /include)
27108 @end smallexample
27110 expands to @file{/path/to/top/include}.
27112 @item @code{if-exists}
27113 The @code{if-exists} spec function takes one argument, an absolute
27114 pathname to a file.  If the file exists, @code{if-exists} returns the
27115 pathname.  Here is a small example of its usage:
27117 @smallexample
27118 *startfile:
27119 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27120 @end smallexample
27122 @item @code{if-exists-else}
27123 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27124 spec function, except that it takes two arguments.  The first argument is
27125 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27126 returns the pathname.  If it does not exist, it returns the second argument.
27127 This way, @code{if-exists-else} can be used to select one file or another,
27128 based on the existence of the first.  Here is a small example of its usage:
27130 @smallexample
27131 *startfile:
27132 crt0%O%s %:if-exists(crti%O%s) \
27133 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27134 @end smallexample
27136 @item @code{replace-outfile}
27137 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27138 first argument in the outfiles array and replaces it with the second argument.  Here
27139 is a small example of its usage:
27141 @smallexample
27142 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27143 @end smallexample
27145 @item @code{remove-outfile}
27146 The @code{remove-outfile} spec function takes one argument.  It looks for the
27147 first argument in the outfiles array and removes it.  Here is a small example
27148 its usage:
27150 @smallexample
27151 %:remove-outfile(-lm)
27152 @end smallexample
27154 @item @code{pass-through-libs}
27155 The @code{pass-through-libs} spec function takes any number of arguments.  It
27156 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27157 assumes are the names of linker input library archive files) and returns a
27158 result containing all the found arguments each prepended by
27159 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27160 intended to be passed to the LTO linker plugin.
27162 @smallexample
27163 %:pass-through-libs(%G %L %G)
27164 @end smallexample
27166 @item @code{print-asm-header}
27167 The @code{print-asm-header} function takes no arguments and simply
27168 prints a banner like:
27170 @smallexample
27171 Assembler options
27172 =================
27174 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27175 @end smallexample
27177 It is used to separate compiler options from assembler options
27178 in the @option{--target-help} output.
27179 @end table
27181 @item %@{S@}
27182 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27183 If that switch is not specified, this substitutes nothing.  Note that
27184 the leading dash is omitted when specifying this option, and it is
27185 automatically inserted if the substitution is performed.  Thus the spec
27186 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27187 and outputs the command-line option @option{-foo}.
27189 @item %W@{S@}
27190 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27191 deleted on failure.
27193 @item %@{S*@}
27194 Substitutes all the switches specified to GCC whose names start
27195 with @code{-S}, but which also take an argument.  This is used for
27196 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27197 GCC considers @option{-o foo} as being
27198 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27199 text, including the space.  Thus two arguments are generated.
27201 @item %@{S*&T*@}
27202 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27203 (the order of @code{S} and @code{T} in the spec is not significant).
27204 There can be any number of ampersand-separated variables; for each the
27205 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27207 @item %@{S:X@}
27208 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27210 @item %@{!S:X@}
27211 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27213 @item %@{S*:X@}
27214 Substitutes @code{X} if one or more switches whose names start with
27215 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27216 once, no matter how many such switches appeared.  However, if @code{%*}
27217 appears somewhere in @code{X}, then @code{X} is substituted once
27218 for each matching switch, with the @code{%*} replaced by the part of
27219 that switch matching the @code{*}.
27221 If @code{%*} appears as the last part of a spec sequence then a space
27222 is added after the end of the last substitution.  If there is more
27223 text in the sequence, however, then a space is not generated.  This
27224 allows the @code{%*} substitution to be used as part of a larger
27225 string.  For example, a spec string like this:
27227 @smallexample
27228 %@{mcu=*:--script=%*/memory.ld@}
27229 @end smallexample
27231 @noindent
27232 when matching an option like @option{-mcu=newchip} produces:
27234 @smallexample
27235 --script=newchip/memory.ld
27236 @end smallexample
27238 @item %@{.S:X@}
27239 Substitutes @code{X}, if processing a file with suffix @code{S}.
27241 @item %@{!.S:X@}
27242 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27244 @item %@{,S:X@}
27245 Substitutes @code{X}, if processing a file for language @code{S}.
27247 @item %@{!,S:X@}
27248 Substitutes @code{X}, if not processing a file for language @code{S}.
27250 @item %@{S|P:X@}
27251 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27252 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27253 @code{*} sequences as well, although they have a stronger binding than
27254 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27255 alternatives must be starred, and only the first matching alternative
27256 is substituted.
27258 For example, a spec string like this:
27260 @smallexample
27261 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27262 @end smallexample
27264 @noindent
27265 outputs the following command-line options from the following input
27266 command-line options:
27268 @smallexample
27269 fred.c        -foo -baz
27270 jim.d         -bar -boggle
27271 -d fred.c     -foo -baz -boggle
27272 -d jim.d      -bar -baz -boggle
27273 @end smallexample
27275 @item %@{S:X; T:Y; :D@}
27277 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27278 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27279 be as many clauses as you need.  This may be combined with @code{.},
27280 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27283 @end table
27285 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27286 or similar construct can use a backslash to ignore the special meaning
27287 of the character following it, thus allowing literal matching of a
27288 character that is otherwise specially treated.  For example,
27289 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27290 @option{-std=iso9899:1999} option is given.
27292 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27293 construct may contain other nested @samp{%} constructs or spaces, or
27294 even newlines.  They are processed as usual, as described above.
27295 Trailing white space in @code{X} is ignored.  White space may also
27296 appear anywhere on the left side of the colon in these constructs,
27297 except between @code{.} or @code{*} and the corresponding word.
27299 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27300 handled specifically in these constructs.  If another value of
27301 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27302 @option{-W} switch is found later in the command line, the earlier
27303 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27304 just one letter, which passes all matching options.
27306 The character @samp{|} at the beginning of the predicate text is used to
27307 indicate that a command should be piped to the following command, but
27308 only if @option{-pipe} is specified.
27310 It is built into GCC which switches take arguments and which do not.
27311 (You might think it would be useful to generalize this to allow each
27312 compiler's spec to say which switches take arguments.  But this cannot
27313 be done in a consistent fashion.  GCC cannot even decide which input
27314 files have been specified without knowing which switches take arguments,
27315 and it must know which input files to compile in order to tell which
27316 compilers to run).
27318 GCC also knows implicitly that arguments starting in @option{-l} are to be
27319 treated as compiler output files, and passed to the linker in their
27320 proper position among the other output files.
27322 @node Environment Variables
27323 @section Environment Variables Affecting GCC
27324 @cindex environment variables
27326 @c man begin ENVIRONMENT
27327 This section describes several environment variables that affect how GCC
27328 operates.  Some of them work by specifying directories or prefixes to use
27329 when searching for various kinds of files.  Some are used to specify other
27330 aspects of the compilation environment.
27332 Note that you can also specify places to search using options such as
27333 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27334 take precedence over places specified using environment variables, which
27335 in turn take precedence over those specified by the configuration of GCC@.
27336 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27337 GNU Compiler Collection (GCC) Internals}.
27339 @table @env
27340 @item LANG
27341 @itemx LC_CTYPE
27342 @c @itemx LC_COLLATE
27343 @itemx LC_MESSAGES
27344 @c @itemx LC_MONETARY
27345 @c @itemx LC_NUMERIC
27346 @c @itemx LC_TIME
27347 @itemx LC_ALL
27348 @findex LANG
27349 @findex LC_CTYPE
27350 @c @findex LC_COLLATE
27351 @findex LC_MESSAGES
27352 @c @findex LC_MONETARY
27353 @c @findex LC_NUMERIC
27354 @c @findex LC_TIME
27355 @findex LC_ALL
27356 @cindex locale
27357 These environment variables control the way that GCC uses
27358 localization information which allows GCC to work with different
27359 national conventions.  GCC inspects the locale categories
27360 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27361 so.  These locale categories can be set to any value supported by your
27362 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27363 Kingdom encoded in UTF-8.
27365 The @env{LC_CTYPE} environment variable specifies character
27366 classification.  GCC uses it to determine the character boundaries in
27367 a string; this is needed for some multibyte encodings that contain quote
27368 and escape characters that are otherwise interpreted as a string
27369 end or escape.
27371 The @env{LC_MESSAGES} environment variable specifies the language to
27372 use in diagnostic messages.
27374 If the @env{LC_ALL} environment variable is set, it overrides the value
27375 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27376 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27377 environment variable.  If none of these variables are set, GCC
27378 defaults to traditional C English behavior.
27380 @item TMPDIR
27381 @findex TMPDIR
27382 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27383 files.  GCC uses temporary files to hold the output of one stage of
27384 compilation which is to be used as input to the next stage: for example,
27385 the output of the preprocessor, which is the input to the compiler
27386 proper.
27388 @item GCC_COMPARE_DEBUG
27389 @findex GCC_COMPARE_DEBUG
27390 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27391 @option{-fcompare-debug} to the compiler driver.  See the documentation
27392 of this option for more details.
27394 @item GCC_EXEC_PREFIX
27395 @findex GCC_EXEC_PREFIX
27396 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27397 names of the subprograms executed by the compiler.  No slash is added
27398 when this prefix is combined with the name of a subprogram, but you can
27399 specify a prefix that ends with a slash if you wish.
27401 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27402 an appropriate prefix to use based on the pathname it is invoked with.
27404 If GCC cannot find the subprogram using the specified prefix, it
27405 tries looking in the usual places for the subprogram.
27407 The default value of @env{GCC_EXEC_PREFIX} is
27408 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27409 the installed compiler. In many cases @var{prefix} is the value
27410 of @code{prefix} when you ran the @file{configure} script.
27412 Other prefixes specified with @option{-B} take precedence over this prefix.
27414 This prefix is also used for finding files such as @file{crt0.o} that are
27415 used for linking.
27417 In addition, the prefix is used in an unusual way in finding the
27418 directories to search for header files.  For each of the standard
27419 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27420 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27421 replacing that beginning with the specified prefix to produce an
27422 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27423 @file{foo/bar} just before it searches the standard directory 
27424 @file{/usr/local/lib/bar}.
27425 If a standard directory begins with the configured
27426 @var{prefix} then the value of @var{prefix} is replaced by
27427 @env{GCC_EXEC_PREFIX} when looking for header files.
27429 @item COMPILER_PATH
27430 @findex COMPILER_PATH
27431 The value of @env{COMPILER_PATH} is a colon-separated list of
27432 directories, much like @env{PATH}.  GCC tries the directories thus
27433 specified when searching for subprograms, if it cannot find the
27434 subprograms using @env{GCC_EXEC_PREFIX}.
27436 @item LIBRARY_PATH
27437 @findex LIBRARY_PATH
27438 The value of @env{LIBRARY_PATH} is a colon-separated list of
27439 directories, much like @env{PATH}.  When configured as a native compiler,
27440 GCC tries the directories thus specified when searching for special
27441 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27442 using GCC also uses these directories when searching for ordinary
27443 libraries for the @option{-l} option (but directories specified with
27444 @option{-L} come first).
27446 @item LANG
27447 @findex LANG
27448 @cindex locale definition
27449 This variable is used to pass locale information to the compiler.  One way in
27450 which this information is used is to determine the character set to be used
27451 when character literals, string literals and comments are parsed in C and C++.
27452 When the compiler is configured to allow multibyte characters,
27453 the following values for @env{LANG} are recognized:
27455 @table @samp
27456 @item C-JIS
27457 Recognize JIS characters.
27458 @item C-SJIS
27459 Recognize SJIS characters.
27460 @item C-EUCJP
27461 Recognize EUCJP characters.
27462 @end table
27464 If @env{LANG} is not defined, or if it has some other value, then the
27465 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27466 recognize and translate multibyte characters.
27467 @end table
27469 @noindent
27470 Some additional environment variables affect the behavior of the
27471 preprocessor.
27473 @include cppenv.texi
27475 @c man end
27477 @node Precompiled Headers
27478 @section Using Precompiled Headers
27479 @cindex precompiled headers
27480 @cindex speed of compilation
27482 Often large projects have many header files that are included in every
27483 source file.  The time the compiler takes to process these header files
27484 over and over again can account for nearly all of the time required to
27485 build the project.  To make builds faster, GCC allows you to
27486 @dfn{precompile} a header file.
27488 To create a precompiled header file, simply compile it as you would any
27489 other file, if necessary using the @option{-x} option to make the driver
27490 treat it as a C or C++ header file.  You may want to use a
27491 tool like @command{make} to keep the precompiled header up-to-date when
27492 the headers it contains change.
27494 A precompiled header file is searched for when @code{#include} is
27495 seen in the compilation.  As it searches for the included file
27496 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27497 compiler looks for a precompiled header in each directory just before it
27498 looks for the include file in that directory.  The name searched for is
27499 the name specified in the @code{#include} with @samp{.gch} appended.  If
27500 the precompiled header file cannot be used, it is ignored.
27502 For instance, if you have @code{#include "all.h"}, and you have
27503 @file{all.h.gch} in the same directory as @file{all.h}, then the
27504 precompiled header file is used if possible, and the original
27505 header is used otherwise.
27507 Alternatively, you might decide to put the precompiled header file in a
27508 directory and use @option{-I} to ensure that directory is searched
27509 before (or instead of) the directory containing the original header.
27510 Then, if you want to check that the precompiled header file is always
27511 used, you can put a file of the same name as the original header in this
27512 directory containing an @code{#error} command.
27514 This also works with @option{-include}.  So yet another way to use
27515 precompiled headers, good for projects not designed with precompiled
27516 header files in mind, is to simply take most of the header files used by
27517 a project, include them from another header file, precompile that header
27518 file, and @option{-include} the precompiled header.  If the header files
27519 have guards against multiple inclusion, they are skipped because
27520 they've already been included (in the precompiled header).
27522 If you need to precompile the same header file for different
27523 languages, targets, or compiler options, you can instead make a
27524 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27525 header in the directory, perhaps using @option{-o}.  It doesn't matter
27526 what you call the files in the directory; every precompiled header in
27527 the directory is considered.  The first precompiled header
27528 encountered in the directory that is valid for this compilation is
27529 used; they're searched in no particular order.
27531 There are many other possibilities, limited only by your imagination,
27532 good sense, and the constraints of your build system.
27534 A precompiled header file can be used only when these conditions apply:
27536 @itemize
27537 @item
27538 Only one precompiled header can be used in a particular compilation.
27540 @item
27541 A precompiled header cannot be used once the first C token is seen.  You
27542 can have preprocessor directives before a precompiled header; you cannot
27543 include a precompiled header from inside another header.
27545 @item
27546 The precompiled header file must be produced for the same language as
27547 the current compilation.  You cannot use a C precompiled header for a C++
27548 compilation.
27550 @item
27551 The precompiled header file must have been produced by the same compiler
27552 binary as the current compilation is using.
27554 @item
27555 Any macros defined before the precompiled header is included must
27556 either be defined in the same way as when the precompiled header was
27557 generated, or must not affect the precompiled header, which usually
27558 means that they don't appear in the precompiled header at all.
27560 The @option{-D} option is one way to define a macro before a
27561 precompiled header is included; using a @code{#define} can also do it.
27562 There are also some options that define macros implicitly, like
27563 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27564 defined this way.
27566 @item If debugging information is output when using the precompiled
27567 header, using @option{-g} or similar, the same kind of debugging information
27568 must have been output when building the precompiled header.  However,
27569 a precompiled header built using @option{-g} can be used in a compilation
27570 when no debugging information is being output.
27572 @item The same @option{-m} options must generally be used when building
27573 and using the precompiled header.  @xref{Submodel Options},
27574 for any cases where this rule is relaxed.
27576 @item Each of the following options must be the same when building and using
27577 the precompiled header:
27579 @gccoptlist{-fexceptions}
27581 @item
27582 Some other command-line options starting with @option{-f},
27583 @option{-p}, or @option{-O} must be defined in the same way as when
27584 the precompiled header was generated.  At present, it's not clear
27585 which options are safe to change and which are not; the safest choice
27586 is to use exactly the same options when generating and using the
27587 precompiled header.  The following are known to be safe:
27589 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27590 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27591 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27592 -pedantic-errors}
27594 @end itemize
27596 For all of these except the last, the compiler automatically
27597 ignores the precompiled header if the conditions aren't met.  If you
27598 find an option combination that doesn't work and doesn't cause the
27599 precompiled header to be ignored, please consider filing a bug report,
27600 see @ref{Bugs}.
27602 If you do use differing options when generating and using the
27603 precompiled header, the actual behavior is a mixture of the
27604 behavior for the options.  For instance, if you use @option{-g} to
27605 generate the precompiled header but not when using it, you may or may
27606 not get debugging information for routines in the precompiled header.