i386: Don't use frame pointer without stack access
[official-gcc.git] / gcc / doc / invoke.texi
blob3753d8a992b3290b4a0884defe21858f94d0ba79
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  -Wcast-align  -Wcast-qual  @gol
270 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
271 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
272 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
273 -Wdelete-incomplete @gol
274 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
275 -Wdisabled-optimization @gol
276 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
277 -Wno-div-by-zero  -Wdouble-promotion @gol
278 -Wduplicated-branches  -Wduplicated-cond @gol
279 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
280 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
281 -Wfloat-equal  -Wformat  -Wformat=2 @gol
282 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
283 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
284 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
285 -Wformat-y2k  -Wframe-address @gol
286 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
287 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
288 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
289 -Wimplicit-function-declaration  -Wimplicit-int @gol
290 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
291 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
292 -Winvalid-pch  -Wlarger-than=@var{len} @gol
293 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
294 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
295 -Wmisleading-indentation  -Wmissing-braces @gol
296 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
297 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
298 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
299 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
300 -Woverride-init-side-effects  -Woverlength-strings @gol
301 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
302 -Wparentheses  -Wno-pedantic-ms-format @gol
303 -Wplacement-new  -Wplacement-new=@var{n} @gol
304 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
305 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
306 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
307 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
308 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
309 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
310 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
311 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
312 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
313 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
314 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
315 -Wstringop-overflow=@var{n} @gol
316 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
317 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
318 -Wmissing-format-attribute  -Wsubobject-linkage @gol
319 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
320 -Wswitch-unreachable  -Wsync-nand @gol
321 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
322 -Wtype-limits  -Wundef @gol
323 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
324 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
325 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
326 -Wunused-parameter  -Wno-unused-result @gol
327 -Wunused-value  -Wunused-variable @gol
328 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
329 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
330 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
331 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
332 -Wzero-as-null-pointer-constant  -Whsa}
334 @item C and Objective-C-only Warning Options
335 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
336 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
337 -Wold-style-declaration  -Wold-style-definition @gol
338 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
339 -Wdeclaration-after-statement  -Wpointer-sign}
341 @item Debugging Options
342 @xref{Debugging Options,,Options for Debugging Your Program}.
343 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
344 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
345 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
346 -gcolumn-info  -gno-column-info @gol
347 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
348 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
349 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
350 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
351 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
352 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
353 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
354 -fvar-tracking  -fvar-tracking-assignments}
356 @item Optimization Options
357 @xref{Optimize Options,,Options that Control Optimization}.
358 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
359 -falign-jumps[=@var{n}] @gol
360 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
361 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
362 -fauto-inc-dec  -fbranch-probabilities @gol
363 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
364 -fbtr-bb-exclusive  -fcaller-saves @gol
365 -fcombine-stack-adjustments  -fconserve-stack @gol
366 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
367 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
368 -fcx-limited-range @gol
369 -fdata-sections  -fdce  -fdelayed-branch @gol
370 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
371 -fdevirtualize-at-ltrans  -fdse @gol
372 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
373 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
374 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
375 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
376 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
377 -fif-conversion2  -findirect-inlining @gol
378 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
379 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
380 -fipa-bit-cp -fipa-vrp @gol
381 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
382 -fira-algorithm=@var{algorithm} @gol
383 -fira-region=@var{region}  -fira-hoist-pressure @gol
384 -fira-loop-pressure  -fno-ira-share-save-slots @gol
385 -fno-ira-share-spill-slots @gol
386 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
387 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
388 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
389 -floop-block  -floop-interchange  -floop-strip-mine @gol
390 -floop-unroll-and-jam  -floop-nest-optimize @gol
391 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
392 -flto-partition=@var{alg}  -fmerge-all-constants @gol
393 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
394 -fmove-loop-invariants  -fno-branch-count-reg @gol
395 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
396 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
397 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
398 -fno-sched-spec  -fno-signed-zeros @gol
399 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
400 -fomit-frame-pointer  -foptimize-sibling-calls @gol
401 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
402 -fprefetch-loop-arrays @gol
403 -fprofile-correction @gol
404 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
405 -fprofile-reorder-functions @gol
406 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
407 -freorder-blocks-algorithm=@var{algorithm} @gol
408 -freorder-blocks-and-partition  -freorder-functions @gol
409 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
410 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
411 -fsched-spec-load  -fsched-spec-load-dangerous @gol
412 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
413 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
414 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
415 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
416 -fschedule-fusion @gol
417 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
418 -fselective-scheduling  -fselective-scheduling2 @gol
419 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
420 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
421 -fsignaling-nans @gol
422 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
423 -fsplit-paths @gol
424 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
425 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
426 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
427 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
428 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
429 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
430 -ftree-loop-if-convert  -ftree-loop-im @gol
431 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
432 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
433 -ftree-loop-vectorize @gol
434 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
435 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
436 -ftree-switch-conversion  -ftree-tail-merge @gol
437 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
438 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
439 -funsafe-math-optimizations  -funswitch-loops @gol
440 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
441 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
442 --param @var{name}=@var{value}
443 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
445 @item Program Instrumentation Options
446 @xref{Instrumentation Options,,Program Instrumentation Options}.
447 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
448 -fprofile-abs-path @gol
449 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
450 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
451 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
452 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
453 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
454 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
455 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
456 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
457 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
458 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
459 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
460 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
461 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
462 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
463 -fstack-protector-explicit  -fstack-check @gol
464 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
465 -fno-stack-limit  -fsplit-stack @gol
466 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
467 -fvtv-counts  -fvtv-debug @gol
468 -finstrument-functions @gol
469 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
470 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
472 @item Preprocessor Options
473 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
474 @gccoptlist{-A@var{question}=@var{answer} @gol
475 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
476 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
477 -dD  -dI  -dM  -dN  -dU @gol
478 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
479 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
480 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
481 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
482 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
483 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
484 -H  -imacros @var{file}  -include @var{file} @gol
485 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
486 -no-integrated-cpp  -P  -pthread  -remap @gol
487 -traditional  -traditional-cpp  -trigraphs @gol
488 -U@var{macro}  -undef  @gol
489 -Wp,@var{option}  -Xpreprocessor @var{option}}
491 @item Assembler Options
492 @xref{Assembler Options,,Passing Options to the Assembler}.
493 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
495 @item Linker Options
496 @xref{Link Options,,Options for Linking}.
497 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
498 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
499 -s  -static  -static-libgcc  -static-libstdc++ @gol
500 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
501 -static-libmpx  -static-libmpxwrappers @gol
502 -shared  -shared-libgcc  -symbolic @gol
503 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
504 -u @var{symbol}  -z @var{keyword}}
506 @item Directory Options
507 @xref{Directory Options,,Options for Directory Search}.
508 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
509 -idirafter @var{dir} @gol
510 -imacros @var{file}  -imultilib @var{dir} @gol
511 -iplugindir=@var{dir}  -iprefix @var{file} @gol
512 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
513 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
514 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
515 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
517 @item Code Generation Options
518 @xref{Code Gen Options,,Options for Code Generation Conventions}.
519 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
520 -ffixed-@var{reg}  -fexceptions @gol
521 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
522 -fasynchronous-unwind-tables @gol
523 -fno-gnu-unique @gol
524 -finhibit-size-directive  -fno-common  -fno-ident @gol
525 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
526 -fno-jump-tables @gol
527 -frecord-gcc-switches @gol
528 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
529 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
530 -fleading-underscore  -ftls-model=@var{model} @gol
531 -fstack-reuse=@var{reuse_level} @gol
532 -ftrampolines  -ftrapv  -fwrapv @gol
533 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
534 -fstrict-volatile-bitfields  -fsync-libcalls}
536 @item Developer Options
537 @xref{Developer Options,,GCC Developer Options}.
538 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
539 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
540 -fdbg-cnt=@var{counter-value-list} @gol
541 -fdisable-ipa-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass_name} @gol
543 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
544 -fdisable-tree-@var{pass_name} @gol
545 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
546 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
547 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
548 -fdump-final-insns@r{[}=@var{file}@r{]}
549 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
550 -fdump-lang-all @gol
551 -fdump-lang-@var{switch} @gol
552 -fdump-lang-@var{switch}-@var{options} @gol
553 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
554 -fdump-passes @gol
555 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
556 -fdump-statistics @gol
557 -fdump-tree-all @gol
558 -fdump-tree-@var{switch} @gol
559 -fdump-tree-@var{switch}-@var{options} @gol
560 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
561 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
562 -fenable-@var{kind}-@var{pass} @gol
563 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
564 -fira-verbose=@var{n} @gol
565 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
566 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
567 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
568 -fprofile-report @gol
569 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
570 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
571 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
572 -fvar-tracking-assignments-toggle  -gtoggle @gol
573 -print-file-name=@var{library}  -print-libgcc-file-name @gol
574 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
575 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
576 -print-sysroot  -print-sysroot-headers-suffix @gol
577 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
579 @item Machine-Dependent Options
580 @xref{Submodel Options,,Machine-Dependent Options}.
581 @c This list is ordered alphanumerically by subsection name.
582 @c Try and put the significant identifier (CPU or system) first,
583 @c so users have a clue at guessing where the ones they want will be.
585 @emph{AArch64 Options}
586 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
587 -mgeneral-regs-only @gol
588 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
589 -mstrict-align @gol
590 -momit-leaf-frame-pointer @gol
591 -mtls-dialect=desc  -mtls-dialect=traditional @gol
592 -mtls-size=@var{size} @gol
593 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
594 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
595 -mpc-relative-literal-loads @gol
596 -msign-return-address=@var{scope} @gol
597 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
599 @emph{Adapteva Epiphany Options}
600 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
601 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
602 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
603 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
604 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
605 -msplit-vecmove-early  -m1reg-@var{reg}}
607 @emph{ARC Options}
608 @gccoptlist{-mbarrel-shifter @gol
609 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
610 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
611 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
612 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
613 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
614 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
615 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
616 -mrgf-banked-regs @gol
617 -mvolatile-cache  -mtp-regno=@var{regno} @gol
618 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
619 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
620 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
621 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
622 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
623 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
624 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
625 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
627 @emph{ARM Options}
628 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
629 -mabi=@var{name} @gol
630 -mapcs-stack-check  -mno-apcs-stack-check @gol
631 -mapcs-reentrant  -mno-apcs-reentrant @gol
632 -msched-prolog  -mno-sched-prolog @gol
633 -mlittle-endian  -mbig-endian @gol
634 -mbe8 -mbe32 @gol
635 -mfloat-abi=@var{name} @gol
636 -mfp16-format=@var{name}
637 -mthumb-interwork  -mno-thumb-interwork @gol
638 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
639 -mtune=@var{name}  -mprint-tune-info @gol
640 -mstructure-size-boundary=@var{n} @gol
641 -mabort-on-noreturn @gol
642 -mlong-calls  -mno-long-calls @gol
643 -msingle-pic-base  -mno-single-pic-base @gol
644 -mpic-register=@var{reg} @gol
645 -mnop-fun-dllimport @gol
646 -mpoke-function-name @gol
647 -mthumb  -marm @gol
648 -mtpcs-frame  -mtpcs-leaf-frame @gol
649 -mcaller-super-interworking  -mcallee-super-interworking @gol
650 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
651 -mword-relocations @gol
652 -mfix-cortex-m3-ldrd @gol
653 -munaligned-access @gol
654 -mneon-for-64bits @gol
655 -mslow-flash-data @gol
656 -masm-syntax-unified @gol
657 -mrestrict-it @gol
658 -mpure-code @gol
659 -mcmse}
661 @emph{AVR Options}
662 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
663 -mbranch-cost=@var{cost} @gol
664 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
665 -mn_flash=@var{size}  -mno-interrupts @gol
666 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
667 -mshort-calls  -nodevicelib @gol
668 -Waddr-space-convert  -Wmisspelled-isr}
670 @emph{Blackfin Options}
671 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
672 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
673 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
674 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
675 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
676 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
677 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
678 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
679 -micplb}
681 @emph{C6X Options}
682 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
683 -msim  -msdata=@var{sdata-type}}
685 @emph{CRIS Options}
686 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
687 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
688 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
689 -mstack-align  -mdata-align  -mconst-align @gol
690 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
691 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
692 -mmul-bug-workaround  -mno-mul-bug-workaround}
694 @emph{CR16 Options}
695 @gccoptlist{-mmac @gol
696 -mcr16cplus  -mcr16c @gol
697 -msim  -mint32  -mbit-ops
698 -mdata-model=@var{model}}
700 @emph{Darwin Options}
701 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
702 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
703 -client_name  -compatibility_version  -current_version @gol
704 -dead_strip @gol
705 -dependency-file  -dylib_file  -dylinker_install_name @gol
706 -dynamic  -dynamiclib  -exported_symbols_list @gol
707 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
708 -force_flat_namespace  -headerpad_max_install_names @gol
709 -iframework @gol
710 -image_base  -init  -install_name  -keep_private_externs @gol
711 -multi_module  -multiply_defined  -multiply_defined_unused @gol
712 -noall_load   -no_dead_strip_inits_and_terms @gol
713 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
714 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
715 -private_bundle  -read_only_relocs  -sectalign @gol
716 -sectobjectsymbols  -whyload  -seg1addr @gol
717 -sectcreate  -sectobjectsymbols  -sectorder @gol
718 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
719 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
720 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
721 -single_module  -static  -sub_library  -sub_umbrella @gol
722 -twolevel_namespace  -umbrella  -undefined @gol
723 -unexported_symbols_list  -weak_reference_mismatches @gol
724 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
725 -mkernel  -mone-byte-bool}
727 @emph{DEC Alpha Options}
728 @gccoptlist{-mno-fp-regs  -msoft-float @gol
729 -mieee  -mieee-with-inexact  -mieee-conformant @gol
730 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
731 -mtrap-precision=@var{mode}  -mbuild-constants @gol
732 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
733 -mbwx  -mmax  -mfix  -mcix @gol
734 -mfloat-vax  -mfloat-ieee @gol
735 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
736 -msmall-text  -mlarge-text @gol
737 -mmemory-latency=@var{time}}
739 @emph{FR30 Options}
740 @gccoptlist{-msmall-model  -mno-lsim}
742 @emph{FT32 Options}
743 @gccoptlist{-msim  -mlra  -mnodiv}
745 @emph{FRV Options}
746 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
747 -mhard-float  -msoft-float @gol
748 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
749 -mdouble  -mno-double @gol
750 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
751 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
752 -mlinked-fp  -mlong-calls  -malign-labels @gol
753 -mlibrary-pic  -macc-4  -macc-8 @gol
754 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
755 -moptimize-membar  -mno-optimize-membar @gol
756 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
757 -mvliw-branch  -mno-vliw-branch @gol
758 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
759 -mno-nested-cond-exec  -mtomcat-stats @gol
760 -mTLS  -mtls @gol
761 -mcpu=@var{cpu}}
763 @emph{GNU/Linux Options}
764 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
765 -tno-android-cc  -tno-android-ld}
767 @emph{H8/300 Options}
768 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
770 @emph{HPPA Options}
771 @gccoptlist{-march=@var{architecture-type} @gol
772 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
773 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
774 -mfixed-range=@var{register-range} @gol
775 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
776 -mlong-load-store  -mno-disable-fpregs @gol
777 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
778 -mno-jump-in-delay  -mno-long-load-store @gol
779 -mno-portable-runtime  -mno-soft-float @gol
780 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
781 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
782 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
783 -munix=@var{unix-std}  -nolibdld  -static  -threads}
785 @emph{IA-64 Options}
786 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
787 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
788 -mconstant-gp  -mauto-pic  -mfused-madd @gol
789 -minline-float-divide-min-latency @gol
790 -minline-float-divide-max-throughput @gol
791 -mno-inline-float-divide @gol
792 -minline-int-divide-min-latency @gol
793 -minline-int-divide-max-throughput  @gol
794 -mno-inline-int-divide @gol
795 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
796 -mno-inline-sqrt @gol
797 -mdwarf2-asm  -mearly-stop-bits @gol
798 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
799 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
800 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
801 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
802 -msched-spec-ldc  -msched-spec-control-ldc @gol
803 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
804 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
805 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
806 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
808 @emph{LM32 Options}
809 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
810 -msign-extend-enabled  -muser-enabled}
812 @emph{M32R/D Options}
813 @gccoptlist{-m32r2  -m32rx  -m32r @gol
814 -mdebug @gol
815 -malign-loops  -mno-align-loops @gol
816 -missue-rate=@var{number} @gol
817 -mbranch-cost=@var{number} @gol
818 -mmodel=@var{code-size-model-type} @gol
819 -msdata=@var{sdata-type} @gol
820 -mno-flush-func  -mflush-func=@var{name} @gol
821 -mno-flush-trap  -mflush-trap=@var{number} @gol
822 -G @var{num}}
824 @emph{M32C Options}
825 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
827 @emph{M680x0 Options}
828 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
829 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
830 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
831 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
832 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
833 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
834 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
835 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
836 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
838 @emph{MCore Options}
839 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
840 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
841 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
842 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
843 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
845 @emph{MeP Options}
846 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
847 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
848 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
849 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
850 -mtiny=@var{n}}
852 @emph{MicroBlaze Options}
853 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
854 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
855 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
856 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
857 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
859 @emph{MIPS Options}
860 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
861 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
862 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
863 -mips16  -mno-mips16  -mflip-mips16 @gol
864 -minterlink-compressed  -mno-interlink-compressed @gol
865 -minterlink-mips16  -mno-interlink-mips16 @gol
866 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
867 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
868 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
869 -mno-float  -msingle-float  -mdouble-float @gol
870 -modd-spreg  -mno-odd-spreg @gol
871 -mabs=@var{mode}  -mnan=@var{encoding} @gol
872 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
873 -mmcu  -mmno-mcu @gol
874 -meva  -mno-eva @gol
875 -mvirt  -mno-virt @gol
876 -mxpa  -mno-xpa @gol
877 -mmicromips  -mno-micromips @gol
878 -mmsa  -mno-msa @gol
879 -mfpu=@var{fpu-type} @gol
880 -msmartmips  -mno-smartmips @gol
881 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
882 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
883 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
884 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
885 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
886 -membedded-data  -mno-embedded-data @gol
887 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
888 -mcode-readable=@var{setting} @gol
889 -msplit-addresses  -mno-split-addresses @gol
890 -mexplicit-relocs  -mno-explicit-relocs @gol
891 -mcheck-zero-division  -mno-check-zero-division @gol
892 -mdivide-traps  -mdivide-breaks @gol
893 -mload-store-pairs  -mno-load-store-pairs @gol
894 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
895 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
896 -mfix-24k  -mno-fix-24k @gol
897 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
898 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
899 -mfix-vr4120  -mno-fix-vr4120 @gol
900 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
901 -mflush-func=@var{func}  -mno-flush-func @gol
902 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
903 -mcompact-branches=@var{policy} @gol
904 -mfp-exceptions  -mno-fp-exceptions @gol
905 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
906 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
907 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
908 -mframe-header-opt  -mno-frame-header-opt}
910 @emph{MMIX Options}
911 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
912 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
913 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
914 -mno-base-addresses  -msingle-exit  -mno-single-exit}
916 @emph{MN10300 Options}
917 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
918 -mno-am33  -mam33  -mam33-2  -mam34 @gol
919 -mtune=@var{cpu-type} @gol
920 -mreturn-pointer-on-d0 @gol
921 -mno-crt0  -mrelax  -mliw  -msetlb}
923 @emph{Moxie Options}
924 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
926 @emph{MSP430 Options}
927 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
928 -mwarn-mcu @gol
929 -mcode-region=  -mdata-region= @gol
930 -msilicon-errata=  -msilicon-errata-warn= @gol
931 -mhwmult=  -minrt}
933 @emph{NDS32 Options}
934 @gccoptlist{-mbig-endian  -mlittle-endian @gol
935 -mreduced-regs  -mfull-regs @gol
936 -mcmov  -mno-cmov @gol
937 -mperf-ext  -mno-perf-ext @gol
938 -mv3push  -mno-v3push @gol
939 -m16bit  -mno-16bit @gol
940 -misr-vector-size=@var{num} @gol
941 -mcache-block-size=@var{num} @gol
942 -march=@var{arch} @gol
943 -mcmodel=@var{code-model} @gol
944 -mctor-dtor  -mrelax}
946 @emph{Nios II Options}
947 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
948 -mel  -meb @gol
949 -mno-bypass-cache  -mbypass-cache @gol
950 -mno-cache-volatile  -mcache-volatile @gol
951 -mno-fast-sw-div  -mfast-sw-div @gol
952 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
953 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
954 -mcustom-fpu-cfg=@var{name} @gol
955 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
956 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
958 @emph{Nvidia PTX Options}
959 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
961 @emph{PDP-11 Options}
962 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
963 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
964 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
965 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
966 -mbranch-expensive  -mbranch-cheap @gol
967 -munix-asm  -mdec-asm}
969 @emph{picoChip Options}
970 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
971 -msymbol-as-address  -mno-inefficient-warnings}
973 @emph{PowerPC Options}
974 See RS/6000 and PowerPC Options.
976 @emph{RISC-V Options}
977 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
978 -mmemcpy  -mno-memcpy @gol
979 -mplt  -mno-plt @gol
980 -mabi=@var{ABI-string} @gol
981 -mfdiv  -mno-fdiv @gol
982 -mdiv  -mno-div @gol
983 -march=@var{ISA-string} @gol
984 -mtune=@var{processor-string} @gol
985 -msmall-data-limit=@var{N-bytes} @gol
986 -msave-restore  -mno-save-restore @gol
987 -mstrict-align -mno-strict-align @gol
988 -mcmodel=@var{code-model} @gol
989 -mexplicit-relocs  -mno-explicit-relocs @gol}
991 @emph{RL78 Options}
992 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
993 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
994 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
996 @emph{RS/6000 and PowerPC Options}
997 @gccoptlist{-mcpu=@var{cpu-type} @gol
998 -mtune=@var{cpu-type} @gol
999 -mcmodel=@var{code-model} @gol
1000 -mpowerpc64 @gol
1001 -maltivec  -mno-altivec @gol
1002 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1003 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1004 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1005 -mfprnd  -mno-fprnd @gol
1006 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1007 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1008 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1009 -malign-power  -malign-natural @gol
1010 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1011 -msingle-float  -mdouble-float  -msimple-fpu @gol
1012 -mstring  -mno-string  -mupdate  -mno-update @gol
1013 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1014 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1015 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1016 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1017 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1018 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1019 -mprioritize-restricted-insns=@var{priority} @gol
1020 -msched-costly-dep=@var{dependence_type} @gol
1021 -minsert-sched-nops=@var{scheme} @gol
1022 -mcall-sysv  -mcall-netbsd @gol
1023 -maix-struct-return  -msvr4-struct-return @gol
1024 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1025 -mblock-move-inline-limit=@var{num} @gol
1026 -misel  -mno-isel @gol
1027 -misel=yes  -misel=no @gol
1028 -mspe  -mno-spe @gol
1029 -mspe=yes  -mspe=no @gol
1030 -mpaired @gol
1031 -mvrsave  -mno-vrsave @gol
1032 -mmulhw  -mno-mulhw @gol
1033 -mdlmzb  -mno-dlmzb @gol
1034 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1035 -mprototype  -mno-prototype @gol
1036 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1037 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1038 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1039 -mno-recip-precision @gol
1040 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1041 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1042 -msave-toc-indirect  -mno-save-toc-indirect @gol
1043 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1044 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1045 -mquad-memory  -mno-quad-memory @gol
1046 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1047 -mcompat-align-parm  -mno-compat-align-parm @gol
1048 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1049 -mgnu-attribute  -mno-gnu-attribute @gol
1050 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1051 -mstack-protector-guard-offset=@var{offset}}
1053 @emph{RX Options}
1054 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1055 -mcpu=@gol
1056 -mbig-endian-data  -mlittle-endian-data @gol
1057 -msmall-data @gol
1058 -msim  -mno-sim@gol
1059 -mas100-syntax  -mno-as100-syntax@gol
1060 -mrelax@gol
1061 -mmax-constant-size=@gol
1062 -mint-register=@gol
1063 -mpid@gol
1064 -mallow-string-insns  -mno-allow-string-insns@gol
1065 -mjsr@gol
1066 -mno-warn-multiple-fast-interrupts@gol
1067 -msave-acc-in-interrupts}
1069 @emph{S/390 and zSeries Options}
1070 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1071 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1072 -mlong-double-64  -mlong-double-128 @gol
1073 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1074 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1075 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1076 -mhtm  -mvx  -mzvector @gol
1077 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1078 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1079 -mhotpatch=@var{halfwords},@var{halfwords}}
1081 @emph{Score Options}
1082 @gccoptlist{-meb  -mel @gol
1083 -mnhwloop @gol
1084 -muls @gol
1085 -mmac @gol
1086 -mscore5  -mscore5u  -mscore7  -mscore7d}
1088 @emph{SH Options}
1089 @gccoptlist{-m1  -m2  -m2e @gol
1090 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1091 -m3  -m3e @gol
1092 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1093 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1094 -mb  -ml  -mdalign  -mrelax @gol
1095 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1096 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1097 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1098 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1099 -maccumulate-outgoing-args @gol
1100 -matomic-model=@var{atomic-model} @gol
1101 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1102 -mcbranch-force-delay-slot @gol
1103 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1104 -mpretend-cmove  -mtas}
1106 @emph{Solaris 2 Options}
1107 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1108 -pthreads}
1110 @emph{SPARC Options}
1111 @gccoptlist{-mcpu=@var{cpu-type} @gol
1112 -mtune=@var{cpu-type} @gol
1113 -mcmodel=@var{code-model} @gol
1114 -mmemory-model=@var{mem-model} @gol
1115 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1116 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1117 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1118 -mhard-quad-float  -msoft-quad-float @gol
1119 -mstack-bias  -mno-stack-bias @gol
1120 -mstd-struct-return  -mno-std-struct-return @gol
1121 -munaligned-doubles  -mno-unaligned-doubles @gol
1122 -muser-mode  -mno-user-mode @gol
1123 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1124 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1125 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1126 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1127 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1128 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1129 -mlra  -mno-lra}
1131 @emph{SPU Options}
1132 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1133 -msafe-dma  -munsafe-dma @gol
1134 -mbranch-hints @gol
1135 -msmall-mem  -mlarge-mem  -mstdmain @gol
1136 -mfixed-range=@var{register-range} @gol
1137 -mea32  -mea64 @gol
1138 -maddress-space-conversion  -mno-address-space-conversion @gol
1139 -mcache-size=@var{cache-size} @gol
1140 -matomic-updates  -mno-atomic-updates}
1142 @emph{System V Options}
1143 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1145 @emph{TILE-Gx Options}
1146 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1147 -mcmodel=@var{code-model}}
1149 @emph{TILEPro Options}
1150 @gccoptlist{-mcpu=@var{cpu}  -m32}
1152 @emph{V850 Options}
1153 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1154 -mprolog-function  -mno-prolog-function  -mspace @gol
1155 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1156 -mapp-regs  -mno-app-regs @gol
1157 -mdisable-callt  -mno-disable-callt @gol
1158 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1159 -mv850e  -mv850  -mv850e3v5 @gol
1160 -mloop @gol
1161 -mrelax @gol
1162 -mlong-jumps @gol
1163 -msoft-float @gol
1164 -mhard-float @gol
1165 -mgcc-abi @gol
1166 -mrh850-abi @gol
1167 -mbig-switch}
1169 @emph{VAX Options}
1170 @gccoptlist{-mg  -mgnu  -munix}
1172 @emph{Visium Options}
1173 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1174 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1176 @emph{VMS Options}
1177 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1178 -mpointer-size=@var{size}}
1180 @emph{VxWorks Options}
1181 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1182 -Xbind-lazy  -Xbind-now}
1184 @emph{x86 Options}
1185 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1186 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1187 -mfpmath=@var{unit} @gol
1188 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1189 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1190 -mno-wide-multiply  -mrtd  -malign-double @gol
1191 -mpreferred-stack-boundary=@var{num} @gol
1192 -mincoming-stack-boundary=@var{num} @gol
1193 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1194 -mrecip  -mrecip=@var{opt} @gol
1195 -mvzeroupper  -mprefer-avx128 @gol
1196 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1197 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1198 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1199 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1200 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1201 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1202 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1203 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1204 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1205 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1206 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1207 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1208 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1209 -mregparm=@var{num}  -msseregparm @gol
1210 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1211 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1212 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1213 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1214 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1215 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1216 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1217 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1218 -mstack-protector-guard-reg=@var{reg} @gol
1219 -mstack-protector-guard-offset=@var{offset}  -mmitigate-rop @gol
1220 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1222 @emph{x86 Windows Options}
1223 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1224 -mnop-fun-dllimport  -mthread @gol
1225 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1227 @emph{Xstormy16 Options}
1228 @gccoptlist{-msim}
1230 @emph{Xtensa Options}
1231 @gccoptlist{-mconst16  -mno-const16 @gol
1232 -mfused-madd  -mno-fused-madd @gol
1233 -mforce-no-pic @gol
1234 -mserialize-volatile  -mno-serialize-volatile @gol
1235 -mtext-section-literals  -mno-text-section-literals @gol
1236 -mauto-litpools  -mno-auto-litpools @gol
1237 -mtarget-align  -mno-target-align @gol
1238 -mlongcalls  -mno-longcalls}
1240 @emph{zSeries Options}
1241 See S/390 and zSeries Options.
1242 @end table
1245 @node Overall Options
1246 @section Options Controlling the Kind of Output
1248 Compilation can involve up to four stages: preprocessing, compilation
1249 proper, assembly and linking, always in that order.  GCC is capable of
1250 preprocessing and compiling several files either into several
1251 assembler input files, or into one assembler input file; then each
1252 assembler input file produces an object file, and linking combines all
1253 the object files (those newly compiled, and those specified as input)
1254 into an executable file.
1256 @cindex file name suffix
1257 For any given input file, the file name suffix determines what kind of
1258 compilation is done:
1260 @table @gcctabopt
1261 @item @var{file}.c
1262 C source code that must be preprocessed.
1264 @item @var{file}.i
1265 C source code that should not be preprocessed.
1267 @item @var{file}.ii
1268 C++ source code that should not be preprocessed.
1270 @item @var{file}.m
1271 Objective-C source code.  Note that you must link with the @file{libobjc}
1272 library to make an Objective-C program work.
1274 @item @var{file}.mi
1275 Objective-C source code that should not be preprocessed.
1277 @item @var{file}.mm
1278 @itemx @var{file}.M
1279 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1280 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1281 to a literal capital M@.
1283 @item @var{file}.mii
1284 Objective-C++ source code that should not be preprocessed.
1286 @item @var{file}.h
1287 C, C++, Objective-C or Objective-C++ header file to be turned into a
1288 precompiled header (default), or C, C++ header file to be turned into an
1289 Ada spec (via the @option{-fdump-ada-spec} switch).
1291 @item @var{file}.cc
1292 @itemx @var{file}.cp
1293 @itemx @var{file}.cxx
1294 @itemx @var{file}.cpp
1295 @itemx @var{file}.CPP
1296 @itemx @var{file}.c++
1297 @itemx @var{file}.C
1298 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1299 the last two letters must both be literally @samp{x}.  Likewise,
1300 @samp{.C} refers to a literal capital C@.
1302 @item @var{file}.mm
1303 @itemx @var{file}.M
1304 Objective-C++ source code that must be preprocessed.
1306 @item @var{file}.mii
1307 Objective-C++ source code that should not be preprocessed.
1309 @item @var{file}.hh
1310 @itemx @var{file}.H
1311 @itemx @var{file}.hp
1312 @itemx @var{file}.hxx
1313 @itemx @var{file}.hpp
1314 @itemx @var{file}.HPP
1315 @itemx @var{file}.h++
1316 @itemx @var{file}.tcc
1317 C++ header file to be turned into a precompiled header or Ada spec.
1319 @item @var{file}.f
1320 @itemx @var{file}.for
1321 @itemx @var{file}.ftn
1322 Fixed form Fortran source code that should not be preprocessed.
1324 @item @var{file}.F
1325 @itemx @var{file}.FOR
1326 @itemx @var{file}.fpp
1327 @itemx @var{file}.FPP
1328 @itemx @var{file}.FTN
1329 Fixed form Fortran source code that must be preprocessed (with the traditional
1330 preprocessor).
1332 @item @var{file}.f90
1333 @itemx @var{file}.f95
1334 @itemx @var{file}.f03
1335 @itemx @var{file}.f08
1336 Free form Fortran source code that should not be preprocessed.
1338 @item @var{file}.F90
1339 @itemx @var{file}.F95
1340 @itemx @var{file}.F03
1341 @itemx @var{file}.F08
1342 Free form Fortran source code that must be preprocessed (with the
1343 traditional preprocessor).
1345 @item @var{file}.go
1346 Go source code.
1348 @item @var{file}.brig
1349 BRIG files (binary representation of HSAIL).
1351 @item @var{file}.ads
1352 Ada source code file that contains a library unit declaration (a
1353 declaration of a package, subprogram, or generic, or a generic
1354 instantiation), or a library unit renaming declaration (a package,
1355 generic, or subprogram renaming declaration).  Such files are also
1356 called @dfn{specs}.
1358 @item @var{file}.adb
1359 Ada source code file containing a library unit body (a subprogram or
1360 package body).  Such files are also called @dfn{bodies}.
1362 @c GCC also knows about some suffixes for languages not yet included:
1363 @c Pascal:
1364 @c @var{file}.p
1365 @c @var{file}.pas
1366 @c Ratfor:
1367 @c @var{file}.r
1369 @item @var{file}.s
1370 Assembler code.
1372 @item @var{file}.S
1373 @itemx @var{file}.sx
1374 Assembler code that must be preprocessed.
1376 @item @var{other}
1377 An object file to be fed straight into linking.
1378 Any file name with no recognized suffix is treated this way.
1379 @end table
1381 @opindex x
1382 You can specify the input language explicitly with the @option{-x} option:
1384 @table @gcctabopt
1385 @item -x @var{language}
1386 Specify explicitly the @var{language} for the following input files
1387 (rather than letting the compiler choose a default based on the file
1388 name suffix).  This option applies to all following input files until
1389 the next @option{-x} option.  Possible values for @var{language} are:
1390 @smallexample
1391 c  c-header  cpp-output
1392 c++  c++-header  c++-cpp-output
1393 objective-c  objective-c-header  objective-c-cpp-output
1394 objective-c++ objective-c++-header objective-c++-cpp-output
1395 assembler  assembler-with-cpp
1397 f77  f77-cpp-input f95  f95-cpp-input
1399 brig
1400 @end smallexample
1402 @item -x none
1403 Turn off any specification of a language, so that subsequent files are
1404 handled according to their file name suffixes (as they are if @option{-x}
1405 has not been used at all).
1406 @end table
1408 If you only want some of the stages of compilation, you can use
1409 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1410 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1411 @command{gcc} is to stop.  Note that some combinations (for example,
1412 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1414 @table @gcctabopt
1415 @item -c
1416 @opindex c
1417 Compile or assemble the source files, but do not link.  The linking
1418 stage simply is not done.  The ultimate output is in the form of an
1419 object file for each source file.
1421 By default, the object file name for a source file is made by replacing
1422 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1424 Unrecognized input files, not requiring compilation or assembly, are
1425 ignored.
1427 @item -S
1428 @opindex S
1429 Stop after the stage of compilation proper; do not assemble.  The output
1430 is in the form of an assembler code file for each non-assembler input
1431 file specified.
1433 By default, the assembler file name for a source file is made by
1434 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1436 Input files that don't require compilation are ignored.
1438 @item -E
1439 @opindex E
1440 Stop after the preprocessing stage; do not run the compiler proper.  The
1441 output is in the form of preprocessed source code, which is sent to the
1442 standard output.
1444 Input files that don't require preprocessing are ignored.
1446 @cindex output file option
1447 @item -o @var{file}
1448 @opindex o
1449 Place output in file @var{file}.  This applies to whatever
1450 sort of output is being produced, whether it be an executable file,
1451 an object file, an assembler file or preprocessed C code.
1453 If @option{-o} is not specified, the default is to put an executable
1454 file in @file{a.out}, the object file for
1455 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1456 assembler file in @file{@var{source}.s}, a precompiled header file in
1457 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1458 standard output.
1460 @item -v
1461 @opindex v
1462 Print (on standard error output) the commands executed to run the stages
1463 of compilation.  Also print the version number of the compiler driver
1464 program and of the preprocessor and the compiler proper.
1466 @item -###
1467 @opindex ###
1468 Like @option{-v} except the commands are not executed and arguments
1469 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1470 This is useful for shell scripts to capture the driver-generated command lines.
1472 @item --help
1473 @opindex help
1474 Print (on the standard output) a description of the command-line options
1475 understood by @command{gcc}.  If the @option{-v} option is also specified
1476 then @option{--help} is also passed on to the various processes
1477 invoked by @command{gcc}, so that they can display the command-line options
1478 they accept.  If the @option{-Wextra} option has also been specified
1479 (prior to the @option{--help} option), then command-line options that
1480 have no documentation associated with them are also displayed.
1482 @item --target-help
1483 @opindex target-help
1484 Print (on the standard output) a description of target-specific command-line
1485 options for each tool.  For some targets extra target-specific
1486 information may also be printed.
1488 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1489 Print (on the standard output) a description of the command-line
1490 options understood by the compiler that fit into all specified classes
1491 and qualifiers.  These are the supported classes:
1493 @table @asis
1494 @item @samp{optimizers}
1495 Display all of the optimization options supported by the
1496 compiler.
1498 @item @samp{warnings}
1499 Display all of the options controlling warning messages
1500 produced by the compiler.
1502 @item @samp{target}
1503 Display target-specific options.  Unlike the
1504 @option{--target-help} option however, target-specific options of the
1505 linker and assembler are not displayed.  This is because those
1506 tools do not currently support the extended @option{--help=} syntax.
1508 @item @samp{params}
1509 Display the values recognized by the @option{--param}
1510 option.
1512 @item @var{language}
1513 Display the options supported for @var{language}, where
1514 @var{language} is the name of one of the languages supported in this
1515 version of GCC@.
1517 @item @samp{common}
1518 Display the options that are common to all languages.
1519 @end table
1521 These are the supported qualifiers:
1523 @table @asis
1524 @item @samp{undocumented}
1525 Display only those options that are undocumented.
1527 @item @samp{joined}
1528 Display options taking an argument that appears after an equal
1529 sign in the same continuous piece of text, such as:
1530 @samp{--help=target}.
1532 @item @samp{separate}
1533 Display options taking an argument that appears as a separate word
1534 following the original option, such as: @samp{-o output-file}.
1535 @end table
1537 Thus for example to display all the undocumented target-specific
1538 switches supported by the compiler, use:
1540 @smallexample
1541 --help=target,undocumented
1542 @end smallexample
1544 The sense of a qualifier can be inverted by prefixing it with the
1545 @samp{^} character, so for example to display all binary warning
1546 options (i.e., ones that are either on or off and that do not take an
1547 argument) that have a description, use:
1549 @smallexample
1550 --help=warnings,^joined,^undocumented
1551 @end smallexample
1553 The argument to @option{--help=} should not consist solely of inverted
1554 qualifiers.
1556 Combining several classes is possible, although this usually
1557 restricts the output so much that there is nothing to display.  One
1558 case where it does work, however, is when one of the classes is
1559 @var{target}.  For example, to display all the target-specific
1560 optimization options, use:
1562 @smallexample
1563 --help=target,optimizers
1564 @end smallexample
1566 The @option{--help=} option can be repeated on the command line.  Each
1567 successive use displays its requested class of options, skipping
1568 those that have already been displayed.
1570 If the @option{-Q} option appears on the command line before the
1571 @option{--help=} option, then the descriptive text displayed by
1572 @option{--help=} is changed.  Instead of describing the displayed
1573 options, an indication is given as to whether the option is enabled,
1574 disabled or set to a specific value (assuming that the compiler
1575 knows this at the point where the @option{--help=} option is used).
1577 Here is a truncated example from the ARM port of @command{gcc}:
1579 @smallexample
1580   % gcc -Q -mabi=2 --help=target -c
1581   The following options are target specific:
1582   -mabi=                                2
1583   -mabort-on-noreturn                   [disabled]
1584   -mapcs                                [disabled]
1585 @end smallexample
1587 The output is sensitive to the effects of previous command-line
1588 options, so for example it is possible to find out which optimizations
1589 are enabled at @option{-O2} by using:
1591 @smallexample
1592 -Q -O2 --help=optimizers
1593 @end smallexample
1595 Alternatively you can discover which binary optimizations are enabled
1596 by @option{-O3} by using:
1598 @smallexample
1599 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1600 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1601 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1602 @end smallexample
1604 @item --version
1605 @opindex version
1606 Display the version number and copyrights of the invoked GCC@.
1608 @item -pass-exit-codes
1609 @opindex pass-exit-codes
1610 Normally the @command{gcc} program exits with the code of 1 if any
1611 phase of the compiler returns a non-success return code.  If you specify
1612 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1613 the numerically highest error produced by any phase returning an error
1614 indication.  The C, C++, and Fortran front ends return 4 if an internal
1615 compiler error is encountered.
1617 @item -pipe
1618 @opindex pipe
1619 Use pipes rather than temporary files for communication between the
1620 various stages of compilation.  This fails to work on some systems where
1621 the assembler is unable to read from a pipe; but the GNU assembler has
1622 no trouble.
1624 @item -specs=@var{file}
1625 @opindex specs
1626 Process @var{file} after the compiler reads in the standard @file{specs}
1627 file, in order to override the defaults which the @command{gcc} driver
1628 program uses when determining what switches to pass to @command{cc1},
1629 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1630 @option{-specs=@var{file}} can be specified on the command line, and they
1631 are processed in order, from left to right.  @xref{Spec Files}, for
1632 information about the format of the @var{file}.
1634 @item -wrapper
1635 @opindex wrapper
1636 Invoke all subcommands under a wrapper program.  The name of the
1637 wrapper program and its parameters are passed as a comma separated
1638 list.
1640 @smallexample
1641 gcc -c t.c -wrapper gdb,--args
1642 @end smallexample
1644 @noindent
1645 This invokes all subprograms of @command{gcc} under
1646 @samp{gdb --args}, thus the invocation of @command{cc1} is
1647 @samp{gdb --args cc1 @dots{}}.
1649 @item -fplugin=@var{name}.so
1650 @opindex fplugin
1651 Load the plugin code in file @var{name}.so, assumed to be a
1652 shared object to be dlopen'd by the compiler.  The base name of
1653 the shared object file is used to identify the plugin for the
1654 purposes of argument parsing (See
1655 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1656 Each plugin should define the callback functions specified in the
1657 Plugins API.
1659 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1660 @opindex fplugin-arg
1661 Define an argument called @var{key} with a value of @var{value}
1662 for the plugin called @var{name}.
1664 @item -fdump-ada-spec@r{[}-slim@r{]}
1665 @opindex fdump-ada-spec
1666 For C and C++ source and include files, generate corresponding Ada specs.
1667 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1668 GNAT User's Guide}, which provides detailed documentation on this feature.
1670 @item -fada-spec-parent=@var{unit}
1671 @opindex fada-spec-parent
1672 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1673 Ada specs as child units of parent @var{unit}.
1675 @item -fdump-go-spec=@var{file}
1676 @opindex fdump-go-spec
1677 For input files in any language, generate corresponding Go
1678 declarations in @var{file}.  This generates Go @code{const},
1679 @code{type}, @code{var}, and @code{func} declarations which may be a
1680 useful way to start writing a Go interface to code written in some
1681 other language.
1683 @include @value{srcdir}/../libiberty/at-file.texi
1684 @end table
1686 @node Invoking G++
1687 @section Compiling C++ Programs
1689 @cindex suffixes for C++ source
1690 @cindex C++ source file suffixes
1691 C++ source files conventionally use one of the suffixes @samp{.C},
1692 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1693 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1694 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1695 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1696 files with these names and compiles them as C++ programs even if you
1697 call the compiler the same way as for compiling C programs (usually
1698 with the name @command{gcc}).
1700 @findex g++
1701 @findex c++
1702 However, the use of @command{gcc} does not add the C++ library.
1703 @command{g++} is a program that calls GCC and automatically specifies linking
1704 against the C++ library.  It treats @samp{.c},
1705 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1706 files unless @option{-x} is used.  This program is also useful when
1707 precompiling a C header file with a @samp{.h} extension for use in C++
1708 compilations.  On many systems, @command{g++} is also installed with
1709 the name @command{c++}.
1711 @cindex invoking @command{g++}
1712 When you compile C++ programs, you may specify many of the same
1713 command-line options that you use for compiling programs in any
1714 language; or command-line options meaningful for C and related
1715 languages; or options that are meaningful only for C++ programs.
1716 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1717 explanations of options for languages related to C@.
1718 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1719 explanations of options that are meaningful only for C++ programs.
1721 @node C Dialect Options
1722 @section Options Controlling C Dialect
1723 @cindex dialect options
1724 @cindex language dialect options
1725 @cindex options, dialect
1727 The following options control the dialect of C (or languages derived
1728 from C, such as C++, Objective-C and Objective-C++) that the compiler
1729 accepts:
1731 @table @gcctabopt
1732 @cindex ANSI support
1733 @cindex ISO support
1734 @item -ansi
1735 @opindex ansi
1736 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1737 equivalent to @option{-std=c++98}.
1739 This turns off certain features of GCC that are incompatible with ISO
1740 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1741 such as the @code{asm} and @code{typeof} keywords, and
1742 predefined macros such as @code{unix} and @code{vax} that identify the
1743 type of system you are using.  It also enables the undesirable and
1744 rarely used ISO trigraph feature.  For the C compiler,
1745 it disables recognition of C++ style @samp{//} comments as well as
1746 the @code{inline} keyword.
1748 The alternate keywords @code{__asm__}, @code{__extension__},
1749 @code{__inline__} and @code{__typeof__} continue to work despite
1750 @option{-ansi}.  You would not want to use them in an ISO C program, of
1751 course, but it is useful to put them in header files that might be included
1752 in compilations done with @option{-ansi}.  Alternate predefined macros
1753 such as @code{__unix__} and @code{__vax__} are also available, with or
1754 without @option{-ansi}.
1756 The @option{-ansi} option does not cause non-ISO programs to be
1757 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1758 addition to @option{-ansi}.  @xref{Warning Options}.
1760 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1761 option is used.  Some header files may notice this macro and refrain
1762 from declaring certain functions or defining certain macros that the
1763 ISO standard doesn't call for; this is to avoid interfering with any
1764 programs that might use these names for other things.
1766 Functions that are normally built in but do not have semantics
1767 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1768 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1769 built-in functions provided by GCC}, for details of the functions
1770 affected.
1772 @item -std=
1773 @opindex std
1774 Determine the language standard. @xref{Standards,,Language Standards
1775 Supported by GCC}, for details of these standard versions.  This option
1776 is currently only supported when compiling C or C++.
1778 The compiler can accept several base standards, such as @samp{c90} or
1779 @samp{c++98}, and GNU dialects of those standards, such as
1780 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1781 compiler accepts all programs following that standard plus those
1782 using GNU extensions that do not contradict it.  For example,
1783 @option{-std=c90} turns off certain features of GCC that are
1784 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1785 keywords, but not other GNU extensions that do not have a meaning in
1786 ISO C90, such as omitting the middle term of a @code{?:}
1787 expression. On the other hand, when a GNU dialect of a standard is
1788 specified, all features supported by the compiler are enabled, even when
1789 those features change the meaning of the base standard.  As a result, some
1790 strict-conforming programs may be rejected.  The particular standard
1791 is used by @option{-Wpedantic} to identify which features are GNU
1792 extensions given that version of the standard. For example
1793 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1794 comments, while @option{-std=gnu99 -Wpedantic} does not.
1796 A value for this option must be provided; possible values are
1798 @table @samp
1799 @item c90
1800 @itemx c89
1801 @itemx iso9899:1990
1802 Support all ISO C90 programs (certain GNU extensions that conflict
1803 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1805 @item iso9899:199409
1806 ISO C90 as modified in amendment 1.
1808 @item c99
1809 @itemx c9x
1810 @itemx iso9899:1999
1811 @itemx iso9899:199x
1812 ISO C99.  This standard is substantially completely supported, modulo
1813 bugs and floating-point issues
1814 (mainly but not entirely relating to optional C99 features from
1815 Annexes F and G).  See
1816 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1817 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1819 @item c11
1820 @itemx c1x
1821 @itemx iso9899:2011
1822 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1823 substantially completely supported, modulo bugs, floating-point issues
1824 (mainly but not entirely relating to optional C11 features from
1825 Annexes F and G) and the optional Annexes K (Bounds-checking
1826 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1828 @item gnu90
1829 @itemx gnu89
1830 GNU dialect of ISO C90 (including some C99 features).
1832 @item gnu99
1833 @itemx gnu9x
1834 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1836 @item gnu11
1837 @itemx gnu1x
1838 GNU dialect of ISO C11.  This is the default for C code.
1839 The name @samp{gnu1x} is deprecated.
1841 @item c++98
1842 @itemx c++03
1843 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1844 additional defect reports. Same as @option{-ansi} for C++ code.
1846 @item gnu++98
1847 @itemx gnu++03
1848 GNU dialect of @option{-std=c++98}.
1850 @item c++11
1851 @itemx c++0x
1852 The 2011 ISO C++ standard plus amendments.
1853 The name @samp{c++0x} is deprecated.
1855 @item gnu++11
1856 @itemx gnu++0x
1857 GNU dialect of @option{-std=c++11}.
1858 The name @samp{gnu++0x} is deprecated.
1860 @item c++14
1861 @itemx c++1y
1862 The 2014 ISO C++ standard plus amendments.
1863 The name @samp{c++1y} is deprecated.
1865 @item gnu++14
1866 @itemx gnu++1y
1867 GNU dialect of @option{-std=c++14}.
1868 This is the default for C++ code.
1869 The name @samp{gnu++1y} is deprecated.
1871 @item c++1z
1872 The next revision of the ISO C++ standard, tentatively planned for
1873 2017.  Support is highly experimental, and will almost certainly
1874 change in incompatible ways in future releases.
1876 @item gnu++1z
1877 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1878 and will almost certainly change in incompatible ways in future
1879 releases.
1880 @end table
1882 @item -fgnu89-inline
1883 @opindex fgnu89-inline
1884 The option @option{-fgnu89-inline} tells GCC to use the traditional
1885 GNU semantics for @code{inline} functions when in C99 mode.
1886 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1887 Using this option is roughly equivalent to adding the
1888 @code{gnu_inline} function attribute to all inline functions
1889 (@pxref{Function Attributes}).
1891 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1892 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1893 specifies the default behavior).
1894 This option is not supported in @option{-std=c90} or
1895 @option{-std=gnu90} mode.
1897 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1898 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1899 in effect for @code{inline} functions.  @xref{Common Predefined
1900 Macros,,,cpp,The C Preprocessor}.
1902 @item -fpermitted-flt-eval-methods=@var{style}
1903 @opindex fpermitted-flt-eval-methods
1904 @opindex fpermitted-flt-eval-methods=c11
1905 @opindex fpermitted-flt-eval-methods=ts-18661-3
1906 ISO/IEC TS 18661-3 defines new permissible values for
1907 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1908 a semantic type that is an interchange or extended format should be
1909 evaluated to the precision and range of that type.  These new values are
1910 a superset of those permitted under C99/C11, which does not specify the
1911 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1912 conforming to C11 may not have been written expecting the possibility of
1913 the new values.
1915 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1916 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1917 or the extended set of values specified in ISO/IEC TS 18661-3.
1919 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1921 The default when in a standards compliant mode (@option{-std=c11} or similar)
1922 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1923 dialect (@option{-std=gnu11} or similar) is
1924 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1926 @item -aux-info @var{filename}
1927 @opindex aux-info
1928 Output to the given filename prototyped declarations for all functions
1929 declared and/or defined in a translation unit, including those in header
1930 files.  This option is silently ignored in any language other than C@.
1932 Besides declarations, the file indicates, in comments, the origin of
1933 each declaration (source file and line), whether the declaration was
1934 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1935 @samp{O} for old, respectively, in the first character after the line
1936 number and the colon), and whether it came from a declaration or a
1937 definition (@samp{C} or @samp{F}, respectively, in the following
1938 character).  In the case of function definitions, a K&R-style list of
1939 arguments followed by their declarations is also provided, inside
1940 comments, after the declaration.
1942 @item -fallow-parameterless-variadic-functions
1943 @opindex fallow-parameterless-variadic-functions
1944 Accept variadic functions without named parameters.
1946 Although it is possible to define such a function, this is not very
1947 useful as it is not possible to read the arguments.  This is only
1948 supported for C as this construct is allowed by C++.
1950 @item -fno-asm
1951 @opindex fno-asm
1952 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1953 keyword, so that code can use these words as identifiers.  You can use
1954 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1955 instead.  @option{-ansi} implies @option{-fno-asm}.
1957 In C++, this switch only affects the @code{typeof} keyword, since
1958 @code{asm} and @code{inline} are standard keywords.  You may want to
1959 use the @option{-fno-gnu-keywords} flag instead, which has the same
1960 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1961 switch only affects the @code{asm} and @code{typeof} keywords, since
1962 @code{inline} is a standard keyword in ISO C99.
1964 @item -fno-builtin
1965 @itemx -fno-builtin-@var{function}
1966 @opindex fno-builtin
1967 @cindex built-in functions
1968 Don't recognize built-in functions that do not begin with
1969 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1970 functions provided by GCC}, for details of the functions affected,
1971 including those which are not built-in functions when @option{-ansi} or
1972 @option{-std} options for strict ISO C conformance are used because they
1973 do not have an ISO standard meaning.
1975 GCC normally generates special code to handle certain built-in functions
1976 more efficiently; for instance, calls to @code{alloca} may become single
1977 instructions which adjust the stack directly, and calls to @code{memcpy}
1978 may become inline copy loops.  The resulting code is often both smaller
1979 and faster, but since the function calls no longer appear as such, you
1980 cannot set a breakpoint on those calls, nor can you change the behavior
1981 of the functions by linking with a different library.  In addition,
1982 when a function is recognized as a built-in function, GCC may use
1983 information about that function to warn about problems with calls to
1984 that function, or to generate more efficient code, even if the
1985 resulting code still contains calls to that function.  For example,
1986 warnings are given with @option{-Wformat} for bad calls to
1987 @code{printf} when @code{printf} is built in and @code{strlen} is
1988 known not to modify global memory.
1990 With the @option{-fno-builtin-@var{function}} option
1991 only the built-in function @var{function} is
1992 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1993 function is named that is not built-in in this version of GCC, this
1994 option is ignored.  There is no corresponding
1995 @option{-fbuiltin-@var{function}} option; if you wish to enable
1996 built-in functions selectively when using @option{-fno-builtin} or
1997 @option{-ffreestanding}, you may define macros such as:
1999 @smallexample
2000 #define abs(n)          __builtin_abs ((n))
2001 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2002 @end smallexample
2004 @item -fgimple
2005 @opindex fgimple
2007 Enable parsing of function definitions marked with @code{__GIMPLE}.
2008 This is an experimental feature that allows unit testing of GIMPLE
2009 passes.
2011 @item -fhosted
2012 @opindex fhosted
2013 @cindex hosted environment
2015 Assert that compilation targets a hosted environment.  This implies
2016 @option{-fbuiltin}.  A hosted environment is one in which the
2017 entire standard library is available, and in which @code{main} has a return
2018 type of @code{int}.  Examples are nearly everything except a kernel.
2019 This is equivalent to @option{-fno-freestanding}.
2021 @item -ffreestanding
2022 @opindex ffreestanding
2023 @cindex hosted environment
2025 Assert that compilation targets a freestanding environment.  This
2026 implies @option{-fno-builtin}.  A freestanding environment
2027 is one in which the standard library may not exist, and program startup may
2028 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2029 This is equivalent to @option{-fno-hosted}.
2031 @xref{Standards,,Language Standards Supported by GCC}, for details of
2032 freestanding and hosted environments.
2034 @item -fopenacc
2035 @opindex fopenacc
2036 @cindex OpenACC accelerator programming
2037 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2038 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2039 compiler generates accelerated code according to the OpenACC Application
2040 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2041 implies @option{-pthread}, and thus is only supported on targets that
2042 have support for @option{-pthread}.
2044 @item -fopenacc-dim=@var{geom}
2045 @opindex fopenacc-dim
2046 @cindex OpenACC accelerator programming
2047 Specify default compute dimensions for parallel offload regions that do
2048 not explicitly specify.  The @var{geom} value is a triple of
2049 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2050 can be omitted, to use a target-specific default value.
2052 @item -fopenmp
2053 @opindex fopenmp
2054 @cindex OpenMP parallel
2055 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2056 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2057 compiler generates parallel code according to the OpenMP Application
2058 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2059 implies @option{-pthread}, and thus is only supported on targets that
2060 have support for @option{-pthread}. @option{-fopenmp} implies
2061 @option{-fopenmp-simd}.
2063 @item -fopenmp-simd
2064 @opindex fopenmp-simd
2065 @cindex OpenMP SIMD
2066 @cindex SIMD
2067 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2068 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2069 are ignored.
2071 @item -fcilkplus
2072 @opindex fcilkplus
2073 @cindex Enable Cilk Plus
2074 Enable the usage of Cilk Plus language extension features for C/C++.
2075 When the option @option{-fcilkplus} is specified, enable the usage of
2076 the Cilk Plus Language extension features for C/C++.  The present
2077 implementation follows ABI version 1.2.  This is an experimental
2078 feature that is only partially complete, and whose interface may
2079 change in future versions of GCC as the official specification
2080 changes.  Currently, all features but @code{_Cilk_for} have been
2081 implemented.
2083 @item -fgnu-tm
2084 @opindex fgnu-tm
2085 When the option @option{-fgnu-tm} is specified, the compiler
2086 generates code for the Linux variant of Intel's current Transactional
2087 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2088 an experimental feature whose interface may change in future versions
2089 of GCC, as the official specification changes.  Please note that not
2090 all architectures are supported for this feature.
2092 For more information on GCC's support for transactional memory,
2093 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2094 Transactional Memory Library}.
2096 Note that the transactional memory feature is not supported with
2097 non-call exceptions (@option{-fnon-call-exceptions}).
2099 @item -fms-extensions
2100 @opindex fms-extensions
2101 Accept some non-standard constructs used in Microsoft header files.
2103 In C++ code, this allows member names in structures to be similar
2104 to previous types declarations.
2106 @smallexample
2107 typedef int UOW;
2108 struct ABC @{
2109   UOW UOW;
2111 @end smallexample
2113 Some cases of unnamed fields in structures and unions are only
2114 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2115 fields within structs/unions}, for details.
2117 Note that this option is off for all targets but x86 
2118 targets using ms-abi.
2120 @item -fplan9-extensions
2121 @opindex fplan9-extensions
2122 Accept some non-standard constructs used in Plan 9 code.
2124 This enables @option{-fms-extensions}, permits passing pointers to
2125 structures with anonymous fields to functions that expect pointers to
2126 elements of the type of the field, and permits referring to anonymous
2127 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2128 struct/union fields within structs/unions}, for details.  This is only
2129 supported for C, not C++.
2131 @item -fcond-mismatch
2132 @opindex fcond-mismatch
2133 Allow conditional expressions with mismatched types in the second and
2134 third arguments.  The value of such an expression is void.  This option
2135 is not supported for C++.
2137 @item -flax-vector-conversions
2138 @opindex flax-vector-conversions
2139 Allow implicit conversions between vectors with differing numbers of
2140 elements and/or incompatible element types.  This option should not be
2141 used for new code.
2143 @item -funsigned-char
2144 @opindex funsigned-char
2145 Let the type @code{char} be unsigned, like @code{unsigned char}.
2147 Each kind of machine has a default for what @code{char} should
2148 be.  It is either like @code{unsigned char} by default or like
2149 @code{signed char} by default.
2151 Ideally, a portable program should always use @code{signed char} or
2152 @code{unsigned char} when it depends on the signedness of an object.
2153 But many programs have been written to use plain @code{char} and
2154 expect it to be signed, or expect it to be unsigned, depending on the
2155 machines they were written for.  This option, and its inverse, let you
2156 make such a program work with the opposite default.
2158 The type @code{char} is always a distinct type from each of
2159 @code{signed char} or @code{unsigned char}, even though its behavior
2160 is always just like one of those two.
2162 @item -fsigned-char
2163 @opindex fsigned-char
2164 Let the type @code{char} be signed, like @code{signed char}.
2166 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2167 the negative form of @option{-funsigned-char}.  Likewise, the option
2168 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2170 @item -fsigned-bitfields
2171 @itemx -funsigned-bitfields
2172 @itemx -fno-signed-bitfields
2173 @itemx -fno-unsigned-bitfields
2174 @opindex fsigned-bitfields
2175 @opindex funsigned-bitfields
2176 @opindex fno-signed-bitfields
2177 @opindex fno-unsigned-bitfields
2178 These options control whether a bit-field is signed or unsigned, when the
2179 declaration does not use either @code{signed} or @code{unsigned}.  By
2180 default, such a bit-field is signed, because this is consistent: the
2181 basic integer types such as @code{int} are signed types.
2183 @item -fsso-struct=@var{endianness}
2184 @opindex fsso-struct
2185 Set the default scalar storage order of structures and unions to the
2186 specified endianness.  The accepted values are @samp{big-endian},
2187 @samp{little-endian} and @samp{native} for the native endianness of
2188 the target (the default).  This option is not supported for C++.
2190 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2191 code that is not binary compatible with code generated without it if the
2192 specified endianness is not the native endianness of the target.
2193 @end table
2195 @node C++ Dialect Options
2196 @section Options Controlling C++ Dialect
2198 @cindex compiler options, C++
2199 @cindex C++ options, command-line
2200 @cindex options, C++
2201 This section describes the command-line options that are only meaningful
2202 for C++ programs.  You can also use most of the GNU compiler options
2203 regardless of what language your program is in.  For example, you
2204 might compile a file @file{firstClass.C} like this:
2206 @smallexample
2207 g++ -g -fstrict-enums -O -c firstClass.C
2208 @end smallexample
2210 @noindent
2211 In this example, only @option{-fstrict-enums} is an option meant
2212 only for C++ programs; you can use the other options with any
2213 language supported by GCC@.
2215 Some options for compiling C programs, such as @option{-std}, are also
2216 relevant for C++ programs.
2217 @xref{C Dialect Options,,Options Controlling C Dialect}.
2219 Here is a list of options that are @emph{only} for compiling C++ programs:
2221 @table @gcctabopt
2223 @item -fabi-version=@var{n}
2224 @opindex fabi-version
2225 Use version @var{n} of the C++ ABI@.  The default is version 0.
2227 Version 0 refers to the version conforming most closely to
2228 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2229 will change in different versions of G++ as ABI bugs are fixed.
2231 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2233 Version 2 is the version of the C++ ABI that first appeared in G++
2234 3.4, and was the default through G++ 4.9.
2236 Version 3 corrects an error in mangling a constant address as a
2237 template argument.
2239 Version 4, which first appeared in G++ 4.5, implements a standard
2240 mangling for vector types.
2242 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2243 attribute const/volatile on function pointer types, decltype of a
2244 plain decl, and use of a function parameter in the declaration of
2245 another parameter.
2247 Version 6, which first appeared in G++ 4.7, corrects the promotion
2248 behavior of C++11 scoped enums and the mangling of template argument
2249 packs, const/static_cast, prefix ++ and --, and a class scope function
2250 used as a template argument.
2252 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2253 builtin type and corrects the mangling of lambdas in default argument
2254 scope.
2256 Version 8, which first appeared in G++ 4.9, corrects the substitution
2257 behavior of function types with function-cv-qualifiers.
2259 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2260 @code{nullptr_t}.
2262 Version 10, which first appeared in G++ 6.1, adds mangling of
2263 attributes that affect type identity, such as ia32 calling convention
2264 attributes (e.g. @samp{stdcall}).
2266 Version 11, which first appeared in G++ 7, corrects the mangling of
2267 sizeof... expressions and operator names.  For multiple entities with
2268 the same name within a function, that are declared in different scopes,
2269 the mangling now changes starting with the twelfth occurrence.  It also
2270 implies @option{-fnew-inheriting-ctors}.
2272 See also @option{-Wabi}.
2274 @item -fabi-compat-version=@var{n}
2275 @opindex fabi-compat-version
2276 On targets that support strong aliases, G++
2277 works around mangling changes by creating an alias with the correct
2278 mangled name when defining a symbol with an incorrect mangled name.
2279 This switch specifies which ABI version to use for the alias.
2281 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2282 compatibility).  If another ABI version is explicitly selected, this
2283 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2284 use @option{-fabi-compat-version=2}.
2286 If this option is not provided but @option{-Wabi=@var{n}} is, that
2287 version is used for compatibility aliases.  If this option is provided
2288 along with @option{-Wabi} (without the version), the version from this
2289 option is used for the warning.
2291 @item -fno-access-control
2292 @opindex fno-access-control
2293 Turn off all access checking.  This switch is mainly useful for working
2294 around bugs in the access control code.
2296 @item -faligned-new
2297 @opindex faligned-new
2298 Enable support for C++17 @code{new} of types that require more
2299 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2300 numeric argument such as @code{-faligned-new=32} can be used to
2301 specify how much alignment (in bytes) is provided by that function,
2302 but few users will need to override the default of
2303 @code{alignof(std::max_align_t)}.
2305 This flag is enabled by default for @option{-std=c++1z}.
2307 @item -fcheck-new
2308 @opindex fcheck-new
2309 Check that the pointer returned by @code{operator new} is non-null
2310 before attempting to modify the storage allocated.  This check is
2311 normally unnecessary because the C++ standard specifies that
2312 @code{operator new} only returns @code{0} if it is declared
2313 @code{throw()}, in which case the compiler always checks the
2314 return value even without this option.  In all other cases, when
2315 @code{operator new} has a non-empty exception specification, memory
2316 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2317 @samp{new (nothrow)}.
2319 @item -fconcepts
2320 @opindex fconcepts
2321 Enable support for the C++ Extensions for Concepts Technical
2322 Specification, ISO 19217 (2015), which allows code like
2324 @smallexample
2325 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2326 template <Addable T> T add (T a, T b) @{ return a + b; @}
2327 @end smallexample
2329 @item -fconstexpr-depth=@var{n}
2330 @opindex fconstexpr-depth
2331 Set the maximum nested evaluation depth for C++11 constexpr functions
2332 to @var{n}.  A limit is needed to detect endless recursion during
2333 constant expression evaluation.  The minimum specified by the standard
2334 is 512.
2336 @item -fconstexpr-loop-limit=@var{n}
2337 @opindex fconstexpr-loop-limit
2338 Set the maximum number of iterations for a loop in C++14 constexpr functions
2339 to @var{n}.  A limit is needed to detect infinite loops during
2340 constant expression evaluation.  The default is 262144 (1<<18).
2342 @item -fdeduce-init-list
2343 @opindex fdeduce-init-list
2344 Enable deduction of a template type parameter as
2345 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2347 @smallexample
2348 template <class T> auto forward(T t) -> decltype (realfn (t))
2350   return realfn (t);
2353 void f()
2355   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2357 @end smallexample
2359 This deduction was implemented as a possible extension to the
2360 originally proposed semantics for the C++11 standard, but was not part
2361 of the final standard, so it is disabled by default.  This option is
2362 deprecated, and may be removed in a future version of G++.
2364 @item -ffriend-injection
2365 @opindex ffriend-injection
2366 Inject friend functions into the enclosing namespace, so that they are
2367 visible outside the scope of the class in which they are declared.
2368 Friend functions were documented to work this way in the old Annotated
2369 C++ Reference Manual.  
2370 However, in ISO C++ a friend function that is not declared
2371 in an enclosing scope can only be found using argument dependent
2372 lookup.  GCC defaults to the standard behavior.
2374 This option is for compatibility, and may be removed in a future
2375 release of G++.
2377 @item -fno-elide-constructors
2378 @opindex fno-elide-constructors
2379 The C++ standard allows an implementation to omit creating a temporary
2380 that is only used to initialize another object of the same type.
2381 Specifying this option disables that optimization, and forces G++ to
2382 call the copy constructor in all cases.  This option also causes G++
2383 to call trivial member functions which otherwise would be expanded inline.
2385 In C++17, the compiler is required to omit these temporaries, but this
2386 option still affects trivial member functions.
2388 @item -fno-enforce-eh-specs
2389 @opindex fno-enforce-eh-specs
2390 Don't generate code to check for violation of exception specifications
2391 at run time.  This option violates the C++ standard, but may be useful
2392 for reducing code size in production builds, much like defining
2393 @code{NDEBUG}.  This does not give user code permission to throw
2394 exceptions in violation of the exception specifications; the compiler
2395 still optimizes based on the specifications, so throwing an
2396 unexpected exception results in undefined behavior at run time.
2398 @item -fextern-tls-init
2399 @itemx -fno-extern-tls-init
2400 @opindex fextern-tls-init
2401 @opindex fno-extern-tls-init
2402 The C++11 and OpenMP standards allow @code{thread_local} and
2403 @code{threadprivate} variables to have dynamic (runtime)
2404 initialization.  To support this, any use of such a variable goes
2405 through a wrapper function that performs any necessary initialization.
2406 When the use and definition of the variable are in the same
2407 translation unit, this overhead can be optimized away, but when the
2408 use is in a different translation unit there is significant overhead
2409 even if the variable doesn't actually need dynamic initialization.  If
2410 the programmer can be sure that no use of the variable in a
2411 non-defining TU needs to trigger dynamic initialization (either
2412 because the variable is statically initialized, or a use of the
2413 variable in the defining TU will be executed before any uses in
2414 another TU), they can avoid this overhead with the
2415 @option{-fno-extern-tls-init} option.
2417 On targets that support symbol aliases, the default is
2418 @option{-fextern-tls-init}.  On targets that do not support symbol
2419 aliases, the default is @option{-fno-extern-tls-init}.
2421 @item -ffor-scope
2422 @itemx -fno-for-scope
2423 @opindex ffor-scope
2424 @opindex fno-for-scope
2425 If @option{-ffor-scope} is specified, the scope of variables declared in
2426 a @i{for-init-statement} is limited to the @code{for} loop itself,
2427 as specified by the C++ standard.
2428 If @option{-fno-for-scope} is specified, the scope of variables declared in
2429 a @i{for-init-statement} extends to the end of the enclosing scope,
2430 as was the case in old versions of G++, and other (traditional)
2431 implementations of C++.
2433 If neither flag is given, the default is to follow the standard,
2434 but to allow and give a warning for old-style code that would
2435 otherwise be invalid, or have different behavior.
2437 @item -fno-gnu-keywords
2438 @opindex fno-gnu-keywords
2439 Do not recognize @code{typeof} as a keyword, so that code can use this
2440 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2441 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2442 @option{-std=c++98}, @option{-std=c++11}, etc.
2444 @item -fno-implicit-templates
2445 @opindex fno-implicit-templates
2446 Never emit code for non-inline templates that are instantiated
2447 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2448 @xref{Template Instantiation}, for more information.
2450 @item -fno-implicit-inline-templates
2451 @opindex fno-implicit-inline-templates
2452 Don't emit code for implicit instantiations of inline templates, either.
2453 The default is to handle inlines differently so that compiles with and
2454 without optimization need the same set of explicit instantiations.
2456 @item -fno-implement-inlines
2457 @opindex fno-implement-inlines
2458 To save space, do not emit out-of-line copies of inline functions
2459 controlled by @code{#pragma implementation}.  This causes linker
2460 errors if these functions are not inlined everywhere they are called.
2462 @item -fms-extensions
2463 @opindex fms-extensions
2464 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2465 int and getting a pointer to member function via non-standard syntax.
2467 @item -fnew-inheriting-ctors
2468 @opindex fnew-inheriting-ctors
2469 Enable the P0136 adjustment to the semantics of C++11 constructor
2470 inheritance.  This is part of C++17 but also considered to be a Defect
2471 Report against C++11 and C++14.  This flag is enabled by default
2472 unless @option{-fabi-version=10} or lower is specified.
2474 @item -fnew-ttp-matching
2475 @opindex fnew-ttp-matching
2476 Enable the P0522 resolution to Core issue 150, template template
2477 parameters and default arguments: this allows a template with default
2478 template arguments as an argument for a template template parameter
2479 with fewer template parameters.  This flag is enabled by default for
2480 @option{-std=c++1z}.
2482 @item -fno-nonansi-builtins
2483 @opindex fno-nonansi-builtins
2484 Disable built-in declarations of functions that are not mandated by
2485 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2486 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2488 @item -fnothrow-opt
2489 @opindex fnothrow-opt
2490 Treat a @code{throw()} exception specification as if it were a
2491 @code{noexcept} specification to reduce or eliminate the text size
2492 overhead relative to a function with no exception specification.  If
2493 the function has local variables of types with non-trivial
2494 destructors, the exception specification actually makes the
2495 function smaller because the EH cleanups for those variables can be
2496 optimized away.  The semantic effect is that an exception thrown out of
2497 a function with such an exception specification results in a call
2498 to @code{terminate} rather than @code{unexpected}.
2500 @item -fno-operator-names
2501 @opindex fno-operator-names
2502 Do not treat the operator name keywords @code{and}, @code{bitand},
2503 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2504 synonyms as keywords.
2506 @item -fno-optional-diags
2507 @opindex fno-optional-diags
2508 Disable diagnostics that the standard says a compiler does not need to
2509 issue.  Currently, the only such diagnostic issued by G++ is the one for
2510 a name having multiple meanings within a class.
2512 @item -fpermissive
2513 @opindex fpermissive
2514 Downgrade some diagnostics about nonconformant code from errors to
2515 warnings.  Thus, using @option{-fpermissive} allows some
2516 nonconforming code to compile.
2518 @item -fno-pretty-templates
2519 @opindex fno-pretty-templates
2520 When an error message refers to a specialization of a function
2521 template, the compiler normally prints the signature of the
2522 template followed by the template arguments and any typedefs or
2523 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2524 rather than @code{void f(int)}) so that it's clear which template is
2525 involved.  When an error message refers to a specialization of a class
2526 template, the compiler omits any template arguments that match
2527 the default template arguments for that template.  If either of these
2528 behaviors make it harder to understand the error message rather than
2529 easier, you can use @option{-fno-pretty-templates} to disable them.
2531 @item -frepo
2532 @opindex frepo
2533 Enable automatic template instantiation at link time.  This option also
2534 implies @option{-fno-implicit-templates}.  @xref{Template
2535 Instantiation}, for more information.
2537 @item -fno-rtti
2538 @opindex fno-rtti
2539 Disable generation of information about every class with virtual
2540 functions for use by the C++ run-time type identification features
2541 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2542 of the language, you can save some space by using this flag.  Note that
2543 exception handling uses the same information, but G++ generates it as
2544 needed. The @code{dynamic_cast} operator can still be used for casts that
2545 do not require run-time type information, i.e.@: casts to @code{void *} or to
2546 unambiguous base classes.
2548 @item -fsized-deallocation
2549 @opindex fsized-deallocation
2550 Enable the built-in global declarations
2551 @smallexample
2552 void operator delete (void *, std::size_t) noexcept;
2553 void operator delete[] (void *, std::size_t) noexcept;
2554 @end smallexample
2555 as introduced in C++14.  This is useful for user-defined replacement
2556 deallocation functions that, for example, use the size of the object
2557 to make deallocation faster.  Enabled by default under
2558 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2559 warns about places that might want to add a definition.
2561 @item -fstrict-enums
2562 @opindex fstrict-enums
2563 Allow the compiler to optimize using the assumption that a value of
2564 enumerated type can only be one of the values of the enumeration (as
2565 defined in the C++ standard; basically, a value that can be
2566 represented in the minimum number of bits needed to represent all the
2567 enumerators).  This assumption may not be valid if the program uses a
2568 cast to convert an arbitrary integer value to the enumerated type.
2570 @item -fstrong-eval-order
2571 @opindex fstrong-eval-order
2572 Evaluate member access, array subscripting, and shift expressions in
2573 left-to-right order, and evaluate assignment in right-to-left order,
2574 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2575 @option{-fstrong-eval-order=some} enables just the ordering of member
2576 access and shift expressions, and is the default without
2577 @option{-std=c++1z}.
2579 @item -ftemplate-backtrace-limit=@var{n}
2580 @opindex ftemplate-backtrace-limit
2581 Set the maximum number of template instantiation notes for a single
2582 warning or error to @var{n}.  The default value is 10.
2584 @item -ftemplate-depth=@var{n}
2585 @opindex ftemplate-depth
2586 Set the maximum instantiation depth for template classes to @var{n}.
2587 A limit on the template instantiation depth is needed to detect
2588 endless recursions during template class instantiation.  ANSI/ISO C++
2589 conforming programs must not rely on a maximum depth greater than 17
2590 (changed to 1024 in C++11).  The default value is 900, as the compiler
2591 can run out of stack space before hitting 1024 in some situations.
2593 @item -fno-threadsafe-statics
2594 @opindex fno-threadsafe-statics
2595 Do not emit the extra code to use the routines specified in the C++
2596 ABI for thread-safe initialization of local statics.  You can use this
2597 option to reduce code size slightly in code that doesn't need to be
2598 thread-safe.
2600 @item -fuse-cxa-atexit
2601 @opindex fuse-cxa-atexit
2602 Register destructors for objects with static storage duration with the
2603 @code{__cxa_atexit} function rather than the @code{atexit} function.
2604 This option is required for fully standards-compliant handling of static
2605 destructors, but only works if your C library supports
2606 @code{__cxa_atexit}.
2608 @item -fno-use-cxa-get-exception-ptr
2609 @opindex fno-use-cxa-get-exception-ptr
2610 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2611 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2612 if the runtime routine is not available.
2614 @item -fvisibility-inlines-hidden
2615 @opindex fvisibility-inlines-hidden
2616 This switch declares that the user does not attempt to compare
2617 pointers to inline functions or methods where the addresses of the two functions
2618 are taken in different shared objects.
2620 The effect of this is that GCC may, effectively, mark inline methods with
2621 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2622 appear in the export table of a DSO and do not require a PLT indirection
2623 when used within the DSO@.  Enabling this option can have a dramatic effect
2624 on load and link times of a DSO as it massively reduces the size of the
2625 dynamic export table when the library makes heavy use of templates.
2627 The behavior of this switch is not quite the same as marking the
2628 methods as hidden directly, because it does not affect static variables
2629 local to the function or cause the compiler to deduce that
2630 the function is defined in only one shared object.
2632 You may mark a method as having a visibility explicitly to negate the
2633 effect of the switch for that method.  For example, if you do want to
2634 compare pointers to a particular inline method, you might mark it as
2635 having default visibility.  Marking the enclosing class with explicit
2636 visibility has no effect.
2638 Explicitly instantiated inline methods are unaffected by this option
2639 as their linkage might otherwise cross a shared library boundary.
2640 @xref{Template Instantiation}.
2642 @item -fvisibility-ms-compat
2643 @opindex fvisibility-ms-compat
2644 This flag attempts to use visibility settings to make GCC's C++
2645 linkage model compatible with that of Microsoft Visual Studio.
2647 The flag makes these changes to GCC's linkage model:
2649 @enumerate
2650 @item
2651 It sets the default visibility to @code{hidden}, like
2652 @option{-fvisibility=hidden}.
2654 @item
2655 Types, but not their members, are not hidden by default.
2657 @item
2658 The One Definition Rule is relaxed for types without explicit
2659 visibility specifications that are defined in more than one
2660 shared object: those declarations are permitted if they are
2661 permitted when this option is not used.
2662 @end enumerate
2664 In new code it is better to use @option{-fvisibility=hidden} and
2665 export those classes that are intended to be externally visible.
2666 Unfortunately it is possible for code to rely, perhaps accidentally,
2667 on the Visual Studio behavior.
2669 Among the consequences of these changes are that static data members
2670 of the same type with the same name but defined in different shared
2671 objects are different, so changing one does not change the other;
2672 and that pointers to function members defined in different shared
2673 objects may not compare equal.  When this flag is given, it is a
2674 violation of the ODR to define types with the same name differently.
2676 @item -fno-weak
2677 @opindex fno-weak
2678 Do not use weak symbol support, even if it is provided by the linker.
2679 By default, G++ uses weak symbols if they are available.  This
2680 option exists only for testing, and should not be used by end-users;
2681 it results in inferior code and has no benefits.  This option may
2682 be removed in a future release of G++.
2684 @item -nostdinc++
2685 @opindex nostdinc++
2686 Do not search for header files in the standard directories specific to
2687 C++, but do still search the other standard directories.  (This option
2688 is used when building the C++ library.)
2689 @end table
2691 In addition, these optimization, warning, and code generation options
2692 have meanings only for C++ programs:
2694 @table @gcctabopt
2695 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2696 @opindex Wabi
2697 @opindex Wno-abi
2698 Warn when G++ it generates code that is probably not compatible with
2699 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2700 ABI with each major release, normally @option{-Wabi} will warn only if
2701 there is a check added later in a release series for an ABI issue
2702 discovered since the initial release.  @option{-Wabi} will warn about
2703 more things if an older ABI version is selected (with
2704 @option{-fabi-version=@var{n}}).
2706 @option{-Wabi} can also be used with an explicit version number to
2707 warn about compatibility with a particular @option{-fabi-version}
2708 level, e.g. @option{-Wabi=2} to warn about changes relative to
2709 @option{-fabi-version=2}.
2711 If an explicit version number is provided and
2712 @option{-fabi-compat-version} is not specified, the version number
2713 from this option is used for compatibility aliases.  If no explicit
2714 version number is provided with this option, but
2715 @option{-fabi-compat-version} is specified, that version number is
2716 used for ABI warnings.
2718 Although an effort has been made to warn about
2719 all such cases, there are probably some cases that are not warned about,
2720 even though G++ is generating incompatible code.  There may also be
2721 cases where warnings are emitted even though the code that is generated
2722 is compatible.
2724 You should rewrite your code to avoid these warnings if you are
2725 concerned about the fact that code generated by G++ may not be binary
2726 compatible with code generated by other compilers.
2728 Known incompatibilities in @option{-fabi-version=2} (which was the
2729 default from GCC 3.4 to 4.9) include:
2731 @itemize @bullet
2733 @item
2734 A template with a non-type template parameter of reference type was
2735 mangled incorrectly:
2736 @smallexample
2737 extern int N;
2738 template <int &> struct S @{@};
2739 void n (S<N>) @{2@}
2740 @end smallexample
2742 This was fixed in @option{-fabi-version=3}.
2744 @item
2745 SIMD vector types declared using @code{__attribute ((vector_size))} were
2746 mangled in a non-standard way that does not allow for overloading of
2747 functions taking vectors of different sizes.
2749 The mangling was changed in @option{-fabi-version=4}.
2751 @item
2752 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2753 qualifiers, and @code{decltype} of a plain declaration was folded away.
2755 These mangling issues were fixed in @option{-fabi-version=5}.
2757 @item
2758 Scoped enumerators passed as arguments to a variadic function are
2759 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2760 On most targets this does not actually affect the parameter passing
2761 ABI, as there is no way to pass an argument smaller than @code{int}.
2763 Also, the ABI changed the mangling of template argument packs,
2764 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2765 a class scope function used as a template argument.
2767 These issues were corrected in @option{-fabi-version=6}.
2769 @item
2770 Lambdas in default argument scope were mangled incorrectly, and the
2771 ABI changed the mangling of @code{nullptr_t}.
2773 These issues were corrected in @option{-fabi-version=7}.
2775 @item
2776 When mangling a function type with function-cv-qualifiers, the
2777 un-qualified function type was incorrectly treated as a substitution
2778 candidate.
2780 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2782 @item
2783 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2784 unaligned accesses.  Note that this did not affect the ABI of a
2785 function with a @code{nullptr_t} parameter, as parameters have a
2786 minimum alignment.
2788 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2790 @item
2791 Target-specific attributes that affect the identity of a type, such as
2792 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2793 did not affect the mangled name, leading to name collisions when
2794 function pointers were used as template arguments.
2796 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2798 @end itemize
2800 It also warns about psABI-related changes.  The known psABI changes at this
2801 point include:
2803 @itemize @bullet
2805 @item
2806 For SysV/x86-64, unions with @code{long double} members are 
2807 passed in memory as specified in psABI.  For example:
2809 @smallexample
2810 union U @{
2811   long double ld;
2812   int i;
2814 @end smallexample
2816 @noindent
2817 @code{union U} is always passed in memory.
2819 @end itemize
2821 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2822 @opindex Wabi-tag
2823 @opindex -Wabi-tag
2824 Warn when a type with an ABI tag is used in a context that does not
2825 have that ABI tag.  See @ref{C++ Attributes} for more information
2826 about ABI tags.
2828 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2829 @opindex Wctor-dtor-privacy
2830 @opindex Wno-ctor-dtor-privacy
2831 Warn when a class seems unusable because all the constructors or
2832 destructors in that class are private, and it has neither friends nor
2833 public static member functions.  Also warn if there are no non-private
2834 methods, and there's at least one private member function that isn't
2835 a constructor or destructor.
2837 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2838 @opindex Wdelete-non-virtual-dtor
2839 @opindex Wno-delete-non-virtual-dtor
2840 Warn when @code{delete} is used to destroy an instance of a class that
2841 has virtual functions and non-virtual destructor. It is unsafe to delete
2842 an instance of a derived class through a pointer to a base class if the
2843 base class does not have a virtual destructor.  This warning is enabled
2844 by @option{-Wall}.
2846 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2847 @opindex Wliteral-suffix
2848 @opindex Wno-literal-suffix
2849 Warn when a string or character literal is followed by a ud-suffix which does
2850 not begin with an underscore.  As a conforming extension, GCC treats such
2851 suffixes as separate preprocessing tokens in order to maintain backwards
2852 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2853 For example:
2855 @smallexample
2856 #define __STDC_FORMAT_MACROS
2857 #include <inttypes.h>
2858 #include <stdio.h>
2860 int main() @{
2861   int64_t i64 = 123;
2862   printf("My int64: %" PRId64"\n", i64);
2864 @end smallexample
2866 In this case, @code{PRId64} is treated as a separate preprocessing token.
2868 Additionally, warn when a user-defined literal operator is declared with
2869 a literal suffix identifier that doesn't begin with an underscore. Literal
2870 suffix identifiers that don't begin with an underscore are reserved for
2871 future standardization.
2873 This warning is enabled by default.
2875 @item -Wlto-type-mismatch
2876 @opindex Wlto-type-mismatch
2877 @opindex Wno-lto-type-mismatch
2879 During the link-time optimization warn about type mismatches in
2880 global declarations from different compilation units.
2881 Requires @option{-flto} to be enabled.  Enabled by default.
2883 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2884 @opindex Wnarrowing
2885 @opindex Wno-narrowing
2886 For C++11 and later standards, narrowing conversions are diagnosed by default,
2887 as required by the standard.  A narrowing conversion from a constant produces
2888 an error, and a narrowing conversion from a non-constant produces a warning,
2889 but @option{-Wno-narrowing} suppresses the diagnostic.
2890 Note that this does not affect the meaning of well-formed code;
2891 narrowing conversions are still considered ill-formed in SFINAE contexts.
2893 With @option{-Wnarrowing} in C++98, warn when a narrowing
2894 conversion prohibited by C++11 occurs within
2895 @samp{@{ @}}, e.g.
2897 @smallexample
2898 int i = @{ 2.2 @}; // error: narrowing from double to int
2899 @end smallexample
2901 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2903 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2904 @opindex Wnoexcept
2905 @opindex Wno-noexcept
2906 Warn when a noexcept-expression evaluates to false because of a call
2907 to a function that does not have a non-throwing exception
2908 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2909 the compiler to never throw an exception.
2911 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2912 @opindex Wnoexcept-type
2913 @opindex Wno-noexcept-type
2914 Warn if the C++1z feature making @code{noexcept} part of a function
2915 type changes the mangled name of a symbol relative to C++14.  Enabled
2916 by @option{-Wabi} and @option{-Wc++1z-compat}.
2918 @smallexample
2919 template <class T> void f(T t) @{ t(); @};
2920 void g() noexcept;
2921 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2922 @end smallexample
2924 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2925 @opindex Wclass-memaccess
2926 Warn when the destination of a call to a raw memory function such as
2927 @code{memset} or @code{memcpy} is an object of class type writing into which
2928 might bypass the class non-trivial or deleted constructor or copy assignment,
2929 violate const-correctness or encapsulation, or corrupt the virtual table.
2930 Modifying the representation of such objects may violate invariants maintained
2931 by member functions of the class.  For example, the call to @code{memset}
2932 below is undefined becase it modifies a non-trivial class object and is,
2933 therefore, diagnosed.  The safe way to either initialize or clear the storage
2934 of objects of such types is by using the appropriate constructor or assignment
2935 operator, if one is available.
2936 @smallexample
2937 std::string str = "abc";
2938 memset (&str, 0, 3);
2939 @end smallexample
2940 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2942 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2943 @opindex Wnon-virtual-dtor
2944 @opindex Wno-non-virtual-dtor
2945 Warn when a class has virtual functions and an accessible non-virtual
2946 destructor itself or in an accessible polymorphic base class, in which
2947 case it is possible but unsafe to delete an instance of a derived
2948 class through a pointer to the class itself or base class.  This
2949 warning is automatically enabled if @option{-Weffc++} is specified.
2951 @item -Wregister @r{(C++ and Objective-C++ only)}
2952 @opindex Wregister
2953 @opindex Wno-register
2954 Warn on uses of the @code{register} storage class specifier, except
2955 when it is part of the GNU @ref{Explicit Register Variables} extension.
2956 The use of the @code{register} keyword as storage class specifier has
2957 been deprecated in C++11 and removed in C++17.
2958 Enabled by default with @option{-std=c++1z}.
2960 @item -Wreorder @r{(C++ and Objective-C++ only)}
2961 @opindex Wreorder
2962 @opindex Wno-reorder
2963 @cindex reordering, warning
2964 @cindex warning for reordering of member initializers
2965 Warn when the order of member initializers given in the code does not
2966 match the order in which they must be executed.  For instance:
2968 @smallexample
2969 struct A @{
2970   int i;
2971   int j;
2972   A(): j (0), i (1) @{ @}
2974 @end smallexample
2976 @noindent
2977 The compiler rearranges the member initializers for @code{i}
2978 and @code{j} to match the declaration order of the members, emitting
2979 a warning to that effect.  This warning is enabled by @option{-Wall}.
2981 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2982 @opindex fext-numeric-literals
2983 @opindex fno-ext-numeric-literals
2984 Accept imaginary, fixed-point, or machine-defined
2985 literal number suffixes as GNU extensions.
2986 When this option is turned off these suffixes are treated
2987 as C++11 user-defined literal numeric suffixes.
2988 This is on by default for all pre-C++11 dialects and all GNU dialects:
2989 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2990 @option{-std=gnu++14}.
2991 This option is off by default
2992 for ISO C++11 onwards (@option{-std=c++11}, ...).
2993 @end table
2995 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2997 @table @gcctabopt
2998 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2999 @opindex Weffc++
3000 @opindex Wno-effc++
3001 Warn about violations of the following style guidelines from Scott Meyers'
3002 @cite{Effective C++} series of books:
3004 @itemize @bullet
3005 @item
3006 Define a copy constructor and an assignment operator for classes
3007 with dynamically-allocated memory.
3009 @item
3010 Prefer initialization to assignment in constructors.
3012 @item
3013 Have @code{operator=} return a reference to @code{*this}.
3015 @item
3016 Don't try to return a reference when you must return an object.
3018 @item
3019 Distinguish between prefix and postfix forms of increment and
3020 decrement operators.
3022 @item
3023 Never overload @code{&&}, @code{||}, or @code{,}.
3025 @end itemize
3027 This option also enables @option{-Wnon-virtual-dtor}, which is also
3028 one of the effective C++ recommendations.  However, the check is
3029 extended to warn about the lack of virtual destructor in accessible
3030 non-polymorphic bases classes too.
3032 When selecting this option, be aware that the standard library
3033 headers do not obey all of these guidelines; use @samp{grep -v}
3034 to filter out those warnings.
3036 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3037 @opindex Wstrict-null-sentinel
3038 @opindex Wno-strict-null-sentinel
3039 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3040 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3041 to @code{__null}.  Although it is a null pointer constant rather than a
3042 null pointer, it is guaranteed to be of the same size as a pointer.
3043 But this use is not portable across different compilers.
3045 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3046 @opindex Wno-non-template-friend
3047 @opindex Wnon-template-friend
3048 Disable warnings when non-template friend functions are declared
3049 within a template.  In very old versions of GCC that predate implementation
3050 of the ISO standard, declarations such as 
3051 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3052 could be interpreted as a particular specialization of a template
3053 function; the warning exists to diagnose compatibility problems, 
3054 and is enabled by default.
3056 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3057 @opindex Wold-style-cast
3058 @opindex Wno-old-style-cast
3059 Warn if an old-style (C-style) cast to a non-void type is used within
3060 a C++ program.  The new-style casts (@code{dynamic_cast},
3061 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3062 less vulnerable to unintended effects and much easier to search for.
3064 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3065 @opindex Woverloaded-virtual
3066 @opindex Wno-overloaded-virtual
3067 @cindex overloaded virtual function, warning
3068 @cindex warning for overloaded virtual function
3069 Warn when a function declaration hides virtual functions from a
3070 base class.  For example, in:
3072 @smallexample
3073 struct A @{
3074   virtual void f();
3077 struct B: public A @{
3078   void f(int);
3080 @end smallexample
3082 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3083 like:
3085 @smallexample
3086 B* b;
3087 b->f();
3088 @end smallexample
3090 @noindent
3091 fails to compile.
3093 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3094 @opindex Wno-pmf-conversions
3095 @opindex Wpmf-conversions
3096 Disable the diagnostic for converting a bound pointer to member function
3097 to a plain pointer.
3099 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3100 @opindex Wsign-promo
3101 @opindex Wno-sign-promo
3102 Warn when overload resolution chooses a promotion from unsigned or
3103 enumerated type to a signed type, over a conversion to an unsigned type of
3104 the same size.  Previous versions of G++ tried to preserve
3105 unsignedness, but the standard mandates the current behavior.
3107 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3108 @opindex Wtemplates
3109 Warn when a primary template declaration is encountered.  Some coding
3110 rules disallow templates, and this may be used to enforce that rule.
3111 The warning is inactive inside a system header file, such as the STL, so
3112 one can still use the STL.  One may also instantiate or specialize
3113 templates.
3115 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3116 @opindex Wmultiple-inheritance
3117 Warn when a class is defined with multiple direct base classes.  Some
3118 coding rules disallow multiple inheritance, and this may be used to
3119 enforce that rule.  The warning is inactive inside a system header file,
3120 such as the STL, so one can still use the STL.  One may also define
3121 classes that indirectly use multiple inheritance.
3123 @item -Wvirtual-inheritance
3124 @opindex Wvirtual-inheritance
3125 Warn when a class is defined with a virtual direct base class.  Some
3126 coding rules disallow multiple inheritance, and this may be used to
3127 enforce that rule.  The warning is inactive inside a system header file,
3128 such as the STL, so one can still use the STL.  One may also define
3129 classes that indirectly use virtual inheritance.
3131 @item -Wnamespaces
3132 @opindex Wnamespaces
3133 Warn when a namespace definition is opened.  Some coding rules disallow
3134 namespaces, and this may be used to enforce that rule.  The warning is
3135 inactive inside a system header file, such as the STL, so one can still
3136 use the STL.  One may also use using directives and qualified names.
3138 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3139 @opindex Wterminate
3140 @opindex Wno-terminate
3141 Disable the warning about a throw-expression that will immediately
3142 result in a call to @code{terminate}.
3143 @end table
3145 @node Objective-C and Objective-C++ Dialect Options
3146 @section Options Controlling Objective-C and Objective-C++ Dialects
3148 @cindex compiler options, Objective-C and Objective-C++
3149 @cindex Objective-C and Objective-C++ options, command-line
3150 @cindex options, Objective-C and Objective-C++
3151 (NOTE: This manual does not describe the Objective-C and Objective-C++
3152 languages themselves.  @xref{Standards,,Language Standards
3153 Supported by GCC}, for references.)
3155 This section describes the command-line options that are only meaningful
3156 for Objective-C and Objective-C++ programs.  You can also use most of
3157 the language-independent GNU compiler options.
3158 For example, you might compile a file @file{some_class.m} like this:
3160 @smallexample
3161 gcc -g -fgnu-runtime -O -c some_class.m
3162 @end smallexample
3164 @noindent
3165 In this example, @option{-fgnu-runtime} is an option meant only for
3166 Objective-C and Objective-C++ programs; you can use the other options with
3167 any language supported by GCC@.
3169 Note that since Objective-C is an extension of the C language, Objective-C
3170 compilations may also use options specific to the C front-end (e.g.,
3171 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3172 C++-specific options (e.g., @option{-Wabi}).
3174 Here is a list of options that are @emph{only} for compiling Objective-C
3175 and Objective-C++ programs:
3177 @table @gcctabopt
3178 @item -fconstant-string-class=@var{class-name}
3179 @opindex fconstant-string-class
3180 Use @var{class-name} as the name of the class to instantiate for each
3181 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3182 class name is @code{NXConstantString} if the GNU runtime is being used, and
3183 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3184 @option{-fconstant-cfstrings} option, if also present, overrides the
3185 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3186 to be laid out as constant CoreFoundation strings.
3188 @item -fgnu-runtime
3189 @opindex fgnu-runtime
3190 Generate object code compatible with the standard GNU Objective-C
3191 runtime.  This is the default for most types of systems.
3193 @item -fnext-runtime
3194 @opindex fnext-runtime
3195 Generate output compatible with the NeXT runtime.  This is the default
3196 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3197 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3198 used.
3200 @item -fno-nil-receivers
3201 @opindex fno-nil-receivers
3202 Assume that all Objective-C message dispatches (@code{[receiver
3203 message:arg]}) in this translation unit ensure that the receiver is
3204 not @code{nil}.  This allows for more efficient entry points in the
3205 runtime to be used.  This option is only available in conjunction with
3206 the NeXT runtime and ABI version 0 or 1.
3208 @item -fobjc-abi-version=@var{n}
3209 @opindex fobjc-abi-version
3210 Use version @var{n} of the Objective-C ABI for the selected runtime.
3211 This option is currently supported only for the NeXT runtime.  In that
3212 case, Version 0 is the traditional (32-bit) ABI without support for
3213 properties and other Objective-C 2.0 additions.  Version 1 is the
3214 traditional (32-bit) ABI with support for properties and other
3215 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3216 nothing is specified, the default is Version 0 on 32-bit target
3217 machines, and Version 2 on 64-bit target machines.
3219 @item -fobjc-call-cxx-cdtors
3220 @opindex fobjc-call-cxx-cdtors
3221 For each Objective-C class, check if any of its instance variables is a
3222 C++ object with a non-trivial default constructor.  If so, synthesize a
3223 special @code{- (id) .cxx_construct} instance method which runs
3224 non-trivial default constructors on any such instance variables, in order,
3225 and then return @code{self}.  Similarly, check if any instance variable
3226 is a C++ object with a non-trivial destructor, and if so, synthesize a
3227 special @code{- (void) .cxx_destruct} method which runs
3228 all such default destructors, in reverse order.
3230 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3231 methods thusly generated only operate on instance variables
3232 declared in the current Objective-C class, and not those inherited
3233 from superclasses.  It is the responsibility of the Objective-C
3234 runtime to invoke all such methods in an object's inheritance
3235 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3236 by the runtime immediately after a new object instance is allocated;
3237 the @code{- (void) .cxx_destruct} methods are invoked immediately
3238 before the runtime deallocates an object instance.
3240 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3241 support for invoking the @code{- (id) .cxx_construct} and
3242 @code{- (void) .cxx_destruct} methods.
3244 @item -fobjc-direct-dispatch
3245 @opindex fobjc-direct-dispatch
3246 Allow fast jumps to the message dispatcher.  On Darwin this is
3247 accomplished via the comm page.
3249 @item -fobjc-exceptions
3250 @opindex fobjc-exceptions
3251 Enable syntactic support for structured exception handling in
3252 Objective-C, similar to what is offered by C++.  This option
3253 is required to use the Objective-C keywords @code{@@try},
3254 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3255 @code{@@synchronized}.  This option is available with both the GNU
3256 runtime and the NeXT runtime (but not available in conjunction with
3257 the NeXT runtime on Mac OS X 10.2 and earlier).
3259 @item -fobjc-gc
3260 @opindex fobjc-gc
3261 Enable garbage collection (GC) in Objective-C and Objective-C++
3262 programs.  This option is only available with the NeXT runtime; the
3263 GNU runtime has a different garbage collection implementation that
3264 does not require special compiler flags.
3266 @item -fobjc-nilcheck
3267 @opindex fobjc-nilcheck
3268 For the NeXT runtime with version 2 of the ABI, check for a nil
3269 receiver in method invocations before doing the actual method call.
3270 This is the default and can be disabled using
3271 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3272 checked for nil in this way no matter what this flag is set to.
3273 Currently this flag does nothing when the GNU runtime, or an older
3274 version of the NeXT runtime ABI, is used.
3276 @item -fobjc-std=objc1
3277 @opindex fobjc-std
3278 Conform to the language syntax of Objective-C 1.0, the language
3279 recognized by GCC 4.0.  This only affects the Objective-C additions to
3280 the C/C++ language; it does not affect conformance to C/C++ standards,
3281 which is controlled by the separate C/C++ dialect option flags.  When
3282 this option is used with the Objective-C or Objective-C++ compiler,
3283 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3284 This is useful if you need to make sure that your Objective-C code can
3285 be compiled with older versions of GCC@.
3287 @item -freplace-objc-classes
3288 @opindex freplace-objc-classes
3289 Emit a special marker instructing @command{ld(1)} not to statically link in
3290 the resulting object file, and allow @command{dyld(1)} to load it in at
3291 run time instead.  This is used in conjunction with the Fix-and-Continue
3292 debugging mode, where the object file in question may be recompiled and
3293 dynamically reloaded in the course of program execution, without the need
3294 to restart the program itself.  Currently, Fix-and-Continue functionality
3295 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3296 and later.
3298 @item -fzero-link
3299 @opindex fzero-link
3300 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3301 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3302 compile time) with static class references that get initialized at load time,
3303 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3304 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3305 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3306 for individual class implementations to be modified during program execution.
3307 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3308 regardless of command-line options.
3310 @item -fno-local-ivars
3311 @opindex fno-local-ivars
3312 @opindex flocal-ivars
3313 By default instance variables in Objective-C can be accessed as if
3314 they were local variables from within the methods of the class they're
3315 declared in.  This can lead to shadowing between instance variables
3316 and other variables declared either locally inside a class method or
3317 globally with the same name.  Specifying the @option{-fno-local-ivars}
3318 flag disables this behavior thus avoiding variable shadowing issues.
3320 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3321 @opindex fivar-visibility
3322 Set the default instance variable visibility to the specified option
3323 so that instance variables declared outside the scope of any access
3324 modifier directives default to the specified visibility.
3326 @item -gen-decls
3327 @opindex gen-decls
3328 Dump interface declarations for all classes seen in the source file to a
3329 file named @file{@var{sourcename}.decl}.
3331 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3332 @opindex Wassign-intercept
3333 @opindex Wno-assign-intercept
3334 Warn whenever an Objective-C assignment is being intercepted by the
3335 garbage collector.
3337 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3338 @opindex Wno-protocol
3339 @opindex Wprotocol
3340 If a class is declared to implement a protocol, a warning is issued for
3341 every method in the protocol that is not implemented by the class.  The
3342 default behavior is to issue a warning for every method not explicitly
3343 implemented in the class, even if a method implementation is inherited
3344 from the superclass.  If you use the @option{-Wno-protocol} option, then
3345 methods inherited from the superclass are considered to be implemented,
3346 and no warning is issued for them.
3348 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3349 @opindex Wselector
3350 @opindex Wno-selector
3351 Warn if multiple methods of different types for the same selector are
3352 found during compilation.  The check is performed on the list of methods
3353 in the final stage of compilation.  Additionally, a check is performed
3354 for each selector appearing in a @code{@@selector(@dots{})}
3355 expression, and a corresponding method for that selector has been found
3356 during compilation.  Because these checks scan the method table only at
3357 the end of compilation, these warnings are not produced if the final
3358 stage of compilation is not reached, for example because an error is
3359 found during compilation, or because the @option{-fsyntax-only} option is
3360 being used.
3362 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3363 @opindex Wstrict-selector-match
3364 @opindex Wno-strict-selector-match
3365 Warn if multiple methods with differing argument and/or return types are
3366 found for a given selector when attempting to send a message using this
3367 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3368 is off (which is the default behavior), the compiler omits such warnings
3369 if any differences found are confined to types that share the same size
3370 and alignment.
3372 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3373 @opindex Wundeclared-selector
3374 @opindex Wno-undeclared-selector
3375 Warn if a @code{@@selector(@dots{})} expression referring to an
3376 undeclared selector is found.  A selector is considered undeclared if no
3377 method with that name has been declared before the
3378 @code{@@selector(@dots{})} expression, either explicitly in an
3379 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3380 an @code{@@implementation} section.  This option always performs its
3381 checks as soon as a @code{@@selector(@dots{})} expression is found,
3382 while @option{-Wselector} only performs its checks in the final stage of
3383 compilation.  This also enforces the coding style convention
3384 that methods and selectors must be declared before being used.
3386 @item -print-objc-runtime-info
3387 @opindex print-objc-runtime-info
3388 Generate C header describing the largest structure that is passed by
3389 value, if any.
3391 @end table
3393 @node Diagnostic Message Formatting Options
3394 @section Options to Control Diagnostic Messages Formatting
3395 @cindex options to control diagnostics formatting
3396 @cindex diagnostic messages
3397 @cindex message formatting
3399 Traditionally, diagnostic messages have been formatted irrespective of
3400 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3401 options described below
3402 to control the formatting algorithm for diagnostic messages, 
3403 e.g.@: how many characters per line, how often source location
3404 information should be reported.  Note that some language front ends may not
3405 honor these options.
3407 @table @gcctabopt
3408 @item -fmessage-length=@var{n}
3409 @opindex fmessage-length
3410 Try to format error messages so that they fit on lines of about
3411 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3412 done; each error message appears on a single line.  This is the
3413 default for all front ends.
3415 @item -fdiagnostics-show-location=once
3416 @opindex fdiagnostics-show-location
3417 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3418 reporter to emit source location information @emph{once}; that is, in
3419 case the message is too long to fit on a single physical line and has to
3420 be wrapped, the source location won't be emitted (as prefix) again,
3421 over and over, in subsequent continuation lines.  This is the default
3422 behavior.
3424 @item -fdiagnostics-show-location=every-line
3425 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3426 messages reporter to emit the same source location information (as
3427 prefix) for physical lines that result from the process of breaking
3428 a message which is too long to fit on a single line.
3430 @item -fdiagnostics-color[=@var{WHEN}]
3431 @itemx -fno-diagnostics-color
3432 @opindex fdiagnostics-color
3433 @cindex highlight, color
3434 @vindex GCC_COLORS @r{environment variable}
3435 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3436 or @samp{auto}.  The default depends on how the compiler has been configured,
3437 it can be any of the above @var{WHEN} options or also @samp{never}
3438 if @env{GCC_COLORS} environment variable isn't present in the environment,
3439 and @samp{auto} otherwise.
3440 @samp{auto} means to use color only when the standard error is a terminal.
3441 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3442 aliases for @option{-fdiagnostics-color=always} and
3443 @option{-fdiagnostics-color=never}, respectively.
3445 The colors are defined by the environment variable @env{GCC_COLORS}.
3446 Its value is a colon-separated list of capabilities and Select Graphic
3447 Rendition (SGR) substrings. SGR commands are interpreted by the
3448 terminal or terminal emulator.  (See the section in the documentation
3449 of your text terminal for permitted values and their meanings as
3450 character attributes.)  These substring values are integers in decimal
3451 representation and can be concatenated with semicolons.
3452 Common values to concatenate include
3453 @samp{1} for bold,
3454 @samp{4} for underline,
3455 @samp{5} for blink,
3456 @samp{7} for inverse,
3457 @samp{39} for default foreground color,
3458 @samp{30} to @samp{37} for foreground colors,
3459 @samp{90} to @samp{97} for 16-color mode foreground colors,
3460 @samp{38;5;0} to @samp{38;5;255}
3461 for 88-color and 256-color modes foreground colors,
3462 @samp{49} for default background color,
3463 @samp{40} to @samp{47} for background colors,
3464 @samp{100} to @samp{107} for 16-color mode background colors,
3465 and @samp{48;5;0} to @samp{48;5;255}
3466 for 88-color and 256-color modes background colors.
3468 The default @env{GCC_COLORS} is
3469 @smallexample
3470 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3471 quote=01:fixit-insert=32:fixit-delete=31:\
3472 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3473 type-diff=01;32
3474 @end smallexample
3475 @noindent
3476 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3477 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3478 @samp{01} is bold, and @samp{31} is red.
3479 Setting @env{GCC_COLORS} to the empty string disables colors.
3480 Supported capabilities are as follows.
3482 @table @code
3483 @item error=
3484 @vindex error GCC_COLORS @r{capability}
3485 SGR substring for error: markers.
3487 @item warning=
3488 @vindex warning GCC_COLORS @r{capability}
3489 SGR substring for warning: markers.
3491 @item note=
3492 @vindex note GCC_COLORS @r{capability}
3493 SGR substring for note: markers.
3495 @item range1=
3496 @vindex range1 GCC_COLORS @r{capability}
3497 SGR substring for first additional range.
3499 @item range2=
3500 @vindex range2 GCC_COLORS @r{capability}
3501 SGR substring for second additional range.
3503 @item locus=
3504 @vindex locus GCC_COLORS @r{capability}
3505 SGR substring for location information, @samp{file:line} or
3506 @samp{file:line:column} etc.
3508 @item quote=
3509 @vindex quote GCC_COLORS @r{capability}
3510 SGR substring for information printed within quotes.
3512 @item fixit-insert=
3513 @vindex fixit-insert GCC_COLORS @r{capability}
3514 SGR substring for fix-it hints suggesting text to
3515 be inserted or replaced.
3517 @item fixit-delete=
3518 @vindex fixit-delete GCC_COLORS @r{capability}
3519 SGR substring for fix-it hints suggesting text to
3520 be deleted.
3522 @item diff-filename=
3523 @vindex diff-filename GCC_COLORS @r{capability}
3524 SGR substring for filename headers within generated patches.
3526 @item diff-hunk=
3527 @vindex diff-hunk GCC_COLORS @r{capability}
3528 SGR substring for the starts of hunks within generated patches.
3530 @item diff-delete=
3531 @vindex diff-delete GCC_COLORS @r{capability}
3532 SGR substring for deleted lines within generated patches.
3534 @item diff-insert=
3535 @vindex diff-insert GCC_COLORS @r{capability}
3536 SGR substring for inserted lines within generated patches.
3538 @item type-diff=
3539 @vindex type-diff GCC_COLORS @r{capability}
3540 SGR substring for highlighting mismatching types within template
3541 arguments in the C++ frontend.
3542 @end table
3544 @item -fno-diagnostics-show-option
3545 @opindex fno-diagnostics-show-option
3546 @opindex fdiagnostics-show-option
3547 By default, each diagnostic emitted includes text indicating the
3548 command-line option that directly controls the diagnostic (if such an
3549 option is known to the diagnostic machinery).  Specifying the
3550 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3552 @item -fno-diagnostics-show-caret
3553 @opindex fno-diagnostics-show-caret
3554 @opindex fdiagnostics-show-caret
3555 By default, each diagnostic emitted includes the original source line
3556 and a caret @samp{^} indicating the column.  This option suppresses this
3557 information.  The source line is truncated to @var{n} characters, if
3558 the @option{-fmessage-length=n} option is given.  When the output is done
3559 to the terminal, the width is limited to the width given by the
3560 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3562 @item -fdiagnostics-parseable-fixits
3563 @opindex fdiagnostics-parseable-fixits
3564 Emit fix-it hints in a machine-parseable format, suitable for consumption
3565 by IDEs.  For each fix-it, a line will be printed after the relevant
3566 diagnostic, starting with the string ``fix-it:''.  For example:
3568 @smallexample
3569 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3570 @end smallexample
3572 The location is expressed as a half-open range, expressed as a count of
3573 bytes, starting at byte 1 for the initial column.  In the above example,
3574 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3575 given string:
3577 @smallexample
3578 00000000011111111112222222222
3579 12345678901234567890123456789
3580   gtk_widget_showall (dlg);
3581   ^^^^^^^^^^^^^^^^^^
3582   gtk_widget_show_all
3583 @end smallexample
3585 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3586 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3587 (e.g. vertical tab as ``\013'').
3589 An empty replacement string indicates that the given range is to be removed.
3590 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3591 be inserted at the given position.
3593 @item -fdiagnostics-generate-patch
3594 @opindex fdiagnostics-generate-patch
3595 Print fix-it hints to stderr in unified diff format, after any diagnostics
3596 are printed.  For example:
3598 @smallexample
3599 --- test.c
3600 +++ test.c
3601 @@ -42,5 +42,5 @@
3603  void show_cb(GtkDialog *dlg)
3604  @{
3605 -  gtk_widget_showall(dlg);
3606 +  gtk_widget_show_all(dlg);
3607  @}
3609 @end smallexample
3611 The diff may or may not be colorized, following the same rules
3612 as for diagnostics (see @option{-fdiagnostics-color}).
3614 @item -fdiagnostics-show-template-tree
3615 @opindex fdiagnostics-show-template-tree
3617 In the C++ frontend, when printing diagnostics showing mismatching
3618 template types, such as:
3620 @smallexample
3621   could not convert 'std::map<int, std::vector<double> >()'
3622     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3623 @end smallexample
3625 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3626 tree-like structure showing the common and differing parts of the types,
3627 such as:
3629 @smallexample
3630   map<
3631     [...],
3632     vector<
3633       [double != float]>>
3634 @end smallexample
3636 The parts that differ are highlighted with color (``double'' and
3637 ``float'' in this case).
3639 @item -fno-elide-type
3640 @opindex fno-elide-type
3641 @opindex felide-type
3642 By default when the C++ frontend prints diagnostics showing mismatching
3643 template types, common parts of the types are printed as ``[...]'' to
3644 simplify the error message.  For example:
3646 @smallexample
3647   could not convert 'std::map<int, std::vector<double> >()'
3648     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3649 @end smallexample
3651 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3652 This flag also affects the output of the
3653 @option{-fdiagnostics-show-template-tree} flag.
3655 @item -fno-show-column
3656 @opindex fno-show-column
3657 Do not print column numbers in diagnostics.  This may be necessary if
3658 diagnostics are being scanned by a program that does not understand the
3659 column numbers, such as @command{dejagnu}.
3661 @end table
3663 @node Warning Options
3664 @section Options to Request or Suppress Warnings
3665 @cindex options to control warnings
3666 @cindex warning messages
3667 @cindex messages, warning
3668 @cindex suppressing warnings
3670 Warnings are diagnostic messages that report constructions that
3671 are not inherently erroneous but that are risky or suggest there
3672 may have been an error.
3674 The following language-independent options do not enable specific
3675 warnings but control the kinds of diagnostics produced by GCC@.
3677 @table @gcctabopt
3678 @cindex syntax checking
3679 @item -fsyntax-only
3680 @opindex fsyntax-only
3681 Check the code for syntax errors, but don't do anything beyond that.
3683 @item -fmax-errors=@var{n}
3684 @opindex fmax-errors
3685 Limits the maximum number of error messages to @var{n}, at which point
3686 GCC bails out rather than attempting to continue processing the source
3687 code.  If @var{n} is 0 (the default), there is no limit on the number
3688 of error messages produced.  If @option{-Wfatal-errors} is also
3689 specified, then @option{-Wfatal-errors} takes precedence over this
3690 option.
3692 @item -w
3693 @opindex w
3694 Inhibit all warning messages.
3696 @item -Werror
3697 @opindex Werror
3698 @opindex Wno-error
3699 Make all warnings into errors.
3701 @item -Werror=
3702 @opindex Werror=
3703 @opindex Wno-error=
3704 Make the specified warning into an error.  The specifier for a warning
3705 is appended; for example @option{-Werror=switch} turns the warnings
3706 controlled by @option{-Wswitch} into errors.  This switch takes a
3707 negative form, to be used to negate @option{-Werror} for specific
3708 warnings; for example @option{-Wno-error=switch} makes
3709 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3710 is in effect.
3712 The warning message for each controllable warning includes the
3713 option that controls the warning.  That option can then be used with
3714 @option{-Werror=} and @option{-Wno-error=} as described above.
3715 (Printing of the option in the warning message can be disabled using the
3716 @option{-fno-diagnostics-show-option} flag.)
3718 Note that specifying @option{-Werror=}@var{foo} automatically implies
3719 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3720 imply anything.
3722 @item -Wfatal-errors
3723 @opindex Wfatal-errors
3724 @opindex Wno-fatal-errors
3725 This option causes the compiler to abort compilation on the first error
3726 occurred rather than trying to keep going and printing further error
3727 messages.
3729 @end table
3731 You can request many specific warnings with options beginning with
3732 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3733 implicit declarations.  Each of these specific warning options also
3734 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3735 example, @option{-Wno-implicit}.  This manual lists only one of the
3736 two forms, whichever is not the default.  For further
3737 language-specific options also refer to @ref{C++ Dialect Options} and
3738 @ref{Objective-C and Objective-C++ Dialect Options}.
3740 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3741 options, such as @option{-Wunused}, which may turn on further options,
3742 such as @option{-Wunused-value}. The combined effect of positive and
3743 negative forms is that more specific options have priority over less
3744 specific ones, independently of their position in the command-line. For
3745 options of the same specificity, the last one takes effect. Options
3746 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3747 as if they appeared at the end of the command-line.
3749 When an unrecognized warning option is requested (e.g.,
3750 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3751 that the option is not recognized.  However, if the @option{-Wno-} form
3752 is used, the behavior is slightly different: no diagnostic is
3753 produced for @option{-Wno-unknown-warning} unless other diagnostics
3754 are being produced.  This allows the use of new @option{-Wno-} options
3755 with old compilers, but if something goes wrong, the compiler
3756 warns that an unrecognized option is present.
3758 @table @gcctabopt
3759 @item -Wpedantic
3760 @itemx -pedantic
3761 @opindex pedantic
3762 @opindex Wpedantic
3763 Issue all the warnings demanded by strict ISO C and ISO C++;
3764 reject all programs that use forbidden extensions, and some other
3765 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3766 version of the ISO C standard specified by any @option{-std} option used.
3768 Valid ISO C and ISO C++ programs should compile properly with or without
3769 this option (though a rare few require @option{-ansi} or a
3770 @option{-std} option specifying the required version of ISO C)@.  However,
3771 without this option, certain GNU extensions and traditional C and C++
3772 features are supported as well.  With this option, they are rejected.
3774 @option{-Wpedantic} does not cause warning messages for use of the
3775 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3776 warnings are also disabled in the expression that follows
3777 @code{__extension__}.  However, only system header files should use
3778 these escape routes; application programs should avoid them.
3779 @xref{Alternate Keywords}.
3781 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3782 C conformance.  They soon find that it does not do quite what they want:
3783 it finds some non-ISO practices, but not all---only those for which
3784 ISO C @emph{requires} a diagnostic, and some others for which
3785 diagnostics have been added.
3787 A feature to report any failure to conform to ISO C might be useful in
3788 some instances, but would require considerable additional work and would
3789 be quite different from @option{-Wpedantic}.  We don't have plans to
3790 support such a feature in the near future.
3792 Where the standard specified with @option{-std} represents a GNU
3793 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3794 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3795 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3796 where they are required by the base standard.  (It does not make sense
3797 for such warnings to be given only for features not in the specified GNU
3798 C dialect, since by definition the GNU dialects of C include all
3799 features the compiler supports with the given option, and there would be
3800 nothing to warn about.)
3802 @item -pedantic-errors
3803 @opindex pedantic-errors
3804 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3805 requires a diagnostic, in some cases where there is undefined behavior
3806 at compile-time and in some other cases that do not prevent compilation
3807 of programs that are valid according to the standard. This is not
3808 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3809 by this option and not enabled by the latter and vice versa.
3811 @item -Wall
3812 @opindex Wall
3813 @opindex Wno-all
3814 This enables all the warnings about constructions that some users
3815 consider questionable, and that are easy to avoid (or modify to
3816 prevent the warning), even in conjunction with macros.  This also
3817 enables some language-specific warnings described in @ref{C++ Dialect
3818 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3820 @option{-Wall} turns on the following warning flags:
3822 @gccoptlist{-Waddress   @gol
3823 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3824 -Wbool-compare  @gol
3825 -Wbool-operation  @gol
3826 -Wc++11-compat  -Wc++14-compat  @gol
3827 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3828 -Wchar-subscripts  @gol
3829 -Wcomment  @gol
3830 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3831 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3832 -Wformat   @gol
3833 -Wint-in-bool-context  @gol
3834 -Wimplicit @r{(C and Objective-C only)} @gol
3835 -Wimplicit-int @r{(C and Objective-C only)} @gol
3836 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3837 -Winit-self @r{(only for C++)} @gol
3838 -Wlogical-not-parentheses @gol
3839 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3840 -Wmaybe-uninitialized @gol
3841 -Wmemset-elt-size @gol
3842 -Wmemset-transposed-args @gol
3843 -Wmisleading-indentation @r{(only for C/C++)} @gol
3844 -Wmissing-braces @r{(only for C/ObjC)} @gol
3845 -Wmultistatement-macros  @gol
3846 -Wnarrowing @r{(only for C++)}  @gol
3847 -Wnonnull  @gol
3848 -Wnonnull-compare  @gol
3849 -Wopenmp-simd @gol
3850 -Wparentheses  @gol
3851 -Wpointer-sign  @gol
3852 -Wreorder   @gol
3853 -Wreturn-type  @gol
3854 -Wsequence-point  @gol
3855 -Wsign-compare @r{(only in C++)}  @gol
3856 -Wsizeof-pointer-div @gol
3857 -Wsizeof-pointer-memaccess @gol
3858 -Wstrict-aliasing  @gol
3859 -Wstrict-overflow=1  @gol
3860 -Wswitch  @gol
3861 -Wtautological-compare  @gol
3862 -Wtrigraphs  @gol
3863 -Wuninitialized  @gol
3864 -Wunknown-pragmas  @gol
3865 -Wunused-function  @gol
3866 -Wunused-label     @gol
3867 -Wunused-value     @gol
3868 -Wunused-variable  @gol
3869 -Wvolatile-register-var @gol
3872 Note that some warning flags are not implied by @option{-Wall}.  Some of
3873 them warn about constructions that users generally do not consider
3874 questionable, but which occasionally you might wish to check for;
3875 others warn about constructions that are necessary or hard to avoid in
3876 some cases, and there is no simple way to modify the code to suppress
3877 the warning. Some of them are enabled by @option{-Wextra} but many of
3878 them must be enabled individually.
3880 @item -Wextra
3881 @opindex W
3882 @opindex Wextra
3883 @opindex Wno-extra
3884 This enables some extra warning flags that are not enabled by
3885 @option{-Wall}. (This option used to be called @option{-W}.  The older
3886 name is still supported, but the newer name is more descriptive.)
3888 @gccoptlist{-Wclobbered  @gol
3889 -Wempty-body  @gol
3890 -Wignored-qualifiers @gol
3891 -Wimplicit-fallthrough=3 @gol
3892 -Wmissing-field-initializers  @gol
3893 -Wmissing-parameter-type @r{(C only)}  @gol
3894 -Wold-style-declaration @r{(C only)}  @gol
3895 -Woverride-init  @gol
3896 -Wsign-compare @r{(C only)} @gol
3897 -Wtype-limits  @gol
3898 -Wuninitialized  @gol
3899 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3900 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3901 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3904 The option @option{-Wextra} also prints warning messages for the
3905 following cases:
3907 @itemize @bullet
3909 @item
3910 A pointer is compared against integer zero with @code{<}, @code{<=},
3911 @code{>}, or @code{>=}.
3913 @item
3914 (C++ only) An enumerator and a non-enumerator both appear in a
3915 conditional expression.
3917 @item
3918 (C++ only) Ambiguous virtual bases.
3920 @item
3921 (C++ only) Subscripting an array that has been declared @code{register}.
3923 @item
3924 (C++ only) Taking the address of a variable that has been declared
3925 @code{register}.
3927 @item
3928 (C++ only) A base class is not initialized in the copy constructor
3929 of a derived class.
3931 @end itemize
3933 @item -Wchar-subscripts
3934 @opindex Wchar-subscripts
3935 @opindex Wno-char-subscripts
3936 Warn if an array subscript has type @code{char}.  This is a common cause
3937 of error, as programmers often forget that this type is signed on some
3938 machines.
3939 This warning is enabled by @option{-Wall}.
3941 @item -Wchkp
3942 @opindex Wchkp
3943 Warn about an invalid memory access that is found by Pointer Bounds Checker
3944 (@option{-fcheck-pointer-bounds}).
3946 @item -Wno-coverage-mismatch
3947 @opindex Wno-coverage-mismatch
3948 Warn if feedback profiles do not match when using the
3949 @option{-fprofile-use} option.
3950 If a source file is changed between compiling with @option{-fprofile-gen} and
3951 with @option{-fprofile-use}, the files with the profile feedback can fail
3952 to match the source file and GCC cannot use the profile feedback
3953 information.  By default, this warning is enabled and is treated as an
3954 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3955 warning or @option{-Wno-error=coverage-mismatch} can be used to
3956 disable the error.  Disabling the error for this warning can result in
3957 poorly optimized code and is useful only in the
3958 case of very minor changes such as bug fixes to an existing code-base.
3959 Completely disabling the warning is not recommended.
3961 @item -Wno-cpp
3962 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3964 Suppress warning messages emitted by @code{#warning} directives.
3966 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3967 @opindex Wdouble-promotion
3968 @opindex Wno-double-promotion
3969 Give a warning when a value of type @code{float} is implicitly
3970 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3971 floating-point unit implement @code{float} in hardware, but emulate
3972 @code{double} in software.  On such a machine, doing computations
3973 using @code{double} values is much more expensive because of the
3974 overhead required for software emulation.
3976 It is easy to accidentally do computations with @code{double} because
3977 floating-point literals are implicitly of type @code{double}.  For
3978 example, in:
3979 @smallexample
3980 @group
3981 float area(float radius)
3983    return 3.14159 * radius * radius;
3985 @end group
3986 @end smallexample
3987 the compiler performs the entire computation with @code{double}
3988 because the floating-point literal is a @code{double}.
3990 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3991 @opindex Wduplicate-decl-specifier
3992 @opindex Wno-duplicate-decl-specifier
3993 Warn if a declaration has duplicate @code{const}, @code{volatile},
3994 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3995 @option{-Wall}.
3997 @item -Wformat
3998 @itemx -Wformat=@var{n}
3999 @opindex Wformat
4000 @opindex Wno-format
4001 @opindex ffreestanding
4002 @opindex fno-builtin
4003 @opindex Wformat=
4004 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4005 the arguments supplied have types appropriate to the format string
4006 specified, and that the conversions specified in the format string make
4007 sense.  This includes standard functions, and others specified by format
4008 attributes (@pxref{Function Attributes}), in the @code{printf},
4009 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4010 not in the C standard) families (or other target-specific families).
4011 Which functions are checked without format attributes having been
4012 specified depends on the standard version selected, and such checks of
4013 functions without the attribute specified are disabled by
4014 @option{-ffreestanding} or @option{-fno-builtin}.
4016 The formats are checked against the format features supported by GNU
4017 libc version 2.2.  These include all ISO C90 and C99 features, as well
4018 as features from the Single Unix Specification and some BSD and GNU
4019 extensions.  Other library implementations may not support all these
4020 features; GCC does not support warning about features that go beyond a
4021 particular library's limitations.  However, if @option{-Wpedantic} is used
4022 with @option{-Wformat}, warnings are given about format features not
4023 in the selected standard version (but not for @code{strfmon} formats,
4024 since those are not in any version of the C standard).  @xref{C Dialect
4025 Options,,Options Controlling C Dialect}.
4027 @table @gcctabopt
4028 @item -Wformat=1
4029 @itemx -Wformat
4030 @opindex Wformat
4031 @opindex Wformat=1
4032 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4033 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4034 @option{-Wformat} also checks for null format arguments for several
4035 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4036 aspects of this level of format checking can be disabled by the
4037 options: @option{-Wno-format-contains-nul},
4038 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4039 @option{-Wformat} is enabled by @option{-Wall}.
4041 @item -Wno-format-contains-nul
4042 @opindex Wno-format-contains-nul
4043 @opindex Wformat-contains-nul
4044 If @option{-Wformat} is specified, do not warn about format strings that
4045 contain NUL bytes.
4047 @item -Wno-format-extra-args
4048 @opindex Wno-format-extra-args
4049 @opindex Wformat-extra-args
4050 If @option{-Wformat} is specified, do not warn about excess arguments to a
4051 @code{printf} or @code{scanf} format function.  The C standard specifies
4052 that such arguments are ignored.
4054 Where the unused arguments lie between used arguments that are
4055 specified with @samp{$} operand number specifications, normally
4056 warnings are still given, since the implementation could not know what
4057 type to pass to @code{va_arg} to skip the unused arguments.  However,
4058 in the case of @code{scanf} formats, this option suppresses the
4059 warning if the unused arguments are all pointers, since the Single
4060 Unix Specification says that such unused arguments are allowed.
4062 @item -Wformat-overflow
4063 @itemx -Wformat-overflow=@var{level}
4064 @opindex Wformat-overflow
4065 @opindex Wno-format-overflow
4066 Warn about calls to formatted input/output functions such as @code{sprintf}
4067 and @code{vsprintf} that might overflow the destination buffer.  When the
4068 exact number of bytes written by a format directive cannot be determined
4069 at compile-time it is estimated based on heuristics that depend on the
4070 @var{level} argument and on optimization.  While enabling optimization
4071 will in most cases improve the accuracy of the warning, it may also
4072 result in false positives.
4074 @table @gcctabopt
4075 @item -Wformat-overflow
4076 @item -Wformat-overflow=1
4077 @opindex Wformat-overflow
4078 @opindex Wno-format-overflow
4079 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4080 employs a conservative approach that warns only about calls that most
4081 likely overflow the buffer.  At this level, numeric arguments to format
4082 directives with unknown values are assumed to have the value of one, and
4083 strings of unknown length to be empty.  Numeric arguments that are known
4084 to be bounded to a subrange of their type, or string arguments whose output
4085 is bounded either by their directive's precision or by a finite set of
4086 string literals, are assumed to take on the value within the range that
4087 results in the most bytes on output.  For example, the call to @code{sprintf}
4088 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4089 the terminating NUL character (@code{'\0'}) appended by the function
4090 to the destination buffer will be written past its end.  Increasing
4091 the size of the buffer by a single byte is sufficient to avoid the
4092 warning, though it may not be sufficient to avoid the overflow.
4094 @smallexample
4095 void f (int a, int b)
4097   char buf [12];
4098   sprintf (buf, "a = %i, b = %i\n", a, b);
4100 @end smallexample
4102 @item -Wformat-overflow=2
4103 Level @var{2} warns also about calls that might overflow the destination
4104 buffer given an argument of sufficient length or magnitude.  At level
4105 @var{2}, unknown numeric arguments are assumed to have the minimum
4106 representable value for signed types with a precision greater than 1, and
4107 the maximum representable value otherwise.  Unknown string arguments whose
4108 length cannot be assumed to be bounded either by the directive's precision,
4109 or by a finite set of string literals they may evaluate to, or the character
4110 array they may point to, are assumed to be 1 character long.
4112 At level @var{2}, the call in the example above is again diagnosed, but
4113 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4114 @code{%i} directive will write some of its digits beyond the end of
4115 the destination buffer.  To make the call safe regardless of the values
4116 of the two variables, the size of the destination buffer must be increased
4117 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4118 an informational note following the warning.
4120 An alternative to increasing the size of the destination buffer is to
4121 constrain the range of formatted values.  The maximum length of string
4122 arguments can be bounded by specifying the precision in the format
4123 directive.  When numeric arguments of format directives can be assumed
4124 to be bounded by less than the precision of their type, choosing
4125 an appropriate length modifier to the format specifier will reduce
4126 the required buffer size.  For example, if @var{a} and @var{b} in the
4127 example above can be assumed to be within the precision of
4128 the @code{short int} type then using either the @code{%hi} format
4129 directive or casting the argument to @code{short} reduces the maximum
4130 required size of the buffer to 24 bytes.
4132 @smallexample
4133 void f (int a, int b)
4135   char buf [23];
4136   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4138 @end smallexample
4139 @end table
4141 @item -Wno-format-zero-length
4142 @opindex Wno-format-zero-length
4143 @opindex Wformat-zero-length
4144 If @option{-Wformat} is specified, do not warn about zero-length formats.
4145 The C standard specifies that zero-length formats are allowed.
4148 @item -Wformat=2
4149 @opindex Wformat=2
4150 Enable @option{-Wformat} plus additional format checks.  Currently
4151 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4152 -Wformat-y2k}.
4154 @item -Wformat-nonliteral
4155 @opindex Wformat-nonliteral
4156 @opindex Wno-format-nonliteral
4157 If @option{-Wformat} is specified, also warn if the format string is not a
4158 string literal and so cannot be checked, unless the format function
4159 takes its format arguments as a @code{va_list}.
4161 @item -Wformat-security
4162 @opindex Wformat-security
4163 @opindex Wno-format-security
4164 If @option{-Wformat} is specified, also warn about uses of format
4165 functions that represent possible security problems.  At present, this
4166 warns about calls to @code{printf} and @code{scanf} functions where the
4167 format string is not a string literal and there are no format arguments,
4168 as in @code{printf (foo);}.  This may be a security hole if the format
4169 string came from untrusted input and contains @samp{%n}.  (This is
4170 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4171 in future warnings may be added to @option{-Wformat-security} that are not
4172 included in @option{-Wformat-nonliteral}.)
4174 @item -Wformat-signedness
4175 @opindex Wformat-signedness
4176 @opindex Wno-format-signedness
4177 If @option{-Wformat} is specified, also warn if the format string
4178 requires an unsigned argument and the argument is signed and vice versa.
4180 @item -Wformat-truncation
4181 @itemx -Wformat-truncation=@var{level}
4182 @opindex Wformat-truncation
4183 @opindex Wno-format-truncation
4184 Warn about calls to formatted input/output functions such as @code{snprintf}
4185 and @code{vsnprintf} that might result in output truncation.  When the exact
4186 number of bytes written by a format directive cannot be determined at
4187 compile-time it is estimated based on heuristics that depend on
4188 the @var{level} argument and on optimization.  While enabling optimization
4189 will in most cases improve the accuracy of the warning, it may also result
4190 in false positives.  Except as noted otherwise, the option uses the same
4191 logic @option{-Wformat-overflow}.
4193 @table @gcctabopt
4194 @item -Wformat-truncation
4195 @item -Wformat-truncation=1
4196 @opindex Wformat-truncation
4197 @opindex Wno-format-overflow
4198 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4199 employs a conservative approach that warns only about calls to bounded
4200 functions whose return value is unused and that will most likely result
4201 in output truncation.
4203 @item -Wformat-truncation=2
4204 Level @var{2} warns also about calls to bounded functions whose return
4205 value is used and that might result in truncation given an argument of
4206 sufficient length or magnitude.
4207 @end table
4209 @item -Wformat-y2k
4210 @opindex Wformat-y2k
4211 @opindex Wno-format-y2k
4212 If @option{-Wformat} is specified, also warn about @code{strftime}
4213 formats that may yield only a two-digit year.
4214 @end table
4216 @item -Wnonnull
4217 @opindex Wnonnull
4218 @opindex Wno-nonnull
4219 Warn about passing a null pointer for arguments marked as
4220 requiring a non-null value by the @code{nonnull} function attribute.
4222 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4223 can be disabled with the @option{-Wno-nonnull} option.
4225 @item -Wnonnull-compare
4226 @opindex Wnonnull-compare
4227 @opindex Wno-nonnull-compare
4228 Warn when comparing an argument marked with the @code{nonnull}
4229 function attribute against null inside the function.
4231 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4232 can be disabled with the @option{-Wno-nonnull-compare} option.
4234 @item -Wnull-dereference
4235 @opindex Wnull-dereference
4236 @opindex Wno-null-dereference
4237 Warn if the compiler detects paths that trigger erroneous or
4238 undefined behavior due to dereferencing a null pointer.  This option
4239 is only active when @option{-fdelete-null-pointer-checks} is active,
4240 which is enabled by optimizations in most targets.  The precision of
4241 the warnings depends on the optimization options used.
4243 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4244 @opindex Winit-self
4245 @opindex Wno-init-self
4246 Warn about uninitialized variables that are initialized with themselves.
4247 Note this option can only be used with the @option{-Wuninitialized} option.
4249 For example, GCC warns about @code{i} being uninitialized in the
4250 following snippet only when @option{-Winit-self} has been specified:
4251 @smallexample
4252 @group
4253 int f()
4255   int i = i;
4256   return i;
4258 @end group
4259 @end smallexample
4261 This warning is enabled by @option{-Wall} in C++.
4263 @item -Wimplicit-int @r{(C and Objective-C only)}
4264 @opindex Wimplicit-int
4265 @opindex Wno-implicit-int
4266 Warn when a declaration does not specify a type.
4267 This warning is enabled by @option{-Wall}.
4269 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4270 @opindex Wimplicit-function-declaration
4271 @opindex Wno-implicit-function-declaration
4272 Give a warning whenever a function is used before being declared. In
4273 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4274 enabled by default and it is made into an error by
4275 @option{-pedantic-errors}. This warning is also enabled by
4276 @option{-Wall}.
4278 @item -Wimplicit @r{(C and Objective-C only)}
4279 @opindex Wimplicit
4280 @opindex Wno-implicit
4281 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4282 This warning is enabled by @option{-Wall}.
4284 @item -Wimplicit-fallthrough
4285 @opindex Wimplicit-fallthrough
4286 @opindex Wno-implicit-fallthrough
4287 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4288 and @option{-Wno-implicit-fallthrough} is the same as
4289 @option{-Wimplicit-fallthrough=0}.
4291 @item -Wimplicit-fallthrough=@var{n}
4292 @opindex Wimplicit-fallthrough=
4293 Warn when a switch case falls through.  For example:
4295 @smallexample
4296 @group
4297 switch (cond)
4298   @{
4299   case 1:
4300     a = 1;
4301     break;
4302   case 2:
4303     a = 2;
4304   case 3:
4305     a = 3;
4306     break;
4307   @}
4308 @end group
4309 @end smallexample
4311 This warning does not warn when the last statement of a case cannot
4312 fall through, e.g. when there is a return statement or a call to function
4313 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4314 also takes into account control flow statements, such as ifs, and only
4315 warns when appropriate.  E.g.@:
4317 @smallexample
4318 @group
4319 switch (cond)
4320   @{
4321   case 1:
4322     if (i > 3) @{
4323       bar (5);
4324       break;
4325     @} else if (i < 1) @{
4326       bar (0);
4327     @} else
4328       return;
4329   default:
4330     @dots{}
4331   @}
4332 @end group
4333 @end smallexample
4335 Since there are occasions where a switch case fall through is desirable,
4336 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4337 to be used along with a null statement to suppress this warning that
4338 would normally occur:
4340 @smallexample
4341 @group
4342 switch (cond)
4343   @{
4344   case 1:
4345     bar (0);
4346     __attribute__ ((fallthrough));
4347   default:
4348     @dots{}
4349   @}
4350 @end group
4351 @end smallexample
4353 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4354 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4355 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4356 Instead of these attributes, it is also possible to add a fallthrough comment
4357 to silence the warning.  The whole body of the C or C++ style comment should
4358 match the given regular expressions listed below.  The option argument @var{n}
4359 specifies what kind of comments are accepted:
4361 @itemize @bullet
4363 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4365 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4366 expression, any comment is used as fallthrough comment.
4368 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4369 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4371 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4372 following regular expressions:
4374 @itemize @bullet
4376 @item @code{-fallthrough}
4378 @item @code{@@fallthrough@@}
4380 @item @code{lint -fallthrough[ \t]*}
4382 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4384 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4386 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4388 @end itemize
4390 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4391 following regular expressions:
4393 @itemize @bullet
4395 @item @code{-fallthrough}
4397 @item @code{@@fallthrough@@}
4399 @item @code{lint -fallthrough[ \t]*}
4401 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4403 @end itemize
4405 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4406 fallthrough comments, only attributes disable the warning.
4408 @end itemize
4410 The comment needs to be followed after optional whitespace and other comments
4411 by @code{case} or @code{default} keywords or by a user label that precedes some
4412 @code{case} or @code{default} label.
4414 @smallexample
4415 @group
4416 switch (cond)
4417   @{
4418   case 1:
4419     bar (0);
4420     /* FALLTHRU */
4421   default:
4422     @dots{}
4423   @}
4424 @end group
4425 @end smallexample
4427 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4429 @item -Wignored-qualifiers @r{(C and C++ only)}
4430 @opindex Wignored-qualifiers
4431 @opindex Wno-ignored-qualifiers
4432 Warn if the return type of a function has a type qualifier
4433 such as @code{const}.  For ISO C such a type qualifier has no effect,
4434 since the value returned by a function is not an lvalue.
4435 For C++, the warning is only emitted for scalar types or @code{void}.
4436 ISO C prohibits qualified @code{void} return types on function
4437 definitions, so such return types always receive a warning
4438 even without this option.
4440 This warning is also enabled by @option{-Wextra}.
4442 @item -Wignored-attributes @r{(C and C++ only)}
4443 @opindex Wignored-attributes
4444 @opindex Wno-ignored-attributes
4445 Warn when an attribute is ignored.  This is different from the
4446 @option{-Wattributes} option in that it warns whenever the compiler decides
4447 to drop an attribute, not that the attribute is either unknown, used in a
4448 wrong place, etc.  This warning is enabled by default.
4450 @item -Wmain
4451 @opindex Wmain
4452 @opindex Wno-main
4453 Warn if the type of @code{main} is suspicious.  @code{main} should be
4454 a function with external linkage, returning int, taking either zero
4455 arguments, two, or three arguments of appropriate types.  This warning
4456 is enabled by default in C++ and is enabled by either @option{-Wall}
4457 or @option{-Wpedantic}.
4459 @item -Wmisleading-indentation @r{(C and C++ only)}
4460 @opindex Wmisleading-indentation
4461 @opindex Wno-misleading-indentation
4462 Warn when the indentation of the code does not reflect the block structure.
4463 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4464 @code{for} clauses with a guarded statement that does not use braces,
4465 followed by an unguarded statement with the same indentation.
4467 In the following example, the call to ``bar'' is misleadingly indented as
4468 if it were guarded by the ``if'' conditional.
4470 @smallexample
4471   if (some_condition ())
4472     foo ();
4473     bar ();  /* Gotcha: this is not guarded by the "if".  */
4474 @end smallexample
4476 In the case of mixed tabs and spaces, the warning uses the
4477 @option{-ftabstop=} option to determine if the statements line up
4478 (defaulting to 8).
4480 The warning is not issued for code involving multiline preprocessor logic
4481 such as the following example.
4483 @smallexample
4484   if (flagA)
4485     foo (0);
4486 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4487   if (flagB)
4488 #endif
4489     foo (1);
4490 @end smallexample
4492 The warning is not issued after a @code{#line} directive, since this
4493 typically indicates autogenerated code, and no assumptions can be made
4494 about the layout of the file that the directive references.
4496 This warning is enabled by @option{-Wall} in C and C++.
4498 @item -Wmissing-braces
4499 @opindex Wmissing-braces
4500 @opindex Wno-missing-braces
4501 Warn if an aggregate or union initializer is not fully bracketed.  In
4502 the following example, the initializer for @code{a} is not fully
4503 bracketed, but that for @code{b} is fully bracketed.  This warning is
4504 enabled by @option{-Wall} in C.
4506 @smallexample
4507 int a[2][2] = @{ 0, 1, 2, 3 @};
4508 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4509 @end smallexample
4511 This warning is enabled by @option{-Wall}.
4513 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4514 @opindex Wmissing-include-dirs
4515 @opindex Wno-missing-include-dirs
4516 Warn if a user-supplied include directory does not exist.
4518 @item -Wmultistatement-macros
4519 @opindex Wmultistatement-macros
4520 @opindex Wno-multistatement-macros
4521 Warn about unsafe multiple statement macros that appear to be guarded
4522 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4523 @code{while}, in which only the first statement is actually guarded after
4524 the macro is expanded.
4526 For example:
4528 @smallexample
4529 #define DOIT x++; y++
4530 if (c)
4531   DOIT;
4532 @end smallexample
4534 will increment @code{y} unconditionally, not just when @code{c} holds.
4535 The can usually be fixed by wrapping the macro in a do-while loop:
4536 @smallexample
4537 #define DOIT do @{ x++; y++; @} while (0)
4538 if (c)
4539   DOIT;
4540 @end smallexample
4542 This warning is enabled by @option{-Wall} in C and C++.
4544 @item -Wparentheses
4545 @opindex Wparentheses
4546 @opindex Wno-parentheses
4547 Warn if parentheses are omitted in certain contexts, such
4548 as when there is an assignment in a context where a truth value
4549 is expected, or when operators are nested whose precedence people
4550 often get confused about.
4552 Also warn if a comparison like @code{x<=y<=z} appears; this is
4553 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4554 interpretation from that of ordinary mathematical notation.
4556 Also warn for dangerous uses of the GNU extension to
4557 @code{?:} with omitted middle operand. When the condition
4558 in the @code{?}: operator is a boolean expression, the omitted value is
4559 always 1.  Often programmers expect it to be a value computed
4560 inside the conditional expression instead.
4562 This warning is enabled by @option{-Wall}.
4564 @item -Wsequence-point
4565 @opindex Wsequence-point
4566 @opindex Wno-sequence-point
4567 Warn about code that may have undefined semantics because of violations
4568 of sequence point rules in the C and C++ standards.
4570 The C and C++ standards define the order in which expressions in a C/C++
4571 program are evaluated in terms of @dfn{sequence points}, which represent
4572 a partial ordering between the execution of parts of the program: those
4573 executed before the sequence point, and those executed after it.  These
4574 occur after the evaluation of a full expression (one which is not part
4575 of a larger expression), after the evaluation of the first operand of a
4576 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4577 function is called (but after the evaluation of its arguments and the
4578 expression denoting the called function), and in certain other places.
4579 Other than as expressed by the sequence point rules, the order of
4580 evaluation of subexpressions of an expression is not specified.  All
4581 these rules describe only a partial order rather than a total order,
4582 since, for example, if two functions are called within one expression
4583 with no sequence point between them, the order in which the functions
4584 are called is not specified.  However, the standards committee have
4585 ruled that function calls do not overlap.
4587 It is not specified when between sequence points modifications to the
4588 values of objects take effect.  Programs whose behavior depends on this
4589 have undefined behavior; the C and C++ standards specify that ``Between
4590 the previous and next sequence point an object shall have its stored
4591 value modified at most once by the evaluation of an expression.
4592 Furthermore, the prior value shall be read only to determine the value
4593 to be stored.''.  If a program breaks these rules, the results on any
4594 particular implementation are entirely unpredictable.
4596 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4597 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4598 diagnosed by this option, and it may give an occasional false positive
4599 result, but in general it has been found fairly effective at detecting
4600 this sort of problem in programs.
4602 The C++17 standard will define the order of evaluation of operands in
4603 more cases: in particular it requires that the right-hand side of an
4604 assignment be evaluated before the left-hand side, so the above
4605 examples are no longer undefined.  But this warning will still warn
4606 about them, to help people avoid writing code that is undefined in C
4607 and earlier revisions of C++.
4609 The standard is worded confusingly, therefore there is some debate
4610 over the precise meaning of the sequence point rules in subtle cases.
4611 Links to discussions of the problem, including proposed formal
4612 definitions, may be found on the GCC readings page, at
4613 @uref{http://gcc.gnu.org/@/readings.html}.
4615 This warning is enabled by @option{-Wall} for C and C++.
4617 @item -Wno-return-local-addr
4618 @opindex Wno-return-local-addr
4619 @opindex Wreturn-local-addr
4620 Do not warn about returning a pointer (or in C++, a reference) to a
4621 variable that goes out of scope after the function returns.
4623 @item -Wreturn-type
4624 @opindex Wreturn-type
4625 @opindex Wno-return-type
4626 Warn whenever a function is defined with a return type that defaults
4627 to @code{int}.  Also warn about any @code{return} statement with no
4628 return value in a function whose return type is not @code{void}
4629 (falling off the end of the function body is considered returning
4630 without a value).
4632 For C only, warn about a @code{return} statement with an expression in a
4633 function whose return type is @code{void}, unless the expression type is
4634 also @code{void}.  As a GNU extension, the latter case is accepted
4635 without a warning unless @option{-Wpedantic} is used.
4637 For C++, a function without return type always produces a diagnostic
4638 message, even when @option{-Wno-return-type} is specified.  The only
4639 exceptions are @code{main} and functions defined in system headers.
4641 This warning is enabled by @option{-Wall}.
4643 @item -Wshift-count-negative
4644 @opindex Wshift-count-negative
4645 @opindex Wno-shift-count-negative
4646 Warn if shift count is negative. This warning is enabled by default.
4648 @item -Wshift-count-overflow
4649 @opindex Wshift-count-overflow
4650 @opindex Wno-shift-count-overflow
4651 Warn if shift count >= width of type. This warning is enabled by default.
4653 @item -Wshift-negative-value
4654 @opindex Wshift-negative-value
4655 @opindex Wno-shift-negative-value
4656 Warn if left shifting a negative value.  This warning is enabled by
4657 @option{-Wextra} in C99 and C++11 modes (and newer).
4659 @item -Wshift-overflow
4660 @itemx -Wshift-overflow=@var{n}
4661 @opindex Wshift-overflow
4662 @opindex Wno-shift-overflow
4663 Warn about left shift overflows.  This warning is enabled by
4664 default in C99 and C++11 modes (and newer).
4666 @table @gcctabopt
4667 @item -Wshift-overflow=1
4668 This is the warning level of @option{-Wshift-overflow} and is enabled
4669 by default in C99 and C++11 modes (and newer).  This warning level does
4670 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4671 an overflow is still rejected in contexts where an integer constant expression
4672 is required.)
4674 @item -Wshift-overflow=2
4675 This warning level also warns about left-shifting 1 into the sign bit,
4676 unless C++14 mode is active.
4677 @end table
4679 @item -Wswitch
4680 @opindex Wswitch
4681 @opindex Wno-switch
4682 Warn whenever a @code{switch} statement has an index of enumerated type
4683 and lacks a @code{case} for one or more of the named codes of that
4684 enumeration.  (The presence of a @code{default} label prevents this
4685 warning.)  @code{case} labels outside the enumeration range also
4686 provoke warnings when this option is used (even if there is a
4687 @code{default} label).
4688 This warning is enabled by @option{-Wall}.
4690 @item -Wswitch-default
4691 @opindex Wswitch-default
4692 @opindex Wno-switch-default
4693 Warn whenever a @code{switch} statement does not have a @code{default}
4694 case.
4696 @item -Wswitch-enum
4697 @opindex Wswitch-enum
4698 @opindex Wno-switch-enum
4699 Warn whenever a @code{switch} statement has an index of enumerated type
4700 and lacks a @code{case} for one or more of the named codes of that
4701 enumeration.  @code{case} labels outside the enumeration range also
4702 provoke warnings when this option is used.  The only difference
4703 between @option{-Wswitch} and this option is that this option gives a
4704 warning about an omitted enumeration code even if there is a
4705 @code{default} label.
4707 @item -Wswitch-bool
4708 @opindex Wswitch-bool
4709 @opindex Wno-switch-bool
4710 Warn whenever a @code{switch} statement has an index of boolean type
4711 and the case values are outside the range of a boolean type.
4712 It is possible to suppress this warning by casting the controlling
4713 expression to a type other than @code{bool}.  For example:
4714 @smallexample
4715 @group
4716 switch ((int) (a == 4))
4717   @{
4718   @dots{}
4719   @}
4720 @end group
4721 @end smallexample
4722 This warning is enabled by default for C and C++ programs.
4724 @item -Wswitch-unreachable
4725 @opindex Wswitch-unreachable
4726 @opindex Wno-switch-unreachable
4727 Warn whenever a @code{switch} statement contains statements between the
4728 controlling expression and the first case label, which will never be
4729 executed.  For example:
4730 @smallexample
4731 @group
4732 switch (cond)
4733   @{
4734    i = 15;
4735   @dots{}
4736    case 5:
4737   @dots{}
4738   @}
4739 @end group
4740 @end smallexample
4741 @option{-Wswitch-unreachable} does not warn if the statement between the
4742 controlling expression and the first case label is just a declaration:
4743 @smallexample
4744 @group
4745 switch (cond)
4746   @{
4747    int i;
4748   @dots{}
4749    case 5:
4750    i = 5;
4751   @dots{}
4752   @}
4753 @end group
4754 @end smallexample
4755 This warning is enabled by default for C and C++ programs.
4757 @item -Wsync-nand @r{(C and C++ only)}
4758 @opindex Wsync-nand
4759 @opindex Wno-sync-nand
4760 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4761 built-in functions are used.  These functions changed semantics in GCC 4.4.
4763 @item -Wunused-but-set-parameter
4764 @opindex Wunused-but-set-parameter
4765 @opindex Wno-unused-but-set-parameter
4766 Warn whenever a function parameter is assigned to, but otherwise unused
4767 (aside from its declaration).
4769 To suppress this warning use the @code{unused} attribute
4770 (@pxref{Variable Attributes}).
4772 This warning is also enabled by @option{-Wunused} together with
4773 @option{-Wextra}.
4775 @item -Wunused-but-set-variable
4776 @opindex Wunused-but-set-variable
4777 @opindex Wno-unused-but-set-variable
4778 Warn whenever a local variable is assigned to, but otherwise unused
4779 (aside from its declaration).
4780 This warning is enabled by @option{-Wall}.
4782 To suppress this warning use the @code{unused} attribute
4783 (@pxref{Variable Attributes}).
4785 This warning is also enabled by @option{-Wunused}, which is enabled
4786 by @option{-Wall}.
4788 @item -Wunused-function
4789 @opindex Wunused-function
4790 @opindex Wno-unused-function
4791 Warn whenever a static function is declared but not defined or a
4792 non-inline static function is unused.
4793 This warning is enabled by @option{-Wall}.
4795 @item -Wunused-label
4796 @opindex Wunused-label
4797 @opindex Wno-unused-label
4798 Warn whenever a label is declared but not used.
4799 This warning is enabled by @option{-Wall}.
4801 To suppress this warning use the @code{unused} attribute
4802 (@pxref{Variable Attributes}).
4804 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4805 @opindex Wunused-local-typedefs
4806 Warn when a typedef locally defined in a function is not used.
4807 This warning is enabled by @option{-Wall}.
4809 @item -Wunused-parameter
4810 @opindex Wunused-parameter
4811 @opindex Wno-unused-parameter
4812 Warn whenever a function parameter is unused aside from its declaration.
4814 To suppress this warning use the @code{unused} attribute
4815 (@pxref{Variable Attributes}).
4817 @item -Wno-unused-result
4818 @opindex Wunused-result
4819 @opindex Wno-unused-result
4820 Do not warn if a caller of a function marked with attribute
4821 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4822 its return value. The default is @option{-Wunused-result}.
4824 @item -Wunused-variable
4825 @opindex Wunused-variable
4826 @opindex Wno-unused-variable
4827 Warn whenever a local or static variable is unused aside from its
4828 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4829 but not for C++. This warning is enabled by @option{-Wall}.
4831 To suppress this warning use the @code{unused} attribute
4832 (@pxref{Variable Attributes}).
4834 @item -Wunused-const-variable
4835 @itemx -Wunused-const-variable=@var{n}
4836 @opindex Wunused-const-variable
4837 @opindex Wno-unused-const-variable
4838 Warn whenever a constant static variable is unused aside from its declaration.
4839 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4840 for C, but not for C++. In C this declares variable storage, but in C++ this
4841 is not an error since const variables take the place of @code{#define}s.
4843 To suppress this warning use the @code{unused} attribute
4844 (@pxref{Variable Attributes}).
4846 @table @gcctabopt
4847 @item -Wunused-const-variable=1
4848 This is the warning level that is enabled by @option{-Wunused-variable} for
4849 C.  It warns only about unused static const variables defined in the main
4850 compilation unit, but not about static const variables declared in any
4851 header included.
4853 @item -Wunused-const-variable=2
4854 This warning level also warns for unused constant static variables in
4855 headers (excluding system headers).  This is the warning level of
4856 @option{-Wunused-const-variable} and must be explicitly requested since
4857 in C++ this isn't an error and in C it might be harder to clean up all
4858 headers included.
4859 @end table
4861 @item -Wunused-value
4862 @opindex Wunused-value
4863 @opindex Wno-unused-value
4864 Warn whenever a statement computes a result that is explicitly not
4865 used. To suppress this warning cast the unused expression to
4866 @code{void}. This includes an expression-statement or the left-hand
4867 side of a comma expression that contains no side effects. For example,
4868 an expression such as @code{x[i,j]} causes a warning, while
4869 @code{x[(void)i,j]} does not.
4871 This warning is enabled by @option{-Wall}.
4873 @item -Wunused
4874 @opindex Wunused
4875 @opindex Wno-unused
4876 All the above @option{-Wunused} options combined.
4878 In order to get a warning about an unused function parameter, you must
4879 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4880 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4882 @item -Wuninitialized
4883 @opindex Wuninitialized
4884 @opindex Wno-uninitialized
4885 Warn if an automatic variable is used without first being initialized
4886 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4887 warn if a non-static reference or non-static @code{const} member
4888 appears in a class without constructors.
4890 If you want to warn about code that uses the uninitialized value of the
4891 variable in its own initializer, use the @option{-Winit-self} option.
4893 These warnings occur for individual uninitialized or clobbered
4894 elements of structure, union or array variables as well as for
4895 variables that are uninitialized or clobbered as a whole.  They do
4896 not occur for variables or elements declared @code{volatile}.  Because
4897 these warnings depend on optimization, the exact variables or elements
4898 for which there are warnings depends on the precise optimization
4899 options and version of GCC used.
4901 Note that there may be no warning about a variable that is used only
4902 to compute a value that itself is never used, because such
4903 computations may be deleted by data flow analysis before the warnings
4904 are printed.
4906 @item -Winvalid-memory-model
4907 @opindex Winvalid-memory-model
4908 @opindex Wno-invalid-memory-model
4909 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4910 and the C11 atomic generic functions with a memory consistency argument
4911 that is either invalid for the operation or outside the range of values
4912 of the @code{memory_order} enumeration.  For example, since the
4913 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4914 defined for the relaxed, release, and sequentially consistent memory
4915 orders the following code is diagnosed:
4917 @smallexample
4918 void store (int *i)
4920   __atomic_store_n (i, 0, memory_order_consume);
4922 @end smallexample
4924 @option{-Winvalid-memory-model} is enabled by default.
4926 @item -Wmaybe-uninitialized
4927 @opindex Wmaybe-uninitialized
4928 @opindex Wno-maybe-uninitialized
4929 For an automatic variable, if there exists a path from the function
4930 entry to a use of the variable that is initialized, but there exist
4931 some other paths for which the variable is not initialized, the compiler
4932 emits a warning if it cannot prove the uninitialized paths are not
4933 executed at run time. These warnings are made optional because GCC is
4934 not smart enough to see all the reasons why the code might be correct
4935 in spite of appearing to have an error.  Here is one example of how
4936 this can happen:
4938 @smallexample
4939 @group
4941   int x;
4942   switch (y)
4943     @{
4944     case 1: x = 1;
4945       break;
4946     case 2: x = 4;
4947       break;
4948     case 3: x = 5;
4949     @}
4950   foo (x);
4952 @end group
4953 @end smallexample
4955 @noindent
4956 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4957 always initialized, but GCC doesn't know this. To suppress the
4958 warning, you need to provide a default case with assert(0) or
4959 similar code.
4961 @cindex @code{longjmp} warnings
4962 This option also warns when a non-volatile automatic variable might be
4963 changed by a call to @code{longjmp}.  These warnings as well are possible
4964 only in optimizing compilation.
4966 The compiler sees only the calls to @code{setjmp}.  It cannot know
4967 where @code{longjmp} will be called; in fact, a signal handler could
4968 call it at any point in the code.  As a result, you may get a warning
4969 even when there is in fact no problem because @code{longjmp} cannot
4970 in fact be called at the place that would cause a problem.
4972 Some spurious warnings can be avoided if you declare all the functions
4973 you use that never return as @code{noreturn}.  @xref{Function
4974 Attributes}.
4976 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4978 @item -Wunknown-pragmas
4979 @opindex Wunknown-pragmas
4980 @opindex Wno-unknown-pragmas
4981 @cindex warning for unknown pragmas
4982 @cindex unknown pragmas, warning
4983 @cindex pragmas, warning of unknown
4984 Warn when a @code{#pragma} directive is encountered that is not understood by 
4985 GCC@.  If this command-line option is used, warnings are even issued
4986 for unknown pragmas in system header files.  This is not the case if
4987 the warnings are only enabled by the @option{-Wall} command-line option.
4989 @item -Wno-pragmas
4990 @opindex Wno-pragmas
4991 @opindex Wpragmas
4992 Do not warn about misuses of pragmas, such as incorrect parameters,
4993 invalid syntax, or conflicts between pragmas.  See also
4994 @option{-Wunknown-pragmas}.
4996 @item -Wstrict-aliasing
4997 @opindex Wstrict-aliasing
4998 @opindex Wno-strict-aliasing
4999 This option is only active when @option{-fstrict-aliasing} is active.
5000 It warns about code that might break the strict aliasing rules that the
5001 compiler is using for optimization.  The warning does not catch all
5002 cases, but does attempt to catch the more common pitfalls.  It is
5003 included in @option{-Wall}.
5004 It is equivalent to @option{-Wstrict-aliasing=3}
5006 @item -Wstrict-aliasing=n
5007 @opindex Wstrict-aliasing=n
5008 This option is only active when @option{-fstrict-aliasing} is active.
5009 It warns about code that might break the strict aliasing rules that the
5010 compiler is using for optimization.
5011 Higher levels correspond to higher accuracy (fewer false positives).
5012 Higher levels also correspond to more effort, similar to the way @option{-O} 
5013 works.
5014 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5016 Level 1: Most aggressive, quick, least accurate.
5017 Possibly useful when higher levels
5018 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5019 false negatives.  However, it has many false positives.
5020 Warns for all pointer conversions between possibly incompatible types,
5021 even if never dereferenced.  Runs in the front end only.
5023 Level 2: Aggressive, quick, not too precise.
5024 May still have many false positives (not as many as level 1 though),
5025 and few false negatives (but possibly more than level 1).
5026 Unlike level 1, it only warns when an address is taken.  Warns about
5027 incomplete types.  Runs in the front end only.
5029 Level 3 (default for @option{-Wstrict-aliasing}):
5030 Should have very few false positives and few false
5031 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5032 Takes care of the common pun+dereference pattern in the front end:
5033 @code{*(int*)&some_float}.
5034 If optimization is enabled, it also runs in the back end, where it deals
5035 with multiple statement cases using flow-sensitive points-to information.
5036 Only warns when the converted pointer is dereferenced.
5037 Does not warn about incomplete types.
5039 @item -Wstrict-overflow
5040 @itemx -Wstrict-overflow=@var{n}
5041 @opindex Wstrict-overflow
5042 @opindex Wno-strict-overflow
5043 This option is only active when signed overflow is undefined.
5044 It warns about cases where the compiler optimizes based on the
5045 assumption that signed overflow does not occur.  Note that it does not
5046 warn about all cases where the code might overflow: it only warns
5047 about cases where the compiler implements some optimization.  Thus
5048 this warning depends on the optimization level.
5050 An optimization that assumes that signed overflow does not occur is
5051 perfectly safe if the values of the variables involved are such that
5052 overflow never does, in fact, occur.  Therefore this warning can
5053 easily give a false positive: a warning about code that is not
5054 actually a problem.  To help focus on important issues, several
5055 warning levels are defined.  No warnings are issued for the use of
5056 undefined signed overflow when estimating how many iterations a loop
5057 requires, in particular when determining whether a loop will be
5058 executed at all.
5060 @table @gcctabopt
5061 @item -Wstrict-overflow=1
5062 Warn about cases that are both questionable and easy to avoid.  For
5063 example the compiler simplifies
5064 @code{x + 1 > x} to @code{1}.  This level of
5065 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5066 are not, and must be explicitly requested.
5068 @item -Wstrict-overflow=2
5069 Also warn about other cases where a comparison is simplified to a
5070 constant.  For example: @code{abs (x) >= 0}.  This can only be
5071 simplified when signed integer overflow is undefined, because
5072 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5073 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5074 @option{-Wstrict-overflow=2}.
5076 @item -Wstrict-overflow=3
5077 Also warn about other cases where a comparison is simplified.  For
5078 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5080 @item -Wstrict-overflow=4
5081 Also warn about other simplifications not covered by the above cases.
5082 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5084 @item -Wstrict-overflow=5
5085 Also warn about cases where the compiler reduces the magnitude of a
5086 constant involved in a comparison.  For example: @code{x + 2 > y} is
5087 simplified to @code{x + 1 >= y}.  This is reported only at the
5088 highest warning level because this simplification applies to many
5089 comparisons, so this warning level gives a very large number of
5090 false positives.
5091 @end table
5093 @item -Wstringop-overflow
5094 @itemx -Wstringop-overflow=@var{type}
5095 @opindex Wstringop-overflow
5096 @opindex Wno-stringop-overflow
5097 Warn for calls to string manipulation functions such as @code{memcpy} and
5098 @code{strcpy} that are determined to overflow the destination buffer.  The
5099 optional argument is one greater than the type of Object Size Checking to
5100 perform to determine the size of the destination.  @xref{Object Size Checking}.
5101 The argument is meaningful only for functions that operate on character arrays
5102 but not for raw memory functions like @code{memcpy} which always make use
5103 of Object Size type-0.  The option also warns for calls that specify a size
5104 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5105 The option produces the best results with optimization enabled but can detect
5106 a small subset of simple buffer overflows even without optimization in
5107 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5108 correspond to the standard functions.  In any case, the option warns about
5109 just a subset of buffer overflows detected by the corresponding overflow
5110 checking built-ins.  For example, the option will issue a warning for
5111 the @code{strcpy} call below because it copies at least 5 characters
5112 (the string @code{"blue"} including the terminating NUL) into the buffer
5113 of size 4.
5115 @smallexample
5116 enum Color @{ blue, purple, yellow @};
5117 const char* f (enum Color clr)
5119   static char buf [4];
5120   const char *str;
5121   switch (clr)
5122     @{
5123       case blue: str = "blue"; break;
5124       case purple: str = "purple"; break;
5125       case yellow: str = "yellow"; break;
5126     @}
5128   return strcpy (buf, str);   // warning here
5130 @end smallexample
5132 Option @option{-Wstringop-overflow=2} is enabled by default.
5134 @table @gcctabopt
5135 @item -Wstringop-overflow
5136 @item -Wstringop-overflow=1
5137 @opindex Wstringop-overflow
5138 @opindex Wno-stringop-overflow
5139 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5140 to determine the sizes of destination objects.  This is the default setting
5141 of the option.  At this setting the option will not warn for writes past
5142 the end of subobjects of larger objects accessed by pointers unless the
5143 size of the largest surrounding object is known.  When the destination may
5144 be one of several objects it is assumed to be the largest one of them.  On
5145 Linux systems, when optimization is enabled at this setting the option warns
5146 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5147 a non-zero value.
5149 @item -Wstringop-overflow=2
5150 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5151 to determine the sizes of destination objects.  At this setting the option
5152 will warn about overflows when writing to members of the largest complete
5153 objects whose exact size is known.  It will, however, not warn for excessive
5154 writes to the same members of unknown objects referenced by pointers since
5155 they may point to arrays containing unknown numbers of elements.
5157 @item -Wstringop-overflow=3
5158 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5159 to determine the sizes of destination objects.  At this setting the option
5160 warns about overflowing the smallest object or data member.  This is the
5161 most restrictive setting of the option that may result in warnings for safe
5162 code.
5164 @item -Wstringop-overflow=4
5165 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5166 to determine the sizes of destination objects.  At this setting the option
5167 will warn about overflowing any data members, and when the destination is
5168 one of several objects it uses the size of the largest of them to decide
5169 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5170 setting of the option may result in warnings for benign code.
5171 @end table
5173 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5174 @opindex Wsuggest-attribute=
5175 @opindex Wno-suggest-attribute=
5176 Warn for cases where adding an attribute may be beneficial. The
5177 attributes currently supported are listed below.
5179 @table @gcctabopt
5180 @item -Wsuggest-attribute=pure
5181 @itemx -Wsuggest-attribute=const
5182 @itemx -Wsuggest-attribute=noreturn
5183 @opindex Wsuggest-attribute=pure
5184 @opindex Wno-suggest-attribute=pure
5185 @opindex Wsuggest-attribute=const
5186 @opindex Wno-suggest-attribute=const
5187 @opindex Wsuggest-attribute=noreturn
5188 @opindex Wno-suggest-attribute=noreturn
5190 Warn about functions that might be candidates for attributes
5191 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5192 functions visible in other compilation units or (in the case of @code{pure} and
5193 @code{const}) if it cannot prove that the function returns normally. A function
5194 returns normally if it doesn't contain an infinite loop or return abnormally
5195 by throwing, calling @code{abort} or trapping.  This analysis requires option
5196 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5197 higher.  Higher optimization levels improve the accuracy of the analysis.
5199 @item -Wsuggest-attribute=format
5200 @itemx -Wmissing-format-attribute
5201 @opindex Wsuggest-attribute=format
5202 @opindex Wmissing-format-attribute
5203 @opindex Wno-suggest-attribute=format
5204 @opindex Wno-missing-format-attribute
5205 @opindex Wformat
5206 @opindex Wno-format
5208 Warn about function pointers that might be candidates for @code{format}
5209 attributes.  Note these are only possible candidates, not absolute ones.
5210 GCC guesses that function pointers with @code{format} attributes that
5211 are used in assignment, initialization, parameter passing or return
5212 statements should have a corresponding @code{format} attribute in the
5213 resulting type.  I.e.@: the left-hand side of the assignment or
5214 initialization, the type of the parameter variable, or the return type
5215 of the containing function respectively should also have a @code{format}
5216 attribute to avoid the warning.
5218 GCC also warns about function definitions that might be
5219 candidates for @code{format} attributes.  Again, these are only
5220 possible candidates.  GCC guesses that @code{format} attributes
5221 might be appropriate for any function that calls a function like
5222 @code{vprintf} or @code{vscanf}, but this might not always be the
5223 case, and some functions for which @code{format} attributes are
5224 appropriate may not be detected.
5225 @end table
5227 @item -Wsuggest-final-types
5228 @opindex Wno-suggest-final-types
5229 @opindex Wsuggest-final-types
5230 Warn about types with virtual methods where code quality would be improved
5231 if the type were declared with the C++11 @code{final} specifier, 
5232 or, if possible,
5233 declared in an anonymous namespace. This allows GCC to more aggressively
5234 devirtualize the polymorphic calls. This warning is more effective with link
5235 time optimization, where the information about the class hierarchy graph is
5236 more complete.
5238 @item -Wsuggest-final-methods
5239 @opindex Wno-suggest-final-methods
5240 @opindex Wsuggest-final-methods
5241 Warn about virtual methods where code quality would be improved if the method
5242 were declared with the C++11 @code{final} specifier, 
5243 or, if possible, its type were
5244 declared in an anonymous namespace or with the @code{final} specifier.
5245 This warning is
5246 more effective with link-time optimization, where the information about the
5247 class hierarchy graph is more complete. It is recommended to first consider
5248 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5249 annotations.
5251 @item -Wsuggest-override
5252 Warn about overriding virtual functions that are not marked with the override
5253 keyword.
5255 @item -Walloc-zero
5256 @opindex Wno-alloc-zero
5257 @opindex Walloc-zero
5258 Warn about calls to allocation functions decorated with attribute
5259 @code{alloc_size} that specify zero bytes, including those to the built-in
5260 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5261 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5262 when called with a zero size differs among implementations (and in the case
5263 of @code{realloc} has been deprecated) relying on it may result in subtle
5264 portability bugs and should be avoided.
5266 @item -Walloc-size-larger-than=@var{n}
5267 Warn about calls to functions decorated with attribute @code{alloc_size}
5268 that attempt to allocate objects larger than the specified number of bytes,
5269 or where the result of the size computation in an integer type with infinite
5270 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5271 may end in one of the standard suffixes designating a multiple of bytes
5272 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5273 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5274 @xref{Function Attributes}.
5276 @item -Walloca
5277 @opindex Wno-alloca
5278 @opindex Walloca
5279 This option warns on all uses of @code{alloca} in the source.
5281 @item -Walloca-larger-than=@var{n}
5282 This option warns on calls to @code{alloca} that are not bounded by a
5283 controlling predicate limiting its argument of integer type to at most
5284 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5285 Arguments of non-integer types are considered unbounded even if they
5286 appear to be constrained to the expected range.
5288 For example, a bounded case of @code{alloca} could be:
5290 @smallexample
5291 void func (size_t n)
5293   void *p;
5294   if (n <= 1000)
5295     p = alloca (n);
5296   else
5297     p = malloc (n);
5298   f (p);
5300 @end smallexample
5302 In the above example, passing @code{-Walloca-larger-than=1000} would not
5303 issue a warning because the call to @code{alloca} is known to be at most
5304 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5305 the compiler would emit a warning.
5307 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5308 controlling predicate constraining its integer argument.  For example:
5310 @smallexample
5311 void func ()
5313   void *p = alloca (n);
5314   f (p);
5316 @end smallexample
5318 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5319 a warning, but this time because of the lack of bounds checking.
5321 Note, that even seemingly correct code involving signed integers could
5322 cause a warning:
5324 @smallexample
5325 void func (signed int n)
5327   if (n < 500)
5328     @{
5329       p = alloca (n);
5330       f (p);
5331     @}
5333 @end smallexample
5335 In the above example, @var{n} could be negative, causing a larger than
5336 expected argument to be implicitly cast into the @code{alloca} call.
5338 This option also warns when @code{alloca} is used in a loop.
5340 This warning is not enabled by @option{-Wall}, and is only active when
5341 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5343 See also @option{-Wvla-larger-than=@var{n}}.
5345 @item -Warray-bounds
5346 @itemx -Warray-bounds=@var{n}
5347 @opindex Wno-array-bounds
5348 @opindex Warray-bounds
5349 This option is only active when @option{-ftree-vrp} is active
5350 (default for @option{-O2} and above). It warns about subscripts to arrays
5351 that are always out of bounds. This warning is enabled by @option{-Wall}.
5353 @table @gcctabopt
5354 @item -Warray-bounds=1
5355 This is the warning level of @option{-Warray-bounds} and is enabled
5356 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5358 @item -Warray-bounds=2
5359 This warning level also warns about out of bounds access for
5360 arrays at the end of a struct and for arrays accessed through
5361 pointers. This warning level may give a larger number of
5362 false positives and is deactivated by default.
5363 @end table
5365 @item -Wbool-compare
5366 @opindex Wno-bool-compare
5367 @opindex Wbool-compare
5368 Warn about boolean expression compared with an integer value different from
5369 @code{true}/@code{false}.  For instance, the following comparison is
5370 always false:
5371 @smallexample
5372 int n = 5;
5373 @dots{}
5374 if ((n > 1) == 2) @{ @dots{} @}
5375 @end smallexample
5376 This warning is enabled by @option{-Wall}.
5378 @item -Wbool-operation
5379 @opindex Wno-bool-operation
5380 @opindex Wbool-operation
5381 Warn about suspicious operations on expressions of a boolean type.  For
5382 instance, bitwise negation of a boolean is very likely a bug in the program.
5383 For C, this warning also warns about incrementing or decrementing a boolean,
5384 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5385 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5387 This warning is enabled by @option{-Wall}.
5389 @item -Wduplicated-branches
5390 @opindex Wno-duplicated-branches
5391 @opindex Wduplicated-branches
5392 Warn when an if-else has identical branches.  This warning detects cases like
5393 @smallexample
5394 if (p != NULL)
5395   return 0;
5396 else
5397   return 0;
5398 @end smallexample
5399 It doesn't warn when both branches contain just a null statement.  This warning
5400 also warn for conditional operators:
5401 @smallexample
5402   int i = x ? *p : *p;
5403 @end smallexample
5405 @item -Wduplicated-cond
5406 @opindex Wno-duplicated-cond
5407 @opindex Wduplicated-cond
5408 Warn about duplicated conditions in an if-else-if chain.  For instance,
5409 warn for the following code:
5410 @smallexample
5411 if (p->q != NULL) @{ @dots{} @}
5412 else if (p->q != NULL) @{ @dots{} @}
5413 @end smallexample
5415 @item -Wframe-address
5416 @opindex Wno-frame-address
5417 @opindex Wframe-address
5418 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5419 is called with an argument greater than 0.  Such calls may return indeterminate
5420 values or crash the program.  The warning is included in @option{-Wall}.
5422 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5423 @opindex Wno-discarded-qualifiers
5424 @opindex Wdiscarded-qualifiers
5425 Do not warn if type qualifiers on pointers are being discarded.
5426 Typically, the compiler warns if a @code{const char *} variable is
5427 passed to a function that takes a @code{char *} parameter.  This option
5428 can be used to suppress such a warning.
5430 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5431 @opindex Wno-discarded-array-qualifiers
5432 @opindex Wdiscarded-array-qualifiers
5433 Do not warn if type qualifiers on arrays which are pointer targets
5434 are being discarded. Typically, the compiler warns if a
5435 @code{const int (*)[]} variable is passed to a function that
5436 takes a @code{int (*)[]} parameter.  This option can be used to
5437 suppress such a warning.
5439 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5440 @opindex Wno-incompatible-pointer-types
5441 @opindex Wincompatible-pointer-types
5442 Do not warn when there is a conversion between pointers that have incompatible
5443 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5444 which warns for pointer argument passing or assignment with different
5445 signedness.
5447 @item -Wno-int-conversion @r{(C and Objective-C only)}
5448 @opindex Wno-int-conversion
5449 @opindex Wint-conversion
5450 Do not warn about incompatible integer to pointer and pointer to integer
5451 conversions.  This warning is about implicit conversions; for explicit
5452 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5453 @option{-Wno-pointer-to-int-cast} may be used.
5455 @item -Wno-div-by-zero
5456 @opindex Wno-div-by-zero
5457 @opindex Wdiv-by-zero
5458 Do not warn about compile-time integer division by zero.  Floating-point
5459 division by zero is not warned about, as it can be a legitimate way of
5460 obtaining infinities and NaNs.
5462 @item -Wsystem-headers
5463 @opindex Wsystem-headers
5464 @opindex Wno-system-headers
5465 @cindex warnings from system headers
5466 @cindex system headers, warnings from
5467 Print warning messages for constructs found in system header files.
5468 Warnings from system headers are normally suppressed, on the assumption
5469 that they usually do not indicate real problems and would only make the
5470 compiler output harder to read.  Using this command-line option tells
5471 GCC to emit warnings from system headers as if they occurred in user
5472 code.  However, note that using @option{-Wall} in conjunction with this
5473 option does @emph{not} warn about unknown pragmas in system
5474 headers---for that, @option{-Wunknown-pragmas} must also be used.
5476 @item -Wtautological-compare
5477 @opindex Wtautological-compare
5478 @opindex Wno-tautological-compare
5479 Warn if a self-comparison always evaluates to true or false.  This
5480 warning detects various mistakes such as:
5481 @smallexample
5482 int i = 1;
5483 @dots{}
5484 if (i > i) @{ @dots{} @}
5485 @end smallexample
5486 This warning is enabled by @option{-Wall}.
5488 @item -Wtrampolines
5489 @opindex Wtrampolines
5490 @opindex Wno-trampolines
5491 Warn about trampolines generated for pointers to nested functions.
5492 A trampoline is a small piece of data or code that is created at run
5493 time on the stack when the address of a nested function is taken, and is
5494 used to call the nested function indirectly.  For some targets, it is
5495 made up of data only and thus requires no special treatment.  But, for
5496 most targets, it is made up of code and thus requires the stack to be
5497 made executable in order for the program to work properly.
5499 @item -Wfloat-equal
5500 @opindex Wfloat-equal
5501 @opindex Wno-float-equal
5502 Warn if floating-point values are used in equality comparisons.
5504 The idea behind this is that sometimes it is convenient (for the
5505 programmer) to consider floating-point values as approximations to
5506 infinitely precise real numbers.  If you are doing this, then you need
5507 to compute (by analyzing the code, or in some other way) the maximum or
5508 likely maximum error that the computation introduces, and allow for it
5509 when performing comparisons (and when producing output, but that's a
5510 different problem).  In particular, instead of testing for equality, you
5511 should check to see whether the two values have ranges that overlap; and
5512 this is done with the relational operators, so equality comparisons are
5513 probably mistaken.
5515 @item -Wtraditional @r{(C and Objective-C only)}
5516 @opindex Wtraditional
5517 @opindex Wno-traditional
5518 Warn about certain constructs that behave differently in traditional and
5519 ISO C@.  Also warn about ISO C constructs that have no traditional C
5520 equivalent, and/or problematic constructs that should be avoided.
5522 @itemize @bullet
5523 @item
5524 Macro parameters that appear within string literals in the macro body.
5525 In traditional C macro replacement takes place within string literals,
5526 but in ISO C it does not.
5528 @item
5529 In traditional C, some preprocessor directives did not exist.
5530 Traditional preprocessors only considered a line to be a directive
5531 if the @samp{#} appeared in column 1 on the line.  Therefore
5532 @option{-Wtraditional} warns about directives that traditional C
5533 understands but ignores because the @samp{#} does not appear as the
5534 first character on the line.  It also suggests you hide directives like
5535 @code{#pragma} not understood by traditional C by indenting them.  Some
5536 traditional implementations do not recognize @code{#elif}, so this option
5537 suggests avoiding it altogether.
5539 @item
5540 A function-like macro that appears without arguments.
5542 @item
5543 The unary plus operator.
5545 @item
5546 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5547 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5548 constants.)  Note, these suffixes appear in macros defined in the system
5549 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5550 Use of these macros in user code might normally lead to spurious
5551 warnings, however GCC's integrated preprocessor has enough context to
5552 avoid warning in these cases.
5554 @item
5555 A function declared external in one block and then used after the end of
5556 the block.
5558 @item
5559 A @code{switch} statement has an operand of type @code{long}.
5561 @item
5562 A non-@code{static} function declaration follows a @code{static} one.
5563 This construct is not accepted by some traditional C compilers.
5565 @item
5566 The ISO type of an integer constant has a different width or
5567 signedness from its traditional type.  This warning is only issued if
5568 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5569 typically represent bit patterns, are not warned about.
5571 @item
5572 Usage of ISO string concatenation is detected.
5574 @item
5575 Initialization of automatic aggregates.
5577 @item
5578 Identifier conflicts with labels.  Traditional C lacks a separate
5579 namespace for labels.
5581 @item
5582 Initialization of unions.  If the initializer is zero, the warning is
5583 omitted.  This is done under the assumption that the zero initializer in
5584 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5585 initializer warnings and relies on default initialization to zero in the
5586 traditional C case.
5588 @item
5589 Conversions by prototypes between fixed/floating-point values and vice
5590 versa.  The absence of these prototypes when compiling with traditional
5591 C causes serious problems.  This is a subset of the possible
5592 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5594 @item
5595 Use of ISO C style function definitions.  This warning intentionally is
5596 @emph{not} issued for prototype declarations or variadic functions
5597 because these ISO C features appear in your code when using
5598 libiberty's traditional C compatibility macros, @code{PARAMS} and
5599 @code{VPARAMS}.  This warning is also bypassed for nested functions
5600 because that feature is already a GCC extension and thus not relevant to
5601 traditional C compatibility.
5602 @end itemize
5604 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5605 @opindex Wtraditional-conversion
5606 @opindex Wno-traditional-conversion
5607 Warn if a prototype causes a type conversion that is different from what
5608 would happen to the same argument in the absence of a prototype.  This
5609 includes conversions of fixed point to floating and vice versa, and
5610 conversions changing the width or signedness of a fixed-point argument
5611 except when the same as the default promotion.
5613 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5614 @opindex Wdeclaration-after-statement
5615 @opindex Wno-declaration-after-statement
5616 Warn when a declaration is found after a statement in a block.  This
5617 construct, known from C++, was introduced with ISO C99 and is by default
5618 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5620 @item -Wshadow
5621 @opindex Wshadow
5622 @opindex Wno-shadow
5623 Warn whenever a local variable or type declaration shadows another
5624 variable, parameter, type, class member (in C++), or instance variable
5625 (in Objective-C) or whenever a built-in function is shadowed. Note
5626 that in C++, the compiler warns if a local variable shadows an
5627 explicit typedef, but not if it shadows a struct/class/enum.
5628 Same as @option{-Wshadow=global}.
5630 @item -Wno-shadow-ivar @r{(Objective-C only)}
5631 @opindex Wno-shadow-ivar
5632 @opindex Wshadow-ivar
5633 Do not warn whenever a local variable shadows an instance variable in an
5634 Objective-C method.
5636 @item -Wshadow=global
5637 @opindex Wshadow=local
5638 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5640 @item -Wshadow=local
5641 @opindex Wshadow=local
5642 Warn when a local variable shadows another local variable or parameter.
5643 This warning is enabled by @option{-Wshadow=global}.
5645 @item -Wshadow=compatible-local
5646 @opindex Wshadow=compatible-local
5647 Warn when a local variable shadows another local variable or parameter
5648 whose type is compatible with that of the shadowing variable. In C++,
5649 type compatibility here means the type of the shadowing variable can be
5650 converted to that of the shadowed variable. The creation of this flag
5651 (in addition to @option{-Wshadow=local}) is based on the idea that when
5652 a local variable shadows another one of incompatible type, it is most
5653 likely intentional, not a bug or typo, as shown in the following example:
5655 @smallexample
5656 @group
5657 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5659   for (int i = 0; i < N; ++i)
5660   @{
5661     ...
5662   @}
5663   ...
5665 @end group
5666 @end smallexample
5668 Since the two variable @code{i} in the example above have incompatible types,
5669 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5670 Because their types are incompatible, if a programmer accidentally uses one
5671 in place of the other, type checking will catch that and emit an error or
5672 warning. So not warning (about shadowing) in this case will not lead to
5673 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5674 possibly reduce the number of warnings triggered by intentional shadowing.
5676 This warning is enabled by @option{-Wshadow=local}.
5678 @item -Wlarger-than=@var{len}
5679 @opindex Wlarger-than=@var{len}
5680 @opindex Wlarger-than-@var{len}
5681 Warn whenever an object of larger than @var{len} bytes is defined.
5683 @item -Wframe-larger-than=@var{len}
5684 @opindex Wframe-larger-than
5685 Warn if the size of a function frame is larger than @var{len} bytes.
5686 The computation done to determine the stack frame size is approximate
5687 and not conservative.
5688 The actual requirements may be somewhat greater than @var{len}
5689 even if you do not get a warning.  In addition, any space allocated
5690 via @code{alloca}, variable-length arrays, or related constructs
5691 is not included by the compiler when determining
5692 whether or not to issue a warning.
5694 @item -Wno-free-nonheap-object
5695 @opindex Wno-free-nonheap-object
5696 @opindex Wfree-nonheap-object
5697 Do not warn when attempting to free an object that was not allocated
5698 on the heap.
5700 @item -Wstack-usage=@var{len}
5701 @opindex Wstack-usage
5702 Warn if the stack usage of a function might be larger than @var{len} bytes.
5703 The computation done to determine the stack usage is conservative.
5704 Any space allocated via @code{alloca}, variable-length arrays, or related
5705 constructs is included by the compiler when determining whether or not to
5706 issue a warning.
5708 The message is in keeping with the output of @option{-fstack-usage}.
5710 @itemize
5711 @item
5712 If the stack usage is fully static but exceeds the specified amount, it's:
5714 @smallexample
5715   warning: stack usage is 1120 bytes
5716 @end smallexample
5717 @item
5718 If the stack usage is (partly) dynamic but bounded, it's:
5720 @smallexample
5721   warning: stack usage might be 1648 bytes
5722 @end smallexample
5723 @item
5724 If the stack usage is (partly) dynamic and not bounded, it's:
5726 @smallexample
5727   warning: stack usage might be unbounded
5728 @end smallexample
5729 @end itemize
5731 @item -Wunsafe-loop-optimizations
5732 @opindex Wunsafe-loop-optimizations
5733 @opindex Wno-unsafe-loop-optimizations
5734 Warn if the loop cannot be optimized because the compiler cannot
5735 assume anything on the bounds of the loop indices.  With
5736 @option{-funsafe-loop-optimizations} warn if the compiler makes
5737 such assumptions.
5739 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5740 @opindex Wno-pedantic-ms-format
5741 @opindex Wpedantic-ms-format
5742 When used in combination with @option{-Wformat}
5743 and @option{-pedantic} without GNU extensions, this option
5744 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5745 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5746 which depend on the MS runtime.
5748 @item -Waligned-new
5749 @opindex Waligned-new
5750 @opindex Wno-aligned-new
5751 Warn about a new-expression of a type that requires greater alignment
5752 than the @code{alignof(std::max_align_t)} but uses an allocation
5753 function without an explicit alignment parameter. This option is
5754 enabled by @option{-Wall}.
5756 Normally this only warns about global allocation functions, but
5757 @option{-Waligned-new=all} also warns about class member allocation
5758 functions.
5760 @item -Wplacement-new
5761 @itemx -Wplacement-new=@var{n}
5762 @opindex Wplacement-new
5763 @opindex Wno-placement-new
5764 Warn about placement new expressions with undefined behavior, such as
5765 constructing an object in a buffer that is smaller than the type of
5766 the object.  For example, the placement new expression below is diagnosed
5767 because it attempts to construct an array of 64 integers in a buffer only
5768 64 bytes large.
5769 @smallexample
5770 char buf [64];
5771 new (buf) int[64];
5772 @end smallexample
5773 This warning is enabled by default.
5775 @table @gcctabopt
5776 @item -Wplacement-new=1
5777 This is the default warning level of @option{-Wplacement-new}.  At this
5778 level the warning is not issued for some strictly undefined constructs that
5779 GCC allows as extensions for compatibility with legacy code.  For example,
5780 the following @code{new} expression is not diagnosed at this level even
5781 though it has undefined behavior according to the C++ standard because
5782 it writes past the end of the one-element array.
5783 @smallexample
5784 struct S @{ int n, a[1]; @};
5785 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5786 new (s->a)int [32]();
5787 @end smallexample
5789 @item -Wplacement-new=2
5790 At this level, in addition to diagnosing all the same constructs as at level
5791 1, a diagnostic is also issued for placement new expressions that construct
5792 an object in the last member of structure whose type is an array of a single
5793 element and whose size is less than the size of the object being constructed.
5794 While the previous example would be diagnosed, the following construct makes
5795 use of the flexible member array extension to avoid the warning at level 2.
5796 @smallexample
5797 struct S @{ int n, a[]; @};
5798 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5799 new (s->a)int [32]();
5800 @end smallexample
5802 @end table
5804 @item -Wpointer-arith
5805 @opindex Wpointer-arith
5806 @opindex Wno-pointer-arith
5807 Warn about anything that depends on the ``size of'' a function type or
5808 of @code{void}.  GNU C assigns these types a size of 1, for
5809 convenience in calculations with @code{void *} pointers and pointers
5810 to functions.  In C++, warn also when an arithmetic operation involves
5811 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5813 @item -Wpointer-compare
5814 @opindex Wpointer-compare
5815 @opindex Wno-pointer-compare
5816 Warn if a pointer is compared with a zero character constant.  This usually
5817 means that the pointer was meant to be dereferenced.  For example:
5819 @smallexample
5820 const char *p = foo ();
5821 if (p == '\0')
5822   return 42;
5823 @end smallexample
5825 Note that the code above is invalid in C++11.
5827 This warning is enabled by default.
5829 @item -Wtype-limits
5830 @opindex Wtype-limits
5831 @opindex Wno-type-limits
5832 Warn if a comparison is always true or always false due to the limited
5833 range of the data type, but do not warn for constant expressions.  For
5834 example, warn if an unsigned variable is compared against zero with
5835 @code{<} or @code{>=}.  This warning is also enabled by
5836 @option{-Wextra}.
5838 @include cppwarnopts.texi
5840 @item -Wbad-function-cast @r{(C and Objective-C only)}
5841 @opindex Wbad-function-cast
5842 @opindex Wno-bad-function-cast
5843 Warn when a function call is cast to a non-matching type.
5844 For example, warn if a call to a function returning an integer type 
5845 is cast to a pointer type.
5847 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5848 @opindex Wc90-c99-compat
5849 @opindex Wno-c90-c99-compat
5850 Warn about features not present in ISO C90, but present in ISO C99.
5851 For instance, warn about use of variable length arrays, @code{long long}
5852 type, @code{bool} type, compound literals, designated initializers, and so
5853 on.  This option is independent of the standards mode.  Warnings are disabled
5854 in the expression that follows @code{__extension__}.
5856 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5857 @opindex Wc99-c11-compat
5858 @opindex Wno-c99-c11-compat
5859 Warn about features not present in ISO C99, but present in ISO C11.
5860 For instance, warn about use of anonymous structures and unions,
5861 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5862 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5863 and so on.  This option is independent of the standards mode.  Warnings are
5864 disabled in the expression that follows @code{__extension__}.
5866 @item -Wc++-compat @r{(C and Objective-C only)}
5867 @opindex Wc++-compat
5868 Warn about ISO C constructs that are outside of the common subset of
5869 ISO C and ISO C++, e.g.@: request for implicit conversion from
5870 @code{void *} to a pointer to non-@code{void} type.
5872 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5873 @opindex Wc++11-compat
5874 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5875 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5876 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5877 enabled by @option{-Wall}.
5879 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5880 @opindex Wc++14-compat
5881 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5882 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5884 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5885 @opindex Wc++1z-compat
5886 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5887 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5889 @item -Wcast-qual
5890 @opindex Wcast-qual
5891 @opindex Wno-cast-qual
5892 Warn whenever a pointer is cast so as to remove a type qualifier from
5893 the target type.  For example, warn if a @code{const char *} is cast
5894 to an ordinary @code{char *}.
5896 Also warn when making a cast that introduces a type qualifier in an
5897 unsafe way.  For example, casting @code{char **} to @code{const char **}
5898 is unsafe, as in this example:
5900 @smallexample
5901   /* p is char ** value.  */
5902   const char **q = (const char **) p;
5903   /* Assignment of readonly string to const char * is OK.  */
5904   *q = "string";
5905   /* Now char** pointer points to read-only memory.  */
5906   **p = 'b';
5907 @end smallexample
5909 @item -Wcast-align
5910 @opindex Wcast-align
5911 @opindex Wno-cast-align
5912 Warn whenever a pointer is cast such that the required alignment of the
5913 target is increased.  For example, warn if a @code{char *} is cast to
5914 an @code{int *} on machines where integers can only be accessed at
5915 two- or four-byte boundaries.
5917 @item -Wwrite-strings
5918 @opindex Wwrite-strings
5919 @opindex Wno-write-strings
5920 When compiling C, give string constants the type @code{const
5921 char[@var{length}]} so that copying the address of one into a
5922 non-@code{const} @code{char *} pointer produces a warning.  These
5923 warnings help you find at compile time code that can try to write
5924 into a string constant, but only if you have been very careful about
5925 using @code{const} in declarations and prototypes.  Otherwise, it is
5926 just a nuisance. This is why we did not make @option{-Wall} request
5927 these warnings.
5929 When compiling C++, warn about the deprecated conversion from string
5930 literals to @code{char *}.  This warning is enabled by default for C++
5931 programs.
5933 @item -Wcatch-value
5934 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5935 @opindex Wcatch-value
5936 @opindex Wno-catch-value
5937 Warn about catch handlers that do not catch via reference.
5938 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5939 warn about polymorphic class types that are caught by value.
5940 With @option{-Wcatch-value=2} warn about all class types that are caught
5941 by value. With @option{-Wcatch-value=3} warn about all types that are
5942 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5944 @item -Wclobbered
5945 @opindex Wclobbered
5946 @opindex Wno-clobbered
5947 Warn for variables that might be changed by @code{longjmp} or
5948 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5950 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5951 @opindex Wconditionally-supported
5952 @opindex Wno-conditionally-supported
5953 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5955 @item -Wconversion
5956 @opindex Wconversion
5957 @opindex Wno-conversion
5958 Warn for implicit conversions that may alter a value. This includes
5959 conversions between real and integer, like @code{abs (x)} when
5960 @code{x} is @code{double}; conversions between signed and unsigned,
5961 like @code{unsigned ui = -1}; and conversions to smaller types, like
5962 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5963 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5964 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5965 conversions between signed and unsigned integers can be disabled by
5966 using @option{-Wno-sign-conversion}.
5968 For C++, also warn for confusing overload resolution for user-defined
5969 conversions; and conversions that never use a type conversion
5970 operator: conversions to @code{void}, the same type, a base class or a
5971 reference to them. Warnings about conversions between signed and
5972 unsigned integers are disabled by default in C++ unless
5973 @option{-Wsign-conversion} is explicitly enabled.
5975 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5976 @opindex Wconversion-null
5977 @opindex Wno-conversion-null
5978 Do not warn for conversions between @code{NULL} and non-pointer
5979 types. @option{-Wconversion-null} is enabled by default.
5981 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5982 @opindex Wzero-as-null-pointer-constant
5983 @opindex Wno-zero-as-null-pointer-constant
5984 Warn when a literal @samp{0} is used as null pointer constant.  This can
5985 be useful to facilitate the conversion to @code{nullptr} in C++11.
5987 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5988 @opindex Wsubobject-linkage
5989 @opindex Wno-subobject-linkage
5990 Warn if a class type has a base or a field whose type uses the anonymous
5991 namespace or depends on a type with no linkage.  If a type A depends on
5992 a type B with no or internal linkage, defining it in multiple
5993 translation units would be an ODR violation because the meaning of B
5994 is different in each translation unit.  If A only appears in a single
5995 translation unit, the best way to silence the warning is to give it
5996 internal linkage by putting it in an anonymous namespace as well.  The
5997 compiler doesn't give this warning for types defined in the main .C
5998 file, as those are unlikely to have multiple definitions.
5999 @option{-Wsubobject-linkage} is enabled by default.
6001 @item -Wdangling-else
6002 @opindex Wdangling-else
6003 @opindex Wno-dangling-else
6004 Warn about constructions where there may be confusion to which
6005 @code{if} statement an @code{else} branch belongs.  Here is an example of
6006 such a case:
6008 @smallexample
6009 @group
6011   if (a)
6012     if (b)
6013       foo ();
6014   else
6015     bar ();
6017 @end group
6018 @end smallexample
6020 In C/C++, every @code{else} branch belongs to the innermost possible
6021 @code{if} statement, which in this example is @code{if (b)}.  This is
6022 often not what the programmer expected, as illustrated in the above
6023 example by indentation the programmer chose.  When there is the
6024 potential for this confusion, GCC issues a warning when this flag
6025 is specified.  To eliminate the warning, add explicit braces around
6026 the innermost @code{if} statement so there is no way the @code{else}
6027 can belong to the enclosing @code{if}.  The resulting code
6028 looks like this:
6030 @smallexample
6031 @group
6033   if (a)
6034     @{
6035       if (b)
6036         foo ();
6037       else
6038         bar ();
6039     @}
6041 @end group
6042 @end smallexample
6044 This warning is enabled by @option{-Wparentheses}.
6046 @item -Wdate-time
6047 @opindex Wdate-time
6048 @opindex Wno-date-time
6049 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6050 are encountered as they might prevent bit-wise-identical reproducible
6051 compilations.
6053 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6054 @opindex Wdelete-incomplete
6055 @opindex Wno-delete-incomplete
6056 Warn when deleting a pointer to incomplete type, which may cause
6057 undefined behavior at runtime.  This warning is enabled by default.
6059 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6060 @opindex Wuseless-cast
6061 @opindex Wno-useless-cast
6062 Warn when an expression is casted to its own type.
6064 @item -Wempty-body
6065 @opindex Wempty-body
6066 @opindex Wno-empty-body
6067 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6068 while} statement.  This warning is also enabled by @option{-Wextra}.
6070 @item -Wenum-compare
6071 @opindex Wenum-compare
6072 @opindex Wno-enum-compare
6073 Warn about a comparison between values of different enumerated types.
6074 In C++ enumerated type mismatches in conditional expressions are also
6075 diagnosed and the warning is enabled by default.  In C this warning is 
6076 enabled by @option{-Wall}.
6078 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6079 @opindex Wextra-semi
6080 @opindex Wno-extra-semi
6081 Warn about redundant semicolon after in-class function definition.
6083 @item -Wjump-misses-init @r{(C, Objective-C only)}
6084 @opindex Wjump-misses-init
6085 @opindex Wno-jump-misses-init
6086 Warn if a @code{goto} statement or a @code{switch} statement jumps
6087 forward across the initialization of a variable, or jumps backward to a
6088 label after the variable has been initialized.  This only warns about
6089 variables that are initialized when they are declared.  This warning is
6090 only supported for C and Objective-C; in C++ this sort of branch is an
6091 error in any case.
6093 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6094 can be disabled with the @option{-Wno-jump-misses-init} option.
6096 @item -Wsign-compare
6097 @opindex Wsign-compare
6098 @opindex Wno-sign-compare
6099 @cindex warning for comparison of signed and unsigned values
6100 @cindex comparison of signed and unsigned values, warning
6101 @cindex signed and unsigned values, comparison warning
6102 Warn when a comparison between signed and unsigned values could produce
6103 an incorrect result when the signed value is converted to unsigned.
6104 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6105 also enabled by @option{-Wextra}.
6107 @item -Wsign-conversion
6108 @opindex Wsign-conversion
6109 @opindex Wno-sign-conversion
6110 Warn for implicit conversions that may change the sign of an integer
6111 value, like assigning a signed integer expression to an unsigned
6112 integer variable. An explicit cast silences the warning. In C, this
6113 option is enabled also by @option{-Wconversion}.
6115 @item -Wfloat-conversion
6116 @opindex Wfloat-conversion
6117 @opindex Wno-float-conversion
6118 Warn for implicit conversions that reduce the precision of a real value.
6119 This includes conversions from real to integer, and from higher precision
6120 real to lower precision real values.  This option is also enabled by
6121 @option{-Wconversion}.
6123 @item -Wno-scalar-storage-order
6124 @opindex -Wno-scalar-storage-order
6125 @opindex -Wscalar-storage-order
6126 Do not warn on suspicious constructs involving reverse scalar storage order.
6128 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6129 @opindex Wsized-deallocation
6130 @opindex Wno-sized-deallocation
6131 Warn about a definition of an unsized deallocation function
6132 @smallexample
6133 void operator delete (void *) noexcept;
6134 void operator delete[] (void *) noexcept;
6135 @end smallexample
6136 without a definition of the corresponding sized deallocation function
6137 @smallexample
6138 void operator delete (void *, std::size_t) noexcept;
6139 void operator delete[] (void *, std::size_t) noexcept;
6140 @end smallexample
6141 or vice versa.  Enabled by @option{-Wextra} along with
6142 @option{-fsized-deallocation}.
6144 @item -Wsizeof-pointer-div
6145 @opindex Wsizeof-pointer-div
6146 @opindex Wno-sizeof-pointer-div
6147 Warn for suspicious divisions of two sizeof expressions that divide
6148 the pointer size by the element size, which is the usual way to compute
6149 the array size but won't work out correctly with pointers.  This warning
6150 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6151 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6153 @item -Wsizeof-pointer-memaccess
6154 @opindex Wsizeof-pointer-memaccess
6155 @opindex Wno-sizeof-pointer-memaccess
6156 Warn for suspicious length parameters to certain string and memory built-in
6157 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6158 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6159 but a pointer, and suggests a possible fix, or about
6160 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6161 @option{-Wall}.
6163 @item -Wsizeof-array-argument
6164 @opindex Wsizeof-array-argument
6165 @opindex Wno-sizeof-array-argument
6166 Warn when the @code{sizeof} operator is applied to a parameter that is
6167 declared as an array in a function definition.  This warning is enabled by
6168 default for C and C++ programs.
6170 @item -Wmemset-elt-size
6171 @opindex Wmemset-elt-size
6172 @opindex Wno-memset-elt-size
6173 Warn for suspicious calls to the @code{memset} built-in function, if the
6174 first argument references an array, and the third argument is a number
6175 equal to the number of elements, but not equal to the size of the array
6176 in memory.  This indicates that the user has omitted a multiplication by
6177 the element size.  This warning is enabled by @option{-Wall}.
6179 @item -Wmemset-transposed-args
6180 @opindex Wmemset-transposed-args
6181 @opindex Wno-memset-transposed-args
6182 Warn for suspicious calls to the @code{memset} built-in function, if the
6183 second argument is not zero and the third argument is zero.  This warns e.g.@
6184 about @code{memset (buf, sizeof buf, 0)} where most probably
6185 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6186 is only emitted if the third argument is literal zero.  If it is some
6187 expression that is folded to zero, a cast of zero to some type, etc., 
6188 it is far less likely that the user has mistakenly exchanged the arguments 
6189 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6191 @item -Waddress
6192 @opindex Waddress
6193 @opindex Wno-address
6194 Warn about suspicious uses of memory addresses. These include using
6195 the address of a function in a conditional expression, such as
6196 @code{void func(void); if (func)}, and comparisons against the memory
6197 address of a string literal, such as @code{if (x == "abc")}.  Such
6198 uses typically indicate a programmer error: the address of a function
6199 always evaluates to true, so their use in a conditional usually
6200 indicate that the programmer forgot the parentheses in a function
6201 call; and comparisons against string literals result in unspecified
6202 behavior and are not portable in C, so they usually indicate that the
6203 programmer intended to use @code{strcmp}.  This warning is enabled by
6204 @option{-Wall}.
6206 @item -Wlogical-op
6207 @opindex Wlogical-op
6208 @opindex Wno-logical-op
6209 Warn about suspicious uses of logical operators in expressions.
6210 This includes using logical operators in contexts where a
6211 bit-wise operator is likely to be expected.  Also warns when
6212 the operands of a logical operator are the same:
6213 @smallexample
6214 extern int a;
6215 if (a < 0 && a < 0) @{ @dots{} @}
6216 @end smallexample
6218 @item -Wlogical-not-parentheses
6219 @opindex Wlogical-not-parentheses
6220 @opindex Wno-logical-not-parentheses
6221 Warn about logical not used on the left hand side operand of a comparison.
6222 This option does not warn if the right operand is considered to be a boolean
6223 expression.  Its purpose is to detect suspicious code like the following:
6224 @smallexample
6225 int a;
6226 @dots{}
6227 if (!a > 1) @{ @dots{} @}
6228 @end smallexample
6230 It is possible to suppress the warning by wrapping the LHS into
6231 parentheses:
6232 @smallexample
6233 if ((!a) > 1) @{ @dots{} @}
6234 @end smallexample
6236 This warning is enabled by @option{-Wall}.
6238 @item -Waggregate-return
6239 @opindex Waggregate-return
6240 @opindex Wno-aggregate-return
6241 Warn if any functions that return structures or unions are defined or
6242 called.  (In languages where you can return an array, this also elicits
6243 a warning.)
6245 @item -Wno-aggressive-loop-optimizations
6246 @opindex Wno-aggressive-loop-optimizations
6247 @opindex Waggressive-loop-optimizations
6248 Warn if in a loop with constant number of iterations the compiler detects
6249 undefined behavior in some statement during one or more of the iterations.
6251 @item -Wno-attributes
6252 @opindex Wno-attributes
6253 @opindex Wattributes
6254 Do not warn if an unexpected @code{__attribute__} is used, such as
6255 unrecognized attributes, function attributes applied to variables,
6256 etc.  This does not stop errors for incorrect use of supported
6257 attributes.
6259 @item -Wno-builtin-declaration-mismatch
6260 @opindex Wno-builtin-declaration-mismatch
6261 @opindex Wbuiltin-declaration-mismatch
6262 Warn if a built-in function is declared with the wrong signature.
6263 This warning is enabled by default.
6265 @item -Wno-builtin-macro-redefined
6266 @opindex Wno-builtin-macro-redefined
6267 @opindex Wbuiltin-macro-redefined
6268 Do not warn if certain built-in macros are redefined.  This suppresses
6269 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6270 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6272 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6273 @opindex Wstrict-prototypes
6274 @opindex Wno-strict-prototypes
6275 Warn if a function is declared or defined without specifying the
6276 argument types.  (An old-style function definition is permitted without
6277 a warning if preceded by a declaration that specifies the argument
6278 types.)
6280 @item -Wold-style-declaration @r{(C and Objective-C only)}
6281 @opindex Wold-style-declaration
6282 @opindex Wno-old-style-declaration
6283 Warn for obsolescent usages, according to the C Standard, in a
6284 declaration. For example, warn if storage-class specifiers like
6285 @code{static} are not the first things in a declaration.  This warning
6286 is also enabled by @option{-Wextra}.
6288 @item -Wold-style-definition @r{(C and Objective-C only)}
6289 @opindex Wold-style-definition
6290 @opindex Wno-old-style-definition
6291 Warn if an old-style function definition is used.  A warning is given
6292 even if there is a previous prototype.
6294 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6295 @opindex Wmissing-parameter-type
6296 @opindex Wno-missing-parameter-type
6297 A function parameter is declared without a type specifier in K&R-style
6298 functions:
6300 @smallexample
6301 void foo(bar) @{ @}
6302 @end smallexample
6304 This warning is also enabled by @option{-Wextra}.
6306 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6307 @opindex Wmissing-prototypes
6308 @opindex Wno-missing-prototypes
6309 Warn if a global function is defined without a previous prototype
6310 declaration.  This warning is issued even if the definition itself
6311 provides a prototype.  Use this option to detect global functions
6312 that do not have a matching prototype declaration in a header file.
6313 This option is not valid for C++ because all function declarations
6314 provide prototypes and a non-matching declaration declares an
6315 overload rather than conflict with an earlier declaration.
6316 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6318 @item -Wmissing-declarations
6319 @opindex Wmissing-declarations
6320 @opindex Wno-missing-declarations
6321 Warn if a global function is defined without a previous declaration.
6322 Do so even if the definition itself provides a prototype.
6323 Use this option to detect global functions that are not declared in
6324 header files.  In C, no warnings are issued for functions with previous
6325 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6326 missing prototypes.  In C++, no warnings are issued for function templates,
6327 or for inline functions, or for functions in anonymous namespaces.
6329 @item -Wmissing-field-initializers
6330 @opindex Wmissing-field-initializers
6331 @opindex Wno-missing-field-initializers
6332 @opindex W
6333 @opindex Wextra
6334 @opindex Wno-extra
6335 Warn if a structure's initializer has some fields missing.  For
6336 example, the following code causes such a warning, because
6337 @code{x.h} is implicitly zero:
6339 @smallexample
6340 struct s @{ int f, g, h; @};
6341 struct s x = @{ 3, 4 @};
6342 @end smallexample
6344 This option does not warn about designated initializers, so the following
6345 modification does not trigger a warning:
6347 @smallexample
6348 struct s @{ int f, g, h; @};
6349 struct s x = @{ .f = 3, .g = 4 @};
6350 @end smallexample
6352 In C this option does not warn about the universal zero initializer
6353 @samp{@{ 0 @}}:
6355 @smallexample
6356 struct s @{ int f, g, h; @};
6357 struct s x = @{ 0 @};
6358 @end smallexample
6360 Likewise, in C++ this option does not warn about the empty @{ @}
6361 initializer, for example:
6363 @smallexample
6364 struct s @{ int f, g, h; @};
6365 s x = @{ @};
6366 @end smallexample
6368 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6369 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6371 @item -Wno-multichar
6372 @opindex Wno-multichar
6373 @opindex Wmultichar
6374 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6375 Usually they indicate a typo in the user's code, as they have
6376 implementation-defined values, and should not be used in portable code.
6378 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6379 @opindex Wnormalized=
6380 @opindex Wnormalized
6381 @opindex Wno-normalized
6382 @cindex NFC
6383 @cindex NFKC
6384 @cindex character set, input normalization
6385 In ISO C and ISO C++, two identifiers are different if they are
6386 different sequences of characters.  However, sometimes when characters
6387 outside the basic ASCII character set are used, you can have two
6388 different character sequences that look the same.  To avoid confusion,
6389 the ISO 10646 standard sets out some @dfn{normalization rules} which
6390 when applied ensure that two sequences that look the same are turned into
6391 the same sequence.  GCC can warn you if you are using identifiers that
6392 have not been normalized; this option controls that warning.
6394 There are four levels of warning supported by GCC@.  The default is
6395 @option{-Wnormalized=nfc}, which warns about any identifier that is
6396 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6397 recommended form for most uses.  It is equivalent to
6398 @option{-Wnormalized}.
6400 Unfortunately, there are some characters allowed in identifiers by
6401 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6402 identifiers.  That is, there's no way to use these symbols in portable
6403 ISO C or C++ and have all your identifiers in NFC@.
6404 @option{-Wnormalized=id} suppresses the warning for these characters.
6405 It is hoped that future versions of the standards involved will correct
6406 this, which is why this option is not the default.
6408 You can switch the warning off for all characters by writing
6409 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6410 only do this if you are using some other normalization scheme (like
6411 ``D''), because otherwise you can easily create bugs that are
6412 literally impossible to see.
6414 Some characters in ISO 10646 have distinct meanings but look identical
6415 in some fonts or display methodologies, especially once formatting has
6416 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6417 LETTER N'', displays just like a regular @code{n} that has been
6418 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6419 normalization scheme to convert all these into a standard form as
6420 well, and GCC warns if your code is not in NFKC if you use
6421 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6422 about every identifier that contains the letter O because it might be
6423 confused with the digit 0, and so is not the default, but may be
6424 useful as a local coding convention if the programming environment 
6425 cannot be fixed to display these characters distinctly.
6427 @item -Wno-deprecated
6428 @opindex Wno-deprecated
6429 @opindex Wdeprecated
6430 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6432 @item -Wno-deprecated-declarations
6433 @opindex Wno-deprecated-declarations
6434 @opindex Wdeprecated-declarations
6435 Do not warn about uses of functions (@pxref{Function Attributes}),
6436 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6437 Attributes}) marked as deprecated by using the @code{deprecated}
6438 attribute.
6440 @item -Wno-overflow
6441 @opindex Wno-overflow
6442 @opindex Woverflow
6443 Do not warn about compile-time overflow in constant expressions.
6445 @item -Wno-odr
6446 @opindex Wno-odr
6447 @opindex Wodr
6448 Warn about One Definition Rule violations during link-time optimization.
6449 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6451 @item -Wopenmp-simd
6452 @opindex Wopenm-simd
6453 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6454 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6455 option can be used to relax the cost model.
6457 @item -Woverride-init @r{(C and Objective-C only)}
6458 @opindex Woverride-init
6459 @opindex Wno-override-init
6460 @opindex W
6461 @opindex Wextra
6462 @opindex Wno-extra
6463 Warn if an initialized field without side effects is overridden when
6464 using designated initializers (@pxref{Designated Inits, , Designated
6465 Initializers}).
6467 This warning is included in @option{-Wextra}.  To get other
6468 @option{-Wextra} warnings without this one, use @option{-Wextra
6469 -Wno-override-init}.
6471 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6472 @opindex Woverride-init-side-effects
6473 @opindex Wno-override-init-side-effects
6474 Warn if an initialized field with side effects is overridden when
6475 using designated initializers (@pxref{Designated Inits, , Designated
6476 Initializers}).  This warning is enabled by default.
6478 @item -Wpacked
6479 @opindex Wpacked
6480 @opindex Wno-packed
6481 Warn if a structure is given the packed attribute, but the packed
6482 attribute has no effect on the layout or size of the structure.
6483 Such structures may be mis-aligned for little benefit.  For
6484 instance, in this code, the variable @code{f.x} in @code{struct bar}
6485 is misaligned even though @code{struct bar} does not itself
6486 have the packed attribute:
6488 @smallexample
6489 @group
6490 struct foo @{
6491   int x;
6492   char a, b, c, d;
6493 @} __attribute__((packed));
6494 struct bar @{
6495   char z;
6496   struct foo f;
6498 @end group
6499 @end smallexample
6501 @item -Wpacked-bitfield-compat
6502 @opindex Wpacked-bitfield-compat
6503 @opindex Wno-packed-bitfield-compat
6504 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6505 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6506 the change can lead to differences in the structure layout.  GCC
6507 informs you when the offset of such a field has changed in GCC 4.4.
6508 For example there is no longer a 4-bit padding between field @code{a}
6509 and @code{b} in this structure:
6511 @smallexample
6512 struct foo
6514   char a:4;
6515   char b:8;
6516 @} __attribute__ ((packed));
6517 @end smallexample
6519 This warning is enabled by default.  Use
6520 @option{-Wno-packed-bitfield-compat} to disable this warning.
6522 @item -Wpadded
6523 @opindex Wpadded
6524 @opindex Wno-padded
6525 Warn if padding is included in a structure, either to align an element
6526 of the structure or to align the whole structure.  Sometimes when this
6527 happens it is possible to rearrange the fields of the structure to
6528 reduce the padding and so make the structure smaller.
6530 @item -Wredundant-decls
6531 @opindex Wredundant-decls
6532 @opindex Wno-redundant-decls
6533 Warn if anything is declared more than once in the same scope, even in
6534 cases where multiple declaration is valid and changes nothing.
6536 @item -Wrestrict
6537 @opindex Wrestrict
6538 @opindex Wno-restrict
6539 Warn when an argument passed to a restrict-qualified parameter
6540 aliases with another argument.
6542 @item -Wnested-externs @r{(C and Objective-C only)}
6543 @opindex Wnested-externs
6544 @opindex Wno-nested-externs
6545 Warn if an @code{extern} declaration is encountered within a function.
6547 @item -Wno-inherited-variadic-ctor
6548 @opindex Winherited-variadic-ctor
6549 @opindex Wno-inherited-variadic-ctor
6550 Suppress warnings about use of C++11 inheriting constructors when the
6551 base class inherited from has a C variadic constructor; the warning is
6552 on by default because the ellipsis is not inherited.
6554 @item -Winline
6555 @opindex Winline
6556 @opindex Wno-inline
6557 Warn if a function that is declared as inline cannot be inlined.
6558 Even with this option, the compiler does not warn about failures to
6559 inline functions declared in system headers.
6561 The compiler uses a variety of heuristics to determine whether or not
6562 to inline a function.  For example, the compiler takes into account
6563 the size of the function being inlined and the amount of inlining
6564 that has already been done in the current function.  Therefore,
6565 seemingly insignificant changes in the source program can cause the
6566 warnings produced by @option{-Winline} to appear or disappear.
6568 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6569 @opindex Wno-invalid-offsetof
6570 @opindex Winvalid-offsetof
6571 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6572 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6573 to a non-standard-layout type is undefined.  In existing C++ implementations,
6574 however, @code{offsetof} typically gives meaningful results.
6575 This flag is for users who are aware that they are
6576 writing nonportable code and who have deliberately chosen to ignore the
6577 warning about it.
6579 The restrictions on @code{offsetof} may be relaxed in a future version
6580 of the C++ standard.
6582 @item -Wint-in-bool-context
6583 @opindex Wint-in-bool-context
6584 @opindex Wno-int-in-bool-context
6585 Warn for suspicious use of integer values where boolean values are expected,
6586 such as conditional expressions (?:) using non-boolean integer constants in
6587 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6588 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6589 for all kinds of multiplications regardless of the data type.
6590 This warning is enabled by @option{-Wall}.
6592 @item -Wno-int-to-pointer-cast
6593 @opindex Wno-int-to-pointer-cast
6594 @opindex Wint-to-pointer-cast
6595 Suppress warnings from casts to pointer type of an integer of a
6596 different size. In C++, casting to a pointer type of smaller size is
6597 an error. @option{Wint-to-pointer-cast} is enabled by default.
6600 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6601 @opindex Wno-pointer-to-int-cast
6602 @opindex Wpointer-to-int-cast
6603 Suppress warnings from casts from a pointer to an integer type of a
6604 different size.
6606 @item -Winvalid-pch
6607 @opindex Winvalid-pch
6608 @opindex Wno-invalid-pch
6609 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6610 the search path but cannot be used.
6612 @item -Wlong-long
6613 @opindex Wlong-long
6614 @opindex Wno-long-long
6615 Warn if @code{long long} type is used.  This is enabled by either
6616 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6617 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6619 @item -Wvariadic-macros
6620 @opindex Wvariadic-macros
6621 @opindex Wno-variadic-macros
6622 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6623 alternate syntax is used in ISO C99 mode.  This is enabled by either
6624 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6625 messages, use @option{-Wno-variadic-macros}.
6627 @item -Wvarargs
6628 @opindex Wvarargs
6629 @opindex Wno-varargs
6630 Warn upon questionable usage of the macros used to handle variable
6631 arguments like @code{va_start}.  This is default.  To inhibit the
6632 warning messages, use @option{-Wno-varargs}.
6634 @item -Wvector-operation-performance
6635 @opindex Wvector-operation-performance
6636 @opindex Wno-vector-operation-performance
6637 Warn if vector operation is not implemented via SIMD capabilities of the
6638 architecture.  Mainly useful for the performance tuning.
6639 Vector operation can be implemented @code{piecewise}, which means that the
6640 scalar operation is performed on every vector element; 
6641 @code{in parallel}, which means that the vector operation is implemented
6642 using scalars of wider type, which normally is more performance efficient;
6643 and @code{as a single scalar}, which means that vector fits into a
6644 scalar type.
6646 @item -Wno-virtual-move-assign
6647 @opindex Wvirtual-move-assign
6648 @opindex Wno-virtual-move-assign
6649 Suppress warnings about inheriting from a virtual base with a
6650 non-trivial C++11 move assignment operator.  This is dangerous because
6651 if the virtual base is reachable along more than one path, it is
6652 moved multiple times, which can mean both objects end up in the
6653 moved-from state.  If the move assignment operator is written to avoid
6654 moving from a moved-from object, this warning can be disabled.
6656 @item -Wvla
6657 @opindex Wvla
6658 @opindex Wno-vla
6659 Warn if a variable-length array is used in the code.
6660 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6661 the variable-length array.
6663 @item -Wvla-larger-than=@var{n}
6664 If this option is used, the compiler will warn on uses of
6665 variable-length arrays where the size is either unbounded, or bounded
6666 by an argument that can be larger than @var{n} bytes.  This is similar
6667 to how @option{-Walloca-larger-than=@var{n}} works, but with
6668 variable-length arrays.
6670 Note that GCC may optimize small variable-length arrays of a known
6671 value into plain arrays, so this warning may not get triggered for
6672 such arrays.
6674 This warning is not enabled by @option{-Wall}, and is only active when
6675 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6677 See also @option{-Walloca-larger-than=@var{n}}.
6679 @item -Wvolatile-register-var
6680 @opindex Wvolatile-register-var
6681 @opindex Wno-volatile-register-var
6682 Warn if a register variable is declared volatile.  The volatile
6683 modifier does not inhibit all optimizations that may eliminate reads
6684 and/or writes to register variables.  This warning is enabled by
6685 @option{-Wall}.
6687 @item -Wdisabled-optimization
6688 @opindex Wdisabled-optimization
6689 @opindex Wno-disabled-optimization
6690 Warn if a requested optimization pass is disabled.  This warning does
6691 not generally indicate that there is anything wrong with your code; it
6692 merely indicates that GCC's optimizers are unable to handle the code
6693 effectively.  Often, the problem is that your code is too big or too
6694 complex; GCC refuses to optimize programs when the optimization
6695 itself is likely to take inordinate amounts of time.
6697 @item -Wpointer-sign @r{(C and Objective-C only)}
6698 @opindex Wpointer-sign
6699 @opindex Wno-pointer-sign
6700 Warn for pointer argument passing or assignment with different signedness.
6701 This option is only supported for C and Objective-C@.  It is implied by
6702 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6703 @option{-Wno-pointer-sign}.
6705 @item -Wstack-protector
6706 @opindex Wstack-protector
6707 @opindex Wno-stack-protector
6708 This option is only active when @option{-fstack-protector} is active.  It
6709 warns about functions that are not protected against stack smashing.
6711 @item -Woverlength-strings
6712 @opindex Woverlength-strings
6713 @opindex Wno-overlength-strings
6714 Warn about string constants that are longer than the ``minimum
6715 maximum'' length specified in the C standard.  Modern compilers
6716 generally allow string constants that are much longer than the
6717 standard's minimum limit, but very portable programs should avoid
6718 using longer strings.
6720 The limit applies @emph{after} string constant concatenation, and does
6721 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6722 C99, it was raised to 4095.  C++98 does not specify a normative
6723 minimum maximum, so we do not diagnose overlength strings in C++@.
6725 This option is implied by @option{-Wpedantic}, and can be disabled with
6726 @option{-Wno-overlength-strings}.
6728 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6729 @opindex Wunsuffixed-float-constants
6731 Issue a warning for any floating constant that does not have
6732 a suffix.  When used together with @option{-Wsystem-headers} it
6733 warns about such constants in system header files.  This can be useful
6734 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6735 from the decimal floating-point extension to C99.
6737 @item -Wno-designated-init @r{(C and Objective-C only)}
6738 Suppress warnings when a positional initializer is used to initialize
6739 a structure that has been marked with the @code{designated_init}
6740 attribute.
6742 @item -Whsa
6743 Issue a warning when HSAIL cannot be emitted for the compiled function or
6744 OpenMP construct.
6746 @end table
6748 @node Debugging Options
6749 @section Options for Debugging Your Program
6750 @cindex options, debugging
6751 @cindex debugging information options
6753 To tell GCC to emit extra information for use by a debugger, in almost 
6754 all cases you need only to add @option{-g} to your other options.
6756 GCC allows you to use @option{-g} with
6757 @option{-O}.  The shortcuts taken by optimized code may occasionally
6758 be surprising: some variables you declared may not exist
6759 at all; flow of control may briefly move where you did not expect it;
6760 some statements may not be executed because they compute constant
6761 results or their values are already at hand; some statements may
6762 execute in different places because they have been moved out of loops.
6763 Nevertheless it is possible to debug optimized output.  This makes
6764 it reasonable to use the optimizer for programs that might have bugs.
6766 If you are not using some other optimization option, consider
6767 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6768 With no @option{-O} option at all, some compiler passes that collect
6769 information useful for debugging do not run at all, so that
6770 @option{-Og} may result in a better debugging experience.
6772 @table @gcctabopt
6773 @item -g
6774 @opindex g
6775 Produce debugging information in the operating system's native format
6776 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6777 information.
6779 On most systems that use stabs format, @option{-g} enables use of extra
6780 debugging information that only GDB can use; this extra information
6781 makes debugging work better in GDB but probably makes other debuggers
6782 crash or
6783 refuse to read the program.  If you want to control for certain whether
6784 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6785 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6787 @item -ggdb
6788 @opindex ggdb
6789 Produce debugging information for use by GDB@.  This means to use the
6790 most expressive format available (DWARF, stabs, or the native format
6791 if neither of those are supported), including GDB extensions if at all
6792 possible.
6794 @item -gdwarf
6795 @itemx -gdwarf-@var{version}
6796 @opindex gdwarf
6797 Produce debugging information in DWARF format (if that is supported).
6798 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6799 for most targets is 4.  DWARF Version 5 is only experimental.
6801 Note that with DWARF Version 2, some ports require and always
6802 use some non-conflicting DWARF 3 extensions in the unwind tables.
6804 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6805 for maximum benefit.
6807 GCC no longer supports DWARF Version 1, which is substantially
6808 different than Version 2 and later.  For historical reasons, some
6809 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6810 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6811 in their names, but apply to all currently-supported versions of DWARF.
6813 @item -gstabs
6814 @opindex gstabs
6815 Produce debugging information in stabs format (if that is supported),
6816 without GDB extensions.  This is the format used by DBX on most BSD
6817 systems.  On MIPS, Alpha and System V Release 4 systems this option
6818 produces stabs debugging output that is not understood by DBX or SDB@.
6819 On System V Release 4 systems this option requires the GNU assembler.
6821 @item -gstabs+
6822 @opindex gstabs+
6823 Produce debugging information in stabs format (if that is supported),
6824 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6825 use of these extensions is likely to make other debuggers crash or
6826 refuse to read the program.
6828 @item -gcoff
6829 @opindex gcoff
6830 Produce debugging information in COFF format (if that is supported).
6831 This is the format used by SDB on most System V systems prior to
6832 System V Release 4.
6834 @item -gxcoff
6835 @opindex gxcoff
6836 Produce debugging information in XCOFF format (if that is supported).
6837 This is the format used by the DBX debugger on IBM RS/6000 systems.
6839 @item -gxcoff+
6840 @opindex gxcoff+
6841 Produce debugging information in XCOFF format (if that is supported),
6842 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6843 use of these extensions is likely to make other debuggers crash or
6844 refuse to read the program, and may cause assemblers other than the GNU
6845 assembler (GAS) to fail with an error.
6847 @item -gvms
6848 @opindex gvms
6849 Produce debugging information in Alpha/VMS debug format (if that is
6850 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6852 @item -g@var{level}
6853 @itemx -ggdb@var{level}
6854 @itemx -gstabs@var{level}
6855 @itemx -gcoff@var{level}
6856 @itemx -gxcoff@var{level}
6857 @itemx -gvms@var{level}
6858 Request debugging information and also use @var{level} to specify how
6859 much information.  The default level is 2.
6861 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6862 @option{-g}.
6864 Level 1 produces minimal information, enough for making backtraces in
6865 parts of the program that you don't plan to debug.  This includes
6866 descriptions of functions and external variables, and line number
6867 tables, but no information about local variables.
6869 Level 3 includes extra information, such as all the macro definitions
6870 present in the program.  Some debuggers support macro expansion when
6871 you use @option{-g3}.
6873 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6874 confusion with @option{-gdwarf-@var{level}}.
6875 Instead use an additional @option{-g@var{level}} option to change the
6876 debug level for DWARF.
6878 @item -feliminate-unused-debug-symbols
6879 @opindex feliminate-unused-debug-symbols
6880 Produce debugging information in stabs format (if that is supported),
6881 for only symbols that are actually used.
6883 @item -femit-class-debug-always
6884 @opindex femit-class-debug-always
6885 Instead of emitting debugging information for a C++ class in only one
6886 object file, emit it in all object files using the class.  This option
6887 should be used only with debuggers that are unable to handle the way GCC
6888 normally emits debugging information for classes because using this
6889 option increases the size of debugging information by as much as a
6890 factor of two.
6892 @item -fno-merge-debug-strings
6893 @opindex fmerge-debug-strings
6894 @opindex fno-merge-debug-strings
6895 Direct the linker to not merge together strings in the debugging
6896 information that are identical in different object files.  Merging is
6897 not supported by all assemblers or linkers.  Merging decreases the size
6898 of the debug information in the output file at the cost of increasing
6899 link processing time.  Merging is enabled by default.
6901 @item -fdebug-prefix-map=@var{old}=@var{new}
6902 @opindex fdebug-prefix-map
6903 When compiling files in directory @file{@var{old}}, record debugging
6904 information describing them as in @file{@var{new}} instead.
6906 @item -fvar-tracking
6907 @opindex fvar-tracking
6908 Run variable tracking pass.  It computes where variables are stored at each
6909 position in code.  Better debugging information is then generated
6910 (if the debugging information format supports this information).
6912 It is enabled by default when compiling with optimization (@option{-Os},
6913 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6914 the debug info format supports it.
6916 @item -fvar-tracking-assignments
6917 @opindex fvar-tracking-assignments
6918 @opindex fno-var-tracking-assignments
6919 Annotate assignments to user variables early in the compilation and
6920 attempt to carry the annotations over throughout the compilation all the
6921 way to the end, in an attempt to improve debug information while
6922 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6924 It can be enabled even if var-tracking is disabled, in which case
6925 annotations are created and maintained, but discarded at the end.
6926 By default, this flag is enabled together with @option{-fvar-tracking},
6927 except when selective scheduling is enabled.
6929 @item -gsplit-dwarf
6930 @opindex gsplit-dwarf
6931 Separate as much DWARF debugging information as possible into a
6932 separate output file with the extension @file{.dwo}.  This option allows
6933 the build system to avoid linking files with debug information.  To
6934 be useful, this option requires a debugger capable of reading @file{.dwo}
6935 files.
6937 @item -gpubnames
6938 @opindex gpubnames
6939 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6941 @item -ggnu-pubnames
6942 @opindex ggnu-pubnames
6943 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6944 suitable for conversion into a GDB@ index.  This option is only useful
6945 with a linker that can produce GDB@ index version 7.
6947 @item -fdebug-types-section
6948 @opindex fdebug-types-section
6949 @opindex fno-debug-types-section
6950 When using DWARF Version 4 or higher, type DIEs can be put into
6951 their own @code{.debug_types} section instead of making them part of the
6952 @code{.debug_info} section.  It is more efficient to put them in a separate
6953 comdat sections since the linker can then remove duplicates.
6954 But not all DWARF consumers support @code{.debug_types} sections yet
6955 and on some objects @code{.debug_types} produces larger instead of smaller
6956 debugging information.
6958 @item -grecord-gcc-switches
6959 @item -gno-record-gcc-switches
6960 @opindex grecord-gcc-switches
6961 @opindex gno-record-gcc-switches
6962 This switch causes the command-line options used to invoke the
6963 compiler that may affect code generation to be appended to the
6964 DW_AT_producer attribute in DWARF debugging information.  The options
6965 are concatenated with spaces separating them from each other and from
6966 the compiler version.  
6967 It is enabled by default.
6968 See also @option{-frecord-gcc-switches} for another
6969 way of storing compiler options into the object file.  
6971 @item -gstrict-dwarf
6972 @opindex gstrict-dwarf
6973 Disallow using extensions of later DWARF standard version than selected
6974 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6975 DWARF extensions from later standard versions is allowed.
6977 @item -gno-strict-dwarf
6978 @opindex gno-strict-dwarf
6979 Allow using extensions of later DWARF standard version than selected with
6980 @option{-gdwarf-@var{version}}.
6982 @item -gcolumn-info
6983 @item -gno-column-info
6984 @opindex gcolumn-info
6985 @opindex gno-column-info
6986 Emit location column information into DWARF debugging information, rather
6987 than just file and line.
6988 This option is disabled by default.
6990 @item -gz@r{[}=@var{type}@r{]}
6991 @opindex gz
6992 Produce compressed debug sections in DWARF format, if that is supported.
6993 If @var{type} is not given, the default type depends on the capabilities
6994 of the assembler and linker used.  @var{type} may be one of
6995 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6996 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6997 compression in traditional GNU format).  If the linker doesn't support
6998 writing compressed debug sections, the option is rejected.  Otherwise,
6999 if the assembler does not support them, @option{-gz} is silently ignored
7000 when producing object files.
7002 @item -feliminate-dwarf2-dups
7003 @opindex feliminate-dwarf2-dups
7004 Compress DWARF debugging information by eliminating duplicated
7005 information about each symbol.  This option only makes sense when
7006 generating DWARF debugging information.
7008 @item -femit-struct-debug-baseonly
7009 @opindex femit-struct-debug-baseonly
7010 Emit debug information for struct-like types
7011 only when the base name of the compilation source file
7012 matches the base name of file in which the struct is defined.
7014 This option substantially reduces the size of debugging information,
7015 but at significant potential loss in type information to the debugger.
7016 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7017 See @option{-femit-struct-debug-detailed} for more detailed control.
7019 This option works only with DWARF debug output.
7021 @item -femit-struct-debug-reduced
7022 @opindex femit-struct-debug-reduced
7023 Emit debug information for struct-like types
7024 only when the base name of the compilation source file
7025 matches the base name of file in which the type is defined,
7026 unless the struct is a template or defined in a system header.
7028 This option significantly reduces the size of debugging information,
7029 with some potential loss in type information to the debugger.
7030 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7031 See @option{-femit-struct-debug-detailed} for more detailed control.
7033 This option works only with DWARF debug output.
7035 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7036 @opindex femit-struct-debug-detailed
7037 Specify the struct-like types
7038 for which the compiler generates debug information.
7039 The intent is to reduce duplicate struct debug information
7040 between different object files within the same program.
7042 This option is a detailed version of
7043 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7044 which serves for most needs.
7046 A specification has the syntax@*
7047 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7049 The optional first word limits the specification to
7050 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7051 A struct type is used directly when it is the type of a variable, member.
7052 Indirect uses arise through pointers to structs.
7053 That is, when use of an incomplete struct is valid, the use is indirect.
7054 An example is
7055 @samp{struct one direct; struct two * indirect;}.
7057 The optional second word limits the specification to
7058 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7059 Generic structs are a bit complicated to explain.
7060 For C++, these are non-explicit specializations of template classes,
7061 or non-template classes within the above.
7062 Other programming languages have generics,
7063 but @option{-femit-struct-debug-detailed} does not yet implement them.
7065 The third word specifies the source files for those
7066 structs for which the compiler should emit debug information.
7067 The values @samp{none} and @samp{any} have the normal meaning.
7068 The value @samp{base} means that
7069 the base of name of the file in which the type declaration appears
7070 must match the base of the name of the main compilation file.
7071 In practice, this means that when compiling @file{foo.c}, debug information
7072 is generated for types declared in that file and @file{foo.h},
7073 but not other header files.
7074 The value @samp{sys} means those types satisfying @samp{base}
7075 or declared in system or compiler headers.
7077 You may need to experiment to determine the best settings for your application.
7079 The default is @option{-femit-struct-debug-detailed=all}.
7081 This option works only with DWARF debug output.
7083 @item -fno-dwarf2-cfi-asm
7084 @opindex fdwarf2-cfi-asm
7085 @opindex fno-dwarf2-cfi-asm
7086 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7087 instead of using GAS @code{.cfi_*} directives.
7089 @item -fno-eliminate-unused-debug-types
7090 @opindex feliminate-unused-debug-types
7091 @opindex fno-eliminate-unused-debug-types
7092 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7093 output for types that are nowhere used in the source file being compiled.
7094 Sometimes it is useful to have GCC emit debugging
7095 information for all types declared in a compilation
7096 unit, regardless of whether or not they are actually used
7097 in that compilation unit, for example 
7098 if, in the debugger, you want to cast a value to a type that is
7099 not actually used in your program (but is declared).  More often,
7100 however, this results in a significant amount of wasted space.
7101 @end table
7103 @node Optimize Options
7104 @section Options That Control Optimization
7105 @cindex optimize options
7106 @cindex options, optimization
7108 These options control various sorts of optimizations.
7110 Without any optimization option, the compiler's goal is to reduce the
7111 cost of compilation and to make debugging produce the expected
7112 results.  Statements are independent: if you stop the program with a
7113 breakpoint between statements, you can then assign a new value to any
7114 variable or change the program counter to any other statement in the
7115 function and get exactly the results you expect from the source
7116 code.
7118 Turning on optimization flags makes the compiler attempt to improve
7119 the performance and/or code size at the expense of compilation time
7120 and possibly the ability to debug the program.
7122 The compiler performs optimization based on the knowledge it has of the
7123 program.  Compiling multiple files at once to a single output file mode allows
7124 the compiler to use information gained from all of the files when compiling
7125 each of them.
7127 Not all optimizations are controlled directly by a flag.  Only
7128 optimizations that have a flag are listed in this section.
7130 Most optimizations are only enabled if an @option{-O} level is set on
7131 the command line.  Otherwise they are disabled, even if individual
7132 optimization flags are specified.
7134 Depending on the target and how GCC was configured, a slightly different
7135 set of optimizations may be enabled at each @option{-O} level than
7136 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7137 to find out the exact set of optimizations that are enabled at each level.
7138 @xref{Overall Options}, for examples.
7140 @table @gcctabopt
7141 @item -O
7142 @itemx -O1
7143 @opindex O
7144 @opindex O1
7145 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7146 more memory for a large function.
7148 With @option{-O}, the compiler tries to reduce code size and execution
7149 time, without performing any optimizations that take a great deal of
7150 compilation time.
7152 @option{-O} turns on the following optimization flags:
7153 @gccoptlist{
7154 -fauto-inc-dec @gol
7155 -fbranch-count-reg @gol
7156 -fcombine-stack-adjustments @gol
7157 -fcompare-elim @gol
7158 -fcprop-registers @gol
7159 -fdce @gol
7160 -fdefer-pop @gol
7161 -fdelayed-branch @gol
7162 -fdse @gol
7163 -fforward-propagate @gol
7164 -fguess-branch-probability @gol
7165 -fif-conversion2 @gol
7166 -fif-conversion @gol
7167 -finline-functions-called-once @gol
7168 -fipa-pure-const @gol
7169 -fipa-profile @gol
7170 -fipa-reference @gol
7171 -fmerge-constants @gol
7172 -fmove-loop-invariants @gol
7173 -freorder-blocks @gol
7174 -fshrink-wrap @gol
7175 -fshrink-wrap-separate @gol
7176 -fsplit-wide-types @gol
7177 -fssa-backprop @gol
7178 -fssa-phiopt @gol
7179 -ftree-bit-ccp @gol
7180 -ftree-ccp @gol
7181 -ftree-ch @gol
7182 -ftree-coalesce-vars @gol
7183 -ftree-copy-prop @gol
7184 -ftree-dce @gol
7185 -ftree-dominator-opts @gol
7186 -ftree-dse @gol
7187 -ftree-forwprop @gol
7188 -ftree-fre @gol
7189 -ftree-phiprop @gol
7190 -ftree-sink @gol
7191 -ftree-slsr @gol
7192 -ftree-sra @gol
7193 -ftree-pta @gol
7194 -ftree-ter @gol
7195 -funit-at-a-time}
7197 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7198 where doing so does not interfere with debugging.
7200 @item -O2
7201 @opindex O2
7202 Optimize even more.  GCC performs nearly all supported optimizations
7203 that do not involve a space-speed tradeoff.
7204 As compared to @option{-O}, this option increases both compilation time
7205 and the performance of the generated code.
7207 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7208 also turns on the following optimization flags:
7209 @gccoptlist{-fthread-jumps @gol
7210 -falign-functions  -falign-jumps @gol
7211 -falign-loops  -falign-labels @gol
7212 -fcaller-saves @gol
7213 -fcrossjumping @gol
7214 -fcse-follow-jumps  -fcse-skip-blocks @gol
7215 -fdelete-null-pointer-checks @gol
7216 -fdevirtualize -fdevirtualize-speculatively @gol
7217 -fexpensive-optimizations @gol
7218 -fgcse  -fgcse-lm  @gol
7219 -fhoist-adjacent-loads @gol
7220 -finline-small-functions @gol
7221 -findirect-inlining @gol
7222 -fipa-cp @gol
7223 -fipa-bit-cp @gol
7224 -fipa-vrp @gol
7225 -fipa-sra @gol
7226 -fipa-icf @gol
7227 -fisolate-erroneous-paths-dereference @gol
7228 -flra-remat @gol
7229 -foptimize-sibling-calls @gol
7230 -foptimize-strlen @gol
7231 -fpartial-inlining @gol
7232 -fpeephole2 @gol
7233 -freorder-blocks-algorithm=stc @gol
7234 -freorder-blocks-and-partition -freorder-functions @gol
7235 -frerun-cse-after-loop  @gol
7236 -fsched-interblock  -fsched-spec @gol
7237 -fschedule-insns  -fschedule-insns2 @gol
7238 -fstore-merging @gol
7239 -fstrict-aliasing @gol
7240 -ftree-builtin-call-dce @gol
7241 -ftree-switch-conversion -ftree-tail-merge @gol
7242 -fcode-hoisting @gol
7243 -ftree-pre @gol
7244 -ftree-vrp @gol
7245 -fipa-ra}
7247 Please note the warning under @option{-fgcse} about
7248 invoking @option{-O2} on programs that use computed gotos.
7250 @item -O3
7251 @opindex O3
7252 Optimize yet more.  @option{-O3} turns on all optimizations specified
7253 by @option{-O2} and also turns on the following optimization flags:
7254 @gccoptlist{-finline-functions @gol
7255 -funswitch-loops @gol
7256 -fpredictive-commoning @gol
7257 -fgcse-after-reload @gol
7258 -ftree-loop-vectorize @gol
7259 -ftree-loop-distribution @gol
7260 -ftree-loop-distribute-patterns @gol
7261 -fsplit-paths @gol
7262 -ftree-slp-vectorize @gol
7263 -fvect-cost-model @gol
7264 -ftree-partial-pre @gol
7265 -fpeel-loops @gol
7266 -fipa-cp-clone}
7268 @item -O0
7269 @opindex O0
7270 Reduce compilation time and make debugging produce the expected
7271 results.  This is the default.
7273 @item -Os
7274 @opindex Os
7275 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7276 do not typically increase code size.  It also performs further
7277 optimizations designed to reduce code size.
7279 @option{-Os} disables the following optimization flags:
7280 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7281 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7282 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7284 @item -Ofast
7285 @opindex Ofast
7286 Disregard strict standards compliance.  @option{-Ofast} enables all
7287 @option{-O3} optimizations.  It also enables optimizations that are not
7288 valid for all standard-compliant programs.
7289 It turns on @option{-ffast-math} and the Fortran-specific
7290 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7291 specified, and @option{-fno-protect-parens}.
7293 @item -Og
7294 @opindex Og
7295 Optimize debugging experience.  @option{-Og} enables optimizations
7296 that do not interfere with debugging. It should be the optimization
7297 level of choice for the standard edit-compile-debug cycle, offering
7298 a reasonable level of optimization while maintaining fast compilation
7299 and a good debugging experience.
7300 @end table
7302 If you use multiple @option{-O} options, with or without level numbers,
7303 the last such option is the one that is effective.
7305 Options of the form @option{-f@var{flag}} specify machine-independent
7306 flags.  Most flags have both positive and negative forms; the negative
7307 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7308 below, only one of the forms is listed---the one you typically 
7309 use.  You can figure out the other form by either removing @samp{no-}
7310 or adding it.
7312 The following options control specific optimizations.  They are either
7313 activated by @option{-O} options or are related to ones that are.  You
7314 can use the following flags in the rare cases when ``fine-tuning'' of
7315 optimizations to be performed is desired.
7317 @table @gcctabopt
7318 @item -fno-defer-pop
7319 @opindex fno-defer-pop
7320 Always pop the arguments to each function call as soon as that function
7321 returns.  For machines that must pop arguments after a function call,
7322 the compiler normally lets arguments accumulate on the stack for several
7323 function calls and pops them all at once.
7325 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7327 @item -fforward-propagate
7328 @opindex fforward-propagate
7329 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7330 instructions and checks if the result can be simplified.  If loop unrolling
7331 is active, two passes are performed and the second is scheduled after
7332 loop unrolling.
7334 This option is enabled by default at optimization levels @option{-O},
7335 @option{-O2}, @option{-O3}, @option{-Os}.
7337 @item -ffp-contract=@var{style}
7338 @opindex ffp-contract
7339 @option{-ffp-contract=off} disables floating-point expression contraction.
7340 @option{-ffp-contract=fast} enables floating-point expression contraction
7341 such as forming of fused multiply-add operations if the target has
7342 native support for them.
7343 @option{-ffp-contract=on} enables floating-point expression contraction
7344 if allowed by the language standard.  This is currently not implemented
7345 and treated equal to @option{-ffp-contract=off}.
7347 The default is @option{-ffp-contract=fast}.
7349 @item -fomit-frame-pointer
7350 @opindex fomit-frame-pointer
7351 Don't keep the frame pointer in a register for functions that
7352 don't need one.  This avoids the instructions to save, set up and
7353 restore frame pointers; it also makes an extra register available
7354 in many functions.  @strong{It also makes debugging impossible on
7355 some machines.}
7357 On some machines, such as the VAX, this flag has no effect, because
7358 the standard calling sequence automatically handles the frame pointer
7359 and nothing is saved by pretending it doesn't exist.  The
7360 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7361 whether a target machine supports this flag.  @xref{Registers,,Register
7362 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7364 The default setting (when not optimizing for
7365 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7366 @option{-fomit-frame-pointer}.  You can configure GCC with the
7367 @option{--enable-frame-pointer} configure option to change the default.
7369 Note that @option{-fno-omit-frame-pointer} doesn't force a new stack
7370 frame for all functions if it isn't otherwise needed, and hence doesn't
7371 guarantee a new frame pointer for all functions.
7373 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7375 @item -foptimize-sibling-calls
7376 @opindex foptimize-sibling-calls
7377 Optimize sibling and tail recursive calls.
7379 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7381 @item -foptimize-strlen
7382 @opindex foptimize-strlen
7383 Optimize various standard C string functions (e.g. @code{strlen},
7384 @code{strchr} or @code{strcpy}) and
7385 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7387 Enabled at levels @option{-O2}, @option{-O3}.
7389 @item -fno-inline
7390 @opindex fno-inline
7391 Do not expand any functions inline apart from those marked with
7392 the @code{always_inline} attribute.  This is the default when not
7393 optimizing.
7395 Single functions can be exempted from inlining by marking them
7396 with the @code{noinline} attribute.
7398 @item -finline-small-functions
7399 @opindex finline-small-functions
7400 Integrate functions into their callers when their body is smaller than expected
7401 function call code (so overall size of program gets smaller).  The compiler
7402 heuristically decides which functions are simple enough to be worth integrating
7403 in this way.  This inlining applies to all functions, even those not declared
7404 inline.
7406 Enabled at level @option{-O2}.
7408 @item -findirect-inlining
7409 @opindex findirect-inlining
7410 Inline also indirect calls that are discovered to be known at compile
7411 time thanks to previous inlining.  This option has any effect only
7412 when inlining itself is turned on by the @option{-finline-functions}
7413 or @option{-finline-small-functions} options.
7415 Enabled at level @option{-O2}.
7417 @item -finline-functions
7418 @opindex finline-functions
7419 Consider all functions for inlining, even if they are not declared inline.
7420 The compiler heuristically decides which functions are worth integrating
7421 in this way.
7423 If all calls to a given function are integrated, and the function is
7424 declared @code{static}, then the function is normally not output as
7425 assembler code in its own right.
7427 Enabled at level @option{-O3}.
7429 @item -finline-functions-called-once
7430 @opindex finline-functions-called-once
7431 Consider all @code{static} functions called once for inlining into their
7432 caller even if they are not marked @code{inline}.  If a call to a given
7433 function is integrated, then the function is not output as assembler code
7434 in its own right.
7436 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7438 @item -fearly-inlining
7439 @opindex fearly-inlining
7440 Inline functions marked by @code{always_inline} and functions whose body seems
7441 smaller than the function call overhead early before doing
7442 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7443 makes profiling significantly cheaper and usually inlining faster on programs
7444 having large chains of nested wrapper functions.
7446 Enabled by default.
7448 @item -fipa-sra
7449 @opindex fipa-sra
7450 Perform interprocedural scalar replacement of aggregates, removal of
7451 unused parameters and replacement of parameters passed by reference
7452 by parameters passed by value.
7454 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7456 @item -finline-limit=@var{n}
7457 @opindex finline-limit
7458 By default, GCC limits the size of functions that can be inlined.  This flag
7459 allows coarse control of this limit.  @var{n} is the size of functions that
7460 can be inlined in number of pseudo instructions.
7462 Inlining is actually controlled by a number of parameters, which may be
7463 specified individually by using @option{--param @var{name}=@var{value}}.
7464 The @option{-finline-limit=@var{n}} option sets some of these parameters
7465 as follows:
7467 @table @gcctabopt
7468 @item max-inline-insns-single
7469 is set to @var{n}/2.
7470 @item max-inline-insns-auto
7471 is set to @var{n}/2.
7472 @end table
7474 See below for a documentation of the individual
7475 parameters controlling inlining and for the defaults of these parameters.
7477 @emph{Note:} there may be no value to @option{-finline-limit} that results
7478 in default behavior.
7480 @emph{Note:} pseudo instruction represents, in this particular context, an
7481 abstract measurement of function's size.  In no way does it represent a count
7482 of assembly instructions and as such its exact meaning might change from one
7483 release to an another.
7485 @item -fno-keep-inline-dllexport
7486 @opindex fno-keep-inline-dllexport
7487 This is a more fine-grained version of @option{-fkeep-inline-functions},
7488 which applies only to functions that are declared using the @code{dllexport}
7489 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7490 Functions}.
7492 @item -fkeep-inline-functions
7493 @opindex fkeep-inline-functions
7494 In C, emit @code{static} functions that are declared @code{inline}
7495 into the object file, even if the function has been inlined into all
7496 of its callers.  This switch does not affect functions using the
7497 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7498 inline functions into the object file.
7500 @item -fkeep-static-functions
7501 @opindex fkeep-static-functions
7502 Emit @code{static} functions into the object file, even if the function
7503 is never used.
7505 @item -fkeep-static-consts
7506 @opindex fkeep-static-consts
7507 Emit variables declared @code{static const} when optimization isn't turned
7508 on, even if the variables aren't referenced.
7510 GCC enables this option by default.  If you want to force the compiler to
7511 check if a variable is referenced, regardless of whether or not
7512 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7514 @item -fmerge-constants
7515 @opindex fmerge-constants
7516 Attempt to merge identical constants (string constants and floating-point
7517 constants) across compilation units.
7519 This option is the default for optimized compilation if the assembler and
7520 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7521 behavior.
7523 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7525 @item -fmerge-all-constants
7526 @opindex fmerge-all-constants
7527 Attempt to merge identical constants and identical variables.
7529 This option implies @option{-fmerge-constants}.  In addition to
7530 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7531 arrays or initialized constant variables with integral or floating-point
7532 types.  Languages like C or C++ require each variable, including multiple
7533 instances of the same variable in recursive calls, to have distinct locations,
7534 so using this option results in non-conforming
7535 behavior.
7537 @item -fmodulo-sched
7538 @opindex fmodulo-sched
7539 Perform swing modulo scheduling immediately before the first scheduling
7540 pass.  This pass looks at innermost loops and reorders their
7541 instructions by overlapping different iterations.
7543 @item -fmodulo-sched-allow-regmoves
7544 @opindex fmodulo-sched-allow-regmoves
7545 Perform more aggressive SMS-based modulo scheduling with register moves
7546 allowed.  By setting this flag certain anti-dependences edges are
7547 deleted, which triggers the generation of reg-moves based on the
7548 life-range analysis.  This option is effective only with
7549 @option{-fmodulo-sched} enabled.
7551 @item -fno-branch-count-reg
7552 @opindex fno-branch-count-reg
7553 Avoid running a pass scanning for opportunities to use ``decrement and
7554 branch'' instructions on a count register instead of generating sequences
7555 of instructions that decrement a register, compare it against zero, and
7556 then branch based upon the result.  This option is only meaningful on
7557 architectures that support such instructions, which include x86, PowerPC,
7558 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7559 doesn't remove the decrement and branch instructions from the generated
7560 instruction stream introduced by other optimization passes.
7562 Enabled by default at @option{-O1} and higher.
7564 The default is @option{-fbranch-count-reg}.
7566 @item -fno-function-cse
7567 @opindex fno-function-cse
7568 Do not put function addresses in registers; make each instruction that
7569 calls a constant function contain the function's address explicitly.
7571 This option results in less efficient code, but some strange hacks
7572 that alter the assembler output may be confused by the optimizations
7573 performed when this option is not used.
7575 The default is @option{-ffunction-cse}
7577 @item -fno-zero-initialized-in-bss
7578 @opindex fno-zero-initialized-in-bss
7579 If the target supports a BSS section, GCC by default puts variables that
7580 are initialized to zero into BSS@.  This can save space in the resulting
7581 code.
7583 This option turns off this behavior because some programs explicitly
7584 rely on variables going to the data section---e.g., so that the
7585 resulting executable can find the beginning of that section and/or make
7586 assumptions based on that.
7588 The default is @option{-fzero-initialized-in-bss}.
7590 @item -fthread-jumps
7591 @opindex fthread-jumps
7592 Perform optimizations that check to see if a jump branches to a
7593 location where another comparison subsumed by the first is found.  If
7594 so, the first branch is redirected to either the destination of the
7595 second branch or a point immediately following it, depending on whether
7596 the condition is known to be true or false.
7598 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7600 @item -fsplit-wide-types
7601 @opindex fsplit-wide-types
7602 When using a type that occupies multiple registers, such as @code{long
7603 long} on a 32-bit system, split the registers apart and allocate them
7604 independently.  This normally generates better code for those types,
7605 but may make debugging more difficult.
7607 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7608 @option{-Os}.
7610 @item -fcse-follow-jumps
7611 @opindex fcse-follow-jumps
7612 In common subexpression elimination (CSE), scan through jump instructions
7613 when the target of the jump is not reached by any other path.  For
7614 example, when CSE encounters an @code{if} statement with an
7615 @code{else} clause, CSE follows the jump when the condition
7616 tested is false.
7618 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7620 @item -fcse-skip-blocks
7621 @opindex fcse-skip-blocks
7622 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7623 follow jumps that conditionally skip over blocks.  When CSE
7624 encounters a simple @code{if} statement with no else clause,
7625 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7626 body of the @code{if}.
7628 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7630 @item -frerun-cse-after-loop
7631 @opindex frerun-cse-after-loop
7632 Re-run common subexpression elimination after loop optimizations are
7633 performed.
7635 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7637 @item -fgcse
7638 @opindex fgcse
7639 Perform a global common subexpression elimination pass.
7640 This pass also performs global constant and copy propagation.
7642 @emph{Note:} When compiling a program using computed gotos, a GCC
7643 extension, you may get better run-time performance if you disable
7644 the global common subexpression elimination pass by adding
7645 @option{-fno-gcse} to the command line.
7647 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7649 @item -fgcse-lm
7650 @opindex fgcse-lm
7651 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7652 attempts to move loads that are only killed by stores into themselves.  This
7653 allows a loop containing a load/store sequence to be changed to a load outside
7654 the loop, and a copy/store within the loop.
7656 Enabled by default when @option{-fgcse} is enabled.
7658 @item -fgcse-sm
7659 @opindex fgcse-sm
7660 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7661 global common subexpression elimination.  This pass attempts to move
7662 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7663 loops containing a load/store sequence can be changed to a load before
7664 the loop and a store after the loop.
7666 Not enabled at any optimization level.
7668 @item -fgcse-las
7669 @opindex fgcse-las
7670 When @option{-fgcse-las} is enabled, the global common subexpression
7671 elimination pass eliminates redundant loads that come after stores to the
7672 same memory location (both partial and full redundancies).
7674 Not enabled at any optimization level.
7676 @item -fgcse-after-reload
7677 @opindex fgcse-after-reload
7678 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7679 pass is performed after reload.  The purpose of this pass is to clean up
7680 redundant spilling.
7682 @item -faggressive-loop-optimizations
7683 @opindex faggressive-loop-optimizations
7684 This option tells the loop optimizer to use language constraints to
7685 derive bounds for the number of iterations of a loop.  This assumes that
7686 loop code does not invoke undefined behavior by for example causing signed
7687 integer overflows or out-of-bound array accesses.  The bounds for the
7688 number of iterations of a loop are used to guide loop unrolling and peeling
7689 and loop exit test optimizations.
7690 This option is enabled by default.
7692 @item -funconstrained-commons
7693 @opindex funconstrained-commons
7694 This option tells the compiler that variables declared in common blocks
7695 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7696 prevents certain optimizations that depend on knowing the array bounds.
7698 @item -fcrossjumping
7699 @opindex fcrossjumping
7700 Perform cross-jumping transformation.
7701 This transformation unifies equivalent code and saves code size.  The
7702 resulting code may or may not perform better than without cross-jumping.
7704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7706 @item -fauto-inc-dec
7707 @opindex fauto-inc-dec
7708 Combine increments or decrements of addresses with memory accesses.
7709 This pass is always skipped on architectures that do not have
7710 instructions to support this.  Enabled by default at @option{-O} and
7711 higher on architectures that support this.
7713 @item -fdce
7714 @opindex fdce
7715 Perform dead code elimination (DCE) on RTL@.
7716 Enabled by default at @option{-O} and higher.
7718 @item -fdse
7719 @opindex fdse
7720 Perform dead store elimination (DSE) on RTL@.
7721 Enabled by default at @option{-O} and higher.
7723 @item -fif-conversion
7724 @opindex fif-conversion
7725 Attempt to transform conditional jumps into branch-less equivalents.  This
7726 includes use of conditional moves, min, max, set flags and abs instructions, and
7727 some tricks doable by standard arithmetics.  The use of conditional execution
7728 on chips where it is available is controlled by @option{-fif-conversion2}.
7730 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7732 @item -fif-conversion2
7733 @opindex fif-conversion2
7734 Use conditional execution (where available) to transform conditional jumps into
7735 branch-less equivalents.
7737 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7739 @item -fdeclone-ctor-dtor
7740 @opindex fdeclone-ctor-dtor
7741 The C++ ABI requires multiple entry points for constructors and
7742 destructors: one for a base subobject, one for a complete object, and
7743 one for a virtual destructor that calls operator delete afterwards.
7744 For a hierarchy with virtual bases, the base and complete variants are
7745 clones, which means two copies of the function.  With this option, the
7746 base and complete variants are changed to be thunks that call a common
7747 implementation.
7749 Enabled by @option{-Os}.
7751 @item -fdelete-null-pointer-checks
7752 @opindex fdelete-null-pointer-checks
7753 Assume that programs cannot safely dereference null pointers, and that
7754 no code or data element resides at address zero.
7755 This option enables simple constant
7756 folding optimizations at all optimization levels.  In addition, other
7757 optimization passes in GCC use this flag to control global dataflow
7758 analyses that eliminate useless checks for null pointers; these assume
7759 that a memory access to address zero always results in a trap, so
7760 that if a pointer is checked after it has already been dereferenced,
7761 it cannot be null.
7763 Note however that in some environments this assumption is not true.
7764 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7765 for programs that depend on that behavior.
7767 This option is enabled by default on most targets.  On Nios II ELF, it
7768 defaults to off.  On AVR and CR16, this option is completely disabled.  
7770 Passes that use the dataflow information
7771 are enabled independently at different optimization levels.
7773 @item -fdevirtualize
7774 @opindex fdevirtualize
7775 Attempt to convert calls to virtual functions to direct calls.  This
7776 is done both within a procedure and interprocedurally as part of
7777 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7778 propagation (@option{-fipa-cp}).
7779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7781 @item -fdevirtualize-speculatively
7782 @opindex fdevirtualize-speculatively
7783 Attempt to convert calls to virtual functions to speculative direct calls.
7784 Based on the analysis of the type inheritance graph, determine for a given call
7785 the set of likely targets. If the set is small, preferably of size 1, change
7786 the call into a conditional deciding between direct and indirect calls.  The
7787 speculative calls enable more optimizations, such as inlining.  When they seem
7788 useless after further optimization, they are converted back into original form.
7790 @item -fdevirtualize-at-ltrans
7791 @opindex fdevirtualize-at-ltrans
7792 Stream extra information needed for aggressive devirtualization when running
7793 the link-time optimizer in local transformation mode.  
7794 This option enables more devirtualization but
7795 significantly increases the size of streamed data. For this reason it is
7796 disabled by default.
7798 @item -fexpensive-optimizations
7799 @opindex fexpensive-optimizations
7800 Perform a number of minor optimizations that are relatively expensive.
7802 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7804 @item -free
7805 @opindex free
7806 Attempt to remove redundant extension instructions.  This is especially
7807 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7808 registers after writing to their lower 32-bit half.
7810 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7811 @option{-O3}, @option{-Os}.
7813 @item -fno-lifetime-dse
7814 @opindex fno-lifetime-dse
7815 In C++ the value of an object is only affected by changes within its
7816 lifetime: when the constructor begins, the object has an indeterminate
7817 value, and any changes during the lifetime of the object are dead when
7818 the object is destroyed.  Normally dead store elimination will take
7819 advantage of this; if your code relies on the value of the object
7820 storage persisting beyond the lifetime of the object, you can use this
7821 flag to disable this optimization.  To preserve stores before the
7822 constructor starts (e.g. because your operator new clears the object
7823 storage) but still treat the object as dead after the destructor you,
7824 can use @option{-flifetime-dse=1}.  The default behavior can be
7825 explicitly selected with @option{-flifetime-dse=2}.
7826 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7828 @item -flive-range-shrinkage
7829 @opindex flive-range-shrinkage
7830 Attempt to decrease register pressure through register live range
7831 shrinkage.  This is helpful for fast processors with small or moderate
7832 size register sets.
7834 @item -fira-algorithm=@var{algorithm}
7835 @opindex fira-algorithm
7836 Use the specified coloring algorithm for the integrated register
7837 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7838 specifies Chow's priority coloring, or @samp{CB}, which specifies
7839 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7840 for all architectures, but for those targets that do support it, it is
7841 the default because it generates better code.
7843 @item -fira-region=@var{region}
7844 @opindex fira-region
7845 Use specified regions for the integrated register allocator.  The
7846 @var{region} argument should be one of the following:
7848 @table @samp
7850 @item all
7851 Use all loops as register allocation regions.
7852 This can give the best results for machines with a small and/or
7853 irregular register set.
7855 @item mixed
7856 Use all loops except for loops with small register pressure 
7857 as the regions.  This value usually gives
7858 the best results in most cases and for most architectures,
7859 and is enabled by default when compiling with optimization for speed
7860 (@option{-O}, @option{-O2}, @dots{}).
7862 @item one
7863 Use all functions as a single region.  
7864 This typically results in the smallest code size, and is enabled by default for
7865 @option{-Os} or @option{-O0}.
7867 @end table
7869 @item -fira-hoist-pressure
7870 @opindex fira-hoist-pressure
7871 Use IRA to evaluate register pressure in the code hoisting pass for
7872 decisions to hoist expressions.  This option usually results in smaller
7873 code, but it can slow the compiler down.
7875 This option is enabled at level @option{-Os} for all targets.
7877 @item -fira-loop-pressure
7878 @opindex fira-loop-pressure
7879 Use IRA to evaluate register pressure in loops for decisions to move
7880 loop invariants.  This option usually results in generation
7881 of faster and smaller code on machines with large register files (>= 32
7882 registers), but it can slow the compiler down.
7884 This option is enabled at level @option{-O3} for some targets.
7886 @item -fno-ira-share-save-slots
7887 @opindex fno-ira-share-save-slots
7888 Disable sharing of stack slots used for saving call-used hard
7889 registers living through a call.  Each hard register gets a
7890 separate stack slot, and as a result function stack frames are
7891 larger.
7893 @item -fno-ira-share-spill-slots
7894 @opindex fno-ira-share-spill-slots
7895 Disable sharing of stack slots allocated for pseudo-registers.  Each
7896 pseudo-register that does not get a hard register gets a separate
7897 stack slot, and as a result function stack frames are larger.
7899 @item -flra-remat
7900 @opindex flra-remat
7901 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7902 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7903 values if it is profitable.
7905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7907 @item -fdelayed-branch
7908 @opindex fdelayed-branch
7909 If supported for the target machine, attempt to reorder instructions
7910 to exploit instruction slots available after delayed branch
7911 instructions.
7913 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7915 @item -fschedule-insns
7916 @opindex fschedule-insns
7917 If supported for the target machine, attempt to reorder instructions to
7918 eliminate execution stalls due to required data being unavailable.  This
7919 helps machines that have slow floating point or memory load instructions
7920 by allowing other instructions to be issued until the result of the load
7921 or floating-point instruction is required.
7923 Enabled at levels @option{-O2}, @option{-O3}.
7925 @item -fschedule-insns2
7926 @opindex fschedule-insns2
7927 Similar to @option{-fschedule-insns}, but requests an additional pass of
7928 instruction scheduling after register allocation has been done.  This is
7929 especially useful on machines with a relatively small number of
7930 registers and where memory load instructions take more than one cycle.
7932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7934 @item -fno-sched-interblock
7935 @opindex fno-sched-interblock
7936 Don't schedule instructions across basic blocks.  This is normally
7937 enabled by default when scheduling before register allocation, i.e.@:
7938 with @option{-fschedule-insns} or at @option{-O2} or higher.
7940 @item -fno-sched-spec
7941 @opindex fno-sched-spec
7942 Don't allow speculative motion of non-load instructions.  This is normally
7943 enabled by default when scheduling before register allocation, i.e.@:
7944 with @option{-fschedule-insns} or at @option{-O2} or higher.
7946 @item -fsched-pressure
7947 @opindex fsched-pressure
7948 Enable register pressure sensitive insn scheduling before register
7949 allocation.  This only makes sense when scheduling before register
7950 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7951 @option{-O2} or higher.  Usage of this option can improve the
7952 generated code and decrease its size by preventing register pressure
7953 increase above the number of available hard registers and subsequent
7954 spills in register allocation.
7956 @item -fsched-spec-load
7957 @opindex fsched-spec-load
7958 Allow speculative motion of some load instructions.  This only makes
7959 sense when scheduling before register allocation, i.e.@: with
7960 @option{-fschedule-insns} or at @option{-O2} or higher.
7962 @item -fsched-spec-load-dangerous
7963 @opindex fsched-spec-load-dangerous
7964 Allow speculative motion of more load instructions.  This only makes
7965 sense when scheduling before register allocation, i.e.@: with
7966 @option{-fschedule-insns} or at @option{-O2} or higher.
7968 @item -fsched-stalled-insns
7969 @itemx -fsched-stalled-insns=@var{n}
7970 @opindex fsched-stalled-insns
7971 Define how many insns (if any) can be moved prematurely from the queue
7972 of stalled insns into the ready list during the second scheduling pass.
7973 @option{-fno-sched-stalled-insns} means that no insns are moved
7974 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7975 on how many queued insns can be moved prematurely.
7976 @option{-fsched-stalled-insns} without a value is equivalent to
7977 @option{-fsched-stalled-insns=1}.
7979 @item -fsched-stalled-insns-dep
7980 @itemx -fsched-stalled-insns-dep=@var{n}
7981 @opindex fsched-stalled-insns-dep
7982 Define how many insn groups (cycles) are examined for a dependency
7983 on a stalled insn that is a candidate for premature removal from the queue
7984 of stalled insns.  This has an effect only during the second scheduling pass,
7985 and only if @option{-fsched-stalled-insns} is used.
7986 @option{-fno-sched-stalled-insns-dep} is equivalent to
7987 @option{-fsched-stalled-insns-dep=0}.
7988 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7989 @option{-fsched-stalled-insns-dep=1}.
7991 @item -fsched2-use-superblocks
7992 @opindex fsched2-use-superblocks
7993 When scheduling after register allocation, use superblock scheduling.
7994 This allows motion across basic block boundaries,
7995 resulting in faster schedules.  This option is experimental, as not all machine
7996 descriptions used by GCC model the CPU closely enough to avoid unreliable
7997 results from the algorithm.
7999 This only makes sense when scheduling after register allocation, i.e.@: with
8000 @option{-fschedule-insns2} or at @option{-O2} or higher.
8002 @item -fsched-group-heuristic
8003 @opindex fsched-group-heuristic
8004 Enable the group heuristic in the scheduler.  This heuristic favors
8005 the instruction that belongs to a schedule group.  This is enabled
8006 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8007 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8009 @item -fsched-critical-path-heuristic
8010 @opindex fsched-critical-path-heuristic
8011 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8012 instructions on the critical path.  This is enabled by default when
8013 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8014 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8016 @item -fsched-spec-insn-heuristic
8017 @opindex fsched-spec-insn-heuristic
8018 Enable the speculative instruction heuristic in the scheduler.  This
8019 heuristic favors speculative instructions with greater dependency weakness.
8020 This is enabled by default when scheduling is enabled, i.e.@:
8021 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8022 or at @option{-O2} or higher.
8024 @item -fsched-rank-heuristic
8025 @opindex fsched-rank-heuristic
8026 Enable the rank heuristic in the scheduler.  This heuristic favors
8027 the instruction belonging to a basic block with greater size or frequency.
8028 This is enabled by default when scheduling is enabled, i.e.@:
8029 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8030 at @option{-O2} or higher.
8032 @item -fsched-last-insn-heuristic
8033 @opindex fsched-last-insn-heuristic
8034 Enable the last-instruction heuristic in the scheduler.  This heuristic
8035 favors the instruction that is less dependent on the last instruction
8036 scheduled.  This is enabled by default when scheduling is enabled,
8037 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8038 at @option{-O2} or higher.
8040 @item -fsched-dep-count-heuristic
8041 @opindex fsched-dep-count-heuristic
8042 Enable the dependent-count heuristic in the scheduler.  This heuristic
8043 favors the instruction that has more instructions depending on it.
8044 This is enabled by default when scheduling is enabled, i.e.@:
8045 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8046 at @option{-O2} or higher.
8048 @item -freschedule-modulo-scheduled-loops
8049 @opindex freschedule-modulo-scheduled-loops
8050 Modulo scheduling is performed before traditional scheduling.  If a loop
8051 is modulo scheduled, later scheduling passes may change its schedule.  
8052 Use this option to control that behavior.
8054 @item -fselective-scheduling
8055 @opindex fselective-scheduling
8056 Schedule instructions using selective scheduling algorithm.  Selective
8057 scheduling runs instead of the first scheduler pass.
8059 @item -fselective-scheduling2
8060 @opindex fselective-scheduling2
8061 Schedule instructions using selective scheduling algorithm.  Selective
8062 scheduling runs instead of the second scheduler pass.
8064 @item -fsel-sched-pipelining
8065 @opindex fsel-sched-pipelining
8066 Enable software pipelining of innermost loops during selective scheduling.
8067 This option has no effect unless one of @option{-fselective-scheduling} or
8068 @option{-fselective-scheduling2} is turned on.
8070 @item -fsel-sched-pipelining-outer-loops
8071 @opindex fsel-sched-pipelining-outer-loops
8072 When pipelining loops during selective scheduling, also pipeline outer loops.
8073 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8075 @item -fsemantic-interposition
8076 @opindex fsemantic-interposition
8077 Some object formats, like ELF, allow interposing of symbols by the 
8078 dynamic linker.
8079 This means that for symbols exported from the DSO, the compiler cannot perform
8080 interprocedural propagation, inlining and other optimizations in anticipation
8081 that the function or variable in question may change. While this feature is
8082 useful, for example, to rewrite memory allocation functions by a debugging
8083 implementation, it is expensive in the terms of code quality.
8084 With @option{-fno-semantic-interposition} the compiler assumes that 
8085 if interposition happens for functions the overwriting function will have 
8086 precisely the same semantics (and side effects). 
8087 Similarly if interposition happens
8088 for variables, the constructor of the variable will be the same. The flag
8089 has no effect for functions explicitly declared inline 
8090 (where it is never allowed for interposition to change semantics) 
8091 and for symbols explicitly declared weak.
8093 @item -fshrink-wrap
8094 @opindex fshrink-wrap
8095 Emit function prologues only before parts of the function that need it,
8096 rather than at the top of the function.  This flag is enabled by default at
8097 @option{-O} and higher.
8099 @item -fshrink-wrap-separate
8100 @opindex fshrink-wrap-separate
8101 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8102 those parts are only executed when needed.
8103 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8104 is also turned on and the target supports this.
8106 @item -fcaller-saves
8107 @opindex fcaller-saves
8108 Enable allocation of values to registers that are clobbered by
8109 function calls, by emitting extra instructions to save and restore the
8110 registers around such calls.  Such allocation is done only when it
8111 seems to result in better code.
8113 This option is always enabled by default on certain machines, usually
8114 those which have no call-preserved registers to use instead.
8116 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8118 @item -fcombine-stack-adjustments
8119 @opindex fcombine-stack-adjustments
8120 Tracks stack adjustments (pushes and pops) and stack memory references
8121 and then tries to find ways to combine them.
8123 Enabled by default at @option{-O1} and higher.
8125 @item -fipa-ra
8126 @opindex fipa-ra
8127 Use caller save registers for allocation if those registers are not used by
8128 any called function.  In that case it is not necessary to save and restore
8129 them around calls.  This is only possible if called functions are part of
8130 same compilation unit as current function and they are compiled before it.
8132 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8133 is disabled if generated code will be instrumented for profiling
8134 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8135 exactly (this happens on targets that do not expose prologues
8136 and epilogues in RTL).
8138 @item -fconserve-stack
8139 @opindex fconserve-stack
8140 Attempt to minimize stack usage.  The compiler attempts to use less
8141 stack space, even if that makes the program slower.  This option
8142 implies setting the @option{large-stack-frame} parameter to 100
8143 and the @option{large-stack-frame-growth} parameter to 400.
8145 @item -ftree-reassoc
8146 @opindex ftree-reassoc
8147 Perform reassociation on trees.  This flag is enabled by default
8148 at @option{-O} and higher.
8150 @item -fcode-hoisting
8151 @opindex fcode-hoisting
8152 Perform code hoisting.  Code hoisting tries to move the
8153 evaluation of expressions executed on all paths to the function exit
8154 as early as possible.  This is especially useful as a code size
8155 optimization, but it often helps for code speed as well.
8156 This flag is enabled by default at @option{-O2} and higher.
8158 @item -ftree-pre
8159 @opindex ftree-pre
8160 Perform partial redundancy elimination (PRE) on trees.  This flag is
8161 enabled by default at @option{-O2} and @option{-O3}.
8163 @item -ftree-partial-pre
8164 @opindex ftree-partial-pre
8165 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8166 enabled by default at @option{-O3}.
8168 @item -ftree-forwprop
8169 @opindex ftree-forwprop
8170 Perform forward propagation on trees.  This flag is enabled by default
8171 at @option{-O} and higher.
8173 @item -ftree-fre
8174 @opindex ftree-fre
8175 Perform full redundancy elimination (FRE) on trees.  The difference
8176 between FRE and PRE is that FRE only considers expressions
8177 that are computed on all paths leading to the redundant computation.
8178 This analysis is faster than PRE, though it exposes fewer redundancies.
8179 This flag is enabled by default at @option{-O} and higher.
8181 @item -ftree-phiprop
8182 @opindex ftree-phiprop
8183 Perform hoisting of loads from conditional pointers on trees.  This
8184 pass is enabled by default at @option{-O} and higher.
8186 @item -fhoist-adjacent-loads
8187 @opindex fhoist-adjacent-loads
8188 Speculatively hoist loads from both branches of an if-then-else if the
8189 loads are from adjacent locations in the same structure and the target
8190 architecture has a conditional move instruction.  This flag is enabled
8191 by default at @option{-O2} and higher.
8193 @item -ftree-copy-prop
8194 @opindex ftree-copy-prop
8195 Perform copy propagation on trees.  This pass eliminates unnecessary
8196 copy operations.  This flag is enabled by default at @option{-O} and
8197 higher.
8199 @item -fipa-pure-const
8200 @opindex fipa-pure-const
8201 Discover which functions are pure or constant.
8202 Enabled by default at @option{-O} and higher.
8204 @item -fipa-reference
8205 @opindex fipa-reference
8206 Discover which static variables do not escape the
8207 compilation unit.
8208 Enabled by default at @option{-O} and higher.
8210 @item -fipa-pta
8211 @opindex fipa-pta
8212 Perform interprocedural pointer analysis and interprocedural modification
8213 and reference analysis.  This option can cause excessive memory and
8214 compile-time usage on large compilation units.  It is not enabled by
8215 default at any optimization level.
8217 @item -fipa-profile
8218 @opindex fipa-profile
8219 Perform interprocedural profile propagation.  The functions called only from
8220 cold functions are marked as cold. Also functions executed once (such as
8221 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8222 functions and loop less parts of functions executed once are then optimized for
8223 size.
8224 Enabled by default at @option{-O} and higher.
8226 @item -fipa-cp
8227 @opindex fipa-cp
8228 Perform interprocedural constant propagation.
8229 This optimization analyzes the program to determine when values passed
8230 to functions are constants and then optimizes accordingly.
8231 This optimization can substantially increase performance
8232 if the application has constants passed to functions.
8233 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8235 @item -fipa-cp-clone
8236 @opindex fipa-cp-clone
8237 Perform function cloning to make interprocedural constant propagation stronger.
8238 When enabled, interprocedural constant propagation performs function cloning
8239 when externally visible function can be called with constant arguments.
8240 Because this optimization can create multiple copies of functions,
8241 it may significantly increase code size
8242 (see @option{--param ipcp-unit-growth=@var{value}}).
8243 This flag is enabled by default at @option{-O3}.
8245 @item -fipa-bit-cp
8246 @opindex -fipa-bit-cp
8247 When enabled, perform interprocedural bitwise constant
8248 propagation. This flag is enabled by default at @option{-O2}. It
8249 requires that @option{-fipa-cp} is enabled.
8251 @item -fipa-vrp
8252 @opindex -fipa-vrp
8253 When enabled, perform interprocedural propagation of value
8254 ranges. This flag is enabled by default at @option{-O2}. It requires
8255 that @option{-fipa-cp} is enabled.
8257 @item -fipa-icf
8258 @opindex fipa-icf
8259 Perform Identical Code Folding for functions and read-only variables.
8260 The optimization reduces code size and may disturb unwind stacks by replacing
8261 a function by equivalent one with a different name. The optimization works
8262 more effectively with link-time optimization enabled.
8264 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8265 works on different levels and thus the optimizations are not same - there are
8266 equivalences that are found only by GCC and equivalences found only by Gold.
8268 This flag is enabled by default at @option{-O2} and @option{-Os}.
8270 @item -fisolate-erroneous-paths-dereference
8271 @opindex fisolate-erroneous-paths-dereference
8272 Detect paths that trigger erroneous or undefined behavior due to
8273 dereferencing a null pointer.  Isolate those paths from the main control
8274 flow and turn the statement with erroneous or undefined behavior into a trap.
8275 This flag is enabled by default at @option{-O2} and higher and depends on
8276 @option{-fdelete-null-pointer-checks} also being enabled.
8278 @item -fisolate-erroneous-paths-attribute
8279 @opindex fisolate-erroneous-paths-attribute
8280 Detect paths that trigger erroneous or undefined behavior due a null value
8281 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8282 attribute.  Isolate those paths from the main control flow and turn the
8283 statement with erroneous or undefined behavior into a trap.  This is not
8284 currently enabled, but may be enabled by @option{-O2} in the future.
8286 @item -ftree-sink
8287 @opindex ftree-sink
8288 Perform forward store motion on trees.  This flag is
8289 enabled by default at @option{-O} and higher.
8291 @item -ftree-bit-ccp
8292 @opindex ftree-bit-ccp
8293 Perform sparse conditional bit constant propagation on trees and propagate
8294 pointer alignment information.
8295 This pass only operates on local scalar variables and is enabled by default
8296 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8298 @item -ftree-ccp
8299 @opindex ftree-ccp
8300 Perform sparse conditional constant propagation (CCP) on trees.  This
8301 pass only operates on local scalar variables and is enabled by default
8302 at @option{-O} and higher.
8304 @item -fssa-backprop
8305 @opindex fssa-backprop
8306 Propagate information about uses of a value up the definition chain
8307 in order to simplify the definitions.  For example, this pass strips
8308 sign operations if the sign of a value never matters.  The flag is
8309 enabled by default at @option{-O} and higher.
8311 @item -fssa-phiopt
8312 @opindex fssa-phiopt
8313 Perform pattern matching on SSA PHI nodes to optimize conditional
8314 code.  This pass is enabled by default at @option{-O} and higher.
8316 @item -ftree-switch-conversion
8317 @opindex ftree-switch-conversion
8318 Perform conversion of simple initializations in a switch to
8319 initializations from a scalar array.  This flag is enabled by default
8320 at @option{-O2} and higher.
8322 @item -ftree-tail-merge
8323 @opindex ftree-tail-merge
8324 Look for identical code sequences.  When found, replace one with a jump to the
8325 other.  This optimization is known as tail merging or cross jumping.  This flag
8326 is enabled by default at @option{-O2} and higher.  The compilation time
8327 in this pass can
8328 be limited using @option{max-tail-merge-comparisons} parameter and
8329 @option{max-tail-merge-iterations} parameter.
8331 @item -ftree-dce
8332 @opindex ftree-dce
8333 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8334 default at @option{-O} and higher.
8336 @item -ftree-builtin-call-dce
8337 @opindex ftree-builtin-call-dce
8338 Perform conditional dead code elimination (DCE) for calls to built-in functions
8339 that may set @code{errno} but are otherwise side-effect free.  This flag is
8340 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8341 specified.
8343 @item -ftree-dominator-opts
8344 @opindex ftree-dominator-opts
8345 Perform a variety of simple scalar cleanups (constant/copy
8346 propagation, redundancy elimination, range propagation and expression
8347 simplification) based on a dominator tree traversal.  This also
8348 performs jump threading (to reduce jumps to jumps). This flag is
8349 enabled by default at @option{-O} and higher.
8351 @item -ftree-dse
8352 @opindex ftree-dse
8353 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8354 a memory location that is later overwritten by another store without
8355 any intervening loads.  In this case the earlier store can be deleted.  This
8356 flag is enabled by default at @option{-O} and higher.
8358 @item -ftree-ch
8359 @opindex ftree-ch
8360 Perform loop header copying on trees.  This is beneficial since it increases
8361 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8362 is enabled by default at @option{-O} and higher.  It is not enabled
8363 for @option{-Os}, since it usually increases code size.
8365 @item -ftree-loop-optimize
8366 @opindex ftree-loop-optimize
8367 Perform loop optimizations on trees.  This flag is enabled by default
8368 at @option{-O} and higher.
8370 @item -ftree-loop-linear
8371 @itemx -floop-interchange
8372 @itemx -floop-strip-mine
8373 @itemx -floop-block
8374 @itemx -floop-unroll-and-jam
8375 @opindex ftree-loop-linear
8376 @opindex floop-interchange
8377 @opindex floop-strip-mine
8378 @opindex floop-block
8379 @opindex floop-unroll-and-jam
8380 Perform loop nest optimizations.  Same as
8381 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8382 to be configured with @option{--with-isl} to enable the Graphite loop
8383 transformation infrastructure.
8385 @item -fgraphite-identity
8386 @opindex fgraphite-identity
8387 Enable the identity transformation for graphite.  For every SCoP we generate
8388 the polyhedral representation and transform it back to gimple.  Using
8389 @option{-fgraphite-identity} we can check the costs or benefits of the
8390 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8391 are also performed by the code generator isl, like index splitting and
8392 dead code elimination in loops.
8394 @item -floop-nest-optimize
8395 @opindex floop-nest-optimize
8396 Enable the isl based loop nest optimizer.  This is a generic loop nest
8397 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8398 structure optimized for data-locality and parallelism.  This option
8399 is experimental.
8401 @item -floop-parallelize-all
8402 @opindex floop-parallelize-all
8403 Use the Graphite data dependence analysis to identify loops that can
8404 be parallelized.  Parallelize all the loops that can be analyzed to
8405 not contain loop carried dependences without checking that it is
8406 profitable to parallelize the loops.
8408 @item -ftree-coalesce-vars
8409 @opindex ftree-coalesce-vars
8410 While transforming the program out of the SSA representation, attempt to
8411 reduce copying by coalescing versions of different user-defined
8412 variables, instead of just compiler temporaries.  This may severely
8413 limit the ability to debug an optimized program compiled with
8414 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8415 prevents SSA coalescing of user variables.  This option is enabled by
8416 default if optimization is enabled, and it does very little otherwise.
8418 @item -ftree-loop-if-convert
8419 @opindex ftree-loop-if-convert
8420 Attempt to transform conditional jumps in the innermost loops to
8421 branch-less equivalents.  The intent is to remove control-flow from
8422 the innermost loops in order to improve the ability of the
8423 vectorization pass to handle these loops.  This is enabled by default
8424 if vectorization is enabled.
8426 @item -ftree-loop-distribution
8427 @opindex ftree-loop-distribution
8428 Perform loop distribution.  This flag can improve cache performance on
8429 big loop bodies and allow further loop optimizations, like
8430 parallelization or vectorization, to take place.  For example, the loop
8431 @smallexample
8432 DO I = 1, N
8433   A(I) = B(I) + C
8434   D(I) = E(I) * F
8435 ENDDO
8436 @end smallexample
8437 is transformed to
8438 @smallexample
8439 DO I = 1, N
8440    A(I) = B(I) + C
8441 ENDDO
8442 DO I = 1, N
8443    D(I) = E(I) * F
8444 ENDDO
8445 @end smallexample
8447 @item -ftree-loop-distribute-patterns
8448 @opindex ftree-loop-distribute-patterns
8449 Perform loop distribution of patterns that can be code generated with
8450 calls to a library.  This flag is enabled by default at @option{-O3}.
8452 This pass distributes the initialization loops and generates a call to
8453 memset zero.  For example, the loop
8454 @smallexample
8455 DO I = 1, N
8456   A(I) = 0
8457   B(I) = A(I) + I
8458 ENDDO
8459 @end smallexample
8460 is transformed to
8461 @smallexample
8462 DO I = 1, N
8463    A(I) = 0
8464 ENDDO
8465 DO I = 1, N
8466    B(I) = A(I) + I
8467 ENDDO
8468 @end smallexample
8469 and the initialization loop is transformed into a call to memset zero.
8471 @item -ftree-loop-im
8472 @opindex ftree-loop-im
8473 Perform loop invariant motion on trees.  This pass moves only invariants that
8474 are hard to handle at RTL level (function calls, operations that expand to
8475 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8476 operands of conditions that are invariant out of the loop, so that we can use
8477 just trivial invariantness analysis in loop unswitching.  The pass also includes
8478 store motion.
8480 @item -ftree-loop-ivcanon
8481 @opindex ftree-loop-ivcanon
8482 Create a canonical counter for number of iterations in loops for which
8483 determining number of iterations requires complicated analysis.  Later
8484 optimizations then may determine the number easily.  Useful especially
8485 in connection with unrolling.
8487 @item -fivopts
8488 @opindex fivopts
8489 Perform induction variable optimizations (strength reduction, induction
8490 variable merging and induction variable elimination) on trees.
8492 @item -ftree-parallelize-loops=n
8493 @opindex ftree-parallelize-loops
8494 Parallelize loops, i.e., split their iteration space to run in n threads.
8495 This is only possible for loops whose iterations are independent
8496 and can be arbitrarily reordered.  The optimization is only
8497 profitable on multiprocessor machines, for loops that are CPU-intensive,
8498 rather than constrained e.g.@: by memory bandwidth.  This option
8499 implies @option{-pthread}, and thus is only supported on targets
8500 that have support for @option{-pthread}.
8502 @item -ftree-pta
8503 @opindex ftree-pta
8504 Perform function-local points-to analysis on trees.  This flag is
8505 enabled by default at @option{-O} and higher.
8507 @item -ftree-sra
8508 @opindex ftree-sra
8509 Perform scalar replacement of aggregates.  This pass replaces structure
8510 references with scalars to prevent committing structures to memory too
8511 early.  This flag is enabled by default at @option{-O} and higher.
8513 @item -fstore-merging
8514 @opindex fstore-merging
8515 Perform merging of narrow stores to consecutive memory addresses.  This pass
8516 merges contiguous stores of immediate values narrower than a word into fewer
8517 wider stores to reduce the number of instructions.  This is enabled by default
8518 at @option{-O2} and higher as well as @option{-Os}.
8520 @item -ftree-ter
8521 @opindex ftree-ter
8522 Perform temporary expression replacement during the SSA->normal phase.  Single
8523 use/single def temporaries are replaced at their use location with their
8524 defining expression.  This results in non-GIMPLE code, but gives the expanders
8525 much more complex trees to work on resulting in better RTL generation.  This is
8526 enabled by default at @option{-O} and higher.
8528 @item -ftree-slsr
8529 @opindex ftree-slsr
8530 Perform straight-line strength reduction on trees.  This recognizes related
8531 expressions involving multiplications and replaces them by less expensive
8532 calculations when possible.  This is enabled by default at @option{-O} and
8533 higher.
8535 @item -ftree-vectorize
8536 @opindex ftree-vectorize
8537 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8538 and @option{-ftree-slp-vectorize} if not explicitly specified.
8540 @item -ftree-loop-vectorize
8541 @opindex ftree-loop-vectorize
8542 Perform loop vectorization on trees. This flag is enabled by default at
8543 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8545 @item -ftree-slp-vectorize
8546 @opindex ftree-slp-vectorize
8547 Perform basic block vectorization on trees. This flag is enabled by default at
8548 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8550 @item -fvect-cost-model=@var{model}
8551 @opindex fvect-cost-model
8552 Alter the cost model used for vectorization.  The @var{model} argument
8553 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8554 With the @samp{unlimited} model the vectorized code-path is assumed
8555 to be profitable while with the @samp{dynamic} model a runtime check
8556 guards the vectorized code-path to enable it only for iteration
8557 counts that will likely execute faster than when executing the original
8558 scalar loop.  The @samp{cheap} model disables vectorization of
8559 loops where doing so would be cost prohibitive for example due to
8560 required runtime checks for data dependence or alignment but otherwise
8561 is equal to the @samp{dynamic} model.
8562 The default cost model depends on other optimization flags and is
8563 either @samp{dynamic} or @samp{cheap}.
8565 @item -fsimd-cost-model=@var{model}
8566 @opindex fsimd-cost-model
8567 Alter the cost model used for vectorization of loops marked with the OpenMP
8568 or Cilk Plus simd directive.  The @var{model} argument should be one of
8569 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8570 have the same meaning as described in @option{-fvect-cost-model} and by
8571 default a cost model defined with @option{-fvect-cost-model} is used.
8573 @item -ftree-vrp
8574 @opindex ftree-vrp
8575 Perform Value Range Propagation on trees.  This is similar to the
8576 constant propagation pass, but instead of values, ranges of values are
8577 propagated.  This allows the optimizers to remove unnecessary range
8578 checks like array bound checks and null pointer checks.  This is
8579 enabled by default at @option{-O2} and higher.  Null pointer check
8580 elimination is only done if @option{-fdelete-null-pointer-checks} is
8581 enabled.
8583 @item -fsplit-paths
8584 @opindex fsplit-paths
8585 Split paths leading to loop backedges.  This can improve dead code
8586 elimination and common subexpression elimination.  This is enabled by
8587 default at @option{-O2} and above.
8589 @item -fsplit-ivs-in-unroller
8590 @opindex fsplit-ivs-in-unroller
8591 Enables expression of values of induction variables in later iterations
8592 of the unrolled loop using the value in the first iteration.  This breaks
8593 long dependency chains, thus improving efficiency of the scheduling passes.
8595 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8596 same effect.  However, that is not reliable in cases where the loop body
8597 is more complicated than a single basic block.  It also does not work at all
8598 on some architectures due to restrictions in the CSE pass.
8600 This optimization is enabled by default.
8602 @item -fvariable-expansion-in-unroller
8603 @opindex fvariable-expansion-in-unroller
8604 With this option, the compiler creates multiple copies of some
8605 local variables when unrolling a loop, which can result in superior code.
8607 @item -fpartial-inlining
8608 @opindex fpartial-inlining
8609 Inline parts of functions.  This option has any effect only
8610 when inlining itself is turned on by the @option{-finline-functions}
8611 or @option{-finline-small-functions} options.
8613 Enabled at level @option{-O2}.
8615 @item -fpredictive-commoning
8616 @opindex fpredictive-commoning
8617 Perform predictive commoning optimization, i.e., reusing computations
8618 (especially memory loads and stores) performed in previous
8619 iterations of loops.
8621 This option is enabled at level @option{-O3}.
8623 @item -fprefetch-loop-arrays
8624 @opindex fprefetch-loop-arrays
8625 If supported by the target machine, generate instructions to prefetch
8626 memory to improve the performance of loops that access large arrays.
8628 This option may generate better or worse code; results are highly
8629 dependent on the structure of loops within the source code.
8631 Disabled at level @option{-Os}.
8633 @item -fno-printf-return-value
8634 @opindex fno-printf-return-value
8635 Do not substitute constants for known return value of formatted output
8636 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8637 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8638 transformation allows GCC to optimize or even eliminate branches based
8639 on the known return value of these functions called with arguments that
8640 are either constant, or whose values are known to be in a range that
8641 makes determining the exact return value possible.  For example, when
8642 @option{-fprintf-return-value} is in effect, both the branch and the
8643 body of the @code{if} statement (but not the call to @code{snprint})
8644 can be optimized away when @code{i} is a 32-bit or smaller integer
8645 because the return value is guaranteed to be at most 8.
8647 @smallexample
8648 char buf[9];
8649 if (snprintf (buf, "%08x", i) >= sizeof buf)
8650   @dots{}
8651 @end smallexample
8653 The @option{-fprintf-return-value} option relies on other optimizations
8654 and yields best results with @option{-O2}.  It works in tandem with the
8655 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8656 The @option{-fprintf-return-value} option is enabled by default.
8658 @item -fno-peephole
8659 @itemx -fno-peephole2
8660 @opindex fno-peephole
8661 @opindex fno-peephole2
8662 Disable any machine-specific peephole optimizations.  The difference
8663 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8664 are implemented in the compiler; some targets use one, some use the
8665 other, a few use both.
8667 @option{-fpeephole} is enabled by default.
8668 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8670 @item -fno-guess-branch-probability
8671 @opindex fno-guess-branch-probability
8672 Do not guess branch probabilities using heuristics.
8674 GCC uses heuristics to guess branch probabilities if they are
8675 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8676 heuristics are based on the control flow graph.  If some branch probabilities
8677 are specified by @code{__builtin_expect}, then the heuristics are
8678 used to guess branch probabilities for the rest of the control flow graph,
8679 taking the @code{__builtin_expect} info into account.  The interactions
8680 between the heuristics and @code{__builtin_expect} can be complex, and in
8681 some cases, it may be useful to disable the heuristics so that the effects
8682 of @code{__builtin_expect} are easier to understand.
8684 The default is @option{-fguess-branch-probability} at levels
8685 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8687 @item -freorder-blocks
8688 @opindex freorder-blocks
8689 Reorder basic blocks in the compiled function in order to reduce number of
8690 taken branches and improve code locality.
8692 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8694 @item -freorder-blocks-algorithm=@var{algorithm}
8695 @opindex freorder-blocks-algorithm
8696 Use the specified algorithm for basic block reordering.  The
8697 @var{algorithm} argument can be @samp{simple}, which does not increase
8698 code size (except sometimes due to secondary effects like alignment),
8699 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8700 put all often executed code together, minimizing the number of branches
8701 executed by making extra copies of code.
8703 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8704 @samp{stc} at levels @option{-O2}, @option{-O3}.
8706 @item -freorder-blocks-and-partition
8707 @opindex freorder-blocks-and-partition
8708 In addition to reordering basic blocks in the compiled function, in order
8709 to reduce number of taken branches, partitions hot and cold basic blocks
8710 into separate sections of the assembly and @file{.o} files, to improve
8711 paging and cache locality performance.
8713 This optimization is automatically turned off in the presence of
8714 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8715 section attribute and on any architecture that does not support named
8716 sections.  When @option{-fsplit-stack} is used this option is not
8717 enabled by default (to avoid linker errors), but may be enabled
8718 explicitly (if using a working linker).
8720 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8722 @item -freorder-functions
8723 @opindex freorder-functions
8724 Reorder functions in the object file in order to
8725 improve code locality.  This is implemented by using special
8726 subsections @code{.text.hot} for most frequently executed functions and
8727 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8728 the linker so object file format must support named sections and linker must
8729 place them in a reasonable way.
8731 Also profile feedback must be available to make this option effective.  See
8732 @option{-fprofile-arcs} for details.
8734 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8736 @item -fstrict-aliasing
8737 @opindex fstrict-aliasing
8738 Allow the compiler to assume the strictest aliasing rules applicable to
8739 the language being compiled.  For C (and C++), this activates
8740 optimizations based on the type of expressions.  In particular, an
8741 object of one type is assumed never to reside at the same address as an
8742 object of a different type, unless the types are almost the same.  For
8743 example, an @code{unsigned int} can alias an @code{int}, but not a
8744 @code{void*} or a @code{double}.  A character type may alias any other
8745 type.
8747 @anchor{Type-punning}Pay special attention to code like this:
8748 @smallexample
8749 union a_union @{
8750   int i;
8751   double d;
8754 int f() @{
8755   union a_union t;
8756   t.d = 3.0;
8757   return t.i;
8759 @end smallexample
8760 The practice of reading from a different union member than the one most
8761 recently written to (called ``type-punning'') is common.  Even with
8762 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8763 is accessed through the union type.  So, the code above works as
8764 expected.  @xref{Structures unions enumerations and bit-fields
8765 implementation}.  However, this code might not:
8766 @smallexample
8767 int f() @{
8768   union a_union t;
8769   int* ip;
8770   t.d = 3.0;
8771   ip = &t.i;
8772   return *ip;
8774 @end smallexample
8776 Similarly, access by taking the address, casting the resulting pointer
8777 and dereferencing the result has undefined behavior, even if the cast
8778 uses a union type, e.g.:
8779 @smallexample
8780 int f() @{
8781   double d = 3.0;
8782   return ((union a_union *) &d)->i;
8784 @end smallexample
8786 The @option{-fstrict-aliasing} option is enabled at levels
8787 @option{-O2}, @option{-O3}, @option{-Os}.
8789 @item -falign-functions
8790 @itemx -falign-functions=@var{n}
8791 @opindex falign-functions
8792 Align the start of functions to the next power-of-two greater than
8793 @var{n}, skipping up to @var{n} bytes.  For instance,
8794 @option{-falign-functions=32} aligns functions to the next 32-byte
8795 boundary, but @option{-falign-functions=24} aligns to the next
8796 32-byte boundary only if this can be done by skipping 23 bytes or less.
8798 @option{-fno-align-functions} and @option{-falign-functions=1} are
8799 equivalent and mean that functions are not aligned.
8801 Some assemblers only support this flag when @var{n} is a power of two;
8802 in that case, it is rounded up.
8804 If @var{n} is not specified or is zero, use a machine-dependent default.
8806 Enabled at levels @option{-O2}, @option{-O3}.
8808 @item -flimit-function-alignment
8809 If this option is enabled, the compiler tries to avoid unnecessarily
8810 overaligning functions. It attempts to instruct the assembler to align
8811 by the amount specified by @option{-falign-functions}, but not to
8812 skip more bytes than the size of the function.
8814 @item -falign-labels
8815 @itemx -falign-labels=@var{n}
8816 @opindex falign-labels
8817 Align all branch targets to a power-of-two boundary, skipping up to
8818 @var{n} bytes like @option{-falign-functions}.  This option can easily
8819 make code slower, because it must insert dummy operations for when the
8820 branch target is reached in the usual flow of the code.
8822 @option{-fno-align-labels} and @option{-falign-labels=1} are
8823 equivalent and mean that labels are not aligned.
8825 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8826 are greater than this value, then their values are used instead.
8828 If @var{n} is not specified or is zero, use a machine-dependent default
8829 which is very likely to be @samp{1}, meaning no alignment.
8831 Enabled at levels @option{-O2}, @option{-O3}.
8833 @item -falign-loops
8834 @itemx -falign-loops=@var{n}
8835 @opindex falign-loops
8836 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8837 like @option{-falign-functions}.  If the loops are
8838 executed many times, this makes up for any execution of the dummy
8839 operations.
8841 @option{-fno-align-loops} and @option{-falign-loops=1} are
8842 equivalent and mean that loops are not aligned.
8844 If @var{n} is not specified or is zero, use a machine-dependent default.
8846 Enabled at levels @option{-O2}, @option{-O3}.
8848 @item -falign-jumps
8849 @itemx -falign-jumps=@var{n}
8850 @opindex falign-jumps
8851 Align branch targets to a power-of-two boundary, for branch targets
8852 where the targets can only be reached by jumping, skipping up to @var{n}
8853 bytes like @option{-falign-functions}.  In this case, no dummy operations
8854 need be executed.
8856 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8857 equivalent and mean that loops are not aligned.
8859 If @var{n} is not specified or is zero, use a machine-dependent default.
8861 Enabled at levels @option{-O2}, @option{-O3}.
8863 @item -funit-at-a-time
8864 @opindex funit-at-a-time
8865 This option is left for compatibility reasons. @option{-funit-at-a-time}
8866 has no effect, while @option{-fno-unit-at-a-time} implies
8867 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8869 Enabled by default.
8871 @item -fno-toplevel-reorder
8872 @opindex fno-toplevel-reorder
8873 Do not reorder top-level functions, variables, and @code{asm}
8874 statements.  Output them in the same order that they appear in the
8875 input file.  When this option is used, unreferenced static variables
8876 are not removed.  This option is intended to support existing code
8877 that relies on a particular ordering.  For new code, it is better to
8878 use attributes when possible.
8880 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8881 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8882 targets.
8884 @item -fweb
8885 @opindex fweb
8886 Constructs webs as commonly used for register allocation purposes and assign
8887 each web individual pseudo register.  This allows the register allocation pass
8888 to operate on pseudos directly, but also strengthens several other optimization
8889 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8890 however, make debugging impossible, since variables no longer stay in a
8891 ``home register''.
8893 Enabled by default with @option{-funroll-loops}.
8895 @item -fwhole-program
8896 @opindex fwhole-program
8897 Assume that the current compilation unit represents the whole program being
8898 compiled.  All public functions and variables with the exception of @code{main}
8899 and those merged by attribute @code{externally_visible} become static functions
8900 and in effect are optimized more aggressively by interprocedural optimizers.
8902 This option should not be used in combination with @option{-flto}.
8903 Instead relying on a linker plugin should provide safer and more precise
8904 information.
8906 @item -flto[=@var{n}]
8907 @opindex flto
8908 This option runs the standard link-time optimizer.  When invoked
8909 with source code, it generates GIMPLE (one of GCC's internal
8910 representations) and writes it to special ELF sections in the object
8911 file.  When the object files are linked together, all the function
8912 bodies are read from these ELF sections and instantiated as if they
8913 had been part of the same translation unit.
8915 To use the link-time optimizer, @option{-flto} and optimization
8916 options should be specified at compile time and during the final link.
8917 It is recommended that you compile all the files participating in the
8918 same link with the same options and also specify those options at
8919 link time.  
8920 For example:
8922 @smallexample
8923 gcc -c -O2 -flto foo.c
8924 gcc -c -O2 -flto bar.c
8925 gcc -o myprog -flto -O2 foo.o bar.o
8926 @end smallexample
8928 The first two invocations to GCC save a bytecode representation
8929 of GIMPLE into special ELF sections inside @file{foo.o} and
8930 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8931 @file{foo.o} and @file{bar.o}, merges the two files into a single
8932 internal image, and compiles the result as usual.  Since both
8933 @file{foo.o} and @file{bar.o} are merged into a single image, this
8934 causes all the interprocedural analyses and optimizations in GCC to
8935 work across the two files as if they were a single one.  This means,
8936 for example, that the inliner is able to inline functions in
8937 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8939 Another (simpler) way to enable link-time optimization is:
8941 @smallexample
8942 gcc -o myprog -flto -O2 foo.c bar.c
8943 @end smallexample
8945 The above generates bytecode for @file{foo.c} and @file{bar.c},
8946 merges them together into a single GIMPLE representation and optimizes
8947 them as usual to produce @file{myprog}.
8949 The only important thing to keep in mind is that to enable link-time
8950 optimizations you need to use the GCC driver to perform the link step.
8951 GCC then automatically performs link-time optimization if any of the
8952 objects involved were compiled with the @option{-flto} command-line option.  
8953 You generally
8954 should specify the optimization options to be used for link-time
8955 optimization though GCC tries to be clever at guessing an
8956 optimization level to use from the options used at compile time
8957 if you fail to specify one at link time.  You can always override
8958 the automatic decision to do link-time optimization
8959 by passing @option{-fno-lto} to the link command.
8961 To make whole program optimization effective, it is necessary to make
8962 certain whole program assumptions.  The compiler needs to know
8963 what functions and variables can be accessed by libraries and runtime
8964 outside of the link-time optimized unit.  When supported by the linker,
8965 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8966 to the compiler about used and externally visible symbols.  When
8967 the linker plugin is not available, @option{-fwhole-program} should be
8968 used to allow the compiler to make these assumptions, which leads
8969 to more aggressive optimization decisions.
8971 When @option{-fuse-linker-plugin} is not enabled, when a file is
8972 compiled with @option{-flto}, the generated object file is larger than
8973 a regular object file because it contains GIMPLE bytecodes and the usual
8974 final code (see @option{-ffat-lto-objects}.  This means that
8975 object files with LTO information can be linked as normal object
8976 files; if @option{-fno-lto} is passed to the linker, no
8977 interprocedural optimizations are applied.  Note that when
8978 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8979 but you cannot perform a regular, non-LTO link on them.
8981 Additionally, the optimization flags used to compile individual files
8982 are not necessarily related to those used at link time.  For instance,
8984 @smallexample
8985 gcc -c -O0 -ffat-lto-objects -flto foo.c
8986 gcc -c -O0 -ffat-lto-objects -flto bar.c
8987 gcc -o myprog -O3 foo.o bar.o
8988 @end smallexample
8990 This produces individual object files with unoptimized assembler
8991 code, but the resulting binary @file{myprog} is optimized at
8992 @option{-O3}.  If, instead, the final binary is generated with
8993 @option{-fno-lto}, then @file{myprog} is not optimized.
8995 When producing the final binary, GCC only
8996 applies link-time optimizations to those files that contain bytecode.
8997 Therefore, you can mix and match object files and libraries with
8998 GIMPLE bytecodes and final object code.  GCC automatically selects
8999 which files to optimize in LTO mode and which files to link without
9000 further processing.
9002 There are some code generation flags preserved by GCC when
9003 generating bytecodes, as they need to be used during the final link
9004 stage.  Generally options specified at link time override those
9005 specified at compile time.
9007 If you do not specify an optimization level option @option{-O} at
9008 link time, then GCC uses the highest optimization level 
9009 used when compiling the object files.
9011 Currently, the following options and their settings are taken from
9012 the first object file that explicitly specifies them: 
9013 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9014 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9015 and all the @option{-m} target flags.
9017 Certain ABI-changing flags are required to match in all compilation units,
9018 and trying to override this at link time with a conflicting value
9019 is ignored.  This includes options such as @option{-freg-struct-return}
9020 and @option{-fpcc-struct-return}. 
9022 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9023 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9024 are passed through to the link stage and merged conservatively for
9025 conflicting translation units.  Specifically
9026 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9027 precedence; and for example @option{-ffp-contract=off} takes precedence
9028 over @option{-ffp-contract=fast}.  You can override them at link time.
9030 If LTO encounters objects with C linkage declared with incompatible
9031 types in separate translation units to be linked together (undefined
9032 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9033 issued.  The behavior is still undefined at run time.  Similar
9034 diagnostics may be raised for other languages.
9036 Another feature of LTO is that it is possible to apply interprocedural
9037 optimizations on files written in different languages:
9039 @smallexample
9040 gcc -c -flto foo.c
9041 g++ -c -flto bar.cc
9042 gfortran -c -flto baz.f90
9043 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9044 @end smallexample
9046 Notice that the final link is done with @command{g++} to get the C++
9047 runtime libraries and @option{-lgfortran} is added to get the Fortran
9048 runtime libraries.  In general, when mixing languages in LTO mode, you
9049 should use the same link command options as when mixing languages in a
9050 regular (non-LTO) compilation.
9052 If object files containing GIMPLE bytecode are stored in a library archive, say
9053 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9054 are using a linker with plugin support.  To create static libraries suitable
9055 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9056 and @command{ranlib}; 
9057 to show the symbols of object files with GIMPLE bytecode, use
9058 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9059 and @command{nm} have been compiled with plugin support.  At link time, use the the
9060 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9061 the LTO optimization process:
9063 @smallexample
9064 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9065 @end smallexample
9067 With the linker plugin enabled, the linker extracts the needed
9068 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9069 to make them part of the aggregated GIMPLE image to be optimized.
9071 If you are not using a linker with plugin support and/or do not
9072 enable the linker plugin, then the objects inside @file{libfoo.a}
9073 are extracted and linked as usual, but they do not participate
9074 in the LTO optimization process.  In order to make a static library suitable
9075 for both LTO optimization and usual linkage, compile its object files with
9076 @option{-flto} @option{-ffat-lto-objects}.
9078 Link-time optimizations do not require the presence of the whole program to
9079 operate.  If the program does not require any symbols to be exported, it is
9080 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9081 the interprocedural optimizers to use more aggressive assumptions which may
9082 lead to improved optimization opportunities.
9083 Use of @option{-fwhole-program} is not needed when linker plugin is
9084 active (see @option{-fuse-linker-plugin}).
9086 The current implementation of LTO makes no
9087 attempt to generate bytecode that is portable between different
9088 types of hosts.  The bytecode files are versioned and there is a
9089 strict version check, so bytecode files generated in one version of
9090 GCC do not work with an older or newer version of GCC.
9092 Link-time optimization does not work well with generation of debugging
9093 information.  Combining @option{-flto} with
9094 @option{-g} is currently experimental and expected to produce unexpected
9095 results.
9097 If you specify the optional @var{n}, the optimization and code
9098 generation done at link time is executed in parallel using @var{n}
9099 parallel jobs by utilizing an installed @command{make} program.  The
9100 environment variable @env{MAKE} may be used to override the program
9101 used.  The default value for @var{n} is 1.
9103 You can also specify @option{-flto=jobserver} to use GNU make's
9104 job server mode to determine the number of parallel jobs. This
9105 is useful when the Makefile calling GCC is already executing in parallel.
9106 You must prepend a @samp{+} to the command recipe in the parent Makefile
9107 for this to work.  This option likely only works if @env{MAKE} is
9108 GNU make.
9110 @item -flto-partition=@var{alg}
9111 @opindex flto-partition
9112 Specify the partitioning algorithm used by the link-time optimizer.
9113 The value is either @samp{1to1} to specify a partitioning mirroring
9114 the original source files or @samp{balanced} to specify partitioning
9115 into equally sized chunks (whenever possible) or @samp{max} to create
9116 new partition for every symbol where possible.  Specifying @samp{none}
9117 as an algorithm disables partitioning and streaming completely. 
9118 The default value is @samp{balanced}. While @samp{1to1} can be used
9119 as an workaround for various code ordering issues, the @samp{max}
9120 partitioning is intended for internal testing only.
9121 The value @samp{one} specifies that exactly one partition should be
9122 used while the value @samp{none} bypasses partitioning and executes
9123 the link-time optimization step directly from the WPA phase.
9125 @item -flto-odr-type-merging
9126 @opindex flto-odr-type-merging
9127 Enable streaming of mangled types names of C++ types and their unification
9128 at link time.  This increases size of LTO object files, but enables
9129 diagnostics about One Definition Rule violations.
9131 @item -flto-compression-level=@var{n}
9132 @opindex flto-compression-level
9133 This option specifies the level of compression used for intermediate
9134 language written to LTO object files, and is only meaningful in
9135 conjunction with LTO mode (@option{-flto}).  Valid
9136 values are 0 (no compression) to 9 (maximum compression).  Values
9137 outside this range are clamped to either 0 or 9.  If the option is not
9138 given, a default balanced compression setting is used.
9140 @item -fuse-linker-plugin
9141 @opindex fuse-linker-plugin
9142 Enables the use of a linker plugin during link-time optimization.  This
9143 option relies on plugin support in the linker, which is available in gold
9144 or in GNU ld 2.21 or newer.
9146 This option enables the extraction of object files with GIMPLE bytecode out
9147 of library archives. This improves the quality of optimization by exposing
9148 more code to the link-time optimizer.  This information specifies what
9149 symbols can be accessed externally (by non-LTO object or during dynamic
9150 linking).  Resulting code quality improvements on binaries (and shared
9151 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9152 See @option{-flto} for a description of the effect of this flag and how to
9153 use it.
9155 This option is enabled by default when LTO support in GCC is enabled
9156 and GCC was configured for use with
9157 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9159 @item -ffat-lto-objects
9160 @opindex ffat-lto-objects
9161 Fat LTO objects are object files that contain both the intermediate language
9162 and the object code. This makes them usable for both LTO linking and normal
9163 linking. This option is effective only when compiling with @option{-flto}
9164 and is ignored at link time.
9166 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9167 requires the complete toolchain to be aware of LTO. It requires a linker with
9168 linker plugin support for basic functionality.  Additionally,
9169 @command{nm}, @command{ar} and @command{ranlib}
9170 need to support linker plugins to allow a full-featured build environment
9171 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9172 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9173 to these tools. With non fat LTO makefiles need to be modified to use them.
9175 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9176 support.
9178 @item -fcompare-elim
9179 @opindex fcompare-elim
9180 After register allocation and post-register allocation instruction splitting,
9181 identify arithmetic instructions that compute processor flags similar to a
9182 comparison operation based on that arithmetic.  If possible, eliminate the
9183 explicit comparison operation.
9185 This pass only applies to certain targets that cannot explicitly represent
9186 the comparison operation before register allocation is complete.
9188 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9190 @item -fcprop-registers
9191 @opindex fcprop-registers
9192 After register allocation and post-register allocation instruction splitting,
9193 perform a copy-propagation pass to try to reduce scheduling dependencies
9194 and occasionally eliminate the copy.
9196 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9198 @item -fprofile-correction
9199 @opindex fprofile-correction
9200 Profiles collected using an instrumented binary for multi-threaded programs may
9201 be inconsistent due to missed counter updates. When this option is specified,
9202 GCC uses heuristics to correct or smooth out such inconsistencies. By
9203 default, GCC emits an error message when an inconsistent profile is detected.
9205 @item -fprofile-use
9206 @itemx -fprofile-use=@var{path}
9207 @opindex fprofile-use
9208 Enable profile feedback-directed optimizations, 
9209 and the following optimizations
9210 which are generally profitable only with profile feedback available:
9211 @option{-fbranch-probabilities}, @option{-fvpt},
9212 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9213 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9215 Before you can use this option, you must first generate profiling information.
9216 @xref{Instrumentation Options}, for information about the
9217 @option{-fprofile-generate} option.
9219 By default, GCC emits an error message if the feedback profiles do not
9220 match the source code.  This error can be turned into a warning by using
9221 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9222 code.
9224 If @var{path} is specified, GCC looks at the @var{path} to find
9225 the profile feedback data files. See @option{-fprofile-dir}.
9227 @item -fauto-profile
9228 @itemx -fauto-profile=@var{path}
9229 @opindex fauto-profile
9230 Enable sampling-based feedback-directed optimizations, 
9231 and the following optimizations
9232 which are generally profitable only with profile feedback available:
9233 @option{-fbranch-probabilities}, @option{-fvpt},
9234 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9235 @option{-ftree-vectorize},
9236 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9237 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9238 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9240 @var{path} is the name of a file containing AutoFDO profile information.
9241 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9243 Producing an AutoFDO profile data file requires running your program
9244 with the @command{perf} utility on a supported GNU/Linux target system.
9245 For more information, see @uref{https://perf.wiki.kernel.org/}.
9247 E.g.
9248 @smallexample
9249 perf record -e br_inst_retired:near_taken -b -o perf.data \
9250     -- your_program
9251 @end smallexample
9253 Then use the @command{create_gcov} tool to convert the raw profile data
9254 to a format that can be used by GCC.@  You must also supply the 
9255 unstripped binary for your program to this tool.  
9256 See @uref{https://github.com/google/autofdo}.
9258 E.g.
9259 @smallexample
9260 create_gcov --binary=your_program.unstripped --profile=perf.data \
9261     --gcov=profile.afdo
9262 @end smallexample
9263 @end table
9265 The following options control compiler behavior regarding floating-point 
9266 arithmetic.  These options trade off between speed and
9267 correctness.  All must be specifically enabled.
9269 @table @gcctabopt
9270 @item -ffloat-store
9271 @opindex ffloat-store
9272 Do not store floating-point variables in registers, and inhibit other
9273 options that might change whether a floating-point value is taken from a
9274 register or memory.
9276 @cindex floating-point precision
9277 This option prevents undesirable excess precision on machines such as
9278 the 68000 where the floating registers (of the 68881) keep more
9279 precision than a @code{double} is supposed to have.  Similarly for the
9280 x86 architecture.  For most programs, the excess precision does only
9281 good, but a few programs rely on the precise definition of IEEE floating
9282 point.  Use @option{-ffloat-store} for such programs, after modifying
9283 them to store all pertinent intermediate computations into variables.
9285 @item -fexcess-precision=@var{style}
9286 @opindex fexcess-precision
9287 This option allows further control over excess precision on machines
9288 where floating-point operations occur in a format with more precision or
9289 range than the IEEE standard and interchange floating-point types.  By
9290 default, @option{-fexcess-precision=fast} is in effect; this means that
9291 operations may be carried out in a wider precision than the types specified
9292 in the source if that would result in faster code, and it is unpredictable
9293 when rounding to the types specified in the source code takes place.
9294 When compiling C, if @option{-fexcess-precision=standard} is specified then
9295 excess precision follows the rules specified in ISO C99; in particular,
9296 both casts and assignments cause values to be rounded to their
9297 semantic types (whereas @option{-ffloat-store} only affects
9298 assignments).  This option is enabled by default for C if a strict
9299 conformance option such as @option{-std=c99} is used.
9300 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9301 regardless of whether a strict conformance option is used.
9303 @opindex mfpmath
9304 @option{-fexcess-precision=standard} is not implemented for languages
9305 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9306 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9307 semantics apply without excess precision, and in the latter, rounding
9308 is unpredictable.
9310 @item -ffast-math
9311 @opindex ffast-math
9312 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9313 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9314 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9315 @option{-fexcess-precision=fast}.
9317 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9319 This option is not turned on by any @option{-O} option besides
9320 @option{-Ofast} since it can result in incorrect output for programs
9321 that depend on an exact implementation of IEEE or ISO rules/specifications
9322 for math functions. It may, however, yield faster code for programs
9323 that do not require the guarantees of these specifications.
9325 @item -fno-math-errno
9326 @opindex fno-math-errno
9327 Do not set @code{errno} after calling math functions that are executed
9328 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9329 IEEE exceptions for math error handling may want to use this flag
9330 for speed while maintaining IEEE arithmetic compatibility.
9332 This option is not turned on by any @option{-O} option since
9333 it can result in incorrect output for programs that depend on
9334 an exact implementation of IEEE or ISO rules/specifications for
9335 math functions. It may, however, yield faster code for programs
9336 that do not require the guarantees of these specifications.
9338 The default is @option{-fmath-errno}.
9340 On Darwin systems, the math library never sets @code{errno}.  There is
9341 therefore no reason for the compiler to consider the possibility that
9342 it might, and @option{-fno-math-errno} is the default.
9344 @item -funsafe-math-optimizations
9345 @opindex funsafe-math-optimizations
9347 Allow optimizations for floating-point arithmetic that (a) assume
9348 that arguments and results are valid and (b) may violate IEEE or
9349 ANSI standards.  When used at link time, it may include libraries
9350 or startup files that change the default FPU control word or other
9351 similar optimizations.
9353 This option is not turned on by any @option{-O} option since
9354 it can result in incorrect output for programs that depend on
9355 an exact implementation of IEEE or ISO rules/specifications for
9356 math functions. It may, however, yield faster code for programs
9357 that do not require the guarantees of these specifications.
9358 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9359 @option{-fassociative-math} and @option{-freciprocal-math}.
9361 The default is @option{-fno-unsafe-math-optimizations}.
9363 @item -fassociative-math
9364 @opindex fassociative-math
9366 Allow re-association of operands in series of floating-point operations.
9367 This violates the ISO C and C++ language standard by possibly changing
9368 computation result.  NOTE: re-ordering may change the sign of zero as
9369 well as ignore NaNs and inhibit or create underflow or overflow (and
9370 thus cannot be used on code that relies on rounding behavior like
9371 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9372 and thus may not be used when ordered comparisons are required.
9373 This option requires that both @option{-fno-signed-zeros} and
9374 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9375 much sense with @option{-frounding-math}. For Fortran the option
9376 is automatically enabled when both @option{-fno-signed-zeros} and
9377 @option{-fno-trapping-math} are in effect.
9379 The default is @option{-fno-associative-math}.
9381 @item -freciprocal-math
9382 @opindex freciprocal-math
9384 Allow the reciprocal of a value to be used instead of dividing by
9385 the value if this enables optimizations.  For example @code{x / y}
9386 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9387 is subject to common subexpression elimination.  Note that this loses
9388 precision and increases the number of flops operating on the value.
9390 The default is @option{-fno-reciprocal-math}.
9392 @item -ffinite-math-only
9393 @opindex ffinite-math-only
9394 Allow optimizations for floating-point arithmetic that assume
9395 that arguments and results are not NaNs or +-Infs.
9397 This option is not turned on by any @option{-O} option since
9398 it can result in incorrect output for programs that depend on
9399 an exact implementation of IEEE or ISO rules/specifications for
9400 math functions. It may, however, yield faster code for programs
9401 that do not require the guarantees of these specifications.
9403 The default is @option{-fno-finite-math-only}.
9405 @item -fno-signed-zeros
9406 @opindex fno-signed-zeros
9407 Allow optimizations for floating-point arithmetic that ignore the
9408 signedness of zero.  IEEE arithmetic specifies the behavior of
9409 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9410 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9411 This option implies that the sign of a zero result isn't significant.
9413 The default is @option{-fsigned-zeros}.
9415 @item -fno-trapping-math
9416 @opindex fno-trapping-math
9417 Compile code assuming that floating-point operations cannot generate
9418 user-visible traps.  These traps include division by zero, overflow,
9419 underflow, inexact result and invalid operation.  This option requires
9420 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9421 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9423 This option should never be turned on by any @option{-O} option since
9424 it can result in incorrect output for programs that depend on
9425 an exact implementation of IEEE or ISO rules/specifications for
9426 math functions.
9428 The default is @option{-ftrapping-math}.
9430 @item -frounding-math
9431 @opindex frounding-math
9432 Disable transformations and optimizations that assume default floating-point
9433 rounding behavior.  This is round-to-zero for all floating point
9434 to integer conversions, and round-to-nearest for all other arithmetic
9435 truncations.  This option should be specified for programs that change
9436 the FP rounding mode dynamically, or that may be executed with a
9437 non-default rounding mode.  This option disables constant folding of
9438 floating-point expressions at compile time (which may be affected by
9439 rounding mode) and arithmetic transformations that are unsafe in the
9440 presence of sign-dependent rounding modes.
9442 The default is @option{-fno-rounding-math}.
9444 This option is experimental and does not currently guarantee to
9445 disable all GCC optimizations that are affected by rounding mode.
9446 Future versions of GCC may provide finer control of this setting
9447 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9448 will be used to specify the default state for @code{FENV_ACCESS}.
9450 @item -fsignaling-nans
9451 @opindex fsignaling-nans
9452 Compile code assuming that IEEE signaling NaNs may generate user-visible
9453 traps during floating-point operations.  Setting this option disables
9454 optimizations that may change the number of exceptions visible with
9455 signaling NaNs.  This option implies @option{-ftrapping-math}.
9457 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9458 be defined.
9460 The default is @option{-fno-signaling-nans}.
9462 This option is experimental and does not currently guarantee to
9463 disable all GCC optimizations that affect signaling NaN behavior.
9465 @item -fno-fp-int-builtin-inexact
9466 @opindex fno-fp-int-builtin-inexact
9467 Do not allow the built-in functions @code{ceil}, @code{floor},
9468 @code{round} and @code{trunc}, and their @code{float} and @code{long
9469 double} variants, to generate code that raises the ``inexact''
9470 floating-point exception for noninteger arguments.  ISO C99 and C11
9471 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9472 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9473 functions to do so.
9475 The default is @option{-ffp-int-builtin-inexact}, allowing the
9476 exception to be raised.  This option does nothing unless
9477 @option{-ftrapping-math} is in effect.
9479 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9480 generate a call to a library function then the ``inexact'' exception
9481 may be raised if the library implementation does not follow TS 18661.
9483 @item -fsingle-precision-constant
9484 @opindex fsingle-precision-constant
9485 Treat floating-point constants as single precision instead of
9486 implicitly converting them to double-precision constants.
9488 @item -fcx-limited-range
9489 @opindex fcx-limited-range
9490 When enabled, this option states that a range reduction step is not
9491 needed when performing complex division.  Also, there is no checking
9492 whether the result of a complex multiplication or division is @code{NaN
9493 + I*NaN}, with an attempt to rescue the situation in that case.  The
9494 default is @option{-fno-cx-limited-range}, but is enabled by
9495 @option{-ffast-math}.
9497 This option controls the default setting of the ISO C99
9498 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9499 all languages.
9501 @item -fcx-fortran-rules
9502 @opindex fcx-fortran-rules
9503 Complex multiplication and division follow Fortran rules.  Range
9504 reduction is done as part of complex division, but there is no checking
9505 whether the result of a complex multiplication or division is @code{NaN
9506 + I*NaN}, with an attempt to rescue the situation in that case.
9508 The default is @option{-fno-cx-fortran-rules}.
9510 @end table
9512 The following options control optimizations that may improve
9513 performance, but are not enabled by any @option{-O} options.  This
9514 section includes experimental options that may produce broken code.
9516 @table @gcctabopt
9517 @item -fbranch-probabilities
9518 @opindex fbranch-probabilities
9519 After running a program compiled with @option{-fprofile-arcs}
9520 (@pxref{Instrumentation Options}),
9521 you can compile it a second time using
9522 @option{-fbranch-probabilities}, to improve optimizations based on
9523 the number of times each branch was taken.  When a program
9524 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9525 counts to a file called @file{@var{sourcename}.gcda} for each source
9526 file.  The information in this data file is very dependent on the
9527 structure of the generated code, so you must use the same source code
9528 and the same optimization options for both compilations.
9530 With @option{-fbranch-probabilities}, GCC puts a
9531 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9532 These can be used to improve optimization.  Currently, they are only
9533 used in one place: in @file{reorg.c}, instead of guessing which path a
9534 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9535 exactly determine which path is taken more often.
9537 @item -fprofile-values
9538 @opindex fprofile-values
9539 If combined with @option{-fprofile-arcs}, it adds code so that some
9540 data about values of expressions in the program is gathered.
9542 With @option{-fbranch-probabilities}, it reads back the data gathered
9543 from profiling values of expressions for usage in optimizations.
9545 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9547 @item -fprofile-reorder-functions
9548 @opindex fprofile-reorder-functions
9549 Function reordering based on profile instrumentation collects
9550 first time of execution of a function and orders these functions
9551 in ascending order.
9553 Enabled with @option{-fprofile-use}.
9555 @item -fvpt
9556 @opindex fvpt
9557 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9558 to add code to gather information about values of expressions.
9560 With @option{-fbranch-probabilities}, it reads back the data gathered
9561 and actually performs the optimizations based on them.
9562 Currently the optimizations include specialization of division operations
9563 using the knowledge about the value of the denominator.
9565 @item -frename-registers
9566 @opindex frename-registers
9567 Attempt to avoid false dependencies in scheduled code by making use
9568 of registers left over after register allocation.  This optimization
9569 most benefits processors with lots of registers.  Depending on the
9570 debug information format adopted by the target, however, it can
9571 make debugging impossible, since variables no longer stay in
9572 a ``home register''.
9574 Enabled by default with @option{-funroll-loops}.
9576 @item -fschedule-fusion
9577 @opindex fschedule-fusion
9578 Performs a target dependent pass over the instruction stream to schedule
9579 instructions of same type together because target machine can execute them
9580 more efficiently if they are adjacent to each other in the instruction flow.
9582 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9584 @item -ftracer
9585 @opindex ftracer
9586 Perform tail duplication to enlarge superblock size.  This transformation
9587 simplifies the control flow of the function allowing other optimizations to do
9588 a better job.
9590 Enabled with @option{-fprofile-use}.
9592 @item -funroll-loops
9593 @opindex funroll-loops
9594 Unroll loops whose number of iterations can be determined at compile time or
9595 upon entry to the loop.  @option{-funroll-loops} implies
9596 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9597 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9598 a small constant number of iterations).  This option makes code larger, and may
9599 or may not make it run faster.
9601 Enabled with @option{-fprofile-use}.
9603 @item -funroll-all-loops
9604 @opindex funroll-all-loops
9605 Unroll all loops, even if their number of iterations is uncertain when
9606 the loop is entered.  This usually makes programs run more slowly.
9607 @option{-funroll-all-loops} implies the same options as
9608 @option{-funroll-loops}.
9610 @item -fpeel-loops
9611 @opindex fpeel-loops
9612 Peels loops for which there is enough information that they do not
9613 roll much (from profile feedback or static analysis).  It also turns on
9614 complete loop peeling (i.e.@: complete removal of loops with small constant
9615 number of iterations).
9617 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9619 @item -fmove-loop-invariants
9620 @opindex fmove-loop-invariants
9621 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9622 at level @option{-O1}
9624 @item -fsplit-loops
9625 @opindex fsplit-loops
9626 Split a loop into two if it contains a condition that's always true
9627 for one side of the iteration space and false for the other.
9629 @item -funswitch-loops
9630 @opindex funswitch-loops
9631 Move branches with loop invariant conditions out of the loop, with duplicates
9632 of the loop on both branches (modified according to result of the condition).
9634 @item -ffunction-sections
9635 @itemx -fdata-sections
9636 @opindex ffunction-sections
9637 @opindex fdata-sections
9638 Place each function or data item into its own section in the output
9639 file if the target supports arbitrary sections.  The name of the
9640 function or the name of the data item determines the section's name
9641 in the output file.
9643 Use these options on systems where the linker can perform optimizations
9644 to improve locality of reference in the instruction space.  Most systems
9645 using the ELF object format and SPARC processors running Solaris 2 have
9646 linkers with such optimizations.  AIX may have these optimizations in
9647 the future.
9649 Only use these options when there are significant benefits from doing
9650 so.  When you specify these options, the assembler and linker
9651 create larger object and executable files and are also slower.
9652 You cannot use @command{gprof} on all systems if you
9653 specify this option, and you may have problems with debugging if
9654 you specify both this option and @option{-g}.
9656 @item -fbranch-target-load-optimize
9657 @opindex fbranch-target-load-optimize
9658 Perform branch target register load optimization before prologue / epilogue
9659 threading.
9660 The use of target registers can typically be exposed only during reload,
9661 thus hoisting loads out of loops and doing inter-block scheduling needs
9662 a separate optimization pass.
9664 @item -fbranch-target-load-optimize2
9665 @opindex fbranch-target-load-optimize2
9666 Perform branch target register load optimization after prologue / epilogue
9667 threading.
9669 @item -fbtr-bb-exclusive
9670 @opindex fbtr-bb-exclusive
9671 When performing branch target register load optimization, don't reuse
9672 branch target registers within any basic block.
9674 @item -fstdarg-opt
9675 @opindex fstdarg-opt
9676 Optimize the prologue of variadic argument functions with respect to usage of
9677 those arguments.
9679 @item -fsection-anchors
9680 @opindex fsection-anchors
9681 Try to reduce the number of symbolic address calculations by using
9682 shared ``anchor'' symbols to address nearby objects.  This transformation
9683 can help to reduce the number of GOT entries and GOT accesses on some
9684 targets.
9686 For example, the implementation of the following function @code{foo}:
9688 @smallexample
9689 static int a, b, c;
9690 int foo (void) @{ return a + b + c; @}
9691 @end smallexample
9693 @noindent
9694 usually calculates the addresses of all three variables, but if you
9695 compile it with @option{-fsection-anchors}, it accesses the variables
9696 from a common anchor point instead.  The effect is similar to the
9697 following pseudocode (which isn't valid C):
9699 @smallexample
9700 int foo (void)
9702   register int *xr = &x;
9703   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9705 @end smallexample
9707 Not all targets support this option.
9709 @item --param @var{name}=@var{value}
9710 @opindex param
9711 In some places, GCC uses various constants to control the amount of
9712 optimization that is done.  For example, GCC does not inline functions
9713 that contain more than a certain number of instructions.  You can
9714 control some of these constants on the command line using the
9715 @option{--param} option.
9717 The names of specific parameters, and the meaning of the values, are
9718 tied to the internals of the compiler, and are subject to change
9719 without notice in future releases.
9721 In each case, the @var{value} is an integer.  The allowable choices for
9722 @var{name} are:
9724 @table @gcctabopt
9725 @item predictable-branch-outcome
9726 When branch is predicted to be taken with probability lower than this threshold
9727 (in percent), then it is considered well predictable. The default is 10.
9729 @item max-rtl-if-conversion-insns
9730 RTL if-conversion tries to remove conditional branches around a block and
9731 replace them with conditionally executed instructions.  This parameter
9732 gives the maximum number of instructions in a block which should be
9733 considered for if-conversion.  The default is 10, though the compiler will
9734 also use other heuristics to decide whether if-conversion is likely to be
9735 profitable.
9737 @item max-rtl-if-conversion-predictable-cost
9738 @item max-rtl-if-conversion-unpredictable-cost
9739 RTL if-conversion will try to remove conditional branches around a block
9740 and replace them with conditionally executed instructions.  These parameters
9741 give the maximum permissible cost for the sequence that would be generated
9742 by if-conversion depending on whether the branch is statically determined
9743 to be predictable or not.  The units for this parameter are the same as
9744 those for the GCC internal seq_cost metric.  The compiler will try to
9745 provide a reasonable default for this parameter using the BRANCH_COST
9746 target macro.
9748 @item max-crossjump-edges
9749 The maximum number of incoming edges to consider for cross-jumping.
9750 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9751 the number of edges incoming to each block.  Increasing values mean
9752 more aggressive optimization, making the compilation time increase with
9753 probably small improvement in executable size.
9755 @item min-crossjump-insns
9756 The minimum number of instructions that must be matched at the end
9757 of two blocks before cross-jumping is performed on them.  This
9758 value is ignored in the case where all instructions in the block being
9759 cross-jumped from are matched.  The default value is 5.
9761 @item max-grow-copy-bb-insns
9762 The maximum code size expansion factor when copying basic blocks
9763 instead of jumping.  The expansion is relative to a jump instruction.
9764 The default value is 8.
9766 @item max-goto-duplication-insns
9767 The maximum number of instructions to duplicate to a block that jumps
9768 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9769 passes, GCC factors computed gotos early in the compilation process,
9770 and unfactors them as late as possible.  Only computed jumps at the
9771 end of a basic blocks with no more than max-goto-duplication-insns are
9772 unfactored.  The default value is 8.
9774 @item max-delay-slot-insn-search
9775 The maximum number of instructions to consider when looking for an
9776 instruction to fill a delay slot.  If more than this arbitrary number of
9777 instructions are searched, the time savings from filling the delay slot
9778 are minimal, so stop searching.  Increasing values mean more
9779 aggressive optimization, making the compilation time increase with probably
9780 small improvement in execution time.
9782 @item max-delay-slot-live-search
9783 When trying to fill delay slots, the maximum number of instructions to
9784 consider when searching for a block with valid live register
9785 information.  Increasing this arbitrarily chosen value means more
9786 aggressive optimization, increasing the compilation time.  This parameter
9787 should be removed when the delay slot code is rewritten to maintain the
9788 control-flow graph.
9790 @item max-gcse-memory
9791 The approximate maximum amount of memory that can be allocated in
9792 order to perform the global common subexpression elimination
9793 optimization.  If more memory than specified is required, the
9794 optimization is not done.
9796 @item max-gcse-insertion-ratio
9797 If the ratio of expression insertions to deletions is larger than this value
9798 for any expression, then RTL PRE inserts or removes the expression and thus
9799 leaves partially redundant computations in the instruction stream.  The default value is 20.
9801 @item max-pending-list-length
9802 The maximum number of pending dependencies scheduling allows
9803 before flushing the current state and starting over.  Large functions
9804 with few branches or calls can create excessively large lists which
9805 needlessly consume memory and resources.
9807 @item max-modulo-backtrack-attempts
9808 The maximum number of backtrack attempts the scheduler should make
9809 when modulo scheduling a loop.  Larger values can exponentially increase
9810 compilation time.
9812 @item max-inline-insns-single
9813 Several parameters control the tree inliner used in GCC@.
9814 This number sets the maximum number of instructions (counted in GCC's
9815 internal representation) in a single function that the tree inliner
9816 considers for inlining.  This only affects functions declared
9817 inline and methods implemented in a class declaration (C++).
9818 The default value is 400.
9820 @item max-inline-insns-auto
9821 When you use @option{-finline-functions} (included in @option{-O3}),
9822 a lot of functions that would otherwise not be considered for inlining
9823 by the compiler are investigated.  To those functions, a different
9824 (more restrictive) limit compared to functions declared inline can
9825 be applied.
9826 The default value is 40.
9828 @item inline-min-speedup
9829 When estimated performance improvement of caller + callee runtime exceeds this
9830 threshold (in percent), the function can be inlined regardless of the limit on
9831 @option{--param max-inline-insns-single} and @option{--param
9832 max-inline-insns-auto}.
9834 @item large-function-insns
9835 The limit specifying really large functions.  For functions larger than this
9836 limit after inlining, inlining is constrained by
9837 @option{--param large-function-growth}.  This parameter is useful primarily
9838 to avoid extreme compilation time caused by non-linear algorithms used by the
9839 back end.
9840 The default value is 2700.
9842 @item large-function-growth
9843 Specifies maximal growth of large function caused by inlining in percents.
9844 The default value is 100 which limits large function growth to 2.0 times
9845 the original size.
9847 @item large-unit-insns
9848 The limit specifying large translation unit.  Growth caused by inlining of
9849 units larger than this limit is limited by @option{--param inline-unit-growth}.
9850 For small units this might be too tight.
9851 For example, consider a unit consisting of function A
9852 that is inline and B that just calls A three times.  If B is small relative to
9853 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9854 large units consisting of small inlineable functions, however, the overall unit
9855 growth limit is needed to avoid exponential explosion of code size.  Thus for
9856 smaller units, the size is increased to @option{--param large-unit-insns}
9857 before applying @option{--param inline-unit-growth}.  The default is 10000.
9859 @item inline-unit-growth
9860 Specifies maximal overall growth of the compilation unit caused by inlining.
9861 The default value is 20 which limits unit growth to 1.2 times the original
9862 size. Cold functions (either marked cold via an attribute or by profile
9863 feedback) are not accounted into the unit size.
9865 @item ipcp-unit-growth
9866 Specifies maximal overall growth of the compilation unit caused by
9867 interprocedural constant propagation.  The default value is 10 which limits
9868 unit growth to 1.1 times the original size.
9870 @item large-stack-frame
9871 The limit specifying large stack frames.  While inlining the algorithm is trying
9872 to not grow past this limit too much.  The default value is 256 bytes.
9874 @item large-stack-frame-growth
9875 Specifies maximal growth of large stack frames caused by inlining in percents.
9876 The default value is 1000 which limits large stack frame growth to 11 times
9877 the original size.
9879 @item max-inline-insns-recursive
9880 @itemx max-inline-insns-recursive-auto
9881 Specifies the maximum number of instructions an out-of-line copy of a
9882 self-recursive inline
9883 function can grow into by performing recursive inlining.
9885 @option{--param max-inline-insns-recursive} applies to functions
9886 declared inline.
9887 For functions not declared inline, recursive inlining
9888 happens only when @option{-finline-functions} (included in @option{-O3}) is
9889 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9890 default value is 450.
9892 @item max-inline-recursive-depth
9893 @itemx max-inline-recursive-depth-auto
9894 Specifies the maximum recursion depth used for recursive inlining.
9896 @option{--param max-inline-recursive-depth} applies to functions
9897 declared inline.  For functions not declared inline, recursive inlining
9898 happens only when @option{-finline-functions} (included in @option{-O3}) is
9899 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9900 default value is 8.
9902 @item min-inline-recursive-probability
9903 Recursive inlining is profitable only for function having deep recursion
9904 in average and can hurt for function having little recursion depth by
9905 increasing the prologue size or complexity of function body to other
9906 optimizers.
9908 When profile feedback is available (see @option{-fprofile-generate}) the actual
9909 recursion depth can be guessed from the probability that function recurses
9910 via a given call expression.  This parameter limits inlining only to call
9911 expressions whose probability exceeds the given threshold (in percents).
9912 The default value is 10.
9914 @item early-inlining-insns
9915 Specify growth that the early inliner can make.  In effect it increases
9916 the amount of inlining for code having a large abstraction penalty.
9917 The default value is 14.
9919 @item max-early-inliner-iterations
9920 Limit of iterations of the early inliner.  This basically bounds
9921 the number of nested indirect calls the early inliner can resolve.
9922 Deeper chains are still handled by late inlining.
9924 @item comdat-sharing-probability
9925 Probability (in percent) that C++ inline function with comdat visibility
9926 are shared across multiple compilation units.  The default value is 20.
9928 @item profile-func-internal-id
9929 A parameter to control whether to use function internal id in profile
9930 database lookup. If the value is 0, the compiler uses an id that
9931 is based on function assembler name and filename, which makes old profile
9932 data more tolerant to source changes such as function reordering etc.
9933 The default value is 0.
9935 @item min-vect-loop-bound
9936 The minimum number of iterations under which loops are not vectorized
9937 when @option{-ftree-vectorize} is used.  The number of iterations after
9938 vectorization needs to be greater than the value specified by this option
9939 to allow vectorization.  The default value is 0.
9941 @item gcse-cost-distance-ratio
9942 Scaling factor in calculation of maximum distance an expression
9943 can be moved by GCSE optimizations.  This is currently supported only in the
9944 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9945 is with simple expressions, i.e., the expressions that have cost
9946 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9947 hoisting of simple expressions.  The default value is 10.
9949 @item gcse-unrestricted-cost
9950 Cost, roughly measured as the cost of a single typical machine
9951 instruction, at which GCSE optimizations do not constrain
9952 the distance an expression can travel.  This is currently
9953 supported only in the code hoisting pass.  The lesser the cost,
9954 the more aggressive code hoisting is.  Specifying 0 
9955 allows all expressions to travel unrestricted distances.
9956 The default value is 3.
9958 @item max-hoist-depth
9959 The depth of search in the dominator tree for expressions to hoist.
9960 This is used to avoid quadratic behavior in hoisting algorithm.
9961 The value of 0 does not limit on the search, but may slow down compilation
9962 of huge functions.  The default value is 30.
9964 @item max-tail-merge-comparisons
9965 The maximum amount of similar bbs to compare a bb with.  This is used to
9966 avoid quadratic behavior in tree tail merging.  The default value is 10.
9968 @item max-tail-merge-iterations
9969 The maximum amount of iterations of the pass over the function.  This is used to
9970 limit compilation time in tree tail merging.  The default value is 2.
9972 @item store-merging-allow-unaligned
9973 Allow the store merging pass to introduce unaligned stores if it is legal to
9974 do so.  The default value is 1.
9976 @item max-stores-to-merge
9977 The maximum number of stores to attempt to merge into wider stores in the store
9978 merging pass.  The minimum value is 2 and the default is 64.
9980 @item max-unrolled-insns
9981 The maximum number of instructions that a loop may have to be unrolled.
9982 If a loop is unrolled, this parameter also determines how many times
9983 the loop code is unrolled.
9985 @item max-average-unrolled-insns
9986 The maximum number of instructions biased by probabilities of their execution
9987 that a loop may have to be unrolled.  If a loop is unrolled,
9988 this parameter also determines how many times the loop code is unrolled.
9990 @item max-unroll-times
9991 The maximum number of unrollings of a single loop.
9993 @item max-peeled-insns
9994 The maximum number of instructions that a loop may have to be peeled.
9995 If a loop is peeled, this parameter also determines how many times
9996 the loop code is peeled.
9998 @item max-peel-times
9999 The maximum number of peelings of a single loop.
10001 @item max-peel-branches
10002 The maximum number of branches on the hot path through the peeled sequence.
10004 @item max-completely-peeled-insns
10005 The maximum number of insns of a completely peeled loop.
10007 @item max-completely-peel-times
10008 The maximum number of iterations of a loop to be suitable for complete peeling.
10010 @item max-completely-peel-loop-nest-depth
10011 The maximum depth of a loop nest suitable for complete peeling.
10013 @item max-unswitch-insns
10014 The maximum number of insns of an unswitched loop.
10016 @item max-unswitch-level
10017 The maximum number of branches unswitched in a single loop.
10019 @item max-loop-headers-insns
10020 The maximum number of insns in loop header duplicated by the copy loop headers
10021 pass.
10023 @item lim-expensive
10024 The minimum cost of an expensive expression in the loop invariant motion.
10026 @item iv-consider-all-candidates-bound
10027 Bound on number of candidates for induction variables, below which
10028 all candidates are considered for each use in induction variable
10029 optimizations.  If there are more candidates than this,
10030 only the most relevant ones are considered to avoid quadratic time complexity.
10032 @item iv-max-considered-uses
10033 The induction variable optimizations give up on loops that contain more
10034 induction variable uses.
10036 @item iv-always-prune-cand-set-bound
10037 If the number of candidates in the set is smaller than this value,
10038 always try to remove unnecessary ivs from the set
10039 when adding a new one.
10041 @item avg-loop-niter
10042 Average number of iterations of a loop.
10044 @item dse-max-object-size
10045 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10046 Larger values may result in larger compilation times.
10048 @item scev-max-expr-size
10049 Bound on size of expressions used in the scalar evolutions analyzer.
10050 Large expressions slow the analyzer.
10052 @item scev-max-expr-complexity
10053 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10054 Complex expressions slow the analyzer.
10056 @item max-tree-if-conversion-phi-args
10057 Maximum number of arguments in a PHI supported by TREE if conversion
10058 unless the loop is marked with simd pragma.
10060 @item vect-max-version-for-alignment-checks
10061 The maximum number of run-time checks that can be performed when
10062 doing loop versioning for alignment in the vectorizer.
10064 @item vect-max-version-for-alias-checks
10065 The maximum number of run-time checks that can be performed when
10066 doing loop versioning for alias in the vectorizer.
10068 @item vect-max-peeling-for-alignment
10069 The maximum number of loop peels to enhance access alignment
10070 for vectorizer. Value -1 means no limit.
10072 @item max-iterations-to-track
10073 The maximum number of iterations of a loop the brute-force algorithm
10074 for analysis of the number of iterations of the loop tries to evaluate.
10076 @item hot-bb-count-ws-permille
10077 A basic block profile count is considered hot if it contributes to 
10078 the given permillage (i.e. 0...1000) of the entire profiled execution.
10080 @item hot-bb-frequency-fraction
10081 Select fraction of the entry block frequency of executions of basic block in
10082 function given basic block needs to have to be considered hot.
10084 @item max-predicted-iterations
10085 The maximum number of loop iterations we predict statically.  This is useful
10086 in cases where a function contains a single loop with known bound and
10087 another loop with unknown bound.
10088 The known number of iterations is predicted correctly, while
10089 the unknown number of iterations average to roughly 10.  This means that the
10090 loop without bounds appears artificially cold relative to the other one.
10092 @item builtin-expect-probability
10093 Control the probability of the expression having the specified value. This
10094 parameter takes a percentage (i.e. 0 ... 100) as input.
10095 The default probability of 90 is obtained empirically.
10097 @item align-threshold
10099 Select fraction of the maximal frequency of executions of a basic block in
10100 a function to align the basic block.
10102 @item align-loop-iterations
10104 A loop expected to iterate at least the selected number of iterations is
10105 aligned.
10107 @item tracer-dynamic-coverage
10108 @itemx tracer-dynamic-coverage-feedback
10110 This value is used to limit superblock formation once the given percentage of
10111 executed instructions is covered.  This limits unnecessary code size
10112 expansion.
10114 The @option{tracer-dynamic-coverage-feedback} parameter
10115 is used only when profile
10116 feedback is available.  The real profiles (as opposed to statically estimated
10117 ones) are much less balanced allowing the threshold to be larger value.
10119 @item tracer-max-code-growth
10120 Stop tail duplication once code growth has reached given percentage.  This is
10121 a rather artificial limit, as most of the duplicates are eliminated later in
10122 cross jumping, so it may be set to much higher values than is the desired code
10123 growth.
10125 @item tracer-min-branch-ratio
10127 Stop reverse growth when the reverse probability of best edge is less than this
10128 threshold (in percent).
10130 @item tracer-min-branch-probability
10131 @itemx tracer-min-branch-probability-feedback
10133 Stop forward growth if the best edge has probability lower than this
10134 threshold.
10136 Similarly to @option{tracer-dynamic-coverage} two parameters are
10137 provided.  @option{tracer-min-branch-probability-feedback} is used for
10138 compilation with profile feedback and @option{tracer-min-branch-probability}
10139 compilation without.  The value for compilation with profile feedback
10140 needs to be more conservative (higher) in order to make tracer
10141 effective.
10143 @item max-cse-path-length
10145 The maximum number of basic blocks on path that CSE considers.
10146 The default is 10.
10148 @item max-cse-insns
10149 The maximum number of instructions CSE processes before flushing.
10150 The default is 1000.
10152 @item ggc-min-expand
10154 GCC uses a garbage collector to manage its own memory allocation.  This
10155 parameter specifies the minimum percentage by which the garbage
10156 collector's heap should be allowed to expand between collections.
10157 Tuning this may improve compilation speed; it has no effect on code
10158 generation.
10160 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10161 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10162 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10163 GCC is not able to calculate RAM on a particular platform, the lower
10164 bound of 30% is used.  Setting this parameter and
10165 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10166 every opportunity.  This is extremely slow, but can be useful for
10167 debugging.
10169 @item ggc-min-heapsize
10171 Minimum size of the garbage collector's heap before it begins bothering
10172 to collect garbage.  The first collection occurs after the heap expands
10173 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10174 tuning this may improve compilation speed, and has no effect on code
10175 generation.
10177 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10178 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10179 with a lower bound of 4096 (four megabytes) and an upper bound of
10180 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10181 particular platform, the lower bound is used.  Setting this parameter
10182 very large effectively disables garbage collection.  Setting this
10183 parameter and @option{ggc-min-expand} to zero causes a full collection
10184 to occur at every opportunity.
10186 @item max-reload-search-insns
10187 The maximum number of instruction reload should look backward for equivalent
10188 register.  Increasing values mean more aggressive optimization, making the
10189 compilation time increase with probably slightly better performance.
10190 The default value is 100.
10192 @item max-cselib-memory-locations
10193 The maximum number of memory locations cselib should take into account.
10194 Increasing values mean more aggressive optimization, making the compilation time
10195 increase with probably slightly better performance.  The default value is 500.
10197 @item max-sched-ready-insns
10198 The maximum number of instructions ready to be issued the scheduler should
10199 consider at any given time during the first scheduling pass.  Increasing
10200 values mean more thorough searches, making the compilation time increase
10201 with probably little benefit.  The default value is 100.
10203 @item max-sched-region-blocks
10204 The maximum number of blocks in a region to be considered for
10205 interblock scheduling.  The default value is 10.
10207 @item max-pipeline-region-blocks
10208 The maximum number of blocks in a region to be considered for
10209 pipelining in the selective scheduler.  The default value is 15.
10211 @item max-sched-region-insns
10212 The maximum number of insns in a region to be considered for
10213 interblock scheduling.  The default value is 100.
10215 @item max-pipeline-region-insns
10216 The maximum number of insns in a region to be considered for
10217 pipelining in the selective scheduler.  The default value is 200.
10219 @item min-spec-prob
10220 The minimum probability (in percents) of reaching a source block
10221 for interblock speculative scheduling.  The default value is 40.
10223 @item max-sched-extend-regions-iters
10224 The maximum number of iterations through CFG to extend regions.
10225 A value of 0 (the default) disables region extensions.
10227 @item max-sched-insn-conflict-delay
10228 The maximum conflict delay for an insn to be considered for speculative motion.
10229 The default value is 3.
10231 @item sched-spec-prob-cutoff
10232 The minimal probability of speculation success (in percents), so that
10233 speculative insns are scheduled.
10234 The default value is 40.
10236 @item sched-state-edge-prob-cutoff
10237 The minimum probability an edge must have for the scheduler to save its
10238 state across it.
10239 The default value is 10.
10241 @item sched-mem-true-dep-cost
10242 Minimal distance (in CPU cycles) between store and load targeting same
10243 memory locations.  The default value is 1.
10245 @item selsched-max-lookahead
10246 The maximum size of the lookahead window of selective scheduling.  It is a
10247 depth of search for available instructions.
10248 The default value is 50.
10250 @item selsched-max-sched-times
10251 The maximum number of times that an instruction is scheduled during
10252 selective scheduling.  This is the limit on the number of iterations
10253 through which the instruction may be pipelined.  The default value is 2.
10255 @item selsched-insns-to-rename
10256 The maximum number of best instructions in the ready list that are considered
10257 for renaming in the selective scheduler.  The default value is 2.
10259 @item sms-min-sc
10260 The minimum value of stage count that swing modulo scheduler
10261 generates.  The default value is 2.
10263 @item max-last-value-rtl
10264 The maximum size measured as number of RTLs that can be recorded in an expression
10265 in combiner for a pseudo register as last known value of that register.  The default
10266 is 10000.
10268 @item max-combine-insns
10269 The maximum number of instructions the RTL combiner tries to combine.
10270 The default value is 2 at @option{-Og} and 4 otherwise.
10272 @item integer-share-limit
10273 Small integer constants can use a shared data structure, reducing the
10274 compiler's memory usage and increasing its speed.  This sets the maximum
10275 value of a shared integer constant.  The default value is 256.
10277 @item ssp-buffer-size
10278 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10279 protection when @option{-fstack-protection} is used.
10281 @item min-size-for-stack-sharing
10282 The minimum size of variables taking part in stack slot sharing when not
10283 optimizing. The default value is 32.
10285 @item max-jump-thread-duplication-stmts
10286 Maximum number of statements allowed in a block that needs to be
10287 duplicated when threading jumps.
10289 @item max-fields-for-field-sensitive
10290 Maximum number of fields in a structure treated in
10291 a field sensitive manner during pointer analysis.  The default is zero
10292 for @option{-O0} and @option{-O1},
10293 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10295 @item prefetch-latency
10296 Estimate on average number of instructions that are executed before
10297 prefetch finishes.  The distance prefetched ahead is proportional
10298 to this constant.  Increasing this number may also lead to less
10299 streams being prefetched (see @option{simultaneous-prefetches}).
10301 @item simultaneous-prefetches
10302 Maximum number of prefetches that can run at the same time.
10304 @item l1-cache-line-size
10305 The size of cache line in L1 cache, in bytes.
10307 @item l1-cache-size
10308 The size of L1 cache, in kilobytes.
10310 @item l2-cache-size
10311 The size of L2 cache, in kilobytes.
10313 @item min-insn-to-prefetch-ratio
10314 The minimum ratio between the number of instructions and the
10315 number of prefetches to enable prefetching in a loop.
10317 @item prefetch-min-insn-to-mem-ratio
10318 The minimum ratio between the number of instructions and the
10319 number of memory references to enable prefetching in a loop.
10321 @item use-canonical-types
10322 Whether the compiler should use the ``canonical'' type system.  By
10323 default, this should always be 1, which uses a more efficient internal
10324 mechanism for comparing types in C++ and Objective-C++.  However, if
10325 bugs in the canonical type system are causing compilation failures,
10326 set this value to 0 to disable canonical types.
10328 @item switch-conversion-max-branch-ratio
10329 Switch initialization conversion refuses to create arrays that are
10330 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10331 branches in the switch.
10333 @item max-partial-antic-length
10334 Maximum length of the partial antic set computed during the tree
10335 partial redundancy elimination optimization (@option{-ftree-pre}) when
10336 optimizing at @option{-O3} and above.  For some sorts of source code
10337 the enhanced partial redundancy elimination optimization can run away,
10338 consuming all of the memory available on the host machine.  This
10339 parameter sets a limit on the length of the sets that are computed,
10340 which prevents the runaway behavior.  Setting a value of 0 for
10341 this parameter allows an unlimited set length.
10343 @item sccvn-max-scc-size
10344 Maximum size of a strongly connected component (SCC) during SCCVN
10345 processing.  If this limit is hit, SCCVN processing for the whole
10346 function is not done and optimizations depending on it are
10347 disabled.  The default maximum SCC size is 10000.
10349 @item sccvn-max-alias-queries-per-access
10350 Maximum number of alias-oracle queries we perform when looking for
10351 redundancies for loads and stores.  If this limit is hit the search
10352 is aborted and the load or store is not considered redundant.  The
10353 number of queries is algorithmically limited to the number of
10354 stores on all paths from the load to the function entry.
10355 The default maximum number of queries is 1000.
10357 @item ira-max-loops-num
10358 IRA uses regional register allocation by default.  If a function
10359 contains more loops than the number given by this parameter, only at most
10360 the given number of the most frequently-executed loops form regions
10361 for regional register allocation.  The default value of the
10362 parameter is 100.
10364 @item ira-max-conflict-table-size 
10365 Although IRA uses a sophisticated algorithm to compress the conflict
10366 table, the table can still require excessive amounts of memory for
10367 huge functions.  If the conflict table for a function could be more
10368 than the size in MB given by this parameter, the register allocator
10369 instead uses a faster, simpler, and lower-quality
10370 algorithm that does not require building a pseudo-register conflict table.  
10371 The default value of the parameter is 2000.
10373 @item ira-loop-reserved-regs
10374 IRA can be used to evaluate more accurate register pressure in loops
10375 for decisions to move loop invariants (see @option{-O3}).  The number
10376 of available registers reserved for some other purposes is given
10377 by this parameter.  The default value of the parameter is 2, which is
10378 the minimal number of registers needed by typical instructions.
10379 This value is the best found from numerous experiments.
10381 @item lra-inheritance-ebb-probability-cutoff
10382 LRA tries to reuse values reloaded in registers in subsequent insns.
10383 This optimization is called inheritance.  EBB is used as a region to
10384 do this optimization.  The parameter defines a minimal fall-through
10385 edge probability in percentage used to add BB to inheritance EBB in
10386 LRA.  The default value of the parameter is 40.  The value was chosen
10387 from numerous runs of SPEC2000 on x86-64.
10389 @item loop-invariant-max-bbs-in-loop
10390 Loop invariant motion can be very expensive, both in compilation time and
10391 in amount of needed compile-time memory, with very large loops.  Loops
10392 with more basic blocks than this parameter won't have loop invariant
10393 motion optimization performed on them.  The default value of the
10394 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10396 @item loop-max-datarefs-for-datadeps
10397 Building data dependencies is expensive for very large loops.  This
10398 parameter limits the number of data references in loops that are
10399 considered for data dependence analysis.  These large loops are no
10400 handled by the optimizations using loop data dependencies.
10401 The default value is 1000.
10403 @item max-vartrack-size
10404 Sets a maximum number of hash table slots to use during variable
10405 tracking dataflow analysis of any function.  If this limit is exceeded
10406 with variable tracking at assignments enabled, analysis for that
10407 function is retried without it, after removing all debug insns from
10408 the function.  If the limit is exceeded even without debug insns, var
10409 tracking analysis is completely disabled for the function.  Setting
10410 the parameter to zero makes it unlimited.
10412 @item max-vartrack-expr-depth
10413 Sets a maximum number of recursion levels when attempting to map
10414 variable names or debug temporaries to value expressions.  This trades
10415 compilation time for more complete debug information.  If this is set too
10416 low, value expressions that are available and could be represented in
10417 debug information may end up not being used; setting this higher may
10418 enable the compiler to find more complex debug expressions, but compile
10419 time and memory use may grow.  The default is 12.
10421 @item min-nondebug-insn-uid
10422 Use uids starting at this parameter for nondebug insns.  The range below
10423 the parameter is reserved exclusively for debug insns created by
10424 @option{-fvar-tracking-assignments}, but debug insns may get
10425 (non-overlapping) uids above it if the reserved range is exhausted.
10427 @item ipa-sra-ptr-growth-factor
10428 IPA-SRA replaces a pointer to an aggregate with one or more new
10429 parameters only when their cumulative size is less or equal to
10430 @option{ipa-sra-ptr-growth-factor} times the size of the original
10431 pointer parameter.
10433 @item sra-max-scalarization-size-Ospeed
10434 @item sra-max-scalarization-size-Osize
10435 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10436 replace scalar parts of aggregates with uses of independent scalar
10437 variables.  These parameters control the maximum size, in storage units,
10438 of aggregate which is considered for replacement when compiling for
10439 speed
10440 (@option{sra-max-scalarization-size-Ospeed}) or size
10441 (@option{sra-max-scalarization-size-Osize}) respectively.
10443 @item tm-max-aggregate-size
10444 When making copies of thread-local variables in a transaction, this
10445 parameter specifies the size in bytes after which variables are
10446 saved with the logging functions as opposed to save/restore code
10447 sequence pairs.  This option only applies when using
10448 @option{-fgnu-tm}.
10450 @item graphite-max-nb-scop-params
10451 To avoid exponential effects in the Graphite loop transforms, the
10452 number of parameters in a Static Control Part (SCoP) is bounded.  The
10453 default value is 10 parameters.  A variable whose value is unknown at
10454 compilation time and defined outside a SCoP is a parameter of the SCoP.
10456 @item graphite-max-bbs-per-function
10457 To avoid exponential effects in the detection of SCoPs, the size of
10458 the functions analyzed by Graphite is bounded.  The default value is
10459 100 basic blocks.
10461 @item loop-block-tile-size
10462 Loop blocking or strip mining transforms, enabled with
10463 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10464 loop in the loop nest by a given number of iterations.  The strip
10465 length can be changed using the @option{loop-block-tile-size}
10466 parameter.  The default value is 51 iterations.
10468 @item loop-unroll-jam-size
10469 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10470 default value is 4.
10472 @item loop-unroll-jam-depth
10473 Specify the dimension to be unrolled (counting from the most inner loop)
10474 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10476 @item ipa-cp-value-list-size
10477 IPA-CP attempts to track all possible values and types passed to a function's
10478 parameter in order to propagate them and perform devirtualization.
10479 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10480 stores per one formal parameter of a function.
10482 @item ipa-cp-eval-threshold
10483 IPA-CP calculates its own score of cloning profitability heuristics
10484 and performs those cloning opportunities with scores that exceed
10485 @option{ipa-cp-eval-threshold}.
10487 @item ipa-cp-recursion-penalty
10488 Percentage penalty the recursive functions will receive when they
10489 are evaluated for cloning.
10491 @item ipa-cp-single-call-penalty
10492 Percentage penalty functions containing a single call to another
10493 function will receive when they are evaluated for cloning.
10496 @item ipa-max-agg-items
10497 IPA-CP is also capable to propagate a number of scalar values passed
10498 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10499 number of such values per one parameter.
10501 @item ipa-cp-loop-hint-bonus
10502 When IPA-CP determines that a cloning candidate would make the number
10503 of iterations of a loop known, it adds a bonus of
10504 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10505 the candidate.
10507 @item ipa-cp-array-index-hint-bonus
10508 When IPA-CP determines that a cloning candidate would make the index of
10509 an array access known, it adds a bonus of
10510 @option{ipa-cp-array-index-hint-bonus} to the profitability
10511 score of the candidate.
10513 @item ipa-max-aa-steps
10514 During its analysis of function bodies, IPA-CP employs alias analysis
10515 in order to track values pointed to by function parameters.  In order
10516 not spend too much time analyzing huge functions, it gives up and
10517 consider all memory clobbered after examining
10518 @option{ipa-max-aa-steps} statements modifying memory.
10520 @item lto-partitions
10521 Specify desired number of partitions produced during WHOPR compilation.
10522 The number of partitions should exceed the number of CPUs used for compilation.
10523 The default value is 32.
10525 @item lto-min-partition
10526 Size of minimal partition for WHOPR (in estimated instructions).
10527 This prevents expenses of splitting very small programs into too many
10528 partitions.
10530 @item lto-max-partition
10531 Size of max partition for WHOPR (in estimated instructions).
10532 to provide an upper bound for individual size of partition.
10533 Meant to be used only with balanced partitioning.
10535 @item cxx-max-namespaces-for-diagnostic-help
10536 The maximum number of namespaces to consult for suggestions when C++
10537 name lookup fails for an identifier.  The default is 1000.
10539 @item sink-frequency-threshold
10540 The maximum relative execution frequency (in percents) of the target block
10541 relative to a statement's original block to allow statement sinking of a
10542 statement.  Larger numbers result in more aggressive statement sinking.
10543 The default value is 75.  A small positive adjustment is applied for
10544 statements with memory operands as those are even more profitable so sink.
10546 @item max-stores-to-sink
10547 The maximum number of conditional store pairs that can be sunk.  Set to 0
10548 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10549 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10551 @item allow-store-data-races
10552 Allow optimizers to introduce new data races on stores.
10553 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10554 at optimization level @option{-Ofast}.
10556 @item case-values-threshold
10557 The smallest number of different values for which it is best to use a
10558 jump-table instead of a tree of conditional branches.  If the value is
10559 0, use the default for the machine.  The default is 0.
10561 @item tree-reassoc-width
10562 Set the maximum number of instructions executed in parallel in
10563 reassociated tree. This parameter overrides target dependent
10564 heuristics used by default if has non zero value.
10566 @item sched-pressure-algorithm
10567 Choose between the two available implementations of
10568 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10569 and is the more likely to prevent instructions from being reordered.
10570 Algorithm 2 was designed to be a compromise between the relatively
10571 conservative approach taken by algorithm 1 and the rather aggressive
10572 approach taken by the default scheduler.  It relies more heavily on
10573 having a regular register file and accurate register pressure classes.
10574 See @file{haifa-sched.c} in the GCC sources for more details.
10576 The default choice depends on the target.
10578 @item max-slsr-cand-scan
10579 Set the maximum number of existing candidates that are considered when
10580 seeking a basis for a new straight-line strength reduction candidate.
10582 @item asan-globals
10583 Enable buffer overflow detection for global objects.  This kind
10584 of protection is enabled by default if you are using
10585 @option{-fsanitize=address} option.
10586 To disable global objects protection use @option{--param asan-globals=0}.
10588 @item asan-stack
10589 Enable buffer overflow detection for stack objects.  This kind of
10590 protection is enabled by default when using @option{-fsanitize=address}.
10591 To disable stack protection use @option{--param asan-stack=0} option.
10593 @item asan-instrument-reads
10594 Enable buffer overflow detection for memory reads.  This kind of
10595 protection is enabled by default when using @option{-fsanitize=address}.
10596 To disable memory reads protection use
10597 @option{--param asan-instrument-reads=0}.
10599 @item asan-instrument-writes
10600 Enable buffer overflow detection for memory writes.  This kind of
10601 protection is enabled by default when using @option{-fsanitize=address}.
10602 To disable memory writes protection use
10603 @option{--param asan-instrument-writes=0} option.
10605 @item asan-memintrin
10606 Enable detection for built-in functions.  This kind of protection
10607 is enabled by default when using @option{-fsanitize=address}.
10608 To disable built-in functions protection use
10609 @option{--param asan-memintrin=0}.
10611 @item asan-use-after-return
10612 Enable detection of use-after-return.  This kind of protection
10613 is enabled by default when using the @option{-fsanitize=address} option.
10614 To disable it use @option{--param asan-use-after-return=0}.
10616 Note: By default the check is disabled at run time.  To enable it,
10617 add @code{detect_stack_use_after_return=1} to the environment variable
10618 @env{ASAN_OPTIONS}.
10620 @item asan-instrumentation-with-call-threshold
10621 If number of memory accesses in function being instrumented
10622 is greater or equal to this number, use callbacks instead of inline checks.
10623 E.g. to disable inline code use
10624 @option{--param asan-instrumentation-with-call-threshold=0}.
10626 @item use-after-scope-direct-emission-threshold
10627 If the size of a local variable in bytes is smaller or equal to this
10628 number, directly poison (or unpoison) shadow memory instead of using
10629 run-time callbacks.  The default value is 256.
10631 @item chkp-max-ctor-size
10632 Static constructors generated by Pointer Bounds Checker may become very
10633 large and significantly increase compile time at optimization level
10634 @option{-O1} and higher.  This parameter is a maximum number of statements
10635 in a single generated constructor.  Default value is 5000.
10637 @item max-fsm-thread-path-insns
10638 Maximum number of instructions to copy when duplicating blocks on a
10639 finite state automaton jump thread path.  The default is 100.
10641 @item max-fsm-thread-length
10642 Maximum number of basic blocks on a finite state automaton jump thread
10643 path.  The default is 10.
10645 @item max-fsm-thread-paths
10646 Maximum number of new jump thread paths to create for a finite state
10647 automaton.  The default is 50.
10649 @item parloops-chunk-size
10650 Chunk size of omp schedule for loops parallelized by parloops.  The default
10651 is 0.
10653 @item parloops-schedule
10654 Schedule type of omp schedule for loops parallelized by parloops (static,
10655 dynamic, guided, auto, runtime).  The default is static.
10657 @item max-ssa-name-query-depth
10658 Maximum depth of recursion when querying properties of SSA names in things
10659 like fold routines.  One level of recursion corresponds to following a
10660 use-def chain.
10662 @item hsa-gen-debug-stores
10663 Enable emission of special debug stores within HSA kernels which are
10664 then read and reported by libgomp plugin.  Generation of these stores
10665 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10666 enable it.
10668 @item max-speculative-devirt-maydefs
10669 The maximum number of may-defs we analyze when looking for a must-def
10670 specifying the dynamic type of an object that invokes a virtual call
10671 we may be able to devirtualize speculatively.
10673 @item max-vrp-switch-assertions
10674 The maximum number of assertions to add along the default edge of a switch
10675 statement during VRP.  The default is 10.
10676 @end table
10677 @end table
10679 @node Instrumentation Options
10680 @section Program Instrumentation Options
10681 @cindex instrumentation options
10682 @cindex program instrumentation options
10683 @cindex run-time error checking options
10684 @cindex profiling options
10685 @cindex options, program instrumentation
10686 @cindex options, run-time error checking
10687 @cindex options, profiling
10689 GCC supports a number of command-line options that control adding
10690 run-time instrumentation to the code it normally generates.  
10691 For example, one purpose of instrumentation is collect profiling
10692 statistics for use in finding program hot spots, code coverage
10693 analysis, or profile-guided optimizations.
10694 Another class of program instrumentation is adding run-time checking 
10695 to detect programming errors like invalid pointer
10696 dereferences or out-of-bounds array accesses, as well as deliberately
10697 hostile attacks such as stack smashing or C++ vtable hijacking.
10698 There is also a general hook which can be used to implement other
10699 forms of tracing or function-level instrumentation for debug or
10700 program analysis purposes.
10702 @table @gcctabopt
10703 @cindex @command{prof}
10704 @item -p
10705 @opindex p
10706 Generate extra code to write profile information suitable for the
10707 analysis program @command{prof}.  You must use this option when compiling
10708 the source files you want data about, and you must also use it when
10709 linking.
10711 @cindex @command{gprof}
10712 @item -pg
10713 @opindex pg
10714 Generate extra code to write profile information suitable for the
10715 analysis program @command{gprof}.  You must use this option when compiling
10716 the source files you want data about, and you must also use it when
10717 linking.
10719 @item -fprofile-arcs
10720 @opindex fprofile-arcs
10721 Add code so that program flow @dfn{arcs} are instrumented.  During
10722 execution the program records how many times each branch and call is
10723 executed and how many times it is taken or returns.  On targets that support
10724 constructors with priority support, profiling properly handles constructors,
10725 destructors and C++ constructors (and destructors) of classes which are used
10726 as a type of a global variable.
10728 When the compiled
10729 program exits it saves this data to a file called
10730 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10731 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10732 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10733 @var{auxname} is generated from the name of the output file, if
10734 explicitly specified and it is not the final executable, otherwise it is
10735 the basename of the source file.  In both cases any suffix is removed
10736 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10737 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10738 @xref{Cross-profiling}.
10740 @cindex @command{gcov}
10741 @item --coverage
10742 @opindex coverage
10744 This option is used to compile and link code instrumented for coverage
10745 analysis.  The option is a synonym for @option{-fprofile-arcs}
10746 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10747 linking).  See the documentation for those options for more details.
10749 @itemize
10751 @item
10752 Compile the source files with @option{-fprofile-arcs} plus optimization
10753 and code generation options.  For test coverage analysis, use the
10754 additional @option{-ftest-coverage} option.  You do not need to profile
10755 every source file in a program.
10757 @item
10758 Compile the source files additionally with @option{-fprofile-abs-path}
10759 to create absolute path names in the @file{.gcno} files.  This allows
10760 @command{gcov} to find the correct sources in projects where compilations
10761 occur with different working directories.
10763 @item
10764 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10765 (the latter implies the former).
10767 @item
10768 Run the program on a representative workload to generate the arc profile
10769 information.  This may be repeated any number of times.  You can run
10770 concurrent instances of your program, and provided that the file system
10771 supports locking, the data files will be correctly updated.  Also
10772 @code{fork} calls are detected and correctly handled (double counting
10773 will not happen).
10775 @item
10776 For profile-directed optimizations, compile the source files again with
10777 the same optimization and code generation options plus
10778 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10779 Control Optimization}).
10781 @item
10782 For test coverage analysis, use @command{gcov} to produce human readable
10783 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10784 @command{gcov} documentation for further information.
10786 @end itemize
10788 With @option{-fprofile-arcs}, for each function of your program GCC
10789 creates a program flow graph, then finds a spanning tree for the graph.
10790 Only arcs that are not on the spanning tree have to be instrumented: the
10791 compiler adds code to count the number of times that these arcs are
10792 executed.  When an arc is the only exit or only entrance to a block, the
10793 instrumentation code can be added to the block; otherwise, a new basic
10794 block must be created to hold the instrumentation code.
10796 @need 2000
10797 @item -ftest-coverage
10798 @opindex ftest-coverage
10799 Produce a notes file that the @command{gcov} code-coverage utility
10800 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10801 show program coverage.  Each source file's note file is called
10802 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10803 above for a description of @var{auxname} and instructions on how to
10804 generate test coverage data.  Coverage data matches the source files
10805 more closely if you do not optimize.
10807 @item -fprofile-abs-path
10808 @opindex fprofile-abs-path
10809 Automatically convert relative source file names to absolute path names
10810 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10811 sources in projects where compilations occur with different working
10812 directories.
10814 @item -fprofile-dir=@var{path}
10815 @opindex fprofile-dir
10817 Set the directory to search for the profile data files in to @var{path}.
10818 This option affects only the profile data generated by
10819 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10820 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10821 and its related options.  Both absolute and relative paths can be used.
10822 By default, GCC uses the current directory as @var{path}, thus the
10823 profile data file appears in the same directory as the object file.
10825 @item -fprofile-generate
10826 @itemx -fprofile-generate=@var{path}
10827 @opindex fprofile-generate
10829 Enable options usually used for instrumenting application to produce
10830 profile useful for later recompilation with profile feedback based
10831 optimization.  You must use @option{-fprofile-generate} both when
10832 compiling and when linking your program.
10834 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10836 If @var{path} is specified, GCC looks at the @var{path} to find
10837 the profile feedback data files. See @option{-fprofile-dir}.
10839 To optimize the program based on the collected profile information, use
10840 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10842 @item -fprofile-update=@var{method}
10843 @opindex fprofile-update
10845 Alter the update method for an application instrumented for profile
10846 feedback based optimization.  The @var{method} argument should be one of
10847 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10848 The first one is useful for single-threaded applications,
10849 while the second one prevents profile corruption by emitting thread-safe code.
10851 @strong{Warning:} When an application does not properly join all threads
10852 (or creates an detached thread), a profile file can be still corrupted.
10854 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10855 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10856 automatically selects @samp{prefer-atomic} when @option{-pthread}
10857 is present in the command line.
10859 @item -fsanitize=address
10860 @opindex fsanitize=address
10861 Enable AddressSanitizer, a fast memory error detector.
10862 Memory access instructions are instrumented to detect
10863 out-of-bounds and use-after-free bugs.
10864 The option enables @option{-fsanitize-address-use-after-scope}.
10865 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10866 more details.  The run-time behavior can be influenced using the
10867 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10868 the available options are shown at startup of the instrumented program.  See
10869 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10870 for a list of supported options.
10871 The option cannot be combined with @option{-fsanitize=thread}
10872 and/or @option{-fcheck-pointer-bounds}.
10874 @item -fsanitize=kernel-address
10875 @opindex fsanitize=kernel-address
10876 Enable AddressSanitizer for Linux kernel.
10877 See @uref{https://github.com/google/kasan/wiki} for more details.
10878 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10880 @item -fsanitize=thread
10881 @opindex fsanitize=thread
10882 Enable ThreadSanitizer, a fast data race detector.
10883 Memory access instructions are instrumented to detect
10884 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10885 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10886 environment variable; see
10887 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10888 supported options.
10889 The option cannot be combined with @option{-fsanitize=address},
10890 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10892 Note that sanitized atomic builtins cannot throw exceptions when
10893 operating on invalid memory addresses with non-call exceptions
10894 (@option{-fnon-call-exceptions}).
10896 @item -fsanitize=leak
10897 @opindex fsanitize=leak
10898 Enable LeakSanitizer, a memory leak detector.
10899 This option only matters for linking of executables and
10900 the executable is linked against a library that overrides @code{malloc}
10901 and other allocator functions.  See
10902 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10903 details.  The run-time behavior can be influenced using the
10904 @env{LSAN_OPTIONS} environment variable.
10905 The option cannot be combined with @option{-fsanitize=thread}.
10907 @item -fsanitize=undefined
10908 @opindex fsanitize=undefined
10909 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10910 Various computations are instrumented to detect undefined behavior
10911 at runtime.  Current suboptions are:
10913 @table @gcctabopt
10915 @item -fsanitize=shift
10916 @opindex fsanitize=shift
10917 This option enables checking that the result of a shift operation is
10918 not undefined.  Note that what exactly is considered undefined differs
10919 slightly between C and C++, as well as between ISO C90 and C99, etc.
10920 This option has two suboptions, @option{-fsanitize=shift-base} and
10921 @option{-fsanitize=shift-exponent}.
10923 @item -fsanitize=shift-exponent
10924 @opindex fsanitize=shift-exponent
10925 This option enables checking that the second argument of a shift operation
10926 is not negative and is smaller than the precision of the promoted first
10927 argument.
10929 @item -fsanitize=shift-base
10930 @opindex fsanitize=shift-base
10931 If the second argument of a shift operation is within range, check that the
10932 result of a shift operation is not undefined.  Note that what exactly is
10933 considered undefined differs slightly between C and C++, as well as between
10934 ISO C90 and C99, etc.
10936 @item -fsanitize=integer-divide-by-zero
10937 @opindex fsanitize=integer-divide-by-zero
10938 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10940 @item -fsanitize=unreachable
10941 @opindex fsanitize=unreachable
10942 With this option, the compiler turns the @code{__builtin_unreachable}
10943 call into a diagnostics message call instead.  When reaching the
10944 @code{__builtin_unreachable} call, the behavior is undefined.
10946 @item -fsanitize=vla-bound
10947 @opindex fsanitize=vla-bound
10948 This option instructs the compiler to check that the size of a variable
10949 length array is positive.
10951 @item -fsanitize=null
10952 @opindex fsanitize=null
10953 This option enables pointer checking.  Particularly, the application
10954 built with this option turned on will issue an error message when it
10955 tries to dereference a NULL pointer, or if a reference (possibly an
10956 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10957 on an object pointed by a NULL pointer.
10959 @item -fsanitize=return
10960 @opindex fsanitize=return
10961 This option enables return statement checking.  Programs
10962 built with this option turned on will issue an error message
10963 when the end of a non-void function is reached without actually
10964 returning a value.  This option works in C++ only.
10966 @item -fsanitize=signed-integer-overflow
10967 @opindex fsanitize=signed-integer-overflow
10968 This option enables signed integer overflow checking.  We check that
10969 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10970 does not overflow in the signed arithmetics.  Note, integer promotion
10971 rules must be taken into account.  That is, the following is not an
10972 overflow:
10973 @smallexample
10974 signed char a = SCHAR_MAX;
10975 a++;
10976 @end smallexample
10978 @item -fsanitize=bounds
10979 @opindex fsanitize=bounds
10980 This option enables instrumentation of array bounds.  Various out of bounds
10981 accesses are detected.  Flexible array members, flexible array member-like
10982 arrays, and initializers of variables with static storage are not instrumented.
10983 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10985 @item -fsanitize=bounds-strict
10986 @opindex fsanitize=bounds-strict
10987 This option enables strict instrumentation of array bounds.  Most out of bounds
10988 accesses are detected, including flexible array members and flexible array
10989 member-like arrays.  Initializers of variables with static storage are not
10990 instrumented.  The option cannot be combined
10991 with @option{-fcheck-pointer-bounds}.
10993 @item -fsanitize=alignment
10994 @opindex fsanitize=alignment
10996 This option enables checking of alignment of pointers when they are
10997 dereferenced, or when a reference is bound to insufficiently aligned target,
10998 or when a method or constructor is invoked on insufficiently aligned object.
11000 @item -fsanitize=object-size
11001 @opindex fsanitize=object-size
11002 This option enables instrumentation of memory references using the
11003 @code{__builtin_object_size} function.  Various out of bounds pointer
11004 accesses are detected.
11006 @item -fsanitize=float-divide-by-zero
11007 @opindex fsanitize=float-divide-by-zero
11008 Detect floating-point division by zero.  Unlike other similar options,
11009 @option{-fsanitize=float-divide-by-zero} is not enabled by
11010 @option{-fsanitize=undefined}, since floating-point division by zero can
11011 be a legitimate way of obtaining infinities and NaNs.
11013 @item -fsanitize=float-cast-overflow
11014 @opindex fsanitize=float-cast-overflow
11015 This option enables floating-point type to integer conversion checking.
11016 We check that the result of the conversion does not overflow.
11017 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11018 not enabled by @option{-fsanitize=undefined}.
11019 This option does not work well with @code{FE_INVALID} exceptions enabled.
11021 @item -fsanitize=nonnull-attribute
11022 @opindex fsanitize=nonnull-attribute
11024 This option enables instrumentation of calls, checking whether null values
11025 are not passed to arguments marked as requiring a non-null value by the
11026 @code{nonnull} function attribute.
11028 @item -fsanitize=returns-nonnull-attribute
11029 @opindex fsanitize=returns-nonnull-attribute
11031 This option enables instrumentation of return statements in functions
11032 marked with @code{returns_nonnull} function attribute, to detect returning
11033 of null values from such functions.
11035 @item -fsanitize=bool
11036 @opindex fsanitize=bool
11038 This option enables instrumentation of loads from bool.  If a value other
11039 than 0/1 is loaded, a run-time error is issued.
11041 @item -fsanitize=enum
11042 @opindex fsanitize=enum
11044 This option enables instrumentation of loads from an enum type.  If
11045 a value outside the range of values for the enum type is loaded,
11046 a run-time error is issued.
11048 @item -fsanitize=vptr
11049 @opindex fsanitize=vptr
11051 This option enables instrumentation of C++ member function calls, member
11052 accesses and some conversions between pointers to base and derived classes,
11053 to verify the referenced object has the correct dynamic type.
11055 @end table
11057 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11058 @option{-fsanitize=undefined} gives a diagnostic message.
11059 This currently works only for the C family of languages.
11061 @item -fno-sanitize=all
11062 @opindex fno-sanitize=all
11064 This option disables all previously enabled sanitizers.
11065 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11066 together.
11068 @item -fasan-shadow-offset=@var{number}
11069 @opindex fasan-shadow-offset
11070 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11071 It is useful for experimenting with different shadow memory layouts in
11072 Kernel AddressSanitizer.
11074 @item -fsanitize-sections=@var{s1},@var{s2},...
11075 @opindex fsanitize-sections
11076 Sanitize global variables in selected user-defined sections.  @var{si} may
11077 contain wildcards.
11079 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11080 @opindex fsanitize-recover
11081 @opindex fno-sanitize-recover
11082 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11083 mentioned in comma-separated list of @var{opts}.  Enabling this option
11084 for a sanitizer component causes it to attempt to continue
11085 running the program as if no error happened.  This means multiple
11086 runtime errors can be reported in a single program run, and the exit
11087 code of the program may indicate success even when errors
11088 have been reported.  The @option{-fno-sanitize-recover=} option
11089 can be used to alter
11090 this behavior: only the first detected error is reported
11091 and program then exits with a non-zero exit code.
11093 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11094 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11095 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11096 @option{-fsanitize=bounds-strict},
11097 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11098 For these sanitizers error recovery is turned on by default,
11099 except @option{-fsanitize=address}, for which this feature is experimental.
11100 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11101 accepted, the former enables recovery for all sanitizers that support it,
11102 the latter disables recovery for all sanitizers that support it.
11104 Even if a recovery mode is turned on the compiler side, it needs to be also
11105 enabled on the runtime library side, otherwise the failures are still fatal.
11106 The runtime library defaults to @code{halt_on_error=0} for
11107 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11108 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11109 setting the @code{halt_on_error} flag in the corresponding environment variable.
11111 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11112 equivalent to specifying an @var{opts} list of:
11114 @smallexample
11115 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11116 @end smallexample
11118 @item -fsanitize-address-use-after-scope
11119 @opindex fsanitize-address-use-after-scope
11120 Enable sanitization of local variables to detect use-after-scope bugs.
11121 The option sets @option{-fstack-reuse} to @samp{none}.
11123 @item -fsanitize-undefined-trap-on-error
11124 @opindex fsanitize-undefined-trap-on-error
11125 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11126 report undefined behavior using @code{__builtin_trap} rather than
11127 a @code{libubsan} library routine.  The advantage of this is that the
11128 @code{libubsan} library is not needed and is not linked in, so this
11129 is usable even in freestanding environments.
11131 @item -fsanitize-coverage=trace-pc
11132 @opindex fsanitize-coverage=trace-pc
11133 Enable coverage-guided fuzzing code instrumentation.
11134 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11136 @item -fbounds-check
11137 @opindex fbounds-check
11138 For front ends that support it, generate additional code to check that
11139 indices used to access arrays are within the declared range.  This is
11140 currently only supported by the Fortran front end, where this option
11141 defaults to false.
11143 @item -fcheck-pointer-bounds
11144 @opindex fcheck-pointer-bounds
11145 @opindex fno-check-pointer-bounds
11146 @cindex Pointer Bounds Checker options
11147 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11148 is instrumented with checks of the pointer used for memory access against
11149 bounds associated with that pointer.  
11151 Currently there
11152 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11153 and @option{-mmpx} are required to enable this feature.  
11154 MPX-based instrumentation requires
11155 a runtime library to enable MPX in hardware and handle bounds
11156 violation signals.  By default when @option{-fcheck-pointer-bounds}
11157 and @option{-mmpx} options are used to link a program, the GCC driver
11158 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11159 Bounds checking on calls to dynamic libraries requires a linker
11160 with @option{-z bndplt} support; if GCC was configured with a linker
11161 without support for this option (including the Gold linker and older
11162 versions of ld), a warning is given if you link with @option{-mmpx}
11163 without also specifying @option{-static}, since the overall effectiveness
11164 of the bounds checking protection is reduced.
11165 See also @option{-static-libmpxwrappers}.
11167 MPX-based instrumentation
11168 may be used for debugging and also may be included in production code
11169 to increase program security.  Depending on usage, you may
11170 have different requirements for the runtime library.  The current version
11171 of the MPX runtime library is more oriented for use as a debugging
11172 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11173 also @option{-static-libmpx}.  The runtime library  behavior can be
11174 influenced using various @env{CHKP_RT_*} environment variables.  See
11175 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11176 for more details.
11178 Generated instrumentation may be controlled by various
11179 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11180 structure field attribute (@pxref{Type Attributes}) and
11181 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11182 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11183 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11184 Bounds Checker builtins}, for more information.
11186 @item -fchkp-check-incomplete-type
11187 @opindex fchkp-check-incomplete-type
11188 @opindex fno-chkp-check-incomplete-type
11189 Generate pointer bounds checks for variables with incomplete type.
11190 Enabled by default.
11192 @item -fchkp-narrow-bounds
11193 @opindex fchkp-narrow-bounds
11194 @opindex fno-chkp-narrow-bounds
11195 Controls bounds used by Pointer Bounds Checker for pointers to object
11196 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11197 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11198 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11200 @item -fchkp-first-field-has-own-bounds
11201 @opindex fchkp-first-field-has-own-bounds
11202 @opindex fno-chkp-first-field-has-own-bounds
11203 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11204 first field in the structure.  By default a pointer to the first field has
11205 the same bounds as a pointer to the whole structure.
11207 @item -fchkp-flexible-struct-trailing-arrays
11208 @opindex fchkp-flexible-struct-trailing-arrays
11209 @opindex fno-chkp-flexible-struct-trailing-arrays
11210 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11211 possibly flexible.  By default only array fields with zero length or that are
11212 marked with attribute bnd_variable_size are treated as flexible.
11214 @item -fchkp-narrow-to-innermost-array
11215 @opindex fchkp-narrow-to-innermost-array
11216 @opindex fno-chkp-narrow-to-innermost-array
11217 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11218 case of nested static array access.  By default this option is disabled and
11219 bounds of the outermost array are used.
11221 @item -fchkp-optimize
11222 @opindex fchkp-optimize
11223 @opindex fno-chkp-optimize
11224 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11225 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11227 @item -fchkp-use-fast-string-functions
11228 @opindex fchkp-use-fast-string-functions
11229 @opindex fno-chkp-use-fast-string-functions
11230 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11231 by Pointer Bounds Checker.  Disabled by default.
11233 @item -fchkp-use-nochk-string-functions
11234 @opindex fchkp-use-nochk-string-functions
11235 @opindex fno-chkp-use-nochk-string-functions
11236 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11237 by Pointer Bounds Checker.  Disabled by default.
11239 @item -fchkp-use-static-bounds
11240 @opindex fchkp-use-static-bounds
11241 @opindex fno-chkp-use-static-bounds
11242 Allow Pointer Bounds Checker to generate static bounds holding
11243 bounds of static variables.  Enabled by default.
11245 @item -fchkp-use-static-const-bounds
11246 @opindex fchkp-use-static-const-bounds
11247 @opindex fno-chkp-use-static-const-bounds
11248 Use statically-initialized bounds for constant bounds instead of
11249 generating them each time they are required.  By default enabled when
11250 @option{-fchkp-use-static-bounds} is enabled.
11252 @item -fchkp-treat-zero-dynamic-size-as-infinite
11253 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11254 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11255 With this option, objects with incomplete type whose
11256 dynamically-obtained size is zero are treated as having infinite size
11257 instead by Pointer Bounds
11258 Checker.  This option may be helpful if a program is linked with a library
11259 missing size information for some symbols.  Disabled by default.
11261 @item -fchkp-check-read
11262 @opindex fchkp-check-read
11263 @opindex fno-chkp-check-read
11264 Instructs Pointer Bounds Checker to generate checks for all read
11265 accesses to memory.  Enabled by default.
11267 @item -fchkp-check-write
11268 @opindex fchkp-check-write
11269 @opindex fno-chkp-check-write
11270 Instructs Pointer Bounds Checker to generate checks for all write
11271 accesses to memory.  Enabled by default.
11273 @item -fchkp-store-bounds
11274 @opindex fchkp-store-bounds
11275 @opindex fno-chkp-store-bounds
11276 Instructs Pointer Bounds Checker to generate bounds stores for
11277 pointer writes.  Enabled by default.
11279 @item -fchkp-instrument-calls
11280 @opindex fchkp-instrument-calls
11281 @opindex fno-chkp-instrument-calls
11282 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11283 Enabled by default.
11285 @item -fchkp-instrument-marked-only
11286 @opindex fchkp-instrument-marked-only
11287 @opindex fno-chkp-instrument-marked-only
11288 Instructs Pointer Bounds Checker to instrument only functions
11289 marked with the @code{bnd_instrument} attribute
11290 (@pxref{Function Attributes}).  Disabled by default.
11292 @item -fchkp-use-wrappers
11293 @opindex fchkp-use-wrappers
11294 @opindex fno-chkp-use-wrappers
11295 Allows Pointer Bounds Checker to replace calls to built-in functions
11296 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11297 is used to link a program, the GCC driver automatically links
11298 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11299 Enabled by default.
11301 @item -fstack-protector
11302 @opindex fstack-protector
11303 Emit extra code to check for buffer overflows, such as stack smashing
11304 attacks.  This is done by adding a guard variable to functions with
11305 vulnerable objects.  This includes functions that call @code{alloca}, and
11306 functions with buffers larger than 8 bytes.  The guards are initialized
11307 when a function is entered and then checked when the function exits.
11308 If a guard check fails, an error message is printed and the program exits.
11310 @item -fstack-protector-all
11311 @opindex fstack-protector-all
11312 Like @option{-fstack-protector} except that all functions are protected.
11314 @item -fstack-protector-strong
11315 @opindex fstack-protector-strong
11316 Like @option{-fstack-protector} but includes additional functions to
11317 be protected --- those that have local array definitions, or have
11318 references to local frame addresses.
11320 @item -fstack-protector-explicit
11321 @opindex fstack-protector-explicit
11322 Like @option{-fstack-protector} but only protects those functions which
11323 have the @code{stack_protect} attribute.
11325 @item -fstack-check
11326 @opindex fstack-check
11327 Generate code to verify that you do not go beyond the boundary of the
11328 stack.  You should specify this flag if you are running in an
11329 environment with multiple threads, but you only rarely need to specify it in
11330 a single-threaded environment since stack overflow is automatically
11331 detected on nearly all systems if there is only one stack.
11333 Note that this switch does not actually cause checking to be done; the
11334 operating system or the language runtime must do that.  The switch causes
11335 generation of code to ensure that they see the stack being extended.
11337 You can additionally specify a string parameter: @samp{no} means no
11338 checking, @samp{generic} means force the use of old-style checking,
11339 @samp{specific} means use the best checking method and is equivalent
11340 to bare @option{-fstack-check}.
11342 Old-style checking is a generic mechanism that requires no specific
11343 target support in the compiler but comes with the following drawbacks:
11345 @enumerate
11346 @item
11347 Modified allocation strategy for large objects: they are always
11348 allocated dynamically if their size exceeds a fixed threshold.
11350 @item
11351 Fixed limit on the size of the static frame of functions: when it is
11352 topped by a particular function, stack checking is not reliable and
11353 a warning is issued by the compiler.
11355 @item
11356 Inefficiency: because of both the modified allocation strategy and the
11357 generic implementation, code performance is hampered.
11358 @end enumerate
11360 Note that old-style stack checking is also the fallback method for
11361 @samp{specific} if no target support has been added in the compiler.
11363 @item -fstack-limit-register=@var{reg}
11364 @itemx -fstack-limit-symbol=@var{sym}
11365 @itemx -fno-stack-limit
11366 @opindex fstack-limit-register
11367 @opindex fstack-limit-symbol
11368 @opindex fno-stack-limit
11369 Generate code to ensure that the stack does not grow beyond a certain value,
11370 either the value of a register or the address of a symbol.  If a larger
11371 stack is required, a signal is raised at run time.  For most targets,
11372 the signal is raised before the stack overruns the boundary, so
11373 it is possible to catch the signal without taking special precautions.
11375 For instance, if the stack starts at absolute address @samp{0x80000000}
11376 and grows downwards, you can use the flags
11377 @option{-fstack-limit-symbol=__stack_limit} and
11378 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11379 of 128KB@.  Note that this may only work with the GNU linker.
11381 You can locally override stack limit checking by using the
11382 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11384 @item -fsplit-stack
11385 @opindex fsplit-stack
11386 Generate code to automatically split the stack before it overflows.
11387 The resulting program has a discontiguous stack which can only
11388 overflow if the program is unable to allocate any more memory.  This
11389 is most useful when running threaded programs, as it is no longer
11390 necessary to calculate a good stack size to use for each thread.  This
11391 is currently only implemented for the x86 targets running
11392 GNU/Linux.
11394 When code compiled with @option{-fsplit-stack} calls code compiled
11395 without @option{-fsplit-stack}, there may not be much stack space
11396 available for the latter code to run.  If compiling all code,
11397 including library code, with @option{-fsplit-stack} is not an option,
11398 then the linker can fix up these calls so that the code compiled
11399 without @option{-fsplit-stack} always has a large stack.  Support for
11400 this is implemented in the gold linker in GNU binutils release 2.21
11401 and later.
11403 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11404 @opindex fvtable-verify
11405 This option is only available when compiling C++ code.
11406 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11407 feature that verifies at run time, for every virtual call, that
11408 the vtable pointer through which the call is made is valid for the type of
11409 the object, and has not been corrupted or overwritten.  If an invalid vtable
11410 pointer is detected at run time, an error is reported and execution of the
11411 program is immediately halted.
11413 This option causes run-time data structures to be built at program startup,
11414 which are used for verifying the vtable pointers.  
11415 The options @samp{std} and @samp{preinit}
11416 control the timing of when these data structures are built.  In both cases the
11417 data structures are built before execution reaches @code{main}.  Using
11418 @option{-fvtable-verify=std} causes the data structures to be built after
11419 shared libraries have been loaded and initialized.
11420 @option{-fvtable-verify=preinit} causes them to be built before shared
11421 libraries have been loaded and initialized.
11423 If this option appears multiple times in the command line with different
11424 values specified, @samp{none} takes highest priority over both @samp{std} and
11425 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11427 @item -fvtv-debug
11428 @opindex fvtv-debug
11429 When used in conjunction with @option{-fvtable-verify=std} or 
11430 @option{-fvtable-verify=preinit}, causes debug versions of the 
11431 runtime functions for the vtable verification feature to be called.  
11432 This flag also causes the compiler to log information about which 
11433 vtable pointers it finds for each class.
11434 This information is written to a file named @file{vtv_set_ptr_data.log} 
11435 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11436 if that is defined or the current working directory otherwise.
11438 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11439 file, be sure to delete any existing one.
11441 @item -fvtv-counts
11442 @opindex fvtv-counts
11443 This is a debugging flag.  When used in conjunction with
11444 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11445 causes the compiler to keep track of the total number of virtual calls
11446 it encounters and the number of verifications it inserts.  It also
11447 counts the number of calls to certain run-time library functions
11448 that it inserts and logs this information for each compilation unit.
11449 The compiler writes this information to a file named
11450 @file{vtv_count_data.log} in the directory named by the environment
11451 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11452 directory otherwise.  It also counts the size of the vtable pointer sets
11453 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11454 in the same directory.
11456 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11457 files, be sure to delete any existing ones.
11459 @item -finstrument-functions
11460 @opindex finstrument-functions
11461 Generate instrumentation calls for entry and exit to functions.  Just
11462 after function entry and just before function exit, the following
11463 profiling functions are called with the address of the current
11464 function and its call site.  (On some platforms,
11465 @code{__builtin_return_address} does not work beyond the current
11466 function, so the call site information may not be available to the
11467 profiling functions otherwise.)
11469 @smallexample
11470 void __cyg_profile_func_enter (void *this_fn,
11471                                void *call_site);
11472 void __cyg_profile_func_exit  (void *this_fn,
11473                                void *call_site);
11474 @end smallexample
11476 The first argument is the address of the start of the current function,
11477 which may be looked up exactly in the symbol table.
11479 This instrumentation is also done for functions expanded inline in other
11480 functions.  The profiling calls indicate where, conceptually, the
11481 inline function is entered and exited.  This means that addressable
11482 versions of such functions must be available.  If all your uses of a
11483 function are expanded inline, this may mean an additional expansion of
11484 code size.  If you use @code{extern inline} in your C code, an
11485 addressable version of such functions must be provided.  (This is
11486 normally the case anyway, but if you get lucky and the optimizer always
11487 expands the functions inline, you might have gotten away without
11488 providing static copies.)
11490 A function may be given the attribute @code{no_instrument_function}, in
11491 which case this instrumentation is not done.  This can be used, for
11492 example, for the profiling functions listed above, high-priority
11493 interrupt routines, and any functions from which the profiling functions
11494 cannot safely be called (perhaps signal handlers, if the profiling
11495 routines generate output or allocate memory).
11497 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11498 @opindex finstrument-functions-exclude-file-list
11500 Set the list of functions that are excluded from instrumentation (see
11501 the description of @option{-finstrument-functions}).  If the file that
11502 contains a function definition matches with one of @var{file}, then
11503 that function is not instrumented.  The match is done on substrings:
11504 if the @var{file} parameter is a substring of the file name, it is
11505 considered to be a match.
11507 For example:
11509 @smallexample
11510 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11511 @end smallexample
11513 @noindent
11514 excludes any inline function defined in files whose pathnames
11515 contain @file{/bits/stl} or @file{include/sys}.
11517 If, for some reason, you want to include letter @samp{,} in one of
11518 @var{sym}, write @samp{\,}. For example,
11519 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11520 (note the single quote surrounding the option).
11522 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11523 @opindex finstrument-functions-exclude-function-list
11525 This is similar to @option{-finstrument-functions-exclude-file-list},
11526 but this option sets the list of function names to be excluded from
11527 instrumentation.  The function name to be matched is its user-visible
11528 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11529 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11530 match is done on substrings: if the @var{sym} parameter is a substring
11531 of the function name, it is considered to be a match.  For C99 and C++
11532 extended identifiers, the function name must be given in UTF-8, not
11533 using universal character names.
11535 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11536 @opindex fpatchable-function-entry
11537 Generate @var{N} NOPs right at the beginning
11538 of each function, with the function entry point before the @var{M}th NOP.
11539 If @var{M} is omitted, it defaults to @code{0} so the
11540 function entry points to the address just at the first NOP.
11541 The NOP instructions reserve extra space which can be used to patch in
11542 any desired instrumentation at run time, provided that the code segment
11543 is writable.  The amount of space is controllable indirectly via
11544 the number of NOPs; the NOP instruction used corresponds to the instruction
11545 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11546 is target-specific and may also depend on the architecture variant and/or
11547 other compilation options.
11549 For run-time identification, the starting addresses of these areas,
11550 which correspond to their respective function entries minus @var{M},
11551 are additionally collected in the @code{__patchable_function_entries}
11552 section of the resulting binary.
11554 Note that the value of @code{__attribute__ ((patchable_function_entry
11555 (N,M)))} takes precedence over command-line option
11556 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11557 the area size or to remove it completely on a single function.
11558 If @code{N=0}, no pad location is recorded.
11560 The NOP instructions are inserted at---and maybe before, depending on
11561 @var{M}---the function entry address, even before the prologue.
11563 @end table
11566 @node Preprocessor Options
11567 @section Options Controlling the Preprocessor
11568 @cindex preprocessor options
11569 @cindex options, preprocessor
11571 These options control the C preprocessor, which is run on each C source
11572 file before actual compilation.
11574 If you use the @option{-E} option, nothing is done except preprocessing.
11575 Some of these options make sense only together with @option{-E} because
11576 they cause the preprocessor output to be unsuitable for actual
11577 compilation.
11579 In addition to the options listed here, there are a number of options 
11580 to control search paths for include files documented in 
11581 @ref{Directory Options}.  
11582 Options to control preprocessor diagnostics are listed in 
11583 @ref{Warning Options}.
11585 @table @gcctabopt
11586 @include cppopts.texi
11588 @item -Wp,@var{option}
11589 @opindex Wp
11590 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11591 and pass @var{option} directly through to the preprocessor.  If
11592 @var{option} contains commas, it is split into multiple options at the
11593 commas.  However, many options are modified, translated or interpreted
11594 by the compiler driver before being passed to the preprocessor, and
11595 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11596 interface is undocumented and subject to change, so whenever possible
11597 you should avoid using @option{-Wp} and let the driver handle the
11598 options instead.
11600 @item -Xpreprocessor @var{option}
11601 @opindex Xpreprocessor
11602 Pass @var{option} as an option to the preprocessor.  You can use this to
11603 supply system-specific preprocessor options that GCC does not 
11604 recognize.
11606 If you want to pass an option that takes an argument, you must use
11607 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11609 @item -no-integrated-cpp
11610 @opindex no-integrated-cpp
11611 Perform preprocessing as a separate pass before compilation.
11612 By default, GCC performs preprocessing as an integrated part of
11613 input tokenization and parsing.
11614 If this option is provided, the appropriate language front end
11615 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11616 and Objective-C, respectively) is instead invoked twice,
11617 once for preprocessing only and once for actual compilation
11618 of the preprocessed input.
11619 This option may be useful in conjunction with the @option{-B} or
11620 @option{-wrapper} options to specify an alternate preprocessor or
11621 perform additional processing of the program source between
11622 normal preprocessing and compilation.
11624 @end table
11626 @node Assembler Options
11627 @section Passing Options to the Assembler
11629 @c prevent bad page break with this line
11630 You can pass options to the assembler.
11632 @table @gcctabopt
11633 @item -Wa,@var{option}
11634 @opindex Wa
11635 Pass @var{option} as an option to the assembler.  If @var{option}
11636 contains commas, it is split into multiple options at the commas.
11638 @item -Xassembler @var{option}
11639 @opindex Xassembler
11640 Pass @var{option} as an option to the assembler.  You can use this to
11641 supply system-specific assembler options that GCC does not
11642 recognize.
11644 If you want to pass an option that takes an argument, you must use
11645 @option{-Xassembler} twice, once for the option and once for the argument.
11647 @end table
11649 @node Link Options
11650 @section Options for Linking
11651 @cindex link options
11652 @cindex options, linking
11654 These options come into play when the compiler links object files into
11655 an executable output file.  They are meaningless if the compiler is
11656 not doing a link step.
11658 @table @gcctabopt
11659 @cindex file names
11660 @item @var{object-file-name}
11661 A file name that does not end in a special recognized suffix is
11662 considered to name an object file or library.  (Object files are
11663 distinguished from libraries by the linker according to the file
11664 contents.)  If linking is done, these object files are used as input
11665 to the linker.
11667 @item -c
11668 @itemx -S
11669 @itemx -E
11670 @opindex c
11671 @opindex S
11672 @opindex E
11673 If any of these options is used, then the linker is not run, and
11674 object file names should not be used as arguments.  @xref{Overall
11675 Options}.
11677 @item -fuse-ld=bfd
11678 @opindex fuse-ld=bfd
11679 Use the @command{bfd} linker instead of the default linker.
11681 @item -fuse-ld=gold
11682 @opindex fuse-ld=gold
11683 Use the @command{gold} linker instead of the default linker.
11685 @cindex Libraries
11686 @item -l@var{library}
11687 @itemx -l @var{library}
11688 @opindex l
11689 Search the library named @var{library} when linking.  (The second
11690 alternative with the library as a separate argument is only for
11691 POSIX compliance and is not recommended.)
11693 It makes a difference where in the command you write this option; the
11694 linker searches and processes libraries and object files in the order they
11695 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11696 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11697 to functions in @samp{z}, those functions may not be loaded.
11699 The linker searches a standard list of directories for the library,
11700 which is actually a file named @file{lib@var{library}.a}.  The linker
11701 then uses this file as if it had been specified precisely by name.
11703 The directories searched include several standard system directories
11704 plus any that you specify with @option{-L}.
11706 Normally the files found this way are library files---archive files
11707 whose members are object files.  The linker handles an archive file by
11708 scanning through it for members which define symbols that have so far
11709 been referenced but not defined.  But if the file that is found is an
11710 ordinary object file, it is linked in the usual fashion.  The only
11711 difference between using an @option{-l} option and specifying a file name
11712 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11713 and searches several directories.
11715 @item -lobjc
11716 @opindex lobjc
11717 You need this special case of the @option{-l} option in order to
11718 link an Objective-C or Objective-C++ program.
11720 @item -nostartfiles
11721 @opindex nostartfiles
11722 Do not use the standard system startup files when linking.
11723 The standard system libraries are used normally, unless @option{-nostdlib}
11724 or @option{-nodefaultlibs} is used.
11726 @item -nodefaultlibs
11727 @opindex nodefaultlibs
11728 Do not use the standard system libraries when linking.
11729 Only the libraries you specify are passed to the linker, and options
11730 specifying linkage of the system libraries, such as @option{-static-libgcc}
11731 or @option{-shared-libgcc}, are ignored.  
11732 The standard startup files are used normally, unless @option{-nostartfiles}
11733 is used.  
11735 The compiler may generate calls to @code{memcmp},
11736 @code{memset}, @code{memcpy} and @code{memmove}.
11737 These entries are usually resolved by entries in
11738 libc.  These entry points should be supplied through some other
11739 mechanism when this option is specified.
11741 @item -nostdlib
11742 @opindex nostdlib
11743 Do not use the standard system startup files or libraries when linking.
11744 No startup files and only the libraries you specify are passed to
11745 the linker, and options specifying linkage of the system libraries, such as
11746 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11748 The compiler may generate calls to @code{memcmp}, @code{memset},
11749 @code{memcpy} and @code{memmove}.
11750 These entries are usually resolved by entries in
11751 libc.  These entry points should be supplied through some other
11752 mechanism when this option is specified.
11754 @cindex @option{-lgcc}, use with @option{-nostdlib}
11755 @cindex @option{-nostdlib} and unresolved references
11756 @cindex unresolved references and @option{-nostdlib}
11757 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11758 @cindex @option{-nodefaultlibs} and unresolved references
11759 @cindex unresolved references and @option{-nodefaultlibs}
11760 One of the standard libraries bypassed by @option{-nostdlib} and
11761 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11762 which GCC uses to overcome shortcomings of particular machines, or special
11763 needs for some languages.
11764 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11765 Collection (GCC) Internals},
11766 for more discussion of @file{libgcc.a}.)
11767 In most cases, you need @file{libgcc.a} even when you want to avoid
11768 other standard libraries.  In other words, when you specify @option{-nostdlib}
11769 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11770 This ensures that you have no unresolved references to internal GCC
11771 library subroutines.
11772 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11773 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11774 GNU Compiler Collection (GCC) Internals}.)
11776 @item -pie
11777 @opindex pie
11778 Produce a position independent executable on targets that support it.
11779 For predictable results, you must also specify the same set of options
11780 used for compilation (@option{-fpie}, @option{-fPIE},
11781 or model suboptions) when you specify this linker option.
11783 @item -no-pie
11784 @opindex no-pie
11785 Don't produce a position independent executable.
11787 @item -pthread
11788 @opindex pthread
11789 Link with the POSIX threads library.  This option is supported on 
11790 GNU/Linux targets, most other Unix derivatives, and also on 
11791 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11792 flags for the preprocessor, so it should be used consistently for both
11793 compilation and linking.
11795 @item -rdynamic
11796 @opindex rdynamic
11797 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11798 that support it. This instructs the linker to add all symbols, not
11799 only used ones, to the dynamic symbol table. This option is needed
11800 for some uses of @code{dlopen} or to allow obtaining backtraces
11801 from within a program.
11803 @item -s
11804 @opindex s
11805 Remove all symbol table and relocation information from the executable.
11807 @item -static
11808 @opindex static
11809 On systems that support dynamic linking, this prevents linking with the shared
11810 libraries.  On other systems, this option has no effect.
11812 @item -shared
11813 @opindex shared
11814 Produce a shared object which can then be linked with other objects to
11815 form an executable.  Not all systems support this option.  For predictable
11816 results, you must also specify the same set of options used for compilation
11817 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11818 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11819 needs to build supplementary stub code for constructors to work.  On
11820 multi-libbed systems, @samp{gcc -shared} must select the correct support
11821 libraries to link against.  Failing to supply the correct flags may lead
11822 to subtle defects.  Supplying them in cases where they are not necessary
11823 is innocuous.}
11825 @item -shared-libgcc
11826 @itemx -static-libgcc
11827 @opindex shared-libgcc
11828 @opindex static-libgcc
11829 On systems that provide @file{libgcc} as a shared library, these options
11830 force the use of either the shared or static version, respectively.
11831 If no shared version of @file{libgcc} was built when the compiler was
11832 configured, these options have no effect.
11834 There are several situations in which an application should use the
11835 shared @file{libgcc} instead of the static version.  The most common
11836 of these is when the application wishes to throw and catch exceptions
11837 across different shared libraries.  In that case, each of the libraries
11838 as well as the application itself should use the shared @file{libgcc}.
11840 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11841  whenever you build a shared library or a main executable, because C++
11842  programs typically use exceptions, so this is the right thing to do.
11844 If, instead, you use the GCC driver to create shared libraries, you may
11845 find that they are not always linked with the shared @file{libgcc}.
11846 If GCC finds, at its configuration time, that you have a non-GNU linker
11847 or a GNU linker that does not support option @option{--eh-frame-hdr},
11848 it links the shared version of @file{libgcc} into shared libraries
11849 by default.  Otherwise, it takes advantage of the linker and optimizes
11850 away the linking with the shared version of @file{libgcc}, linking with
11851 the static version of libgcc by default.  This allows exceptions to
11852 propagate through such shared libraries, without incurring relocation
11853 costs at library load time.
11855 However, if a library or main executable is supposed to throw or catch
11856 exceptions, you must link it using the G++ driver, as appropriate
11857 for the languages used in the program, or using the option
11858 @option{-shared-libgcc}, such that it is linked with the shared
11859 @file{libgcc}.
11861 @item -static-libasan
11862 @opindex static-libasan
11863 When the @option{-fsanitize=address} option is used to link a program,
11864 the GCC driver automatically links against @option{libasan}.  If
11865 @file{libasan} is available as a shared library, and the @option{-static}
11866 option is not used, then this links against the shared version of
11867 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11868 driver to link @file{libasan} statically, without necessarily linking
11869 other libraries statically.
11871 @item -static-libtsan
11872 @opindex static-libtsan
11873 When the @option{-fsanitize=thread} option is used to link a program,
11874 the GCC driver automatically links against @option{libtsan}.  If
11875 @file{libtsan} is available as a shared library, and the @option{-static}
11876 option is not used, then this links against the shared version of
11877 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11878 driver to link @file{libtsan} statically, without necessarily linking
11879 other libraries statically.
11881 @item -static-liblsan
11882 @opindex static-liblsan
11883 When the @option{-fsanitize=leak} option is used to link a program,
11884 the GCC driver automatically links against @option{liblsan}.  If
11885 @file{liblsan} is available as a shared library, and the @option{-static}
11886 option is not used, then this links against the shared version of
11887 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11888 driver to link @file{liblsan} statically, without necessarily linking
11889 other libraries statically.
11891 @item -static-libubsan
11892 @opindex static-libubsan
11893 When the @option{-fsanitize=undefined} option is used to link a program,
11894 the GCC driver automatically links against @option{libubsan}.  If
11895 @file{libubsan} is available as a shared library, and the @option{-static}
11896 option is not used, then this links against the shared version of
11897 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11898 driver to link @file{libubsan} statically, without necessarily linking
11899 other libraries statically.
11901 @item -static-libmpx
11902 @opindex static-libmpx
11903 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11904 used to link a program, the GCC driver automatically links against
11905 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11906 and the @option{-static} option is not used, then this links against
11907 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11908 option directs the GCC driver to link @file{libmpx} statically,
11909 without necessarily linking other libraries statically.
11911 @item -static-libmpxwrappers
11912 @opindex static-libmpxwrappers
11913 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11914 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11915 GCC driver automatically links against @file{libmpxwrappers}.  If
11916 @file{libmpxwrappers} is available as a shared library, and the
11917 @option{-static} option is not used, then this links against the shared
11918 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11919 option directs the GCC driver to link @file{libmpxwrappers} statically,
11920 without necessarily linking other libraries statically.
11922 @item -static-libstdc++
11923 @opindex static-libstdc++
11924 When the @command{g++} program is used to link a C++ program, it
11925 normally automatically links against @option{libstdc++}.  If
11926 @file{libstdc++} is available as a shared library, and the
11927 @option{-static} option is not used, then this links against the
11928 shared version of @file{libstdc++}.  That is normally fine.  However, it
11929 is sometimes useful to freeze the version of @file{libstdc++} used by
11930 the program without going all the way to a fully static link.  The
11931 @option{-static-libstdc++} option directs the @command{g++} driver to
11932 link @file{libstdc++} statically, without necessarily linking other
11933 libraries statically.
11935 @item -symbolic
11936 @opindex symbolic
11937 Bind references to global symbols when building a shared object.  Warn
11938 about any unresolved references (unless overridden by the link editor
11939 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11940 this option.
11942 @item -T @var{script}
11943 @opindex T
11944 @cindex linker script
11945 Use @var{script} as the linker script.  This option is supported by most
11946 systems using the GNU linker.  On some targets, such as bare-board
11947 targets without an operating system, the @option{-T} option may be required
11948 when linking to avoid references to undefined symbols.
11950 @item -Xlinker @var{option}
11951 @opindex Xlinker
11952 Pass @var{option} as an option to the linker.  You can use this to
11953 supply system-specific linker options that GCC does not recognize.
11955 If you want to pass an option that takes a separate argument, you must use
11956 @option{-Xlinker} twice, once for the option and once for the argument.
11957 For example, to pass @option{-assert definitions}, you must write
11958 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11959 @option{-Xlinker "-assert definitions"}, because this passes the entire
11960 string as a single argument, which is not what the linker expects.
11962 When using the GNU linker, it is usually more convenient to pass
11963 arguments to linker options using the @option{@var{option}=@var{value}}
11964 syntax than as separate arguments.  For example, you can specify
11965 @option{-Xlinker -Map=output.map} rather than
11966 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11967 this syntax for command-line options.
11969 @item -Wl,@var{option}
11970 @opindex Wl
11971 Pass @var{option} as an option to the linker.  If @var{option} contains
11972 commas, it is split into multiple options at the commas.  You can use this
11973 syntax to pass an argument to the option.
11974 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11975 linker.  When using the GNU linker, you can also get the same effect with
11976 @option{-Wl,-Map=output.map}.
11978 @item -u @var{symbol}
11979 @opindex u
11980 Pretend the symbol @var{symbol} is undefined, to force linking of
11981 library modules to define it.  You can use @option{-u} multiple times with
11982 different symbols to force loading of additional library modules.
11984 @item -z @var{keyword}
11985 @opindex z
11986 @option{-z} is passed directly on to the linker along with the keyword
11987 @var{keyword}. See the section in the documentation of your linker for
11988 permitted values and their meanings.
11989 @end table
11991 @node Directory Options
11992 @section Options for Directory Search
11993 @cindex directory options
11994 @cindex options, directory search
11995 @cindex search path
11997 These options specify directories to search for header files, for
11998 libraries and for parts of the compiler:
12000 @table @gcctabopt
12001 @include cppdiropts.texi
12003 @item -iplugindir=@var{dir}
12004 @opindex iplugindir=
12005 Set the directory to search for plugins that are passed
12006 by @option{-fplugin=@var{name}} instead of
12007 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12008 to be used by the user, but only passed by the driver.
12010 @item -L@var{dir}
12011 @opindex L
12012 Add directory @var{dir} to the list of directories to be searched
12013 for @option{-l}.
12015 @item -B@var{prefix}
12016 @opindex B
12017 This option specifies where to find the executables, libraries,
12018 include files, and data files of the compiler itself.
12020 The compiler driver program runs one or more of the subprograms
12021 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12022 @var{prefix} as a prefix for each program it tries to run, both with and
12023 without @samp{@var{machine}/@var{version}/} for the corresponding target
12024 machine and compiler version.
12026 For each subprogram to be run, the compiler driver first tries the
12027 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12028 is not specified, the driver tries two standard prefixes, 
12029 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12030 those results in a file name that is found, the unmodified program
12031 name is searched for using the directories specified in your
12032 @env{PATH} environment variable.
12034 The compiler checks to see if the path provided by @option{-B}
12035 refers to a directory, and if necessary it adds a directory
12036 separator character at the end of the path.
12038 @option{-B} prefixes that effectively specify directory names also apply
12039 to libraries in the linker, because the compiler translates these
12040 options into @option{-L} options for the linker.  They also apply to
12041 include files in the preprocessor, because the compiler translates these
12042 options into @option{-isystem} options for the preprocessor.  In this case,
12043 the compiler appends @samp{include} to the prefix.
12045 The runtime support file @file{libgcc.a} can also be searched for using
12046 the @option{-B} prefix, if needed.  If it is not found there, the two
12047 standard prefixes above are tried, and that is all.  The file is left
12048 out of the link if it is not found by those means.
12050 Another way to specify a prefix much like the @option{-B} prefix is to use
12051 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12052 Variables}.
12054 As a special kludge, if the path provided by @option{-B} is
12055 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12056 9, then it is replaced by @file{[dir/]include}.  This is to help
12057 with boot-strapping the compiler.
12059 @item -no-canonical-prefixes
12060 @opindex no-canonical-prefixes
12061 Do not expand any symbolic links, resolve references to @samp{/../}
12062 or @samp{/./}, or make the path absolute when generating a relative
12063 prefix.
12065 @item --sysroot=@var{dir}
12066 @opindex sysroot
12067 Use @var{dir} as the logical root directory for headers and libraries.
12068 For example, if the compiler normally searches for headers in
12069 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12070 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12072 If you use both this option and the @option{-isysroot} option, then
12073 the @option{--sysroot} option applies to libraries, but the
12074 @option{-isysroot} option applies to header files.
12076 The GNU linker (beginning with version 2.16) has the necessary support
12077 for this option.  If your linker does not support this option, the
12078 header file aspect of @option{--sysroot} still works, but the
12079 library aspect does not.
12081 @item --no-sysroot-suffix
12082 @opindex no-sysroot-suffix
12083 For some targets, a suffix is added to the root directory specified
12084 with @option{--sysroot}, depending on the other options used, so that
12085 headers may for example be found in
12086 @file{@var{dir}/@var{suffix}/usr/include} instead of
12087 @file{@var{dir}/usr/include}.  This option disables the addition of
12088 such a suffix.
12090 @end table
12092 @node Code Gen Options
12093 @section Options for Code Generation Conventions
12094 @cindex code generation conventions
12095 @cindex options, code generation
12096 @cindex run-time options
12098 These machine-independent options control the interface conventions
12099 used in code generation.
12101 Most of them have both positive and negative forms; the negative form
12102 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12103 one of the forms is listed---the one that is not the default.  You
12104 can figure out the other form by either removing @samp{no-} or adding
12107 @table @gcctabopt
12108 @item -fstack-reuse=@var{reuse-level}
12109 @opindex fstack_reuse
12110 This option controls stack space reuse for user declared local/auto variables
12111 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12112 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12113 local variables and temporaries, @samp{named_vars} enables the reuse only for
12114 user defined local variables with names, and @samp{none} disables stack reuse
12115 completely. The default value is @samp{all}. The option is needed when the
12116 program extends the lifetime of a scoped local variable or a compiler generated
12117 temporary beyond the end point defined by the language.  When a lifetime of
12118 a variable ends, and if the variable lives in memory, the optimizing compiler
12119 has the freedom to reuse its stack space with other temporaries or scoped
12120 local variables whose live range does not overlap with it. Legacy code extending
12121 local lifetime is likely to break with the stack reuse optimization.
12123 For example,
12125 @smallexample
12126    int *p;
12127    @{
12128      int local1;
12130      p = &local1;
12131      local1 = 10;
12132      ....
12133    @}
12134    @{
12135       int local2;
12136       local2 = 20;
12137       ...
12138    @}
12140    if (*p == 10)  // out of scope use of local1
12141      @{
12143      @}
12144 @end smallexample
12146 Another example:
12147 @smallexample
12149    struct A
12150    @{
12151        A(int k) : i(k), j(k) @{ @}
12152        int i;
12153        int j;
12154    @};
12156    A *ap;
12158    void foo(const A& ar)
12159    @{
12160       ap = &ar;
12161    @}
12163    void bar()
12164    @{
12165       foo(A(10)); // temp object's lifetime ends when foo returns
12167       @{
12168         A a(20);
12169         ....
12170       @}
12171       ap->i+= 10;  // ap references out of scope temp whose space
12172                    // is reused with a. What is the value of ap->i?
12173    @}
12175 @end smallexample
12177 The lifetime of a compiler generated temporary is well defined by the C++
12178 standard. When a lifetime of a temporary ends, and if the temporary lives
12179 in memory, the optimizing compiler has the freedom to reuse its stack
12180 space with other temporaries or scoped local variables whose live range
12181 does not overlap with it. However some of the legacy code relies on
12182 the behavior of older compilers in which temporaries' stack space is
12183 not reused, the aggressive stack reuse can lead to runtime errors. This
12184 option is used to control the temporary stack reuse optimization.
12186 @item -ftrapv
12187 @opindex ftrapv
12188 This option generates traps for signed overflow on addition, subtraction,
12189 multiplication operations.
12190 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12191 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12192 @option{-fwrapv} being effective.  Note that only active options override, so
12193 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12194 results in @option{-ftrapv} being effective.
12196 @item -fwrapv
12197 @opindex fwrapv
12198 This option instructs the compiler to assume that signed arithmetic
12199 overflow of addition, subtraction and multiplication wraps around
12200 using twos-complement representation.  This flag enables some optimizations
12201 and disables others.
12202 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12203 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12204 @option{-fwrapv} being effective.  Note that only active options override, so
12205 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12206 results in @option{-ftrapv} being effective.
12208 @item -fexceptions
12209 @opindex fexceptions
12210 Enable exception handling.  Generates extra code needed to propagate
12211 exceptions.  For some targets, this implies GCC generates frame
12212 unwind information for all functions, which can produce significant data
12213 size overhead, although it does not affect execution.  If you do not
12214 specify this option, GCC enables it by default for languages like
12215 C++ that normally require exception handling, and disables it for
12216 languages like C that do not normally require it.  However, you may need
12217 to enable this option when compiling C code that needs to interoperate
12218 properly with exception handlers written in C++.  You may also wish to
12219 disable this option if you are compiling older C++ programs that don't
12220 use exception handling.
12222 @item -fnon-call-exceptions
12223 @opindex fnon-call-exceptions
12224 Generate code that allows trapping instructions to throw exceptions.
12225 Note that this requires platform-specific runtime support that does
12226 not exist everywhere.  Moreover, it only allows @emph{trapping}
12227 instructions to throw exceptions, i.e.@: memory references or floating-point
12228 instructions.  It does not allow exceptions to be thrown from
12229 arbitrary signal handlers such as @code{SIGALRM}.
12231 @item -fdelete-dead-exceptions
12232 @opindex fdelete-dead-exceptions
12233 Consider that instructions that may throw exceptions but don't otherwise
12234 contribute to the execution of the program can be optimized away.
12235 This option is enabled by default for the Ada front end, as permitted by
12236 the Ada language specification.
12237 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12239 @item -funwind-tables
12240 @opindex funwind-tables
12241 Similar to @option{-fexceptions}, except that it just generates any needed
12242 static data, but does not affect the generated code in any other way.
12243 You normally do not need to enable this option; instead, a language processor
12244 that needs this handling enables it on your behalf.
12246 @item -fasynchronous-unwind-tables
12247 @opindex fasynchronous-unwind-tables
12248 Generate unwind table in DWARF format, if supported by target machine.  The
12249 table is exact at each instruction boundary, so it can be used for stack
12250 unwinding from asynchronous events (such as debugger or garbage collector).
12252 @item -fno-gnu-unique
12253 @opindex fno-gnu-unique
12254 On systems with recent GNU assembler and C library, the C++ compiler
12255 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12256 of template static data members and static local variables in inline
12257 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12258 is necessary to avoid problems with a library used by two different
12259 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12260 therefore disagreeing with the other one about the binding of the
12261 symbol.  But this causes @code{dlclose} to be ignored for affected
12262 DSOs; if your program relies on reinitialization of a DSO via
12263 @code{dlclose} and @code{dlopen}, you can use
12264 @option{-fno-gnu-unique}.
12266 @item -fpcc-struct-return
12267 @opindex fpcc-struct-return
12268 Return ``short'' @code{struct} and @code{union} values in memory like
12269 longer ones, rather than in registers.  This convention is less
12270 efficient, but it has the advantage of allowing intercallability between
12271 GCC-compiled files and files compiled with other compilers, particularly
12272 the Portable C Compiler (pcc).
12274 The precise convention for returning structures in memory depends
12275 on the target configuration macros.
12277 Short structures and unions are those whose size and alignment match
12278 that of some integer type.
12280 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12281 switch is not binary compatible with code compiled with the
12282 @option{-freg-struct-return} switch.
12283 Use it to conform to a non-default application binary interface.
12285 @item -freg-struct-return
12286 @opindex freg-struct-return
12287 Return @code{struct} and @code{union} values in registers when possible.
12288 This is more efficient for small structures than
12289 @option{-fpcc-struct-return}.
12291 If you specify neither @option{-fpcc-struct-return} nor
12292 @option{-freg-struct-return}, GCC defaults to whichever convention is
12293 standard for the target.  If there is no standard convention, GCC
12294 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12295 the principal compiler.  In those cases, we can choose the standard, and
12296 we chose the more efficient register return alternative.
12298 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12299 switch is not binary compatible with code compiled with the
12300 @option{-fpcc-struct-return} switch.
12301 Use it to conform to a non-default application binary interface.
12303 @item -fshort-enums
12304 @opindex fshort-enums
12305 Allocate to an @code{enum} type only as many bytes as it needs for the
12306 declared range of possible values.  Specifically, the @code{enum} type
12307 is equivalent to the smallest integer type that has enough room.
12309 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12310 code that is not binary compatible with code generated without that switch.
12311 Use it to conform to a non-default application binary interface.
12313 @item -fshort-wchar
12314 @opindex fshort-wchar
12315 Override the underlying type for @code{wchar_t} to be @code{short
12316 unsigned int} instead of the default for the target.  This option is
12317 useful for building programs to run under WINE@.
12319 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12320 code that is not binary compatible with code generated without that switch.
12321 Use it to conform to a non-default application binary interface.
12323 @item -fno-common
12324 @opindex fno-common
12325 @cindex tentative definitions
12326 In C code, this option controls the placement of global variables 
12327 defined without an initializer, known as @dfn{tentative definitions} 
12328 in the C standard.  Tentative definitions are distinct from declarations 
12329 of a variable with the @code{extern} keyword, which do not allocate storage.
12331 Unix C compilers have traditionally allocated storage for
12332 uninitialized global variables in a common block.  This allows the
12333 linker to resolve all tentative definitions of the same variable
12334 in different compilation units to the same object, or to a non-tentative
12335 definition.  
12336 This is the behavior specified by @option{-fcommon}, and is the default for 
12337 GCC on most targets.  
12338 On the other hand, this behavior is not required by ISO
12339 C, and on some targets may carry a speed or code size penalty on
12340 variable references.
12342 The @option{-fno-common} option specifies that the compiler should instead
12343 place uninitialized global variables in the data section of the object file.
12344 This inhibits the merging of tentative definitions by the linker so
12345 you get a multiple-definition error if the same 
12346 variable is defined in more than one compilation unit.
12347 Compiling with @option{-fno-common} is useful on targets for which
12348 it provides better performance, or if you wish to verify that the
12349 program will work on other systems that always treat uninitialized
12350 variable definitions this way.
12352 @item -fno-ident
12353 @opindex fno-ident
12354 Ignore the @code{#ident} directive.
12356 @item -finhibit-size-directive
12357 @opindex finhibit-size-directive
12358 Don't output a @code{.size} assembler directive, or anything else that
12359 would cause trouble if the function is split in the middle, and the
12360 two halves are placed at locations far apart in memory.  This option is
12361 used when compiling @file{crtstuff.c}; you should not need to use it
12362 for anything else.
12364 @item -fverbose-asm
12365 @opindex fverbose-asm
12366 Put extra commentary information in the generated assembly code to
12367 make it more readable.  This option is generally only of use to those
12368 who actually need to read the generated assembly code (perhaps while
12369 debugging the compiler itself).
12371 @option{-fno-verbose-asm}, the default, causes the
12372 extra information to be omitted and is useful when comparing two assembler
12373 files.
12375 The added comments include:
12377 @itemize @bullet
12379 @item
12380 information on the compiler version and command-line options,
12382 @item
12383 the source code lines associated with the assembly instructions,
12384 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12386 @item
12387 hints on which high-level expressions correspond to
12388 the various assembly instruction operands.
12390 @end itemize
12392 For example, given this C source file:
12394 @smallexample
12395 int test (int n)
12397   int i;
12398   int total = 0;
12400   for (i = 0; i < n; i++)
12401     total += i * i;
12403   return total;
12405 @end smallexample
12407 compiling to (x86_64) assembly via @option{-S} and emitting the result
12408 direct to stdout via @option{-o} @option{-}
12410 @smallexample
12411 gcc -S test.c -fverbose-asm -Os -o -
12412 @end smallexample
12414 gives output similar to this:
12416 @smallexample
12417         .file   "test.c"
12418 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12419   [...snip...]
12420 # options passed:
12421   [...snip...]
12423         .text
12424         .globl  test
12425         .type   test, @@function
12426 test:
12427 .LFB0:
12428         .cfi_startproc
12429 # test.c:4:   int total = 0;
12430         xorl    %eax, %eax      # <retval>
12431 # test.c:6:   for (i = 0; i < n; i++)
12432         xorl    %edx, %edx      # i
12433 .L2:
12434 # test.c:6:   for (i = 0; i < n; i++)
12435         cmpl    %edi, %edx      # n, i
12436         jge     .L5     #,
12437 # test.c:7:     total += i * i;
12438         movl    %edx, %ecx      # i, tmp92
12439         imull   %edx, %ecx      # i, tmp92
12440 # test.c:6:   for (i = 0; i < n; i++)
12441         incl    %edx    # i
12442 # test.c:7:     total += i * i;
12443         addl    %ecx, %eax      # tmp92, <retval>
12444         jmp     .L2     #
12445 .L5:
12446 # test.c:10: @}
12447         ret
12448         .cfi_endproc
12449 .LFE0:
12450         .size   test, .-test
12451         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12452         .section        .note.GNU-stack,"",@@progbits
12453 @end smallexample
12455 The comments are intended for humans rather than machines and hence the
12456 precise format of the comments is subject to change.
12458 @item -frecord-gcc-switches
12459 @opindex frecord-gcc-switches
12460 This switch causes the command line used to invoke the
12461 compiler to be recorded into the object file that is being created.
12462 This switch is only implemented on some targets and the exact format
12463 of the recording is target and binary file format dependent, but it
12464 usually takes the form of a section containing ASCII text.  This
12465 switch is related to the @option{-fverbose-asm} switch, but that
12466 switch only records information in the assembler output file as
12467 comments, so it never reaches the object file.
12468 See also @option{-grecord-gcc-switches} for another
12469 way of storing compiler options into the object file.
12471 @item -fpic
12472 @opindex fpic
12473 @cindex global offset table
12474 @cindex PIC
12475 Generate position-independent code (PIC) suitable for use in a shared
12476 library, if supported for the target machine.  Such code accesses all
12477 constant addresses through a global offset table (GOT)@.  The dynamic
12478 loader resolves the GOT entries when the program starts (the dynamic
12479 loader is not part of GCC; it is part of the operating system).  If
12480 the GOT size for the linked executable exceeds a machine-specific
12481 maximum size, you get an error message from the linker indicating that
12482 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12483 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12484 on the m68k and RS/6000.  The x86 has no such limit.)
12486 Position-independent code requires special support, and therefore works
12487 only on certain machines.  For the x86, GCC supports PIC for System V
12488 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12489 position-independent.
12491 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12492 are defined to 1.
12494 @item -fPIC
12495 @opindex fPIC
12496 If supported for the target machine, emit position-independent code,
12497 suitable for dynamic linking and avoiding any limit on the size of the
12498 global offset table.  This option makes a difference on AArch64, m68k,
12499 PowerPC and SPARC@.
12501 Position-independent code requires special support, and therefore works
12502 only on certain machines.
12504 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12505 are defined to 2.
12507 @item -fpie
12508 @itemx -fPIE
12509 @opindex fpie
12510 @opindex fPIE
12511 These options are similar to @option{-fpic} and @option{-fPIC}, but
12512 generated position independent code can be only linked into executables.
12513 Usually these options are used when @option{-pie} GCC option is
12514 used during linking.
12516 @option{-fpie} and @option{-fPIE} both define the macros
12517 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12518 for @option{-fpie} and 2 for @option{-fPIE}.
12520 @item -fno-plt
12521 @opindex fno-plt
12522 Do not use the PLT for external function calls in position-independent code.
12523 Instead, load the callee address at call sites from the GOT and branch to it.
12524 This leads to more efficient code by eliminating PLT stubs and exposing
12525 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12526 PLT stubs expect the GOT pointer in a specific register, this gives more
12527 register allocation freedom to the compiler.
12528 Lazy binding requires use of the PLT; 
12529 with @option{-fno-plt} all external symbols are resolved at load time.
12531 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12532 through the PLT for specific external functions.
12534 In position-dependent code, a few targets also convert calls to
12535 functions that are marked to not use the PLT to use the GOT instead.
12537 @item -fno-jump-tables
12538 @opindex fno-jump-tables
12539 Do not use jump tables for switch statements even where it would be
12540 more efficient than other code generation strategies.  This option is
12541 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12542 building code that forms part of a dynamic linker and cannot
12543 reference the address of a jump table.  On some targets, jump tables
12544 do not require a GOT and this option is not needed.
12546 @item -ffixed-@var{reg}
12547 @opindex ffixed
12548 Treat the register named @var{reg} as a fixed register; generated code
12549 should never refer to it (except perhaps as a stack pointer, frame
12550 pointer or in some other fixed role).
12552 @var{reg} must be the name of a register.  The register names accepted
12553 are machine-specific and are defined in the @code{REGISTER_NAMES}
12554 macro in the machine description macro file.
12556 This flag does not have a negative form, because it specifies a
12557 three-way choice.
12559 @item -fcall-used-@var{reg}
12560 @opindex fcall-used
12561 Treat the register named @var{reg} as an allocable register that is
12562 clobbered by function calls.  It may be allocated for temporaries or
12563 variables that do not live across a call.  Functions compiled this way
12564 do not save and restore the register @var{reg}.
12566 It is an error to use this flag with the frame pointer or stack pointer.
12567 Use of this flag for other registers that have fixed pervasive roles in
12568 the machine's execution model produces disastrous results.
12570 This flag does not have a negative form, because it specifies a
12571 three-way choice.
12573 @item -fcall-saved-@var{reg}
12574 @opindex fcall-saved
12575 Treat the register named @var{reg} as an allocable register saved by
12576 functions.  It may be allocated even for temporaries or variables that
12577 live across a call.  Functions compiled this way save and restore
12578 the register @var{reg} if they use it.
12580 It is an error to use this flag with the frame pointer or stack pointer.
12581 Use of this flag for other registers that have fixed pervasive roles in
12582 the machine's execution model produces disastrous results.
12584 A different sort of disaster results from the use of this flag for
12585 a register in which function values may be returned.
12587 This flag does not have a negative form, because it specifies a
12588 three-way choice.
12590 @item -fpack-struct[=@var{n}]
12591 @opindex fpack-struct
12592 Without a value specified, pack all structure members together without
12593 holes.  When a value is specified (which must be a small power of two), pack
12594 structure members according to this value, representing the maximum
12595 alignment (that is, objects with default alignment requirements larger than
12596 this are output potentially unaligned at the next fitting location.
12598 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12599 code that is not binary compatible with code generated without that switch.
12600 Additionally, it makes the code suboptimal.
12601 Use it to conform to a non-default application binary interface.
12603 @item -fleading-underscore
12604 @opindex fleading-underscore
12605 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12606 change the way C symbols are represented in the object file.  One use
12607 is to help link with legacy assembly code.
12609 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12610 generate code that is not binary compatible with code generated without that
12611 switch.  Use it to conform to a non-default application binary interface.
12612 Not all targets provide complete support for this switch.
12614 @item -ftls-model=@var{model}
12615 @opindex ftls-model
12616 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12617 The @var{model} argument should be one of @samp{global-dynamic},
12618 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12619 Note that the choice is subject to optimization: the compiler may use
12620 a more efficient model for symbols not visible outside of the translation
12621 unit, or if @option{-fpic} is not given on the command line.
12623 The default without @option{-fpic} is @samp{initial-exec}; with
12624 @option{-fpic} the default is @samp{global-dynamic}.
12626 @item -ftrampolines
12627 @opindex ftrampolines
12628 For targets that normally need trampolines for nested functions, always
12629 generate them instead of using descriptors.  Otherwise, for targets that
12630 do not need them, like for example HP-PA or IA-64, do nothing.
12632 A trampoline is a small piece of code that is created at run time on the
12633 stack when the address of a nested function is taken, and is used to call
12634 the nested function indirectly.  Therefore, it requires the stack to be
12635 made executable in order for the program to work properly.
12637 @option{-fno-trampolines} is enabled by default on a language by language
12638 basis to let the compiler avoid generating them, if it computes that this
12639 is safe, and replace them with descriptors.  Descriptors are made up of data
12640 only, but the generated code must be prepared to deal with them.  As of this
12641 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12643 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12644 @option{-fno-trampolines} are not binary compatible if nested functions are
12645 present.  This option must therefore be used on a program-wide basis and be
12646 manipulated with extreme care.
12648 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12649 @opindex fvisibility
12650 Set the default ELF image symbol visibility to the specified option---all
12651 symbols are marked with this unless overridden within the code.
12652 Using this feature can very substantially improve linking and
12653 load times of shared object libraries, produce more optimized
12654 code, provide near-perfect API export and prevent symbol clashes.
12655 It is @strong{strongly} recommended that you use this in any shared objects
12656 you distribute.
12658 Despite the nomenclature, @samp{default} always means public; i.e.,
12659 available to be linked against from outside the shared object.
12660 @samp{protected} and @samp{internal} are pretty useless in real-world
12661 usage so the only other commonly used option is @samp{hidden}.
12662 The default if @option{-fvisibility} isn't specified is
12663 @samp{default}, i.e., make every symbol public.
12665 A good explanation of the benefits offered by ensuring ELF
12666 symbols have the correct visibility is given by ``How To Write
12667 Shared Libraries'' by Ulrich Drepper (which can be found at
12668 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12669 solution made possible by this option to marking things hidden when
12670 the default is public is to make the default hidden and mark things
12671 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12672 and @code{__attribute__ ((visibility("default")))} instead of
12673 @code{__declspec(dllexport)} you get almost identical semantics with
12674 identical syntax.  This is a great boon to those working with
12675 cross-platform projects.
12677 For those adding visibility support to existing code, you may find
12678 @code{#pragma GCC visibility} of use.  This works by you enclosing
12679 the declarations you wish to set visibility for with (for example)
12680 @code{#pragma GCC visibility push(hidden)} and
12681 @code{#pragma GCC visibility pop}.
12682 Bear in mind that symbol visibility should be viewed @strong{as
12683 part of the API interface contract} and thus all new code should
12684 always specify visibility when it is not the default; i.e., declarations
12685 only for use within the local DSO should @strong{always} be marked explicitly
12686 as hidden as so to avoid PLT indirection overheads---making this
12687 abundantly clear also aids readability and self-documentation of the code.
12688 Note that due to ISO C++ specification requirements, @code{operator new} and
12689 @code{operator delete} must always be of default visibility.
12691 Be aware that headers from outside your project, in particular system
12692 headers and headers from any other library you use, may not be
12693 expecting to be compiled with visibility other than the default.  You
12694 may need to explicitly say @code{#pragma GCC visibility push(default)}
12695 before including any such headers.
12697 @code{extern} declarations are not affected by @option{-fvisibility}, so
12698 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12699 no modifications.  However, this means that calls to @code{extern}
12700 functions with no explicit visibility use the PLT, so it is more
12701 effective to use @code{__attribute ((visibility))} and/or
12702 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12703 declarations should be treated as hidden.
12705 Note that @option{-fvisibility} does affect C++ vague linkage
12706 entities. This means that, for instance, an exception class that is
12707 be thrown between DSOs must be explicitly marked with default
12708 visibility so that the @samp{type_info} nodes are unified between
12709 the DSOs.
12711 An overview of these techniques, their benefits and how to use them
12712 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12714 @item -fstrict-volatile-bitfields
12715 @opindex fstrict-volatile-bitfields
12716 This option should be used if accesses to volatile bit-fields (or other
12717 structure fields, although the compiler usually honors those types
12718 anyway) should use a single access of the width of the
12719 field's type, aligned to a natural alignment if possible.  For
12720 example, targets with memory-mapped peripheral registers might require
12721 all such accesses to be 16 bits wide; with this flag you can
12722 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12723 is 16 bits on these targets) to force GCC to use 16-bit accesses
12724 instead of, perhaps, a more efficient 32-bit access.
12726 If this option is disabled, the compiler uses the most efficient
12727 instruction.  In the previous example, that might be a 32-bit load
12728 instruction, even though that accesses bytes that do not contain
12729 any portion of the bit-field, or memory-mapped registers unrelated to
12730 the one being updated.
12732 In some cases, such as when the @code{packed} attribute is applied to a 
12733 structure field, it may not be possible to access the field with a single
12734 read or write that is correctly aligned for the target machine.  In this
12735 case GCC falls back to generating multiple accesses rather than code that 
12736 will fault or truncate the result at run time.
12738 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12739 not allowed to touch non bit-field members.  It is therefore recommended
12740 to define all bits of the field's type as bit-field members.
12742 The default value of this option is determined by the application binary
12743 interface for the target processor.
12745 @item -fsync-libcalls
12746 @opindex fsync-libcalls
12747 This option controls whether any out-of-line instance of the @code{__sync}
12748 family of functions may be used to implement the C++11 @code{__atomic}
12749 family of functions.
12751 The default value of this option is enabled, thus the only useful form
12752 of the option is @option{-fno-sync-libcalls}.  This option is used in
12753 the implementation of the @file{libatomic} runtime library.
12755 @end table
12757 @node Developer Options
12758 @section GCC Developer Options
12759 @cindex developer options
12760 @cindex debugging GCC
12761 @cindex debug dump options
12762 @cindex dump options
12763 @cindex compilation statistics
12765 This section describes command-line options that are primarily of
12766 interest to GCC developers, including options to support compiler
12767 testing and investigation of compiler bugs and compile-time
12768 performance problems.  This includes options that produce debug dumps
12769 at various points in the compilation; that print statistics such as
12770 memory use and execution time; and that print information about GCC's
12771 configuration, such as where it searches for libraries.  You should
12772 rarely need to use any of these options for ordinary compilation and
12773 linking tasks.
12775 @table @gcctabopt
12777 @item -d@var{letters}
12778 @itemx -fdump-rtl-@var{pass}
12779 @itemx -fdump-rtl-@var{pass}=@var{filename}
12780 @opindex d
12781 @opindex fdump-rtl-@var{pass}
12782 Says to make debugging dumps during compilation at times specified by
12783 @var{letters}.  This is used for debugging the RTL-based passes of the
12784 compiler.  The file names for most of the dumps are made by appending
12785 a pass number and a word to the @var{dumpname}, and the files are
12786 created in the directory of the output file.  In case of
12787 @option{=@var{filename}} option, the dump is output on the given file
12788 instead of the pass numbered dump files.  Note that the pass number is
12789 assigned as passes are registered into the pass manager.  Most passes
12790 are registered in the order that they will execute and for these passes
12791 the number corresponds to the pass execution order.  However, passes
12792 registered by plugins, passes specific to compilation targets, or
12793 passes that are otherwise registered after all the other passes are
12794 numbered higher than a pass named "final", even if they are executed
12795 earlier.  @var{dumpname} is generated from the name of the output
12796 file if explicitly specified and not an executable, otherwise it is
12797 the basename of the source file.  
12799 Some @option{-d@var{letters}} switches have different meaning when
12800 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12801 for information about preprocessor-specific dump options.
12803 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12804 @option{-d} option @var{letters}.  Here are the possible
12805 letters for use in @var{pass} and @var{letters}, and their meanings:
12807 @table @gcctabopt
12809 @item -fdump-rtl-alignments
12810 @opindex fdump-rtl-alignments
12811 Dump after branch alignments have been computed.
12813 @item -fdump-rtl-asmcons
12814 @opindex fdump-rtl-asmcons
12815 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12817 @item -fdump-rtl-auto_inc_dec
12818 @opindex fdump-rtl-auto_inc_dec
12819 Dump after auto-inc-dec discovery.  This pass is only run on
12820 architectures that have auto inc or auto dec instructions.
12822 @item -fdump-rtl-barriers
12823 @opindex fdump-rtl-barriers
12824 Dump after cleaning up the barrier instructions.
12826 @item -fdump-rtl-bbpart
12827 @opindex fdump-rtl-bbpart
12828 Dump after partitioning hot and cold basic blocks.
12830 @item -fdump-rtl-bbro
12831 @opindex fdump-rtl-bbro
12832 Dump after block reordering.
12834 @item -fdump-rtl-btl1
12835 @itemx -fdump-rtl-btl2
12836 @opindex fdump-rtl-btl2
12837 @opindex fdump-rtl-btl2
12838 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12839 after the two branch
12840 target load optimization passes.
12842 @item -fdump-rtl-bypass
12843 @opindex fdump-rtl-bypass
12844 Dump after jump bypassing and control flow optimizations.
12846 @item -fdump-rtl-combine
12847 @opindex fdump-rtl-combine
12848 Dump after the RTL instruction combination pass.
12850 @item -fdump-rtl-compgotos
12851 @opindex fdump-rtl-compgotos
12852 Dump after duplicating the computed gotos.
12854 @item -fdump-rtl-ce1
12855 @itemx -fdump-rtl-ce2
12856 @itemx -fdump-rtl-ce3
12857 @opindex fdump-rtl-ce1
12858 @opindex fdump-rtl-ce2
12859 @opindex fdump-rtl-ce3
12860 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12861 @option{-fdump-rtl-ce3} enable dumping after the three
12862 if conversion passes.
12864 @item -fdump-rtl-cprop_hardreg
12865 @opindex fdump-rtl-cprop_hardreg
12866 Dump after hard register copy propagation.
12868 @item -fdump-rtl-csa
12869 @opindex fdump-rtl-csa
12870 Dump after combining stack adjustments.
12872 @item -fdump-rtl-cse1
12873 @itemx -fdump-rtl-cse2
12874 @opindex fdump-rtl-cse1
12875 @opindex fdump-rtl-cse2
12876 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12877 the two common subexpression elimination passes.
12879 @item -fdump-rtl-dce
12880 @opindex fdump-rtl-dce
12881 Dump after the standalone dead code elimination passes.
12883 @item -fdump-rtl-dbr
12884 @opindex fdump-rtl-dbr
12885 Dump after delayed branch scheduling.
12887 @item -fdump-rtl-dce1
12888 @itemx -fdump-rtl-dce2
12889 @opindex fdump-rtl-dce1
12890 @opindex fdump-rtl-dce2
12891 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12892 the two dead store elimination passes.
12894 @item -fdump-rtl-eh
12895 @opindex fdump-rtl-eh
12896 Dump after finalization of EH handling code.
12898 @item -fdump-rtl-eh_ranges
12899 @opindex fdump-rtl-eh_ranges
12900 Dump after conversion of EH handling range regions.
12902 @item -fdump-rtl-expand
12903 @opindex fdump-rtl-expand
12904 Dump after RTL generation.
12906 @item -fdump-rtl-fwprop1
12907 @itemx -fdump-rtl-fwprop2
12908 @opindex fdump-rtl-fwprop1
12909 @opindex fdump-rtl-fwprop2
12910 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12911 dumping after the two forward propagation passes.
12913 @item -fdump-rtl-gcse1
12914 @itemx -fdump-rtl-gcse2
12915 @opindex fdump-rtl-gcse1
12916 @opindex fdump-rtl-gcse2
12917 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12918 after global common subexpression elimination.
12920 @item -fdump-rtl-init-regs
12921 @opindex fdump-rtl-init-regs
12922 Dump after the initialization of the registers.
12924 @item -fdump-rtl-initvals
12925 @opindex fdump-rtl-initvals
12926 Dump after the computation of the initial value sets.
12928 @item -fdump-rtl-into_cfglayout
12929 @opindex fdump-rtl-into_cfglayout
12930 Dump after converting to cfglayout mode.
12932 @item -fdump-rtl-ira
12933 @opindex fdump-rtl-ira
12934 Dump after iterated register allocation.
12936 @item -fdump-rtl-jump
12937 @opindex fdump-rtl-jump
12938 Dump after the second jump optimization.
12940 @item -fdump-rtl-loop2
12941 @opindex fdump-rtl-loop2
12942 @option{-fdump-rtl-loop2} enables dumping after the rtl
12943 loop optimization passes.
12945 @item -fdump-rtl-mach
12946 @opindex fdump-rtl-mach
12947 Dump after performing the machine dependent reorganization pass, if that
12948 pass exists.
12950 @item -fdump-rtl-mode_sw
12951 @opindex fdump-rtl-mode_sw
12952 Dump after removing redundant mode switches.
12954 @item -fdump-rtl-rnreg
12955 @opindex fdump-rtl-rnreg
12956 Dump after register renumbering.
12958 @item -fdump-rtl-outof_cfglayout
12959 @opindex fdump-rtl-outof_cfglayout
12960 Dump after converting from cfglayout mode.
12962 @item -fdump-rtl-peephole2
12963 @opindex fdump-rtl-peephole2
12964 Dump after the peephole pass.
12966 @item -fdump-rtl-postreload
12967 @opindex fdump-rtl-postreload
12968 Dump after post-reload optimizations.
12970 @item -fdump-rtl-pro_and_epilogue
12971 @opindex fdump-rtl-pro_and_epilogue
12972 Dump after generating the function prologues and epilogues.
12974 @item -fdump-rtl-sched1
12975 @itemx -fdump-rtl-sched2
12976 @opindex fdump-rtl-sched1
12977 @opindex fdump-rtl-sched2
12978 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12979 after the basic block scheduling passes.
12981 @item -fdump-rtl-ree
12982 @opindex fdump-rtl-ree
12983 Dump after sign/zero extension elimination.
12985 @item -fdump-rtl-seqabstr
12986 @opindex fdump-rtl-seqabstr
12987 Dump after common sequence discovery.
12989 @item -fdump-rtl-shorten
12990 @opindex fdump-rtl-shorten
12991 Dump after shortening branches.
12993 @item -fdump-rtl-sibling
12994 @opindex fdump-rtl-sibling
12995 Dump after sibling call optimizations.
12997 @item -fdump-rtl-split1
12998 @itemx -fdump-rtl-split2
12999 @itemx -fdump-rtl-split3
13000 @itemx -fdump-rtl-split4
13001 @itemx -fdump-rtl-split5
13002 @opindex fdump-rtl-split1
13003 @opindex fdump-rtl-split2
13004 @opindex fdump-rtl-split3
13005 @opindex fdump-rtl-split4
13006 @opindex fdump-rtl-split5
13007 These options enable dumping after five rounds of
13008 instruction splitting.
13010 @item -fdump-rtl-sms
13011 @opindex fdump-rtl-sms
13012 Dump after modulo scheduling.  This pass is only run on some
13013 architectures.
13015 @item -fdump-rtl-stack
13016 @opindex fdump-rtl-stack
13017 Dump after conversion from GCC's ``flat register file'' registers to the
13018 x87's stack-like registers.  This pass is only run on x86 variants.
13020 @item -fdump-rtl-subreg1
13021 @itemx -fdump-rtl-subreg2
13022 @opindex fdump-rtl-subreg1
13023 @opindex fdump-rtl-subreg2
13024 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13025 the two subreg expansion passes.
13027 @item -fdump-rtl-unshare
13028 @opindex fdump-rtl-unshare
13029 Dump after all rtl has been unshared.
13031 @item -fdump-rtl-vartrack
13032 @opindex fdump-rtl-vartrack
13033 Dump after variable tracking.
13035 @item -fdump-rtl-vregs
13036 @opindex fdump-rtl-vregs
13037 Dump after converting virtual registers to hard registers.
13039 @item -fdump-rtl-web
13040 @opindex fdump-rtl-web
13041 Dump after live range splitting.
13043 @item -fdump-rtl-regclass
13044 @itemx -fdump-rtl-subregs_of_mode_init
13045 @itemx -fdump-rtl-subregs_of_mode_finish
13046 @itemx -fdump-rtl-dfinit
13047 @itemx -fdump-rtl-dfinish
13048 @opindex fdump-rtl-regclass
13049 @opindex fdump-rtl-subregs_of_mode_init
13050 @opindex fdump-rtl-subregs_of_mode_finish
13051 @opindex fdump-rtl-dfinit
13052 @opindex fdump-rtl-dfinish
13053 These dumps are defined but always produce empty files.
13055 @item -da
13056 @itemx -fdump-rtl-all
13057 @opindex da
13058 @opindex fdump-rtl-all
13059 Produce all the dumps listed above.
13061 @item -dA
13062 @opindex dA
13063 Annotate the assembler output with miscellaneous debugging information.
13065 @item -dD
13066 @opindex dD
13067 Dump all macro definitions, at the end of preprocessing, in addition to
13068 normal output.
13070 @item -dH
13071 @opindex dH
13072 Produce a core dump whenever an error occurs.
13074 @item -dp
13075 @opindex dp
13076 Annotate the assembler output with a comment indicating which
13077 pattern and alternative is used.  The length of each instruction is
13078 also printed.
13080 @item -dP
13081 @opindex dP
13082 Dump the RTL in the assembler output as a comment before each instruction.
13083 Also turns on @option{-dp} annotation.
13085 @item -dx
13086 @opindex dx
13087 Just generate RTL for a function instead of compiling it.  Usually used
13088 with @option{-fdump-rtl-expand}.
13089 @end table
13091 @item -fdump-noaddr
13092 @opindex fdump-noaddr
13093 When doing debugging dumps, suppress address output.  This makes it more
13094 feasible to use diff on debugging dumps for compiler invocations with
13095 different compiler binaries and/or different
13096 text / bss / data / heap / stack / dso start locations.
13098 @item -freport-bug
13099 @opindex freport-bug
13100 Collect and dump debug information into a temporary file if an
13101 internal compiler error (ICE) occurs.
13103 @item -fdump-unnumbered
13104 @opindex fdump-unnumbered
13105 When doing debugging dumps, suppress instruction numbers and address output.
13106 This makes it more feasible to use diff on debugging dumps for compiler
13107 invocations with different options, in particular with and without
13108 @option{-g}.
13110 @item -fdump-unnumbered-links
13111 @opindex fdump-unnumbered-links
13112 When doing debugging dumps (see @option{-d} option above), suppress
13113 instruction numbers for the links to the previous and next instructions
13114 in a sequence.
13116 @item -fdump-ipa-@var{switch}
13117 @opindex fdump-ipa
13118 Control the dumping at various stages of inter-procedural analysis
13119 language tree to a file.  The file name is generated by appending a
13120 switch specific suffix to the source file name, and the file is created
13121 in the same directory as the output file.  The following dumps are
13122 possible:
13124 @table @samp
13125 @item all
13126 Enables all inter-procedural analysis dumps.
13128 @item cgraph
13129 Dumps information about call-graph optimization, unused function removal,
13130 and inlining decisions.
13132 @item inline
13133 Dump after function inlining.
13135 @end table
13137 @item -fdump-lang-all
13138 @itemx -fdump-lang-@var{switch}
13139 @itemx -fdump-lang-@var{switch}-@var{options}
13140 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13141 @opindex fdump-lang-all
13142 @opindex fdump-lang
13143 Control the dumping of language-specific information.  The @var{options}
13144 and @var{filename} portions behave as described in the
13145 @option{-fdump-tree} option.  The following @var{switch} values are
13146 accepted:
13148 @table @samp
13149 @item all
13151 Enable all language-specific dumps.
13153 @item class
13154 Dump class hierarchy information.  Virtual table information is emitted
13155 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13157 @item raw
13158 Dump the raw internal tree data.  This option is applicable to C++ only.
13160 @end table
13162 @item -fdump-passes
13163 @opindex fdump-passes
13164 Print on @file{stderr} the list of optimization passes that are turned
13165 on and off by the current command-line options.
13167 @item -fdump-statistics-@var{option}
13168 @opindex fdump-statistics
13169 Enable and control dumping of pass statistics in a separate file.  The
13170 file name is generated by appending a suffix ending in
13171 @samp{.statistics} to the source file name, and the file is created in
13172 the same directory as the output file.  If the @samp{-@var{option}}
13173 form is used, @samp{-stats} causes counters to be summed over the
13174 whole compilation unit while @samp{-details} dumps every event as
13175 the passes generate them.  The default with no option is to sum
13176 counters for each function compiled.
13178 @item -fdump-tree-all
13179 @itemx -fdump-tree-@var{switch}
13180 @itemx -fdump-tree-@var{switch}-@var{options}
13181 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13182 @opindex fdump-tree-all
13183 @opindex fdump-tree
13184 Control the dumping at various stages of processing the intermediate
13185 language tree to a file.  The file name is generated by appending a
13186 switch-specific suffix to the source file name, and the file is
13187 created in the same directory as the output file. In case of
13188 @option{=@var{filename}} option, the dump is output on the given file
13189 instead of the auto named dump files.  If the @samp{-@var{options}}
13190 form is used, @var{options} is a list of @samp{-} separated options
13191 which control the details of the dump.  Not all options are applicable
13192 to all dumps; those that are not meaningful are ignored.  The
13193 following options are available
13195 @table @samp
13196 @item address
13197 Print the address of each node.  Usually this is not meaningful as it
13198 changes according to the environment and source file.  Its primary use
13199 is for tying up a dump file with a debug environment.
13200 @item asmname
13201 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13202 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13203 use working backward from mangled names in the assembly file.
13204 @item slim
13205 When dumping front-end intermediate representations, inhibit dumping
13206 of members of a scope or body of a function merely because that scope
13207 has been reached.  Only dump such items when they are directly reachable
13208 by some other path.
13210 When dumping pretty-printed trees, this option inhibits dumping the
13211 bodies of control structures.
13213 When dumping RTL, print the RTL in slim (condensed) form instead of
13214 the default LISP-like representation.
13215 @item raw
13216 Print a raw representation of the tree.  By default, trees are
13217 pretty-printed into a C-like representation.
13218 @item details
13219 Enable more detailed dumps (not honored by every dump option). Also
13220 include information from the optimization passes.
13221 @item stats
13222 Enable dumping various statistics about the pass (not honored by every dump
13223 option).
13224 @item blocks
13225 Enable showing basic block boundaries (disabled in raw dumps).
13226 @item graph
13227 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13228 dump a representation of the control flow graph suitable for viewing with
13229 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13230 the file is pretty-printed as a subgraph, so that GraphViz can render them
13231 all in a single plot.
13233 This option currently only works for RTL dumps, and the RTL is always
13234 dumped in slim form.
13235 @item vops
13236 Enable showing virtual operands for every statement.
13237 @item lineno
13238 Enable showing line numbers for statements.
13239 @item uid
13240 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13241 @item verbose
13242 Enable showing the tree dump for each statement.
13243 @item eh
13244 Enable showing the EH region number holding each statement.
13245 @item scev
13246 Enable showing scalar evolution analysis details.
13247 @item optimized
13248 Enable showing optimization information (only available in certain
13249 passes).
13250 @item missed
13251 Enable showing missed optimization information (only available in certain
13252 passes).
13253 @item note
13254 Enable other detailed optimization information (only available in
13255 certain passes).
13256 @item =@var{filename}
13257 Instead of an auto named dump file, output into the given file
13258 name. The file names @file{stdout} and @file{stderr} are treated
13259 specially and are considered already open standard streams. For
13260 example,
13262 @smallexample
13263 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13264      -fdump-tree-pre=/dev/stderr file.c
13265 @end smallexample
13267 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13268 output on to @file{stderr}. If two conflicting dump filenames are
13269 given for the same pass, then the latter option overrides the earlier
13270 one.
13272 @item all
13273 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13274 and @option{lineno}.
13276 @item optall
13277 Turn on all optimization options, i.e., @option{optimized},
13278 @option{missed}, and @option{note}.
13279 @end table
13281 To determine what tree dumps are available or find the dump for a pass
13282 of interest follow the steps below.
13284 @enumerate
13285 @item
13286 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13287 look for a code that corresponds to the pass you are interested in.
13288 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13289 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13290 The number at the end distinguishes distinct invocations of the same pass.
13291 @item
13292 To enable the creation of the dump file, append the pass code to
13293 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13294 to enable the dump from the Early Value Range Propagation pass, invoke
13295 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13296 specify the name of the dump file.  If you don't specify one, GCC
13297 creates as described below.
13298 @item
13299 Find the pass dump in a file whose name is composed of three components
13300 separated by a period: the name of the source file GCC was invoked to
13301 compile, a numeric suffix indicating the pass number followed by the
13302 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13303 and finally the pass code.  For example, the Early VRP pass dump might
13304 be in a file named @file{myfile.c.038t.evrp} in the current working
13305 directory.  Note that the numeric codes are not stable and may change
13306 from one version of GCC to another.
13307 @end enumerate
13309 @item -fopt-info
13310 @itemx -fopt-info-@var{options}
13311 @itemx -fopt-info-@var{options}=@var{filename}
13312 @opindex fopt-info
13313 Controls optimization dumps from various optimization passes. If the
13314 @samp{-@var{options}} form is used, @var{options} is a list of
13315 @samp{-} separated option keywords to select the dump details and
13316 optimizations.  
13318 The @var{options} can be divided into two groups: options describing the
13319 verbosity of the dump, and options describing which optimizations
13320 should be included. The options from both the groups can be freely
13321 mixed as they are non-overlapping. However, in case of any conflicts,
13322 the later options override the earlier options on the command
13323 line. 
13325 The following options control the dump verbosity:
13327 @table @samp
13328 @item optimized
13329 Print information when an optimization is successfully applied. It is
13330 up to a pass to decide which information is relevant. For example, the
13331 vectorizer passes print the source location of loops which are
13332 successfully vectorized.
13333 @item missed
13334 Print information about missed optimizations. Individual passes
13335 control which information to include in the output. 
13336 @item note
13337 Print verbose information about optimizations, such as certain
13338 transformations, more detailed messages about decisions etc.
13339 @item all
13340 Print detailed optimization information. This includes
13341 @samp{optimized}, @samp{missed}, and @samp{note}.
13342 @end table
13344 One or more of the following option keywords can be used to describe a
13345 group of optimizations:
13347 @table @samp
13348 @item ipa
13349 Enable dumps from all interprocedural optimizations.
13350 @item loop
13351 Enable dumps from all loop optimizations.
13352 @item inline
13353 Enable dumps from all inlining optimizations.
13354 @item omp
13355 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13356 @item vec
13357 Enable dumps from all vectorization optimizations.
13358 @item optall
13359 Enable dumps from all optimizations. This is a superset of
13360 the optimization groups listed above.
13361 @end table
13363 If @var{options} is
13364 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13365 info about successful optimizations from all the passes.  
13367 If the @var{filename} is provided, then the dumps from all the
13368 applicable optimizations are concatenated into the @var{filename}.
13369 Otherwise the dump is output onto @file{stderr}. Though multiple
13370 @option{-fopt-info} options are accepted, only one of them can include
13371 a @var{filename}. If other filenames are provided then all but the
13372 first such option are ignored.
13374 Note that the output @var{filename} is overwritten
13375 in case of multiple translation units. If a combined output from
13376 multiple translation units is desired, @file{stderr} should be used
13377 instead.
13379 In the following example, the optimization info is output to
13380 @file{stderr}:
13382 @smallexample
13383 gcc -O3 -fopt-info
13384 @end smallexample
13386 This example:
13387 @smallexample
13388 gcc -O3 -fopt-info-missed=missed.all
13389 @end smallexample
13391 @noindent
13392 outputs missed optimization report from all the passes into
13393 @file{missed.all}, and this one:
13395 @smallexample
13396 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13397 @end smallexample
13399 @noindent
13400 prints information about missed optimization opportunities from
13401 vectorization passes on @file{stderr}.  
13402 Note that @option{-fopt-info-vec-missed} is equivalent to 
13403 @option{-fopt-info-missed-vec}.  The order of the optimization group
13404 names and message types listed after @option{-fopt-info} does not matter.
13406 As another example,
13407 @smallexample
13408 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13409 @end smallexample
13411 @noindent
13412 outputs information about missed optimizations as well as
13413 optimized locations from all the inlining passes into
13414 @file{inline.txt}.
13416 Finally, consider:
13418 @smallexample
13419 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13420 @end smallexample
13422 @noindent
13423 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13424 in conflict since only one output file is allowed. In this case, only
13425 the first option takes effect and the subsequent options are
13426 ignored. Thus only @file{vec.miss} is produced which contains
13427 dumps from the vectorizer about missed opportunities.
13429 @item -fsched-verbose=@var{n}
13430 @opindex fsched-verbose
13431 On targets that use instruction scheduling, this option controls the
13432 amount of debugging output the scheduler prints to the dump files.
13434 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13435 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13436 For @var{n} greater than one, it also output basic block probabilities,
13437 detailed ready list information and unit/insn info.  For @var{n} greater
13438 than two, it includes RTL at abort point, control-flow and regions info.
13439 And for @var{n} over four, @option{-fsched-verbose} also includes
13440 dependence info.
13444 @item -fenable-@var{kind}-@var{pass}
13445 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13446 @opindex fdisable-
13447 @opindex fenable-
13449 This is a set of options that are used to explicitly disable/enable
13450 optimization passes.  These options are intended for use for debugging GCC.
13451 Compiler users should use regular options for enabling/disabling
13452 passes instead.
13454 @table @gcctabopt
13456 @item -fdisable-ipa-@var{pass}
13457 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13458 statically invoked in the compiler multiple times, the pass name should be
13459 appended with a sequential number starting from 1.
13461 @item -fdisable-rtl-@var{pass}
13462 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13463 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13464 statically invoked in the compiler multiple times, the pass name should be
13465 appended with a sequential number starting from 1.  @var{range-list} is a 
13466 comma-separated list of function ranges or assembler names.  Each range is a number
13467 pair separated by a colon.  The range is inclusive in both ends.  If the range
13468 is trivial, the number pair can be simplified as a single number.  If the
13469 function's call graph node's @var{uid} falls within one of the specified ranges,
13470 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13471 function header of a dump file, and the pass names can be dumped by using
13472 option @option{-fdump-passes}.
13474 @item -fdisable-tree-@var{pass}
13475 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13476 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13477 option arguments.
13479 @item -fenable-ipa-@var{pass}
13480 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13481 statically invoked in the compiler multiple times, the pass name should be
13482 appended with a sequential number starting from 1.
13484 @item -fenable-rtl-@var{pass}
13485 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13486 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13487 description and examples.
13489 @item -fenable-tree-@var{pass}
13490 @itemx -fenable-tree-@var{pass}=@var{range-list}
13491 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13492 of option arguments.
13494 @end table
13496 Here are some examples showing uses of these options.
13498 @smallexample
13500 # disable ccp1 for all functions
13501    -fdisable-tree-ccp1
13502 # disable complete unroll for function whose cgraph node uid is 1
13503    -fenable-tree-cunroll=1
13504 # disable gcse2 for functions at the following ranges [1,1],
13505 # [300,400], and [400,1000]
13506 # disable gcse2 for functions foo and foo2
13507    -fdisable-rtl-gcse2=foo,foo2
13508 # disable early inlining
13509    -fdisable-tree-einline
13510 # disable ipa inlining
13511    -fdisable-ipa-inline
13512 # enable tree full unroll
13513    -fenable-tree-unroll
13515 @end smallexample
13517 @item -fchecking
13518 @itemx -fchecking=@var{n}
13519 @opindex fchecking
13520 @opindex fno-checking
13521 Enable internal consistency checking.  The default depends on
13522 the compiler configuration.  @option{-fchecking=2} enables further
13523 internal consistency checking that might affect code generation.
13525 @item -frandom-seed=@var{string}
13526 @opindex frandom-seed
13527 This option provides a seed that GCC uses in place of
13528 random numbers in generating certain symbol names
13529 that have to be different in every compiled file.  It is also used to
13530 place unique stamps in coverage data files and the object files that
13531 produce them.  You can use the @option{-frandom-seed} option to produce
13532 reproducibly identical object files.
13534 The @var{string} can either be a number (decimal, octal or hex) or an
13535 arbitrary string (in which case it's converted to a number by
13536 computing CRC32).
13538 The @var{string} should be different for every file you compile.
13540 @item -save-temps
13541 @itemx -save-temps=cwd
13542 @opindex save-temps
13543 Store the usual ``temporary'' intermediate files permanently; place them
13544 in the current directory and name them based on the source file.  Thus,
13545 compiling @file{foo.c} with @option{-c -save-temps} produces files
13546 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13547 preprocessed @file{foo.i} output file even though the compiler now
13548 normally uses an integrated preprocessor.
13550 When used in combination with the @option{-x} command-line option,
13551 @option{-save-temps} is sensible enough to avoid over writing an
13552 input source file with the same extension as an intermediate file.
13553 The corresponding intermediate file may be obtained by renaming the
13554 source file before using @option{-save-temps}.
13556 If you invoke GCC in parallel, compiling several different source
13557 files that share a common base name in different subdirectories or the
13558 same source file compiled for multiple output destinations, it is
13559 likely that the different parallel compilers will interfere with each
13560 other, and overwrite the temporary files.  For instance:
13562 @smallexample
13563 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13564 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13565 @end smallexample
13567 may result in @file{foo.i} and @file{foo.o} being written to
13568 simultaneously by both compilers.
13570 @item -save-temps=obj
13571 @opindex save-temps=obj
13572 Store the usual ``temporary'' intermediate files permanently.  If the
13573 @option{-o} option is used, the temporary files are based on the
13574 object file.  If the @option{-o} option is not used, the
13575 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13577 For example:
13579 @smallexample
13580 gcc -save-temps=obj -c foo.c
13581 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13582 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13583 @end smallexample
13585 @noindent
13586 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13587 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13588 @file{dir2/yfoobar.o}.
13590 @item -time@r{[}=@var{file}@r{]}
13591 @opindex time
13592 Report the CPU time taken by each subprocess in the compilation
13593 sequence.  For C source files, this is the compiler proper and assembler
13594 (plus the linker if linking is done).
13596 Without the specification of an output file, the output looks like this:
13598 @smallexample
13599 # cc1 0.12 0.01
13600 # as 0.00 0.01
13601 @end smallexample
13603 The first number on each line is the ``user time'', that is time spent
13604 executing the program itself.  The second number is ``system time'',
13605 time spent executing operating system routines on behalf of the program.
13606 Both numbers are in seconds.
13608 With the specification of an output file, the output is appended to the
13609 named file, and it looks like this:
13611 @smallexample
13612 0.12 0.01 cc1 @var{options}
13613 0.00 0.01 as @var{options}
13614 @end smallexample
13616 The ``user time'' and the ``system time'' are moved before the program
13617 name, and the options passed to the program are displayed, so that one
13618 can later tell what file was being compiled, and with which options.
13620 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13621 @opindex fdump-final-insns
13622 Dump the final internal representation (RTL) to @var{file}.  If the
13623 optional argument is omitted (or if @var{file} is @code{.}), the name
13624 of the dump file is determined by appending @code{.gkd} to the
13625 compilation output file name.
13627 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13628 @opindex fcompare-debug
13629 @opindex fno-compare-debug
13630 If no error occurs during compilation, run the compiler a second time,
13631 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13632 passed to the second compilation.  Dump the final internal
13633 representation in both compilations, and print an error if they differ.
13635 If the equal sign is omitted, the default @option{-gtoggle} is used.
13637 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13638 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13639 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13640 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13641 is used.
13643 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13644 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13645 of the final representation and the second compilation, preventing even
13646 @env{GCC_COMPARE_DEBUG} from taking effect.
13648 To verify full coverage during @option{-fcompare-debug} testing, set
13649 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13650 which GCC rejects as an invalid option in any actual compilation
13651 (rather than preprocessing, assembly or linking).  To get just a
13652 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13653 not overridden} will do.
13655 @item -fcompare-debug-second
13656 @opindex fcompare-debug-second
13657 This option is implicitly passed to the compiler for the second
13658 compilation requested by @option{-fcompare-debug}, along with options to
13659 silence warnings, and omitting other options that would cause
13660 side-effect compiler outputs to files or to the standard output.  Dump
13661 files and preserved temporary files are renamed so as to contain the
13662 @code{.gk} additional extension during the second compilation, to avoid
13663 overwriting those generated by the first.
13665 When this option is passed to the compiler driver, it causes the
13666 @emph{first} compilation to be skipped, which makes it useful for little
13667 other than debugging the compiler proper.
13669 @item -gtoggle
13670 @opindex gtoggle
13671 Turn off generation of debug info, if leaving out this option
13672 generates it, or turn it on at level 2 otherwise.  The position of this
13673 argument in the command line does not matter; it takes effect after all
13674 other options are processed, and it does so only once, no matter how
13675 many times it is given.  This is mainly intended to be used with
13676 @option{-fcompare-debug}.
13678 @item -fvar-tracking-assignments-toggle
13679 @opindex fvar-tracking-assignments-toggle
13680 @opindex fno-var-tracking-assignments-toggle
13681 Toggle @option{-fvar-tracking-assignments}, in the same way that
13682 @option{-gtoggle} toggles @option{-g}.
13684 @item -Q
13685 @opindex Q
13686 Makes the compiler print out each function name as it is compiled, and
13687 print some statistics about each pass when it finishes.
13689 @item -ftime-report
13690 @opindex ftime-report
13691 Makes the compiler print some statistics about the time consumed by each
13692 pass when it finishes.
13694 @item -ftime-report-details
13695 @opindex ftime-report-details
13696 Record the time consumed by infrastructure parts separately for each pass.
13698 @item -fira-verbose=@var{n}
13699 @opindex fira-verbose
13700 Control the verbosity of the dump file for the integrated register allocator.
13701 The default value is 5.  If the value @var{n} is greater or equal to 10,
13702 the dump output is sent to stderr using the same format as @var{n} minus 10.
13704 @item -flto-report
13705 @opindex flto-report
13706 Prints a report with internal details on the workings of the link-time
13707 optimizer.  The contents of this report vary from version to version.
13708 It is meant to be useful to GCC developers when processing object
13709 files in LTO mode (via @option{-flto}).
13711 Disabled by default.
13713 @item -flto-report-wpa
13714 @opindex flto-report-wpa
13715 Like @option{-flto-report}, but only print for the WPA phase of Link
13716 Time Optimization.
13718 @item -fmem-report
13719 @opindex fmem-report
13720 Makes the compiler print some statistics about permanent memory
13721 allocation when it finishes.
13723 @item -fmem-report-wpa
13724 @opindex fmem-report-wpa
13725 Makes the compiler print some statistics about permanent memory
13726 allocation for the WPA phase only.
13728 @item -fpre-ipa-mem-report
13729 @opindex fpre-ipa-mem-report
13730 @item -fpost-ipa-mem-report
13731 @opindex fpost-ipa-mem-report
13732 Makes the compiler print some statistics about permanent memory
13733 allocation before or after interprocedural optimization.
13735 @item -fprofile-report
13736 @opindex fprofile-report
13737 Makes the compiler print some statistics about consistency of the
13738 (estimated) profile and effect of individual passes.
13740 @item -fstack-usage
13741 @opindex fstack-usage
13742 Makes the compiler output stack usage information for the program, on a
13743 per-function basis.  The filename for the dump is made by appending
13744 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13745 the output file, if explicitly specified and it is not an executable,
13746 otherwise it is the basename of the source file.  An entry is made up
13747 of three fields:
13749 @itemize
13750 @item
13751 The name of the function.
13752 @item
13753 A number of bytes.
13754 @item
13755 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13756 @end itemize
13758 The qualifier @code{static} means that the function manipulates the stack
13759 statically: a fixed number of bytes are allocated for the frame on function
13760 entry and released on function exit; no stack adjustments are otherwise made
13761 in the function.  The second field is this fixed number of bytes.
13763 The qualifier @code{dynamic} means that the function manipulates the stack
13764 dynamically: in addition to the static allocation described above, stack
13765 adjustments are made in the body of the function, for example to push/pop
13766 arguments around function calls.  If the qualifier @code{bounded} is also
13767 present, the amount of these adjustments is bounded at compile time and
13768 the second field is an upper bound of the total amount of stack used by
13769 the function.  If it is not present, the amount of these adjustments is
13770 not bounded at compile time and the second field only represents the
13771 bounded part.
13773 @item -fstats
13774 @opindex fstats
13775 Emit statistics about front-end processing at the end of the compilation.
13776 This option is supported only by the C++ front end, and
13777 the information is generally only useful to the G++ development team.
13779 @item -fdbg-cnt-list
13780 @opindex fdbg-cnt-list
13781 Print the name and the counter upper bound for all debug counters.
13784 @item -fdbg-cnt=@var{counter-value-list}
13785 @opindex fdbg-cnt
13786 Set the internal debug counter upper bound.  @var{counter-value-list}
13787 is a comma-separated list of @var{name}:@var{value} pairs
13788 which sets the upper bound of each debug counter @var{name} to @var{value}.
13789 All debug counters have the initial upper bound of @code{UINT_MAX};
13790 thus @code{dbg_cnt} returns true always unless the upper bound
13791 is set by this option.
13792 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13793 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13795 @item -print-file-name=@var{library}
13796 @opindex print-file-name
13797 Print the full absolute name of the library file @var{library} that
13798 would be used when linking---and don't do anything else.  With this
13799 option, GCC does not compile or link anything; it just prints the
13800 file name.
13802 @item -print-multi-directory
13803 @opindex print-multi-directory
13804 Print the directory name corresponding to the multilib selected by any
13805 other switches present in the command line.  This directory is supposed
13806 to exist in @env{GCC_EXEC_PREFIX}.
13808 @item -print-multi-lib
13809 @opindex print-multi-lib
13810 Print the mapping from multilib directory names to compiler switches
13811 that enable them.  The directory name is separated from the switches by
13812 @samp{;}, and each switch starts with an @samp{@@} instead of the
13813 @samp{-}, without spaces between multiple switches.  This is supposed to
13814 ease shell processing.
13816 @item -print-multi-os-directory
13817 @opindex print-multi-os-directory
13818 Print the path to OS libraries for the selected
13819 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13820 present in the @file{lib} subdirectory and no multilibs are used, this is
13821 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13822 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13823 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13824 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13826 @item -print-multiarch
13827 @opindex print-multiarch
13828 Print the path to OS libraries for the selected multiarch,
13829 relative to some @file{lib} subdirectory.
13831 @item -print-prog-name=@var{program}
13832 @opindex print-prog-name
13833 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13835 @item -print-libgcc-file-name
13836 @opindex print-libgcc-file-name
13837 Same as @option{-print-file-name=libgcc.a}.
13839 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13840 but you do want to link with @file{libgcc.a}.  You can do:
13842 @smallexample
13843 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13844 @end smallexample
13846 @item -print-search-dirs
13847 @opindex print-search-dirs
13848 Print the name of the configured installation directory and a list of
13849 program and library directories @command{gcc} searches---and don't do anything else.
13851 This is useful when @command{gcc} prints the error message
13852 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13853 To resolve this you either need to put @file{cpp0} and the other compiler
13854 components where @command{gcc} expects to find them, or you can set the environment
13855 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13856 Don't forget the trailing @samp{/}.
13857 @xref{Environment Variables}.
13859 @item -print-sysroot
13860 @opindex print-sysroot
13861 Print the target sysroot directory that is used during
13862 compilation.  This is the target sysroot specified either at configure
13863 time or using the @option{--sysroot} option, possibly with an extra
13864 suffix that depends on compilation options.  If no target sysroot is
13865 specified, the option prints nothing.
13867 @item -print-sysroot-headers-suffix
13868 @opindex print-sysroot-headers-suffix
13869 Print the suffix added to the target sysroot when searching for
13870 headers, or give an error if the compiler is not configured with such
13871 a suffix---and don't do anything else.
13873 @item -dumpmachine
13874 @opindex dumpmachine
13875 Print the compiler's target machine (for example,
13876 @samp{i686-pc-linux-gnu})---and don't do anything else.
13878 @item -dumpversion
13879 @opindex dumpversion
13880 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13881 anything else.  This is the compiler version used in filesystem paths,
13882 specs, can be depending on how the compiler has been configured just
13883 a single number (major version), two numbers separated by dot (major and
13884 minor version) or three numbers separated by dots (major, minor and patchlevel
13885 version).
13887 @item -dumpfullversion
13888 @opindex dumpfullversion
13889 Print the full compiler version, always 3 numbers separated by dots,
13890 major, minor and patchlevel version.
13892 @item -dumpspecs
13893 @opindex dumpspecs
13894 Print the compiler's built-in specs---and don't do anything else.  (This
13895 is used when GCC itself is being built.)  @xref{Spec Files}.
13896 @end table
13898 @node Submodel Options
13899 @section Machine-Dependent Options
13900 @cindex submodel options
13901 @cindex specifying hardware config
13902 @cindex hardware models and configurations, specifying
13903 @cindex target-dependent options
13904 @cindex machine-dependent options
13906 Each target machine supported by GCC can have its own options---for
13907 example, to allow you to compile for a particular processor variant or
13908 ABI, or to control optimizations specific to that machine.  By
13909 convention, the names of machine-specific options start with
13910 @samp{-m}.
13912 Some configurations of the compiler also support additional target-specific
13913 options, usually for compatibility with other compilers on the same
13914 platform.
13916 @c This list is ordered alphanumerically by subsection name.
13917 @c It should be the same order and spelling as these options are listed
13918 @c in Machine Dependent Options
13920 @menu
13921 * AArch64 Options::
13922 * Adapteva Epiphany Options::
13923 * ARC Options::
13924 * ARM Options::
13925 * AVR Options::
13926 * Blackfin Options::
13927 * C6X Options::
13928 * CRIS Options::
13929 * CR16 Options::
13930 * Darwin Options::
13931 * DEC Alpha Options::
13932 * FR30 Options::
13933 * FT32 Options::
13934 * FRV Options::
13935 * GNU/Linux Options::
13936 * H8/300 Options::
13937 * HPPA Options::
13938 * IA-64 Options::
13939 * LM32 Options::
13940 * M32C Options::
13941 * M32R/D Options::
13942 * M680x0 Options::
13943 * MCore Options::
13944 * MeP Options::
13945 * MicroBlaze Options::
13946 * MIPS Options::
13947 * MMIX Options::
13948 * MN10300 Options::
13949 * Moxie Options::
13950 * MSP430 Options::
13951 * NDS32 Options::
13952 * Nios II Options::
13953 * Nvidia PTX Options::
13954 * PDP-11 Options::
13955 * picoChip Options::
13956 * PowerPC Options::
13957 * RISC-V Options::
13958 * RL78 Options::
13959 * RS/6000 and PowerPC Options::
13960 * RX Options::
13961 * S/390 and zSeries Options::
13962 * Score Options::
13963 * SH Options::
13964 * Solaris 2 Options::
13965 * SPARC Options::
13966 * SPU Options::
13967 * System V Options::
13968 * TILE-Gx Options::
13969 * TILEPro Options::
13970 * V850 Options::
13971 * VAX Options::
13972 * Visium Options::
13973 * VMS Options::
13974 * VxWorks Options::
13975 * x86 Options::
13976 * x86 Windows Options::
13977 * Xstormy16 Options::
13978 * Xtensa Options::
13979 * zSeries Options::
13980 @end menu
13982 @node AArch64 Options
13983 @subsection AArch64 Options
13984 @cindex AArch64 Options
13986 These options are defined for AArch64 implementations:
13988 @table @gcctabopt
13990 @item -mabi=@var{name}
13991 @opindex mabi
13992 Generate code for the specified data model.  Permissible values
13993 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13994 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13995 but long int and pointers are 64 bits.
13997 The default depends on the specific target configuration.  Note that
13998 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13999 entire program with the same ABI, and link with a compatible set of libraries.
14001 @item -mbig-endian
14002 @opindex mbig-endian
14003 Generate big-endian code.  This is the default when GCC is configured for an
14004 @samp{aarch64_be-*-*} target.
14006 @item -mgeneral-regs-only
14007 @opindex mgeneral-regs-only
14008 Generate code which uses only the general-purpose registers.  This will prevent
14009 the compiler from using floating-point and Advanced SIMD registers but will not
14010 impose any restrictions on the assembler.
14012 @item -mlittle-endian
14013 @opindex mlittle-endian
14014 Generate little-endian code.  This is the default when GCC is configured for an
14015 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14017 @item -mcmodel=tiny
14018 @opindex mcmodel=tiny
14019 Generate code for the tiny code model.  The program and its statically defined
14020 symbols must be within 1MB of each other.  Programs can be statically or
14021 dynamically linked.
14023 @item -mcmodel=small
14024 @opindex mcmodel=small
14025 Generate code for the small code model.  The program and its statically defined
14026 symbols must be within 4GB of each other.  Programs can be statically or
14027 dynamically linked.  This is the default code model.
14029 @item -mcmodel=large
14030 @opindex mcmodel=large
14031 Generate code for the large code model.  This makes no assumptions about
14032 addresses and sizes of sections.  Programs can be statically linked only.
14034 @item -mstrict-align
14035 @opindex mstrict-align
14036 Avoid generating memory accesses that may not be aligned on a natural object
14037 boundary as described in the architecture specification.
14039 @item -momit-leaf-frame-pointer
14040 @itemx -mno-omit-leaf-frame-pointer
14041 @opindex momit-leaf-frame-pointer
14042 @opindex mno-omit-leaf-frame-pointer
14043 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14044 default.
14046 @item -mtls-dialect=desc
14047 @opindex mtls-dialect=desc
14048 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14049 of TLS variables.  This is the default.
14051 @item -mtls-dialect=traditional
14052 @opindex mtls-dialect=traditional
14053 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14054 of TLS variables.
14056 @item -mtls-size=@var{size}
14057 @opindex mtls-size
14058 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14059 This option requires binutils 2.26 or newer.
14061 @item -mfix-cortex-a53-835769
14062 @itemx -mno-fix-cortex-a53-835769
14063 @opindex mfix-cortex-a53-835769
14064 @opindex mno-fix-cortex-a53-835769
14065 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14066 This involves inserting a NOP instruction between memory instructions and
14067 64-bit integer multiply-accumulate instructions.
14069 @item -mfix-cortex-a53-843419
14070 @itemx -mno-fix-cortex-a53-843419
14071 @opindex mfix-cortex-a53-843419
14072 @opindex mno-fix-cortex-a53-843419
14073 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14074 This erratum workaround is made at link time and this will only pass the
14075 corresponding flag to the linker.
14077 @item -mlow-precision-recip-sqrt
14078 @item -mno-low-precision-recip-sqrt
14079 @opindex mlow-precision-recip-sqrt
14080 @opindex mno-low-precision-recip-sqrt
14081 Enable or disable the reciprocal square root approximation.
14082 This option only has an effect if @option{-ffast-math} or
14083 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14084 precision of reciprocal square root results to about 16 bits for
14085 single precision and to 32 bits for double precision.
14087 @item -mlow-precision-sqrt
14088 @item -mno-low-precision-sqrt
14089 @opindex -mlow-precision-sqrt
14090 @opindex -mno-low-precision-sqrt
14091 Enable or disable the square root approximation.
14092 This option only has an effect if @option{-ffast-math} or
14093 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14094 precision of square root results to about 16 bits for
14095 single precision and to 32 bits for double precision.
14096 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14098 @item -mlow-precision-div
14099 @item -mno-low-precision-div
14100 @opindex -mlow-precision-div
14101 @opindex -mno-low-precision-div
14102 Enable or disable the division approximation.
14103 This option only has an effect if @option{-ffast-math} or
14104 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14105 precision of division results to about 16 bits for
14106 single precision and to 32 bits for double precision.
14108 @item -march=@var{name}
14109 @opindex march
14110 Specify the name of the target architecture and, optionally, one or
14111 more feature modifiers.  This option has the form
14112 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14114 The permissible values for @var{arch} are @samp{armv8-a},
14115 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14117 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14118 support for the ARMv8.3-A architecture extensions.
14120 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14121 support for the ARMv8.2-A architecture extensions.
14123 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14124 support for the ARMv8.1-A architecture extension.  In particular, it
14125 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14127 The value @samp{native} is available on native AArch64 GNU/Linux and
14128 causes the compiler to pick the architecture of the host system.  This
14129 option has no effect if the compiler is unable to recognize the
14130 architecture of the host system,
14132 The permissible values for @var{feature} are listed in the sub-section
14133 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14134 Feature Modifiers}.  Where conflicting feature modifiers are
14135 specified, the right-most feature is used.
14137 GCC uses @var{name} to determine what kind of instructions it can emit
14138 when generating assembly code.  If @option{-march} is specified
14139 without either of @option{-mtune} or @option{-mcpu} also being
14140 specified, the code is tuned to perform well across a range of target
14141 processors implementing the target architecture.
14143 @item -mtune=@var{name}
14144 @opindex mtune
14145 Specify the name of the target processor for which GCC should tune the
14146 performance of the code.  Permissible values for this option are:
14147 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14148 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14149 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14150 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14151 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14152 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14153 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14154 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14155 @samp{native}.
14157 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14158 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14159 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14160 big.LITTLE system.
14162 Additionally on native AArch64 GNU/Linux systems the value
14163 @samp{native} tunes performance to the host system.  This option has no effect
14164 if the compiler is unable to recognize the processor of the host system.
14166 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14167 are specified, the code is tuned to perform well across a range
14168 of target processors.
14170 This option cannot be suffixed by feature modifiers.
14172 @item -mcpu=@var{name}
14173 @opindex mcpu
14174 Specify the name of the target processor, optionally suffixed by one
14175 or more feature modifiers.  This option has the form
14176 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14177 the permissible values for @var{cpu} are the same as those available
14178 for @option{-mtune}.  The permissible values for @var{feature} are
14179 documented in the sub-section on
14180 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14181 Feature Modifiers}.  Where conflicting feature modifiers are
14182 specified, the right-most feature is used.
14184 GCC uses @var{name} to determine what kind of instructions it can emit when
14185 generating assembly code (as if by @option{-march}) and to determine
14186 the target processor for which to tune for performance (as if
14187 by @option{-mtune}).  Where this option is used in conjunction
14188 with @option{-march} or @option{-mtune}, those options take precedence
14189 over the appropriate part of this option.
14191 @item -moverride=@var{string}
14192 @opindex moverride
14193 Override tuning decisions made by the back-end in response to a
14194 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14195 for @var{string} in this option are not guaranteed to be consistent
14196 across releases.
14198 This option is only intended to be useful when developing GCC.
14200 @item -mpc-relative-literal-loads
14201 @itemx -mno-pc-relative-literal-loads
14202 @opindex mpc-relative-literal-loads
14203 @opindex mno-pc-relative-literal-loads
14204 Enable or disable PC-relative literal loads.  With this option literal pools are
14205 accessed using a single instruction and emitted after each function.  This
14206 limits the maximum size of functions to 1MB.  This is enabled by default for
14207 @option{-mcmodel=tiny}.
14209 @item -msign-return-address=@var{scope}
14210 @opindex msign-return-address
14211 Select the function scope on which return address signing will be applied.
14212 Permissible values are @samp{none}, which disables return address signing,
14213 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14214 functions, and @samp{all}, which enables pointer signing for all functions.  The
14215 default value is @samp{none}.
14217 @end table
14219 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14220 @anchor{aarch64-feature-modifiers}
14221 @cindex @option{-march} feature modifiers
14222 @cindex @option{-mcpu} feature modifiers
14223 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14224 the following and their inverses @option{no@var{feature}}:
14226 @table @samp
14227 @item crc
14228 Enable CRC extension.  This is on by default for
14229 @option{-march=armv8.1-a}.
14230 @item crypto
14231 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14232 instructions.
14233 @item fp
14234 Enable floating-point instructions.  This is on by default for all possible
14235 values for options @option{-march} and @option{-mcpu}.
14236 @item simd
14237 Enable Advanced SIMD instructions.  This also enables floating-point
14238 instructions.  This is on by default for all possible values for options
14239 @option{-march} and @option{-mcpu}.
14240 @item lse
14241 Enable Large System Extension instructions.  This is on by default for
14242 @option{-march=armv8.1-a}.
14243 @item rdma
14244 Enable Round Double Multiply Accumulate instructions.  This is on by default
14245 for @option{-march=armv8.1-a}.
14246 @item fp16
14247 Enable FP16 extension.  This also enables floating-point instructions.
14248 @item rcpc
14249 Enable the RcPc extension.  This does not change code generation from GCC,
14250 but is passed on to the assembler, enabling inline asm statements to use
14251 instructions from the RcPc extension.
14253 @end table
14255 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14256 Conversely, @option{nofp} implies @option{nosimd}, which implies
14257 @option{nocrypto}.
14259 @node Adapteva Epiphany Options
14260 @subsection Adapteva Epiphany Options
14262 These @samp{-m} options are defined for Adapteva Epiphany:
14264 @table @gcctabopt
14265 @item -mhalf-reg-file
14266 @opindex mhalf-reg-file
14267 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14268 That allows code to run on hardware variants that lack these registers.
14270 @item -mprefer-short-insn-regs
14271 @opindex mprefer-short-insn-regs
14272 Preferentially allocate registers that allow short instruction generation.
14273 This can result in increased instruction count, so this may either reduce or
14274 increase overall code size.
14276 @item -mbranch-cost=@var{num}
14277 @opindex mbranch-cost
14278 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14279 This cost is only a heuristic and is not guaranteed to produce
14280 consistent results across releases.
14282 @item -mcmove
14283 @opindex mcmove
14284 Enable the generation of conditional moves.
14286 @item -mnops=@var{num}
14287 @opindex mnops
14288 Emit @var{num} NOPs before every other generated instruction.
14290 @item -mno-soft-cmpsf
14291 @opindex mno-soft-cmpsf
14292 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14293 and test the flags.  This is faster than a software comparison, but can
14294 get incorrect results in the presence of NaNs, or when two different small
14295 numbers are compared such that their difference is calculated as zero.
14296 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14297 software comparisons.
14299 @item -mstack-offset=@var{num}
14300 @opindex mstack-offset
14301 Set the offset between the top of the stack and the stack pointer.
14302 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14303 can be used by leaf functions without stack allocation.
14304 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14305 Note also that this option changes the ABI; compiling a program with a
14306 different stack offset than the libraries have been compiled with
14307 generally does not work.
14308 This option can be useful if you want to evaluate if a different stack
14309 offset would give you better code, but to actually use a different stack
14310 offset to build working programs, it is recommended to configure the
14311 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14313 @item -mno-round-nearest
14314 @opindex mno-round-nearest
14315 Make the scheduler assume that the rounding mode has been set to
14316 truncating.  The default is @option{-mround-nearest}.
14318 @item -mlong-calls
14319 @opindex mlong-calls
14320 If not otherwise specified by an attribute, assume all calls might be beyond
14321 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14322 function address into a register before performing a (otherwise direct) call.
14323 This is the default.
14325 @item -mshort-calls
14326 @opindex short-calls
14327 If not otherwise specified by an attribute, assume all direct calls are
14328 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14329 for direct calls.  The default is @option{-mlong-calls}.
14331 @item -msmall16
14332 @opindex msmall16
14333 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14334 apply to function addresses for which @option{-mlong-calls} semantics
14335 are in effect.
14337 @item -mfp-mode=@var{mode}
14338 @opindex mfp-mode
14339 Set the prevailing mode of the floating-point unit.
14340 This determines the floating-point mode that is provided and expected
14341 at function call and return time.  Making this mode match the mode you
14342 predominantly need at function start can make your programs smaller and
14343 faster by avoiding unnecessary mode switches.
14345 @var{mode} can be set to one the following values:
14347 @table @samp
14348 @item caller
14349 Any mode at function entry is valid, and retained or restored when
14350 the function returns, and when it calls other functions.
14351 This mode is useful for compiling libraries or other compilation units
14352 you might want to incorporate into different programs with different
14353 prevailing FPU modes, and the convenience of being able to use a single
14354 object file outweighs the size and speed overhead for any extra
14355 mode switching that might be needed, compared with what would be needed
14356 with a more specific choice of prevailing FPU mode.
14358 @item truncate
14359 This is the mode used for floating-point calculations with
14360 truncating (i.e.@: round towards zero) rounding mode.  That includes
14361 conversion from floating point to integer.
14363 @item round-nearest
14364 This is the mode used for floating-point calculations with
14365 round-to-nearest-or-even rounding mode.
14367 @item int
14368 This is the mode used to perform integer calculations in the FPU, e.g.@:
14369 integer multiply, or integer multiply-and-accumulate.
14370 @end table
14372 The default is @option{-mfp-mode=caller}
14374 @item -mnosplit-lohi
14375 @itemx -mno-postinc
14376 @itemx -mno-postmodify
14377 @opindex mnosplit-lohi
14378 @opindex mno-postinc
14379 @opindex mno-postmodify
14380 Code generation tweaks that disable, respectively, splitting of 32-bit
14381 loads, generation of post-increment addresses, and generation of
14382 post-modify addresses.  The defaults are @option{msplit-lohi},
14383 @option{-mpost-inc}, and @option{-mpost-modify}.
14385 @item -mnovect-double
14386 @opindex mno-vect-double
14387 Change the preferred SIMD mode to SImode.  The default is
14388 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14390 @item -max-vect-align=@var{num}
14391 @opindex max-vect-align
14392 The maximum alignment for SIMD vector mode types.
14393 @var{num} may be 4 or 8.  The default is 8.
14394 Note that this is an ABI change, even though many library function
14395 interfaces are unaffected if they don't use SIMD vector modes
14396 in places that affect size and/or alignment of relevant types.
14398 @item -msplit-vecmove-early
14399 @opindex msplit-vecmove-early
14400 Split vector moves into single word moves before reload.  In theory this
14401 can give better register allocation, but so far the reverse seems to be
14402 generally the case.
14404 @item -m1reg-@var{reg}
14405 @opindex m1reg-
14406 Specify a register to hold the constant @minus{}1, which makes loading small negative
14407 constants and certain bitmasks faster.
14408 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14409 which specify use of that register as a fixed register,
14410 and @samp{none}, which means that no register is used for this
14411 purpose.  The default is @option{-m1reg-none}.
14413 @end table
14415 @node ARC Options
14416 @subsection ARC Options
14417 @cindex ARC options
14419 The following options control the architecture variant for which code
14420 is being compiled:
14422 @c architecture variants
14423 @table @gcctabopt
14425 @item -mbarrel-shifter
14426 @opindex mbarrel-shifter
14427 Generate instructions supported by barrel shifter.  This is the default
14428 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14430 @item -mcpu=@var{cpu}
14431 @opindex mcpu
14432 Set architecture type, register usage, and instruction scheduling
14433 parameters for @var{cpu}.  There are also shortcut alias options
14434 available for backward compatibility and convenience.  Supported
14435 values for @var{cpu} are
14437 @table @samp
14438 @opindex mA6
14439 @opindex mARC600
14440 @item arc600
14441 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14443 @item arc601
14444 @opindex mARC601
14445 Compile for ARC601.  Alias: @option{-mARC601}.
14447 @item arc700
14448 @opindex mA7
14449 @opindex mARC700
14450 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14451 This is the default when configured with @option{--with-cpu=arc700}@.
14453 @item arcem
14454 Compile for ARC EM.
14456 @item archs
14457 Compile for ARC HS.
14459 @item em
14460 Compile for ARC EM CPU with no hardware extensions.
14462 @item em4
14463 Compile for ARC EM4 CPU.
14465 @item em4_dmips
14466 Compile for ARC EM4 DMIPS CPU.
14468 @item em4_fpus
14469 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14470 extension.
14472 @item em4_fpuda
14473 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14474 double assist instructions.
14476 @item hs
14477 Compile for ARC HS CPU with no hardware extensions except the atomic
14478 instructions.
14480 @item hs34
14481 Compile for ARC HS34 CPU.
14483 @item hs38
14484 Compile for ARC HS38 CPU.
14486 @item hs38_linux
14487 Compile for ARC HS38 CPU with all hardware extensions on.
14489 @item arc600_norm
14490 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14492 @item arc600_mul32x16
14493 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14494 instructions enabled.
14496 @item arc600_mul64
14497 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14498 instructions enabled.
14500 @item arc601_norm
14501 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14503 @item arc601_mul32x16
14504 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14505 instructions enabled.
14507 @item arc601_mul64
14508 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14509 instructions enabled.
14511 @item nps400
14512 Compile for ARC 700 on NPS400 chip.
14514 @end table
14516 @item -mdpfp
14517 @opindex mdpfp
14518 @itemx -mdpfp-compact
14519 @opindex mdpfp-compact
14520 Generate double-precision FPX instructions, tuned for the compact
14521 implementation.
14523 @item -mdpfp-fast
14524 @opindex mdpfp-fast
14525 Generate double-precision FPX instructions, tuned for the fast
14526 implementation.
14528 @item -mno-dpfp-lrsr
14529 @opindex mno-dpfp-lrsr
14530 Disable @code{lr} and @code{sr} instructions from using FPX extension
14531 aux registers.
14533 @item -mea
14534 @opindex mea
14535 Generate extended arithmetic instructions.  Currently only
14536 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14537 supported.  This is always enabled for @option{-mcpu=ARC700}.
14539 @item -mno-mpy
14540 @opindex mno-mpy
14541 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14542 deprecated.
14544 @item -mmul32x16
14545 @opindex mmul32x16
14546 Generate 32x16-bit multiply and multiply-accumulate instructions.
14548 @item -mmul64
14549 @opindex mmul64
14550 Generate @code{mul64} and @code{mulu64} instructions.  
14551 Only valid for @option{-mcpu=ARC600}.
14553 @item -mnorm
14554 @opindex mnorm
14555 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14556 is in effect.
14558 @item -mspfp
14559 @opindex mspfp
14560 @itemx -mspfp-compact
14561 @opindex mspfp-compact
14562 Generate single-precision FPX instructions, tuned for the compact
14563 implementation.
14565 @item -mspfp-fast
14566 @opindex mspfp-fast
14567 Generate single-precision FPX instructions, tuned for the fast
14568 implementation.
14570 @item -msimd
14571 @opindex msimd
14572 Enable generation of ARC SIMD instructions via target-specific
14573 builtins.  Only valid for @option{-mcpu=ARC700}.
14575 @item -msoft-float
14576 @opindex msoft-float
14577 This option ignored; it is provided for compatibility purposes only.
14578 Software floating-point code is emitted by default, and this default
14579 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14580 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14581 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14583 @item -mswap
14584 @opindex mswap
14585 Generate @code{swap} instructions.
14587 @item -matomic
14588 @opindex matomic
14589 This enables use of the locked load/store conditional extension to implement
14590 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14591 EM cores.
14593 @item -mdiv-rem
14594 @opindex mdiv-rem
14595 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14597 @item -mcode-density
14598 @opindex mcode-density
14599 Enable code density instructions for ARC EM.  
14600 This option is on by default for ARC HS.
14602 @item -mll64
14603 @opindex mll64
14604 Enable double load/store operations for ARC HS cores.
14606 @item -mtp-regno=@var{regno}
14607 @opindex mtp-regno
14608 Specify thread pointer register number.
14610 @item -mmpy-option=@var{multo}
14611 @opindex mmpy-option
14612 Compile ARCv2 code with a multiplier design option.  You can specify 
14613 the option using either a string or numeric value for @var{multo}.  
14614 @samp{wlh1} is the default value.  The recognized values are:
14616 @table @samp
14617 @item 0
14618 @itemx none
14619 No multiplier available.
14621 @item 1
14622 @itemx w
14623 16x16 multiplier, fully pipelined.
14624 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14626 @item 2
14627 @itemx wlh1
14628 32x32 multiplier, fully
14629 pipelined (1 stage).  The following instructions are additionally
14630 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14632 @item 3
14633 @itemx wlh2
14634 32x32 multiplier, fully pipelined
14635 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14636 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14638 @item 4
14639 @itemx wlh3
14640 Two 16x16 multipliers, blocking,
14641 sequential.  The following instructions are additionally enabled: @code{mpy},
14642 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14644 @item 5
14645 @itemx wlh4
14646 One 16x16 multiplier, blocking,
14647 sequential.  The following instructions are additionally enabled: @code{mpy},
14648 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14650 @item 6
14651 @itemx wlh5
14652 One 32x4 multiplier, blocking,
14653 sequential.  The following instructions are additionally enabled: @code{mpy},
14654 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14656 @item 7
14657 @itemx plus_dmpy
14658 ARC HS SIMD support.
14660 @item 8
14661 @itemx plus_macd
14662 ARC HS SIMD support.
14664 @item 9
14665 @itemx plus_qmacw
14666 ARC HS SIMD support.
14668 @end table
14670 This option is only available for ARCv2 cores@.
14672 @item -mfpu=@var{fpu}
14673 @opindex mfpu
14674 Enables support for specific floating-point hardware extensions for ARCv2
14675 cores.  Supported values for @var{fpu} are:
14677 @table @samp
14679 @item fpus
14680 Enables support for single-precision floating-point hardware
14681 extensions@.
14683 @item fpud
14684 Enables support for double-precision floating-point hardware
14685 extensions.  The single-precision floating-point extension is also
14686 enabled.  Not available for ARC EM@.
14688 @item fpuda
14689 Enables support for double-precision floating-point hardware
14690 extensions using double-precision assist instructions.  The single-precision
14691 floating-point extension is also enabled.  This option is
14692 only available for ARC EM@.
14694 @item fpuda_div
14695 Enables support for double-precision floating-point hardware
14696 extensions using double-precision assist instructions.
14697 The single-precision floating-point, square-root, and divide 
14698 extensions are also enabled.  This option is
14699 only available for ARC EM@.
14701 @item fpuda_fma
14702 Enables support for double-precision floating-point hardware
14703 extensions using double-precision assist instructions.
14704 The single-precision floating-point and fused multiply and add 
14705 hardware extensions are also enabled.  This option is
14706 only available for ARC EM@.
14708 @item fpuda_all
14709 Enables support for double-precision floating-point hardware
14710 extensions using double-precision assist instructions.
14711 All single-precision floating-point hardware extensions are also
14712 enabled.  This option is only available for ARC EM@.
14714 @item fpus_div
14715 Enables support for single-precision floating-point, square-root and divide 
14716 hardware extensions@.
14718 @item fpud_div
14719 Enables support for double-precision floating-point, square-root and divide 
14720 hardware extensions.  This option
14721 includes option @samp{fpus_div}. Not available for ARC EM@.
14723 @item fpus_fma
14724 Enables support for single-precision floating-point and 
14725 fused multiply and add hardware extensions@.
14727 @item fpud_fma
14728 Enables support for double-precision floating-point and 
14729 fused multiply and add hardware extensions.  This option
14730 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14732 @item fpus_all
14733 Enables support for all single-precision floating-point hardware
14734 extensions@.
14736 @item fpud_all
14737 Enables support for all single- and double-precision floating-point
14738 hardware extensions.  Not available for ARC EM@.
14740 @end table
14742 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14743 @opindex mirq-ctrl-saved
14744 Specifies general-purposes registers that the processor automatically
14745 saves/restores on interrupt entry and exit.  @var{register-range} is
14746 specified as two registers separated by a dash.  The register range
14747 always starts with @code{r0}, the upper limit is @code{fp} register.
14748 @var{blink} and @var{lp_count} are optional.  This option is only
14749 valid for ARC EM and ARC HS cores.
14751 @item -mrgf-banked-regs=@var{number}
14752 @opindex mrgf-banked-regs
14753 Specifies the number of registers replicated in second register bank
14754 on entry to fast interrupt.  Fast interrupts are interrupts with the
14755 highest priority level P0.  These interrupts save only PC and STATUS32
14756 registers to avoid memory transactions during interrupt entry and exit
14757 sequences.  Use this option when you are using fast interrupts in an
14758 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14760 @end table
14762 The following options are passed through to the assembler, and also
14763 define preprocessor macro symbols.
14765 @c Flags used by the assembler, but for which we define preprocessor
14766 @c macro symbols as well.
14767 @table @gcctabopt
14768 @item -mdsp-packa
14769 @opindex mdsp-packa
14770 Passed down to the assembler to enable the DSP Pack A extensions.
14771 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14772 deprecated.
14774 @item -mdvbf
14775 @opindex mdvbf
14776 Passed down to the assembler to enable the dual Viterbi butterfly
14777 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14778 option is deprecated.
14780 @c ARC700 4.10 extension instruction
14781 @item -mlock
14782 @opindex mlock
14783 Passed down to the assembler to enable the locked load/store
14784 conditional extension.  Also sets the preprocessor symbol
14785 @code{__Xlock}.
14787 @item -mmac-d16
14788 @opindex mmac-d16
14789 Passed down to the assembler.  Also sets the preprocessor symbol
14790 @code{__Xxmac_d16}.  This option is deprecated.
14792 @item -mmac-24
14793 @opindex mmac-24
14794 Passed down to the assembler.  Also sets the preprocessor symbol
14795 @code{__Xxmac_24}.  This option is deprecated.
14797 @c ARC700 4.10 extension instruction
14798 @item -mrtsc
14799 @opindex mrtsc
14800 Passed down to the assembler to enable the 64-bit time-stamp counter
14801 extension instruction.  Also sets the preprocessor symbol
14802 @code{__Xrtsc}.  This option is deprecated.
14804 @c ARC700 4.10 extension instruction
14805 @item -mswape
14806 @opindex mswape
14807 Passed down to the assembler to enable the swap byte ordering
14808 extension instruction.  Also sets the preprocessor symbol
14809 @code{__Xswape}.
14811 @item -mtelephony
14812 @opindex mtelephony
14813 Passed down to the assembler to enable dual- and single-operand
14814 instructions for telephony.  Also sets the preprocessor symbol
14815 @code{__Xtelephony}.  This option is deprecated.
14817 @item -mxy
14818 @opindex mxy
14819 Passed down to the assembler to enable the XY memory extension.  Also
14820 sets the preprocessor symbol @code{__Xxy}.
14822 @end table
14824 The following options control how the assembly code is annotated:
14826 @c Assembly annotation options
14827 @table @gcctabopt
14828 @item -misize
14829 @opindex misize
14830 Annotate assembler instructions with estimated addresses.
14832 @item -mannotate-align
14833 @opindex mannotate-align
14834 Explain what alignment considerations lead to the decision to make an
14835 instruction short or long.
14837 @end table
14839 The following options are passed through to the linker:
14841 @c options passed through to the linker
14842 @table @gcctabopt
14843 @item -marclinux
14844 @opindex marclinux
14845 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14846 This option is enabled by default in tool chains built for
14847 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14848 when profiling is not requested.
14850 @item -marclinux_prof
14851 @opindex marclinux_prof
14852 Passed through to the linker, to specify use of the
14853 @code{arclinux_prof} emulation.  This option is enabled by default in
14854 tool chains built for @w{@code{arc-linux-uclibc}} and
14855 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14857 @end table
14859 The following options control the semantics of generated code:
14861 @c semantically relevant code generation options
14862 @table @gcctabopt
14863 @item -mlong-calls
14864 @opindex mlong-calls
14865 Generate calls as register indirect calls, thus providing access
14866 to the full 32-bit address range.
14868 @item -mmedium-calls
14869 @opindex mmedium-calls
14870 Don't use less than 25-bit addressing range for calls, which is the
14871 offset available for an unconditional branch-and-link
14872 instruction.  Conditional execution of function calls is suppressed, to
14873 allow use of the 25-bit range, rather than the 21-bit range with
14874 conditional branch-and-link.  This is the default for tool chains built
14875 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14877 @item -mno-sdata
14878 @opindex mno-sdata
14879 Do not generate sdata references.  This is the default for tool chains
14880 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14881 targets.
14883 @item -mvolatile-cache
14884 @opindex mvolatile-cache
14885 Use ordinarily cached memory accesses for volatile references.  This is the
14886 default.
14888 @item -mno-volatile-cache
14889 @opindex mno-volatile-cache
14890 Enable cache bypass for volatile references.
14892 @end table
14894 The following options fine tune code generation:
14895 @c code generation tuning options
14896 @table @gcctabopt
14897 @item -malign-call
14898 @opindex malign-call
14899 Do alignment optimizations for call instructions.
14901 @item -mauto-modify-reg
14902 @opindex mauto-modify-reg
14903 Enable the use of pre/post modify with register displacement.
14905 @item -mbbit-peephole
14906 @opindex mbbit-peephole
14907 Enable bbit peephole2.
14909 @item -mno-brcc
14910 @opindex mno-brcc
14911 This option disables a target-specific pass in @file{arc_reorg} to
14912 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14913 It has no effect on
14914 generation of these instructions driven by the combiner pass.
14916 @item -mcase-vector-pcrel
14917 @opindex mcase-vector-pcrel
14918 Use PC-relative switch case tables to enable case table shortening.
14919 This is the default for @option{-Os}.
14921 @item -mcompact-casesi
14922 @opindex mcompact-casesi
14923 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14924 and only available for ARCv1 cores.
14926 @item -mno-cond-exec
14927 @opindex mno-cond-exec
14928 Disable the ARCompact-specific pass to generate conditional 
14929 execution instructions.
14931 Due to delay slot scheduling and interactions between operand numbers,
14932 literal sizes, instruction lengths, and the support for conditional execution,
14933 the target-independent pass to generate conditional execution is often lacking,
14934 so the ARC port has kept a special pass around that tries to find more
14935 conditional execution generation opportunities after register allocation,
14936 branch shortening, and delay slot scheduling have been done.  This pass
14937 generally, but not always, improves performance and code size, at the cost of
14938 extra compilation time, which is why there is an option to switch it off.
14939 If you have a problem with call instructions exceeding their allowable
14940 offset range because they are conditionalized, you should consider using
14941 @option{-mmedium-calls} instead.
14943 @item -mearly-cbranchsi
14944 @opindex mearly-cbranchsi
14945 Enable pre-reload use of the @code{cbranchsi} pattern.
14947 @item -mexpand-adddi
14948 @opindex mexpand-adddi
14949 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14950 @code{add.f}, @code{adc} etc.  This option is deprecated.
14952 @item -mindexed-loads
14953 @opindex mindexed-loads
14954 Enable the use of indexed loads.  This can be problematic because some
14955 optimizers then assume that indexed stores exist, which is not
14956 the case.
14958 @opindex mlra
14959 Enable Local Register Allocation.  This is still experimental for ARC,
14960 so by default the compiler uses standard reload
14961 (i.e. @option{-mno-lra}).
14963 @item -mlra-priority-none
14964 @opindex mlra-priority-none
14965 Don't indicate any priority for target registers.
14967 @item -mlra-priority-compact
14968 @opindex mlra-priority-compact
14969 Indicate target register priority for r0..r3 / r12..r15.
14971 @item -mlra-priority-noncompact
14972 @opindex mlra-priority-noncompact
14973 Reduce target register priority for r0..r3 / r12..r15.
14975 @item -mno-millicode
14976 @opindex mno-millicode
14977 When optimizing for size (using @option{-Os}), prologues and epilogues
14978 that have to save or restore a large number of registers are often
14979 shortened by using call to a special function in libgcc; this is
14980 referred to as a @emph{millicode} call.  As these calls can pose
14981 performance issues, and/or cause linking issues when linking in a
14982 nonstandard way, this option is provided to turn off millicode call
14983 generation.
14985 @item -mmixed-code
14986 @opindex mmixed-code
14987 Tweak register allocation to help 16-bit instruction generation.
14988 This generally has the effect of decreasing the average instruction size
14989 while increasing the instruction count.
14991 @item -mq-class
14992 @opindex mq-class
14993 Enable @samp{q} instruction alternatives.
14994 This is the default for @option{-Os}.
14996 @item -mRcq
14997 @opindex mRcq
14998 Enable @samp{Rcq} constraint handling.  
14999 Most short code generation depends on this.
15000 This is the default.
15002 @item -mRcw
15003 @opindex mRcw
15004 Enable @samp{Rcw} constraint handling.  
15005 Most ccfsm condexec mostly depends on this.
15006 This is the default.
15008 @item -msize-level=@var{level}
15009 @opindex msize-level
15010 Fine-tune size optimization with regards to instruction lengths and alignment.
15011 The recognized values for @var{level} are:
15012 @table @samp
15013 @item 0
15014 No size optimization.  This level is deprecated and treated like @samp{1}.
15016 @item 1
15017 Short instructions are used opportunistically.
15019 @item 2
15020 In addition, alignment of loops and of code after barriers are dropped.
15022 @item 3
15023 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15025 @end table
15027 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15028 the behavior when this is not set is equivalent to level @samp{1}.
15030 @item -mtune=@var{cpu}
15031 @opindex mtune
15032 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15033 by @option{-mcpu=}.
15035 Supported values for @var{cpu} are
15037 @table @samp
15038 @item ARC600
15039 Tune for ARC600 CPU.
15041 @item ARC601
15042 Tune for ARC601 CPU.
15044 @item ARC700
15045 Tune for ARC700 CPU with standard multiplier block.
15047 @item ARC700-xmac
15048 Tune for ARC700 CPU with XMAC block.
15050 @item ARC725D
15051 Tune for ARC725D CPU.
15053 @item ARC750D
15054 Tune for ARC750D CPU.
15056 @end table
15058 @item -mmultcost=@var{num}
15059 @opindex mmultcost
15060 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15061 normal instruction.
15063 @item -munalign-prob-threshold=@var{probability}
15064 @opindex munalign-prob-threshold
15065 Set probability threshold for unaligning branches.
15066 When tuning for @samp{ARC700} and optimizing for speed, branches without
15067 filled delay slot are preferably emitted unaligned and long, unless
15068 profiling indicates that the probability for the branch to be taken
15069 is below @var{probability}.  @xref{Cross-profiling}.
15070 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15072 @end table
15074 The following options are maintained for backward compatibility, but
15075 are now deprecated and will be removed in a future release:
15077 @c Deprecated options
15078 @table @gcctabopt
15080 @item -margonaut
15081 @opindex margonaut
15082 Obsolete FPX.
15084 @item -mbig-endian
15085 @opindex mbig-endian
15086 @itemx -EB
15087 @opindex EB
15088 Compile code for big-endian targets.  Use of these options is now
15089 deprecated.  Big-endian code is supported by configuring GCC to build
15090 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15091 for which big endian is the default.
15093 @item -mlittle-endian
15094 @opindex mlittle-endian
15095 @itemx -EL
15096 @opindex EL
15097 Compile code for little-endian targets.  Use of these options is now
15098 deprecated.  Little-endian code is supported by configuring GCC to build 
15099 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15100 for which little endian is the default.
15102 @item -mbarrel_shifter
15103 @opindex mbarrel_shifter
15104 Replaced by @option{-mbarrel-shifter}.
15106 @item -mdpfp_compact
15107 @opindex mdpfp_compact
15108 Replaced by @option{-mdpfp-compact}.
15110 @item -mdpfp_fast
15111 @opindex mdpfp_fast
15112 Replaced by @option{-mdpfp-fast}.
15114 @item -mdsp_packa
15115 @opindex mdsp_packa
15116 Replaced by @option{-mdsp-packa}.
15118 @item -mEA
15119 @opindex mEA
15120 Replaced by @option{-mea}.
15122 @item -mmac_24
15123 @opindex mmac_24
15124 Replaced by @option{-mmac-24}.
15126 @item -mmac_d16
15127 @opindex mmac_d16
15128 Replaced by @option{-mmac-d16}.
15130 @item -mspfp_compact
15131 @opindex mspfp_compact
15132 Replaced by @option{-mspfp-compact}.
15134 @item -mspfp_fast
15135 @opindex mspfp_fast
15136 Replaced by @option{-mspfp-fast}.
15138 @item -mtune=@var{cpu}
15139 @opindex mtune
15140 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15141 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15142 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15144 @item -multcost=@var{num}
15145 @opindex multcost
15146 Replaced by @option{-mmultcost}.
15148 @end table
15150 @node ARM Options
15151 @subsection ARM Options
15152 @cindex ARM options
15154 These @samp{-m} options are defined for the ARM port:
15156 @table @gcctabopt
15157 @item -mabi=@var{name}
15158 @opindex mabi
15159 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15160 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15162 @item -mapcs-frame
15163 @opindex mapcs-frame
15164 Generate a stack frame that is compliant with the ARM Procedure Call
15165 Standard for all functions, even if this is not strictly necessary for
15166 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15167 with this option causes the stack frames not to be generated for
15168 leaf functions.  The default is @option{-mno-apcs-frame}.
15169 This option is deprecated.
15171 @item -mapcs
15172 @opindex mapcs
15173 This is a synonym for @option{-mapcs-frame} and is deprecated.
15175 @ignore
15176 @c not currently implemented
15177 @item -mapcs-stack-check
15178 @opindex mapcs-stack-check
15179 Generate code to check the amount of stack space available upon entry to
15180 every function (that actually uses some stack space).  If there is
15181 insufficient space available then either the function
15182 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15183 called, depending upon the amount of stack space required.  The runtime
15184 system is required to provide these functions.  The default is
15185 @option{-mno-apcs-stack-check}, since this produces smaller code.
15187 @c not currently implemented
15188 @item -mapcs-reentrant
15189 @opindex mapcs-reentrant
15190 Generate reentrant, position-independent code.  The default is
15191 @option{-mno-apcs-reentrant}.
15192 @end ignore
15194 @item -mthumb-interwork
15195 @opindex mthumb-interwork
15196 Generate code that supports calling between the ARM and Thumb
15197 instruction sets.  Without this option, on pre-v5 architectures, the
15198 two instruction sets cannot be reliably used inside one program.  The
15199 default is @option{-mno-thumb-interwork}, since slightly larger code
15200 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15201 configurations this option is meaningless.
15203 @item -mno-sched-prolog
15204 @opindex mno-sched-prolog
15205 Prevent the reordering of instructions in the function prologue, or the
15206 merging of those instruction with the instructions in the function's
15207 body.  This means that all functions start with a recognizable set
15208 of instructions (or in fact one of a choice from a small set of
15209 different function prologues), and this information can be used to
15210 locate the start of functions inside an executable piece of code.  The
15211 default is @option{-msched-prolog}.
15213 @item -mfloat-abi=@var{name}
15214 @opindex mfloat-abi
15215 Specifies which floating-point ABI to use.  Permissible values
15216 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15218 Specifying @samp{soft} causes GCC to generate output containing
15219 library calls for floating-point operations.
15220 @samp{softfp} allows the generation of code using hardware floating-point
15221 instructions, but still uses the soft-float calling conventions.
15222 @samp{hard} allows generation of floating-point instructions
15223 and uses FPU-specific calling conventions.
15225 The default depends on the specific target configuration.  Note that
15226 the hard-float and soft-float ABIs are not link-compatible; you must
15227 compile your entire program with the same ABI, and link with a
15228 compatible set of libraries.
15230 @item -mlittle-endian
15231 @opindex mlittle-endian
15232 Generate code for a processor running in little-endian mode.  This is
15233 the default for all standard configurations.
15235 @item -mbig-endian
15236 @opindex mbig-endian
15237 Generate code for a processor running in big-endian mode; the default is
15238 to compile code for a little-endian processor.
15240 @item -mbe8
15241 @itemx -mbe32
15242 @opindex mbe8
15243 When linking a big-endian image select between BE8 and BE32 formats.
15244 The option has no effect for little-endian images and is ignored.  The
15245 default is dependent on the selected target architecture.  For ARMv6
15246 and later architectures the default is BE8, for older architectures
15247 the default is BE32.  BE32 format has been deprecated by ARM.
15249 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15250 @opindex march
15251 This specifies the name of the target ARM architecture.  GCC uses this
15252 name to determine what kind of instructions it can emit when generating
15253 assembly code.  This option can be used in conjunction with or instead
15254 of the @option{-mcpu=} option.
15256 Permissible names are:
15257 @samp{armv4t},
15258 @samp{armv5t}, @samp{armv5te},
15259 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15260 @samp{armv6z}, @samp{armv6zk},
15261 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15262 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15263 @samp{armv7-r},
15264 @samp{armv8-r},
15265 @samp{armv6-m}, @samp{armv6s-m},
15266 @samp{armv7-m}, @samp{armv7e-m},
15267 @samp{armv8-m.base}, @samp{armv8-m.main},
15268 @samp{iwmmxt} and @samp{iwmmxt2}.
15270 Additionally, the following architectures, which lack support for the
15271 Thumb exection state, are recognized but support is deprecated:
15272 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15273 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15275 Many of the architectures support extensions.  These can be added by
15276 appending @samp{+@var{extension}} to the architecture name.  Extension
15277 options are processed in order and capabilities accumulate.  An extension
15278 will also enable any necessary base extensions
15279 upon which it depends.  For example, the @samp{+crypto} extension
15280 will always enable the @samp{+simd} extension.  The exception to the
15281 additive construction is for extensions that are prefixed with
15282 @samp{+no@dots{}}: these extensions disable the specified option and
15283 any other extensions that may depend on the presence of that
15284 extension.
15286 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15287 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15288 entirely disabled by the @samp{+nofp} option that follows it.
15290 Most extension names are generically named, but have an effect that is
15291 dependent upon the architecture to which it is applied.  For example,
15292 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15293 @samp{armv8-a} architectures, but will enable the original ARMv7
15294 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15295 variant for @samp{armv8-a}.
15297 The table below lists the supported extensions for each architecture.
15298 Architectures not mentioned do not support any extensions.
15300 @table @samp
15301 @item  armv5e
15302 @itemx armv5te
15303 @itemx armv6
15304 @itemx armv6j
15305 @itemx armv6k
15306 @itemx armv6kz
15307 @itemx armv6t2
15308 @itemx armv6z
15309 @itemx armv6zk
15310 @table @samp
15311 @item +fp
15312 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15313 used as an alias for this extension.
15315 @item +nofp
15316 Disable the floating-point instructions.
15317 @end table
15319 @item armv7
15320 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15321 @table @samp
15322 @item +fp
15323 The VFPv3 floating-point instructions, with 16 double-precision
15324 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15325 for this extension.  Note that floating-point is not supported by the
15326 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15327 ARMv7-R architectures.
15329 @item +nofp
15330 Disable the floating-point instructions.
15331 @end table
15333 @item armv7-a
15334 @table @samp
15335 @item +fp
15336 The VFPv3 floating-point instructions, with 16 double-precision
15337 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15338 for this extension.
15340 @item +simd
15341 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15342 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15343 for this extension.
15345 @item +vfpv3
15346 The VFPv3 floating-point instructions, with 32 double-precision
15347 registers.
15349 @item +vfpv3-d16-fp16
15350 The VFPv3 floating-point instructions, with 16 double-precision
15351 registers and the half-precision floating-point conversion operations.
15353 @item +vfpv3-fp16
15354 The VFPv3 floating-point instructions, with 32 double-precision
15355 registers and the half-precision floating-point conversion operations.
15357 @item +vfpv4-d16
15358 The VFPv4 floating-point instructions, with 16 double-precision
15359 registers.
15361 @item +vfpv4
15362 The VFPv4 floating-point instructions, with 32 double-precision
15363 registers.
15365 @item +neon-fp16
15366 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15367 the half-precision floating-point conversion operations.
15369 @item +neon-vfpv4
15370 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15372 @item +nosimd
15373 Disable the Advanced SIMD instructions (does not disable floating point).
15375 @item +nofp
15376 Disable the floating-point and Advanced SIMD instructions.
15377 @end table
15379 @item armv7ve
15380 The extended version of the ARMv7-A architecture with support for
15381 virtualization.
15382 @table @samp
15383 @item +fp
15384 The VFPv4 floating-point instructions, with 16 double-precision registers.
15385 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15387 @item +simd
15388 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15389 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15391 @item +vfpv3-d16
15392 The VFPv3 floating-point instructions, with 16 double-precision
15393 registers.
15395 @item +vfpv3
15396 The VFPv3 floating-point instructions, with 32 double-precision
15397 registers.
15399 @item +vfpv3-d16-fp16
15400 The VFPv3 floating-point instructions, with 16 double-precision
15401 registers and the half-precision floating-point conversion operations.
15403 @item +vfpv3-fp16
15404 The VFPv3 floating-point instructions, with 32 double-precision
15405 registers and the half-precision floating-point conversion operations.
15407 @item +vfpv4-d16
15408 The VFPv4 floating-point instructions, with 16 double-precision
15409 registers.
15411 @item +vfpv4
15412 The VFPv4 floating-point instructions, with 32 double-precision
15413 registers.
15415 @item +neon
15416 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15417 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15419 @item +neon-fp16
15420 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15421 the half-precision floating-point conversion operations.
15423 @item +nosimd
15424 Disable the Advanced SIMD instructions (does not disable floating point).
15426 @item +nofp
15427 Disable the floating-point and Advanced SIMD instructions.
15428 @end table
15430 @item armv8-a
15431 @table @samp
15432 @item +crc
15433 The Cyclic Redundancy Check (CRC) instructions.
15434 @item +simd
15435 The ARMv8 Advanced SIMD and floating-point instructions.
15436 @item +crypto
15437 The cryptographic instructions.
15438 @item +nocrypto
15439 Disable the cryptographic isntructions.
15440 @item +nofp
15441 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15442 @end table
15444 @item armv8.1-a
15445 @table @samp
15446 @item +simd
15447 The ARMv8.1 Advanced SIMD and floating-point instructions.
15449 @item +crypto
15450 The cryptographic instructions.  This also enables the Advanced SIMD and
15451 floating-point instructions.
15453 @item +nocrypto
15454 Disable the cryptographic isntructions.
15456 @item +nofp
15457 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15458 @end table
15460 @item armv8.2-a
15461 @table @samp
15462 @item +fp16
15463 The half-precision floating-point data processing instructions.
15464 This also enables the Advanced SIMD and floating-point instructions.
15466 @item +simd
15467 The ARMv8.1 Advanced SIMD and floating-point instructions.
15469 @item +crypto
15470 The cryptographic instructions.  This also enables the Advanced SIMD and
15471 floating-point instructions.
15473 @item +nocrypto
15474 Disable the cryptographic extension.
15476 @item +nofp
15477 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15478 @end table
15480 @item armv7-r
15481 @table @samp
15482 @item +fp.sp
15483 The single-precision VFPv3 floating-point instructions.  The extension
15484 @samp{+vfpv3xd} can be used as an alias for this extension.
15486 @item +fp
15487 The VFPv3 floating-point instructions with 16 double-precision registers.
15488 The extension +vfpv3-d16 can be used as an alias for this extension.
15490 @item +nofp
15491 Disable the floating-point extension.
15493 @item +idiv
15494 The ARM-state integer division instructions.
15496 @item +noidiv
15497 Disable the ARM-state integer division extension.
15498 @end table
15500 @item armv7e-m
15501 @table @samp
15502 @item +fp
15503 The single-precision VFPv4 floating-point instructions.
15505 @item +fpv5
15506 The single-precision FPv5 floating-point instructions.
15508 @item +fp.dp
15509 The single- and double-precision FPv5 floating-point instructions.
15511 @item +nofp
15512 Disable the floating-point extensions.
15513 @end table
15515 @item  armv8-m.main
15516 @table @samp
15517 @item +dsp
15518 The DSP instructions.
15520 @item +nodsp
15521 Disable the DSP extension.
15523 @item +fp
15524 The single-precision floating-point instructions.
15526 @item +fp.dp
15527 The single- and double-precision floating-point instructions.
15529 @item +nofp
15530 Disable the floating-point extension.
15531 @end table
15533 @item armv8-r
15534 @table @samp
15535 @item +crc
15536 The Cyclic Redundancy Check (CRC) instructions.
15537 @item +fp.sp
15538 The single-precision FPv5 floating-point instructions.
15539 @item +simd
15540 The ARMv8 Advanced SIMD and floating-point instructions.
15541 @item +crypto
15542 The cryptographic instructions.
15543 @item +nocrypto
15544 Disable the cryptographic isntructions.
15545 @item +nofp
15546 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15547 @end table
15549 @end table
15551 @option{-march=native} causes the compiler to auto-detect the architecture
15552 of the build computer.  At present, this feature is only supported on
15553 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15554 is unsuccessful the option has no effect.
15556 @item -mtune=@var{name}
15557 @opindex mtune
15558 This option specifies the name of the target ARM processor for
15559 which GCC should tune the performance of the code.
15560 For some ARM implementations better performance can be obtained by using
15561 this option.
15562 Permissible names are: @samp{arm2}, @samp{arm250},
15563 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15564 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15565 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15566 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15567 @samp{arm720},
15568 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15569 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15570 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15571 @samp{strongarm1110},
15572 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15573 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15574 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15575 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15576 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15577 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15578 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15579 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15580 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15581 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15582 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15583 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15584 @samp{cortex-r8}, @samp{cortex-r52},
15585 @samp{cortex-m33},
15586 @samp{cortex-m23},
15587 @samp{cortex-m7},
15588 @samp{cortex-m4},
15589 @samp{cortex-m3},
15590 @samp{cortex-m1},
15591 @samp{cortex-m0},
15592 @samp{cortex-m0plus},
15593 @samp{cortex-m1.small-multiply},
15594 @samp{cortex-m0.small-multiply},
15595 @samp{cortex-m0plus.small-multiply},
15596 @samp{exynos-m1},
15597 @samp{marvell-pj4},
15598 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15599 @samp{fa526}, @samp{fa626},
15600 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15601 @samp{xgene1}.
15603 Additionally, this option can specify that GCC should tune the performance
15604 of the code for a big.LITTLE system.  Permissible names are:
15605 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15606 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15607 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15608 @samp{cortex-a75.cortex-a55}.
15610 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15611 performance for a blend of processors within architecture @var{arch}.
15612 The aim is to generate code that run well on the current most popular
15613 processors, balancing between optimizations that benefit some CPUs in the
15614 range, and avoiding performance pitfalls of other CPUs.  The effects of
15615 this option may change in future GCC versions as CPU models come and go.
15617 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15618 the extension options do not affect the tuning of the generated code.
15620 @option{-mtune=native} causes the compiler to auto-detect the CPU
15621 of the build computer.  At present, this feature is only supported on
15622 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15623 unsuccessful the option has no effect.
15625 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15626 @opindex mcpu
15627 This specifies the name of the target ARM processor.  GCC uses this name
15628 to derive the name of the target ARM architecture (as if specified
15629 by @option{-march}) and the ARM processor type for which to tune for
15630 performance (as if specified by @option{-mtune}).  Where this option
15631 is used in conjunction with @option{-march} or @option{-mtune},
15632 those options take precedence over the appropriate part of this option.
15634 Many of the supported CPUs implement optional architectural
15635 extensions.  Where this is so the architectural extensions are
15636 normally enabled by default.  If implementations that lack the
15637 extension exist, then the extension syntax can be used to disable
15638 those extensions that have been omitted.  For floating-point and
15639 Advanced SIMD (Neon) instructions, the settings of the options
15640 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15641 floating-point and Advanced SIMD instructions will only be used if
15642 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15643 @option{-mfpu} other than @samp{auto} will override the available
15644 floating-point and SIMD extension instructions.
15646 For example, @samp{cortex-a9} can be found in three major
15647 configurations: integer only, with just a floating-point unit or with
15648 floating-point and Advanced SIMD.  The default is to enable all the
15649 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15650 be used to disable just the SIMD or both the SIMD and floating-point
15651 instructions respectively.
15653 Permissible names for this option are the same as those for
15654 @option{-mtune}.
15656 The following extension options are common to the listed CPUs:
15658 @table @samp
15659 @item  +nofp
15660 Disables the floating-point instructions on @samp{arm9e},
15661 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15662 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15663 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15664 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15665 Disables the floating-point and SIMD instructions on
15666 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15667 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15668 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15669 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15670 @samp{cortex-a53} and @samp{cortex-a55}.
15672 @item +nofp.dp
15673 Disables the double-precision component of the floating-point instructions
15674 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15676 @item +nosimd
15677 Disables the SIMD (but not floating-point) instructions on
15678 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15679 and @samp{cortex-a9}.
15681 @item +crypto
15682 Enables the cryptographic instructions on @samp{cortex-a32},
15683 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15684 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15685 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15686 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15687 @samp{cortex-a75.cortex-a55}.
15688 @end table
15690 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15691 VFPv3 with 16 double-precision registers.  It supports the following
15692 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15693 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15694 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15695 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15696 @option{-march=armv7-a}.
15698 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15699 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15700 See @option{-mtune} for more information.
15702 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15703 of the build computer.  At present, this feature is only supported on
15704 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15705 is unsuccessful the option has no effect.
15707 @item -mfpu=@var{name}
15708 @opindex mfpu
15709 This specifies what floating-point hardware (or hardware emulation) is
15710 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15711 @samp{vfpv3},
15712 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15713 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15714 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15715 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15716 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15717 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15718 is an alias for @samp{vfpv2}.
15720 The setting @samp{auto} is the default and is special.  It causes the
15721 compiler to select the floating-point and Advanced SIMD instructions
15722 based on the settings of @option{-mcpu} and @option{-march}.
15724 If the selected floating-point hardware includes the NEON extension
15725 (e.g. @option{-mfpu=neon}), note that floating-point
15726 operations are not generated by GCC's auto-vectorization pass unless
15727 @option{-funsafe-math-optimizations} is also specified.  This is
15728 because NEON hardware does not fully implement the IEEE 754 standard for
15729 floating-point arithmetic (in particular denormal values are treated as
15730 zero), so the use of NEON instructions may lead to a loss of precision.
15732 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}).
15734 @item -mfp16-format=@var{name}
15735 @opindex mfp16-format
15736 Specify the format of the @code{__fp16} half-precision floating-point type.
15737 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15738 the default is @samp{none}, in which case the @code{__fp16} type is not
15739 defined.  @xref{Half-Precision}, for more information.
15741 @item -mstructure-size-boundary=@var{n}
15742 @opindex mstructure-size-boundary
15743 The sizes of all structures and unions are rounded up to a multiple
15744 of the number of bits set by this option.  Permissible values are 8, 32
15745 and 64.  The default value varies for different toolchains.  For the COFF
15746 targeted toolchain the default value is 8.  A value of 64 is only allowed
15747 if the underlying ABI supports it.
15749 Specifying a larger number can produce faster, more efficient code, but
15750 can also increase the size of the program.  Different values are potentially
15751 incompatible.  Code compiled with one value cannot necessarily expect to
15752 work with code or libraries compiled with another value, if they exchange
15753 information using structures or unions.
15755 This option is deprecated.
15757 @item -mabort-on-noreturn
15758 @opindex mabort-on-noreturn
15759 Generate a call to the function @code{abort} at the end of a
15760 @code{noreturn} function.  It is executed if the function tries to
15761 return.
15763 @item -mlong-calls
15764 @itemx -mno-long-calls
15765 @opindex mlong-calls
15766 @opindex mno-long-calls
15767 Tells the compiler to perform function calls by first loading the
15768 address of the function into a register and then performing a subroutine
15769 call on this register.  This switch is needed if the target function
15770 lies outside of the 64-megabyte addressing range of the offset-based
15771 version of subroutine call instruction.
15773 Even if this switch is enabled, not all function calls are turned
15774 into long calls.  The heuristic is that static functions, functions
15775 that have the @code{short_call} attribute, functions that are inside
15776 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15777 definitions have already been compiled within the current compilation
15778 unit are not turned into long calls.  The exceptions to this rule are
15779 that weak function definitions, functions with the @code{long_call}
15780 attribute or the @code{section} attribute, and functions that are within
15781 the scope of a @code{#pragma long_calls} directive are always
15782 turned into long calls.
15784 This feature is not enabled by default.  Specifying
15785 @option{-mno-long-calls} restores the default behavior, as does
15786 placing the function calls within the scope of a @code{#pragma
15787 long_calls_off} directive.  Note these switches have no effect on how
15788 the compiler generates code to handle function calls via function
15789 pointers.
15791 @item -msingle-pic-base
15792 @opindex msingle-pic-base
15793 Treat the register used for PIC addressing as read-only, rather than
15794 loading it in the prologue for each function.  The runtime system is
15795 responsible for initializing this register with an appropriate value
15796 before execution begins.
15798 @item -mpic-register=@var{reg}
15799 @opindex mpic-register
15800 Specify the register to be used for PIC addressing.
15801 For standard PIC base case, the default is any suitable register
15802 determined by compiler.  For single PIC base case, the default is
15803 @samp{R9} if target is EABI based or stack-checking is enabled,
15804 otherwise the default is @samp{R10}.
15806 @item -mpic-data-is-text-relative
15807 @opindex mpic-data-is-text-relative
15808 Assume that the displacement between the text and data segments is fixed
15809 at static link time.  This permits using PC-relative addressing
15810 operations to access data known to be in the data segment.  For
15811 non-VxWorks RTP targets, this option is enabled by default.  When
15812 disabled on such targets, it will enable @option{-msingle-pic-base} by
15813 default.
15815 @item -mpoke-function-name
15816 @opindex mpoke-function-name
15817 Write the name of each function into the text section, directly
15818 preceding the function prologue.  The generated code is similar to this:
15820 @smallexample
15821      t0
15822          .ascii "arm_poke_function_name", 0
15823          .align
15824      t1
15825          .word 0xff000000 + (t1 - t0)
15826      arm_poke_function_name
15827          mov     ip, sp
15828          stmfd   sp!, @{fp, ip, lr, pc@}
15829          sub     fp, ip, #4
15830 @end smallexample
15832 When performing a stack backtrace, code can inspect the value of
15833 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15834 location @code{pc - 12} and the top 8 bits are set, then we know that
15835 there is a function name embedded immediately preceding this location
15836 and has length @code{((pc[-3]) & 0xff000000)}.
15838 @item -mthumb
15839 @itemx -marm
15840 @opindex marm
15841 @opindex mthumb
15843 Select between generating code that executes in ARM and Thumb
15844 states.  The default for most configurations is to generate code
15845 that executes in ARM state, but the default can be changed by
15846 configuring GCC with the @option{--with-mode=}@var{state}
15847 configure option.
15849 You can also override the ARM and Thumb mode for each function
15850 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15851 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15853 @item -mtpcs-frame
15854 @opindex mtpcs-frame
15855 Generate a stack frame that is compliant with the Thumb Procedure Call
15856 Standard for all non-leaf functions.  (A leaf function is one that does
15857 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15859 @item -mtpcs-leaf-frame
15860 @opindex mtpcs-leaf-frame
15861 Generate a stack frame that is compliant with the Thumb Procedure Call
15862 Standard for all leaf functions.  (A leaf function is one that does
15863 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15865 @item -mcallee-super-interworking
15866 @opindex mcallee-super-interworking
15867 Gives all externally visible functions in the file being compiled an ARM
15868 instruction set header which switches to Thumb mode before executing the
15869 rest of the function.  This allows these functions to be called from
15870 non-interworking code.  This option is not valid in AAPCS configurations
15871 because interworking is enabled by default.
15873 @item -mcaller-super-interworking
15874 @opindex mcaller-super-interworking
15875 Allows calls via function pointers (including virtual functions) to
15876 execute correctly regardless of whether the target code has been
15877 compiled for interworking or not.  There is a small overhead in the cost
15878 of executing a function pointer if this option is enabled.  This option
15879 is not valid in AAPCS configurations because interworking is enabled
15880 by default.
15882 @item -mtp=@var{name}
15883 @opindex mtp
15884 Specify the access model for the thread local storage pointer.  The valid
15885 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15886 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15887 (supported in the arm6k architecture), and @samp{auto}, which uses the
15888 best available method for the selected processor.  The default setting is
15889 @samp{auto}.
15891 @item -mtls-dialect=@var{dialect}
15892 @opindex mtls-dialect
15893 Specify the dialect to use for accessing thread local storage.  Two
15894 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15895 @samp{gnu} dialect selects the original GNU scheme for supporting
15896 local and global dynamic TLS models.  The @samp{gnu2} dialect
15897 selects the GNU descriptor scheme, which provides better performance
15898 for shared libraries.  The GNU descriptor scheme is compatible with
15899 the original scheme, but does require new assembler, linker and
15900 library support.  Initial and local exec TLS models are unaffected by
15901 this option and always use the original scheme.
15903 @item -mword-relocations
15904 @opindex mword-relocations
15905 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15906 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15907 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15908 is specified.
15910 @item -mfix-cortex-m3-ldrd
15911 @opindex mfix-cortex-m3-ldrd
15912 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15913 with overlapping destination and base registers are used.  This option avoids
15914 generating these instructions.  This option is enabled by default when
15915 @option{-mcpu=cortex-m3} is specified.
15917 @item -munaligned-access
15918 @itemx -mno-unaligned-access
15919 @opindex munaligned-access
15920 @opindex mno-unaligned-access
15921 Enables (or disables) reading and writing of 16- and 32- bit values
15922 from addresses that are not 16- or 32- bit aligned.  By default
15923 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15924 ARMv8-M Baseline architectures, and enabled for all other
15925 architectures.  If unaligned access is not enabled then words in packed
15926 data structures are accessed a byte at a time.
15928 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15929 generated object file to either true or false, depending upon the
15930 setting of this option.  If unaligned access is enabled then the
15931 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15932 defined.
15934 @item -mneon-for-64bits
15935 @opindex mneon-for-64bits
15936 Enables using Neon to handle scalar 64-bits operations. This is
15937 disabled by default since the cost of moving data from core registers
15938 to Neon is high.
15940 @item -mslow-flash-data
15941 @opindex mslow-flash-data
15942 Assume loading data from flash is slower than fetching instruction.
15943 Therefore literal load is minimized for better performance.
15944 This option is only supported when compiling for ARMv7 M-profile and
15945 off by default.
15947 @item -masm-syntax-unified
15948 @opindex masm-syntax-unified
15949 Assume inline assembler is using unified asm syntax.  The default is
15950 currently off which implies divided syntax.  This option has no impact
15951 on Thumb2. However, this may change in future releases of GCC.
15952 Divided syntax should be considered deprecated.
15954 @item -mrestrict-it
15955 @opindex mrestrict-it
15956 Restricts generation of IT blocks to conform to the rules of ARMv8.
15957 IT blocks can only contain a single 16-bit instruction from a select
15958 set of instructions. This option is on by default for ARMv8 Thumb mode.
15960 @item -mprint-tune-info
15961 @opindex mprint-tune-info
15962 Print CPU tuning information as comment in assembler file.  This is
15963 an option used only for regression testing of the compiler and not
15964 intended for ordinary use in compiling code.  This option is disabled
15965 by default.
15967 @item -mpure-code
15968 @opindex mpure-code
15969 Do not allow constant data to be placed in code sections.
15970 Additionally, when compiling for ELF object format give all text sections the
15971 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15972 is only available when generating non-pic code for M-profile targets with the
15973 MOVT instruction.
15975 @item -mcmse
15976 @opindex mcmse
15977 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15978 Development Tools Engineering Specification", which can be found on
15979 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15980 @end table
15982 @node AVR Options
15983 @subsection AVR Options
15984 @cindex AVR Options
15986 These options are defined for AVR implementations:
15988 @table @gcctabopt
15989 @item -mmcu=@var{mcu}
15990 @opindex mmcu
15991 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15993 The default for this option is@tie{}@samp{avr2}.
15995 GCC supports the following AVR devices and ISAs:
15997 @include avr-mmcu.texi
15999 @item -mabsdata
16000 @opindex mabsdata
16002 Assume that all data in static storage can be accessed by LDS / STS
16003 instructions.  This option has only an effect on reduced Tiny devices like
16004 ATtiny40.  See also the @code{absdata}
16005 @ref{AVR Variable Attributes,variable attribute}.
16007 @item -maccumulate-args
16008 @opindex maccumulate-args
16009 Accumulate outgoing function arguments and acquire/release the needed
16010 stack space for outgoing function arguments once in function
16011 prologue/epilogue.  Without this option, outgoing arguments are pushed
16012 before calling a function and popped afterwards.
16014 Popping the arguments after the function call can be expensive on
16015 AVR so that accumulating the stack space might lead to smaller
16016 executables because arguments need not be removed from the
16017 stack after such a function call.
16019 This option can lead to reduced code size for functions that perform
16020 several calls to functions that get their arguments on the stack like
16021 calls to printf-like functions.
16023 @item -mbranch-cost=@var{cost}
16024 @opindex mbranch-cost
16025 Set the branch costs for conditional branch instructions to
16026 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16027 integers. The default branch cost is 0.
16029 @item -mcall-prologues
16030 @opindex mcall-prologues
16031 Functions prologues/epilogues are expanded as calls to appropriate
16032 subroutines.  Code size is smaller.
16034 @item -mgas-isr-prologues
16035 @opindex mgas-isr-prologues
16036 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16037 instruction supported by GNU Binutils.
16038 If this option is on, the feature can still be disabled for individual
16039 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16040 function attribute.  This feature is activated per default
16041 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16042 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16044 @item -mint8
16045 @opindex mint8
16046 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16047 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16048 and @code{long long} is 4 bytes.  Please note that this option does not
16049 conform to the C standards, but it results in smaller code
16050 size.
16052 @item -mn-flash=@var{num}
16053 @opindex mn-flash
16054 Assume that the flash memory has a size of 
16055 @var{num} times 64@tie{}KiB.
16057 @item -mno-interrupts
16058 @opindex mno-interrupts
16059 Generated code is not compatible with hardware interrupts.
16060 Code size is smaller.
16062 @item -mrelax
16063 @opindex mrelax
16064 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16065 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16066 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16067 the assembler's command line and the @option{--relax} option to the
16068 linker's command line.
16070 Jump relaxing is performed by the linker because jump offsets are not
16071 known before code is located. Therefore, the assembler code generated by the
16072 compiler is the same, but the instructions in the executable may
16073 differ from instructions in the assembler code.
16075 Relaxing must be turned on if linker stubs are needed, see the
16076 section on @code{EIND} and linker stubs below.
16078 @item -mrmw
16079 @opindex mrmw
16080 Assume that the device supports the Read-Modify-Write
16081 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16083 @item -mshort-calls
16084 @opindex mshort-calls
16086 Assume that @code{RJMP} and @code{RCALL} can target the whole
16087 program memory.
16089 This option is used internally for multilib selection.  It is
16090 not an optimization option, and you don't need to set it by hand.
16092 @item -msp8
16093 @opindex msp8
16094 Treat the stack pointer register as an 8-bit register,
16095 i.e.@: assume the high byte of the stack pointer is zero.
16096 In general, you don't need to set this option by hand.
16098 This option is used internally by the compiler to select and
16099 build multilibs for architectures @code{avr2} and @code{avr25}.
16100 These architectures mix devices with and without @code{SPH}.
16101 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16102 the compiler driver adds or removes this option from the compiler
16103 proper's command line, because the compiler then knows if the device
16104 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16105 register or not.
16107 @item -mstrict-X
16108 @opindex mstrict-X
16109 Use address register @code{X} in a way proposed by the hardware.  This means
16110 that @code{X} is only used in indirect, post-increment or
16111 pre-decrement addressing.
16113 Without this option, the @code{X} register may be used in the same way
16114 as @code{Y} or @code{Z} which then is emulated by additional
16115 instructions.  
16116 For example, loading a value with @code{X+const} addressing with a
16117 small non-negative @code{const < 64} to a register @var{Rn} is
16118 performed as
16120 @example
16121 adiw r26, const   ; X += const
16122 ld   @var{Rn}, X        ; @var{Rn} = *X
16123 sbiw r26, const   ; X -= const
16124 @end example
16126 @item -mtiny-stack
16127 @opindex mtiny-stack
16128 Only change the lower 8@tie{}bits of the stack pointer.
16130 @item -mfract-convert-truncate
16131 @opindex mfract-convert-truncate
16132 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16134 @item -nodevicelib
16135 @opindex nodevicelib
16136 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16138 @item -Waddr-space-convert
16139 @opindex Waddr-space-convert
16140 Warn about conversions between address spaces in the case where the
16141 resulting address space is not contained in the incoming address space.
16143 @item -Wmisspelled-isr
16144 @opindex Wmisspelled-isr
16145 Warn if the ISR is misspelled, i.e. without __vector prefix.
16146 Enabled by default.
16147 @end table
16149 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16150 @cindex @code{EIND}
16151 Pointers in the implementation are 16@tie{}bits wide.
16152 The address of a function or label is represented as word address so
16153 that indirect jumps and calls can target any code address in the
16154 range of 64@tie{}Ki words.
16156 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16157 bytes of program memory space, there is a special function register called
16158 @code{EIND} that serves as most significant part of the target address
16159 when @code{EICALL} or @code{EIJMP} instructions are used.
16161 Indirect jumps and calls on these devices are handled as follows by
16162 the compiler and are subject to some limitations:
16164 @itemize @bullet
16166 @item
16167 The compiler never sets @code{EIND}.
16169 @item
16170 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16171 instructions or might read @code{EIND} directly in order to emulate an
16172 indirect call/jump by means of a @code{RET} instruction.
16174 @item
16175 The compiler assumes that @code{EIND} never changes during the startup
16176 code or during the application. In particular, @code{EIND} is not
16177 saved/restored in function or interrupt service routine
16178 prologue/epilogue.
16180 @item
16181 For indirect calls to functions and computed goto, the linker
16182 generates @emph{stubs}. Stubs are jump pads sometimes also called
16183 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16184 The stub contains a direct jump to the desired address.
16186 @item
16187 Linker relaxation must be turned on so that the linker generates
16188 the stubs correctly in all situations. See the compiler option
16189 @option{-mrelax} and the linker option @option{--relax}.
16190 There are corner cases where the linker is supposed to generate stubs
16191 but aborts without relaxation and without a helpful error message.
16193 @item
16194 The default linker script is arranged for code with @code{EIND = 0}.
16195 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16196 linker script has to be used in order to place the sections whose
16197 name start with @code{.trampolines} into the segment where @code{EIND}
16198 points to.
16200 @item
16201 The startup code from libgcc never sets @code{EIND}.
16202 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16203 For the impact of AVR-LibC on @code{EIND}, see the
16204 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16206 @item
16207 It is legitimate for user-specific startup code to set up @code{EIND}
16208 early, for example by means of initialization code located in
16209 section @code{.init3}. Such code runs prior to general startup code
16210 that initializes RAM and calls constructors, but after the bit
16211 of startup code from AVR-LibC that sets @code{EIND} to the segment
16212 where the vector table is located.
16213 @example
16214 #include <avr/io.h>
16216 static void
16217 __attribute__((section(".init3"),naked,used,no_instrument_function))
16218 init3_set_eind (void)
16220   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16221                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16223 @end example
16225 @noindent
16226 The @code{__trampolines_start} symbol is defined in the linker script.
16228 @item
16229 Stubs are generated automatically by the linker if
16230 the following two conditions are met:
16231 @itemize @minus
16233 @item The address of a label is taken by means of the @code{gs} modifier
16234 (short for @emph{generate stubs}) like so:
16235 @example
16236 LDI r24, lo8(gs(@var{func}))
16237 LDI r25, hi8(gs(@var{func}))
16238 @end example
16239 @item The final location of that label is in a code segment
16240 @emph{outside} the segment where the stubs are located.
16241 @end itemize
16243 @item
16244 The compiler emits such @code{gs} modifiers for code labels in the
16245 following situations:
16246 @itemize @minus
16247 @item Taking address of a function or code label.
16248 @item Computed goto.
16249 @item If prologue-save function is used, see @option{-mcall-prologues}
16250 command-line option.
16251 @item Switch/case dispatch tables. If you do not want such dispatch
16252 tables you can specify the @option{-fno-jump-tables} command-line option.
16253 @item C and C++ constructors/destructors called during startup/shutdown.
16254 @item If the tools hit a @code{gs()} modifier explained above.
16255 @end itemize
16257 @item
16258 Jumping to non-symbolic addresses like so is @emph{not} supported:
16260 @example
16261 int main (void)
16263     /* Call function at word address 0x2 */
16264     return ((int(*)(void)) 0x2)();
16266 @end example
16268 Instead, a stub has to be set up, i.e.@: the function has to be called
16269 through a symbol (@code{func_4} in the example):
16271 @example
16272 int main (void)
16274     extern int func_4 (void);
16276     /* Call function at byte address 0x4 */
16277     return func_4();
16279 @end example
16281 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16282 Alternatively, @code{func_4} can be defined in the linker script.
16283 @end itemize
16285 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16286 @cindex @code{RAMPD}
16287 @cindex @code{RAMPX}
16288 @cindex @code{RAMPY}
16289 @cindex @code{RAMPZ}
16290 Some AVR devices support memories larger than the 64@tie{}KiB range
16291 that can be accessed with 16-bit pointers.  To access memory locations
16292 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16293 register is used as high part of the address:
16294 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16295 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16296 register, respectively, to get a wide address. Similarly,
16297 @code{RAMPD} is used together with direct addressing.
16299 @itemize
16300 @item
16301 The startup code initializes the @code{RAMP} special function
16302 registers with zero.
16304 @item
16305 If a @ref{AVR Named Address Spaces,named address space} other than
16306 generic or @code{__flash} is used, then @code{RAMPZ} is set
16307 as needed before the operation.
16309 @item
16310 If the device supports RAM larger than 64@tie{}KiB and the compiler
16311 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16312 is reset to zero after the operation.
16314 @item
16315 If the device comes with a specific @code{RAMP} register, the ISR
16316 prologue/epilogue saves/restores that SFR and initializes it with
16317 zero in case the ISR code might (implicitly) use it.
16319 @item
16320 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16321 If you use inline assembler to read from locations outside the
16322 16-bit address range and change one of the @code{RAMP} registers,
16323 you must reset it to zero after the access.
16325 @end itemize
16327 @subsubsection AVR Built-in Macros
16329 GCC defines several built-in macros so that the user code can test
16330 for the presence or absence of features.  Almost any of the following
16331 built-in macros are deduced from device capabilities and thus
16332 triggered by the @option{-mmcu=} command-line option.
16334 For even more AVR-specific built-in macros see
16335 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16337 @table @code
16339 @item __AVR_ARCH__
16340 Build-in macro that resolves to a decimal number that identifies the
16341 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16342 Possible values are:
16344 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16345 @code{4}, @code{5}, @code{51}, @code{6}
16347 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16348 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16350 respectively and
16352 @code{100},
16353 @code{102}, @code{103}, @code{104},
16354 @code{105}, @code{106}, @code{107}
16356 for @var{mcu}=@code{avrtiny},
16357 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16358 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16359 If @var{mcu} specifies a device, this built-in macro is set
16360 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16361 defined to @code{4}.
16363 @item __AVR_@var{Device}__
16364 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16365 the device's name. For example, @option{-mmcu=atmega8} defines the
16366 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16367 @code{__AVR_ATtiny261A__}, etc.
16369 The built-in macros' names follow
16370 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16371 the device name as from the AVR user manual. The difference between
16372 @var{Device} in the built-in macro and @var{device} in
16373 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16375 If @var{device} is not a device but only a core architecture like
16376 @samp{avr51}, this macro is not defined.
16378 @item __AVR_DEVICE_NAME__
16379 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16380 the device's name. For example, with @option{-mmcu=atmega8} the macro
16381 is defined to @code{atmega8}.
16383 If @var{device} is not a device but only a core architecture like
16384 @samp{avr51}, this macro is not defined.
16386 @item __AVR_XMEGA__
16387 The device / architecture belongs to the XMEGA family of devices.
16389 @item __AVR_HAVE_ELPM__
16390 The device has the @code{ELPM} instruction.
16392 @item __AVR_HAVE_ELPMX__
16393 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16394 R@var{n},Z+} instructions.
16396 @item __AVR_HAVE_MOVW__
16397 The device has the @code{MOVW} instruction to perform 16-bit
16398 register-register moves.
16400 @item __AVR_HAVE_LPMX__
16401 The device has the @code{LPM R@var{n},Z} and
16402 @code{LPM R@var{n},Z+} instructions.
16404 @item __AVR_HAVE_MUL__
16405 The device has a hardware multiplier. 
16407 @item __AVR_HAVE_JMP_CALL__
16408 The device has the @code{JMP} and @code{CALL} instructions.
16409 This is the case for devices with more than 8@tie{}KiB of program
16410 memory.
16412 @item __AVR_HAVE_EIJMP_EICALL__
16413 @itemx __AVR_3_BYTE_PC__
16414 The device has the @code{EIJMP} and @code{EICALL} instructions.
16415 This is the case for devices with more than 128@tie{}KiB of program memory.
16416 This also means that the program counter
16417 (PC) is 3@tie{}bytes wide.
16419 @item __AVR_2_BYTE_PC__
16420 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16421 with up to 128@tie{}KiB of program memory.
16423 @item __AVR_HAVE_8BIT_SP__
16424 @itemx __AVR_HAVE_16BIT_SP__
16425 The stack pointer (SP) register is treated as 8-bit respectively
16426 16-bit register by the compiler.
16427 The definition of these macros is affected by @option{-mtiny-stack}.
16429 @item __AVR_HAVE_SPH__
16430 @itemx __AVR_SP8__
16431 The device has the SPH (high part of stack pointer) special function
16432 register or has an 8-bit stack pointer, respectively.
16433 The definition of these macros is affected by @option{-mmcu=} and
16434 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16435 by @option{-msp8}.
16437 @item __AVR_HAVE_RAMPD__
16438 @itemx __AVR_HAVE_RAMPX__
16439 @itemx __AVR_HAVE_RAMPY__
16440 @itemx __AVR_HAVE_RAMPZ__
16441 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16442 @code{RAMPZ} special function register, respectively.
16444 @item __NO_INTERRUPTS__
16445 This macro reflects the @option{-mno-interrupts} command-line option.
16447 @item __AVR_ERRATA_SKIP__
16448 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16449 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16450 instructions because of a hardware erratum.  Skip instructions are
16451 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16452 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16453 set.
16455 @item __AVR_ISA_RMW__
16456 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16458 @item __AVR_SFR_OFFSET__=@var{offset}
16459 Instructions that can address I/O special function registers directly
16460 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16461 address as if addressed by an instruction to access RAM like @code{LD}
16462 or @code{STS}. This offset depends on the device architecture and has
16463 to be subtracted from the RAM address in order to get the
16464 respective I/O@tie{}address.
16466 @item __AVR_SHORT_CALLS__
16467 The @option{-mshort-calls} command line option is set.
16469 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16470 Some devices support reading from flash memory by means of @code{LD*}
16471 instructions.  The flash memory is seen in the data address space
16472 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16473 is not defined, this feature is not available.  If defined,
16474 the address space is linear and there is no need to put
16475 @code{.rodata} into RAM.  This is handled by the default linker
16476 description file, and is currently available for
16477 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16478 there is no need to use address spaces like @code{__flash} or
16479 features like attribute @code{progmem} and @code{pgm_read_*}.
16481 @item __WITH_AVRLIBC__
16482 The compiler is configured to be used together with AVR-Libc.
16483 See the @option{--with-avrlibc} configure option.
16485 @end table
16487 @node Blackfin Options
16488 @subsection Blackfin Options
16489 @cindex Blackfin Options
16491 @table @gcctabopt
16492 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16493 @opindex mcpu=
16494 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16495 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16496 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16497 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16498 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16499 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16500 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16501 @samp{bf561}, @samp{bf592}.
16503 The optional @var{sirevision} specifies the silicon revision of the target
16504 Blackfin processor.  Any workarounds available for the targeted silicon revision
16505 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16506 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16507 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16508 hexadecimal digits representing the major and minor numbers in the silicon
16509 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16510 is not defined.  If @var{sirevision} is @samp{any}, the
16511 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16512 If this optional @var{sirevision} is not used, GCC assumes the latest known
16513 silicon revision of the targeted Blackfin processor.
16515 GCC defines a preprocessor macro for the specified @var{cpu}.
16516 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16517 provided by libgloss to be linked in if @option{-msim} is not given.
16519 Without this option, @samp{bf532} is used as the processor by default.
16521 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16522 only the preprocessor macro is defined.
16524 @item -msim
16525 @opindex msim
16526 Specifies that the program will be run on the simulator.  This causes
16527 the simulator BSP provided by libgloss to be linked in.  This option
16528 has effect only for @samp{bfin-elf} toolchain.
16529 Certain other options, such as @option{-mid-shared-library} and
16530 @option{-mfdpic}, imply @option{-msim}.
16532 @item -momit-leaf-frame-pointer
16533 @opindex momit-leaf-frame-pointer
16534 Don't keep the frame pointer in a register for leaf functions.  This
16535 avoids the instructions to save, set up and restore frame pointers and
16536 makes an extra register available in leaf functions.  The option
16537 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16538 which might make debugging harder.
16540 @item -mspecld-anomaly
16541 @opindex mspecld-anomaly
16542 When enabled, the compiler ensures that the generated code does not
16543 contain speculative loads after jump instructions. If this option is used,
16544 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16546 @item -mno-specld-anomaly
16547 @opindex mno-specld-anomaly
16548 Don't generate extra code to prevent speculative loads from occurring.
16550 @item -mcsync-anomaly
16551 @opindex mcsync-anomaly
16552 When enabled, the compiler ensures that the generated code does not
16553 contain CSYNC or SSYNC instructions too soon after conditional branches.
16554 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16556 @item -mno-csync-anomaly
16557 @opindex mno-csync-anomaly
16558 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16559 occurring too soon after a conditional branch.
16561 @item -mlow-64k
16562 @opindex mlow-64k
16563 When enabled, the compiler is free to take advantage of the knowledge that
16564 the entire program fits into the low 64k of memory.
16566 @item -mno-low-64k
16567 @opindex mno-low-64k
16568 Assume that the program is arbitrarily large.  This is the default.
16570 @item -mstack-check-l1
16571 @opindex mstack-check-l1
16572 Do stack checking using information placed into L1 scratchpad memory by the
16573 uClinux kernel.
16575 @item -mid-shared-library
16576 @opindex mid-shared-library
16577 Generate code that supports shared libraries via the library ID method.
16578 This allows for execute in place and shared libraries in an environment
16579 without virtual memory management.  This option implies @option{-fPIC}.
16580 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16582 @item -mno-id-shared-library
16583 @opindex mno-id-shared-library
16584 Generate code that doesn't assume ID-based shared libraries are being used.
16585 This is the default.
16587 @item -mleaf-id-shared-library
16588 @opindex mleaf-id-shared-library
16589 Generate code that supports shared libraries via the library ID method,
16590 but assumes that this library or executable won't link against any other
16591 ID shared libraries.  That allows the compiler to use faster code for jumps
16592 and calls.
16594 @item -mno-leaf-id-shared-library
16595 @opindex mno-leaf-id-shared-library
16596 Do not assume that the code being compiled won't link against any ID shared
16597 libraries.  Slower code is generated for jump and call insns.
16599 @item -mshared-library-id=n
16600 @opindex mshared-library-id
16601 Specifies the identification number of the ID-based shared library being
16602 compiled.  Specifying a value of 0 generates more compact code; specifying
16603 other values forces the allocation of that number to the current
16604 library but is no more space- or time-efficient than omitting this option.
16606 @item -msep-data
16607 @opindex msep-data
16608 Generate code that allows the data segment to be located in a different
16609 area of memory from the text segment.  This allows for execute in place in
16610 an environment without virtual memory management by eliminating relocations
16611 against the text section.
16613 @item -mno-sep-data
16614 @opindex mno-sep-data
16615 Generate code that assumes that the data segment follows the text segment.
16616 This is the default.
16618 @item -mlong-calls
16619 @itemx -mno-long-calls
16620 @opindex mlong-calls
16621 @opindex mno-long-calls
16622 Tells the compiler to perform function calls by first loading the
16623 address of the function into a register and then performing a subroutine
16624 call on this register.  This switch is needed if the target function
16625 lies outside of the 24-bit addressing range of the offset-based
16626 version of subroutine call instruction.
16628 This feature is not enabled by default.  Specifying
16629 @option{-mno-long-calls} restores the default behavior.  Note these
16630 switches have no effect on how the compiler generates code to handle
16631 function calls via function pointers.
16633 @item -mfast-fp
16634 @opindex mfast-fp
16635 Link with the fast floating-point library. This library relaxes some of
16636 the IEEE floating-point standard's rules for checking inputs against
16637 Not-a-Number (NAN), in the interest of performance.
16639 @item -minline-plt
16640 @opindex minline-plt
16641 Enable inlining of PLT entries in function calls to functions that are
16642 not known to bind locally.  It has no effect without @option{-mfdpic}.
16644 @item -mmulticore
16645 @opindex mmulticore
16646 Build a standalone application for multicore Blackfin processors. 
16647 This option causes proper start files and link scripts supporting 
16648 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16649 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16651 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16652 selects the one-application-per-core programming model.  Without
16653 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16654 programming model is used. In this model, the main function of Core B
16655 should be named as @code{coreb_main}.
16657 If this option is not used, the single-core application programming
16658 model is used.
16660 @item -mcorea
16661 @opindex mcorea
16662 Build a standalone application for Core A of BF561 when using
16663 the one-application-per-core programming model. Proper start files
16664 and link scripts are used to support Core A, and the macro
16665 @code{__BFIN_COREA} is defined.
16666 This option can only be used in conjunction with @option{-mmulticore}.
16668 @item -mcoreb
16669 @opindex mcoreb
16670 Build a standalone application for Core B of BF561 when using
16671 the one-application-per-core programming model. Proper start files
16672 and link scripts are used to support Core B, and the macro
16673 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16674 should be used instead of @code{main}. 
16675 This option can only be used in conjunction with @option{-mmulticore}.
16677 @item -msdram
16678 @opindex msdram
16679 Build a standalone application for SDRAM. Proper start files and
16680 link scripts are used to put the application into SDRAM, and the macro
16681 @code{__BFIN_SDRAM} is defined.
16682 The loader should initialize SDRAM before loading the application.
16684 @item -micplb
16685 @opindex micplb
16686 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16687 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16688 are enabled; for standalone applications the default is off.
16689 @end table
16691 @node C6X Options
16692 @subsection C6X Options
16693 @cindex C6X Options
16695 @table @gcctabopt
16696 @item -march=@var{name}
16697 @opindex march
16698 This specifies the name of the target architecture.  GCC uses this
16699 name to determine what kind of instructions it can emit when generating
16700 assembly code.  Permissible names are: @samp{c62x},
16701 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16703 @item -mbig-endian
16704 @opindex mbig-endian
16705 Generate code for a big-endian target.
16707 @item -mlittle-endian
16708 @opindex mlittle-endian
16709 Generate code for a little-endian target.  This is the default.
16711 @item -msim
16712 @opindex msim
16713 Choose startup files and linker script suitable for the simulator.
16715 @item -msdata=default
16716 @opindex msdata=default
16717 Put small global and static data in the @code{.neardata} section,
16718 which is pointed to by register @code{B14}.  Put small uninitialized
16719 global and static data in the @code{.bss} section, which is adjacent
16720 to the @code{.neardata} section.  Put small read-only data into the
16721 @code{.rodata} section.  The corresponding sections used for large
16722 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16724 @item -msdata=all
16725 @opindex msdata=all
16726 Put all data, not just small objects, into the sections reserved for
16727 small data, and use addressing relative to the @code{B14} register to
16728 access them.
16730 @item -msdata=none
16731 @opindex msdata=none
16732 Make no use of the sections reserved for small data, and use absolute
16733 addresses to access all data.  Put all initialized global and static
16734 data in the @code{.fardata} section, and all uninitialized data in the
16735 @code{.far} section.  Put all constant data into the @code{.const}
16736 section.
16737 @end table
16739 @node CRIS Options
16740 @subsection CRIS Options
16741 @cindex CRIS Options
16743 These options are defined specifically for the CRIS ports.
16745 @table @gcctabopt
16746 @item -march=@var{architecture-type}
16747 @itemx -mcpu=@var{architecture-type}
16748 @opindex march
16749 @opindex mcpu
16750 Generate code for the specified architecture.  The choices for
16751 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16752 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16753 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16754 @samp{v10}.
16756 @item -mtune=@var{architecture-type}
16757 @opindex mtune
16758 Tune to @var{architecture-type} everything applicable about the generated
16759 code, except for the ABI and the set of available instructions.  The
16760 choices for @var{architecture-type} are the same as for
16761 @option{-march=@var{architecture-type}}.
16763 @item -mmax-stack-frame=@var{n}
16764 @opindex mmax-stack-frame
16765 Warn when the stack frame of a function exceeds @var{n} bytes.
16767 @item -metrax4
16768 @itemx -metrax100
16769 @opindex metrax4
16770 @opindex metrax100
16771 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16772 @option{-march=v3} and @option{-march=v8} respectively.
16774 @item -mmul-bug-workaround
16775 @itemx -mno-mul-bug-workaround
16776 @opindex mmul-bug-workaround
16777 @opindex mno-mul-bug-workaround
16778 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16779 models where it applies.  This option is active by default.
16781 @item -mpdebug
16782 @opindex mpdebug
16783 Enable CRIS-specific verbose debug-related information in the assembly
16784 code.  This option also has the effect of turning off the @samp{#NO_APP}
16785 formatted-code indicator to the assembler at the beginning of the
16786 assembly file.
16788 @item -mcc-init
16789 @opindex mcc-init
16790 Do not use condition-code results from previous instruction; always emit
16791 compare and test instructions before use of condition codes.
16793 @item -mno-side-effects
16794 @opindex mno-side-effects
16795 Do not emit instructions with side effects in addressing modes other than
16796 post-increment.
16798 @item -mstack-align
16799 @itemx -mno-stack-align
16800 @itemx -mdata-align
16801 @itemx -mno-data-align
16802 @itemx -mconst-align
16803 @itemx -mno-const-align
16804 @opindex mstack-align
16805 @opindex mno-stack-align
16806 @opindex mdata-align
16807 @opindex mno-data-align
16808 @opindex mconst-align
16809 @opindex mno-const-align
16810 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16811 stack frame, individual data and constants to be aligned for the maximum
16812 single data access size for the chosen CPU model.  The default is to
16813 arrange for 32-bit alignment.  ABI details such as structure layout are
16814 not affected by these options.
16816 @item -m32-bit
16817 @itemx -m16-bit
16818 @itemx -m8-bit
16819 @opindex m32-bit
16820 @opindex m16-bit
16821 @opindex m8-bit
16822 Similar to the stack- data- and const-align options above, these options
16823 arrange for stack frame, writable data and constants to all be 32-bit,
16824 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16826 @item -mno-prologue-epilogue
16827 @itemx -mprologue-epilogue
16828 @opindex mno-prologue-epilogue
16829 @opindex mprologue-epilogue
16830 With @option{-mno-prologue-epilogue}, the normal function prologue and
16831 epilogue which set up the stack frame are omitted and no return
16832 instructions or return sequences are generated in the code.  Use this
16833 option only together with visual inspection of the compiled code: no
16834 warnings or errors are generated when call-saved registers must be saved,
16835 or storage for local variables needs to be allocated.
16837 @item -mno-gotplt
16838 @itemx -mgotplt
16839 @opindex mno-gotplt
16840 @opindex mgotplt
16841 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16842 instruction sequences that load addresses for functions from the PLT part
16843 of the GOT rather than (traditional on other architectures) calls to the
16844 PLT@.  The default is @option{-mgotplt}.
16846 @item -melf
16847 @opindex melf
16848 Legacy no-op option only recognized with the cris-axis-elf and
16849 cris-axis-linux-gnu targets.
16851 @item -mlinux
16852 @opindex mlinux
16853 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16855 @item -sim
16856 @opindex sim
16857 This option, recognized for the cris-axis-elf, arranges
16858 to link with input-output functions from a simulator library.  Code,
16859 initialized data and zero-initialized data are allocated consecutively.
16861 @item -sim2
16862 @opindex sim2
16863 Like @option{-sim}, but pass linker options to locate initialized data at
16864 0x40000000 and zero-initialized data at 0x80000000.
16865 @end table
16867 @node CR16 Options
16868 @subsection CR16 Options
16869 @cindex CR16 Options
16871 These options are defined specifically for the CR16 ports.
16873 @table @gcctabopt
16875 @item -mmac
16876 @opindex mmac
16877 Enable the use of multiply-accumulate instructions. Disabled by default.
16879 @item -mcr16cplus
16880 @itemx -mcr16c
16881 @opindex mcr16cplus
16882 @opindex mcr16c
16883 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16884 is default.
16886 @item -msim
16887 @opindex msim
16888 Links the library libsim.a which is in compatible with simulator. Applicable
16889 to ELF compiler only.
16891 @item -mint32
16892 @opindex mint32
16893 Choose integer type as 32-bit wide.
16895 @item -mbit-ops
16896 @opindex mbit-ops
16897 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16899 @item -mdata-model=@var{model}
16900 @opindex mdata-model
16901 Choose a data model. The choices for @var{model} are @samp{near},
16902 @samp{far} or @samp{medium}. @samp{medium} is default.
16903 However, @samp{far} is not valid with @option{-mcr16c}, as the
16904 CR16C architecture does not support the far data model.
16905 @end table
16907 @node Darwin Options
16908 @subsection Darwin Options
16909 @cindex Darwin options
16911 These options are defined for all architectures running the Darwin operating
16912 system.
16914 FSF GCC on Darwin does not create ``fat'' object files; it creates
16915 an object file for the single architecture that GCC was built to
16916 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16917 @option{-arch} options are used; it does so by running the compiler or
16918 linker multiple times and joining the results together with
16919 @file{lipo}.
16921 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16922 @samp{i686}) is determined by the flags that specify the ISA
16923 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16924 @option{-force_cpusubtype_ALL} option can be used to override this.
16926 The Darwin tools vary in their behavior when presented with an ISA
16927 mismatch.  The assembler, @file{as}, only permits instructions to
16928 be used that are valid for the subtype of the file it is generating,
16929 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16930 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16931 and prints an error if asked to create a shared library with a less
16932 restrictive subtype than its input files (for instance, trying to put
16933 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16934 for executables, @command{ld}, quietly gives the executable the most
16935 restrictive subtype of any of its input files.
16937 @table @gcctabopt
16938 @item -F@var{dir}
16939 @opindex F
16940 Add the framework directory @var{dir} to the head of the list of
16941 directories to be searched for header files.  These directories are
16942 interleaved with those specified by @option{-I} options and are
16943 scanned in a left-to-right order.
16945 A framework directory is a directory with frameworks in it.  A
16946 framework is a directory with a @file{Headers} and/or
16947 @file{PrivateHeaders} directory contained directly in it that ends
16948 in @file{.framework}.  The name of a framework is the name of this
16949 directory excluding the @file{.framework}.  Headers associated with
16950 the framework are found in one of those two directories, with
16951 @file{Headers} being searched first.  A subframework is a framework
16952 directory that is in a framework's @file{Frameworks} directory.
16953 Includes of subframework headers can only appear in a header of a
16954 framework that contains the subframework, or in a sibling subframework
16955 header.  Two subframeworks are siblings if they occur in the same
16956 framework.  A subframework should not have the same name as a
16957 framework; a warning is issued if this is violated.  Currently a
16958 subframework cannot have subframeworks; in the future, the mechanism
16959 may be extended to support this.  The standard frameworks can be found
16960 in @file{/System/Library/Frameworks} and
16961 @file{/Library/Frameworks}.  An example include looks like
16962 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16963 the name of the framework and @file{header.h} is found in the
16964 @file{PrivateHeaders} or @file{Headers} directory.
16966 @item -iframework@var{dir}
16967 @opindex iframework
16968 Like @option{-F} except the directory is a treated as a system
16969 directory.  The main difference between this @option{-iframework} and
16970 @option{-F} is that with @option{-iframework} the compiler does not
16971 warn about constructs contained within header files found via
16972 @var{dir}.  This option is valid only for the C family of languages.
16974 @item -gused
16975 @opindex gused
16976 Emit debugging information for symbols that are used.  For stabs
16977 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16978 This is by default ON@.
16980 @item -gfull
16981 @opindex gfull
16982 Emit debugging information for all symbols and types.
16984 @item -mmacosx-version-min=@var{version}
16985 The earliest version of MacOS X that this executable will run on
16986 is @var{version}.  Typical values of @var{version} include @code{10.1},
16987 @code{10.2}, and @code{10.3.9}.
16989 If the compiler was built to use the system's headers by default,
16990 then the default for this option is the system version on which the
16991 compiler is running, otherwise the default is to make choices that
16992 are compatible with as many systems and code bases as possible.
16994 @item -mkernel
16995 @opindex mkernel
16996 Enable kernel development mode.  The @option{-mkernel} option sets
16997 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16998 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16999 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17000 applicable.  This mode also sets @option{-mno-altivec},
17001 @option{-msoft-float}, @option{-fno-builtin} and
17002 @option{-mlong-branch} for PowerPC targets.
17004 @item -mone-byte-bool
17005 @opindex mone-byte-bool
17006 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17007 By default @code{sizeof(bool)} is @code{4} when compiling for
17008 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17009 option has no effect on x86.
17011 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17012 to generate code that is not binary compatible with code generated
17013 without that switch.  Using this switch may require recompiling all
17014 other modules in a program, including system libraries.  Use this
17015 switch to conform to a non-default data model.
17017 @item -mfix-and-continue
17018 @itemx -ffix-and-continue
17019 @itemx -findirect-data
17020 @opindex mfix-and-continue
17021 @opindex ffix-and-continue
17022 @opindex findirect-data
17023 Generate code suitable for fast turnaround development, such as to
17024 allow GDB to dynamically load @file{.o} files into already-running
17025 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17026 are provided for backwards compatibility.
17028 @item -all_load
17029 @opindex all_load
17030 Loads all members of static archive libraries.
17031 See man ld(1) for more information.
17033 @item -arch_errors_fatal
17034 @opindex arch_errors_fatal
17035 Cause the errors having to do with files that have the wrong architecture
17036 to be fatal.
17038 @item -bind_at_load
17039 @opindex bind_at_load
17040 Causes the output file to be marked such that the dynamic linker will
17041 bind all undefined references when the file is loaded or launched.
17043 @item -bundle
17044 @opindex bundle
17045 Produce a Mach-o bundle format file.
17046 See man ld(1) for more information.
17048 @item -bundle_loader @var{executable}
17049 @opindex bundle_loader
17050 This option specifies the @var{executable} that will load the build
17051 output file being linked.  See man ld(1) for more information.
17053 @item -dynamiclib
17054 @opindex dynamiclib
17055 When passed this option, GCC produces a dynamic library instead of
17056 an executable when linking, using the Darwin @file{libtool} command.
17058 @item -force_cpusubtype_ALL
17059 @opindex force_cpusubtype_ALL
17060 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17061 one controlled by the @option{-mcpu} or @option{-march} option.
17063 @item -allowable_client  @var{client_name}
17064 @itemx -client_name
17065 @itemx -compatibility_version
17066 @itemx -current_version
17067 @itemx -dead_strip
17068 @itemx -dependency-file
17069 @itemx -dylib_file
17070 @itemx -dylinker_install_name
17071 @itemx -dynamic
17072 @itemx -exported_symbols_list
17073 @itemx -filelist
17074 @need 800
17075 @itemx -flat_namespace
17076 @itemx -force_flat_namespace
17077 @itemx -headerpad_max_install_names
17078 @itemx -image_base
17079 @itemx -init
17080 @itemx -install_name
17081 @itemx -keep_private_externs
17082 @itemx -multi_module
17083 @itemx -multiply_defined
17084 @itemx -multiply_defined_unused
17085 @need 800
17086 @itemx -noall_load
17087 @itemx -no_dead_strip_inits_and_terms
17088 @itemx -nofixprebinding
17089 @itemx -nomultidefs
17090 @itemx -noprebind
17091 @itemx -noseglinkedit
17092 @itemx -pagezero_size
17093 @itemx -prebind
17094 @itemx -prebind_all_twolevel_modules
17095 @itemx -private_bundle
17096 @need 800
17097 @itemx -read_only_relocs
17098 @itemx -sectalign
17099 @itemx -sectobjectsymbols
17100 @itemx -whyload
17101 @itemx -seg1addr
17102 @itemx -sectcreate
17103 @itemx -sectobjectsymbols
17104 @itemx -sectorder
17105 @itemx -segaddr
17106 @itemx -segs_read_only_addr
17107 @need 800
17108 @itemx -segs_read_write_addr
17109 @itemx -seg_addr_table
17110 @itemx -seg_addr_table_filename
17111 @itemx -seglinkedit
17112 @itemx -segprot
17113 @itemx -segs_read_only_addr
17114 @itemx -segs_read_write_addr
17115 @itemx -single_module
17116 @itemx -static
17117 @itemx -sub_library
17118 @need 800
17119 @itemx -sub_umbrella
17120 @itemx -twolevel_namespace
17121 @itemx -umbrella
17122 @itemx -undefined
17123 @itemx -unexported_symbols_list
17124 @itemx -weak_reference_mismatches
17125 @itemx -whatsloaded
17126 @opindex allowable_client
17127 @opindex client_name
17128 @opindex compatibility_version
17129 @opindex current_version
17130 @opindex dead_strip
17131 @opindex dependency-file
17132 @opindex dylib_file
17133 @opindex dylinker_install_name
17134 @opindex dynamic
17135 @opindex exported_symbols_list
17136 @opindex filelist
17137 @opindex flat_namespace
17138 @opindex force_flat_namespace
17139 @opindex headerpad_max_install_names
17140 @opindex image_base
17141 @opindex init
17142 @opindex install_name
17143 @opindex keep_private_externs
17144 @opindex multi_module
17145 @opindex multiply_defined
17146 @opindex multiply_defined_unused
17147 @opindex noall_load
17148 @opindex no_dead_strip_inits_and_terms
17149 @opindex nofixprebinding
17150 @opindex nomultidefs
17151 @opindex noprebind
17152 @opindex noseglinkedit
17153 @opindex pagezero_size
17154 @opindex prebind
17155 @opindex prebind_all_twolevel_modules
17156 @opindex private_bundle
17157 @opindex read_only_relocs
17158 @opindex sectalign
17159 @opindex sectobjectsymbols
17160 @opindex whyload
17161 @opindex seg1addr
17162 @opindex sectcreate
17163 @opindex sectobjectsymbols
17164 @opindex sectorder
17165 @opindex segaddr
17166 @opindex segs_read_only_addr
17167 @opindex segs_read_write_addr
17168 @opindex seg_addr_table
17169 @opindex seg_addr_table_filename
17170 @opindex seglinkedit
17171 @opindex segprot
17172 @opindex segs_read_only_addr
17173 @opindex segs_read_write_addr
17174 @opindex single_module
17175 @opindex static
17176 @opindex sub_library
17177 @opindex sub_umbrella
17178 @opindex twolevel_namespace
17179 @opindex umbrella
17180 @opindex undefined
17181 @opindex unexported_symbols_list
17182 @opindex weak_reference_mismatches
17183 @opindex whatsloaded
17184 These options are passed to the Darwin linker.  The Darwin linker man page
17185 describes them in detail.
17186 @end table
17188 @node DEC Alpha Options
17189 @subsection DEC Alpha Options
17191 These @samp{-m} options are defined for the DEC Alpha implementations:
17193 @table @gcctabopt
17194 @item -mno-soft-float
17195 @itemx -msoft-float
17196 @opindex mno-soft-float
17197 @opindex msoft-float
17198 Use (do not use) the hardware floating-point instructions for
17199 floating-point operations.  When @option{-msoft-float} is specified,
17200 functions in @file{libgcc.a} are used to perform floating-point
17201 operations.  Unless they are replaced by routines that emulate the
17202 floating-point operations, or compiled in such a way as to call such
17203 emulations routines, these routines issue floating-point
17204 operations.   If you are compiling for an Alpha without floating-point
17205 operations, you must ensure that the library is built so as not to call
17206 them.
17208 Note that Alpha implementations without floating-point operations are
17209 required to have floating-point registers.
17211 @item -mfp-reg
17212 @itemx -mno-fp-regs
17213 @opindex mfp-reg
17214 @opindex mno-fp-regs
17215 Generate code that uses (does not use) the floating-point register set.
17216 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17217 register set is not used, floating-point operands are passed in integer
17218 registers as if they were integers and floating-point results are passed
17219 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17220 so any function with a floating-point argument or return value called by code
17221 compiled with @option{-mno-fp-regs} must also be compiled with that
17222 option.
17224 A typical use of this option is building a kernel that does not use,
17225 and hence need not save and restore, any floating-point registers.
17227 @item -mieee
17228 @opindex mieee
17229 The Alpha architecture implements floating-point hardware optimized for
17230 maximum performance.  It is mostly compliant with the IEEE floating-point
17231 standard.  However, for full compliance, software assistance is
17232 required.  This option generates code fully IEEE-compliant code
17233 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17234 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17235 defined during compilation.  The resulting code is less efficient but is
17236 able to correctly support denormalized numbers and exceptional IEEE
17237 values such as not-a-number and plus/minus infinity.  Other Alpha
17238 compilers call this option @option{-ieee_with_no_inexact}.
17240 @item -mieee-with-inexact
17241 @opindex mieee-with-inexact
17242 This is like @option{-mieee} except the generated code also maintains
17243 the IEEE @var{inexact-flag}.  Turning on this option causes the
17244 generated code to implement fully-compliant IEEE math.  In addition to
17245 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17246 macro.  On some Alpha implementations the resulting code may execute
17247 significantly slower than the code generated by default.  Since there is
17248 very little code that depends on the @var{inexact-flag}, you should
17249 normally not specify this option.  Other Alpha compilers call this
17250 option @option{-ieee_with_inexact}.
17252 @item -mfp-trap-mode=@var{trap-mode}
17253 @opindex mfp-trap-mode
17254 This option controls what floating-point related traps are enabled.
17255 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17256 The trap mode can be set to one of four values:
17258 @table @samp
17259 @item n
17260 This is the default (normal) setting.  The only traps that are enabled
17261 are the ones that cannot be disabled in software (e.g., division by zero
17262 trap).
17264 @item u
17265 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17266 as well.
17268 @item su
17269 Like @samp{u}, but the instructions are marked to be safe for software
17270 completion (see Alpha architecture manual for details).
17272 @item sui
17273 Like @samp{su}, but inexact traps are enabled as well.
17274 @end table
17276 @item -mfp-rounding-mode=@var{rounding-mode}
17277 @opindex mfp-rounding-mode
17278 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17279 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17282 @table @samp
17283 @item n
17284 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17285 the nearest machine number or towards the even machine number in case
17286 of a tie.
17288 @item m
17289 Round towards minus infinity.
17291 @item c
17292 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17294 @item d
17295 Dynamic rounding mode.  A field in the floating-point control register
17296 (@var{fpcr}, see Alpha architecture reference manual) controls the
17297 rounding mode in effect.  The C library initializes this register for
17298 rounding towards plus infinity.  Thus, unless your program modifies the
17299 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17300 @end table
17302 @item -mtrap-precision=@var{trap-precision}
17303 @opindex mtrap-precision
17304 In the Alpha architecture, floating-point traps are imprecise.  This
17305 means without software assistance it is impossible to recover from a
17306 floating trap and program execution normally needs to be terminated.
17307 GCC can generate code that can assist operating system trap handlers
17308 in determining the exact location that caused a floating-point trap.
17309 Depending on the requirements of an application, different levels of
17310 precisions can be selected:
17312 @table @samp
17313 @item p
17314 Program precision.  This option is the default and means a trap handler
17315 can only identify which program caused a floating-point exception.
17317 @item f
17318 Function precision.  The trap handler can determine the function that
17319 caused a floating-point exception.
17321 @item i
17322 Instruction precision.  The trap handler can determine the exact
17323 instruction that caused a floating-point exception.
17324 @end table
17326 Other Alpha compilers provide the equivalent options called
17327 @option{-scope_safe} and @option{-resumption_safe}.
17329 @item -mieee-conformant
17330 @opindex mieee-conformant
17331 This option marks the generated code as IEEE conformant.  You must not
17332 use this option unless you also specify @option{-mtrap-precision=i} and either
17333 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17334 is to emit the line @samp{.eflag 48} in the function prologue of the
17335 generated assembly file.
17337 @item -mbuild-constants
17338 @opindex mbuild-constants
17339 Normally GCC examines a 32- or 64-bit integer constant to
17340 see if it can construct it from smaller constants in two or three
17341 instructions.  If it cannot, it outputs the constant as a literal and
17342 generates code to load it from the data segment at run time.
17344 Use this option to require GCC to construct @emph{all} integer constants
17345 using code, even if it takes more instructions (the maximum is six).
17347 You typically use this option to build a shared library dynamic
17348 loader.  Itself a shared library, it must relocate itself in memory
17349 before it can find the variables and constants in its own data segment.
17351 @item -mbwx
17352 @itemx -mno-bwx
17353 @itemx -mcix
17354 @itemx -mno-cix
17355 @itemx -mfix
17356 @itemx -mno-fix
17357 @itemx -mmax
17358 @itemx -mno-max
17359 @opindex mbwx
17360 @opindex mno-bwx
17361 @opindex mcix
17362 @opindex mno-cix
17363 @opindex mfix
17364 @opindex mno-fix
17365 @opindex mmax
17366 @opindex mno-max
17367 Indicate whether GCC should generate code to use the optional BWX,
17368 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17369 sets supported by the CPU type specified via @option{-mcpu=} option or that
17370 of the CPU on which GCC was built if none is specified.
17372 @item -mfloat-vax
17373 @itemx -mfloat-ieee
17374 @opindex mfloat-vax
17375 @opindex mfloat-ieee
17376 Generate code that uses (does not use) VAX F and G floating-point
17377 arithmetic instead of IEEE single and double precision.
17379 @item -mexplicit-relocs
17380 @itemx -mno-explicit-relocs
17381 @opindex mexplicit-relocs
17382 @opindex mno-explicit-relocs
17383 Older Alpha assemblers provided no way to generate symbol relocations
17384 except via assembler macros.  Use of these macros does not allow
17385 optimal instruction scheduling.  GNU binutils as of version 2.12
17386 supports a new syntax that allows the compiler to explicitly mark
17387 which relocations should apply to which instructions.  This option
17388 is mostly useful for debugging, as GCC detects the capabilities of
17389 the assembler when it is built and sets the default accordingly.
17391 @item -msmall-data
17392 @itemx -mlarge-data
17393 @opindex msmall-data
17394 @opindex mlarge-data
17395 When @option{-mexplicit-relocs} is in effect, static data is
17396 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17397 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17398 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17399 16-bit relocations off of the @code{$gp} register.  This limits the
17400 size of the small data area to 64KB, but allows the variables to be
17401 directly accessed via a single instruction.
17403 The default is @option{-mlarge-data}.  With this option the data area
17404 is limited to just below 2GB@.  Programs that require more than 2GB of
17405 data must use @code{malloc} or @code{mmap} to allocate the data in the
17406 heap instead of in the program's data segment.
17408 When generating code for shared libraries, @option{-fpic} implies
17409 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17411 @item -msmall-text
17412 @itemx -mlarge-text
17413 @opindex msmall-text
17414 @opindex mlarge-text
17415 When @option{-msmall-text} is used, the compiler assumes that the
17416 code of the entire program (or shared library) fits in 4MB, and is
17417 thus reachable with a branch instruction.  When @option{-msmall-data}
17418 is used, the compiler can assume that all local symbols share the
17419 same @code{$gp} value, and thus reduce the number of instructions
17420 required for a function call from 4 to 1.
17422 The default is @option{-mlarge-text}.
17424 @item -mcpu=@var{cpu_type}
17425 @opindex mcpu
17426 Set the instruction set and instruction scheduling parameters for
17427 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17428 style name or the corresponding chip number.  GCC supports scheduling
17429 parameters for the EV4, EV5 and EV6 family of processors and
17430 chooses the default values for the instruction set from the processor
17431 you specify.  If you do not specify a processor type, GCC defaults
17432 to the processor on which the compiler was built.
17434 Supported values for @var{cpu_type} are
17436 @table @samp
17437 @item ev4
17438 @itemx ev45
17439 @itemx 21064
17440 Schedules as an EV4 and has no instruction set extensions.
17442 @item ev5
17443 @itemx 21164
17444 Schedules as an EV5 and has no instruction set extensions.
17446 @item ev56
17447 @itemx 21164a
17448 Schedules as an EV5 and supports the BWX extension.
17450 @item pca56
17451 @itemx 21164pc
17452 @itemx 21164PC
17453 Schedules as an EV5 and supports the BWX and MAX extensions.
17455 @item ev6
17456 @itemx 21264
17457 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17459 @item ev67
17460 @itemx 21264a
17461 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17462 @end table
17464 Native toolchains also support the value @samp{native},
17465 which selects the best architecture option for the host processor.
17466 @option{-mcpu=native} has no effect if GCC does not recognize
17467 the processor.
17469 @item -mtune=@var{cpu_type}
17470 @opindex mtune
17471 Set only the instruction scheduling parameters for machine type
17472 @var{cpu_type}.  The instruction set is not changed.
17474 Native toolchains also support the value @samp{native},
17475 which selects the best architecture option for the host processor.
17476 @option{-mtune=native} has no effect if GCC does not recognize
17477 the processor.
17479 @item -mmemory-latency=@var{time}
17480 @opindex mmemory-latency
17481 Sets the latency the scheduler should assume for typical memory
17482 references as seen by the application.  This number is highly
17483 dependent on the memory access patterns used by the application
17484 and the size of the external cache on the machine.
17486 Valid options for @var{time} are
17488 @table @samp
17489 @item @var{number}
17490 A decimal number representing clock cycles.
17492 @item L1
17493 @itemx L2
17494 @itemx L3
17495 @itemx main
17496 The compiler contains estimates of the number of clock cycles for
17497 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17498 (also called Dcache, Scache, and Bcache), as well as to main memory.
17499 Note that L3 is only valid for EV5.
17501 @end table
17502 @end table
17504 @node FR30 Options
17505 @subsection FR30 Options
17506 @cindex FR30 Options
17508 These options are defined specifically for the FR30 port.
17510 @table @gcctabopt
17512 @item -msmall-model
17513 @opindex msmall-model
17514 Use the small address space model.  This can produce smaller code, but
17515 it does assume that all symbolic values and addresses fit into a
17516 20-bit range.
17518 @item -mno-lsim
17519 @opindex mno-lsim
17520 Assume that runtime support has been provided and so there is no need
17521 to include the simulator library (@file{libsim.a}) on the linker
17522 command line.
17524 @end table
17526 @node FT32 Options
17527 @subsection FT32 Options
17528 @cindex FT32 Options
17530 These options are defined specifically for the FT32 port.
17532 @table @gcctabopt
17534 @item -msim
17535 @opindex msim
17536 Specifies that the program will be run on the simulator.  This causes
17537 an alternate runtime startup and library to be linked.
17538 You must not use this option when generating programs that will run on
17539 real hardware; you must provide your own runtime library for whatever
17540 I/O functions are needed.
17542 @item -mlra
17543 @opindex mlra
17544 Enable Local Register Allocation.  This is still experimental for FT32,
17545 so by default the compiler uses standard reload.
17547 @item -mnodiv
17548 @opindex mnodiv
17549 Do not use div and mod instructions.
17551 @end table
17553 @node FRV Options
17554 @subsection FRV Options
17555 @cindex FRV Options
17557 @table @gcctabopt
17558 @item -mgpr-32
17559 @opindex mgpr-32
17561 Only use the first 32 general-purpose registers.
17563 @item -mgpr-64
17564 @opindex mgpr-64
17566 Use all 64 general-purpose registers.
17568 @item -mfpr-32
17569 @opindex mfpr-32
17571 Use only the first 32 floating-point registers.
17573 @item -mfpr-64
17574 @opindex mfpr-64
17576 Use all 64 floating-point registers.
17578 @item -mhard-float
17579 @opindex mhard-float
17581 Use hardware instructions for floating-point operations.
17583 @item -msoft-float
17584 @opindex msoft-float
17586 Use library routines for floating-point operations.
17588 @item -malloc-cc
17589 @opindex malloc-cc
17591 Dynamically allocate condition code registers.
17593 @item -mfixed-cc
17594 @opindex mfixed-cc
17596 Do not try to dynamically allocate condition code registers, only
17597 use @code{icc0} and @code{fcc0}.
17599 @item -mdword
17600 @opindex mdword
17602 Change ABI to use double word insns.
17604 @item -mno-dword
17605 @opindex mno-dword
17607 Do not use double word instructions.
17609 @item -mdouble
17610 @opindex mdouble
17612 Use floating-point double instructions.
17614 @item -mno-double
17615 @opindex mno-double
17617 Do not use floating-point double instructions.
17619 @item -mmedia
17620 @opindex mmedia
17622 Use media instructions.
17624 @item -mno-media
17625 @opindex mno-media
17627 Do not use media instructions.
17629 @item -mmuladd
17630 @opindex mmuladd
17632 Use multiply and add/subtract instructions.
17634 @item -mno-muladd
17635 @opindex mno-muladd
17637 Do not use multiply and add/subtract instructions.
17639 @item -mfdpic
17640 @opindex mfdpic
17642 Select the FDPIC ABI, which uses function descriptors to represent
17643 pointers to functions.  Without any PIC/PIE-related options, it
17644 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17645 assumes GOT entries and small data are within a 12-bit range from the
17646 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17647 are computed with 32 bits.
17648 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17650 @item -minline-plt
17651 @opindex minline-plt
17653 Enable inlining of PLT entries in function calls to functions that are
17654 not known to bind locally.  It has no effect without @option{-mfdpic}.
17655 It's enabled by default if optimizing for speed and compiling for
17656 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17657 optimization option such as @option{-O3} or above is present in the
17658 command line.
17660 @item -mTLS
17661 @opindex mTLS
17663 Assume a large TLS segment when generating thread-local code.
17665 @item -mtls
17666 @opindex mtls
17668 Do not assume a large TLS segment when generating thread-local code.
17670 @item -mgprel-ro
17671 @opindex mgprel-ro
17673 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17674 that is known to be in read-only sections.  It's enabled by default,
17675 except for @option{-fpic} or @option{-fpie}: even though it may help
17676 make the global offset table smaller, it trades 1 instruction for 4.
17677 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17678 one of which may be shared by multiple symbols, and it avoids the need
17679 for a GOT entry for the referenced symbol, so it's more likely to be a
17680 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17682 @item -multilib-library-pic
17683 @opindex multilib-library-pic
17685 Link with the (library, not FD) pic libraries.  It's implied by
17686 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17687 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17688 it explicitly.
17690 @item -mlinked-fp
17691 @opindex mlinked-fp
17693 Follow the EABI requirement of always creating a frame pointer whenever
17694 a stack frame is allocated.  This option is enabled by default and can
17695 be disabled with @option{-mno-linked-fp}.
17697 @item -mlong-calls
17698 @opindex mlong-calls
17700 Use indirect addressing to call functions outside the current
17701 compilation unit.  This allows the functions to be placed anywhere
17702 within the 32-bit address space.
17704 @item -malign-labels
17705 @opindex malign-labels
17707 Try to align labels to an 8-byte boundary by inserting NOPs into the
17708 previous packet.  This option only has an effect when VLIW packing
17709 is enabled.  It doesn't create new packets; it merely adds NOPs to
17710 existing ones.
17712 @item -mlibrary-pic
17713 @opindex mlibrary-pic
17715 Generate position-independent EABI code.
17717 @item -macc-4
17718 @opindex macc-4
17720 Use only the first four media accumulator registers.
17722 @item -macc-8
17723 @opindex macc-8
17725 Use all eight media accumulator registers.
17727 @item -mpack
17728 @opindex mpack
17730 Pack VLIW instructions.
17732 @item -mno-pack
17733 @opindex mno-pack
17735 Do not pack VLIW instructions.
17737 @item -mno-eflags
17738 @opindex mno-eflags
17740 Do not mark ABI switches in e_flags.
17742 @item -mcond-move
17743 @opindex mcond-move
17745 Enable the use of conditional-move instructions (default).
17747 This switch is mainly for debugging the compiler and will likely be removed
17748 in a future version.
17750 @item -mno-cond-move
17751 @opindex mno-cond-move
17753 Disable the use of conditional-move instructions.
17755 This switch is mainly for debugging the compiler and will likely be removed
17756 in a future version.
17758 @item -mscc
17759 @opindex mscc
17761 Enable the use of conditional set instructions (default).
17763 This switch is mainly for debugging the compiler and will likely be removed
17764 in a future version.
17766 @item -mno-scc
17767 @opindex mno-scc
17769 Disable the use of conditional set instructions.
17771 This switch is mainly for debugging the compiler and will likely be removed
17772 in a future version.
17774 @item -mcond-exec
17775 @opindex mcond-exec
17777 Enable the use of conditional execution (default).
17779 This switch is mainly for debugging the compiler and will likely be removed
17780 in a future version.
17782 @item -mno-cond-exec
17783 @opindex mno-cond-exec
17785 Disable the use of conditional execution.
17787 This switch is mainly for debugging the compiler and will likely be removed
17788 in a future version.
17790 @item -mvliw-branch
17791 @opindex mvliw-branch
17793 Run a pass to pack branches into VLIW instructions (default).
17795 This switch is mainly for debugging the compiler and will likely be removed
17796 in a future version.
17798 @item -mno-vliw-branch
17799 @opindex mno-vliw-branch
17801 Do not run a pass to pack branches into VLIW instructions.
17803 This switch is mainly for debugging the compiler and will likely be removed
17804 in a future version.
17806 @item -mmulti-cond-exec
17807 @opindex mmulti-cond-exec
17809 Enable optimization of @code{&&} and @code{||} in conditional execution
17810 (default).
17812 This switch is mainly for debugging the compiler and will likely be removed
17813 in a future version.
17815 @item -mno-multi-cond-exec
17816 @opindex mno-multi-cond-exec
17818 Disable optimization of @code{&&} and @code{||} in conditional execution.
17820 This switch is mainly for debugging the compiler and will likely be removed
17821 in a future version.
17823 @item -mnested-cond-exec
17824 @opindex mnested-cond-exec
17826 Enable nested conditional execution optimizations (default).
17828 This switch is mainly for debugging the compiler and will likely be removed
17829 in a future version.
17831 @item -mno-nested-cond-exec
17832 @opindex mno-nested-cond-exec
17834 Disable nested conditional execution optimizations.
17836 This switch is mainly for debugging the compiler and will likely be removed
17837 in a future version.
17839 @item -moptimize-membar
17840 @opindex moptimize-membar
17842 This switch removes redundant @code{membar} instructions from the
17843 compiler-generated code.  It is enabled by default.
17845 @item -mno-optimize-membar
17846 @opindex mno-optimize-membar
17848 This switch disables the automatic removal of redundant @code{membar}
17849 instructions from the generated code.
17851 @item -mtomcat-stats
17852 @opindex mtomcat-stats
17854 Cause gas to print out tomcat statistics.
17856 @item -mcpu=@var{cpu}
17857 @opindex mcpu
17859 Select the processor type for which to generate code.  Possible values are
17860 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17861 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17863 @end table
17865 @node GNU/Linux Options
17866 @subsection GNU/Linux Options
17868 These @samp{-m} options are defined for GNU/Linux targets:
17870 @table @gcctabopt
17871 @item -mglibc
17872 @opindex mglibc
17873 Use the GNU C library.  This is the default except
17874 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17875 @samp{*-*-linux-*android*} targets.
17877 @item -muclibc
17878 @opindex muclibc
17879 Use uClibc C library.  This is the default on
17880 @samp{*-*-linux-*uclibc*} targets.
17882 @item -mmusl
17883 @opindex mmusl
17884 Use the musl C library.  This is the default on
17885 @samp{*-*-linux-*musl*} targets.
17887 @item -mbionic
17888 @opindex mbionic
17889 Use Bionic C library.  This is the default on
17890 @samp{*-*-linux-*android*} targets.
17892 @item -mandroid
17893 @opindex mandroid
17894 Compile code compatible with Android platform.  This is the default on
17895 @samp{*-*-linux-*android*} targets.
17897 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17898 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17899 this option makes the GCC driver pass Android-specific options to the linker.
17900 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17901 to be defined.
17903 @item -tno-android-cc
17904 @opindex tno-android-cc
17905 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17906 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17907 @option{-fno-rtti} by default.
17909 @item -tno-android-ld
17910 @opindex tno-android-ld
17911 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17912 linking options to the linker.
17914 @end table
17916 @node H8/300 Options
17917 @subsection H8/300 Options
17919 These @samp{-m} options are defined for the H8/300 implementations:
17921 @table @gcctabopt
17922 @item -mrelax
17923 @opindex mrelax
17924 Shorten some address references at link time, when possible; uses the
17925 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17926 ld, Using ld}, for a fuller description.
17928 @item -mh
17929 @opindex mh
17930 Generate code for the H8/300H@.
17932 @item -ms
17933 @opindex ms
17934 Generate code for the H8S@.
17936 @item -mn
17937 @opindex mn
17938 Generate code for the H8S and H8/300H in the normal mode.  This switch
17939 must be used either with @option{-mh} or @option{-ms}.
17941 @item -ms2600
17942 @opindex ms2600
17943 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17945 @item -mexr
17946 @opindex mexr
17947 Extended registers are stored on stack before execution of function
17948 with monitor attribute. Default option is @option{-mexr}.
17949 This option is valid only for H8S targets.
17951 @item -mno-exr
17952 @opindex mno-exr
17953 Extended registers are not stored on stack before execution of function 
17954 with monitor attribute. Default option is @option{-mno-exr}. 
17955 This option is valid only for H8S targets.
17957 @item -mint32
17958 @opindex mint32
17959 Make @code{int} data 32 bits by default.
17961 @item -malign-300
17962 @opindex malign-300
17963 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17964 The default for the H8/300H and H8S is to align longs and floats on
17965 4-byte boundaries.
17966 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17967 This option has no effect on the H8/300.
17968 @end table
17970 @node HPPA Options
17971 @subsection HPPA Options
17972 @cindex HPPA Options
17974 These @samp{-m} options are defined for the HPPA family of computers:
17976 @table @gcctabopt
17977 @item -march=@var{architecture-type}
17978 @opindex march
17979 Generate code for the specified architecture.  The choices for
17980 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17981 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17982 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17983 architecture option for your machine.  Code compiled for lower numbered
17984 architectures runs on higher numbered architectures, but not the
17985 other way around.
17987 @item -mpa-risc-1-0
17988 @itemx -mpa-risc-1-1
17989 @itemx -mpa-risc-2-0
17990 @opindex mpa-risc-1-0
17991 @opindex mpa-risc-1-1
17992 @opindex mpa-risc-2-0
17993 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17995 @item -mcaller-copies
17996 @opindex mcaller-copies
17997 The caller copies function arguments passed by hidden reference.  This
17998 option should be used with care as it is not compatible with the default
17999 32-bit runtime.  However, only aggregates larger than eight bytes are
18000 passed by hidden reference and the option provides better compatibility
18001 with OpenMP.
18003 @item -mjump-in-delay
18004 @opindex mjump-in-delay
18005 This option is ignored and provided for compatibility purposes only.
18007 @item -mdisable-fpregs
18008 @opindex mdisable-fpregs
18009 Prevent floating-point registers from being used in any manner.  This is
18010 necessary for compiling kernels that perform lazy context switching of
18011 floating-point registers.  If you use this option and attempt to perform
18012 floating-point operations, the compiler aborts.
18014 @item -mdisable-indexing
18015 @opindex mdisable-indexing
18016 Prevent the compiler from using indexing address modes.  This avoids some
18017 rather obscure problems when compiling MIG generated code under MACH@.
18019 @item -mno-space-regs
18020 @opindex mno-space-regs
18021 Generate code that assumes the target has no space registers.  This allows
18022 GCC to generate faster indirect calls and use unscaled index address modes.
18024 Such code is suitable for level 0 PA systems and kernels.
18026 @item -mfast-indirect-calls
18027 @opindex mfast-indirect-calls
18028 Generate code that assumes calls never cross space boundaries.  This
18029 allows GCC to emit code that performs faster indirect calls.
18031 This option does not work in the presence of shared libraries or nested
18032 functions.
18034 @item -mfixed-range=@var{register-range}
18035 @opindex mfixed-range
18036 Generate code treating the given register range as fixed registers.
18037 A fixed register is one that the register allocator cannot use.  This is
18038 useful when compiling kernel code.  A register range is specified as
18039 two registers separated by a dash.  Multiple register ranges can be
18040 specified separated by a comma.
18042 @item -mlong-load-store
18043 @opindex mlong-load-store
18044 Generate 3-instruction load and store sequences as sometimes required by
18045 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18046 the HP compilers.
18048 @item -mportable-runtime
18049 @opindex mportable-runtime
18050 Use the portable calling conventions proposed by HP for ELF systems.
18052 @item -mgas
18053 @opindex mgas
18054 Enable the use of assembler directives only GAS understands.
18056 @item -mschedule=@var{cpu-type}
18057 @opindex mschedule
18058 Schedule code according to the constraints for the machine type
18059 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18060 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18061 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18062 proper scheduling option for your machine.  The default scheduling is
18063 @samp{8000}.
18065 @item -mlinker-opt
18066 @opindex mlinker-opt
18067 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18068 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18069 linkers in which they give bogus error messages when linking some programs.
18071 @item -msoft-float
18072 @opindex msoft-float
18073 Generate output containing library calls for floating point.
18074 @strong{Warning:} the requisite libraries are not available for all HPPA
18075 targets.  Normally the facilities of the machine's usual C compiler are
18076 used, but this cannot be done directly in cross-compilation.  You must make
18077 your own arrangements to provide suitable library functions for
18078 cross-compilation.
18080 @option{-msoft-float} changes the calling convention in the output file;
18081 therefore, it is only useful if you compile @emph{all} of a program with
18082 this option.  In particular, you need to compile @file{libgcc.a}, the
18083 library that comes with GCC, with @option{-msoft-float} in order for
18084 this to work.
18086 @item -msio
18087 @opindex msio
18088 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18089 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18090 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18091 options are available under HP-UX and HI-UX@.
18093 @item -mgnu-ld
18094 @opindex mgnu-ld
18095 Use options specific to GNU @command{ld}.
18096 This passes @option{-shared} to @command{ld} when
18097 building a shared library.  It is the default when GCC is configured,
18098 explicitly or implicitly, with the GNU linker.  This option does not
18099 affect which @command{ld} is called; it only changes what parameters
18100 are passed to that @command{ld}.
18101 The @command{ld} that is called is determined by the
18102 @option{--with-ld} configure option, GCC's program search path, and
18103 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18104 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18105 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18107 @item -mhp-ld
18108 @opindex mhp-ld
18109 Use options specific to HP @command{ld}.
18110 This passes @option{-b} to @command{ld} when building
18111 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18112 links.  It is the default when GCC is configured, explicitly or
18113 implicitly, with the HP linker.  This option does not affect
18114 which @command{ld} is called; it only changes what parameters are passed to that
18115 @command{ld}.
18116 The @command{ld} that is called is determined by the @option{--with-ld}
18117 configure option, GCC's program search path, and finally by the user's
18118 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18119 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18120 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18122 @item -mlong-calls
18123 @opindex mno-long-calls
18124 Generate code that uses long call sequences.  This ensures that a call
18125 is always able to reach linker generated stubs.  The default is to generate
18126 long calls only when the distance from the call site to the beginning
18127 of the function or translation unit, as the case may be, exceeds a
18128 predefined limit set by the branch type being used.  The limits for
18129 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18130 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18131 240,000 bytes.
18133 Distances are measured from the beginning of functions when using the
18134 @option{-ffunction-sections} option, or when using the @option{-mgas}
18135 and @option{-mno-portable-runtime} options together under HP-UX with
18136 the SOM linker.
18138 It is normally not desirable to use this option as it degrades
18139 performance.  However, it may be useful in large applications,
18140 particularly when partial linking is used to build the application.
18142 The types of long calls used depends on the capabilities of the
18143 assembler and linker, and the type of code being generated.  The
18144 impact on systems that support long absolute calls, and long pic
18145 symbol-difference or pc-relative calls should be relatively small.
18146 However, an indirect call is used on 32-bit ELF systems in pic code
18147 and it is quite long.
18149 @item -munix=@var{unix-std}
18150 @opindex march
18151 Generate compiler predefines and select a startfile for the specified
18152 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18153 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18154 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18155 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18156 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18157 and later.
18159 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18160 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18161 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18162 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18163 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18164 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18166 It is @emph{important} to note that this option changes the interfaces
18167 for various library routines.  It also affects the operational behavior
18168 of the C library.  Thus, @emph{extreme} care is needed in using this
18169 option.
18171 Library code that is intended to operate with more than one UNIX
18172 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18173 as appropriate.  Most GNU software doesn't provide this capability.
18175 @item -nolibdld
18176 @opindex nolibdld
18177 Suppress the generation of link options to search libdld.sl when the
18178 @option{-static} option is specified on HP-UX 10 and later.
18180 @item -static
18181 @opindex static
18182 The HP-UX implementation of setlocale in libc has a dependency on
18183 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18184 when the @option{-static} option is specified, special link options
18185 are needed to resolve this dependency.
18187 On HP-UX 10 and later, the GCC driver adds the necessary options to
18188 link with libdld.sl when the @option{-static} option is specified.
18189 This causes the resulting binary to be dynamic.  On the 64-bit port,
18190 the linkers generate dynamic binaries by default in any case.  The
18191 @option{-nolibdld} option can be used to prevent the GCC driver from
18192 adding these link options.
18194 @item -threads
18195 @opindex threads
18196 Add support for multithreading with the @dfn{dce thread} library
18197 under HP-UX@.  This option sets flags for both the preprocessor and
18198 linker.
18199 @end table
18201 @node IA-64 Options
18202 @subsection IA-64 Options
18203 @cindex IA-64 Options
18205 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18207 @table @gcctabopt
18208 @item -mbig-endian
18209 @opindex mbig-endian
18210 Generate code for a big-endian target.  This is the default for HP-UX@.
18212 @item -mlittle-endian
18213 @opindex mlittle-endian
18214 Generate code for a little-endian target.  This is the default for AIX5
18215 and GNU/Linux.
18217 @item -mgnu-as
18218 @itemx -mno-gnu-as
18219 @opindex mgnu-as
18220 @opindex mno-gnu-as
18221 Generate (or don't) code for the GNU assembler.  This is the default.
18222 @c Also, this is the default if the configure option @option{--with-gnu-as}
18223 @c is used.
18225 @item -mgnu-ld
18226 @itemx -mno-gnu-ld
18227 @opindex mgnu-ld
18228 @opindex mno-gnu-ld
18229 Generate (or don't) code for the GNU linker.  This is the default.
18230 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18231 @c is used.
18233 @item -mno-pic
18234 @opindex mno-pic
18235 Generate code that does not use a global pointer register.  The result
18236 is not position independent code, and violates the IA-64 ABI@.
18238 @item -mvolatile-asm-stop
18239 @itemx -mno-volatile-asm-stop
18240 @opindex mvolatile-asm-stop
18241 @opindex mno-volatile-asm-stop
18242 Generate (or don't) a stop bit immediately before and after volatile asm
18243 statements.
18245 @item -mregister-names
18246 @itemx -mno-register-names
18247 @opindex mregister-names
18248 @opindex mno-register-names
18249 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18250 the stacked registers.  This may make assembler output more readable.
18252 @item -mno-sdata
18253 @itemx -msdata
18254 @opindex mno-sdata
18255 @opindex msdata
18256 Disable (or enable) optimizations that use the small data section.  This may
18257 be useful for working around optimizer bugs.
18259 @item -mconstant-gp
18260 @opindex mconstant-gp
18261 Generate code that uses a single constant global pointer value.  This is
18262 useful when compiling kernel code.
18264 @item -mauto-pic
18265 @opindex mauto-pic
18266 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18267 This is useful when compiling firmware code.
18269 @item -minline-float-divide-min-latency
18270 @opindex minline-float-divide-min-latency
18271 Generate code for inline divides of floating-point values
18272 using the minimum latency algorithm.
18274 @item -minline-float-divide-max-throughput
18275 @opindex minline-float-divide-max-throughput
18276 Generate code for inline divides of floating-point values
18277 using the maximum throughput algorithm.
18279 @item -mno-inline-float-divide
18280 @opindex mno-inline-float-divide
18281 Do not generate inline code for divides of floating-point values.
18283 @item -minline-int-divide-min-latency
18284 @opindex minline-int-divide-min-latency
18285 Generate code for inline divides of integer values
18286 using the minimum latency algorithm.
18288 @item -minline-int-divide-max-throughput
18289 @opindex minline-int-divide-max-throughput
18290 Generate code for inline divides of integer values
18291 using the maximum throughput algorithm.
18293 @item -mno-inline-int-divide
18294 @opindex mno-inline-int-divide
18295 Do not generate inline code for divides of integer values.
18297 @item -minline-sqrt-min-latency
18298 @opindex minline-sqrt-min-latency
18299 Generate code for inline square roots
18300 using the minimum latency algorithm.
18302 @item -minline-sqrt-max-throughput
18303 @opindex minline-sqrt-max-throughput
18304 Generate code for inline square roots
18305 using the maximum throughput algorithm.
18307 @item -mno-inline-sqrt
18308 @opindex mno-inline-sqrt
18309 Do not generate inline code for @code{sqrt}.
18311 @item -mfused-madd
18312 @itemx -mno-fused-madd
18313 @opindex mfused-madd
18314 @opindex mno-fused-madd
18315 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18316 instructions.  The default is to use these instructions.
18318 @item -mno-dwarf2-asm
18319 @itemx -mdwarf2-asm
18320 @opindex mno-dwarf2-asm
18321 @opindex mdwarf2-asm
18322 Don't (or do) generate assembler code for the DWARF line number debugging
18323 info.  This may be useful when not using the GNU assembler.
18325 @item -mearly-stop-bits
18326 @itemx -mno-early-stop-bits
18327 @opindex mearly-stop-bits
18328 @opindex mno-early-stop-bits
18329 Allow stop bits to be placed earlier than immediately preceding the
18330 instruction that triggered the stop bit.  This can improve instruction
18331 scheduling, but does not always do so.
18333 @item -mfixed-range=@var{register-range}
18334 @opindex mfixed-range
18335 Generate code treating the given register range as fixed registers.
18336 A fixed register is one that the register allocator cannot use.  This is
18337 useful when compiling kernel code.  A register range is specified as
18338 two registers separated by a dash.  Multiple register ranges can be
18339 specified separated by a comma.
18341 @item -mtls-size=@var{tls-size}
18342 @opindex mtls-size
18343 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18346 @item -mtune=@var{cpu-type}
18347 @opindex mtune
18348 Tune the instruction scheduling for a particular CPU, Valid values are
18349 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18350 and @samp{mckinley}.
18352 @item -milp32
18353 @itemx -mlp64
18354 @opindex milp32
18355 @opindex mlp64
18356 Generate code for a 32-bit or 64-bit environment.
18357 The 32-bit environment sets int, long and pointer to 32 bits.
18358 The 64-bit environment sets int to 32 bits and long and pointer
18359 to 64 bits.  These are HP-UX specific flags.
18361 @item -mno-sched-br-data-spec
18362 @itemx -msched-br-data-spec
18363 @opindex mno-sched-br-data-spec
18364 @opindex msched-br-data-spec
18365 (Dis/En)able data speculative scheduling before reload.
18366 This results in generation of @code{ld.a} instructions and
18367 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18368 The default setting is disabled.
18370 @item -msched-ar-data-spec
18371 @itemx -mno-sched-ar-data-spec
18372 @opindex msched-ar-data-spec
18373 @opindex mno-sched-ar-data-spec
18374 (En/Dis)able data speculative scheduling after reload.
18375 This results in generation of @code{ld.a} instructions and
18376 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18377 The default setting is enabled.
18379 @item -mno-sched-control-spec
18380 @itemx -msched-control-spec
18381 @opindex mno-sched-control-spec
18382 @opindex msched-control-spec
18383 (Dis/En)able control speculative scheduling.  This feature is
18384 available only during region scheduling (i.e.@: before reload).
18385 This results in generation of the @code{ld.s} instructions and
18386 the corresponding check instructions @code{chk.s}.
18387 The default setting is disabled.
18389 @item -msched-br-in-data-spec
18390 @itemx -mno-sched-br-in-data-spec
18391 @opindex msched-br-in-data-spec
18392 @opindex mno-sched-br-in-data-spec
18393 (En/Dis)able speculative scheduling of the instructions that
18394 are dependent on the data speculative loads before reload.
18395 This is effective only with @option{-msched-br-data-spec} enabled.
18396 The default setting is enabled.
18398 @item -msched-ar-in-data-spec
18399 @itemx -mno-sched-ar-in-data-spec
18400 @opindex msched-ar-in-data-spec
18401 @opindex mno-sched-ar-in-data-spec
18402 (En/Dis)able speculative scheduling of the instructions that
18403 are dependent on the data speculative loads after reload.
18404 This is effective only with @option{-msched-ar-data-spec} enabled.
18405 The default setting is enabled.
18407 @item -msched-in-control-spec
18408 @itemx -mno-sched-in-control-spec
18409 @opindex msched-in-control-spec
18410 @opindex mno-sched-in-control-spec
18411 (En/Dis)able speculative scheduling of the instructions that
18412 are dependent on the control speculative loads.
18413 This is effective only with @option{-msched-control-spec} enabled.
18414 The default setting is enabled.
18416 @item -mno-sched-prefer-non-data-spec-insns
18417 @itemx -msched-prefer-non-data-spec-insns
18418 @opindex mno-sched-prefer-non-data-spec-insns
18419 @opindex msched-prefer-non-data-spec-insns
18420 If enabled, data-speculative instructions are chosen for schedule
18421 only if there are no other choices at the moment.  This makes
18422 the use of the data speculation much more conservative.
18423 The default setting is disabled.
18425 @item -mno-sched-prefer-non-control-spec-insns
18426 @itemx -msched-prefer-non-control-spec-insns
18427 @opindex mno-sched-prefer-non-control-spec-insns
18428 @opindex msched-prefer-non-control-spec-insns
18429 If enabled, control-speculative instructions are chosen for schedule
18430 only if there are no other choices at the moment.  This makes
18431 the use of the control speculation much more conservative.
18432 The default setting is disabled.
18434 @item -mno-sched-count-spec-in-critical-path
18435 @itemx -msched-count-spec-in-critical-path
18436 @opindex mno-sched-count-spec-in-critical-path
18437 @opindex msched-count-spec-in-critical-path
18438 If enabled, speculative dependencies are considered during
18439 computation of the instructions priorities.  This makes the use of the
18440 speculation a bit more conservative.
18441 The default setting is disabled.
18443 @item -msched-spec-ldc
18444 @opindex msched-spec-ldc
18445 Use a simple data speculation check.  This option is on by default.
18447 @item -msched-control-spec-ldc
18448 @opindex msched-spec-ldc
18449 Use a simple check for control speculation.  This option is on by default.
18451 @item -msched-stop-bits-after-every-cycle
18452 @opindex msched-stop-bits-after-every-cycle
18453 Place a stop bit after every cycle when scheduling.  This option is on
18454 by default.
18456 @item -msched-fp-mem-deps-zero-cost
18457 @opindex msched-fp-mem-deps-zero-cost
18458 Assume that floating-point stores and loads are not likely to cause a conflict
18459 when placed into the same instruction group.  This option is disabled by
18460 default.
18462 @item -msel-sched-dont-check-control-spec
18463 @opindex msel-sched-dont-check-control-spec
18464 Generate checks for control speculation in selective scheduling.
18465 This flag is disabled by default.
18467 @item -msched-max-memory-insns=@var{max-insns}
18468 @opindex msched-max-memory-insns
18469 Limit on the number of memory insns per instruction group, giving lower
18470 priority to subsequent memory insns attempting to schedule in the same
18471 instruction group. Frequently useful to prevent cache bank conflicts.
18472 The default value is 1.
18474 @item -msched-max-memory-insns-hard-limit
18475 @opindex msched-max-memory-insns-hard-limit
18476 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18477 disallowing more than that number in an instruction group.
18478 Otherwise, the limit is ``soft'', meaning that non-memory operations
18479 are preferred when the limit is reached, but memory operations may still
18480 be scheduled.
18482 @end table
18484 @node LM32 Options
18485 @subsection LM32 Options
18486 @cindex LM32 options
18488 These @option{-m} options are defined for the LatticeMico32 architecture:
18490 @table @gcctabopt
18491 @item -mbarrel-shift-enabled
18492 @opindex mbarrel-shift-enabled
18493 Enable barrel-shift instructions.
18495 @item -mdivide-enabled
18496 @opindex mdivide-enabled
18497 Enable divide and modulus instructions.
18499 @item -mmultiply-enabled
18500 @opindex multiply-enabled
18501 Enable multiply instructions.
18503 @item -msign-extend-enabled
18504 @opindex msign-extend-enabled
18505 Enable sign extend instructions.
18507 @item -muser-enabled
18508 @opindex muser-enabled
18509 Enable user-defined instructions.
18511 @end table
18513 @node M32C Options
18514 @subsection M32C Options
18515 @cindex M32C options
18517 @table @gcctabopt
18518 @item -mcpu=@var{name}
18519 @opindex mcpu=
18520 Select the CPU for which code is generated.  @var{name} may be one of
18521 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18522 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18523 the M32C/80 series.
18525 @item -msim
18526 @opindex msim
18527 Specifies that the program will be run on the simulator.  This causes
18528 an alternate runtime library to be linked in which supports, for
18529 example, file I/O@.  You must not use this option when generating
18530 programs that will run on real hardware; you must provide your own
18531 runtime library for whatever I/O functions are needed.
18533 @item -memregs=@var{number}
18534 @opindex memregs=
18535 Specifies the number of memory-based pseudo-registers GCC uses
18536 during code generation.  These pseudo-registers are used like real
18537 registers, so there is a tradeoff between GCC's ability to fit the
18538 code into available registers, and the performance penalty of using
18539 memory instead of registers.  Note that all modules in a program must
18540 be compiled with the same value for this option.  Because of that, you
18541 must not use this option with GCC's default runtime libraries.
18543 @end table
18545 @node M32R/D Options
18546 @subsection M32R/D Options
18547 @cindex M32R/D options
18549 These @option{-m} options are defined for Renesas M32R/D architectures:
18551 @table @gcctabopt
18552 @item -m32r2
18553 @opindex m32r2
18554 Generate code for the M32R/2@.
18556 @item -m32rx
18557 @opindex m32rx
18558 Generate code for the M32R/X@.
18560 @item -m32r
18561 @opindex m32r
18562 Generate code for the M32R@.  This is the default.
18564 @item -mmodel=small
18565 @opindex mmodel=small
18566 Assume all objects live in the lower 16MB of memory (so that their addresses
18567 can be loaded with the @code{ld24} instruction), and assume all subroutines
18568 are reachable with the @code{bl} instruction.
18569 This is the default.
18571 The addressability of a particular object can be set with the
18572 @code{model} attribute.
18574 @item -mmodel=medium
18575 @opindex mmodel=medium
18576 Assume objects may be anywhere in the 32-bit address space (the compiler
18577 generates @code{seth/add3} instructions to load their addresses), and
18578 assume all subroutines are reachable with the @code{bl} instruction.
18580 @item -mmodel=large
18581 @opindex mmodel=large
18582 Assume objects may be anywhere in the 32-bit address space (the compiler
18583 generates @code{seth/add3} instructions to load their addresses), and
18584 assume subroutines may not be reachable with the @code{bl} instruction
18585 (the compiler generates the much slower @code{seth/add3/jl}
18586 instruction sequence).
18588 @item -msdata=none
18589 @opindex msdata=none
18590 Disable use of the small data area.  Variables are put into
18591 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18592 @code{section} attribute has been specified).
18593 This is the default.
18595 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18596 Objects may be explicitly put in the small data area with the
18597 @code{section} attribute using one of these sections.
18599 @item -msdata=sdata
18600 @opindex msdata=sdata
18601 Put small global and static data in the small data area, but do not
18602 generate special code to reference them.
18604 @item -msdata=use
18605 @opindex msdata=use
18606 Put small global and static data in the small data area, and generate
18607 special instructions to reference them.
18609 @item -G @var{num}
18610 @opindex G
18611 @cindex smaller data references
18612 Put global and static objects less than or equal to @var{num} bytes
18613 into the small data or BSS sections instead of the normal data or BSS
18614 sections.  The default value of @var{num} is 8.
18615 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18616 for this option to have any effect.
18618 All modules should be compiled with the same @option{-G @var{num}} value.
18619 Compiling with different values of @var{num} may or may not work; if it
18620 doesn't the linker gives an error message---incorrect code is not
18621 generated.
18623 @item -mdebug
18624 @opindex mdebug
18625 Makes the M32R-specific code in the compiler display some statistics
18626 that might help in debugging programs.
18628 @item -malign-loops
18629 @opindex malign-loops
18630 Align all loops to a 32-byte boundary.
18632 @item -mno-align-loops
18633 @opindex mno-align-loops
18634 Do not enforce a 32-byte alignment for loops.  This is the default.
18636 @item -missue-rate=@var{number}
18637 @opindex missue-rate=@var{number}
18638 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18639 or 2.
18641 @item -mbranch-cost=@var{number}
18642 @opindex mbranch-cost=@var{number}
18643 @var{number} can only be 1 or 2.  If it is 1 then branches are
18644 preferred over conditional code, if it is 2, then the opposite applies.
18646 @item -mflush-trap=@var{number}
18647 @opindex mflush-trap=@var{number}
18648 Specifies the trap number to use to flush the cache.  The default is
18649 12.  Valid numbers are between 0 and 15 inclusive.
18651 @item -mno-flush-trap
18652 @opindex mno-flush-trap
18653 Specifies that the cache cannot be flushed by using a trap.
18655 @item -mflush-func=@var{name}
18656 @opindex mflush-func=@var{name}
18657 Specifies the name of the operating system function to call to flush
18658 the cache.  The default is @samp{_flush_cache}, but a function call
18659 is only used if a trap is not available.
18661 @item -mno-flush-func
18662 @opindex mno-flush-func
18663 Indicates that there is no OS function for flushing the cache.
18665 @end table
18667 @node M680x0 Options
18668 @subsection M680x0 Options
18669 @cindex M680x0 options
18671 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18672 The default settings depend on which architecture was selected when
18673 the compiler was configured; the defaults for the most common choices
18674 are given below.
18676 @table @gcctabopt
18677 @item -march=@var{arch}
18678 @opindex march
18679 Generate code for a specific M680x0 or ColdFire instruction set
18680 architecture.  Permissible values of @var{arch} for M680x0
18681 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18682 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18683 architectures are selected according to Freescale's ISA classification
18684 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18685 @samp{isab} and @samp{isac}.
18687 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18688 code for a ColdFire target.  The @var{arch} in this macro is one of the
18689 @option{-march} arguments given above.
18691 When used together, @option{-march} and @option{-mtune} select code
18692 that runs on a family of similar processors but that is optimized
18693 for a particular microarchitecture.
18695 @item -mcpu=@var{cpu}
18696 @opindex mcpu
18697 Generate code for a specific M680x0 or ColdFire processor.
18698 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18699 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18700 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18701 below, which also classifies the CPUs into families:
18703 @multitable @columnfractions 0.20 0.80
18704 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18705 @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}
18706 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18707 @item @samp{5206e} @tab @samp{5206e}
18708 @item @samp{5208} @tab @samp{5207} @samp{5208}
18709 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18710 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18711 @item @samp{5216} @tab @samp{5214} @samp{5216}
18712 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18713 @item @samp{5225} @tab @samp{5224} @samp{5225}
18714 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18715 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18716 @item @samp{5249} @tab @samp{5249}
18717 @item @samp{5250} @tab @samp{5250}
18718 @item @samp{5271} @tab @samp{5270} @samp{5271}
18719 @item @samp{5272} @tab @samp{5272}
18720 @item @samp{5275} @tab @samp{5274} @samp{5275}
18721 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18722 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18723 @item @samp{5307} @tab @samp{5307}
18724 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18725 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18726 @item @samp{5407} @tab @samp{5407}
18727 @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}
18728 @end multitable
18730 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18731 @var{arch} is compatible with @var{cpu}.  Other combinations of
18732 @option{-mcpu} and @option{-march} are rejected.
18734 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18735 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18736 where the value of @var{family} is given by the table above.
18738 @item -mtune=@var{tune}
18739 @opindex mtune
18740 Tune the code for a particular microarchitecture within the
18741 constraints set by @option{-march} and @option{-mcpu}.
18742 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18743 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18744 and @samp{cpu32}.  The ColdFire microarchitectures
18745 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18747 You can also use @option{-mtune=68020-40} for code that needs
18748 to run relatively well on 68020, 68030 and 68040 targets.
18749 @option{-mtune=68020-60} is similar but includes 68060 targets
18750 as well.  These two options select the same tuning decisions as
18751 @option{-m68020-40} and @option{-m68020-60} respectively.
18753 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18754 when tuning for 680x0 architecture @var{arch}.  It also defines
18755 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18756 option is used.  If GCC is tuning for a range of architectures,
18757 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18758 it defines the macros for every architecture in the range.
18760 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18761 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18762 of the arguments given above.
18764 @item -m68000
18765 @itemx -mc68000
18766 @opindex m68000
18767 @opindex mc68000
18768 Generate output for a 68000.  This is the default
18769 when the compiler is configured for 68000-based systems.
18770 It is equivalent to @option{-march=68000}.
18772 Use this option for microcontrollers with a 68000 or EC000 core,
18773 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18775 @item -m68010
18776 @opindex m68010
18777 Generate output for a 68010.  This is the default
18778 when the compiler is configured for 68010-based systems.
18779 It is equivalent to @option{-march=68010}.
18781 @item -m68020
18782 @itemx -mc68020
18783 @opindex m68020
18784 @opindex mc68020
18785 Generate output for a 68020.  This is the default
18786 when the compiler is configured for 68020-based systems.
18787 It is equivalent to @option{-march=68020}.
18789 @item -m68030
18790 @opindex m68030
18791 Generate output for a 68030.  This is the default when the compiler is
18792 configured for 68030-based systems.  It is equivalent to
18793 @option{-march=68030}.
18795 @item -m68040
18796 @opindex m68040
18797 Generate output for a 68040.  This is the default when the compiler is
18798 configured for 68040-based systems.  It is equivalent to
18799 @option{-march=68040}.
18801 This option inhibits the use of 68881/68882 instructions that have to be
18802 emulated by software on the 68040.  Use this option if your 68040 does not
18803 have code to emulate those instructions.
18805 @item -m68060
18806 @opindex m68060
18807 Generate output for a 68060.  This is the default when the compiler is
18808 configured for 68060-based systems.  It is equivalent to
18809 @option{-march=68060}.
18811 This option inhibits the use of 68020 and 68881/68882 instructions that
18812 have to be emulated by software on the 68060.  Use this option if your 68060
18813 does not have code to emulate those instructions.
18815 @item -mcpu32
18816 @opindex mcpu32
18817 Generate output for a CPU32.  This is the default
18818 when the compiler is configured for CPU32-based systems.
18819 It is equivalent to @option{-march=cpu32}.
18821 Use this option for microcontrollers with a
18822 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18823 68336, 68340, 68341, 68349 and 68360.
18825 @item -m5200
18826 @opindex m5200
18827 Generate output for a 520X ColdFire CPU@.  This is the default
18828 when the compiler is configured for 520X-based systems.
18829 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18830 in favor of that option.
18832 Use this option for microcontroller with a 5200 core, including
18833 the MCF5202, MCF5203, MCF5204 and MCF5206.
18835 @item -m5206e
18836 @opindex m5206e
18837 Generate output for a 5206e ColdFire CPU@.  The option is now
18838 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18840 @item -m528x
18841 @opindex m528x
18842 Generate output for a member of the ColdFire 528X family.
18843 The option is now deprecated in favor of the equivalent
18844 @option{-mcpu=528x}.
18846 @item -m5307
18847 @opindex m5307
18848 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18849 in favor of the equivalent @option{-mcpu=5307}.
18851 @item -m5407
18852 @opindex m5407
18853 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18854 in favor of the equivalent @option{-mcpu=5407}.
18856 @item -mcfv4e
18857 @opindex mcfv4e
18858 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18859 This includes use of hardware floating-point instructions.
18860 The option is equivalent to @option{-mcpu=547x}, and is now
18861 deprecated in favor of that option.
18863 @item -m68020-40
18864 @opindex m68020-40
18865 Generate output for a 68040, without using any of the new instructions.
18866 This results in code that can run relatively efficiently on either a
18867 68020/68881 or a 68030 or a 68040.  The generated code does use the
18868 68881 instructions that are emulated on the 68040.
18870 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18872 @item -m68020-60
18873 @opindex m68020-60
18874 Generate output for a 68060, without using any of the new instructions.
18875 This results in code that can run relatively efficiently on either a
18876 68020/68881 or a 68030 or a 68040.  The generated code does use the
18877 68881 instructions that are emulated on the 68060.
18879 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18881 @item -mhard-float
18882 @itemx -m68881
18883 @opindex mhard-float
18884 @opindex m68881
18885 Generate floating-point instructions.  This is the default for 68020
18886 and above, and for ColdFire devices that have an FPU@.  It defines the
18887 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18888 on ColdFire targets.
18890 @item -msoft-float
18891 @opindex msoft-float
18892 Do not generate floating-point instructions; use library calls instead.
18893 This is the default for 68000, 68010, and 68832 targets.  It is also
18894 the default for ColdFire devices that have no FPU.
18896 @item -mdiv
18897 @itemx -mno-div
18898 @opindex mdiv
18899 @opindex mno-div
18900 Generate (do not generate) ColdFire hardware divide and remainder
18901 instructions.  If @option{-march} is used without @option{-mcpu},
18902 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18903 architectures.  Otherwise, the default is taken from the target CPU
18904 (either the default CPU, or the one specified by @option{-mcpu}).  For
18905 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18906 @option{-mcpu=5206e}.
18908 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18910 @item -mshort
18911 @opindex mshort
18912 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18913 Additionally, parameters passed on the stack are also aligned to a
18914 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18916 @item -mno-short
18917 @opindex mno-short
18918 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18920 @item -mnobitfield
18921 @itemx -mno-bitfield
18922 @opindex mnobitfield
18923 @opindex mno-bitfield
18924 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18925 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18927 @item -mbitfield
18928 @opindex mbitfield
18929 Do use the bit-field instructions.  The @option{-m68020} option implies
18930 @option{-mbitfield}.  This is the default if you use a configuration
18931 designed for a 68020.
18933 @item -mrtd
18934 @opindex mrtd
18935 Use a different function-calling convention, in which functions
18936 that take a fixed number of arguments return with the @code{rtd}
18937 instruction, which pops their arguments while returning.  This
18938 saves one instruction in the caller since there is no need to pop
18939 the arguments there.
18941 This calling convention is incompatible with the one normally
18942 used on Unix, so you cannot use it if you need to call libraries
18943 compiled with the Unix compiler.
18945 Also, you must provide function prototypes for all functions that
18946 take variable numbers of arguments (including @code{printf});
18947 otherwise incorrect code is generated for calls to those
18948 functions.
18950 In addition, seriously incorrect code results if you call a
18951 function with too many arguments.  (Normally, extra arguments are
18952 harmlessly ignored.)
18954 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18955 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18957 @item -mno-rtd
18958 @opindex mno-rtd
18959 Do not use the calling conventions selected by @option{-mrtd}.
18960 This is the default.
18962 @item -malign-int
18963 @itemx -mno-align-int
18964 @opindex malign-int
18965 @opindex mno-align-int
18966 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18967 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18968 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18969 Aligning variables on 32-bit boundaries produces code that runs somewhat
18970 faster on processors with 32-bit busses at the expense of more memory.
18972 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18973 aligns structures containing the above types differently than
18974 most published application binary interface specifications for the m68k.
18976 @item -mpcrel
18977 @opindex mpcrel
18978 Use the pc-relative addressing mode of the 68000 directly, instead of
18979 using a global offset table.  At present, this option implies @option{-fpic},
18980 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18981 not presently supported with @option{-mpcrel}, though this could be supported for
18982 68020 and higher processors.
18984 @item -mno-strict-align
18985 @itemx -mstrict-align
18986 @opindex mno-strict-align
18987 @opindex mstrict-align
18988 Do not (do) assume that unaligned memory references are handled by
18989 the system.
18991 @item -msep-data
18992 Generate code that allows the data segment to be located in a different
18993 area of memory from the text segment.  This allows for execute-in-place in
18994 an environment without virtual memory management.  This option implies
18995 @option{-fPIC}.
18997 @item -mno-sep-data
18998 Generate code that assumes that the data segment follows the text segment.
18999 This is the default.
19001 @item -mid-shared-library
19002 Generate code that supports shared libraries via the library ID method.
19003 This allows for execute-in-place and shared libraries in an environment
19004 without virtual memory management.  This option implies @option{-fPIC}.
19006 @item -mno-id-shared-library
19007 Generate code that doesn't assume ID-based shared libraries are being used.
19008 This is the default.
19010 @item -mshared-library-id=n
19011 Specifies the identification number of the ID-based shared library being
19012 compiled.  Specifying a value of 0 generates more compact code; specifying
19013 other values forces the allocation of that number to the current
19014 library, but is no more space- or time-efficient than omitting this option.
19016 @item -mxgot
19017 @itemx -mno-xgot
19018 @opindex mxgot
19019 @opindex mno-xgot
19020 When generating position-independent code for ColdFire, generate code
19021 that works if the GOT has more than 8192 entries.  This code is
19022 larger and slower than code generated without this option.  On M680x0
19023 processors, this option is not needed; @option{-fPIC} suffices.
19025 GCC normally uses a single instruction to load values from the GOT@.
19026 While this is relatively efficient, it only works if the GOT
19027 is smaller than about 64k.  Anything larger causes the linker
19028 to report an error such as:
19030 @cindex relocation truncated to fit (ColdFire)
19031 @smallexample
19032 relocation truncated to fit: R_68K_GOT16O foobar
19033 @end smallexample
19035 If this happens, you should recompile your code with @option{-mxgot}.
19036 It should then work with very large GOTs.  However, code generated with
19037 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19038 the value of a global symbol.
19040 Note that some linkers, including newer versions of the GNU linker,
19041 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19042 you should only need to use @option{-mxgot} when compiling a single
19043 object file that accesses more than 8192 GOT entries.  Very few do.
19045 These options have no effect unless GCC is generating
19046 position-independent code.
19048 @item -mlong-jump-table-offsets
19049 @opindex mlong-jump-table-offsets
19050 Use 32-bit offsets in @code{switch} tables.  The default is to use
19051 16-bit offsets.
19053 @end table
19055 @node MCore Options
19056 @subsection MCore Options
19057 @cindex MCore options
19059 These are the @samp{-m} options defined for the Motorola M*Core
19060 processors.
19062 @table @gcctabopt
19064 @item -mhardlit
19065 @itemx -mno-hardlit
19066 @opindex mhardlit
19067 @opindex mno-hardlit
19068 Inline constants into the code stream if it can be done in two
19069 instructions or less.
19071 @item -mdiv
19072 @itemx -mno-div
19073 @opindex mdiv
19074 @opindex mno-div
19075 Use the divide instruction.  (Enabled by default).
19077 @item -mrelax-immediate
19078 @itemx -mno-relax-immediate
19079 @opindex mrelax-immediate
19080 @opindex mno-relax-immediate
19081 Allow arbitrary-sized immediates in bit operations.
19083 @item -mwide-bitfields
19084 @itemx -mno-wide-bitfields
19085 @opindex mwide-bitfields
19086 @opindex mno-wide-bitfields
19087 Always treat bit-fields as @code{int}-sized.
19089 @item -m4byte-functions
19090 @itemx -mno-4byte-functions
19091 @opindex m4byte-functions
19092 @opindex mno-4byte-functions
19093 Force all functions to be aligned to a 4-byte boundary.
19095 @item -mcallgraph-data
19096 @itemx -mno-callgraph-data
19097 @opindex mcallgraph-data
19098 @opindex mno-callgraph-data
19099 Emit callgraph information.
19101 @item -mslow-bytes
19102 @itemx -mno-slow-bytes
19103 @opindex mslow-bytes
19104 @opindex mno-slow-bytes
19105 Prefer word access when reading byte quantities.
19107 @item -mlittle-endian
19108 @itemx -mbig-endian
19109 @opindex mlittle-endian
19110 @opindex mbig-endian
19111 Generate code for a little-endian target.
19113 @item -m210
19114 @itemx -m340
19115 @opindex m210
19116 @opindex m340
19117 Generate code for the 210 processor.
19119 @item -mno-lsim
19120 @opindex mno-lsim
19121 Assume that runtime support has been provided and so omit the
19122 simulator library (@file{libsim.a)} from the linker command line.
19124 @item -mstack-increment=@var{size}
19125 @opindex mstack-increment
19126 Set the maximum amount for a single stack increment operation.  Large
19127 values can increase the speed of programs that contain functions
19128 that need a large amount of stack space, but they can also trigger a
19129 segmentation fault if the stack is extended too much.  The default
19130 value is 0x1000.
19132 @end table
19134 @node MeP Options
19135 @subsection MeP Options
19136 @cindex MeP options
19138 @table @gcctabopt
19140 @item -mabsdiff
19141 @opindex mabsdiff
19142 Enables the @code{abs} instruction, which is the absolute difference
19143 between two registers.
19145 @item -mall-opts
19146 @opindex mall-opts
19147 Enables all the optional instructions---average, multiply, divide, bit
19148 operations, leading zero, absolute difference, min/max, clip, and
19149 saturation.
19152 @item -maverage
19153 @opindex maverage
19154 Enables the @code{ave} instruction, which computes the average of two
19155 registers.
19157 @item -mbased=@var{n}
19158 @opindex mbased=
19159 Variables of size @var{n} bytes or smaller are placed in the
19160 @code{.based} section by default.  Based variables use the @code{$tp}
19161 register as a base register, and there is a 128-byte limit to the
19162 @code{.based} section.
19164 @item -mbitops
19165 @opindex mbitops
19166 Enables the bit operation instructions---bit test (@code{btstm}), set
19167 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19168 test-and-set (@code{tas}).
19170 @item -mc=@var{name}
19171 @opindex mc=
19172 Selects which section constant data is placed in.  @var{name} may
19173 be @samp{tiny}, @samp{near}, or @samp{far}.
19175 @item -mclip
19176 @opindex mclip
19177 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19178 useful unless you also provide @option{-mminmax}.
19180 @item -mconfig=@var{name}
19181 @opindex mconfig=
19182 Selects one of the built-in core configurations.  Each MeP chip has
19183 one or more modules in it; each module has a core CPU and a variety of
19184 coprocessors, optional instructions, and peripherals.  The
19185 @code{MeP-Integrator} tool, not part of GCC, provides these
19186 configurations through this option; using this option is the same as
19187 using all the corresponding command-line options.  The default
19188 configuration is @samp{default}.
19190 @item -mcop
19191 @opindex mcop
19192 Enables the coprocessor instructions.  By default, this is a 32-bit
19193 coprocessor.  Note that the coprocessor is normally enabled via the
19194 @option{-mconfig=} option.
19196 @item -mcop32
19197 @opindex mcop32
19198 Enables the 32-bit coprocessor's instructions.
19200 @item -mcop64
19201 @opindex mcop64
19202 Enables the 64-bit coprocessor's instructions.
19204 @item -mivc2
19205 @opindex mivc2
19206 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19208 @item -mdc
19209 @opindex mdc
19210 Causes constant variables to be placed in the @code{.near} section.
19212 @item -mdiv
19213 @opindex mdiv
19214 Enables the @code{div} and @code{divu} instructions.
19216 @item -meb
19217 @opindex meb
19218 Generate big-endian code.
19220 @item -mel
19221 @opindex mel
19222 Generate little-endian code.
19224 @item -mio-volatile
19225 @opindex mio-volatile
19226 Tells the compiler that any variable marked with the @code{io}
19227 attribute is to be considered volatile.
19229 @item -ml
19230 @opindex ml
19231 Causes variables to be assigned to the @code{.far} section by default.
19233 @item -mleadz
19234 @opindex mleadz
19235 Enables the @code{leadz} (leading zero) instruction.
19237 @item -mm
19238 @opindex mm
19239 Causes variables to be assigned to the @code{.near} section by default.
19241 @item -mminmax
19242 @opindex mminmax
19243 Enables the @code{min} and @code{max} instructions.
19245 @item -mmult
19246 @opindex mmult
19247 Enables the multiplication and multiply-accumulate instructions.
19249 @item -mno-opts
19250 @opindex mno-opts
19251 Disables all the optional instructions enabled by @option{-mall-opts}.
19253 @item -mrepeat
19254 @opindex mrepeat
19255 Enables the @code{repeat} and @code{erepeat} instructions, used for
19256 low-overhead looping.
19258 @item -ms
19259 @opindex ms
19260 Causes all variables to default to the @code{.tiny} section.  Note
19261 that there is a 65536-byte limit to this section.  Accesses to these
19262 variables use the @code{%gp} base register.
19264 @item -msatur
19265 @opindex msatur
19266 Enables the saturation instructions.  Note that the compiler does not
19267 currently generate these itself, but this option is included for
19268 compatibility with other tools, like @code{as}.
19270 @item -msdram
19271 @opindex msdram
19272 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19274 @item -msim
19275 @opindex msim
19276 Link the simulator run-time libraries.
19278 @item -msimnovec
19279 @opindex msimnovec
19280 Link the simulator runtime libraries, excluding built-in support
19281 for reset and exception vectors and tables.
19283 @item -mtf
19284 @opindex mtf
19285 Causes all functions to default to the @code{.far} section.  Without
19286 this option, functions default to the @code{.near} section.
19288 @item -mtiny=@var{n}
19289 @opindex mtiny=
19290 Variables that are @var{n} bytes or smaller are allocated to the
19291 @code{.tiny} section.  These variables use the @code{$gp} base
19292 register.  The default for this option is 4, but note that there's a
19293 65536-byte limit to the @code{.tiny} section.
19295 @end table
19297 @node MicroBlaze Options
19298 @subsection MicroBlaze Options
19299 @cindex MicroBlaze Options
19301 @table @gcctabopt
19303 @item -msoft-float
19304 @opindex msoft-float
19305 Use software emulation for floating point (default).
19307 @item -mhard-float
19308 @opindex mhard-float
19309 Use hardware floating-point instructions.
19311 @item -mmemcpy
19312 @opindex mmemcpy
19313 Do not optimize block moves, use @code{memcpy}.
19315 @item -mno-clearbss
19316 @opindex mno-clearbss
19317 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19319 @item -mcpu=@var{cpu-type}
19320 @opindex mcpu=
19321 Use features of, and schedule code for, the given CPU.
19322 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19323 where @var{X} is a major version, @var{YY} is the minor version, and
19324 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19325 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19327 @item -mxl-soft-mul
19328 @opindex mxl-soft-mul
19329 Use software multiply emulation (default).
19331 @item -mxl-soft-div
19332 @opindex mxl-soft-div
19333 Use software emulation for divides (default).
19335 @item -mxl-barrel-shift
19336 @opindex mxl-barrel-shift
19337 Use the hardware barrel shifter.
19339 @item -mxl-pattern-compare
19340 @opindex mxl-pattern-compare
19341 Use pattern compare instructions.
19343 @item -msmall-divides
19344 @opindex msmall-divides
19345 Use table lookup optimization for small signed integer divisions.
19347 @item -mxl-stack-check
19348 @opindex mxl-stack-check
19349 This option is deprecated.  Use @option{-fstack-check} instead.
19351 @item -mxl-gp-opt
19352 @opindex mxl-gp-opt
19353 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19355 @item -mxl-multiply-high
19356 @opindex mxl-multiply-high
19357 Use multiply high instructions for high part of 32x32 multiply.
19359 @item -mxl-float-convert
19360 @opindex mxl-float-convert
19361 Use hardware floating-point conversion instructions.
19363 @item -mxl-float-sqrt
19364 @opindex mxl-float-sqrt
19365 Use hardware floating-point square root instruction.
19367 @item -mbig-endian
19368 @opindex mbig-endian
19369 Generate code for a big-endian target.
19371 @item -mlittle-endian
19372 @opindex mlittle-endian
19373 Generate code for a little-endian target.
19375 @item -mxl-reorder
19376 @opindex mxl-reorder
19377 Use reorder instructions (swap and byte reversed load/store).
19379 @item -mxl-mode-@var{app-model}
19380 Select application model @var{app-model}.  Valid models are
19381 @table @samp
19382 @item executable
19383 normal executable (default), uses startup code @file{crt0.o}.
19385 @item xmdstub
19386 for use with Xilinx Microprocessor Debugger (XMD) based
19387 software intrusive debug agent called xmdstub. This uses startup file
19388 @file{crt1.o} and sets the start address of the program to 0x800.
19390 @item bootstrap
19391 for applications that are loaded using a bootloader.
19392 This model uses startup file @file{crt2.o} which does not contain a processor
19393 reset vector handler. This is suitable for transferring control on a
19394 processor reset to the bootloader rather than the application.
19396 @item novectors
19397 for applications that do not require any of the
19398 MicroBlaze vectors. This option may be useful for applications running
19399 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19400 @end table
19402 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19403 @option{-mxl-mode-@var{app-model}}.
19405 @end table
19407 @node MIPS Options
19408 @subsection MIPS Options
19409 @cindex MIPS options
19411 @table @gcctabopt
19413 @item -EB
19414 @opindex EB
19415 Generate big-endian code.
19417 @item -EL
19418 @opindex EL
19419 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19420 configurations.
19422 @item -march=@var{arch}
19423 @opindex march
19424 Generate code that runs on @var{arch}, which can be the name of a
19425 generic MIPS ISA, or the name of a particular processor.
19426 The ISA names are:
19427 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19428 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19429 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19430 @samp{mips64r5} and @samp{mips64r6}.
19431 The processor names are:
19432 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19433 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19434 @samp{5kc}, @samp{5kf},
19435 @samp{20kc},
19436 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19437 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19438 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19439 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19440 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19441 @samp{i6400},
19442 @samp{interaptiv},
19443 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19444 @samp{m4k},
19445 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19446 @samp{m5100}, @samp{m5101},
19447 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19448 @samp{orion},
19449 @samp{p5600},
19450 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19451 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19452 @samp{rm7000}, @samp{rm9000},
19453 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19454 @samp{sb1},
19455 @samp{sr71000},
19456 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19457 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19458 @samp{xlr} and @samp{xlp}.
19459 The special value @samp{from-abi} selects the
19460 most compatible architecture for the selected ABI (that is,
19461 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19463 The native Linux/GNU toolchain also supports the value @samp{native},
19464 which selects the best architecture option for the host processor.
19465 @option{-march=native} has no effect if GCC does not recognize
19466 the processor.
19468 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19469 (for example, @option{-march=r2k}).  Prefixes are optional, and
19470 @samp{vr} may be written @samp{r}.
19472 Names of the form @samp{@var{n}f2_1} refer to processors with
19473 FPUs clocked at half the rate of the core, names of the form
19474 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19475 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19476 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19477 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19478 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19479 accepted as synonyms for @samp{@var{n}f1_1}.
19481 GCC defines two macros based on the value of this option.  The first
19482 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19483 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19484 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19485 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19486 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19488 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19489 above.  In other words, it has the full prefix and does not
19490 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19491 the macro names the resolved architecture (either @code{"mips1"} or
19492 @code{"mips3"}).  It names the default architecture when no
19493 @option{-march} option is given.
19495 @item -mtune=@var{arch}
19496 @opindex mtune
19497 Optimize for @var{arch}.  Among other things, this option controls
19498 the way instructions are scheduled, and the perceived cost of arithmetic
19499 operations.  The list of @var{arch} values is the same as for
19500 @option{-march}.
19502 When this option is not used, GCC optimizes for the processor
19503 specified by @option{-march}.  By using @option{-march} and
19504 @option{-mtune} together, it is possible to generate code that
19505 runs on a family of processors, but optimize the code for one
19506 particular member of that family.
19508 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19509 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19510 @option{-march} ones described above.
19512 @item -mips1
19513 @opindex mips1
19514 Equivalent to @option{-march=mips1}.
19516 @item -mips2
19517 @opindex mips2
19518 Equivalent to @option{-march=mips2}.
19520 @item -mips3
19521 @opindex mips3
19522 Equivalent to @option{-march=mips3}.
19524 @item -mips4
19525 @opindex mips4
19526 Equivalent to @option{-march=mips4}.
19528 @item -mips32
19529 @opindex mips32
19530 Equivalent to @option{-march=mips32}.
19532 @item -mips32r3
19533 @opindex mips32r3
19534 Equivalent to @option{-march=mips32r3}.
19536 @item -mips32r5
19537 @opindex mips32r5
19538 Equivalent to @option{-march=mips32r5}.
19540 @item -mips32r6
19541 @opindex mips32r6
19542 Equivalent to @option{-march=mips32r6}.
19544 @item -mips64
19545 @opindex mips64
19546 Equivalent to @option{-march=mips64}.
19548 @item -mips64r2
19549 @opindex mips64r2
19550 Equivalent to @option{-march=mips64r2}.
19552 @item -mips64r3
19553 @opindex mips64r3
19554 Equivalent to @option{-march=mips64r3}.
19556 @item -mips64r5
19557 @opindex mips64r5
19558 Equivalent to @option{-march=mips64r5}.
19560 @item -mips64r6
19561 @opindex mips64r6
19562 Equivalent to @option{-march=mips64r6}.
19564 @item -mips16
19565 @itemx -mno-mips16
19566 @opindex mips16
19567 @opindex mno-mips16
19568 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19569 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19571 MIPS16 code generation can also be controlled on a per-function basis
19572 by means of @code{mips16} and @code{nomips16} attributes.
19573 @xref{Function Attributes}, for more information.
19575 @item -mflip-mips16
19576 @opindex mflip-mips16
19577 Generate MIPS16 code on alternating functions.  This option is provided
19578 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19579 not intended for ordinary use in compiling user code.
19581 @item -minterlink-compressed
19582 @item -mno-interlink-compressed
19583 @opindex minterlink-compressed
19584 @opindex mno-interlink-compressed
19585 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19586 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19588 For example, code using the standard ISA encoding cannot jump directly
19589 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19590 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19591 knows that the target of the jump is not compressed.
19593 @item -minterlink-mips16
19594 @itemx -mno-interlink-mips16
19595 @opindex minterlink-mips16
19596 @opindex mno-interlink-mips16
19597 Aliases of @option{-minterlink-compressed} and
19598 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19599 and are retained for backwards compatibility.
19601 @item -mabi=32
19602 @itemx -mabi=o64
19603 @itemx -mabi=n32
19604 @itemx -mabi=64
19605 @itemx -mabi=eabi
19606 @opindex mabi=32
19607 @opindex mabi=o64
19608 @opindex mabi=n32
19609 @opindex mabi=64
19610 @opindex mabi=eabi
19611 Generate code for the given ABI@.
19613 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19614 generates 64-bit code when you select a 64-bit architecture, but you
19615 can use @option{-mgp32} to get 32-bit code instead.
19617 For information about the O64 ABI, see
19618 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19620 GCC supports a variant of the o32 ABI in which floating-point registers
19621 are 64 rather than 32 bits wide.  You can select this combination with
19622 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19623 and @code{mfhc1} instructions and is therefore only supported for
19624 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19626 The register assignments for arguments and return values remain the
19627 same, but each scalar value is passed in a single 64-bit register
19628 rather than a pair of 32-bit registers.  For example, scalar
19629 floating-point values are returned in @samp{$f0} only, not a
19630 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19631 remains the same in that the even-numbered double-precision registers
19632 are saved.
19634 Two additional variants of the o32 ABI are supported to enable
19635 a transition from 32-bit to 64-bit registers.  These are FPXX
19636 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19637 The FPXX extension mandates that all code must execute correctly
19638 when run using 32-bit or 64-bit registers.  The code can be interlinked
19639 with either FP32 or FP64, but not both.
19640 The FP64A extension is similar to the FP64 extension but forbids the
19641 use of odd-numbered single-precision registers.  This can be used
19642 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19643 processors and allows both FP32 and FP64A code to interlink and
19644 run in the same process without changing FPU modes.
19646 @item -mabicalls
19647 @itemx -mno-abicalls
19648 @opindex mabicalls
19649 @opindex mno-abicalls
19650 Generate (do not generate) code that is suitable for SVR4-style
19651 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19652 systems.
19654 @item -mshared
19655 @itemx -mno-shared
19656 Generate (do not generate) code that is fully position-independent,
19657 and that can therefore be linked into shared libraries.  This option
19658 only affects @option{-mabicalls}.
19660 All @option{-mabicalls} code has traditionally been position-independent,
19661 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19662 as an extension, the GNU toolchain allows executables to use absolute
19663 accesses for locally-binding symbols.  It can also use shorter GP
19664 initialization sequences and generate direct calls to locally-defined
19665 functions.  This mode is selected by @option{-mno-shared}.
19667 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19668 objects that can only be linked by the GNU linker.  However, the option
19669 does not affect the ABI of the final executable; it only affects the ABI
19670 of relocatable objects.  Using @option{-mno-shared} generally makes
19671 executables both smaller and quicker.
19673 @option{-mshared} is the default.
19675 @item -mplt
19676 @itemx -mno-plt
19677 @opindex mplt
19678 @opindex mno-plt
19679 Assume (do not assume) that the static and dynamic linkers
19680 support PLTs and copy relocations.  This option only affects
19681 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19682 has no effect without @option{-msym32}.
19684 You can make @option{-mplt} the default by configuring
19685 GCC with @option{--with-mips-plt}.  The default is
19686 @option{-mno-plt} otherwise.
19688 @item -mxgot
19689 @itemx -mno-xgot
19690 @opindex mxgot
19691 @opindex mno-xgot
19692 Lift (do not lift) the usual restrictions on the size of the global
19693 offset table.
19695 GCC normally uses a single instruction to load values from the GOT@.
19696 While this is relatively efficient, it only works if the GOT
19697 is smaller than about 64k.  Anything larger causes the linker
19698 to report an error such as:
19700 @cindex relocation truncated to fit (MIPS)
19701 @smallexample
19702 relocation truncated to fit: R_MIPS_GOT16 foobar
19703 @end smallexample
19705 If this happens, you should recompile your code with @option{-mxgot}.
19706 This works with very large GOTs, although the code is also
19707 less efficient, since it takes three instructions to fetch the
19708 value of a global symbol.
19710 Note that some linkers can create multiple GOTs.  If you have such a
19711 linker, you should only need to use @option{-mxgot} when a single object
19712 file accesses more than 64k's worth of GOT entries.  Very few do.
19714 These options have no effect unless GCC is generating position
19715 independent code.
19717 @item -mgp32
19718 @opindex mgp32
19719 Assume that general-purpose registers are 32 bits wide.
19721 @item -mgp64
19722 @opindex mgp64
19723 Assume that general-purpose registers are 64 bits wide.
19725 @item -mfp32
19726 @opindex mfp32
19727 Assume that floating-point registers are 32 bits wide.
19729 @item -mfp64
19730 @opindex mfp64
19731 Assume that floating-point registers are 64 bits wide.
19733 @item -mfpxx
19734 @opindex mfpxx
19735 Do not assume the width of floating-point registers.
19737 @item -mhard-float
19738 @opindex mhard-float
19739 Use floating-point coprocessor instructions.
19741 @item -msoft-float
19742 @opindex msoft-float
19743 Do not use floating-point coprocessor instructions.  Implement
19744 floating-point calculations using library calls instead.
19746 @item -mno-float
19747 @opindex mno-float
19748 Equivalent to @option{-msoft-float}, but additionally asserts that the
19749 program being compiled does not perform any floating-point operations.
19750 This option is presently supported only by some bare-metal MIPS
19751 configurations, where it may select a special set of libraries
19752 that lack all floating-point support (including, for example, the
19753 floating-point @code{printf} formats).  
19754 If code compiled with @option{-mno-float} accidentally contains
19755 floating-point operations, it is likely to suffer a link-time
19756 or run-time failure.
19758 @item -msingle-float
19759 @opindex msingle-float
19760 Assume that the floating-point coprocessor only supports single-precision
19761 operations.
19763 @item -mdouble-float
19764 @opindex mdouble-float
19765 Assume that the floating-point coprocessor supports double-precision
19766 operations.  This is the default.
19768 @item -modd-spreg
19769 @itemx -mno-odd-spreg
19770 @opindex modd-spreg
19771 @opindex mno-odd-spreg
19772 Enable the use of odd-numbered single-precision floating-point registers
19773 for the o32 ABI.  This is the default for processors that are known to
19774 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19775 is set by default.
19777 @item -mabs=2008
19778 @itemx -mabs=legacy
19779 @opindex mabs=2008
19780 @opindex mabs=legacy
19781 These options control the treatment of the special not-a-number (NaN)
19782 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19783 @code{neg.@i{fmt}} machine instructions.
19785 By default or when @option{-mabs=legacy} is used the legacy
19786 treatment is selected.  In this case these instructions are considered
19787 arithmetic and avoided where correct operation is required and the
19788 input operand might be a NaN.  A longer sequence of instructions that
19789 manipulate the sign bit of floating-point datum manually is used
19790 instead unless the @option{-ffinite-math-only} option has also been
19791 specified.
19793 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19794 this case these instructions are considered non-arithmetic and therefore
19795 operating correctly in all cases, including in particular where the
19796 input operand is a NaN.  These instructions are therefore always used
19797 for the respective operations.
19799 @item -mnan=2008
19800 @itemx -mnan=legacy
19801 @opindex mnan=2008
19802 @opindex mnan=legacy
19803 These options control the encoding of the special not-a-number (NaN)
19804 IEEE 754 floating-point data.
19806 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19807 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19808 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19809 by the first bit of their trailing significand field being 1.
19811 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19812 this case qNaNs are denoted by the first bit of their trailing
19813 significand field being 1, whereas sNaNs are denoted by the first bit of
19814 their trailing significand field being 0.
19816 The default is @option{-mnan=legacy} unless GCC has been configured with
19817 @option{--with-nan=2008}.
19819 @item -mllsc
19820 @itemx -mno-llsc
19821 @opindex mllsc
19822 @opindex mno-llsc
19823 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19824 implement atomic memory built-in functions.  When neither option is
19825 specified, GCC uses the instructions if the target architecture
19826 supports them.
19828 @option{-mllsc} is useful if the runtime environment can emulate the
19829 instructions and @option{-mno-llsc} can be useful when compiling for
19830 nonstandard ISAs.  You can make either option the default by
19831 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19832 respectively.  @option{--with-llsc} is the default for some
19833 configurations; see the installation documentation for details.
19835 @item -mdsp
19836 @itemx -mno-dsp
19837 @opindex mdsp
19838 @opindex mno-dsp
19839 Use (do not use) revision 1 of the MIPS DSP ASE@.
19840 @xref{MIPS DSP Built-in Functions}.  This option defines the
19841 preprocessor macro @code{__mips_dsp}.  It also defines
19842 @code{__mips_dsp_rev} to 1.
19844 @item -mdspr2
19845 @itemx -mno-dspr2
19846 @opindex mdspr2
19847 @opindex mno-dspr2
19848 Use (do not use) revision 2 of the MIPS DSP ASE@.
19849 @xref{MIPS DSP Built-in Functions}.  This option defines the
19850 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19851 It also defines @code{__mips_dsp_rev} to 2.
19853 @item -msmartmips
19854 @itemx -mno-smartmips
19855 @opindex msmartmips
19856 @opindex mno-smartmips
19857 Use (do not use) the MIPS SmartMIPS ASE.
19859 @item -mpaired-single
19860 @itemx -mno-paired-single
19861 @opindex mpaired-single
19862 @opindex mno-paired-single
19863 Use (do not use) paired-single floating-point instructions.
19864 @xref{MIPS Paired-Single Support}.  This option requires
19865 hardware floating-point support to be enabled.
19867 @item -mdmx
19868 @itemx -mno-mdmx
19869 @opindex mdmx
19870 @opindex mno-mdmx
19871 Use (do not use) MIPS Digital Media Extension instructions.
19872 This option can only be used when generating 64-bit code and requires
19873 hardware floating-point support to be enabled.
19875 @item -mips3d
19876 @itemx -mno-mips3d
19877 @opindex mips3d
19878 @opindex mno-mips3d
19879 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19880 The option @option{-mips3d} implies @option{-mpaired-single}.
19882 @item -mmicromips
19883 @itemx -mno-micromips
19884 @opindex mmicromips
19885 @opindex mno-mmicromips
19886 Generate (do not generate) microMIPS code.
19888 MicroMIPS code generation can also be controlled on a per-function basis
19889 by means of @code{micromips} and @code{nomicromips} attributes.
19890 @xref{Function Attributes}, for more information.
19892 @item -mmt
19893 @itemx -mno-mt
19894 @opindex mmt
19895 @opindex mno-mt
19896 Use (do not use) MT Multithreading instructions.
19898 @item -mmcu
19899 @itemx -mno-mcu
19900 @opindex mmcu
19901 @opindex mno-mcu
19902 Use (do not use) the MIPS MCU ASE instructions.
19904 @item -meva
19905 @itemx -mno-eva
19906 @opindex meva
19907 @opindex mno-eva
19908 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19910 @item -mvirt
19911 @itemx -mno-virt
19912 @opindex mvirt
19913 @opindex mno-virt
19914 Use (do not use) the MIPS Virtualization (VZ) instructions.
19916 @item -mxpa
19917 @itemx -mno-xpa
19918 @opindex mxpa
19919 @opindex mno-xpa
19920 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19922 @item -mlong64
19923 @opindex mlong64
19924 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19925 an explanation of the default and the way that the pointer size is
19926 determined.
19928 @item -mlong32
19929 @opindex mlong32
19930 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19932 The default size of @code{int}s, @code{long}s and pointers depends on
19933 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19934 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19935 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19936 or the same size as integer registers, whichever is smaller.
19938 @item -msym32
19939 @itemx -mno-sym32
19940 @opindex msym32
19941 @opindex mno-sym32
19942 Assume (do not assume) that all symbols have 32-bit values, regardless
19943 of the selected ABI@.  This option is useful in combination with
19944 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19945 to generate shorter and faster references to symbolic addresses.
19947 @item -G @var{num}
19948 @opindex G
19949 Put definitions of externally-visible data in a small data section
19950 if that data is no bigger than @var{num} bytes.  GCC can then generate
19951 more efficient accesses to the data; see @option{-mgpopt} for details.
19953 The default @option{-G} option depends on the configuration.
19955 @item -mlocal-sdata
19956 @itemx -mno-local-sdata
19957 @opindex mlocal-sdata
19958 @opindex mno-local-sdata
19959 Extend (do not extend) the @option{-G} behavior to local data too,
19960 such as to static variables in C@.  @option{-mlocal-sdata} is the
19961 default for all configurations.
19963 If the linker complains that an application is using too much small data,
19964 you might want to try rebuilding the less performance-critical parts with
19965 @option{-mno-local-sdata}.  You might also want to build large
19966 libraries with @option{-mno-local-sdata}, so that the libraries leave
19967 more room for the main program.
19969 @item -mextern-sdata
19970 @itemx -mno-extern-sdata
19971 @opindex mextern-sdata
19972 @opindex mno-extern-sdata
19973 Assume (do not assume) that externally-defined data is in
19974 a small data section if the size of that data is within the @option{-G} limit.
19975 @option{-mextern-sdata} is the default for all configurations.
19977 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19978 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19979 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19980 is placed in a small data section.  If @var{Var} is defined by another
19981 module, you must either compile that module with a high-enough
19982 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19983 definition.  If @var{Var} is common, you must link the application
19984 with a high-enough @option{-G} setting.
19986 The easiest way of satisfying these restrictions is to compile
19987 and link every module with the same @option{-G} option.  However,
19988 you may wish to build a library that supports several different
19989 small data limits.  You can do this by compiling the library with
19990 the highest supported @option{-G} setting and additionally using
19991 @option{-mno-extern-sdata} to stop the library from making assumptions
19992 about externally-defined data.
19994 @item -mgpopt
19995 @itemx -mno-gpopt
19996 @opindex mgpopt
19997 @opindex mno-gpopt
19998 Use (do not use) GP-relative accesses for symbols that are known to be
19999 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20000 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20001 configurations.
20003 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20004 might not hold the value of @code{_gp}.  For example, if the code is
20005 part of a library that might be used in a boot monitor, programs that
20006 call boot monitor routines pass an unknown value in @code{$gp}.
20007 (In such situations, the boot monitor itself is usually compiled
20008 with @option{-G0}.)
20010 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20011 @option{-mno-extern-sdata}.
20013 @item -membedded-data
20014 @itemx -mno-embedded-data
20015 @opindex membedded-data
20016 @opindex mno-embedded-data
20017 Allocate variables to the read-only data section first if possible, then
20018 next in the small data section if possible, otherwise in data.  This gives
20019 slightly slower code than the default, but reduces the amount of RAM required
20020 when executing, and thus may be preferred for some embedded systems.
20022 @item -muninit-const-in-rodata
20023 @itemx -mno-uninit-const-in-rodata
20024 @opindex muninit-const-in-rodata
20025 @opindex mno-uninit-const-in-rodata
20026 Put uninitialized @code{const} variables in the read-only data section.
20027 This option is only meaningful in conjunction with @option{-membedded-data}.
20029 @item -mcode-readable=@var{setting}
20030 @opindex mcode-readable
20031 Specify whether GCC may generate code that reads from executable sections.
20032 There are three possible settings:
20034 @table @gcctabopt
20035 @item -mcode-readable=yes
20036 Instructions may freely access executable sections.  This is the
20037 default setting.
20039 @item -mcode-readable=pcrel
20040 MIPS16 PC-relative load instructions can access executable sections,
20041 but other instructions must not do so.  This option is useful on 4KSc
20042 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20043 It is also useful on processors that can be configured to have a dual
20044 instruction/data SRAM interface and that, like the M4K, automatically
20045 redirect PC-relative loads to the instruction RAM.
20047 @item -mcode-readable=no
20048 Instructions must not access executable sections.  This option can be
20049 useful on targets that are configured to have a dual instruction/data
20050 SRAM interface but that (unlike the M4K) do not automatically redirect
20051 PC-relative loads to the instruction RAM.
20052 @end table
20054 @item -msplit-addresses
20055 @itemx -mno-split-addresses
20056 @opindex msplit-addresses
20057 @opindex mno-split-addresses
20058 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20059 relocation operators.  This option has been superseded by
20060 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20062 @item -mexplicit-relocs
20063 @itemx -mno-explicit-relocs
20064 @opindex mexplicit-relocs
20065 @opindex mno-explicit-relocs
20066 Use (do not use) assembler relocation operators when dealing with symbolic
20067 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20068 is to use assembler macros instead.
20070 @option{-mexplicit-relocs} is the default if GCC was configured
20071 to use an assembler that supports relocation operators.
20073 @item -mcheck-zero-division
20074 @itemx -mno-check-zero-division
20075 @opindex mcheck-zero-division
20076 @opindex mno-check-zero-division
20077 Trap (do not trap) on integer division by zero.
20079 The default is @option{-mcheck-zero-division}.
20081 @item -mdivide-traps
20082 @itemx -mdivide-breaks
20083 @opindex mdivide-traps
20084 @opindex mdivide-breaks
20085 MIPS systems check for division by zero by generating either a
20086 conditional trap or a break instruction.  Using traps results in
20087 smaller code, but is only supported on MIPS II and later.  Also, some
20088 versions of the Linux kernel have a bug that prevents trap from
20089 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20090 allow conditional traps on architectures that support them and
20091 @option{-mdivide-breaks} to force the use of breaks.
20093 The default is usually @option{-mdivide-traps}, but this can be
20094 overridden at configure time using @option{--with-divide=breaks}.
20095 Divide-by-zero checks can be completely disabled using
20096 @option{-mno-check-zero-division}.
20098 @item -mload-store-pairs
20099 @itemx -mno-load-store-pairs
20100 @opindex mload-store-pairs
20101 @opindex mno-load-store-pairs
20102 Enable (disable) an optimization that pairs consecutive load or store
20103 instructions to enable load/store bonding.  This option is enabled by
20104 default but only takes effect when the selected architecture is known
20105 to support bonding.
20107 @item -mmemcpy
20108 @itemx -mno-memcpy
20109 @opindex mmemcpy
20110 @opindex mno-memcpy
20111 Force (do not force) the use of @code{memcpy} for non-trivial block
20112 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20113 most constant-sized copies.
20115 @item -mlong-calls
20116 @itemx -mno-long-calls
20117 @opindex mlong-calls
20118 @opindex mno-long-calls
20119 Disable (do not disable) use of the @code{jal} instruction.  Calling
20120 functions using @code{jal} is more efficient but requires the caller
20121 and callee to be in the same 256 megabyte segment.
20123 This option has no effect on abicalls code.  The default is
20124 @option{-mno-long-calls}.
20126 @item -mmad
20127 @itemx -mno-mad
20128 @opindex mmad
20129 @opindex mno-mad
20130 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20131 instructions, as provided by the R4650 ISA@.
20133 @item -mimadd
20134 @itemx -mno-imadd
20135 @opindex mimadd
20136 @opindex mno-imadd
20137 Enable (disable) use of the @code{madd} and @code{msub} integer
20138 instructions.  The default is @option{-mimadd} on architectures
20139 that support @code{madd} and @code{msub} except for the 74k 
20140 architecture where it was found to generate slower code.
20142 @item -mfused-madd
20143 @itemx -mno-fused-madd
20144 @opindex mfused-madd
20145 @opindex mno-fused-madd
20146 Enable (disable) use of the floating-point multiply-accumulate
20147 instructions, when they are available.  The default is
20148 @option{-mfused-madd}.
20150 On the R8000 CPU when multiply-accumulate instructions are used,
20151 the intermediate product is calculated to infinite precision
20152 and is not subject to the FCSR Flush to Zero bit.  This may be
20153 undesirable in some circumstances.  On other processors the result
20154 is numerically identical to the equivalent computation using
20155 separate multiply, add, subtract and negate instructions.
20157 @item -nocpp
20158 @opindex nocpp
20159 Tell the MIPS assembler to not run its preprocessor over user
20160 assembler files (with a @samp{.s} suffix) when assembling them.
20162 @item -mfix-24k
20163 @item -mno-fix-24k
20164 @opindex mfix-24k
20165 @opindex mno-fix-24k
20166 Work around the 24K E48 (lost data on stores during refill) errata.
20167 The workarounds are implemented by the assembler rather than by GCC@.
20169 @item -mfix-r4000
20170 @itemx -mno-fix-r4000
20171 @opindex mfix-r4000
20172 @opindex mno-fix-r4000
20173 Work around certain R4000 CPU errata:
20174 @itemize @minus
20175 @item
20176 A double-word or a variable shift may give an incorrect result if executed
20177 immediately after starting an integer division.
20178 @item
20179 A double-word or a variable shift may give an incorrect result if executed
20180 while an integer multiplication is in progress.
20181 @item
20182 An integer division may give an incorrect result if started in a delay slot
20183 of a taken branch or a jump.
20184 @end itemize
20186 @item -mfix-r4400
20187 @itemx -mno-fix-r4400
20188 @opindex mfix-r4400
20189 @opindex mno-fix-r4400
20190 Work around certain R4400 CPU errata:
20191 @itemize @minus
20192 @item
20193 A double-word or a variable shift may give an incorrect result if executed
20194 immediately after starting an integer division.
20195 @end itemize
20197 @item -mfix-r10000
20198 @itemx -mno-fix-r10000
20199 @opindex mfix-r10000
20200 @opindex mno-fix-r10000
20201 Work around certain R10000 errata:
20202 @itemize @minus
20203 @item
20204 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20205 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20206 @end itemize
20208 This option can only be used if the target architecture supports
20209 branch-likely instructions.  @option{-mfix-r10000} is the default when
20210 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20211 otherwise.
20213 @item -mfix-rm7000
20214 @itemx -mno-fix-rm7000
20215 @opindex mfix-rm7000
20216 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20217 workarounds are implemented by the assembler rather than by GCC@.
20219 @item -mfix-vr4120
20220 @itemx -mno-fix-vr4120
20221 @opindex mfix-vr4120
20222 Work around certain VR4120 errata:
20223 @itemize @minus
20224 @item
20225 @code{dmultu} does not always produce the correct result.
20226 @item
20227 @code{div} and @code{ddiv} do not always produce the correct result if one
20228 of the operands is negative.
20229 @end itemize
20230 The workarounds for the division errata rely on special functions in
20231 @file{libgcc.a}.  At present, these functions are only provided by
20232 the @code{mips64vr*-elf} configurations.
20234 Other VR4120 errata require a NOP to be inserted between certain pairs of
20235 instructions.  These errata are handled by the assembler, not by GCC itself.
20237 @item -mfix-vr4130
20238 @opindex mfix-vr4130
20239 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20240 workarounds are implemented by the assembler rather than by GCC,
20241 although GCC avoids using @code{mflo} and @code{mfhi} if the
20242 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20243 instructions are available instead.
20245 @item -mfix-sb1
20246 @itemx -mno-fix-sb1
20247 @opindex mfix-sb1
20248 Work around certain SB-1 CPU core errata.
20249 (This flag currently works around the SB-1 revision 2
20250 ``F1'' and ``F2'' floating-point errata.)
20252 @item -mr10k-cache-barrier=@var{setting}
20253 @opindex mr10k-cache-barrier
20254 Specify whether GCC should insert cache barriers to avoid the
20255 side-effects of speculation on R10K processors.
20257 In common with many processors, the R10K tries to predict the outcome
20258 of a conditional branch and speculatively executes instructions from
20259 the ``taken'' branch.  It later aborts these instructions if the
20260 predicted outcome is wrong.  However, on the R10K, even aborted
20261 instructions can have side effects.
20263 This problem only affects kernel stores and, depending on the system,
20264 kernel loads.  As an example, a speculatively-executed store may load
20265 the target memory into cache and mark the cache line as dirty, even if
20266 the store itself is later aborted.  If a DMA operation writes to the
20267 same area of memory before the ``dirty'' line is flushed, the cached
20268 data overwrites the DMA-ed data.  See the R10K processor manual
20269 for a full description, including other potential problems.
20271 One workaround is to insert cache barrier instructions before every memory
20272 access that might be speculatively executed and that might have side
20273 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20274 controls GCC's implementation of this workaround.  It assumes that
20275 aborted accesses to any byte in the following regions does not have
20276 side effects:
20278 @enumerate
20279 @item
20280 the memory occupied by the current function's stack frame;
20282 @item
20283 the memory occupied by an incoming stack argument;
20285 @item
20286 the memory occupied by an object with a link-time-constant address.
20287 @end enumerate
20289 It is the kernel's responsibility to ensure that speculative
20290 accesses to these regions are indeed safe.
20292 If the input program contains a function declaration such as:
20294 @smallexample
20295 void foo (void);
20296 @end smallexample
20298 then the implementation of @code{foo} must allow @code{j foo} and
20299 @code{jal foo} to be executed speculatively.  GCC honors this
20300 restriction for functions it compiles itself.  It expects non-GCC
20301 functions (such as hand-written assembly code) to do the same.
20303 The option has three forms:
20305 @table @gcctabopt
20306 @item -mr10k-cache-barrier=load-store
20307 Insert a cache barrier before a load or store that might be
20308 speculatively executed and that might have side effects even
20309 if aborted.
20311 @item -mr10k-cache-barrier=store
20312 Insert a cache barrier before a store that might be speculatively
20313 executed and that might have side effects even if aborted.
20315 @item -mr10k-cache-barrier=none
20316 Disable the insertion of cache barriers.  This is the default setting.
20317 @end table
20319 @item -mflush-func=@var{func}
20320 @itemx -mno-flush-func
20321 @opindex mflush-func
20322 Specifies the function to call to flush the I and D caches, or to not
20323 call any such function.  If called, the function must take the same
20324 arguments as the common @code{_flush_func}, that is, the address of the
20325 memory range for which the cache is being flushed, the size of the
20326 memory range, and the number 3 (to flush both caches).  The default
20327 depends on the target GCC was configured for, but commonly is either
20328 @code{_flush_func} or @code{__cpu_flush}.
20330 @item mbranch-cost=@var{num}
20331 @opindex mbranch-cost
20332 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20333 This cost is only a heuristic and is not guaranteed to produce
20334 consistent results across releases.  A zero cost redundantly selects
20335 the default, which is based on the @option{-mtune} setting.
20337 @item -mbranch-likely
20338 @itemx -mno-branch-likely
20339 @opindex mbranch-likely
20340 @opindex mno-branch-likely
20341 Enable or disable use of Branch Likely instructions, regardless of the
20342 default for the selected architecture.  By default, Branch Likely
20343 instructions may be generated if they are supported by the selected
20344 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20345 and processors that implement those architectures; for those, Branch
20346 Likely instructions are not be generated by default because the MIPS32
20347 and MIPS64 architectures specifically deprecate their use.
20349 @item -mcompact-branches=never
20350 @itemx -mcompact-branches=optimal
20351 @itemx -mcompact-branches=always
20352 @opindex mcompact-branches=never
20353 @opindex mcompact-branches=optimal
20354 @opindex mcompact-branches=always
20355 These options control which form of branches will be generated.  The
20356 default is @option{-mcompact-branches=optimal}.
20358 The @option{-mcompact-branches=never} option ensures that compact branch
20359 instructions will never be generated.
20361 The @option{-mcompact-branches=always} option ensures that a compact
20362 branch instruction will be generated if available.  If a compact branch
20363 instruction is not available, a delay slot form of the branch will be
20364 used instead.
20366 This option is supported from MIPS Release 6 onwards.
20368 The @option{-mcompact-branches=optimal} option will cause a delay slot
20369 branch to be used if one is available in the current ISA and the delay
20370 slot is successfully filled.  If the delay slot is not filled, a compact
20371 branch will be chosen if one is available.
20373 @item -mfp-exceptions
20374 @itemx -mno-fp-exceptions
20375 @opindex mfp-exceptions
20376 Specifies whether FP exceptions are enabled.  This affects how
20377 FP instructions are scheduled for some processors.
20378 The default is that FP exceptions are
20379 enabled.
20381 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20382 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20383 FP pipe.
20385 @item -mvr4130-align
20386 @itemx -mno-vr4130-align
20387 @opindex mvr4130-align
20388 The VR4130 pipeline is two-way superscalar, but can only issue two
20389 instructions together if the first one is 8-byte aligned.  When this
20390 option is enabled, GCC aligns pairs of instructions that it
20391 thinks should execute in parallel.
20393 This option only has an effect when optimizing for the VR4130.
20394 It normally makes code faster, but at the expense of making it bigger.
20395 It is enabled by default at optimization level @option{-O3}.
20397 @item -msynci
20398 @itemx -mno-synci
20399 @opindex msynci
20400 Enable (disable) generation of @code{synci} instructions on
20401 architectures that support it.  The @code{synci} instructions (if
20402 enabled) are generated when @code{__builtin___clear_cache} is
20403 compiled.
20405 This option defaults to @option{-mno-synci}, but the default can be
20406 overridden by configuring GCC with @option{--with-synci}.
20408 When compiling code for single processor systems, it is generally safe
20409 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20410 does not invalidate the instruction caches on all cores and may lead
20411 to undefined behavior.
20413 @item -mrelax-pic-calls
20414 @itemx -mno-relax-pic-calls
20415 @opindex mrelax-pic-calls
20416 Try to turn PIC calls that are normally dispatched via register
20417 @code{$25} into direct calls.  This is only possible if the linker can
20418 resolve the destination at link time and if the destination is within
20419 range for a direct call.
20421 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20422 an assembler and a linker that support the @code{.reloc} assembly
20423 directive and @option{-mexplicit-relocs} is in effect.  With
20424 @option{-mno-explicit-relocs}, this optimization can be performed by the
20425 assembler and the linker alone without help from the compiler.
20427 @item -mmcount-ra-address
20428 @itemx -mno-mcount-ra-address
20429 @opindex mmcount-ra-address
20430 @opindex mno-mcount-ra-address
20431 Emit (do not emit) code that allows @code{_mcount} to modify the
20432 calling function's return address.  When enabled, this option extends
20433 the usual @code{_mcount} interface with a new @var{ra-address}
20434 parameter, which has type @code{intptr_t *} and is passed in register
20435 @code{$12}.  @code{_mcount} can then modify the return address by
20436 doing both of the following:
20437 @itemize
20438 @item
20439 Returning the new address in register @code{$31}.
20440 @item
20441 Storing the new address in @code{*@var{ra-address}},
20442 if @var{ra-address} is nonnull.
20443 @end itemize
20445 The default is @option{-mno-mcount-ra-address}.
20447 @item -mframe-header-opt
20448 @itemx -mno-frame-header-opt
20449 @opindex mframe-header-opt
20450 Enable (disable) frame header optimization in the o32 ABI.  When using the
20451 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20452 function to write out register arguments.  When enabled, this optimization
20453 will suppress the allocation of the frame header if it can be determined that
20454 it is unused.
20456 This optimization is off by default at all optimization levels.
20458 @item -mlxc1-sxc1
20459 @itemx -mno-lxc1-sxc1
20460 @opindex mlxc1-sxc1
20461 When applicable, enable (disable) the generation of @code{lwxc1},
20462 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20464 @item -mmadd4
20465 @itemx -mno-madd4
20466 @opindex mmadd4
20467 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20468 @code{madd.d} and related instructions.  Enabled by default.
20470 @end table
20472 @node MMIX Options
20473 @subsection MMIX Options
20474 @cindex MMIX Options
20476 These options are defined for the MMIX:
20478 @table @gcctabopt
20479 @item -mlibfuncs
20480 @itemx -mno-libfuncs
20481 @opindex mlibfuncs
20482 @opindex mno-libfuncs
20483 Specify that intrinsic library functions are being compiled, passing all
20484 values in registers, no matter the size.
20486 @item -mepsilon
20487 @itemx -mno-epsilon
20488 @opindex mepsilon
20489 @opindex mno-epsilon
20490 Generate floating-point comparison instructions that compare with respect
20491 to the @code{rE} epsilon register.
20493 @item -mabi=mmixware
20494 @itemx -mabi=gnu
20495 @opindex mabi=mmixware
20496 @opindex mabi=gnu
20497 Generate code that passes function parameters and return values that (in
20498 the called function) are seen as registers @code{$0} and up, as opposed to
20499 the GNU ABI which uses global registers @code{$231} and up.
20501 @item -mzero-extend
20502 @itemx -mno-zero-extend
20503 @opindex mzero-extend
20504 @opindex mno-zero-extend
20505 When reading data from memory in sizes shorter than 64 bits, use (do not
20506 use) zero-extending load instructions by default, rather than
20507 sign-extending ones.
20509 @item -mknuthdiv
20510 @itemx -mno-knuthdiv
20511 @opindex mknuthdiv
20512 @opindex mno-knuthdiv
20513 Make the result of a division yielding a remainder have the same sign as
20514 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20515 remainder follows the sign of the dividend.  Both methods are
20516 arithmetically valid, the latter being almost exclusively used.
20518 @item -mtoplevel-symbols
20519 @itemx -mno-toplevel-symbols
20520 @opindex mtoplevel-symbols
20521 @opindex mno-toplevel-symbols
20522 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20523 code can be used with the @code{PREFIX} assembly directive.
20525 @item -melf
20526 @opindex melf
20527 Generate an executable in the ELF format, rather than the default
20528 @samp{mmo} format used by the @command{mmix} simulator.
20530 @item -mbranch-predict
20531 @itemx -mno-branch-predict
20532 @opindex mbranch-predict
20533 @opindex mno-branch-predict
20534 Use (do not use) the probable-branch instructions, when static branch
20535 prediction indicates a probable branch.
20537 @item -mbase-addresses
20538 @itemx -mno-base-addresses
20539 @opindex mbase-addresses
20540 @opindex mno-base-addresses
20541 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20542 base address automatically generates a request (handled by the assembler
20543 and the linker) for a constant to be set up in a global register.  The
20544 register is used for one or more base address requests within the range 0
20545 to 255 from the value held in the register.  The generally leads to short
20546 and fast code, but the number of different data items that can be
20547 addressed is limited.  This means that a program that uses lots of static
20548 data may require @option{-mno-base-addresses}.
20550 @item -msingle-exit
20551 @itemx -mno-single-exit
20552 @opindex msingle-exit
20553 @opindex mno-single-exit
20554 Force (do not force) generated code to have a single exit point in each
20555 function.
20556 @end table
20558 @node MN10300 Options
20559 @subsection MN10300 Options
20560 @cindex MN10300 options
20562 These @option{-m} options are defined for Matsushita MN10300 architectures:
20564 @table @gcctabopt
20565 @item -mmult-bug
20566 @opindex mmult-bug
20567 Generate code to avoid bugs in the multiply instructions for the MN10300
20568 processors.  This is the default.
20570 @item -mno-mult-bug
20571 @opindex mno-mult-bug
20572 Do not generate code to avoid bugs in the multiply instructions for the
20573 MN10300 processors.
20575 @item -mam33
20576 @opindex mam33
20577 Generate code using features specific to the AM33 processor.
20579 @item -mno-am33
20580 @opindex mno-am33
20581 Do not generate code using features specific to the AM33 processor.  This
20582 is the default.
20584 @item -mam33-2
20585 @opindex mam33-2
20586 Generate code using features specific to the AM33/2.0 processor.
20588 @item -mam34
20589 @opindex mam34
20590 Generate code using features specific to the AM34 processor.
20592 @item -mtune=@var{cpu-type}
20593 @opindex mtune
20594 Use the timing characteristics of the indicated CPU type when
20595 scheduling instructions.  This does not change the targeted processor
20596 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20597 @samp{am33-2} or @samp{am34}.
20599 @item -mreturn-pointer-on-d0
20600 @opindex mreturn-pointer-on-d0
20601 When generating a function that returns a pointer, return the pointer
20602 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20603 only in @code{a0}, and attempts to call such functions without a prototype
20604 result in errors.  Note that this option is on by default; use
20605 @option{-mno-return-pointer-on-d0} to disable it.
20607 @item -mno-crt0
20608 @opindex mno-crt0
20609 Do not link in the C run-time initialization object file.
20611 @item -mrelax
20612 @opindex mrelax
20613 Indicate to the linker that it should perform a relaxation optimization pass
20614 to shorten branches, calls and absolute memory addresses.  This option only
20615 has an effect when used on the command line for the final link step.
20617 This option makes symbolic debugging impossible.
20619 @item -mliw
20620 @opindex mliw
20621 Allow the compiler to generate @emph{Long Instruction Word}
20622 instructions if the target is the @samp{AM33} or later.  This is the
20623 default.  This option defines the preprocessor macro @code{__LIW__}.
20625 @item -mnoliw
20626 @opindex mnoliw
20627 Do not allow the compiler to generate @emph{Long Instruction Word}
20628 instructions.  This option defines the preprocessor macro
20629 @code{__NO_LIW__}.
20631 @item -msetlb
20632 @opindex msetlb
20633 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20634 instructions if the target is the @samp{AM33} or later.  This is the
20635 default.  This option defines the preprocessor macro @code{__SETLB__}.
20637 @item -mnosetlb
20638 @opindex mnosetlb
20639 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20640 instructions.  This option defines the preprocessor macro
20641 @code{__NO_SETLB__}.
20643 @end table
20645 @node Moxie Options
20646 @subsection Moxie Options
20647 @cindex Moxie Options
20649 @table @gcctabopt
20651 @item -meb
20652 @opindex meb
20653 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20654 configurations.
20656 @item -mel
20657 @opindex mel
20658 Generate little-endian code.
20660 @item -mmul.x
20661 @opindex mmul.x
20662 Generate mul.x and umul.x instructions.  This is the default for
20663 @samp{moxiebox-*-*} configurations.
20665 @item -mno-crt0
20666 @opindex mno-crt0
20667 Do not link in the C run-time initialization object file.
20669 @end table
20671 @node MSP430 Options
20672 @subsection MSP430 Options
20673 @cindex MSP430 Options
20675 These options are defined for the MSP430:
20677 @table @gcctabopt
20679 @item -masm-hex
20680 @opindex masm-hex
20681 Force assembly output to always use hex constants.  Normally such
20682 constants are signed decimals, but this option is available for
20683 testsuite and/or aesthetic purposes.
20685 @item -mmcu=
20686 @opindex mmcu=
20687 Select the MCU to target.  This is used to create a C preprocessor
20688 symbol based upon the MCU name, converted to upper case and pre- and
20689 post-fixed with @samp{__}.  This in turn is used by the
20690 @file{msp430.h} header file to select an MCU-specific supplementary
20691 header file.
20693 The option also sets the ISA to use.  If the MCU name is one that is
20694 known to only support the 430 ISA then that is selected, otherwise the
20695 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20696 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20697 name selects the 430X ISA.
20699 In addition an MCU-specific linker script is added to the linker
20700 command line.  The script's name is the name of the MCU with
20701 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20702 command line defines the C preprocessor symbol @code{__XXX__} and
20703 cause the linker to search for a script called @file{xxx.ld}.
20705 This option is also passed on to the assembler.
20707 @item -mwarn-mcu
20708 @itemx -mno-warn-mcu
20709 @opindex mwarn-mcu
20710 @opindex mno-warn-mcu
20711 This option enables or disables warnings about conflicts between the
20712 MCU name specified by the @option{-mmcu} option and the ISA set by the
20713 @option{-mcpu} option and/or the hardware multiply support set by the
20714 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20715 MCU names.  This option is on by default.
20717 @item -mcpu=
20718 @opindex mcpu=
20719 Specifies the ISA to use.  Accepted values are @samp{msp430},
20720 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20721 @option{-mmcu=} option should be used to select the ISA.
20723 @item -msim
20724 @opindex msim
20725 Link to the simulator runtime libraries and linker script.  Overrides
20726 any scripts that would be selected by the @option{-mmcu=} option.
20728 @item -mlarge
20729 @opindex mlarge
20730 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20732 @item -msmall
20733 @opindex msmall
20734 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20736 @item -mrelax
20737 @opindex mrelax
20738 This option is passed to the assembler and linker, and allows the
20739 linker to perform certain optimizations that cannot be done until
20740 the final link.
20742 @item mhwmult=
20743 @opindex mhwmult=
20744 Describes the type of hardware multiply supported by the target.
20745 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20746 for the original 16-bit-only multiply supported by early MCUs.
20747 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20748 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20749 A value of @samp{auto} can also be given.  This tells GCC to deduce
20750 the hardware multiply support based upon the MCU name provided by the
20751 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20752 the MCU name is not recognized then no hardware multiply support is
20753 assumed.  @code{auto} is the default setting.
20755 Hardware multiplies are normally performed by calling a library
20756 routine.  This saves space in the generated code.  When compiling at
20757 @option{-O3} or higher however the hardware multiplier is invoked
20758 inline.  This makes for bigger, but faster code.
20760 The hardware multiply routines disable interrupts whilst running and
20761 restore the previous interrupt state when they finish.  This makes
20762 them safe to use inside interrupt handlers as well as in normal code.
20764 @item -minrt
20765 @opindex minrt
20766 Enable the use of a minimum runtime environment - no static
20767 initializers or constructors.  This is intended for memory-constrained
20768 devices.  The compiler includes special symbols in some objects
20769 that tell the linker and runtime which code fragments are required.
20771 @item -mcode-region=
20772 @itemx -mdata-region=
20773 @opindex mcode-region
20774 @opindex mdata-region
20775 These options tell the compiler where to place functions and data that
20776 do not have one of the @code{lower}, @code{upper}, @code{either} or
20777 @code{section} attributes.  Possible values are @code{lower},
20778 @code{upper}, @code{either} or @code{any}.  The first three behave
20779 like the corresponding attribute.  The fourth possible value -
20780 @code{any} - is the default.  It leaves placement entirely up to the
20781 linker script and how it assigns the standard sections
20782 (@code{.text}, @code{.data}, etc) to the memory regions.
20784 @item -msilicon-errata=
20785 @opindex msilicon-errata
20786 This option passes on a request to assembler to enable the fixes for
20787 the named silicon errata.
20789 @item -msilicon-errata-warn=
20790 @opindex msilicon-errata-warn
20791 This option passes on a request to the assembler to enable warning
20792 messages when a silicon errata might need to be applied.
20794 @end table
20796 @node NDS32 Options
20797 @subsection NDS32 Options
20798 @cindex NDS32 Options
20800 These options are defined for NDS32 implementations:
20802 @table @gcctabopt
20804 @item -mbig-endian
20805 @opindex mbig-endian
20806 Generate code in big-endian mode.
20808 @item -mlittle-endian
20809 @opindex mlittle-endian
20810 Generate code in little-endian mode.
20812 @item -mreduced-regs
20813 @opindex mreduced-regs
20814 Use reduced-set registers for register allocation.
20816 @item -mfull-regs
20817 @opindex mfull-regs
20818 Use full-set registers for register allocation.
20820 @item -mcmov
20821 @opindex mcmov
20822 Generate conditional move instructions.
20824 @item -mno-cmov
20825 @opindex mno-cmov
20826 Do not generate conditional move instructions.
20828 @item -mperf-ext
20829 @opindex mperf-ext
20830 Generate performance extension instructions.
20832 @item -mno-perf-ext
20833 @opindex mno-perf-ext
20834 Do not generate performance extension instructions.
20836 @item -mv3push
20837 @opindex mv3push
20838 Generate v3 push25/pop25 instructions.
20840 @item -mno-v3push
20841 @opindex mno-v3push
20842 Do not generate v3 push25/pop25 instructions.
20844 @item -m16-bit
20845 @opindex m16-bit
20846 Generate 16-bit instructions.
20848 @item -mno-16-bit
20849 @opindex mno-16-bit
20850 Do not generate 16-bit instructions.
20852 @item -misr-vector-size=@var{num}
20853 @opindex misr-vector-size
20854 Specify the size of each interrupt vector, which must be 4 or 16.
20856 @item -mcache-block-size=@var{num}
20857 @opindex mcache-block-size
20858 Specify the size of each cache block,
20859 which must be a power of 2 between 4 and 512.
20861 @item -march=@var{arch}
20862 @opindex march
20863 Specify the name of the target architecture.
20865 @item -mcmodel=@var{code-model}
20866 @opindex mcmodel
20867 Set the code model to one of
20868 @table @asis
20869 @item @samp{small}
20870 All the data and read-only data segments must be within 512KB addressing space.
20871 The text segment must be within 16MB addressing space.
20872 @item @samp{medium}
20873 The data segment must be within 512KB while the read-only data segment can be
20874 within 4GB addressing space.  The text segment should be still within 16MB
20875 addressing space.
20876 @item @samp{large}
20877 All the text and data segments can be within 4GB addressing space.
20878 @end table
20880 @item -mctor-dtor
20881 @opindex mctor-dtor
20882 Enable constructor/destructor feature.
20884 @item -mrelax
20885 @opindex mrelax
20886 Guide linker to relax instructions.
20888 @end table
20890 @node Nios II Options
20891 @subsection Nios II Options
20892 @cindex Nios II options
20893 @cindex Altera Nios II options
20895 These are the options defined for the Altera Nios II processor.
20897 @table @gcctabopt
20899 @item -G @var{num}
20900 @opindex G
20901 @cindex smaller data references
20902 Put global and static objects less than or equal to @var{num} bytes
20903 into the small data or BSS sections instead of the normal data or BSS
20904 sections.  The default value of @var{num} is 8.
20906 @item -mgpopt=@var{option}
20907 @item -mgpopt
20908 @itemx -mno-gpopt
20909 @opindex mgpopt
20910 @opindex mno-gpopt
20911 Generate (do not generate) GP-relative accesses.  The following 
20912 @var{option} names are recognized:
20914 @table @samp
20916 @item none
20917 Do not generate GP-relative accesses.
20919 @item local
20920 Generate GP-relative accesses for small data objects that are not 
20921 external, weak, or uninitialized common symbols.  
20922 Also use GP-relative addressing for objects that
20923 have been explicitly placed in a small data section via a @code{section}
20924 attribute.
20926 @item global
20927 As for @samp{local}, but also generate GP-relative accesses for
20928 small data objects that are external, weak, or common.  If you use this option,
20929 you must ensure that all parts of your program (including libraries) are
20930 compiled with the same @option{-G} setting.
20932 @item data
20933 Generate GP-relative accesses for all data objects in the program.  If you
20934 use this option, the entire data and BSS segments
20935 of your program must fit in 64K of memory and you must use an appropriate
20936 linker script to allocate them within the addressable range of the
20937 global pointer.
20939 @item all
20940 Generate GP-relative addresses for function pointers as well as data
20941 pointers.  If you use this option, the entire text, data, and BSS segments
20942 of your program must fit in 64K of memory and you must use an appropriate
20943 linker script to allocate them within the addressable range of the
20944 global pointer.
20946 @end table
20948 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20949 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20951 The default is @option{-mgpopt} except when @option{-fpic} or
20952 @option{-fPIC} is specified to generate position-independent code.
20953 Note that the Nios II ABI does not permit GP-relative accesses from
20954 shared libraries.
20956 You may need to specify @option{-mno-gpopt} explicitly when building
20957 programs that include large amounts of small data, including large
20958 GOT data sections.  In this case, the 16-bit offset for GP-relative
20959 addressing may not be large enough to allow access to the entire 
20960 small data section.
20962 @item -mel
20963 @itemx -meb
20964 @opindex mel
20965 @opindex meb
20966 Generate little-endian (default) or big-endian (experimental) code,
20967 respectively.
20969 @item -march=@var{arch}
20970 @opindex march
20971 This specifies the name of the target Nios II architecture.  GCC uses this
20972 name to determine what kind of instructions it can emit when generating
20973 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20975 The preprocessor macro @code{__nios2_arch__} is available to programs,
20976 with value 1 or 2, indicating the targeted ISA level.
20978 @item -mbypass-cache
20979 @itemx -mno-bypass-cache
20980 @opindex mno-bypass-cache
20981 @opindex mbypass-cache
20982 Force all load and store instructions to always bypass cache by 
20983 using I/O variants of the instructions. The default is not to
20984 bypass the cache.
20986 @item -mno-cache-volatile 
20987 @itemx -mcache-volatile       
20988 @opindex mcache-volatile 
20989 @opindex mno-cache-volatile
20990 Volatile memory access bypass the cache using the I/O variants of 
20991 the load and store instructions. The default is not to bypass the cache.
20993 @item -mno-fast-sw-div
20994 @itemx -mfast-sw-div
20995 @opindex mno-fast-sw-div
20996 @opindex mfast-sw-div
20997 Do not use table-based fast divide for small numbers. The default 
20998 is to use the fast divide at @option{-O3} and above.
21000 @item -mno-hw-mul
21001 @itemx -mhw-mul
21002 @itemx -mno-hw-mulx
21003 @itemx -mhw-mulx
21004 @itemx -mno-hw-div
21005 @itemx -mhw-div
21006 @opindex mno-hw-mul
21007 @opindex mhw-mul
21008 @opindex mno-hw-mulx
21009 @opindex mhw-mulx
21010 @opindex mno-hw-div
21011 @opindex mhw-div
21012 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21013 instructions by the compiler. The default is to emit @code{mul}
21014 and not emit @code{div} and @code{mulx}.
21016 @item -mbmx
21017 @itemx -mno-bmx
21018 @itemx -mcdx
21019 @itemx -mno-cdx
21020 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21021 CDX (code density) instructions.  Enabling these instructions also
21022 requires @option{-march=r2}.  Since these instructions are optional
21023 extensions to the R2 architecture, the default is not to emit them.
21025 @item -mcustom-@var{insn}=@var{N}
21026 @itemx -mno-custom-@var{insn}
21027 @opindex mcustom-@var{insn}
21028 @opindex mno-custom-@var{insn}
21029 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21030 custom instruction with encoding @var{N} when generating code that uses 
21031 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21032 instruction 253 for single-precision floating-point add operations instead
21033 of the default behavior of using a library call.
21035 The following values of @var{insn} are supported.  Except as otherwise
21036 noted, floating-point operations are expected to be implemented with
21037 normal IEEE 754 semantics and correspond directly to the C operators or the
21038 equivalent GCC built-in functions (@pxref{Other Builtins}).
21040 Single-precision floating point:
21041 @table @asis
21043 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21044 Binary arithmetic operations.
21046 @item @samp{fnegs}
21047 Unary negation.
21049 @item @samp{fabss}
21050 Unary absolute value.
21052 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21053 Comparison operations.
21055 @item @samp{fmins}, @samp{fmaxs}
21056 Floating-point minimum and maximum.  These instructions are only
21057 generated if @option{-ffinite-math-only} is specified.
21059 @item @samp{fsqrts}
21060 Unary square root operation.
21062 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21063 Floating-point trigonometric and exponential functions.  These instructions
21064 are only generated if @option{-funsafe-math-optimizations} is also specified.
21066 @end table
21068 Double-precision floating point:
21069 @table @asis
21071 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21072 Binary arithmetic operations.
21074 @item @samp{fnegd}
21075 Unary negation.
21077 @item @samp{fabsd}
21078 Unary absolute value.
21080 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21081 Comparison operations.
21083 @item @samp{fmind}, @samp{fmaxd}
21084 Double-precision minimum and maximum.  These instructions are only
21085 generated if @option{-ffinite-math-only} is specified.
21087 @item @samp{fsqrtd}
21088 Unary square root operation.
21090 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21091 Double-precision trigonometric and exponential functions.  These instructions
21092 are only generated if @option{-funsafe-math-optimizations} is also specified.
21094 @end table
21096 Conversions:
21097 @table @asis
21098 @item @samp{fextsd}
21099 Conversion from single precision to double precision.
21101 @item @samp{ftruncds}
21102 Conversion from double precision to single precision.
21104 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21105 Conversion from floating point to signed or unsigned integer types, with
21106 truncation towards zero.
21108 @item @samp{round}
21109 Conversion from single-precision floating point to signed integer,
21110 rounding to the nearest integer and ties away from zero.
21111 This corresponds to the @code{__builtin_lroundf} function when
21112 @option{-fno-math-errno} is used.
21114 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21115 Conversion from signed or unsigned integer types to floating-point types.
21117 @end table
21119 In addition, all of the following transfer instructions for internal
21120 registers X and Y must be provided to use any of the double-precision
21121 floating-point instructions.  Custom instructions taking two
21122 double-precision source operands expect the first operand in the
21123 64-bit register X.  The other operand (or only operand of a unary
21124 operation) is given to the custom arithmetic instruction with the
21125 least significant half in source register @var{src1} and the most
21126 significant half in @var{src2}.  A custom instruction that returns a
21127 double-precision result returns the most significant 32 bits in the
21128 destination register and the other half in 32-bit register Y.  
21129 GCC automatically generates the necessary code sequences to write
21130 register X and/or read register Y when double-precision floating-point
21131 instructions are used.
21133 @table @asis
21135 @item @samp{fwrx}
21136 Write @var{src1} into the least significant half of X and @var{src2} into
21137 the most significant half of X.
21139 @item @samp{fwry}
21140 Write @var{src1} into Y.
21142 @item @samp{frdxhi}, @samp{frdxlo}
21143 Read the most or least (respectively) significant half of X and store it in
21144 @var{dest}.
21146 @item @samp{frdy}
21147 Read the value of Y and store it into @var{dest}.
21148 @end table
21150 Note that you can gain more local control over generation of Nios II custom
21151 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21152 and @code{target("no-custom-@var{insn}")} function attributes
21153 (@pxref{Function Attributes})
21154 or pragmas (@pxref{Function Specific Option Pragmas}).
21156 @item -mcustom-fpu-cfg=@var{name}
21157 @opindex mcustom-fpu-cfg
21159 This option enables a predefined, named set of custom instruction encodings
21160 (see @option{-mcustom-@var{insn}} above).  
21161 Currently, the following sets are defined:
21163 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21164 @gccoptlist{-mcustom-fmuls=252 @gol
21165 -mcustom-fadds=253 @gol
21166 -mcustom-fsubs=254 @gol
21167 -fsingle-precision-constant}
21169 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21170 @gccoptlist{-mcustom-fmuls=252 @gol
21171 -mcustom-fadds=253 @gol
21172 -mcustom-fsubs=254 @gol
21173 -mcustom-fdivs=255 @gol
21174 -fsingle-precision-constant}
21176 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21177 @gccoptlist{-mcustom-floatus=243 @gol
21178 -mcustom-fixsi=244 @gol
21179 -mcustom-floatis=245 @gol
21180 -mcustom-fcmpgts=246 @gol
21181 -mcustom-fcmples=249 @gol
21182 -mcustom-fcmpeqs=250 @gol
21183 -mcustom-fcmpnes=251 @gol
21184 -mcustom-fmuls=252 @gol
21185 -mcustom-fadds=253 @gol
21186 -mcustom-fsubs=254 @gol
21187 -mcustom-fdivs=255 @gol
21188 -fsingle-precision-constant}
21190 Custom instruction assignments given by individual
21191 @option{-mcustom-@var{insn}=} options override those given by
21192 @option{-mcustom-fpu-cfg=}, regardless of the
21193 order of the options on the command line.
21195 Note that you can gain more local control over selection of a FPU
21196 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21197 function attribute (@pxref{Function Attributes})
21198 or pragma (@pxref{Function Specific Option Pragmas}).
21200 @end table
21202 These additional @samp{-m} options are available for the Altera Nios II
21203 ELF (bare-metal) target:
21205 @table @gcctabopt
21207 @item -mhal
21208 @opindex mhal
21209 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21210 startup and termination code, and is typically used in conjunction with
21211 @option{-msys-crt0=} to specify the location of the alternate startup code
21212 provided by the HAL BSP.
21214 @item -msmallc
21215 @opindex msmallc
21216 Link with a limited version of the C library, @option{-lsmallc}, rather than
21217 Newlib.
21219 @item -msys-crt0=@var{startfile}
21220 @opindex msys-crt0
21221 @var{startfile} is the file name of the startfile (crt0) to use 
21222 when linking.  This option is only useful in conjunction with @option{-mhal}.
21224 @item -msys-lib=@var{systemlib}
21225 @opindex msys-lib
21226 @var{systemlib} is the library name of the library that provides
21227 low-level system calls required by the C library,
21228 e.g. @code{read} and @code{write}.
21229 This option is typically used to link with a library provided by a HAL BSP.
21231 @end table
21233 @node Nvidia PTX Options
21234 @subsection Nvidia PTX Options
21235 @cindex Nvidia PTX options
21236 @cindex nvptx options
21238 These options are defined for Nvidia PTX:
21240 @table @gcctabopt
21242 @item -m32
21243 @itemx -m64
21244 @opindex m32
21245 @opindex m64
21246 Generate code for 32-bit or 64-bit ABI.
21248 @item -mmainkernel
21249 @opindex mmainkernel
21250 Link in code for a __main kernel.  This is for stand-alone instead of
21251 offloading execution.
21253 @item -moptimize
21254 @opindex moptimize
21255 Apply partitioned execution optimizations.  This is the default when any
21256 level of optimization is selected.
21258 @item -msoft-stack
21259 @opindex msoft-stack
21260 Generate code that does not use @code{.local} memory
21261 directly for stack storage. Instead, a per-warp stack pointer is
21262 maintained explicitly. This enables variable-length stack allocation (with
21263 variable-length arrays or @code{alloca}), and when global memory is used for
21264 underlying storage, makes it possible to access automatic variables from other
21265 threads, or with atomic instructions. This code generation variant is used
21266 for OpenMP offloading, but the option is exposed on its own for the purpose
21267 of testing the compiler; to generate code suitable for linking into programs
21268 using OpenMP offloading, use option @option{-mgomp}.
21270 @item -muniform-simt
21271 @opindex muniform-simt
21272 Switch to code generation variant that allows to execute all threads in each
21273 warp, while maintaining memory state and side effects as if only one thread
21274 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21275 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21276 current lane index equals the master lane index), and the register being
21277 assigned is copied via a shuffle instruction from the master lane.  Outside of
21278 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21279 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21280 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21281 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21282 with current lane index to compute the master lane index.
21284 @item -mgomp
21285 @opindex mgomp
21286 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21287 @option{-muniform-simt} options, and selects corresponding multilib variant.
21289 @end table
21291 @node PDP-11 Options
21292 @subsection PDP-11 Options
21293 @cindex PDP-11 Options
21295 These options are defined for the PDP-11:
21297 @table @gcctabopt
21298 @item -mfpu
21299 @opindex mfpu
21300 Use hardware FPP floating point.  This is the default.  (FIS floating
21301 point on the PDP-11/40 is not supported.)
21303 @item -msoft-float
21304 @opindex msoft-float
21305 Do not use hardware floating point.
21307 @item -mac0
21308 @opindex mac0
21309 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21311 @item -mno-ac0
21312 @opindex mno-ac0
21313 Return floating-point results in memory.  This is the default.
21315 @item -m40
21316 @opindex m40
21317 Generate code for a PDP-11/40.
21319 @item -m45
21320 @opindex m45
21321 Generate code for a PDP-11/45.  This is the default.
21323 @item -m10
21324 @opindex m10
21325 Generate code for a PDP-11/10.
21327 @item -mbcopy-builtin
21328 @opindex mbcopy-builtin
21329 Use inline @code{movmemhi} patterns for copying memory.  This is the
21330 default.
21332 @item -mbcopy
21333 @opindex mbcopy
21334 Do not use inline @code{movmemhi} patterns for copying memory.
21336 @item -mint16
21337 @itemx -mno-int32
21338 @opindex mint16
21339 @opindex mno-int32
21340 Use 16-bit @code{int}.  This is the default.
21342 @item -mint32
21343 @itemx -mno-int16
21344 @opindex mint32
21345 @opindex mno-int16
21346 Use 32-bit @code{int}.
21348 @item -mfloat64
21349 @itemx -mno-float32
21350 @opindex mfloat64
21351 @opindex mno-float32
21352 Use 64-bit @code{float}.  This is the default.
21354 @item -mfloat32
21355 @itemx -mno-float64
21356 @opindex mfloat32
21357 @opindex mno-float64
21358 Use 32-bit @code{float}.
21360 @item -mabshi
21361 @opindex mabshi
21362 Use @code{abshi2} pattern.  This is the default.
21364 @item -mno-abshi
21365 @opindex mno-abshi
21366 Do not use @code{abshi2} pattern.
21368 @item -mbranch-expensive
21369 @opindex mbranch-expensive
21370 Pretend that branches are expensive.  This is for experimenting with
21371 code generation only.
21373 @item -mbranch-cheap
21374 @opindex mbranch-cheap
21375 Do not pretend that branches are expensive.  This is the default.
21377 @item -munix-asm
21378 @opindex munix-asm
21379 Use Unix assembler syntax.  This is the default when configured for
21380 @samp{pdp11-*-bsd}.
21382 @item -mdec-asm
21383 @opindex mdec-asm
21384 Use DEC assembler syntax.  This is the default when configured for any
21385 PDP-11 target other than @samp{pdp11-*-bsd}.
21386 @end table
21388 @node picoChip Options
21389 @subsection picoChip Options
21390 @cindex picoChip options
21392 These @samp{-m} options are defined for picoChip implementations:
21394 @table @gcctabopt
21396 @item -mae=@var{ae_type}
21397 @opindex mcpu
21398 Set the instruction set, register set, and instruction scheduling
21399 parameters for array element type @var{ae_type}.  Supported values
21400 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21402 @option{-mae=ANY} selects a completely generic AE type.  Code
21403 generated with this option runs on any of the other AE types.  The
21404 code is not as efficient as it would be if compiled for a specific
21405 AE type, and some types of operation (e.g., multiplication) do not
21406 work properly on all types of AE.
21408 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21409 for compiled code, and is the default.
21411 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21412 option may suffer from poor performance of byte (char) manipulation,
21413 since the DSP AE does not provide hardware support for byte load/stores.
21415 @item -msymbol-as-address
21416 Enable the compiler to directly use a symbol name as an address in a
21417 load/store instruction, without first loading it into a
21418 register.  Typically, the use of this option generates larger
21419 programs, which run faster than when the option isn't used.  However, the
21420 results vary from program to program, so it is left as a user option,
21421 rather than being permanently enabled.
21423 @item -mno-inefficient-warnings
21424 Disables warnings about the generation of inefficient code.  These
21425 warnings can be generated, for example, when compiling code that
21426 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21427 no hardware support for byte-level memory operations, so all byte
21428 load/stores must be synthesized from word load/store operations.  This is
21429 inefficient and a warning is generated to indicate
21430 that you should rewrite the code to avoid byte operations, or to target
21431 an AE type that has the necessary hardware support.  This option disables
21432 these warnings.
21434 @end table
21436 @node PowerPC Options
21437 @subsection PowerPC Options
21438 @cindex PowerPC options
21440 These are listed under @xref{RS/6000 and PowerPC Options}.
21442 @node RISC-V Options
21443 @subsection RISC-V Options
21444 @cindex RISC-V Options
21446 These command-line options are defined for RISC-V targets:
21448 @table @gcctabopt
21449 @item -mbranch-cost=@var{n}
21450 @opindex mbranch-cost
21451 Set the cost of branches to roughly @var{n} instructions.
21453 @item -mmemcpy
21454 @itemx -mno-memcpy
21455 @opindex mmemcpy
21456 Don't optimize block moves.
21458 @item -mplt
21459 @itemx -mno-plt
21460 @opindex plt
21461 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21463 @item -mabi=@var{ABI-string}
21464 @opindex mabi
21465 Specify integer and floating-point calling convention.  This defaults to the
21466 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21467 RV64G.
21469 @item -mfdiv
21470 @itemx -mno-fdiv
21471 @opindex mfdiv
21472 Use hardware floating-point divide and square root instructions.  This requires
21473 the F or D extensions for floating-point registers.
21475 @item -mdiv
21476 @itemx -mno-div
21477 @opindex mdiv
21478 Use hardware instructions for integer division.  This requires the M extension.
21480 @item -march=@var{ISA-string}
21481 @opindex march
21482 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21483 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21485 @item -mtune=@var{processor-string}
21486 @opindex mtune
21487 Optimize the output for the given processor, specified by microarchitecture
21488 name.
21490 @item -msmall-data-limit=@var{n}
21491 @opindex msmall-data-limit
21492 Put global and static data smaller than @var{n} bytes into a special section
21493 (on some targets).
21495 @item -msave-restore
21496 @itemx -mno-save-restore
21497 @opindex msave-restore
21498 Use smaller but slower prologue and epilogue code.
21500 @item -mstrict-align
21501 @itemx -mno-strict-align
21502 @opindex mstrict-align
21503 Do not generate unaligned memory accesses.
21505 @item -mcmodel=@var{code-model}
21506 @opindex mcmodel
21507 Specify the code model.
21509 @end table
21511 @node RL78 Options
21512 @subsection RL78 Options
21513 @cindex RL78 Options
21515 @table @gcctabopt
21517 @item -msim
21518 @opindex msim
21519 Links in additional target libraries to support operation within a
21520 simulator.
21522 @item -mmul=none
21523 @itemx -mmul=g10
21524 @itemx -mmul=g13
21525 @itemx -mmul=g14
21526 @itemx -mmul=rl78
21527 @opindex mmul
21528 Specifies the type of hardware multiplication and division support to
21529 be used.  The simplest is @code{none}, which uses software for both
21530 multiplication and division.  This is the default.  The @code{g13}
21531 value is for the hardware multiply/divide peripheral found on the
21532 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21533 the multiplication and division instructions supported by the RL78/G14
21534 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21535 the value @code{mg10} is an alias for @code{none}.
21537 In addition a C preprocessor macro is defined, based upon the setting
21538 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21539 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21541 @item -mcpu=g10
21542 @itemx -mcpu=g13
21543 @itemx -mcpu=g14
21544 @itemx -mcpu=rl78
21545 @opindex mcpu
21546 Specifies the RL78 core to target.  The default is the G14 core, also
21547 known as an S3 core or just RL78.  The G13 or S2 core does not have
21548 multiply or divide instructions, instead it uses a hardware peripheral
21549 for these operations.  The G10 or S1 core does not have register
21550 banks, so it uses a different calling convention.
21552 If this option is set it also selects the type of hardware multiply
21553 support to use, unless this is overridden by an explicit
21554 @option{-mmul=none} option on the command line.  Thus specifying
21555 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21556 peripheral and specifying @option{-mcpu=g10} disables the use of
21557 hardware multiplications altogether.
21559 Note, although the RL78/G14 core is the default target, specifying
21560 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21561 change the behavior of the toolchain since it also enables G14
21562 hardware multiply support.  If these options are not specified on the
21563 command line then software multiplication routines will be used even
21564 though the code targets the RL78 core.  This is for backwards
21565 compatibility with older toolchains which did not have hardware
21566 multiply and divide support.
21568 In addition a C preprocessor macro is defined, based upon the setting
21569 of this option.  Possible values are: @code{__RL78_G10__},
21570 @code{__RL78_G13__} or @code{__RL78_G14__}.
21572 @item -mg10
21573 @itemx -mg13
21574 @itemx -mg14
21575 @itemx -mrl78
21576 @opindex mg10
21577 @opindex mg13
21578 @opindex mg14
21579 @opindex mrl78
21580 These are aliases for the corresponding @option{-mcpu=} option.  They
21581 are provided for backwards compatibility.
21583 @item -mallregs
21584 @opindex mallregs
21585 Allow the compiler to use all of the available registers.  By default
21586 registers @code{r24..r31} are reserved for use in interrupt handlers.
21587 With this option enabled these registers can be used in ordinary
21588 functions as well.
21590 @item -m64bit-doubles
21591 @itemx -m32bit-doubles
21592 @opindex m64bit-doubles
21593 @opindex m32bit-doubles
21594 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21595 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21596 @option{-m32bit-doubles}.
21598 @item -msave-mduc-in-interrupts
21599 @item -mno-save-mduc-in-interrupts
21600 @opindex msave-mduc-in-interrupts
21601 @opindex mno-save-mduc-in-interrupts
21602 Specifies that interrupt handler functions should preserve the
21603 MDUC registers.  This is only necessary if normal code might use
21604 the MDUC registers, for example because it performs multiplication
21605 and division operations.  The default is to ignore the MDUC registers
21606 as this makes the interrupt handlers faster.  The target option -mg13
21607 needs to be passed for this to work as this feature is only available
21608 on the G13 target (S2 core).  The MDUC registers will only be saved
21609 if the interrupt handler performs a multiplication or division
21610 operation or it calls another function.
21612 @end table
21614 @node RS/6000 and PowerPC Options
21615 @subsection IBM RS/6000 and PowerPC Options
21616 @cindex RS/6000 and PowerPC Options
21617 @cindex IBM RS/6000 and PowerPC Options
21619 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21620 @table @gcctabopt
21621 @item -mpowerpc-gpopt
21622 @itemx -mno-powerpc-gpopt
21623 @itemx -mpowerpc-gfxopt
21624 @itemx -mno-powerpc-gfxopt
21625 @need 800
21626 @itemx -mpowerpc64
21627 @itemx -mno-powerpc64
21628 @itemx -mmfcrf
21629 @itemx -mno-mfcrf
21630 @itemx -mpopcntb
21631 @itemx -mno-popcntb
21632 @itemx -mpopcntd
21633 @itemx -mno-popcntd
21634 @itemx -mfprnd
21635 @itemx -mno-fprnd
21636 @need 800
21637 @itemx -mcmpb
21638 @itemx -mno-cmpb
21639 @itemx -mmfpgpr
21640 @itemx -mno-mfpgpr
21641 @itemx -mhard-dfp
21642 @itemx -mno-hard-dfp
21643 @opindex mpowerpc-gpopt
21644 @opindex mno-powerpc-gpopt
21645 @opindex mpowerpc-gfxopt
21646 @opindex mno-powerpc-gfxopt
21647 @opindex mpowerpc64
21648 @opindex mno-powerpc64
21649 @opindex mmfcrf
21650 @opindex mno-mfcrf
21651 @opindex mpopcntb
21652 @opindex mno-popcntb
21653 @opindex mpopcntd
21654 @opindex mno-popcntd
21655 @opindex mfprnd
21656 @opindex mno-fprnd
21657 @opindex mcmpb
21658 @opindex mno-cmpb
21659 @opindex mmfpgpr
21660 @opindex mno-mfpgpr
21661 @opindex mhard-dfp
21662 @opindex mno-hard-dfp
21663 You use these options to specify which instructions are available on the
21664 processor you are using.  The default value of these options is
21665 determined when configuring GCC@.  Specifying the
21666 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21667 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21668 rather than the options listed above.
21670 Specifying @option{-mpowerpc-gpopt} allows
21671 GCC to use the optional PowerPC architecture instructions in the
21672 General Purpose group, including floating-point square root.  Specifying
21673 @option{-mpowerpc-gfxopt} allows GCC to
21674 use the optional PowerPC architecture instructions in the Graphics
21675 group, including floating-point select.
21677 The @option{-mmfcrf} option allows GCC to generate the move from
21678 condition register field instruction implemented on the POWER4
21679 processor and other processors that support the PowerPC V2.01
21680 architecture.
21681 The @option{-mpopcntb} option allows GCC to generate the popcount and
21682 double-precision FP reciprocal estimate instruction implemented on the
21683 POWER5 processor and other processors that support the PowerPC V2.02
21684 architecture.
21685 The @option{-mpopcntd} option allows GCC to generate the popcount
21686 instruction implemented on the POWER7 processor and other processors
21687 that support the PowerPC V2.06 architecture.
21688 The @option{-mfprnd} option allows GCC to generate the FP round to
21689 integer instructions implemented on the POWER5+ processor and other
21690 processors that support the PowerPC V2.03 architecture.
21691 The @option{-mcmpb} option allows GCC to generate the compare bytes
21692 instruction implemented on the POWER6 processor and other processors
21693 that support the PowerPC V2.05 architecture.
21694 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21695 general-purpose register instructions implemented on the POWER6X
21696 processor and other processors that support the extended PowerPC V2.05
21697 architecture.
21698 The @option{-mhard-dfp} option allows GCC to generate the decimal
21699 floating-point instructions implemented on some POWER processors.
21701 The @option{-mpowerpc64} option allows GCC to generate the additional
21702 64-bit instructions that are found in the full PowerPC64 architecture
21703 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21704 @option{-mno-powerpc64}.
21706 @item -mcpu=@var{cpu_type}
21707 @opindex mcpu
21708 Set architecture type, register usage, and
21709 instruction scheduling parameters for machine type @var{cpu_type}.
21710 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21711 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21712 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21713 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21714 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21715 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21716 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21717 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21718 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21719 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21720 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21721 and @samp{rs64}.
21723 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21724 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21725 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21726 architecture machine types, with an appropriate, generic processor
21727 model assumed for scheduling purposes.
21729 The other options specify a specific processor.  Code generated under
21730 those options runs best on that processor, and may not run at all on
21731 others.
21733 The @option{-mcpu} options automatically enable or disable the
21734 following options:
21736 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21737 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21738 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21739 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21740 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21741 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21743 The particular options set for any particular CPU varies between
21744 compiler versions, depending on what setting seems to produce optimal
21745 code for that CPU; it doesn't necessarily reflect the actual hardware's
21746 capabilities.  If you wish to set an individual option to a particular
21747 value, you may specify it after the @option{-mcpu} option, like
21748 @option{-mcpu=970 -mno-altivec}.
21750 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21751 not enabled or disabled by the @option{-mcpu} option at present because
21752 AIX does not have full support for these options.  You may still
21753 enable or disable them individually if you're sure it'll work in your
21754 environment.
21756 @item -mtune=@var{cpu_type}
21757 @opindex mtune
21758 Set the instruction scheduling parameters for machine type
21759 @var{cpu_type}, but do not set the architecture type or register usage,
21760 as @option{-mcpu=@var{cpu_type}} does.  The same
21761 values for @var{cpu_type} are used for @option{-mtune} as for
21762 @option{-mcpu}.  If both are specified, the code generated uses the
21763 architecture and registers set by @option{-mcpu}, but the
21764 scheduling parameters set by @option{-mtune}.
21766 @item -mcmodel=small
21767 @opindex mcmodel=small
21768 Generate PowerPC64 code for the small model: The TOC is limited to
21769 64k.
21771 @item -mcmodel=medium
21772 @opindex mcmodel=medium
21773 Generate PowerPC64 code for the medium model: The TOC and other static
21774 data may be up to a total of 4G in size.  This is the default for 64-bit
21775 Linux.
21777 @item -mcmodel=large
21778 @opindex mcmodel=large
21779 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21780 in size.  Other data and code is only limited by the 64-bit address
21781 space.
21783 @item -maltivec
21784 @itemx -mno-altivec
21785 @opindex maltivec
21786 @opindex mno-altivec
21787 Generate code that uses (does not use) AltiVec instructions, and also
21788 enable the use of built-in functions that allow more direct access to
21789 the AltiVec instruction set.  You may also need to set
21790 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21791 enhancements.
21793 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21794 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21795 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21796 match array element order corresponding to the endianness of the
21797 target.  That is, element zero identifies the leftmost element in a
21798 vector register when targeting a big-endian platform, and identifies
21799 the rightmost element in a vector register when targeting a
21800 little-endian platform.
21802 @item -maltivec=be
21803 @opindex maltivec=be
21804 Generate AltiVec instructions using big-endian element order,
21805 regardless of whether the target is big- or little-endian.  This is
21806 the default when targeting a big-endian platform.
21808 The element order is used to interpret element numbers in AltiVec
21809 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21810 @code{vec_insert}.  By default, these match array element order
21811 corresponding to the endianness for the target.
21813 @item -maltivec=le
21814 @opindex maltivec=le
21815 Generate AltiVec instructions using little-endian element order,
21816 regardless of whether the target is big- or little-endian.  This is
21817 the default when targeting a little-endian platform.  This option is
21818 currently ignored when targeting a big-endian platform.
21820 The element order is used to interpret element numbers in AltiVec
21821 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21822 @code{vec_insert}.  By default, these match array element order
21823 corresponding to the endianness for the target.
21825 @item -mvrsave
21826 @itemx -mno-vrsave
21827 @opindex mvrsave
21828 @opindex mno-vrsave
21829 Generate VRSAVE instructions when generating AltiVec code.
21831 @item -msecure-plt
21832 @opindex msecure-plt
21833 Generate code that allows @command{ld} and @command{ld.so}
21834 to build executables and shared
21835 libraries with non-executable @code{.plt} and @code{.got} sections.
21836 This is a PowerPC
21837 32-bit SYSV ABI option.
21839 @item -mbss-plt
21840 @opindex mbss-plt
21841 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21842 fills in, and
21843 requires @code{.plt} and @code{.got}
21844 sections that are both writable and executable.
21845 This is a PowerPC 32-bit SYSV ABI option.
21847 @item -misel
21848 @itemx -mno-isel
21849 @opindex misel
21850 @opindex mno-isel
21851 This switch enables or disables the generation of ISEL instructions.
21853 @item -misel=@var{yes/no}
21854 This switch has been deprecated.  Use @option{-misel} and
21855 @option{-mno-isel} instead.
21857 @item -mspe
21858 @itemx -mno-spe
21859 @opindex mspe
21860 @opindex mno-spe
21861 This switch enables or disables the generation of SPE simd
21862 instructions.
21864 @item -mpaired
21865 @itemx -mno-paired
21866 @opindex mpaired
21867 @opindex mno-paired
21868 This switch enables or disables the generation of PAIRED simd
21869 instructions.
21871 @item -mspe=@var{yes/no}
21872 This option has been deprecated.  Use @option{-mspe} and
21873 @option{-mno-spe} instead.
21875 @item -mvsx
21876 @itemx -mno-vsx
21877 @opindex mvsx
21878 @opindex mno-vsx
21879 Generate code that uses (does not use) vector/scalar (VSX)
21880 instructions, and also enable the use of built-in functions that allow
21881 more direct access to the VSX instruction set.
21883 @item -mcrypto
21884 @itemx -mno-crypto
21885 @opindex mcrypto
21886 @opindex mno-crypto
21887 Enable the use (disable) of the built-in functions that allow direct
21888 access to the cryptographic instructions that were added in version
21889 2.07 of the PowerPC ISA.
21891 @item -mdirect-move
21892 @itemx -mno-direct-move
21893 @opindex mdirect-move
21894 @opindex mno-direct-move
21895 Generate code that uses (does not use) the instructions to move data
21896 between the general purpose registers and the vector/scalar (VSX)
21897 registers that were added in version 2.07 of the PowerPC ISA.
21899 @item -mhtm
21900 @itemx -mno-htm
21901 @opindex mhtm
21902 @opindex mno-htm
21903 Enable (disable) the use of the built-in functions that allow direct
21904 access to the Hardware Transactional Memory (HTM) instructions that
21905 were added in version 2.07 of the PowerPC ISA.
21907 @item -mpower8-fusion
21908 @itemx -mno-power8-fusion
21909 @opindex mpower8-fusion
21910 @opindex mno-power8-fusion
21911 Generate code that keeps (does not keeps) some integer operations
21912 adjacent so that the instructions can be fused together on power8 and
21913 later processors.
21915 @item -mpower8-vector
21916 @itemx -mno-power8-vector
21917 @opindex mpower8-vector
21918 @opindex mno-power8-vector
21919 Generate code that uses (does not use) the vector and scalar
21920 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21921 enable the use of built-in functions that allow more direct access to
21922 the vector instructions.
21924 @item -mquad-memory
21925 @itemx -mno-quad-memory
21926 @opindex mquad-memory
21927 @opindex mno-quad-memory
21928 Generate code that uses (does not use) the non-atomic quad word memory
21929 instructions.  The @option{-mquad-memory} option requires use of
21930 64-bit mode.
21932 @item -mquad-memory-atomic
21933 @itemx -mno-quad-memory-atomic
21934 @opindex mquad-memory-atomic
21935 @opindex mno-quad-memory-atomic
21936 Generate code that uses (does not use) the atomic quad word memory
21937 instructions.  The @option{-mquad-memory-atomic} option requires use of
21938 64-bit mode.
21940 @item -mfloat128
21941 @itemx -mno-float128
21942 @opindex mfloat128
21943 @opindex mno-float128
21944 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21945 and use either software emulation for IEEE 128-bit floating point or
21946 hardware instructions.
21948 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21949 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21950 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21951 Linux systems.
21953 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21954 @option{-mfloat128} option will also enable the generation of ISA 3.0
21955 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21956 floating point will be done with software emulation.
21958 @item -mfloat128-hardware
21959 @itemx -mno-float128-hardware
21960 @opindex mfloat128-hardware
21961 @opindex mno-float128-hardware
21962 Enable/disable using ISA 3.0 hardware instructions to support the
21963 @var{__float128} data type.
21965 If you use @option{-mfloat128-hardware}, it will enable the option
21966 @option{-mfloat128} as well.
21968 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21969 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21970 the IEEE 128-bit floating point support will not be enabled.
21972 @item -mfloat-gprs=@var{yes/single/double/no}
21973 @itemx -mfloat-gprs
21974 @opindex mfloat-gprs
21975 This switch enables or disables the generation of floating-point
21976 operations on the general-purpose registers for architectures that
21977 support it.
21979 The argument @samp{yes} or @samp{single} enables the use of
21980 single-precision floating-point operations.
21982 The argument @samp{double} enables the use of single and
21983 double-precision floating-point operations.
21985 The argument @samp{no} disables floating-point operations on the
21986 general-purpose registers.
21988 This option is currently only available on the MPC854x.
21990 @item -m32
21991 @itemx -m64
21992 @opindex m32
21993 @opindex m64
21994 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21995 targets (including GNU/Linux).  The 32-bit environment sets int, long
21996 and pointer to 32 bits and generates code that runs on any PowerPC
21997 variant.  The 64-bit environment sets int to 32 bits and long and
21998 pointer to 64 bits, and generates code for PowerPC64, as for
21999 @option{-mpowerpc64}.
22001 @item -mfull-toc
22002 @itemx -mno-fp-in-toc
22003 @itemx -mno-sum-in-toc
22004 @itemx -mminimal-toc
22005 @opindex mfull-toc
22006 @opindex mno-fp-in-toc
22007 @opindex mno-sum-in-toc
22008 @opindex mminimal-toc
22009 Modify generation of the TOC (Table Of Contents), which is created for
22010 every executable file.  The @option{-mfull-toc} option is selected by
22011 default.  In that case, GCC allocates at least one TOC entry for
22012 each unique non-automatic variable reference in your program.  GCC
22013 also places floating-point constants in the TOC@.  However, only
22014 16,384 entries are available in the TOC@.
22016 If you receive a linker error message that saying you have overflowed
22017 the available TOC space, you can reduce the amount of TOC space used
22018 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22019 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22020 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22021 generate code to calculate the sum of an address and a constant at
22022 run time instead of putting that sum into the TOC@.  You may specify one
22023 or both of these options.  Each causes GCC to produce very slightly
22024 slower and larger code at the expense of conserving TOC space.
22026 If you still run out of space in the TOC even when you specify both of
22027 these options, specify @option{-mminimal-toc} instead.  This option causes
22028 GCC to make only one TOC entry for every file.  When you specify this
22029 option, GCC produces code that is slower and larger but which
22030 uses extremely little TOC space.  You may wish to use this option
22031 only on files that contain less frequently-executed code.
22033 @item -maix64
22034 @itemx -maix32
22035 @opindex maix64
22036 @opindex maix32
22037 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22038 @code{long} type, and the infrastructure needed to support them.
22039 Specifying @option{-maix64} implies @option{-mpowerpc64},
22040 while @option{-maix32} disables the 64-bit ABI and
22041 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22043 @item -mxl-compat
22044 @itemx -mno-xl-compat
22045 @opindex mxl-compat
22046 @opindex mno-xl-compat
22047 Produce code that conforms more closely to IBM XL compiler semantics
22048 when using AIX-compatible ABI@.  Pass floating-point arguments to
22049 prototyped functions beyond the register save area (RSA) on the stack
22050 in addition to argument FPRs.  Do not assume that most significant
22051 double in 128-bit long double value is properly rounded when comparing
22052 values and converting to double.  Use XL symbol names for long double
22053 support routines.
22055 The AIX calling convention was extended but not initially documented to
22056 handle an obscure K&R C case of calling a function that takes the
22057 address of its arguments with fewer arguments than declared.  IBM XL
22058 compilers access floating-point arguments that do not fit in the
22059 RSA from the stack when a subroutine is compiled without
22060 optimization.  Because always storing floating-point arguments on the
22061 stack is inefficient and rarely needed, this option is not enabled by
22062 default and only is necessary when calling subroutines compiled by IBM
22063 XL compilers without optimization.
22065 @item -mpe
22066 @opindex mpe
22067 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22068 application written to use message passing with special startup code to
22069 enable the application to run.  The system must have PE installed in the
22070 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22071 must be overridden with the @option{-specs=} option to specify the
22072 appropriate directory location.  The Parallel Environment does not
22073 support threads, so the @option{-mpe} option and the @option{-pthread}
22074 option are incompatible.
22076 @item -malign-natural
22077 @itemx -malign-power
22078 @opindex malign-natural
22079 @opindex malign-power
22080 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22081 @option{-malign-natural} overrides the ABI-defined alignment of larger
22082 types, such as floating-point doubles, on their natural size-based boundary.
22083 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22084 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22086 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22087 is not supported.
22089 @item -msoft-float
22090 @itemx -mhard-float
22091 @opindex msoft-float
22092 @opindex mhard-float
22093 Generate code that does not use (uses) the floating-point register set.
22094 Software floating-point emulation is provided if you use the
22095 @option{-msoft-float} option, and pass the option to GCC when linking.
22097 @item -msingle-float
22098 @itemx -mdouble-float
22099 @opindex msingle-float
22100 @opindex mdouble-float
22101 Generate code for single- or double-precision floating-point operations.
22102 @option{-mdouble-float} implies @option{-msingle-float}.
22104 @item -msimple-fpu
22105 @opindex msimple-fpu
22106 Do not generate @code{sqrt} and @code{div} instructions for hardware
22107 floating-point unit.
22109 @item -mfpu=@var{name}
22110 @opindex mfpu
22111 Specify type of floating-point unit.  Valid values for @var{name} are
22112 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22113 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22114 @samp{sp_full} (equivalent to @option{-msingle-float}),
22115 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22117 @item -mxilinx-fpu
22118 @opindex mxilinx-fpu
22119 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22121 @item -mmultiple
22122 @itemx -mno-multiple
22123 @opindex mmultiple
22124 @opindex mno-multiple
22125 Generate code that uses (does not use) the load multiple word
22126 instructions and the store multiple word instructions.  These
22127 instructions are generated by default on POWER systems, and not
22128 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22129 PowerPC systems, since those instructions do not work when the
22130 processor is in little-endian mode.  The exceptions are PPC740 and
22131 PPC750 which permit these instructions in little-endian mode.
22133 @item -mstring
22134 @itemx -mno-string
22135 @opindex mstring
22136 @opindex mno-string
22137 Generate code that uses (does not use) the load string instructions
22138 and the store string word instructions to save multiple registers and
22139 do small block moves.  These instructions are generated by default on
22140 POWER systems, and not generated on PowerPC systems.  Do not use
22141 @option{-mstring} on little-endian PowerPC systems, since those
22142 instructions do not work when the processor is in little-endian mode.
22143 The exceptions are PPC740 and PPC750 which permit these instructions
22144 in little-endian mode.
22146 @item -mupdate
22147 @itemx -mno-update
22148 @opindex mupdate
22149 @opindex mno-update
22150 Generate code that uses (does not use) the load or store instructions
22151 that update the base register to the address of the calculated memory
22152 location.  These instructions are generated by default.  If you use
22153 @option{-mno-update}, there is a small window between the time that the
22154 stack pointer is updated and the address of the previous frame is
22155 stored, which means code that walks the stack frame across interrupts or
22156 signals may get corrupted data.
22158 @item -mavoid-indexed-addresses
22159 @itemx -mno-avoid-indexed-addresses
22160 @opindex mavoid-indexed-addresses
22161 @opindex mno-avoid-indexed-addresses
22162 Generate code that tries to avoid (not avoid) the use of indexed load
22163 or store instructions. These instructions can incur a performance
22164 penalty on Power6 processors in certain situations, such as when
22165 stepping through large arrays that cross a 16M boundary.  This option
22166 is enabled by default when targeting Power6 and disabled otherwise.
22168 @item -mfused-madd
22169 @itemx -mno-fused-madd
22170 @opindex mfused-madd
22171 @opindex mno-fused-madd
22172 Generate code that uses (does not use) the floating-point multiply and
22173 accumulate instructions.  These instructions are generated by default
22174 if hardware floating point is used.  The machine-dependent
22175 @option{-mfused-madd} option is now mapped to the machine-independent
22176 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22177 mapped to @option{-ffp-contract=off}.
22179 @item -mmulhw
22180 @itemx -mno-mulhw
22181 @opindex mmulhw
22182 @opindex mno-mulhw
22183 Generate code that uses (does not use) the half-word multiply and
22184 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22185 These instructions are generated by default when targeting those
22186 processors.
22188 @item -mdlmzb
22189 @itemx -mno-dlmzb
22190 @opindex mdlmzb
22191 @opindex mno-dlmzb
22192 Generate code that uses (does not use) the string-search @samp{dlmzb}
22193 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22194 generated by default when targeting those processors.
22196 @item -mno-bit-align
22197 @itemx -mbit-align
22198 @opindex mno-bit-align
22199 @opindex mbit-align
22200 On System V.4 and embedded PowerPC systems do not (do) force structures
22201 and unions that contain bit-fields to be aligned to the base type of the
22202 bit-field.
22204 For example, by default a structure containing nothing but 8
22205 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22206 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22207 the structure is aligned to a 1-byte boundary and is 1 byte in
22208 size.
22210 @item -mno-strict-align
22211 @itemx -mstrict-align
22212 @opindex mno-strict-align
22213 @opindex mstrict-align
22214 On System V.4 and embedded PowerPC systems do not (do) assume that
22215 unaligned memory references are handled by the system.
22217 @item -mrelocatable
22218 @itemx -mno-relocatable
22219 @opindex mrelocatable
22220 @opindex mno-relocatable
22221 Generate code that allows (does not allow) a static executable to be
22222 relocated to a different address at run time.  A simple embedded
22223 PowerPC system loader should relocate the entire contents of
22224 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22225 a table of 32-bit addresses generated by this option.  For this to
22226 work, all objects linked together must be compiled with
22227 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22228 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22230 @item -mrelocatable-lib
22231 @itemx -mno-relocatable-lib
22232 @opindex mrelocatable-lib
22233 @opindex mno-relocatable-lib
22234 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22235 @code{.fixup} section to allow static executables to be relocated at
22236 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22237 alignment of @option{-mrelocatable}.  Objects compiled with
22238 @option{-mrelocatable-lib} may be linked with objects compiled with
22239 any combination of the @option{-mrelocatable} options.
22241 @item -mno-toc
22242 @itemx -mtoc
22243 @opindex mno-toc
22244 @opindex mtoc
22245 On System V.4 and embedded PowerPC systems do not (do) assume that
22246 register 2 contains a pointer to a global area pointing to the addresses
22247 used in the program.
22249 @item -mlittle
22250 @itemx -mlittle-endian
22251 @opindex mlittle
22252 @opindex mlittle-endian
22253 On System V.4 and embedded PowerPC systems compile code for the
22254 processor in little-endian mode.  The @option{-mlittle-endian} option is
22255 the same as @option{-mlittle}.
22257 @item -mbig
22258 @itemx -mbig-endian
22259 @opindex mbig
22260 @opindex mbig-endian
22261 On System V.4 and embedded PowerPC systems compile code for the
22262 processor in big-endian mode.  The @option{-mbig-endian} option is
22263 the same as @option{-mbig}.
22265 @item -mdynamic-no-pic
22266 @opindex mdynamic-no-pic
22267 On Darwin and Mac OS X systems, compile code so that it is not
22268 relocatable, but that its external references are relocatable.  The
22269 resulting code is suitable for applications, but not shared
22270 libraries.
22272 @item -msingle-pic-base
22273 @opindex msingle-pic-base
22274 Treat the register used for PIC addressing as read-only, rather than
22275 loading it in the prologue for each function.  The runtime system is
22276 responsible for initializing this register with an appropriate value
22277 before execution begins.
22279 @item -mprioritize-restricted-insns=@var{priority}
22280 @opindex mprioritize-restricted-insns
22281 This option controls the priority that is assigned to
22282 dispatch-slot restricted instructions during the second scheduling
22283 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22284 or @samp{2} to assign no, highest, or second-highest (respectively) 
22285 priority to dispatch-slot restricted
22286 instructions.
22288 @item -msched-costly-dep=@var{dependence_type}
22289 @opindex msched-costly-dep
22290 This option controls which dependences are considered costly
22291 by the target during instruction scheduling.  The argument
22292 @var{dependence_type} takes one of the following values:
22294 @table @asis
22295 @item @samp{no}
22296 No dependence is costly.
22298 @item @samp{all}
22299 All dependences are costly.
22301 @item @samp{true_store_to_load}
22302 A true dependence from store to load is costly.
22304 @item @samp{store_to_load}
22305 Any dependence from store to load is costly.
22307 @item @var{number}
22308 Any dependence for which the latency is greater than or equal to 
22309 @var{number} is costly.
22310 @end table
22312 @item -minsert-sched-nops=@var{scheme}
22313 @opindex minsert-sched-nops
22314 This option controls which NOP insertion scheme is used during
22315 the second scheduling pass.  The argument @var{scheme} takes one of the
22316 following values:
22318 @table @asis
22319 @item @samp{no}
22320 Don't insert NOPs.
22322 @item @samp{pad}
22323 Pad with NOPs any dispatch group that has vacant issue slots,
22324 according to the scheduler's grouping.
22326 @item @samp{regroup_exact}
22327 Insert NOPs to force costly dependent insns into
22328 separate groups.  Insert exactly as many NOPs as needed to force an insn
22329 to a new group, according to the estimated processor grouping.
22331 @item @var{number}
22332 Insert NOPs to force costly dependent insns into
22333 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22334 @end table
22336 @item -mcall-sysv
22337 @opindex mcall-sysv
22338 On System V.4 and embedded PowerPC systems compile code using calling
22339 conventions that adhere to the March 1995 draft of the System V
22340 Application Binary Interface, PowerPC processor supplement.  This is the
22341 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22343 @item -mcall-sysv-eabi
22344 @itemx -mcall-eabi
22345 @opindex mcall-sysv-eabi
22346 @opindex mcall-eabi
22347 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22349 @item -mcall-sysv-noeabi
22350 @opindex mcall-sysv-noeabi
22351 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22353 @item -mcall-aixdesc
22354 @opindex m
22355 On System V.4 and embedded PowerPC systems compile code for the AIX
22356 operating system.
22358 @item -mcall-linux
22359 @opindex mcall-linux
22360 On System V.4 and embedded PowerPC systems compile code for the
22361 Linux-based GNU system.
22363 @item -mcall-freebsd
22364 @opindex mcall-freebsd
22365 On System V.4 and embedded PowerPC systems compile code for the
22366 FreeBSD operating system.
22368 @item -mcall-netbsd
22369 @opindex mcall-netbsd
22370 On System V.4 and embedded PowerPC systems compile code for the
22371 NetBSD operating system.
22373 @item -mcall-openbsd
22374 @opindex mcall-netbsd
22375 On System V.4 and embedded PowerPC systems compile code for the
22376 OpenBSD operating system.
22378 @item -maix-struct-return
22379 @opindex maix-struct-return
22380 Return all structures in memory (as specified by the AIX ABI)@.
22382 @item -msvr4-struct-return
22383 @opindex msvr4-struct-return
22384 Return structures smaller than 8 bytes in registers (as specified by the
22385 SVR4 ABI)@.
22387 @item -mabi=@var{abi-type}
22388 @opindex mabi
22389 Extend the current ABI with a particular extension, or remove such extension.
22390 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22391 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22392 @samp{elfv1}, @samp{elfv2}@.
22394 @item -mabi=spe
22395 @opindex mabi=spe
22396 Extend the current ABI with SPE ABI extensions.  This does not change
22397 the default ABI, instead it adds the SPE ABI extensions to the current
22398 ABI@.
22400 @item -mabi=no-spe
22401 @opindex mabi=no-spe
22402 Disable Book-E SPE ABI extensions for the current ABI@.
22404 @item -mabi=ibmlongdouble
22405 @opindex mabi=ibmlongdouble
22406 Change the current ABI to use IBM extended-precision long double.
22407 This is a PowerPC 32-bit SYSV ABI option.
22409 @item -mabi=ieeelongdouble
22410 @opindex mabi=ieeelongdouble
22411 Change the current ABI to use IEEE extended-precision long double.
22412 This is a PowerPC 32-bit Linux ABI option.
22414 @item -mabi=elfv1
22415 @opindex mabi=elfv1
22416 Change the current ABI to use the ELFv1 ABI.
22417 This is the default ABI for big-endian PowerPC 64-bit Linux.
22418 Overriding the default ABI requires special system support and is
22419 likely to fail in spectacular ways.
22421 @item -mabi=elfv2
22422 @opindex mabi=elfv2
22423 Change the current ABI to use the ELFv2 ABI.
22424 This is the default ABI for little-endian PowerPC 64-bit Linux.
22425 Overriding the default ABI requires special system support and is
22426 likely to fail in spectacular ways.
22428 @item -mgnu-attribute
22429 @itemx -mno-gnu-attribute
22430 @opindex mgnu-attribute
22431 @opindex mno-gnu-attribute
22432 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22433 .gnu.attributes section that specify ABI variations in function
22434 parameters or return values.
22436 @item -mprototype
22437 @itemx -mno-prototype
22438 @opindex mprototype
22439 @opindex mno-prototype
22440 On System V.4 and embedded PowerPC systems assume that all calls to
22441 variable argument functions are properly prototyped.  Otherwise, the
22442 compiler must insert an instruction before every non-prototyped call to
22443 set or clear bit 6 of the condition code register (@code{CR}) to
22444 indicate whether floating-point values are passed in the floating-point
22445 registers in case the function takes variable arguments.  With
22446 @option{-mprototype}, only calls to prototyped variable argument functions
22447 set or clear the bit.
22449 @item -msim
22450 @opindex msim
22451 On embedded PowerPC systems, assume that the startup module is called
22452 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22453 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22454 configurations.
22456 @item -mmvme
22457 @opindex mmvme
22458 On embedded PowerPC systems, assume that the startup module is called
22459 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22460 @file{libc.a}.
22462 @item -mads
22463 @opindex mads
22464 On embedded PowerPC systems, assume that the startup module is called
22465 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22466 @file{libc.a}.
22468 @item -myellowknife
22469 @opindex myellowknife
22470 On embedded PowerPC systems, assume that the startup module is called
22471 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22472 @file{libc.a}.
22474 @item -mvxworks
22475 @opindex mvxworks
22476 On System V.4 and embedded PowerPC systems, specify that you are
22477 compiling for a VxWorks system.
22479 @item -memb
22480 @opindex memb
22481 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22482 header to indicate that @samp{eabi} extended relocations are used.
22484 @item -meabi
22485 @itemx -mno-eabi
22486 @opindex meabi
22487 @opindex mno-eabi
22488 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22489 Embedded Applications Binary Interface (EABI), which is a set of
22490 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22491 means that the stack is aligned to an 8-byte boundary, a function
22492 @code{__eabi} is called from @code{main} to set up the EABI
22493 environment, and the @option{-msdata} option can use both @code{r2} and
22494 @code{r13} to point to two separate small data areas.  Selecting
22495 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22496 no EABI initialization function is called from @code{main}, and the
22497 @option{-msdata} option only uses @code{r13} to point to a single
22498 small data area.  The @option{-meabi} option is on by default if you
22499 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22501 @item -msdata=eabi
22502 @opindex msdata=eabi
22503 On System V.4 and embedded PowerPC systems, put small initialized
22504 @code{const} global and static data in the @code{.sdata2} section, which
22505 is pointed to by register @code{r2}.  Put small initialized
22506 non-@code{const} global and static data in the @code{.sdata} section,
22507 which is pointed to by register @code{r13}.  Put small uninitialized
22508 global and static data in the @code{.sbss} section, which is adjacent to
22509 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22510 incompatible with the @option{-mrelocatable} option.  The
22511 @option{-msdata=eabi} option also sets the @option{-memb} option.
22513 @item -msdata=sysv
22514 @opindex msdata=sysv
22515 On System V.4 and embedded PowerPC systems, put small global and static
22516 data in the @code{.sdata} section, which is pointed to by register
22517 @code{r13}.  Put small uninitialized global and static data in the
22518 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22519 The @option{-msdata=sysv} option is incompatible with the
22520 @option{-mrelocatable} option.
22522 @item -msdata=default
22523 @itemx -msdata
22524 @opindex msdata=default
22525 @opindex msdata
22526 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22527 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22528 same as @option{-msdata=sysv}.
22530 @item -msdata=data
22531 @opindex msdata=data
22532 On System V.4 and embedded PowerPC systems, put small global
22533 data in the @code{.sdata} section.  Put small uninitialized global
22534 data in the @code{.sbss} section.  Do not use register @code{r13}
22535 to address small data however.  This is the default behavior unless
22536 other @option{-msdata} options are used.
22538 @item -msdata=none
22539 @itemx -mno-sdata
22540 @opindex msdata=none
22541 @opindex mno-sdata
22542 On embedded PowerPC systems, put all initialized global and static data
22543 in the @code{.data} section, and all uninitialized data in the
22544 @code{.bss} section.
22546 @item -mblock-move-inline-limit=@var{num}
22547 @opindex mblock-move-inline-limit
22548 Inline all block moves (such as calls to @code{memcpy} or structure
22549 copies) less than or equal to @var{num} bytes.  The minimum value for
22550 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22551 targets.  The default value is target-specific.
22553 @item -G @var{num}
22554 @opindex G
22555 @cindex smaller data references (PowerPC)
22556 @cindex .sdata/.sdata2 references (PowerPC)
22557 On embedded PowerPC systems, put global and static items less than or
22558 equal to @var{num} bytes into the small data or BSS sections instead of
22559 the normal data or BSS section.  By default, @var{num} is 8.  The
22560 @option{-G @var{num}} switch is also passed to the linker.
22561 All modules should be compiled with the same @option{-G @var{num}} value.
22563 @item -mregnames
22564 @itemx -mno-regnames
22565 @opindex mregnames
22566 @opindex mno-regnames
22567 On System V.4 and embedded PowerPC systems do (do not) emit register
22568 names in the assembly language output using symbolic forms.
22570 @item -mlongcall
22571 @itemx -mno-longcall
22572 @opindex mlongcall
22573 @opindex mno-longcall
22574 By default assume that all calls are far away so that a longer and more
22575 expensive calling sequence is required.  This is required for calls
22576 farther than 32 megabytes (33,554,432 bytes) from the current location.
22577 A short call is generated if the compiler knows
22578 the call cannot be that far away.  This setting can be overridden by
22579 the @code{shortcall} function attribute, or by @code{#pragma
22580 longcall(0)}.
22582 Some linkers are capable of detecting out-of-range calls and generating
22583 glue code on the fly.  On these systems, long calls are unnecessary and
22584 generate slower code.  As of this writing, the AIX linker can do this,
22585 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22586 to the GNU linker for 32-bit PowerPC systems as well.
22588 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22589 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22590 addresses represent the callee and the branch island.  The
22591 Darwin/PPC linker prefers the first address and generates a @code{bl
22592 callee} if the PPC @code{bl} instruction reaches the callee directly;
22593 otherwise, the linker generates @code{bl L42} to call the branch
22594 island.  The branch island is appended to the body of the
22595 calling function; it computes the full 32-bit address of the callee
22596 and jumps to it.
22598 On Mach-O (Darwin) systems, this option directs the compiler emit to
22599 the glue for every direct call, and the Darwin linker decides whether
22600 to use or discard it.
22602 In the future, GCC may ignore all longcall specifications
22603 when the linker is known to generate glue.
22605 @item -mtls-markers
22606 @itemx -mno-tls-markers
22607 @opindex mtls-markers
22608 @opindex mno-tls-markers
22609 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22610 specifying the function argument.  The relocation allows the linker to
22611 reliably associate function call with argument setup instructions for
22612 TLS optimization, which in turn allows GCC to better schedule the
22613 sequence.
22615 @item -mrecip
22616 @itemx -mno-recip
22617 @opindex mrecip
22618 This option enables use of the reciprocal estimate and
22619 reciprocal square root estimate instructions with additional
22620 Newton-Raphson steps to increase precision instead of doing a divide or
22621 square root and divide for floating-point arguments.  You should use
22622 the @option{-ffast-math} option when using @option{-mrecip} (or at
22623 least @option{-funsafe-math-optimizations},
22624 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22625 @option{-fno-trapping-math}).  Note that while the throughput of the
22626 sequence is generally higher than the throughput of the non-reciprocal
22627 instruction, the precision of the sequence can be decreased by up to 2
22628 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22629 roots.
22631 @item -mrecip=@var{opt}
22632 @opindex mrecip=opt
22633 This option controls which reciprocal estimate instructions
22634 may be used.  @var{opt} is a comma-separated list of options, which may
22635 be preceded by a @code{!} to invert the option:
22637 @table @samp
22639 @item all
22640 Enable all estimate instructions.
22642 @item default 
22643 Enable the default instructions, equivalent to @option{-mrecip}.
22645 @item none 
22646 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22648 @item div 
22649 Enable the reciprocal approximation instructions for both 
22650 single and double precision.
22652 @item divf 
22653 Enable the single-precision reciprocal approximation instructions.
22655 @item divd 
22656 Enable the double-precision reciprocal approximation instructions.
22658 @item rsqrt 
22659 Enable the reciprocal square root approximation instructions for both
22660 single and double precision.
22662 @item rsqrtf 
22663 Enable the single-precision reciprocal square root approximation instructions.
22665 @item rsqrtd 
22666 Enable the double-precision reciprocal square root approximation instructions.
22668 @end table
22670 So, for example, @option{-mrecip=all,!rsqrtd} enables
22671 all of the reciprocal estimate instructions, except for the
22672 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22673 which handle the double-precision reciprocal square root calculations.
22675 @item -mrecip-precision
22676 @itemx -mno-recip-precision
22677 @opindex mrecip-precision
22678 Assume (do not assume) that the reciprocal estimate instructions
22679 provide higher-precision estimates than is mandated by the PowerPC
22680 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22681 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22682 The double-precision square root estimate instructions are not generated by
22683 default on low-precision machines, since they do not provide an
22684 estimate that converges after three steps.
22686 @item -mveclibabi=@var{type}
22687 @opindex mveclibabi
22688 Specifies the ABI type to use for vectorizing intrinsics using an
22689 external library.  The only type supported at present is @samp{mass},
22690 which specifies to use IBM's Mathematical Acceleration Subsystem
22691 (MASS) libraries for vectorizing intrinsics using external libraries.
22692 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22693 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22694 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22695 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22696 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22697 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22698 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22699 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22700 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22701 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22702 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22703 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22704 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22705 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22706 for power7.  Both @option{-ftree-vectorize} and
22707 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22708 libraries must be specified at link time.
22710 @item -mfriz
22711 @itemx -mno-friz
22712 @opindex mfriz
22713 Generate (do not generate) the @code{friz} instruction when the
22714 @option{-funsafe-math-optimizations} option is used to optimize
22715 rounding of floating-point values to 64-bit integer and back to floating
22716 point.  The @code{friz} instruction does not return the same value if
22717 the floating-point number is too large to fit in an integer.
22719 @item -mpointers-to-nested-functions
22720 @itemx -mno-pointers-to-nested-functions
22721 @opindex mpointers-to-nested-functions
22722 Generate (do not generate) code to load up the static chain register
22723 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22724 systems where a function pointer points to a 3-word descriptor giving
22725 the function address, TOC value to be loaded in register @code{r2}, and
22726 static chain value to be loaded in register @code{r11}.  The
22727 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22728 call through pointers to nested functions or pointers
22729 to functions compiled in other languages that use the static chain if
22730 you use @option{-mno-pointers-to-nested-functions}.
22732 @item -msave-toc-indirect
22733 @itemx -mno-save-toc-indirect
22734 @opindex msave-toc-indirect
22735 Generate (do not generate) code to save the TOC value in the reserved
22736 stack location in the function prologue if the function calls through
22737 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22738 saved in the prologue, it is saved just before the call through the
22739 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22741 @item -mcompat-align-parm
22742 @itemx -mno-compat-align-parm
22743 @opindex mcompat-align-parm
22744 Generate (do not generate) code to pass structure parameters with a
22745 maximum alignment of 64 bits, for compatibility with older versions
22746 of GCC.
22748 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22749 structure parameter on a 128-bit boundary when that structure contained
22750 a member requiring 128-bit alignment.  This is corrected in more
22751 recent versions of GCC.  This option may be used to generate code
22752 that is compatible with functions compiled with older versions of
22753 GCC.
22755 The @option{-mno-compat-align-parm} option is the default.
22757 @item -mstack-protector-guard=@var{guard}
22758 @itemx -mstack-protector-guard-reg=@var{reg}
22759 @itemx -mstack-protector-guard-offset=@var{offset}
22760 @opindex mstack-protector-guard
22761 @opindex mstack-protector-guard-reg
22762 @opindex mstack-protector-guard-offset
22763 Generate stack protection code using canary at @var{guard}.  Supported
22764 locations are @samp{global} for global canary or @samp{tls} for per-thread
22765 canary in the TLS block (the default with GNU libc version 2.4 or later).
22767 With the latter choice the options
22768 @option{-mstack-protector-guard-reg=@var{reg}} and
22769 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22770 which register to use as base register for reading the canary, and from what
22771 offset from that base register. The default for those is as specified in the
22772 relevant ABI.
22773 @end table
22775 @node RX Options
22776 @subsection RX Options
22777 @cindex RX Options
22779 These command-line options are defined for RX targets:
22781 @table @gcctabopt
22782 @item -m64bit-doubles
22783 @itemx -m32bit-doubles
22784 @opindex m64bit-doubles
22785 @opindex m32bit-doubles
22786 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22787 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22788 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22789 works on 32-bit values, which is why the default is
22790 @option{-m32bit-doubles}.
22792 @item -fpu
22793 @itemx -nofpu
22794 @opindex fpu
22795 @opindex nofpu
22796 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22797 floating-point hardware.  The default is enabled for the RX600
22798 series and disabled for the RX200 series.
22800 Floating-point instructions are only generated for 32-bit floating-point 
22801 values, however, so the FPU hardware is not used for doubles if the
22802 @option{-m64bit-doubles} option is used.
22804 @emph{Note} If the @option{-fpu} option is enabled then
22805 @option{-funsafe-math-optimizations} is also enabled automatically.
22806 This is because the RX FPU instructions are themselves unsafe.
22808 @item -mcpu=@var{name}
22809 @opindex mcpu
22810 Selects the type of RX CPU to be targeted.  Currently three types are
22811 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22812 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22814 The only difference between @samp{RX600} and @samp{RX610} is that the
22815 @samp{RX610} does not support the @code{MVTIPL} instruction.
22817 The @samp{RX200} series does not have a hardware floating-point unit
22818 and so @option{-nofpu} is enabled by default when this type is
22819 selected.
22821 @item -mbig-endian-data
22822 @itemx -mlittle-endian-data
22823 @opindex mbig-endian-data
22824 @opindex mlittle-endian-data
22825 Store data (but not code) in the big-endian format.  The default is
22826 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22827 format.
22829 @item -msmall-data-limit=@var{N}
22830 @opindex msmall-data-limit
22831 Specifies the maximum size in bytes of global and static variables
22832 which can be placed into the small data area.  Using the small data
22833 area can lead to smaller and faster code, but the size of area is
22834 limited and it is up to the programmer to ensure that the area does
22835 not overflow.  Also when the small data area is used one of the RX's
22836 registers (usually @code{r13}) is reserved for use pointing to this
22837 area, so it is no longer available for use by the compiler.  This
22838 could result in slower and/or larger code if variables are pushed onto
22839 the stack instead of being held in this register.
22841 Note, common variables (variables that have not been initialized) and
22842 constants are not placed into the small data area as they are assigned
22843 to other sections in the output executable.
22845 The default value is zero, which disables this feature.  Note, this
22846 feature is not enabled by default with higher optimization levels
22847 (@option{-O2} etc) because of the potentially detrimental effects of
22848 reserving a register.  It is up to the programmer to experiment and
22849 discover whether this feature is of benefit to their program.  See the
22850 description of the @option{-mpid} option for a description of how the
22851 actual register to hold the small data area pointer is chosen.
22853 @item -msim
22854 @itemx -mno-sim
22855 @opindex msim
22856 @opindex mno-sim
22857 Use the simulator runtime.  The default is to use the libgloss
22858 board-specific runtime.
22860 @item -mas100-syntax
22861 @itemx -mno-as100-syntax
22862 @opindex mas100-syntax
22863 @opindex mno-as100-syntax
22864 When generating assembler output use a syntax that is compatible with
22865 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22866 assembler, but it has some restrictions so it is not generated by default.
22868 @item -mmax-constant-size=@var{N}
22869 @opindex mmax-constant-size
22870 Specifies the maximum size, in bytes, of a constant that can be used as
22871 an operand in a RX instruction.  Although the RX instruction set does
22872 allow constants of up to 4 bytes in length to be used in instructions,
22873 a longer value equates to a longer instruction.  Thus in some
22874 circumstances it can be beneficial to restrict the size of constants
22875 that are used in instructions.  Constants that are too big are instead
22876 placed into a constant pool and referenced via register indirection.
22878 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22879 or 4 means that constants of any size are allowed.
22881 @item -mrelax
22882 @opindex mrelax
22883 Enable linker relaxation.  Linker relaxation is a process whereby the
22884 linker attempts to reduce the size of a program by finding shorter
22885 versions of various instructions.  Disabled by default.
22887 @item -mint-register=@var{N}
22888 @opindex mint-register
22889 Specify the number of registers to reserve for fast interrupt handler
22890 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22891 means that register @code{r13} is reserved for the exclusive use
22892 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22893 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22894 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22895 A value of 0, the default, does not reserve any registers.
22897 @item -msave-acc-in-interrupts
22898 @opindex msave-acc-in-interrupts
22899 Specifies that interrupt handler functions should preserve the
22900 accumulator register.  This is only necessary if normal code might use
22901 the accumulator register, for example because it performs 64-bit
22902 multiplications.  The default is to ignore the accumulator as this
22903 makes the interrupt handlers faster.
22905 @item -mpid
22906 @itemx -mno-pid
22907 @opindex mpid
22908 @opindex mno-pid
22909 Enables the generation of position independent data.  When enabled any
22910 access to constant data is done via an offset from a base address
22911 held in a register.  This allows the location of constant data to be
22912 determined at run time without requiring the executable to be
22913 relocated, which is a benefit to embedded applications with tight
22914 memory constraints.  Data that can be modified is not affected by this
22915 option.
22917 Note, using this feature reserves a register, usually @code{r13}, for
22918 the constant data base address.  This can result in slower and/or
22919 larger code, especially in complicated functions.
22921 The actual register chosen to hold the constant data base address
22922 depends upon whether the @option{-msmall-data-limit} and/or the
22923 @option{-mint-register} command-line options are enabled.  Starting
22924 with register @code{r13} and proceeding downwards, registers are
22925 allocated first to satisfy the requirements of @option{-mint-register},
22926 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22927 is possible for the small data area register to be @code{r8} if both
22928 @option{-mint-register=4} and @option{-mpid} are specified on the
22929 command line.
22931 By default this feature is not enabled.  The default can be restored
22932 via the @option{-mno-pid} command-line option.
22934 @item -mno-warn-multiple-fast-interrupts
22935 @itemx -mwarn-multiple-fast-interrupts
22936 @opindex mno-warn-multiple-fast-interrupts
22937 @opindex mwarn-multiple-fast-interrupts
22938 Prevents GCC from issuing a warning message if it finds more than one
22939 fast interrupt handler when it is compiling a file.  The default is to
22940 issue a warning for each extra fast interrupt handler found, as the RX
22941 only supports one such interrupt.
22943 @item -mallow-string-insns
22944 @itemx -mno-allow-string-insns
22945 @opindex mallow-string-insns
22946 @opindex mno-allow-string-insns
22947 Enables or disables the use of the string manipulation instructions
22948 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22949 @code{SWHILE} and also the @code{RMPA} instruction.  These
22950 instructions may prefetch data, which is not safe to do if accessing
22951 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22952 for more information).
22954 The default is to allow these instructions, but it is not possible for
22955 GCC to reliably detect all circumstances where a string instruction
22956 might be used to access an I/O register, so their use cannot be
22957 disabled automatically.  Instead it is reliant upon the programmer to
22958 use the @option{-mno-allow-string-insns} option if their program
22959 accesses I/O space.
22961 When the instructions are enabled GCC defines the C preprocessor
22962 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22963 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22965 @item -mjsr
22966 @itemx -mno-jsr
22967 @opindex mjsr
22968 @opindex mno-jsr
22969 Use only (or not only) @code{JSR} instructions to access functions.
22970 This option can be used when code size exceeds the range of @code{BSR}
22971 instructions.  Note that @option{-mno-jsr} does not mean to not use
22972 @code{JSR} but instead means that any type of branch may be used.
22973 @end table
22975 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22976 has special significance to the RX port when used with the
22977 @code{interrupt} function attribute.  This attribute indicates a
22978 function intended to process fast interrupts.  GCC ensures
22979 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22980 and/or @code{r13} and only provided that the normal use of the
22981 corresponding registers have been restricted via the
22982 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22983 options.
22985 @node S/390 and zSeries Options
22986 @subsection S/390 and zSeries Options
22987 @cindex S/390 and zSeries Options
22989 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22991 @table @gcctabopt
22992 @item -mhard-float
22993 @itemx -msoft-float
22994 @opindex mhard-float
22995 @opindex msoft-float
22996 Use (do not use) the hardware floating-point instructions and registers
22997 for floating-point operations.  When @option{-msoft-float} is specified,
22998 functions in @file{libgcc.a} are used to perform floating-point
22999 operations.  When @option{-mhard-float} is specified, the compiler
23000 generates IEEE floating-point instructions.  This is the default.
23002 @item -mhard-dfp
23003 @itemx -mno-hard-dfp
23004 @opindex mhard-dfp
23005 @opindex mno-hard-dfp
23006 Use (do not use) the hardware decimal-floating-point instructions for
23007 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23008 specified, functions in @file{libgcc.a} are used to perform
23009 decimal-floating-point operations.  When @option{-mhard-dfp} is
23010 specified, the compiler generates decimal-floating-point hardware
23011 instructions.  This is the default for @option{-march=z9-ec} or higher.
23013 @item -mlong-double-64
23014 @itemx -mlong-double-128
23015 @opindex mlong-double-64
23016 @opindex mlong-double-128
23017 These switches control the size of @code{long double} type. A size
23018 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23019 type. This is the default.
23021 @item -mbackchain
23022 @itemx -mno-backchain
23023 @opindex mbackchain
23024 @opindex mno-backchain
23025 Store (do not store) the address of the caller's frame as backchain pointer
23026 into the callee's stack frame.
23027 A backchain may be needed to allow debugging using tools that do not understand
23028 DWARF call frame information.
23029 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23030 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23031 the backchain is placed into the topmost word of the 96/160 byte register
23032 save area.
23034 In general, code compiled with @option{-mbackchain} is call-compatible with
23035 code compiled with @option{-mmo-backchain}; however, use of the backchain
23036 for debugging purposes usually requires that the whole binary is built with
23037 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23038 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23039 to build a linux kernel use @option{-msoft-float}.
23041 The default is to not maintain the backchain.
23043 @item -mpacked-stack
23044 @itemx -mno-packed-stack
23045 @opindex mpacked-stack
23046 @opindex mno-packed-stack
23047 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23048 specified, the compiler uses the all fields of the 96/160 byte register save
23049 area only for their default purpose; unused fields still take up stack space.
23050 When @option{-mpacked-stack} is specified, register save slots are densely
23051 packed at the top of the register save area; unused space is reused for other
23052 purposes, allowing for more efficient use of the available stack space.
23053 However, when @option{-mbackchain} is also in effect, the topmost word of
23054 the save area is always used to store the backchain, and the return address
23055 register is always saved two words below the backchain.
23057 As long as the stack frame backchain is not used, code generated with
23058 @option{-mpacked-stack} is call-compatible with code generated with
23059 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23060 S/390 or zSeries generated code that uses the stack frame backchain at run
23061 time, not just for debugging purposes.  Such code is not call-compatible
23062 with code compiled with @option{-mpacked-stack}.  Also, note that the
23063 combination of @option{-mbackchain},
23064 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23065 to build a linux kernel use @option{-msoft-float}.
23067 The default is to not use the packed stack layout.
23069 @item -msmall-exec
23070 @itemx -mno-small-exec
23071 @opindex msmall-exec
23072 @opindex mno-small-exec
23073 Generate (or do not generate) code using the @code{bras} instruction
23074 to do subroutine calls.
23075 This only works reliably if the total executable size does not
23076 exceed 64k.  The default is to use the @code{basr} instruction instead,
23077 which does not have this limitation.
23079 @item -m64
23080 @itemx -m31
23081 @opindex m64
23082 @opindex m31
23083 When @option{-m31} is specified, generate code compliant to the
23084 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23085 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23086 particular to generate 64-bit instructions.  For the @samp{s390}
23087 targets, the default is @option{-m31}, while the @samp{s390x}
23088 targets default to @option{-m64}.
23090 @item -mzarch
23091 @itemx -mesa
23092 @opindex mzarch
23093 @opindex mesa
23094 When @option{-mzarch} is specified, generate code using the
23095 instructions available on z/Architecture.
23096 When @option{-mesa} is specified, generate code using the
23097 instructions available on ESA/390.  Note that @option{-mesa} is
23098 not possible with @option{-m64}.
23099 When generating code compliant to the GNU/Linux for S/390 ABI,
23100 the default is @option{-mesa}.  When generating code compliant
23101 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23103 @item -mhtm
23104 @itemx -mno-htm
23105 @opindex mhtm
23106 @opindex mno-htm
23107 The @option{-mhtm} option enables a set of builtins making use of
23108 instructions available with the transactional execution facility
23109 introduced with the IBM zEnterprise EC12 machine generation
23110 @ref{S/390 System z Built-in Functions}.
23111 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23113 @item -mvx
23114 @itemx -mno-vx
23115 @opindex mvx
23116 @opindex mno-vx
23117 When @option{-mvx} is specified, generate code using the instructions
23118 available with the vector extension facility introduced with the IBM
23119 z13 machine generation.
23120 This option changes the ABI for some vector type values with regard to
23121 alignment and calling conventions.  In case vector type values are
23122 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23123 command will be added to mark the resulting binary with the ABI used.
23124 @option{-mvx} is enabled by default when using @option{-march=z13}.
23126 @item -mzvector
23127 @itemx -mno-zvector
23128 @opindex mzvector
23129 @opindex mno-zvector
23130 The @option{-mzvector} option enables vector language extensions and
23131 builtins using instructions available with the vector extension
23132 facility introduced with the IBM z13 machine generation.
23133 This option adds support for @samp{vector} to be used as a keyword to
23134 define vector type variables and arguments.  @samp{vector} is only
23135 available when GNU extensions are enabled.  It will not be expanded
23136 when requesting strict standard compliance e.g. with @option{-std=c99}.
23137 In addition to the GCC low-level builtins @option{-mzvector} enables
23138 a set of builtins added for compatibility with AltiVec-style
23139 implementations like Power and Cell.  In order to make use of these
23140 builtins the header file @file{vecintrin.h} needs to be included.
23141 @option{-mzvector} is disabled by default.
23143 @item -mmvcle
23144 @itemx -mno-mvcle
23145 @opindex mmvcle
23146 @opindex mno-mvcle
23147 Generate (or do not generate) code using the @code{mvcle} instruction
23148 to perform block moves.  When @option{-mno-mvcle} is specified,
23149 use a @code{mvc} loop instead.  This is the default unless optimizing for
23150 size.
23152 @item -mdebug
23153 @itemx -mno-debug
23154 @opindex mdebug
23155 @opindex mno-debug
23156 Print (or do not print) additional debug information when compiling.
23157 The default is to not print debug information.
23159 @item -march=@var{cpu-type}
23160 @opindex march
23161 Generate code that runs on @var{cpu-type}, which is the name of a
23162 system representing a certain processor type.  Possible values for
23163 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23164 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23165 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23166 @samp{native}.
23168 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23169 @samp{g6} are deprecated and will be removed with future releases.
23171 Specifying @samp{native} as cpu type can be used to select the best
23172 architecture option for the host processor.
23173 @option{-march=native} has no effect if GCC does not recognize the
23174 processor.
23176 @item -mtune=@var{cpu-type}
23177 @opindex mtune
23178 Tune to @var{cpu-type} everything applicable about the generated code,
23179 except for the ABI and the set of available instructions.
23180 The list of @var{cpu-type} values is the same as for @option{-march}.
23181 The default is the value used for @option{-march}.
23183 @item -mtpf-trace
23184 @itemx -mno-tpf-trace
23185 @opindex mtpf-trace
23186 @opindex mno-tpf-trace
23187 Generate code that adds (does not add) in TPF OS specific branches to trace
23188 routines in the operating system.  This option is off by default, even
23189 when compiling for the TPF OS@.
23191 @item -mfused-madd
23192 @itemx -mno-fused-madd
23193 @opindex mfused-madd
23194 @opindex mno-fused-madd
23195 Generate code that uses (does not use) the floating-point multiply and
23196 accumulate instructions.  These instructions are generated by default if
23197 hardware floating point is used.
23199 @item -mwarn-framesize=@var{framesize}
23200 @opindex mwarn-framesize
23201 Emit a warning if the current function exceeds the given frame size.  Because
23202 this is a compile-time check it doesn't need to be a real problem when the program
23203 runs.  It is intended to identify functions that most probably cause
23204 a stack overflow.  It is useful to be used in an environment with limited stack
23205 size e.g.@: the linux kernel.
23207 @item -mwarn-dynamicstack
23208 @opindex mwarn-dynamicstack
23209 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23210 arrays.  This is generally a bad idea with a limited stack size.
23212 @item -mstack-guard=@var{stack-guard}
23213 @itemx -mstack-size=@var{stack-size}
23214 @opindex mstack-guard
23215 @opindex mstack-size
23216 If these options are provided the S/390 back end emits additional instructions in
23217 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23218 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23219 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23220 the frame size of the compiled function is chosen.
23221 These options are intended to be used to help debugging stack overflow problems.
23222 The additionally emitted code causes only little overhead and hence can also be
23223 used in production-like systems without greater performance degradation.  The given
23224 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23225 @var{stack-guard} without exceeding 64k.
23226 In order to be efficient the extra code makes the assumption that the stack starts
23227 at an address aligned to the value given by @var{stack-size}.
23228 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23230 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23231 @opindex mhotpatch
23232 If the hotpatch option is enabled, a ``hot-patching'' function
23233 prologue is generated for all functions in the compilation unit.
23234 The funtion label is prepended with the given number of two-byte
23235 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23236 the label, 2 * @var{post-halfwords} bytes are appended, using the
23237 largest NOP like instructions the architecture allows (maximum
23238 1000000).
23240 If both arguments are zero, hotpatching is disabled.
23242 This option can be overridden for individual functions with the
23243 @code{hotpatch} attribute.
23244 @end table
23246 @node Score Options
23247 @subsection Score Options
23248 @cindex Score Options
23250 These options are defined for Score implementations:
23252 @table @gcctabopt
23253 @item -meb
23254 @opindex meb
23255 Compile code for big-endian mode.  This is the default.
23257 @item -mel
23258 @opindex mel
23259 Compile code for little-endian mode.
23261 @item -mnhwloop
23262 @opindex mnhwloop
23263 Disable generation of @code{bcnz} instructions.
23265 @item -muls
23266 @opindex muls
23267 Enable generation of unaligned load and store instructions.
23269 @item -mmac
23270 @opindex mmac
23271 Enable the use of multiply-accumulate instructions. Disabled by default.
23273 @item -mscore5
23274 @opindex mscore5
23275 Specify the SCORE5 as the target architecture.
23277 @item -mscore5u
23278 @opindex mscore5u
23279 Specify the SCORE5U of the target architecture.
23281 @item -mscore7
23282 @opindex mscore7
23283 Specify the SCORE7 as the target architecture. This is the default.
23285 @item -mscore7d
23286 @opindex mscore7d
23287 Specify the SCORE7D as the target architecture.
23288 @end table
23290 @node SH Options
23291 @subsection SH Options
23293 These @samp{-m} options are defined for the SH implementations:
23295 @table @gcctabopt
23296 @item -m1
23297 @opindex m1
23298 Generate code for the SH1.
23300 @item -m2
23301 @opindex m2
23302 Generate code for the SH2.
23304 @item -m2e
23305 Generate code for the SH2e.
23307 @item -m2a-nofpu
23308 @opindex m2a-nofpu
23309 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23310 that the floating-point unit is not used.
23312 @item -m2a-single-only
23313 @opindex m2a-single-only
23314 Generate code for the SH2a-FPU, in such a way that no double-precision
23315 floating-point operations are used.
23317 @item -m2a-single
23318 @opindex m2a-single
23319 Generate code for the SH2a-FPU assuming the floating-point unit is in
23320 single-precision mode by default.
23322 @item -m2a
23323 @opindex m2a
23324 Generate code for the SH2a-FPU assuming the floating-point unit is in
23325 double-precision mode by default.
23327 @item -m3
23328 @opindex m3
23329 Generate code for the SH3.
23331 @item -m3e
23332 @opindex m3e
23333 Generate code for the SH3e.
23335 @item -m4-nofpu
23336 @opindex m4-nofpu
23337 Generate code for the SH4 without a floating-point unit.
23339 @item -m4-single-only
23340 @opindex m4-single-only
23341 Generate code for the SH4 with a floating-point unit that only
23342 supports single-precision arithmetic.
23344 @item -m4-single
23345 @opindex m4-single
23346 Generate code for the SH4 assuming the floating-point unit is in
23347 single-precision mode by default.
23349 @item -m4
23350 @opindex m4
23351 Generate code for the SH4.
23353 @item -m4-100
23354 @opindex m4-100
23355 Generate code for SH4-100.
23357 @item -m4-100-nofpu
23358 @opindex m4-100-nofpu
23359 Generate code for SH4-100 in such a way that the
23360 floating-point unit is not used.
23362 @item -m4-100-single
23363 @opindex m4-100-single
23364 Generate code for SH4-100 assuming the floating-point unit is in
23365 single-precision mode by default.
23367 @item -m4-100-single-only
23368 @opindex m4-100-single-only
23369 Generate code for SH4-100 in such a way that no double-precision
23370 floating-point operations are used.
23372 @item -m4-200
23373 @opindex m4-200
23374 Generate code for SH4-200.
23376 @item -m4-200-nofpu
23377 @opindex m4-200-nofpu
23378 Generate code for SH4-200 without in such a way that the
23379 floating-point unit is not used.
23381 @item -m4-200-single
23382 @opindex m4-200-single
23383 Generate code for SH4-200 assuming the floating-point unit is in
23384 single-precision mode by default.
23386 @item -m4-200-single-only
23387 @opindex m4-200-single-only
23388 Generate code for SH4-200 in such a way that no double-precision
23389 floating-point operations are used.
23391 @item -m4-300
23392 @opindex m4-300
23393 Generate code for SH4-300.
23395 @item -m4-300-nofpu
23396 @opindex m4-300-nofpu
23397 Generate code for SH4-300 without in such a way that the
23398 floating-point unit is not used.
23400 @item -m4-300-single
23401 @opindex m4-300-single
23402 Generate code for SH4-300 in such a way that no double-precision
23403 floating-point operations are used.
23405 @item -m4-300-single-only
23406 @opindex m4-300-single-only
23407 Generate code for SH4-300 in such a way that no double-precision
23408 floating-point operations are used.
23410 @item -m4-340
23411 @opindex m4-340
23412 Generate code for SH4-340 (no MMU, no FPU).
23414 @item -m4-500
23415 @opindex m4-500
23416 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23417 assembler.
23419 @item -m4a-nofpu
23420 @opindex m4a-nofpu
23421 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23422 floating-point unit is not used.
23424 @item -m4a-single-only
23425 @opindex m4a-single-only
23426 Generate code for the SH4a, in such a way that no double-precision
23427 floating-point operations are used.
23429 @item -m4a-single
23430 @opindex m4a-single
23431 Generate code for the SH4a assuming the floating-point unit is in
23432 single-precision mode by default.
23434 @item -m4a
23435 @opindex m4a
23436 Generate code for the SH4a.
23438 @item -m4al
23439 @opindex m4al
23440 Same as @option{-m4a-nofpu}, except that it implicitly passes
23441 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23442 instructions at the moment.
23444 @item -mb
23445 @opindex mb
23446 Compile code for the processor in big-endian mode.
23448 @item -ml
23449 @opindex ml
23450 Compile code for the processor in little-endian mode.
23452 @item -mdalign
23453 @opindex mdalign
23454 Align doubles at 64-bit boundaries.  Note that this changes the calling
23455 conventions, and thus some functions from the standard C library do
23456 not work unless you recompile it first with @option{-mdalign}.
23458 @item -mrelax
23459 @opindex mrelax
23460 Shorten some address references at link time, when possible; uses the
23461 linker option @option{-relax}.
23463 @item -mbigtable
23464 @opindex mbigtable
23465 Use 32-bit offsets in @code{switch} tables.  The default is to use
23466 16-bit offsets.
23468 @item -mbitops
23469 @opindex mbitops
23470 Enable the use of bit manipulation instructions on SH2A.
23472 @item -mfmovd
23473 @opindex mfmovd
23474 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23475 alignment constraints.
23477 @item -mrenesas
23478 @opindex mrenesas
23479 Comply with the calling conventions defined by Renesas.
23481 @item -mno-renesas
23482 @opindex mno-renesas
23483 Comply with the calling conventions defined for GCC before the Renesas
23484 conventions were available.  This option is the default for all
23485 targets of the SH toolchain.
23487 @item -mnomacsave
23488 @opindex mnomacsave
23489 Mark the @code{MAC} register as call-clobbered, even if
23490 @option{-mrenesas} is given.
23492 @item -mieee
23493 @itemx -mno-ieee
23494 @opindex mieee
23495 @opindex mno-ieee
23496 Control the IEEE compliance of floating-point comparisons, which affects the
23497 handling of cases where the result of a comparison is unordered.  By default
23498 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23499 enabled @option{-mno-ieee} is implicitly set, which results in faster
23500 floating-point greater-equal and less-equal comparisons.  The implicit settings
23501 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23503 @item -minline-ic_invalidate
23504 @opindex minline-ic_invalidate
23505 Inline code to invalidate instruction cache entries after setting up
23506 nested function trampolines.
23507 This option has no effect if @option{-musermode} is in effect and the selected
23508 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23509 instruction.
23510 If the selected code generation option does not allow the use of the @code{icbi}
23511 instruction, and @option{-musermode} is not in effect, the inlined code
23512 manipulates the instruction cache address array directly with an associative
23513 write.  This not only requires privileged mode at run time, but it also
23514 fails if the cache line had been mapped via the TLB and has become unmapped.
23516 @item -misize
23517 @opindex misize
23518 Dump instruction size and location in the assembly code.
23520 @item -mpadstruct
23521 @opindex mpadstruct
23522 This option is deprecated.  It pads structures to multiple of 4 bytes,
23523 which is incompatible with the SH ABI@.
23525 @item -matomic-model=@var{model}
23526 @opindex matomic-model=@var{model}
23527 Sets the model of atomic operations and additional parameters as a comma
23528 separated list.  For details on the atomic built-in functions see
23529 @ref{__atomic Builtins}.  The following models and parameters are supported:
23531 @table @samp
23533 @item none
23534 Disable compiler generated atomic sequences and emit library calls for atomic
23535 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23537 @item soft-gusa
23538 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23539 built-in functions.  The generated atomic sequences require additional support
23540 from the interrupt/exception handling code of the system and are only suitable
23541 for SH3* and SH4* single-core systems.  This option is enabled by default when
23542 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23543 this option also partially utilizes the hardware atomic instructions
23544 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23545 @samp{strict} is specified.  
23547 @item soft-tcb
23548 Generate software atomic sequences that use a variable in the thread control
23549 block.  This is a variation of the gUSA sequences which can also be used on
23550 SH1* and SH2* targets.  The generated atomic sequences require additional
23551 support from the interrupt/exception handling code of the system and are only
23552 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23553 parameter has to be specified as well.
23555 @item soft-imask
23556 Generate software atomic sequences that temporarily disable interrupts by
23557 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23558 in privileged mode and is only suitable for single-core systems.  Additional
23559 support from the interrupt/exception handling code of the system is not
23560 required.  This model is enabled by default when the target is
23561 @code{sh*-*-linux*} and SH1* or SH2*.
23563 @item hard-llcs
23564 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23565 instructions only.  This is only available on SH4A and is suitable for
23566 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23567 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23568 Code compiled with this option is also compatible with other software
23569 atomic model interrupt/exception handling systems if executed on an SH4A
23570 system.  Additional support from the interrupt/exception handling code of the
23571 system is not required for this model.
23573 @item gbr-offset=
23574 This parameter specifies the offset in bytes of the variable in the thread
23575 control block structure that should be used by the generated atomic sequences
23576 when the @samp{soft-tcb} model has been selected.  For other models this
23577 parameter is ignored.  The specified value must be an integer multiple of four
23578 and in the range 0-1020.
23580 @item strict
23581 This parameter prevents mixed usage of multiple atomic models, even if they
23582 are compatible, and makes the compiler generate atomic sequences of the
23583 specified model only.
23585 @end table
23587 @item -mtas
23588 @opindex mtas
23589 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23590 Notice that depending on the particular hardware and software configuration
23591 this can degrade overall performance due to the operand cache line flushes
23592 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23593 processors the @code{tas.b} instruction must be used with caution since it
23594 can result in data corruption for certain cache configurations.
23596 @item -mprefergot
23597 @opindex mprefergot
23598 When generating position-independent code, emit function calls using
23599 the Global Offset Table instead of the Procedure Linkage Table.
23601 @item -musermode
23602 @itemx -mno-usermode
23603 @opindex musermode
23604 @opindex mno-usermode
23605 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23606 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23607 inlined code would not work in user mode.  @option{-musermode} is the default
23608 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23609 @option{-musermode} has no effect, since there is no user mode.
23611 @item -multcost=@var{number}
23612 @opindex multcost=@var{number}
23613 Set the cost to assume for a multiply insn.
23615 @item -mdiv=@var{strategy}
23616 @opindex mdiv=@var{strategy}
23617 Set the division strategy to be used for integer division operations.
23618 @var{strategy} can be one of: 
23620 @table @samp
23622 @item call-div1
23623 Calls a library function that uses the single-step division instruction
23624 @code{div1} to perform the operation.  Division by zero calculates an
23625 unspecified result and does not trap.  This is the default except for SH4,
23626 SH2A and SHcompact.
23628 @item call-fp
23629 Calls a library function that performs the operation in double precision
23630 floating point.  Division by zero causes a floating-point exception.  This is
23631 the default for SHcompact with FPU.  Specifying this for targets that do not
23632 have a double precision FPU defaults to @code{call-div1}.
23634 @item call-table
23635 Calls a library function that uses a lookup table for small divisors and
23636 the @code{div1} instruction with case distinction for larger divisors.  Division
23637 by zero calculates an unspecified result and does not trap.  This is the default
23638 for SH4.  Specifying this for targets that do not have dynamic shift
23639 instructions defaults to @code{call-div1}.
23641 @end table
23643 When a division strategy has not been specified the default strategy is
23644 selected based on the current target.  For SH2A the default strategy is to
23645 use the @code{divs} and @code{divu} instructions instead of library function
23646 calls.
23648 @item -maccumulate-outgoing-args
23649 @opindex maccumulate-outgoing-args
23650 Reserve space once for outgoing arguments in the function prologue rather
23651 than around each call.  Generally beneficial for performance and size.  Also
23652 needed for unwinding to avoid changing the stack frame around conditional code.
23654 @item -mdivsi3_libfunc=@var{name}
23655 @opindex mdivsi3_libfunc=@var{name}
23656 Set the name of the library function used for 32-bit signed division to
23657 @var{name}.
23658 This only affects the name used in the @samp{call} division strategies, and
23659 the compiler still expects the same sets of input/output/clobbered registers as
23660 if this option were not present.
23662 @item -mfixed-range=@var{register-range}
23663 @opindex mfixed-range
23664 Generate code treating the given register range as fixed registers.
23665 A fixed register is one that the register allocator can not use.  This is
23666 useful when compiling kernel code.  A register range is specified as
23667 two registers separated by a dash.  Multiple register ranges can be
23668 specified separated by a comma.
23670 @item -mbranch-cost=@var{num}
23671 @opindex mbranch-cost=@var{num}
23672 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23673 make the compiler try to generate more branch-free code if possible.  
23674 If not specified the value is selected depending on the processor type that
23675 is being compiled for.
23677 @item -mzdcbranch
23678 @itemx -mno-zdcbranch
23679 @opindex mzdcbranch
23680 @opindex mno-zdcbranch
23681 Assume (do not assume) that zero displacement conditional branch instructions
23682 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23683 compiler prefers zero displacement branch code sequences.  This is
23684 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23685 disabled by specifying @option{-mno-zdcbranch}.
23687 @item -mcbranch-force-delay-slot
23688 @opindex mcbranch-force-delay-slot
23689 Force the usage of delay slots for conditional branches, which stuffs the delay
23690 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23691 this option is disabled.  It can be enabled to work around hardware bugs as
23692 found in the original SH7055.
23694 @item -mfused-madd
23695 @itemx -mno-fused-madd
23696 @opindex mfused-madd
23697 @opindex mno-fused-madd
23698 Generate code that uses (does not use) the floating-point multiply and
23699 accumulate instructions.  These instructions are generated by default
23700 if hardware floating point is used.  The machine-dependent
23701 @option{-mfused-madd} option is now mapped to the machine-independent
23702 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23703 mapped to @option{-ffp-contract=off}.
23705 @item -mfsca
23706 @itemx -mno-fsca
23707 @opindex mfsca
23708 @opindex mno-fsca
23709 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23710 and cosine approximations.  The option @option{-mfsca} must be used in
23711 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23712 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23713 approximations even if @option{-funsafe-math-optimizations} is in effect.
23715 @item -mfsrra
23716 @itemx -mno-fsrra
23717 @opindex mfsrra
23718 @opindex mno-fsrra
23719 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23720 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23721 in combination with @option{-funsafe-math-optimizations} and
23722 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23723 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23724 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23725 in effect.
23727 @item -mpretend-cmove
23728 @opindex mpretend-cmove
23729 Prefer zero-displacement conditional branches for conditional move instruction
23730 patterns.  This can result in faster code on the SH4 processor.
23732 @item -mfdpic
23733 @opindex fdpic
23734 Generate code using the FDPIC ABI.
23736 @end table
23738 @node Solaris 2 Options
23739 @subsection Solaris 2 Options
23740 @cindex Solaris 2 options
23742 These @samp{-m} options are supported on Solaris 2:
23744 @table @gcctabopt
23745 @item -mclear-hwcap
23746 @opindex mclear-hwcap
23747 @option{-mclear-hwcap} tells the compiler to remove the hardware
23748 capabilities generated by the Solaris assembler.  This is only necessary
23749 when object files use ISA extensions not supported by the current
23750 machine, but check at runtime whether or not to use them.
23752 @item -mimpure-text
23753 @opindex mimpure-text
23754 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23755 the compiler to not pass @option{-z text} to the linker when linking a
23756 shared object.  Using this option, you can link position-dependent
23757 code into a shared object.
23759 @option{-mimpure-text} suppresses the ``relocations remain against
23760 allocatable but non-writable sections'' linker error message.
23761 However, the necessary relocations trigger copy-on-write, and the
23762 shared object is not actually shared across processes.  Instead of
23763 using @option{-mimpure-text}, you should compile all source code with
23764 @option{-fpic} or @option{-fPIC}.
23766 @end table
23768 These switches are supported in addition to the above on Solaris 2:
23770 @table @gcctabopt
23771 @item -pthreads
23772 @opindex pthreads
23773 This is a synonym for @option{-pthread}.
23774 @end table
23776 @node SPARC Options
23777 @subsection SPARC Options
23778 @cindex SPARC options
23780 These @samp{-m} options are supported on the SPARC:
23782 @table @gcctabopt
23783 @item -mno-app-regs
23784 @itemx -mapp-regs
23785 @opindex mno-app-regs
23786 @opindex mapp-regs
23787 Specify @option{-mapp-regs} to generate output using the global registers
23788 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23789 global register 1, each global register 2 through 4 is then treated as an
23790 allocable register that is clobbered by function calls.  This is the default.
23792 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23793 specify @option{-mno-app-regs}.  You should compile libraries and system
23794 software with this option.
23796 @item -mflat
23797 @itemx -mno-flat
23798 @opindex mflat
23799 @opindex mno-flat
23800 With @option{-mflat}, the compiler does not generate save/restore instructions
23801 and uses a ``flat'' or single register window model.  This model is compatible
23802 with the regular register window model.  The local registers and the input
23803 registers (0--5) are still treated as ``call-saved'' registers and are
23804 saved on the stack as needed.
23806 With @option{-mno-flat} (the default), the compiler generates save/restore
23807 instructions (except for leaf functions).  This is the normal operating mode.
23809 @item -mfpu
23810 @itemx -mhard-float
23811 @opindex mfpu
23812 @opindex mhard-float
23813 Generate output containing floating-point instructions.  This is the
23814 default.
23816 @item -mno-fpu
23817 @itemx -msoft-float
23818 @opindex mno-fpu
23819 @opindex msoft-float
23820 Generate output containing library calls for floating point.
23821 @strong{Warning:} the requisite libraries are not available for all SPARC
23822 targets.  Normally the facilities of the machine's usual C compiler are
23823 used, but this cannot be done directly in cross-compilation.  You must make
23824 your own arrangements to provide suitable library functions for
23825 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23826 @samp{sparclite-*-*} do provide software floating-point support.
23828 @option{-msoft-float} changes the calling convention in the output file;
23829 therefore, it is only useful if you compile @emph{all} of a program with
23830 this option.  In particular, you need to compile @file{libgcc.a}, the
23831 library that comes with GCC, with @option{-msoft-float} in order for
23832 this to work.
23834 @item -mhard-quad-float
23835 @opindex mhard-quad-float
23836 Generate output containing quad-word (long double) floating-point
23837 instructions.
23839 @item -msoft-quad-float
23840 @opindex msoft-quad-float
23841 Generate output containing library calls for quad-word (long double)
23842 floating-point instructions.  The functions called are those specified
23843 in the SPARC ABI@.  This is the default.
23845 As of this writing, there are no SPARC implementations that have hardware
23846 support for the quad-word floating-point instructions.  They all invoke
23847 a trap handler for one of these instructions, and then the trap handler
23848 emulates the effect of the instruction.  Because of the trap handler overhead,
23849 this is much slower than calling the ABI library routines.  Thus the
23850 @option{-msoft-quad-float} option is the default.
23852 @item -mno-unaligned-doubles
23853 @itemx -munaligned-doubles
23854 @opindex mno-unaligned-doubles
23855 @opindex munaligned-doubles
23856 Assume that doubles have 8-byte alignment.  This is the default.
23858 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23859 alignment only if they are contained in another type, or if they have an
23860 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23861 Specifying this option avoids some rare compatibility problems with code
23862 generated by other compilers.  It is not the default because it results
23863 in a performance loss, especially for floating-point code.
23865 @item -muser-mode
23866 @itemx -mno-user-mode
23867 @opindex muser-mode
23868 @opindex mno-user-mode
23869 Do not generate code that can only run in supervisor mode.  This is relevant
23870 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23871 is the default.
23873 @item -mfaster-structs
23874 @itemx -mno-faster-structs
23875 @opindex mfaster-structs
23876 @opindex mno-faster-structs
23877 With @option{-mfaster-structs}, the compiler assumes that structures
23878 should have 8-byte alignment.  This enables the use of pairs of
23879 @code{ldd} and @code{std} instructions for copies in structure
23880 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23881 However, the use of this changed alignment directly violates the SPARC
23882 ABI@.  Thus, it's intended only for use on targets where the developer
23883 acknowledges that their resulting code is not directly in line with
23884 the rules of the ABI@.
23886 @item -mstd-struct-return
23887 @itemx -mno-std-struct-return
23888 @opindex mstd-struct-return
23889 @opindex mno-std-struct-return
23890 With @option{-mstd-struct-return}, the compiler generates checking code
23891 in functions returning structures or unions to detect size mismatches
23892 between the two sides of function calls, as per the 32-bit ABI@.
23894 The default is @option{-mno-std-struct-return}.  This option has no effect
23895 in 64-bit mode.
23897 @item -mlra
23898 @itemx -mno-lra
23899 @opindex mlra
23900 @opindex mno-lra
23901 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23902 so @option{-mno-lra} needs to be passed to get old Reload.
23904 @item -mcpu=@var{cpu_type}
23905 @opindex mcpu
23906 Set the instruction set, register set, and instruction scheduling parameters
23907 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23908 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23909 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23910 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23911 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23912 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
23914 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23915 which selects the best architecture option for the host processor.
23916 @option{-mcpu=native} has no effect if GCC does not recognize
23917 the processor.
23919 Default instruction scheduling parameters are used for values that select
23920 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23921 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23923 Here is a list of each supported architecture and their supported
23924 implementations.
23926 @table @asis
23927 @item v7
23928 cypress, leon3v7
23930 @item v8
23931 supersparc, hypersparc, leon, leon3
23933 @item sparclite
23934 f930, f934, sparclite86x
23936 @item sparclet
23937 tsc701
23939 @item v9
23940 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
23941 niagara7, m8
23942 @end table
23944 By default (unless configured otherwise), GCC generates code for the V7
23945 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23946 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23947 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23948 SPARCStation 1, 2, IPX etc.
23950 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23951 architecture.  The only difference from V7 code is that the compiler emits
23952 the integer multiply and integer divide instructions which exist in SPARC-V8
23953 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23954 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23955 2000 series.
23957 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23958 the SPARC architecture.  This adds the integer multiply, integer divide step
23959 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23960 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23961 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23962 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23963 MB86934 chip, which is the more recent SPARClite with FPU@.
23965 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23966 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23967 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23968 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23969 optimizes it for the TEMIC SPARClet chip.
23971 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23972 architecture.  This adds 64-bit integer and floating-point move instructions,
23973 3 additional floating-point condition code registers and conditional move
23974 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23975 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23976 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23977 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23978 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23979 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23980 additionally optimizes it for Sun UltraSPARC T2 chips. With
23981 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23982 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23983 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23984 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23985 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
23986 additionally optimizes it for Oracle M8 chips.
23988 @item -mtune=@var{cpu_type}
23989 @opindex mtune
23990 Set the instruction scheduling parameters for machine type
23991 @var{cpu_type}, but do not set the instruction set or register set that the
23992 option @option{-mcpu=@var{cpu_type}} does.
23994 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23995 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23996 that select a particular CPU implementation.  Those are
23997 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23998 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23999 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24000 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24001 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24002 and GNU/Linux toolchains, @samp{native} can also be used.
24004 @item -mv8plus
24005 @itemx -mno-v8plus
24006 @opindex mv8plus
24007 @opindex mno-v8plus
24008 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24009 difference from the V8 ABI is that the global and out registers are
24010 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24011 mode for all SPARC-V9 processors.
24013 @item -mvis
24014 @itemx -mno-vis
24015 @opindex mvis
24016 @opindex mno-vis
24017 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24018 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24020 @item -mvis2
24021 @itemx -mno-vis2
24022 @opindex mvis2
24023 @opindex mno-vis2
24024 With @option{-mvis2}, GCC generates code that takes advantage of
24025 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24026 default is @option{-mvis2} when targeting a cpu that supports such
24027 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24028 also sets @option{-mvis}.
24030 @item -mvis3
24031 @itemx -mno-vis3
24032 @opindex mvis3
24033 @opindex mno-vis3
24034 With @option{-mvis3}, GCC generates code that takes advantage of
24035 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24036 default is @option{-mvis3} when targeting a cpu that supports such
24037 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24038 also sets @option{-mvis2} and @option{-mvis}.
24040 @item -mvis4
24041 @itemx -mno-vis4
24042 @opindex mvis4
24043 @opindex mno-vis4
24044 With @option{-mvis4}, GCC generates code that takes advantage of
24045 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24046 default is @option{-mvis4} when targeting a cpu that supports such
24047 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24048 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24050 @item -mvis4b
24051 @itemx -mno-vis4b
24052 @opindex mvis4b
24053 @opindex mno-vis4b
24054 With @option{-mvis4b}, GCC generates code that takes advantage of
24055 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24056 the additional VIS instructions introduced in the Oracle SPARC
24057 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24058 cpu that supports such instructions, such as m8 and later.  Setting
24059 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24060 @option{-mvis2} and @option{-mvis}.
24062 @item -mcbcond
24063 @itemx -mno-cbcond
24064 @opindex mcbcond
24065 @opindex mno-cbcond
24066 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24067 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24068 when targeting a CPU that supports such instructions, such as Niagara-4 and
24069 later.
24071 @item -mfmaf
24072 @itemx -mno-fmaf
24073 @opindex mfmaf
24074 @opindex mno-fmaf
24075 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24076 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24077 when targeting a CPU that supports such instructions, such as Niagara-3 and
24078 later.
24080 @item -mfsmuld
24081 @itemx -mno-fsmuld
24082 @opindex mfsmuld
24083 @opindex mno-fsmuld
24084 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24085 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24086 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24087 or V9 with FPU except @option{-mcpu=leon}.
24089 @item -mpopc
24090 @itemx -mno-popc
24091 @opindex mpopc
24092 @opindex mno-popc
24093 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24094 Population Count instruction.  The default is @option{-mpopc}
24095 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24096 later.
24098 @item -msubxc
24099 @itemx -mno-subxc
24100 @opindex msubxc
24101 @opindex mno-subxc
24102 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24103 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24104 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24105 later.
24107 @item -mfix-at697f
24108 @opindex mfix-at697f
24109 Enable the documented workaround for the single erratum of the Atmel AT697F
24110 processor (which corresponds to erratum #13 of the AT697E processor).
24112 @item -mfix-ut699
24113 @opindex mfix-ut699
24114 Enable the documented workarounds for the floating-point errata and the data
24115 cache nullify errata of the UT699 processor.
24117 @item -mfix-ut700
24118 @opindex mfix-ut700
24119 Enable the documented workaround for the back-to-back store errata of
24120 the UT699E/UT700 processor.
24122 @item -mfix-gr712rc
24123 @opindex mfix-gr712rc
24124 Enable the documented workaround for the back-to-back store errata of
24125 the GR712RC processor.
24126 @end table
24128 These @samp{-m} options are supported in addition to the above
24129 on SPARC-V9 processors in 64-bit environments:
24131 @table @gcctabopt
24132 @item -m32
24133 @itemx -m64
24134 @opindex m32
24135 @opindex m64
24136 Generate code for a 32-bit or 64-bit environment.
24137 The 32-bit environment sets int, long and pointer to 32 bits.
24138 The 64-bit environment sets int to 32 bits and long and pointer
24139 to 64 bits.
24141 @item -mcmodel=@var{which}
24142 @opindex mcmodel
24143 Set the code model to one of
24145 @table @samp
24146 @item medlow
24147 The Medium/Low code model: 64-bit addresses, programs
24148 must be linked in the low 32 bits of memory.  Programs can be statically
24149 or dynamically linked.
24151 @item medmid
24152 The Medium/Middle code model: 64-bit addresses, programs
24153 must be linked in the low 44 bits of memory, the text and data segments must
24154 be less than 2GB in size and the data segment must be located within 2GB of
24155 the text segment.
24157 @item medany
24158 The Medium/Anywhere code model: 64-bit addresses, programs
24159 may be linked anywhere in memory, the text and data segments must be less
24160 than 2GB in size and the data segment must be located within 2GB of the
24161 text segment.
24163 @item embmedany
24164 The Medium/Anywhere code model for embedded systems:
24165 64-bit addresses, the text and data segments must be less than 2GB in
24166 size, both starting anywhere in memory (determined at link time).  The
24167 global register %g4 points to the base of the data segment.  Programs
24168 are statically linked and PIC is not supported.
24169 @end table
24171 @item -mmemory-model=@var{mem-model}
24172 @opindex mmemory-model
24173 Set the memory model in force on the processor to one of
24175 @table @samp
24176 @item default
24177 The default memory model for the processor and operating system.
24179 @item rmo
24180 Relaxed Memory Order
24182 @item pso
24183 Partial Store Order
24185 @item tso
24186 Total Store Order
24188 @item sc
24189 Sequential Consistency
24190 @end table
24192 These memory models are formally defined in Appendix D of the SPARC-V9
24193 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24195 @item -mstack-bias
24196 @itemx -mno-stack-bias
24197 @opindex mstack-bias
24198 @opindex mno-stack-bias
24199 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24200 frame pointer if present, are offset by @minus{}2047 which must be added back
24201 when making stack frame references.  This is the default in 64-bit mode.
24202 Otherwise, assume no such offset is present.
24203 @end table
24205 @node SPU Options
24206 @subsection SPU Options
24207 @cindex SPU options
24209 These @samp{-m} options are supported on the SPU:
24211 @table @gcctabopt
24212 @item -mwarn-reloc
24213 @itemx -merror-reloc
24214 @opindex mwarn-reloc
24215 @opindex merror-reloc
24217 The loader for SPU does not handle dynamic relocations.  By default, GCC
24218 gives an error when it generates code that requires a dynamic
24219 relocation.  @option{-mno-error-reloc} disables the error,
24220 @option{-mwarn-reloc} generates a warning instead.
24222 @item -msafe-dma
24223 @itemx -munsafe-dma
24224 @opindex msafe-dma
24225 @opindex munsafe-dma
24227 Instructions that initiate or test completion of DMA must not be
24228 reordered with respect to loads and stores of the memory that is being
24229 accessed.
24230 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24231 memory accesses, but that can lead to inefficient code in places where the
24232 memory is known to not change.  Rather than mark the memory as volatile,
24233 you can use @option{-msafe-dma} to tell the compiler to treat
24234 the DMA instructions as potentially affecting all memory.  
24236 @item -mbranch-hints
24237 @opindex mbranch-hints
24239 By default, GCC generates a branch hint instruction to avoid
24240 pipeline stalls for always-taken or probably-taken branches.  A hint
24241 is not generated closer than 8 instructions away from its branch.
24242 There is little reason to disable them, except for debugging purposes,
24243 or to make an object a little bit smaller.
24245 @item -msmall-mem
24246 @itemx -mlarge-mem
24247 @opindex msmall-mem
24248 @opindex mlarge-mem
24250 By default, GCC generates code assuming that addresses are never larger
24251 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24252 a full 32-bit address.
24254 @item -mstdmain
24255 @opindex mstdmain
24257 By default, GCC links against startup code that assumes the SPU-style
24258 main function interface (which has an unconventional parameter list).
24259 With @option{-mstdmain}, GCC links your program against startup
24260 code that assumes a C99-style interface to @code{main}, including a
24261 local copy of @code{argv} strings.
24263 @item -mfixed-range=@var{register-range}
24264 @opindex mfixed-range
24265 Generate code treating the given register range as fixed registers.
24266 A fixed register is one that the register allocator cannot use.  This is
24267 useful when compiling kernel code.  A register range is specified as
24268 two registers separated by a dash.  Multiple register ranges can be
24269 specified separated by a comma.
24271 @item -mea32
24272 @itemx -mea64
24273 @opindex mea32
24274 @opindex mea64
24275 Compile code assuming that pointers to the PPU address space accessed
24276 via the @code{__ea} named address space qualifier are either 32 or 64
24277 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24278 all object code in an executable must be compiled with the same setting.
24280 @item -maddress-space-conversion
24281 @itemx -mno-address-space-conversion
24282 @opindex maddress-space-conversion
24283 @opindex mno-address-space-conversion
24284 Allow/disallow treating the @code{__ea} address space as superset
24285 of the generic address space.  This enables explicit type casts
24286 between @code{__ea} and generic pointer as well as implicit
24287 conversions of generic pointers to @code{__ea} pointers.  The
24288 default is to allow address space pointer conversions.
24290 @item -mcache-size=@var{cache-size}
24291 @opindex mcache-size
24292 This option controls the version of libgcc that the compiler links to an
24293 executable and selects a software-managed cache for accessing variables
24294 in the @code{__ea} address space with a particular cache size.  Possible
24295 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24296 and @samp{128}.  The default cache size is 64KB.
24298 @item -matomic-updates
24299 @itemx -mno-atomic-updates
24300 @opindex matomic-updates
24301 @opindex mno-atomic-updates
24302 This option controls the version of libgcc that the compiler links to an
24303 executable and selects whether atomic updates to the software-managed
24304 cache of PPU-side variables are used.  If you use atomic updates, changes
24305 to a PPU variable from SPU code using the @code{__ea} named address space
24306 qualifier do not interfere with changes to other PPU variables residing
24307 in the same cache line from PPU code.  If you do not use atomic updates,
24308 such interference may occur; however, writing back cache lines is
24309 more efficient.  The default behavior is to use atomic updates.
24311 @item -mdual-nops
24312 @itemx -mdual-nops=@var{n}
24313 @opindex mdual-nops
24314 By default, GCC inserts NOPs to increase dual issue when it expects
24315 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24316 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24317 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24319 @item -mhint-max-nops=@var{n}
24320 @opindex mhint-max-nops
24321 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24322 be at least 8 instructions away from the branch it is affecting.  GCC
24323 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24324 generate the branch hint.
24326 @item -mhint-max-distance=@var{n}
24327 @opindex mhint-max-distance
24328 The encoding of the branch hint instruction limits the hint to be within
24329 256 instructions of the branch it is affecting.  By default, GCC makes
24330 sure it is within 125.
24332 @item -msafe-hints
24333 @opindex msafe-hints
24334 Work around a hardware bug that causes the SPU to stall indefinitely.
24335 By default, GCC inserts the @code{hbrp} instruction to make sure
24336 this stall won't happen.
24338 @end table
24340 @node System V Options
24341 @subsection Options for System V
24343 These additional options are available on System V Release 4 for
24344 compatibility with other compilers on those systems:
24346 @table @gcctabopt
24347 @item -G
24348 @opindex G
24349 Create a shared object.
24350 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24352 @item -Qy
24353 @opindex Qy
24354 Identify the versions of each tool used by the compiler, in a
24355 @code{.ident} assembler directive in the output.
24357 @item -Qn
24358 @opindex Qn
24359 Refrain from adding @code{.ident} directives to the output file (this is
24360 the default).
24362 @item -YP,@var{dirs}
24363 @opindex YP
24364 Search the directories @var{dirs}, and no others, for libraries
24365 specified with @option{-l}.
24367 @item -Ym,@var{dir}
24368 @opindex Ym
24369 Look in the directory @var{dir} to find the M4 preprocessor.
24370 The assembler uses this option.
24371 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24372 @c the generic assembler that comes with Solaris takes just -Ym.
24373 @end table
24375 @node TILE-Gx Options
24376 @subsection TILE-Gx Options
24377 @cindex TILE-Gx options
24379 These @samp{-m} options are supported on the TILE-Gx:
24381 @table @gcctabopt
24382 @item -mcmodel=small
24383 @opindex mcmodel=small
24384 Generate code for the small model.  The distance for direct calls is
24385 limited to 500M in either direction.  PC-relative addresses are 32
24386 bits.  Absolute addresses support the full address range.
24388 @item -mcmodel=large
24389 @opindex mcmodel=large
24390 Generate code for the large model.  There is no limitation on call
24391 distance, pc-relative addresses, or absolute addresses.
24393 @item -mcpu=@var{name}
24394 @opindex mcpu
24395 Selects the type of CPU to be targeted.  Currently the only supported
24396 type is @samp{tilegx}.
24398 @item -m32
24399 @itemx -m64
24400 @opindex m32
24401 @opindex m64
24402 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24403 environment sets int, long, and pointer to 32 bits.  The 64-bit
24404 environment sets int to 32 bits and long and pointer to 64 bits.
24406 @item -mbig-endian
24407 @itemx -mlittle-endian
24408 @opindex mbig-endian
24409 @opindex mlittle-endian
24410 Generate code in big/little endian mode, respectively.
24411 @end table
24413 @node TILEPro Options
24414 @subsection TILEPro Options
24415 @cindex TILEPro options
24417 These @samp{-m} options are supported on the TILEPro:
24419 @table @gcctabopt
24420 @item -mcpu=@var{name}
24421 @opindex mcpu
24422 Selects the type of CPU to be targeted.  Currently the only supported
24423 type is @samp{tilepro}.
24425 @item -m32
24426 @opindex m32
24427 Generate code for a 32-bit environment, which sets int, long, and
24428 pointer to 32 bits.  This is the only supported behavior so the flag
24429 is essentially ignored.
24430 @end table
24432 @node V850 Options
24433 @subsection V850 Options
24434 @cindex V850 Options
24436 These @samp{-m} options are defined for V850 implementations:
24438 @table @gcctabopt
24439 @item -mlong-calls
24440 @itemx -mno-long-calls
24441 @opindex mlong-calls
24442 @opindex mno-long-calls
24443 Treat all calls as being far away (near).  If calls are assumed to be
24444 far away, the compiler always loads the function's address into a
24445 register, and calls indirect through the pointer.
24447 @item -mno-ep
24448 @itemx -mep
24449 @opindex mno-ep
24450 @opindex mep
24451 Do not optimize (do optimize) basic blocks that use the same index
24452 pointer 4 or more times to copy pointer into the @code{ep} register, and
24453 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24454 option is on by default if you optimize.
24456 @item -mno-prolog-function
24457 @itemx -mprolog-function
24458 @opindex mno-prolog-function
24459 @opindex mprolog-function
24460 Do not use (do use) external functions to save and restore registers
24461 at the prologue and epilogue of a function.  The external functions
24462 are slower, but use less code space if more than one function saves
24463 the same number of registers.  The @option{-mprolog-function} option
24464 is on by default if you optimize.
24466 @item -mspace
24467 @opindex mspace
24468 Try to make the code as small as possible.  At present, this just turns
24469 on the @option{-mep} and @option{-mprolog-function} options.
24471 @item -mtda=@var{n}
24472 @opindex mtda
24473 Put static or global variables whose size is @var{n} bytes or less into
24474 the tiny data area that register @code{ep} points to.  The tiny data
24475 area can hold up to 256 bytes in total (128 bytes for byte references).
24477 @item -msda=@var{n}
24478 @opindex msda
24479 Put static or global variables whose size is @var{n} bytes or less into
24480 the small data area that register @code{gp} points to.  The small data
24481 area can hold up to 64 kilobytes.
24483 @item -mzda=@var{n}
24484 @opindex mzda
24485 Put static or global variables whose size is @var{n} bytes or less into
24486 the first 32 kilobytes of memory.
24488 @item -mv850
24489 @opindex mv850
24490 Specify that the target processor is the V850.
24492 @item -mv850e3v5
24493 @opindex mv850e3v5
24494 Specify that the target processor is the V850E3V5.  The preprocessor
24495 constant @code{__v850e3v5__} is defined if this option is used.
24497 @item -mv850e2v4
24498 @opindex mv850e2v4
24499 Specify that the target processor is the V850E3V5.  This is an alias for
24500 the @option{-mv850e3v5} option.
24502 @item -mv850e2v3
24503 @opindex mv850e2v3
24504 Specify that the target processor is the V850E2V3.  The preprocessor
24505 constant @code{__v850e2v3__} is defined if this option is used.
24507 @item -mv850e2
24508 @opindex mv850e2
24509 Specify that the target processor is the V850E2.  The preprocessor
24510 constant @code{__v850e2__} is defined if this option is used.
24512 @item -mv850e1
24513 @opindex mv850e1
24514 Specify that the target processor is the V850E1.  The preprocessor
24515 constants @code{__v850e1__} and @code{__v850e__} are defined if
24516 this option is used.
24518 @item -mv850es
24519 @opindex mv850es
24520 Specify that the target processor is the V850ES.  This is an alias for
24521 the @option{-mv850e1} option.
24523 @item -mv850e
24524 @opindex mv850e
24525 Specify that the target processor is the V850E@.  The preprocessor
24526 constant @code{__v850e__} is defined if this option is used.
24528 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24529 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24530 are defined then a default target processor is chosen and the
24531 relevant @samp{__v850*__} preprocessor constant is defined.
24533 The preprocessor constants @code{__v850} and @code{__v851__} are always
24534 defined, regardless of which processor variant is the target.
24536 @item -mdisable-callt
24537 @itemx -mno-disable-callt
24538 @opindex mdisable-callt
24539 @opindex mno-disable-callt
24540 This option suppresses generation of the @code{CALLT} instruction for the
24541 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24542 architecture.
24544 This option is enabled by default when the RH850 ABI is
24545 in use (see @option{-mrh850-abi}), and disabled by default when the
24546 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24547 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24549 @item -mrelax
24550 @itemx -mno-relax
24551 @opindex mrelax
24552 @opindex mno-relax
24553 Pass on (or do not pass on) the @option{-mrelax} command-line option
24554 to the assembler.
24556 @item -mlong-jumps
24557 @itemx -mno-long-jumps
24558 @opindex mlong-jumps
24559 @opindex mno-long-jumps
24560 Disable (or re-enable) the generation of PC-relative jump instructions.
24562 @item -msoft-float
24563 @itemx -mhard-float
24564 @opindex msoft-float
24565 @opindex mhard-float
24566 Disable (or re-enable) the generation of hardware floating point
24567 instructions.  This option is only significant when the target
24568 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24569 instructions are being generated then the C preprocessor symbol
24570 @code{__FPU_OK__} is defined, otherwise the symbol
24571 @code{__NO_FPU__} is defined.
24573 @item -mloop
24574 @opindex mloop
24575 Enables the use of the e3v5 LOOP instruction.  The use of this
24576 instruction is not enabled by default when the e3v5 architecture is
24577 selected because its use is still experimental.
24579 @item -mrh850-abi
24580 @itemx -mghs
24581 @opindex mrh850-abi
24582 @opindex mghs
24583 Enables support for the RH850 version of the V850 ABI.  This is the
24584 default.  With this version of the ABI the following rules apply:
24586 @itemize
24587 @item
24588 Integer sized structures and unions are returned via a memory pointer
24589 rather than a register.
24591 @item
24592 Large structures and unions (more than 8 bytes in size) are passed by
24593 value.
24595 @item
24596 Functions are aligned to 16-bit boundaries.
24598 @item
24599 The @option{-m8byte-align} command-line option is supported.
24601 @item
24602 The @option{-mdisable-callt} command-line option is enabled by
24603 default.  The @option{-mno-disable-callt} command-line option is not
24604 supported.
24605 @end itemize
24607 When this version of the ABI is enabled the C preprocessor symbol
24608 @code{__V850_RH850_ABI__} is defined.
24610 @item -mgcc-abi
24611 @opindex mgcc-abi
24612 Enables support for the old GCC version of the V850 ABI.  With this
24613 version of the ABI the following rules apply:
24615 @itemize
24616 @item
24617 Integer sized structures and unions are returned in register @code{r10}.
24619 @item
24620 Large structures and unions (more than 8 bytes in size) are passed by
24621 reference.
24623 @item
24624 Functions are aligned to 32-bit boundaries, unless optimizing for
24625 size.
24627 @item
24628 The @option{-m8byte-align} command-line option is not supported.
24630 @item
24631 The @option{-mdisable-callt} command-line option is supported but not
24632 enabled by default.
24633 @end itemize
24635 When this version of the ABI is enabled the C preprocessor symbol
24636 @code{__V850_GCC_ABI__} is defined.
24638 @item -m8byte-align
24639 @itemx -mno-8byte-align
24640 @opindex m8byte-align
24641 @opindex mno-8byte-align
24642 Enables support for @code{double} and @code{long long} types to be
24643 aligned on 8-byte boundaries.  The default is to restrict the
24644 alignment of all objects to at most 4-bytes.  When
24645 @option{-m8byte-align} is in effect the C preprocessor symbol
24646 @code{__V850_8BYTE_ALIGN__} is defined.
24648 @item -mbig-switch
24649 @opindex mbig-switch
24650 Generate code suitable for big switch tables.  Use this option only if
24651 the assembler/linker complain about out of range branches within a switch
24652 table.
24654 @item -mapp-regs
24655 @opindex mapp-regs
24656 This option causes r2 and r5 to be used in the code generated by
24657 the compiler.  This setting is the default.
24659 @item -mno-app-regs
24660 @opindex mno-app-regs
24661 This option causes r2 and r5 to be treated as fixed registers.
24663 @end table
24665 @node VAX Options
24666 @subsection VAX Options
24667 @cindex VAX options
24669 These @samp{-m} options are defined for the VAX:
24671 @table @gcctabopt
24672 @item -munix
24673 @opindex munix
24674 Do not output certain jump instructions (@code{aobleq} and so on)
24675 that the Unix assembler for the VAX cannot handle across long
24676 ranges.
24678 @item -mgnu
24679 @opindex mgnu
24680 Do output those jump instructions, on the assumption that the
24681 GNU assembler is being used.
24683 @item -mg
24684 @opindex mg
24685 Output code for G-format floating-point numbers instead of D-format.
24686 @end table
24688 @node Visium Options
24689 @subsection Visium Options
24690 @cindex Visium options
24692 @table @gcctabopt
24694 @item -mdebug
24695 @opindex mdebug
24696 A program which performs file I/O and is destined to run on an MCM target
24697 should be linked with this option.  It causes the libraries libc.a and
24698 libdebug.a to be linked.  The program should be run on the target under
24699 the control of the GDB remote debugging stub.
24701 @item -msim
24702 @opindex msim
24703 A program which performs file I/O and is destined to run on the simulator
24704 should be linked with option.  This causes libraries libc.a and libsim.a to
24705 be linked.
24707 @item -mfpu
24708 @itemx -mhard-float
24709 @opindex mfpu
24710 @opindex mhard-float
24711 Generate code containing floating-point instructions.  This is the
24712 default.
24714 @item -mno-fpu
24715 @itemx -msoft-float
24716 @opindex mno-fpu
24717 @opindex msoft-float
24718 Generate code containing library calls for floating-point.
24720 @option{-msoft-float} changes the calling convention in the output file;
24721 therefore, it is only useful if you compile @emph{all} of a program with
24722 this option.  In particular, you need to compile @file{libgcc.a}, the
24723 library that comes with GCC, with @option{-msoft-float} in order for
24724 this to work.
24726 @item -mcpu=@var{cpu_type}
24727 @opindex mcpu
24728 Set the instruction set, register set, and instruction scheduling parameters
24729 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24730 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24732 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24734 By default (unless configured otherwise), GCC generates code for the GR5
24735 variant of the Visium architecture.  
24737 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24738 architecture.  The only difference from GR5 code is that the compiler will
24739 generate block move instructions.
24741 @item -mtune=@var{cpu_type}
24742 @opindex mtune
24743 Set the instruction scheduling parameters for machine type @var{cpu_type},
24744 but do not set the instruction set or register set that the option
24745 @option{-mcpu=@var{cpu_type}} would.
24747 @item -msv-mode
24748 @opindex msv-mode
24749 Generate code for the supervisor mode, where there are no restrictions on
24750 the access to general registers.  This is the default.
24752 @item -muser-mode
24753 @opindex muser-mode
24754 Generate code for the user mode, where the access to some general registers
24755 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24756 mode; on the GR6, only registers r29 to r31 are affected.
24757 @end table
24759 @node VMS Options
24760 @subsection VMS Options
24762 These @samp{-m} options are defined for the VMS implementations:
24764 @table @gcctabopt
24765 @item -mvms-return-codes
24766 @opindex mvms-return-codes
24767 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24768 condition (e.g.@ error) codes.
24770 @item -mdebug-main=@var{prefix}
24771 @opindex mdebug-main=@var{prefix}
24772 Flag the first routine whose name starts with @var{prefix} as the main
24773 routine for the debugger.
24775 @item -mmalloc64
24776 @opindex mmalloc64
24777 Default to 64-bit memory allocation routines.
24779 @item -mpointer-size=@var{size}
24780 @opindex mpointer-size=@var{size}
24781 Set the default size of pointers. Possible options for @var{size} are
24782 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24783 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24784 The later option disables @code{pragma pointer_size}.
24785 @end table
24787 @node VxWorks Options
24788 @subsection VxWorks Options
24789 @cindex VxWorks Options
24791 The options in this section are defined for all VxWorks targets.
24792 Options specific to the target hardware are listed with the other
24793 options for that target.
24795 @table @gcctabopt
24796 @item -mrtp
24797 @opindex mrtp
24798 GCC can generate code for both VxWorks kernels and real time processes
24799 (RTPs).  This option switches from the former to the latter.  It also
24800 defines the preprocessor macro @code{__RTP__}.
24802 @item -non-static
24803 @opindex non-static
24804 Link an RTP executable against shared libraries rather than static
24805 libraries.  The options @option{-static} and @option{-shared} can
24806 also be used for RTPs (@pxref{Link Options}); @option{-static}
24807 is the default.
24809 @item -Bstatic
24810 @itemx -Bdynamic
24811 @opindex Bstatic
24812 @opindex Bdynamic
24813 These options are passed down to the linker.  They are defined for
24814 compatibility with Diab.
24816 @item -Xbind-lazy
24817 @opindex Xbind-lazy
24818 Enable lazy binding of function calls.  This option is equivalent to
24819 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24821 @item -Xbind-now
24822 @opindex Xbind-now
24823 Disable lazy binding of function calls.  This option is the default and
24824 is defined for compatibility with Diab.
24825 @end table
24827 @node x86 Options
24828 @subsection x86 Options
24829 @cindex x86 Options
24831 These @samp{-m} options are defined for the x86 family of computers.
24833 @table @gcctabopt
24835 @item -march=@var{cpu-type}
24836 @opindex march
24837 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24838 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24839 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24840 to generate code that may not run at all on processors other than the one
24841 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24842 @option{-mtune=@var{cpu-type}}.
24844 The choices for @var{cpu-type} are:
24846 @table @samp
24847 @item native
24848 This selects the CPU to generate code for at compilation time by determining
24849 the processor type of the compiling machine.  Using @option{-march=native}
24850 enables all instruction subsets supported by the local machine (hence
24851 the result might not run on different machines).  Using @option{-mtune=native}
24852 produces code optimized for the local machine under the constraints
24853 of the selected instruction set.  
24855 @item i386
24856 Original Intel i386 CPU@.
24858 @item i486
24859 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24861 @item i586
24862 @itemx pentium
24863 Intel Pentium CPU with no MMX support.
24865 @item lakemont
24866 Intel Lakemont MCU, based on Intel Pentium CPU.
24868 @item pentium-mmx
24869 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24871 @item pentiumpro
24872 Intel Pentium Pro CPU@.
24874 @item i686
24875 When used with @option{-march}, the Pentium Pro
24876 instruction set is used, so the code runs on all i686 family chips.
24877 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24879 @item pentium2
24880 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24881 support.
24883 @item pentium3
24884 @itemx pentium3m
24885 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24886 set support.
24888 @item pentium-m
24889 Intel Pentium M; low-power version of Intel Pentium III CPU
24890 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24892 @item pentium4
24893 @itemx pentium4m
24894 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24896 @item prescott
24897 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24898 set support.
24900 @item nocona
24901 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24902 SSE2 and SSE3 instruction set support.
24904 @item core2
24905 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24906 instruction set support.
24908 @item nehalem
24909 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24910 SSE4.1, SSE4.2 and POPCNT instruction set support.
24912 @item westmere
24913 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24914 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24916 @item sandybridge
24917 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24918 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24920 @item ivybridge
24921 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24922 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24923 instruction set support.
24925 @item haswell
24926 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24927 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24928 BMI, BMI2 and F16C instruction set support.
24930 @item broadwell
24931 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24932 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24933 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24935 @item skylake
24936 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24937 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24938 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24939 XSAVES instruction set support.
24941 @item bonnell
24942 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24943 instruction set support.
24945 @item silvermont
24946 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24947 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24949 @item knl
24950 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24951 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24952 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24953 AVX512CD instruction set support.
24955 @item skylake-avx512
24956 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24957 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24958 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24959 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24961 @item k6
24962 AMD K6 CPU with MMX instruction set support.
24964 @item k6-2
24965 @itemx k6-3
24966 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24968 @item athlon
24969 @itemx athlon-tbird
24970 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24971 support.
24973 @item athlon-4
24974 @itemx athlon-xp
24975 @itemx athlon-mp
24976 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24977 instruction set support.
24979 @item k8
24980 @itemx opteron
24981 @itemx athlon64
24982 @itemx athlon-fx
24983 Processors based on the AMD K8 core with x86-64 instruction set support,
24984 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24985 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24986 instruction set extensions.)
24988 @item k8-sse3
24989 @itemx opteron-sse3
24990 @itemx athlon64-sse3
24991 Improved versions of AMD K8 cores with SSE3 instruction set support.
24993 @item amdfam10
24994 @itemx barcelona
24995 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24996 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24997 instruction set extensions.)
24999 @item bdver1
25000 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25001 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25002 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25003 @item bdver2
25004 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25005 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25006 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25007 extensions.)
25008 @item bdver3
25009 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25010 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25011 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25012 64-bit instruction set extensions.
25013 @item bdver4
25014 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25015 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25016 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25017 SSE4.2, ABM and 64-bit instruction set extensions.
25019 @item znver1
25020 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25021 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25022 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25023 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25024 instruction set extensions.
25026 @item btver1
25027 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25028 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25029 instruction set extensions.)
25031 @item btver2
25032 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25033 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25034 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25036 @item winchip-c6
25037 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25038 set support.
25040 @item winchip2
25041 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25042 instruction set support.
25044 @item c3
25045 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25046 (No scheduling is implemented for this chip.)
25048 @item c3-2
25049 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25050 (No scheduling is implemented for this chip.)
25052 @item c7
25053 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25054 (No scheduling is implemented for this chip.)
25056 @item samuel-2
25057 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25058 (No scheduling is implemented for this chip.)
25060 @item nehemiah
25061 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25062 (No scheduling is implemented for this chip.)
25064 @item esther
25065 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25066 (No scheduling is implemented for this chip.)
25068 @item eden-x2
25069 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25070 (No scheduling is implemented for this chip.)
25072 @item eden-x4
25073 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25074 AVX and AVX2 instruction set support.
25075 (No scheduling is implemented for this chip.)
25077 @item nano
25078 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25079 instruction set support.
25080 (No scheduling is implemented for this chip.)
25082 @item nano-1000
25083 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25084 instruction set support.
25085 (No scheduling is implemented for this chip.)
25087 @item nano-2000
25088 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25089 instruction set support.
25090 (No scheduling is implemented for this chip.)
25092 @item nano-3000
25093 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25094 instruction set support.
25095 (No scheduling is implemented for this chip.)
25097 @item nano-x2
25098 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25099 instruction set support.
25100 (No scheduling is implemented for this chip.)
25102 @item nano-x4
25103 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25104 instruction set support.
25105 (No scheduling is implemented for this chip.)
25107 @item geode
25108 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25109 @end table
25111 @item -mtune=@var{cpu-type}
25112 @opindex mtune
25113 Tune to @var{cpu-type} everything applicable about the generated code, except
25114 for the ABI and the set of available instructions.  
25115 While picking a specific @var{cpu-type} schedules things appropriately
25116 for that particular chip, the compiler does not generate any code that
25117 cannot run on the default machine type unless you use a
25118 @option{-march=@var{cpu-type}} option.
25119 For example, if GCC is configured for i686-pc-linux-gnu
25120 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25121 but still runs on i686 machines.
25123 The choices for @var{cpu-type} are the same as for @option{-march}.
25124 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25126 @table @samp
25127 @item generic
25128 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25129 If you know the CPU on which your code will run, then you should use
25130 the corresponding @option{-mtune} or @option{-march} option instead of
25131 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25132 of your application will have, then you should use this option.
25134 As new processors are deployed in the marketplace, the behavior of this
25135 option will change.  Therefore, if you upgrade to a newer version of
25136 GCC, code generation controlled by this option will change to reflect
25137 the processors
25138 that are most common at the time that version of GCC is released.
25140 There is no @option{-march=generic} option because @option{-march}
25141 indicates the instruction set the compiler can use, and there is no
25142 generic instruction set applicable to all processors.  In contrast,
25143 @option{-mtune} indicates the processor (or, in this case, collection of
25144 processors) for which the code is optimized.
25146 @item intel
25147 Produce code optimized for the most current Intel processors, which are
25148 Haswell and Silvermont for this version of GCC.  If you know the CPU
25149 on which your code will run, then you should use the corresponding
25150 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25151 But, if you want your application performs better on both Haswell and
25152 Silvermont, then you should use this option.
25154 As new Intel processors are deployed in the marketplace, the behavior of
25155 this option will change.  Therefore, if you upgrade to a newer version of
25156 GCC, code generation controlled by this option will change to reflect
25157 the most current Intel processors at the time that version of GCC is
25158 released.
25160 There is no @option{-march=intel} option because @option{-march} indicates
25161 the instruction set the compiler can use, and there is no common
25162 instruction set applicable to all processors.  In contrast,
25163 @option{-mtune} indicates the processor (or, in this case, collection of
25164 processors) for which the code is optimized.
25165 @end table
25167 @item -mcpu=@var{cpu-type}
25168 @opindex mcpu
25169 A deprecated synonym for @option{-mtune}.
25171 @item -mfpmath=@var{unit}
25172 @opindex mfpmath
25173 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25174 for @var{unit} are:
25176 @table @samp
25177 @item 387
25178 Use the standard 387 floating-point coprocessor present on the majority of chips and
25179 emulated otherwise.  Code compiled with this option runs almost everywhere.
25180 The temporary results are computed in 80-bit precision instead of the precision
25181 specified by the type, resulting in slightly different results compared to most
25182 of other chips.  See @option{-ffloat-store} for more detailed description.
25184 This is the default choice for non-Darwin x86-32 targets.
25186 @item sse
25187 Use scalar floating-point instructions present in the SSE instruction set.
25188 This instruction set is supported by Pentium III and newer chips,
25189 and in the AMD line
25190 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25191 instruction set supports only single-precision arithmetic, thus the double and
25192 extended-precision arithmetic are still done using 387.  A later version, present
25193 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25194 arithmetic too.
25196 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25197 or @option{-msse2} switches to enable SSE extensions and make this option
25198 effective.  For the x86-64 compiler, these extensions are enabled by default.
25200 The resulting code should be considerably faster in the majority of cases and avoid
25201 the numerical instability problems of 387 code, but may break some existing
25202 code that expects temporaries to be 80 bits.
25204 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25205 and the default choice for x86-32 targets with the SSE2 instruction set
25206 when @option{-ffast-math} is enabled.
25208 @item sse,387
25209 @itemx sse+387
25210 @itemx both
25211 Attempt to utilize both instruction sets at once.  This effectively doubles the
25212 amount of available registers, and on chips with separate execution units for
25213 387 and SSE the execution resources too.  Use this option with care, as it is
25214 still experimental, because the GCC register allocator does not model separate
25215 functional units well, resulting in unstable performance.
25216 @end table
25218 @item -masm=@var{dialect}
25219 @opindex masm=@var{dialect}
25220 Output assembly instructions using selected @var{dialect}.  Also affects
25221 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25222 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25223 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25224 not support @samp{intel}.
25226 @item -mieee-fp
25227 @itemx -mno-ieee-fp
25228 @opindex mieee-fp
25229 @opindex mno-ieee-fp
25230 Control whether or not the compiler uses IEEE floating-point
25231 comparisons.  These correctly handle the case where the result of a
25232 comparison is unordered.
25234 @item -m80387
25235 @item -mhard-float
25236 @opindex 80387
25237 @opindex mhard-float
25238 Generate output containing 80387 instructions for floating point.
25240 @item -mno-80387
25241 @item -msoft-float
25242 @opindex no-80387
25243 @opindex msoft-float
25244 Generate output containing library calls for floating point.
25246 @strong{Warning:} the requisite libraries are not part of GCC@.
25247 Normally the facilities of the machine's usual C compiler are used, but
25248 this cannot be done directly in cross-compilation.  You must make your
25249 own arrangements to provide suitable library functions for
25250 cross-compilation.
25252 On machines where a function returns floating-point results in the 80387
25253 register stack, some floating-point opcodes may be emitted even if
25254 @option{-msoft-float} is used.
25256 @item -mno-fp-ret-in-387
25257 @opindex mno-fp-ret-in-387
25258 Do not use the FPU registers for return values of functions.
25260 The usual calling convention has functions return values of types
25261 @code{float} and @code{double} in an FPU register, even if there
25262 is no FPU@.  The idea is that the operating system should emulate
25263 an FPU@.
25265 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25266 in ordinary CPU registers instead.
25268 @item -mno-fancy-math-387
25269 @opindex mno-fancy-math-387
25270 Some 387 emulators do not support the @code{sin}, @code{cos} and
25271 @code{sqrt} instructions for the 387.  Specify this option to avoid
25272 generating those instructions.  This option is the default on
25273 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25274 indicates that the target CPU always has an FPU and so the
25275 instruction does not need emulation.  These
25276 instructions are not generated unless you also use the
25277 @option{-funsafe-math-optimizations} switch.
25279 @item -malign-double
25280 @itemx -mno-align-double
25281 @opindex malign-double
25282 @opindex mno-align-double
25283 Control whether GCC aligns @code{double}, @code{long double}, and
25284 @code{long long} variables on a two-word boundary or a one-word
25285 boundary.  Aligning @code{double} variables on a two-word boundary
25286 produces code that runs somewhat faster on a Pentium at the
25287 expense of more memory.
25289 On x86-64, @option{-malign-double} is enabled by default.
25291 @strong{Warning:} if you use the @option{-malign-double} switch,
25292 structures containing the above types are aligned differently than
25293 the published application binary interface specifications for the x86-32
25294 and are not binary compatible with structures in code compiled
25295 without that switch.
25297 @item -m96bit-long-double
25298 @itemx -m128bit-long-double
25299 @opindex m96bit-long-double
25300 @opindex m128bit-long-double
25301 These switches control the size of @code{long double} type.  The x86-32
25302 application binary interface specifies the size to be 96 bits,
25303 so @option{-m96bit-long-double} is the default in 32-bit mode.
25305 Modern architectures (Pentium and newer) prefer @code{long double}
25306 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25307 conforming to the ABI, this is not possible.  So specifying
25308 @option{-m128bit-long-double} aligns @code{long double}
25309 to a 16-byte boundary by padding the @code{long double} with an additional
25310 32-bit zero.
25312 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25313 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25315 Notice that neither of these options enable any extra precision over the x87
25316 standard of 80 bits for a @code{long double}.
25318 @strong{Warning:} if you override the default value for your target ABI, this
25319 changes the size of 
25320 structures and arrays containing @code{long double} variables,
25321 as well as modifying the function calling convention for functions taking
25322 @code{long double}.  Hence they are not binary-compatible
25323 with code compiled without that switch.
25325 @item -mlong-double-64
25326 @itemx -mlong-double-80
25327 @itemx -mlong-double-128
25328 @opindex mlong-double-64
25329 @opindex mlong-double-80
25330 @opindex mlong-double-128
25331 These switches control the size of @code{long double} type. A size
25332 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25333 type. This is the default for 32-bit Bionic C library.  A size
25334 of 128 bits makes the @code{long double} type equivalent to the
25335 @code{__float128} type. This is the default for 64-bit Bionic C library.
25337 @strong{Warning:} if you override the default value for your target ABI, this
25338 changes the size of
25339 structures and arrays containing @code{long double} variables,
25340 as well as modifying the function calling convention for functions taking
25341 @code{long double}.  Hence they are not binary-compatible
25342 with code compiled without that switch.
25344 @item -malign-data=@var{type}
25345 @opindex malign-data
25346 Control how GCC aligns variables.  Supported values for @var{type} are
25347 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25348 and earlier, @samp{abi} uses alignment value as specified by the
25349 psABI, and @samp{cacheline} uses increased alignment value to match
25350 the cache line size.  @samp{compat} is the default.
25352 @item -mlarge-data-threshold=@var{threshold}
25353 @opindex mlarge-data-threshold
25354 When @option{-mcmodel=medium} is specified, data objects larger than
25355 @var{threshold} are placed in the large data section.  This value must be the
25356 same across all objects linked into the binary, and defaults to 65535.
25358 @item -mrtd
25359 @opindex mrtd
25360 Use a different function-calling convention, in which functions that
25361 take a fixed number of arguments return with the @code{ret @var{num}}
25362 instruction, which pops their arguments while returning.  This saves one
25363 instruction in the caller since there is no need to pop the arguments
25364 there.
25366 You can specify that an individual function is called with this calling
25367 sequence with the function attribute @code{stdcall}.  You can also
25368 override the @option{-mrtd} option by using the function attribute
25369 @code{cdecl}.  @xref{Function Attributes}.
25371 @strong{Warning:} this calling convention is incompatible with the one
25372 normally used on Unix, so you cannot use it if you need to call
25373 libraries compiled with the Unix compiler.
25375 Also, you must provide function prototypes for all functions that
25376 take variable numbers of arguments (including @code{printf});
25377 otherwise incorrect code is generated for calls to those
25378 functions.
25380 In addition, seriously incorrect code results if you call a
25381 function with too many arguments.  (Normally, extra arguments are
25382 harmlessly ignored.)
25384 @item -mregparm=@var{num}
25385 @opindex mregparm
25386 Control how many registers are used to pass integer arguments.  By
25387 default, no registers are used to pass arguments, and at most 3
25388 registers can be used.  You can control this behavior for a specific
25389 function by using the function attribute @code{regparm}.
25390 @xref{Function Attributes}.
25392 @strong{Warning:} if you use this switch, and
25393 @var{num} is nonzero, then you must build all modules with the same
25394 value, including any libraries.  This includes the system libraries and
25395 startup modules.
25397 @item -msseregparm
25398 @opindex msseregparm
25399 Use SSE register passing conventions for float and double arguments
25400 and return values.  You can control this behavior for a specific
25401 function by using the function attribute @code{sseregparm}.
25402 @xref{Function Attributes}.
25404 @strong{Warning:} if you use this switch then you must build all
25405 modules with the same value, including any libraries.  This includes
25406 the system libraries and startup modules.
25408 @item -mvect8-ret-in-mem
25409 @opindex mvect8-ret-in-mem
25410 Return 8-byte vectors in memory instead of MMX registers.  This is the
25411 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25412 Studio compilers until version 12.  Later compiler versions (starting
25413 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25414 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25415 you need to remain compatible with existing code produced by those
25416 previous compiler versions or older versions of GCC@.
25418 @item -mpc32
25419 @itemx -mpc64
25420 @itemx -mpc80
25421 @opindex mpc32
25422 @opindex mpc64
25423 @opindex mpc80
25425 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25426 is specified, the significands of results of floating-point operations are
25427 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25428 significands of results of floating-point operations to 53 bits (double
25429 precision) and @option{-mpc80} rounds the significands of results of
25430 floating-point operations to 64 bits (extended double precision), which is
25431 the default.  When this option is used, floating-point operations in higher
25432 precisions are not available to the programmer without setting the FPU
25433 control word explicitly.
25435 Setting the rounding of floating-point operations to less than the default
25436 80 bits can speed some programs by 2% or more.  Note that some mathematical
25437 libraries assume that extended-precision (80-bit) floating-point operations
25438 are enabled by default; routines in such libraries could suffer significant
25439 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25440 when this option is used to set the precision to less than extended precision.
25442 @item -mstackrealign
25443 @opindex mstackrealign
25444 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25445 option generates an alternate prologue and epilogue that realigns the
25446 run-time stack if necessary.  This supports mixing legacy codes that keep
25447 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25448 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25449 applicable to individual functions.
25451 @item -mpreferred-stack-boundary=@var{num}
25452 @opindex mpreferred-stack-boundary
25453 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25454 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25455 the default is 4 (16 bytes or 128 bits).
25457 @strong{Warning:} When generating code for the x86-64 architecture with
25458 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25459 used to keep the stack boundary aligned to 8 byte boundary.  Since
25460 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25461 intended to be used in controlled environment where stack space is
25462 important limitation.  This option leads to wrong code when functions
25463 compiled with 16 byte stack alignment (such as functions from a standard
25464 library) are called with misaligned stack.  In this case, SSE
25465 instructions may lead to misaligned memory access traps.  In addition,
25466 variable arguments are handled incorrectly for 16 byte aligned
25467 objects (including x87 long double and __int128), leading to wrong
25468 results.  You must build all modules with
25469 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25470 includes the system libraries and startup modules.
25472 @item -mincoming-stack-boundary=@var{num}
25473 @opindex mincoming-stack-boundary
25474 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25475 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25476 the one specified by @option{-mpreferred-stack-boundary} is used.
25478 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25479 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25480 suffer significant run time performance penalties.  On Pentium III, the
25481 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25482 properly if it is not 16-byte aligned.
25484 To ensure proper alignment of this values on the stack, the stack boundary
25485 must be as aligned as that required by any value stored on the stack.
25486 Further, every function must be generated such that it keeps the stack
25487 aligned.  Thus calling a function compiled with a higher preferred
25488 stack boundary from a function compiled with a lower preferred stack
25489 boundary most likely misaligns the stack.  It is recommended that
25490 libraries that use callbacks always use the default setting.
25492 This extra alignment does consume extra stack space, and generally
25493 increases code size.  Code that is sensitive to stack space usage, such
25494 as embedded systems and operating system kernels, may want to reduce the
25495 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25497 @need 200
25498 @item -mmmx
25499 @opindex mmmx
25500 @need 200
25501 @itemx -msse
25502 @opindex msse
25503 @need 200
25504 @itemx -msse2
25505 @opindex msse2
25506 @need 200
25507 @itemx -msse3
25508 @opindex msse3
25509 @need 200
25510 @itemx -mssse3
25511 @opindex mssse3
25512 @need 200
25513 @itemx -msse4
25514 @opindex msse4
25515 @need 200
25516 @itemx -msse4a
25517 @opindex msse4a
25518 @need 200
25519 @itemx -msse4.1
25520 @opindex msse4.1
25521 @need 200
25522 @itemx -msse4.2
25523 @opindex msse4.2
25524 @need 200
25525 @itemx -mavx
25526 @opindex mavx
25527 @need 200
25528 @itemx -mavx2
25529 @opindex mavx2
25530 @need 200
25531 @itemx -mavx512f
25532 @opindex mavx512f
25533 @need 200
25534 @itemx -mavx512pf
25535 @opindex mavx512pf
25536 @need 200
25537 @itemx -mavx512er
25538 @opindex mavx512er
25539 @need 200
25540 @itemx -mavx512cd
25541 @opindex mavx512cd
25542 @need 200
25543 @itemx -mavx512vl
25544 @opindex mavx512vl
25545 @need 200
25546 @itemx -mavx512bw
25547 @opindex mavx512bw
25548 @need 200
25549 @itemx -mavx512dq
25550 @opindex mavx512dq
25551 @need 200
25552 @itemx -mavx512ifma
25553 @opindex mavx512ifma
25554 @need 200
25555 @itemx -mavx512vbmi
25556 @opindex mavx512vbmi
25557 @need 200
25558 @itemx -msha
25559 @opindex msha
25560 @need 200
25561 @itemx -maes
25562 @opindex maes
25563 @need 200
25564 @itemx -mpclmul
25565 @opindex mpclmul
25566 @need 200
25567 @itemx -mclfushopt
25568 @opindex mclfushopt
25569 @need 200
25570 @itemx -mfsgsbase
25571 @opindex mfsgsbase
25572 @need 200
25573 @itemx -mrdrnd
25574 @opindex mrdrnd
25575 @need 200
25576 @itemx -mf16c
25577 @opindex mf16c
25578 @need 200
25579 @itemx -mfma
25580 @opindex mfma
25581 @need 200
25582 @itemx -mfma4
25583 @opindex mfma4
25584 @need 200
25585 @itemx -mprefetchwt1
25586 @opindex mprefetchwt1
25587 @need 200
25588 @itemx -mxop
25589 @opindex mxop
25590 @need 200
25591 @itemx -mlwp
25592 @opindex mlwp
25593 @need 200
25594 @itemx -m3dnow
25595 @opindex m3dnow
25596 @need 200
25597 @itemx -m3dnowa
25598 @opindex m3dnowa
25599 @need 200
25600 @itemx -mpopcnt
25601 @opindex mpopcnt
25602 @need 200
25603 @itemx -mabm
25604 @opindex mabm
25605 @need 200
25606 @itemx -mbmi
25607 @opindex mbmi
25608 @need 200
25609 @itemx -mbmi2
25610 @need 200
25611 @itemx -mlzcnt
25612 @opindex mlzcnt
25613 @need 200
25614 @itemx -mfxsr
25615 @opindex mfxsr
25616 @need 200
25617 @itemx -mxsave
25618 @opindex mxsave
25619 @need 200
25620 @itemx -mxsaveopt
25621 @opindex mxsaveopt
25622 @need 200
25623 @itemx -mxsavec
25624 @opindex mxsavec
25625 @need 200
25626 @itemx -mxsaves
25627 @opindex mxsaves
25628 @need 200
25629 @itemx -mrtm
25630 @opindex mrtm
25631 @need 200
25632 @itemx -mtbm
25633 @opindex mtbm
25634 @need 200
25635 @itemx -mmpx
25636 @opindex mmpx
25637 @need 200
25638 @itemx -mmwaitx
25639 @opindex mmwaitx
25640 @need 200
25641 @itemx -mclzero
25642 @opindex mclzero
25643 @itemx -mpku
25644 @opindex mpku
25645 These switches enable the use of instructions in the MMX, SSE,
25646 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25647 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25648 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25649 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25650 extended instruction sets.  Each has a corresponding @option{-mno-} option
25651 to disable use of these instructions.
25653 These extensions are also available as built-in functions: see
25654 @ref{x86 Built-in Functions}, for details of the functions enabled and
25655 disabled by these switches.
25657 To generate SSE/SSE2 instructions automatically from floating-point
25658 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25660 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25661 generates new AVX instructions or AVX equivalence for all SSEx instructions
25662 when needed.
25664 These options enable GCC to use these extended instructions in
25665 generated code, even without @option{-mfpmath=sse}.  Applications that
25666 perform run-time CPU detection must compile separate files for each
25667 supported architecture, using the appropriate flags.  In particular,
25668 the file containing the CPU detection code should be compiled without
25669 these options.
25671 @item -mdump-tune-features
25672 @opindex mdump-tune-features
25673 This option instructs GCC to dump the names of the x86 performance 
25674 tuning features and default settings. The names can be used in 
25675 @option{-mtune-ctrl=@var{feature-list}}.
25677 @item -mtune-ctrl=@var{feature-list}
25678 @opindex mtune-ctrl=@var{feature-list}
25679 This option is used to do fine grain control of x86 code generation features.
25680 @var{feature-list} is a comma separated list of @var{feature} names. See also
25681 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25682 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25683 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25684 developers. Using it may lead to code paths not covered by testing and can
25685 potentially result in compiler ICEs or runtime errors.
25687 @item -mno-default
25688 @opindex mno-default
25689 This option instructs GCC to turn off all tunable features. See also 
25690 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25692 @item -mcld
25693 @opindex mcld
25694 This option instructs GCC to emit a @code{cld} instruction in the prologue
25695 of functions that use string instructions.  String instructions depend on
25696 the DF flag to select between autoincrement or autodecrement mode.  While the
25697 ABI specifies the DF flag to be cleared on function entry, some operating
25698 systems violate this specification by not clearing the DF flag in their
25699 exception dispatchers.  The exception handler can be invoked with the DF flag
25700 set, which leads to wrong direction mode when string instructions are used.
25701 This option can be enabled by default on 32-bit x86 targets by configuring
25702 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25703 instructions can be suppressed with the @option{-mno-cld} compiler option
25704 in this case.
25706 @item -mvzeroupper
25707 @opindex mvzeroupper
25708 This option instructs GCC to emit a @code{vzeroupper} instruction
25709 before a transfer of control flow out of the function to minimize
25710 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25711 intrinsics.
25713 @item -mprefer-avx128
25714 @opindex mprefer-avx128
25715 This option instructs GCC to use 128-bit AVX instructions instead of
25716 256-bit AVX instructions in the auto-vectorizer.
25718 @item -mcx16
25719 @opindex mcx16
25720 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25721 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25722 objects.  This is useful for atomic updates of data structures exceeding one
25723 machine word in size.  The compiler uses this instruction to implement
25724 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25725 128-bit integers, a library call is always used.
25727 @item -msahf
25728 @opindex msahf
25729 This option enables generation of @code{SAHF} instructions in 64-bit code.
25730 Early Intel Pentium 4 CPUs with Intel 64 support,
25731 prior to the introduction of Pentium 4 G1 step in December 2005,
25732 lacked the @code{LAHF} and @code{SAHF} instructions
25733 which are supported by AMD64.
25734 These are load and store instructions, respectively, for certain status flags.
25735 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25736 @code{drem}, and @code{remainder} built-in functions;
25737 see @ref{Other Builtins} for details.
25739 @item -mmovbe
25740 @opindex mmovbe
25741 This option enables use of the @code{movbe} instruction to implement
25742 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25744 @item -mcrc32
25745 @opindex mcrc32
25746 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25747 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25748 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25750 @item -mrecip
25751 @opindex mrecip
25752 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25753 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25754 with an additional Newton-Raphson step
25755 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25756 (and their vectorized
25757 variants) for single-precision floating-point arguments.  These instructions
25758 are generated only when @option{-funsafe-math-optimizations} is enabled
25759 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25760 Note that while the throughput of the sequence is higher than the throughput
25761 of the non-reciprocal instruction, the precision of the sequence can be
25762 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25764 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25765 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25766 combination), and doesn't need @option{-mrecip}.
25768 Also note that GCC emits the above sequence with additional Newton-Raphson step
25769 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25770 already with @option{-ffast-math} (or the above option combination), and
25771 doesn't need @option{-mrecip}.
25773 @item -mrecip=@var{opt}
25774 @opindex mrecip=opt
25775 This option controls which reciprocal estimate instructions
25776 may be used.  @var{opt} is a comma-separated list of options, which may
25777 be preceded by a @samp{!} to invert the option:
25779 @table @samp
25780 @item all
25781 Enable all estimate instructions.
25783 @item default
25784 Enable the default instructions, equivalent to @option{-mrecip}.
25786 @item none
25787 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25789 @item div
25790 Enable the approximation for scalar division.
25792 @item vec-div
25793 Enable the approximation for vectorized division.
25795 @item sqrt
25796 Enable the approximation for scalar square root.
25798 @item vec-sqrt
25799 Enable the approximation for vectorized square root.
25800 @end table
25802 So, for example, @option{-mrecip=all,!sqrt} enables
25803 all of the reciprocal approximations, except for square root.
25805 @item -mveclibabi=@var{type}
25806 @opindex mveclibabi
25807 Specifies the ABI type to use for vectorizing intrinsics using an
25808 external library.  Supported values for @var{type} are @samp{svml} 
25809 for the Intel short
25810 vector math library and @samp{acml} for the AMD math core library.
25811 To use this option, both @option{-ftree-vectorize} and
25812 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25813 ABI-compatible library must be specified at link time.
25815 GCC currently emits calls to @code{vmldExp2},
25816 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25817 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25818 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25819 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25820 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25821 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25822 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25823 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25824 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25825 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25826 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25827 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25828 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25829 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25830 when @option{-mveclibabi=acml} is used.  
25832 @item -mabi=@var{name}
25833 @opindex mabi
25834 Generate code for the specified calling convention.  Permissible values
25835 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25836 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25837 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25838 You can control this behavior for specific functions by
25839 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25840 @xref{Function Attributes}.
25842 @item -mcall-ms2sysv-xlogues
25843 @opindex mcall-ms2sysv-xlogues
25844 @opindex mno-call-ms2sysv-xlogues
25845 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25846 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25847 default, the code for saving and restoring these registers is emitted inline,
25848 resulting in fairly lengthy prologues and epilogues.  Using
25849 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25850 use stubs in the static portion of libgcc to perform these saves and restores,
25851 thus reducing function size at the cost of a few extra instructions.
25853 @item -mtls-dialect=@var{type}
25854 @opindex mtls-dialect
25855 Generate code to access thread-local storage using the @samp{gnu} or
25856 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25857 @samp{gnu2} is more efficient, but it may add compile- and run-time
25858 requirements that cannot be satisfied on all systems.
25860 @item -mpush-args
25861 @itemx -mno-push-args
25862 @opindex mpush-args
25863 @opindex mno-push-args
25864 Use PUSH operations to store outgoing parameters.  This method is shorter
25865 and usually equally fast as method using SUB/MOV operations and is enabled
25866 by default.  In some cases disabling it may improve performance because of
25867 improved scheduling and reduced dependencies.
25869 @item -maccumulate-outgoing-args
25870 @opindex maccumulate-outgoing-args
25871 If enabled, the maximum amount of space required for outgoing arguments is
25872 computed in the function prologue.  This is faster on most modern CPUs
25873 because of reduced dependencies, improved scheduling and reduced stack usage
25874 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25875 increase in code size.  This switch implies @option{-mno-push-args}.
25877 @item -mthreads
25878 @opindex mthreads
25879 Support thread-safe exception handling on MinGW.  Programs that rely
25880 on thread-safe exception handling must compile and link all code with the
25881 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25882 @option{-D_MT}; when linking, it links in a special thread helper library
25883 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25885 @item -mms-bitfields
25886 @itemx -mno-ms-bitfields
25887 @opindex mms-bitfields
25888 @opindex mno-ms-bitfields
25890 Enable/disable bit-field layout compatible with the native Microsoft
25891 Windows compiler.  
25893 If @code{packed} is used on a structure, or if bit-fields are used,
25894 it may be that the Microsoft ABI lays out the structure differently
25895 than the way GCC normally does.  Particularly when moving packed
25896 data between functions compiled with GCC and the native Microsoft compiler
25897 (either via function call or as data in a file), it may be necessary to access
25898 either format.
25900 This option is enabled by default for Microsoft Windows
25901 targets.  This behavior can also be controlled locally by use of variable
25902 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25903 and @ref{x86 Type Attributes}.
25905 The Microsoft structure layout algorithm is fairly simple with the exception
25906 of the bit-field packing.  
25907 The padding and alignment of members of structures and whether a bit-field 
25908 can straddle a storage-unit boundary are determine by these rules:
25910 @enumerate
25911 @item Structure members are stored sequentially in the order in which they are
25912 declared: the first member has the lowest memory address and the last member
25913 the highest.
25915 @item Every data object has an alignment requirement.  The alignment requirement
25916 for all data except structures, unions, and arrays is either the size of the
25917 object or the current packing size (specified with either the
25918 @code{aligned} attribute or the @code{pack} pragma),
25919 whichever is less.  For structures, unions, and arrays,
25920 the alignment requirement is the largest alignment requirement of its members.
25921 Every object is allocated an offset so that:
25923 @smallexample
25924 offset % alignment_requirement == 0
25925 @end smallexample
25927 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25928 unit if the integral types are the same size and if the next bit-field fits
25929 into the current allocation unit without crossing the boundary imposed by the
25930 common alignment requirements of the bit-fields.
25931 @end enumerate
25933 MSVC interprets zero-length bit-fields in the following ways:
25935 @enumerate
25936 @item If a zero-length bit-field is inserted between two bit-fields that
25937 are normally coalesced, the bit-fields are not coalesced.
25939 For example:
25941 @smallexample
25942 struct
25943  @{
25944    unsigned long bf_1 : 12;
25945    unsigned long : 0;
25946    unsigned long bf_2 : 12;
25947  @} t1;
25948 @end smallexample
25950 @noindent
25951 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25952 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25954 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25955 alignment of the zero-length bit-field is greater than the member that follows it,
25956 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25958 For example:
25960 @smallexample
25961 struct
25962  @{
25963    char foo : 4;
25964    short : 0;
25965    char bar;
25966  @} t2;
25968 struct
25969  @{
25970    char foo : 4;
25971    short : 0;
25972    double bar;
25973  @} t3;
25974 @end smallexample
25976 @noindent
25977 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25978 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25979 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25980 of the structure.
25982 Taking this into account, it is important to note the following:
25984 @enumerate
25985 @item If a zero-length bit-field follows a normal bit-field, the type of the
25986 zero-length bit-field may affect the alignment of the structure as whole. For
25987 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25988 normal bit-field, and is of type short.
25990 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25991 still affect the alignment of the structure:
25993 @smallexample
25994 struct
25995  @{
25996    char foo : 6;
25997    long : 0;
25998  @} t4;
25999 @end smallexample
26001 @noindent
26002 Here, @code{t4} takes up 4 bytes.
26003 @end enumerate
26005 @item Zero-length bit-fields following non-bit-field members are ignored:
26007 @smallexample
26008 struct
26009  @{
26010    char foo;
26011    long : 0;
26012    char bar;
26013  @} t5;
26014 @end smallexample
26016 @noindent
26017 Here, @code{t5} takes up 2 bytes.
26018 @end enumerate
26021 @item -mno-align-stringops
26022 @opindex mno-align-stringops
26023 Do not align the destination of inlined string operations.  This switch reduces
26024 code size and improves performance in case the destination is already aligned,
26025 but GCC doesn't know about it.
26027 @item -minline-all-stringops
26028 @opindex minline-all-stringops
26029 By default GCC inlines string operations only when the destination is 
26030 known to be aligned to least a 4-byte boundary.  
26031 This enables more inlining and increases code
26032 size, but may improve performance of code that depends on fast
26033 @code{memcpy}, @code{strlen},
26034 and @code{memset} for short lengths.
26036 @item -minline-stringops-dynamically
26037 @opindex minline-stringops-dynamically
26038 For string operations of unknown size, use run-time checks with
26039 inline code for small blocks and a library call for large blocks.
26041 @item -mstringop-strategy=@var{alg}
26042 @opindex mstringop-strategy=@var{alg}
26043 Override the internal decision heuristic for the particular algorithm to use
26044 for inlining string operations.  The allowed values for @var{alg} are:
26046 @table @samp
26047 @item rep_byte
26048 @itemx rep_4byte
26049 @itemx rep_8byte
26050 Expand using i386 @code{rep} prefix of the specified size.
26052 @item byte_loop
26053 @itemx loop
26054 @itemx unrolled_loop
26055 Expand into an inline loop.
26057 @item libcall
26058 Always use a library call.
26059 @end table
26061 @item -mmemcpy-strategy=@var{strategy}
26062 @opindex mmemcpy-strategy=@var{strategy}
26063 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26064 should be inlined and what inline algorithm to use when the expected size
26065 of the copy operation is known. @var{strategy} 
26066 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26067 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26068 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26069 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26070 in the list must be specified in increasing order.  The minimal byte size for 
26071 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26072 preceding range.
26074 @item -mmemset-strategy=@var{strategy}
26075 @opindex mmemset-strategy=@var{strategy}
26076 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26077 @code{__builtin_memset} expansion.
26079 @item -momit-leaf-frame-pointer
26080 @opindex momit-leaf-frame-pointer
26081 Don't keep the frame pointer in a register for leaf functions.  This
26082 avoids the instructions to save, set up, and restore frame pointers and
26083 makes an extra register available in leaf functions.  The option
26084 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26085 which might make debugging harder.
26087 @item -mtls-direct-seg-refs
26088 @itemx -mno-tls-direct-seg-refs
26089 @opindex mtls-direct-seg-refs
26090 Controls whether TLS variables may be accessed with offsets from the
26091 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26092 or whether the thread base pointer must be added.  Whether or not this
26093 is valid depends on the operating system, and whether it maps the
26094 segment to cover the entire TLS area.
26096 For systems that use the GNU C Library, the default is on.
26098 @item -msse2avx
26099 @itemx -mno-sse2avx
26100 @opindex msse2avx
26101 Specify that the assembler should encode SSE instructions with VEX
26102 prefix.  The option @option{-mavx} turns this on by default.
26104 @item -mfentry
26105 @itemx -mno-fentry
26106 @opindex mfentry
26107 If profiling is active (@option{-pg}), put the profiling
26108 counter call before the prologue.
26109 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26110 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26112 @item -mrecord-mcount
26113 @itemx -mno-record-mcount
26114 @opindex mrecord-mcount
26115 If profiling is active (@option{-pg}), generate a __mcount_loc section
26116 that contains pointers to each profiling call. This is useful for
26117 automatically patching and out calls.
26119 @item -mnop-mcount
26120 @itemx -mno-nop-mcount
26121 @opindex mnop-mcount
26122 If profiling is active (@option{-pg}), generate the calls to
26123 the profiling functions as NOPs. This is useful when they
26124 should be patched in later dynamically. This is likely only
26125 useful together with @option{-mrecord-mcount}.
26127 @item -mskip-rax-setup
26128 @itemx -mno-skip-rax-setup
26129 @opindex mskip-rax-setup
26130 When generating code for the x86-64 architecture with SSE extensions
26131 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26132 register when there are no variable arguments passed in vector registers.
26134 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26135 saving vector registers on stack when passing variable arguments, the
26136 impacts of this option are callees may waste some stack space,
26137 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26138 those issues, regardless the RAX register value.
26140 @item -m8bit-idiv
26141 @itemx -mno-8bit-idiv
26142 @opindex m8bit-idiv
26143 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26144 much faster than 32-bit/64-bit integer divide.  This option generates a
26145 run-time check.  If both dividend and divisor are within range of 0
26146 to 255, 8-bit unsigned integer divide is used instead of
26147 32-bit/64-bit integer divide.
26149 @item -mavx256-split-unaligned-load
26150 @itemx -mavx256-split-unaligned-store
26151 @opindex mavx256-split-unaligned-load
26152 @opindex mavx256-split-unaligned-store
26153 Split 32-byte AVX unaligned load and store.
26155 @item -mstack-protector-guard=@var{guard}
26156 @itemx -mstack-protector-guard-reg=@var{reg}
26157 @itemx -mstack-protector-guard-offset=@var{offset}
26158 @opindex mstack-protector-guard
26159 @opindex mstack-protector-guard-reg
26160 @opindex mstack-protector-guard-offset
26161 Generate stack protection code using canary at @var{guard}.  Supported
26162 locations are @samp{global} for global canary or @samp{tls} for per-thread
26163 canary in the TLS block (the default).  This option has effect only when
26164 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26166 With the latter choice the options
26167 @option{-mstack-protector-guard-reg=@var{reg}} and
26168 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26169 which segment register (@code{%fs} or @code{%gs}) to use as base register
26170 for reading the canary, and from what offset from that base register.
26171 The default for those is as specified in the relevant ABI.
26173 @item -mmitigate-rop
26174 @opindex mmitigate-rop
26175 Try to avoid generating code sequences that contain unintended return
26176 opcodes, to mitigate against certain forms of attack. At the moment,
26177 this option is limited in what it can do and should not be relied
26178 on to provide serious protection.
26180 @item -mgeneral-regs-only
26181 @opindex mgeneral-regs-only
26182 Generate code that uses only the general-purpose registers.  This
26183 prevents the compiler from using floating-point, vector, mask and bound
26184 registers.
26186 @end table
26188 These @samp{-m} switches are supported in addition to the above
26189 on x86-64 processors in 64-bit environments.
26191 @table @gcctabopt
26192 @item -m32
26193 @itemx -m64
26194 @itemx -mx32
26195 @itemx -m16
26196 @itemx -miamcu
26197 @opindex m32
26198 @opindex m64
26199 @opindex mx32
26200 @opindex m16
26201 @opindex miamcu
26202 Generate code for a 16-bit, 32-bit or 64-bit environment.
26203 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26204 to 32 bits, and
26205 generates code that runs on any i386 system.
26207 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26208 types to 64 bits, and generates code for the x86-64 architecture.
26209 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26210 and @option{-mdynamic-no-pic} options.
26212 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26213 to 32 bits, and
26214 generates code for the x86-64 architecture.
26216 The @option{-m16} option is the same as @option{-m32}, except for that
26217 it outputs the @code{.code16gcc} assembly directive at the beginning of
26218 the assembly output so that the binary can run in 16-bit mode.
26220 The @option{-miamcu} option generates code which conforms to Intel MCU
26221 psABI.  It requires the @option{-m32} option to be turned on.
26223 @item -mno-red-zone
26224 @opindex mno-red-zone
26225 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26226 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26227 stack pointer that is not modified by signal or interrupt handlers
26228 and therefore can be used for temporary data without adjusting the stack
26229 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26231 @item -mcmodel=small
26232 @opindex mcmodel=small
26233 Generate code for the small code model: the program and its symbols must
26234 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26235 Programs can be statically or dynamically linked.  This is the default
26236 code model.
26238 @item -mcmodel=kernel
26239 @opindex mcmodel=kernel
26240 Generate code for the kernel code model.  The kernel runs in the
26241 negative 2 GB of the address space.
26242 This model has to be used for Linux kernel code.
26244 @item -mcmodel=medium
26245 @opindex mcmodel=medium
26246 Generate code for the medium model: the program is linked in the lower 2
26247 GB of the address space.  Small symbols are also placed there.  Symbols
26248 with sizes larger than @option{-mlarge-data-threshold} are put into
26249 large data or BSS sections and can be located above 2GB.  Programs can
26250 be statically or dynamically linked.
26252 @item -mcmodel=large
26253 @opindex mcmodel=large
26254 Generate code for the large model.  This model makes no assumptions
26255 about addresses and sizes of sections.
26257 @item -maddress-mode=long
26258 @opindex maddress-mode=long
26259 Generate code for long address mode.  This is only supported for 64-bit
26260 and x32 environments.  It is the default address mode for 64-bit
26261 environments.
26263 @item -maddress-mode=short
26264 @opindex maddress-mode=short
26265 Generate code for short address mode.  This is only supported for 32-bit
26266 and x32 environments.  It is the default address mode for 32-bit and
26267 x32 environments.
26268 @end table
26270 @node x86 Windows Options
26271 @subsection x86 Windows Options
26272 @cindex x86 Windows Options
26273 @cindex Windows Options for x86
26275 These additional options are available for Microsoft Windows targets:
26277 @table @gcctabopt
26278 @item -mconsole
26279 @opindex mconsole
26280 This option
26281 specifies that a console application is to be generated, by
26282 instructing the linker to set the PE header subsystem type
26283 required for console applications.
26284 This option is available for Cygwin and MinGW targets and is
26285 enabled by default on those targets.
26287 @item -mdll
26288 @opindex mdll
26289 This option is available for Cygwin and MinGW targets.  It
26290 specifies that a DLL---a dynamic link library---is to be
26291 generated, enabling the selection of the required runtime
26292 startup object and entry point.
26294 @item -mnop-fun-dllimport
26295 @opindex mnop-fun-dllimport
26296 This option is available for Cygwin and MinGW targets.  It
26297 specifies that the @code{dllimport} attribute should be ignored.
26299 @item -mthread
26300 @opindex mthread
26301 This option is available for MinGW targets. It specifies
26302 that MinGW-specific thread support is to be used.
26304 @item -municode
26305 @opindex municode
26306 This option is available for MinGW-w64 targets.  It causes
26307 the @code{UNICODE} preprocessor macro to be predefined, and
26308 chooses Unicode-capable runtime startup code.
26310 @item -mwin32
26311 @opindex mwin32
26312 This option is available for Cygwin and MinGW targets.  It
26313 specifies that the typical Microsoft Windows predefined macros are to
26314 be set in the pre-processor, but does not influence the choice
26315 of runtime library/startup code.
26317 @item -mwindows
26318 @opindex mwindows
26319 This option is available for Cygwin and MinGW targets.  It
26320 specifies that a GUI application is to be generated by
26321 instructing the linker to set the PE header subsystem type
26322 appropriately.
26324 @item -fno-set-stack-executable
26325 @opindex fno-set-stack-executable
26326 This option is available for MinGW targets. It specifies that
26327 the executable flag for the stack used by nested functions isn't
26328 set. This is necessary for binaries running in kernel mode of
26329 Microsoft Windows, as there the User32 API, which is used to set executable
26330 privileges, isn't available.
26332 @item -fwritable-relocated-rdata
26333 @opindex fno-writable-relocated-rdata
26334 This option is available for MinGW and Cygwin targets.  It specifies
26335 that relocated-data in read-only section is put into the @code{.data}
26336 section.  This is a necessary for older runtimes not supporting
26337 modification of @code{.rdata} sections for pseudo-relocation.
26339 @item -mpe-aligned-commons
26340 @opindex mpe-aligned-commons
26341 This option is available for Cygwin and MinGW targets.  It
26342 specifies that the GNU extension to the PE file format that
26343 permits the correct alignment of COMMON variables should be
26344 used when generating code.  It is enabled by default if
26345 GCC detects that the target assembler found during configuration
26346 supports the feature.
26347 @end table
26349 See also under @ref{x86 Options} for standard options.
26351 @node Xstormy16 Options
26352 @subsection Xstormy16 Options
26353 @cindex Xstormy16 Options
26355 These options are defined for Xstormy16:
26357 @table @gcctabopt
26358 @item -msim
26359 @opindex msim
26360 Choose startup files and linker script suitable for the simulator.
26361 @end table
26363 @node Xtensa Options
26364 @subsection Xtensa Options
26365 @cindex Xtensa Options
26367 These options are supported for Xtensa targets:
26369 @table @gcctabopt
26370 @item -mconst16
26371 @itemx -mno-const16
26372 @opindex mconst16
26373 @opindex mno-const16
26374 Enable or disable use of @code{CONST16} instructions for loading
26375 constant values.  The @code{CONST16} instruction is currently not a
26376 standard option from Tensilica.  When enabled, @code{CONST16}
26377 instructions are always used in place of the standard @code{L32R}
26378 instructions.  The use of @code{CONST16} is enabled by default only if
26379 the @code{L32R} instruction is not available.
26381 @item -mfused-madd
26382 @itemx -mno-fused-madd
26383 @opindex mfused-madd
26384 @opindex mno-fused-madd
26385 Enable or disable use of fused multiply/add and multiply/subtract
26386 instructions in the floating-point option.  This has no effect if the
26387 floating-point option is not also enabled.  Disabling fused multiply/add
26388 and multiply/subtract instructions forces the compiler to use separate
26389 instructions for the multiply and add/subtract operations.  This may be
26390 desirable in some cases where strict IEEE 754-compliant results are
26391 required: the fused multiply add/subtract instructions do not round the
26392 intermediate result, thereby producing results with @emph{more} bits of
26393 precision than specified by the IEEE standard.  Disabling fused multiply
26394 add/subtract instructions also ensures that the program output is not
26395 sensitive to the compiler's ability to combine multiply and add/subtract
26396 operations.
26398 @item -mserialize-volatile
26399 @itemx -mno-serialize-volatile
26400 @opindex mserialize-volatile
26401 @opindex mno-serialize-volatile
26402 When this option is enabled, GCC inserts @code{MEMW} instructions before
26403 @code{volatile} memory references to guarantee sequential consistency.
26404 The default is @option{-mserialize-volatile}.  Use
26405 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26407 @item -mforce-no-pic
26408 @opindex mforce-no-pic
26409 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26410 position-independent code (PIC), this option disables PIC for compiling
26411 kernel code.
26413 @item -mtext-section-literals
26414 @itemx -mno-text-section-literals
26415 @opindex mtext-section-literals
26416 @opindex mno-text-section-literals
26417 These options control the treatment of literal pools.  The default is
26418 @option{-mno-text-section-literals}, which places literals in a separate
26419 section in the output file.  This allows the literal pool to be placed
26420 in a data RAM/ROM, and it also allows the linker to combine literal
26421 pools from separate object files to remove redundant literals and
26422 improve code size.  With @option{-mtext-section-literals}, the literals
26423 are interspersed in the text section in order to keep them as close as
26424 possible to their references.  This may be necessary for large assembly
26425 files.  Literals for each function are placed right before that function.
26427 @item -mauto-litpools
26428 @itemx -mno-auto-litpools
26429 @opindex mauto-litpools
26430 @opindex mno-auto-litpools
26431 These options control the treatment of literal pools.  The default is
26432 @option{-mno-auto-litpools}, which places literals in a separate
26433 section in the output file unless @option{-mtext-section-literals} is
26434 used.  With @option{-mauto-litpools} the literals are interspersed in
26435 the text section by the assembler.  Compiler does not produce explicit
26436 @code{.literal} directives and loads literals into registers with
26437 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26438 do relaxation and place literals as necessary.  This option allows
26439 assembler to create several literal pools per function and assemble
26440 very big functions, which may not be possible with
26441 @option{-mtext-section-literals}.
26443 @item -mtarget-align
26444 @itemx -mno-target-align
26445 @opindex mtarget-align
26446 @opindex mno-target-align
26447 When this option is enabled, GCC instructs the assembler to
26448 automatically align instructions to reduce branch penalties at the
26449 expense of some code density.  The assembler attempts to widen density
26450 instructions to align branch targets and the instructions following call
26451 instructions.  If there are not enough preceding safe density
26452 instructions to align a target, no widening is performed.  The
26453 default is @option{-mtarget-align}.  These options do not affect the
26454 treatment of auto-aligned instructions like @code{LOOP}, which the
26455 assembler always aligns, either by widening density instructions or
26456 by inserting NOP instructions.
26458 @item -mlongcalls
26459 @itemx -mno-longcalls
26460 @opindex mlongcalls
26461 @opindex mno-longcalls
26462 When this option is enabled, GCC instructs the assembler to translate
26463 direct calls to indirect calls unless it can determine that the target
26464 of a direct call is in the range allowed by the call instruction.  This
26465 translation typically occurs for calls to functions in other source
26466 files.  Specifically, the assembler translates a direct @code{CALL}
26467 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26468 The default is @option{-mno-longcalls}.  This option should be used in
26469 programs where the call target can potentially be out of range.  This
26470 option is implemented in the assembler, not the compiler, so the
26471 assembly code generated by GCC still shows direct call
26472 instructions---look at the disassembled object code to see the actual
26473 instructions.  Note that the assembler uses an indirect call for
26474 every cross-file call, not just those that really are out of range.
26475 @end table
26477 @node zSeries Options
26478 @subsection zSeries Options
26479 @cindex zSeries options
26481 These are listed under @xref{S/390 and zSeries Options}.
26484 @c man end
26486 @node Spec Files
26487 @section Specifying Subprocesses and the Switches to Pass to Them
26488 @cindex Spec Files
26490 @command{gcc} is a driver program.  It performs its job by invoking a
26491 sequence of other programs to do the work of compiling, assembling and
26492 linking.  GCC interprets its command-line parameters and uses these to
26493 deduce which programs it should invoke, and which command-line options
26494 it ought to place on their command lines.  This behavior is controlled
26495 by @dfn{spec strings}.  In most cases there is one spec string for each
26496 program that GCC can invoke, but a few programs have multiple spec
26497 strings to control their behavior.  The spec strings built into GCC can
26498 be overridden by using the @option{-specs=} command-line switch to specify
26499 a spec file.
26501 @dfn{Spec files} are plain-text files that are used to construct spec
26502 strings.  They consist of a sequence of directives separated by blank
26503 lines.  The type of directive is determined by the first non-whitespace
26504 character on the line, which can be one of the following:
26506 @table @code
26507 @item %@var{command}
26508 Issues a @var{command} to the spec file processor.  The commands that can
26509 appear here are:
26511 @table @code
26512 @item %include <@var{file}>
26513 @cindex @code{%include}
26514 Search for @var{file} and insert its text at the current point in the
26515 specs file.
26517 @item %include_noerr <@var{file}>
26518 @cindex @code{%include_noerr}
26519 Just like @samp{%include}, but do not generate an error message if the include
26520 file cannot be found.
26522 @item %rename @var{old_name} @var{new_name}
26523 @cindex @code{%rename}
26524 Rename the spec string @var{old_name} to @var{new_name}.
26526 @end table
26528 @item *[@var{spec_name}]:
26529 This tells the compiler to create, override or delete the named spec
26530 string.  All lines after this directive up to the next directive or
26531 blank line are considered to be the text for the spec string.  If this
26532 results in an empty string then the spec is deleted.  (Or, if the
26533 spec did not exist, then nothing happens.)  Otherwise, if the spec
26534 does not currently exist a new spec is created.  If the spec does
26535 exist then its contents are overridden by the text of this
26536 directive, unless the first character of that text is the @samp{+}
26537 character, in which case the text is appended to the spec.
26539 @item [@var{suffix}]:
26540 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26541 and up to the next directive or blank line are considered to make up the
26542 spec string for the indicated suffix.  When the compiler encounters an
26543 input file with the named suffix, it processes the spec string in
26544 order to work out how to compile that file.  For example:
26546 @smallexample
26547 .ZZ:
26548 z-compile -input %i
26549 @end smallexample
26551 This says that any input file whose name ends in @samp{.ZZ} should be
26552 passed to the program @samp{z-compile}, which should be invoked with the
26553 command-line switch @option{-input} and with the result of performing the
26554 @samp{%i} substitution.  (See below.)
26556 As an alternative to providing a spec string, the text following a
26557 suffix directive can be one of the following:
26559 @table @code
26560 @item @@@var{language}
26561 This says that the suffix is an alias for a known @var{language}.  This is
26562 similar to using the @option{-x} command-line switch to GCC to specify a
26563 language explicitly.  For example:
26565 @smallexample
26566 .ZZ:
26567 @@c++
26568 @end smallexample
26570 Says that .ZZ files are, in fact, C++ source files.
26572 @item #@var{name}
26573 This causes an error messages saying:
26575 @smallexample
26576 @var{name} compiler not installed on this system.
26577 @end smallexample
26578 @end table
26580 GCC already has an extensive list of suffixes built into it.
26581 This directive adds an entry to the end of the list of suffixes, but
26582 since the list is searched from the end backwards, it is effectively
26583 possible to override earlier entries using this technique.
26585 @end table
26587 GCC has the following spec strings built into it.  Spec files can
26588 override these strings or create their own.  Note that individual
26589 targets can also add their own spec strings to this list.
26591 @smallexample
26592 asm          Options to pass to the assembler
26593 asm_final    Options to pass to the assembler post-processor
26594 cpp          Options to pass to the C preprocessor
26595 cc1          Options to pass to the C compiler
26596 cc1plus      Options to pass to the C++ compiler
26597 endfile      Object files to include at the end of the link
26598 link         Options to pass to the linker
26599 lib          Libraries to include on the command line to the linker
26600 libgcc       Decides which GCC support library to pass to the linker
26601 linker       Sets the name of the linker
26602 predefines   Defines to be passed to the C preprocessor
26603 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26604              by default
26605 startfile    Object files to include at the start of the link
26606 @end smallexample
26608 Here is a small example of a spec file:
26610 @smallexample
26611 %rename lib                 old_lib
26613 *lib:
26614 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26615 @end smallexample
26617 This example renames the spec called @samp{lib} to @samp{old_lib} and
26618 then overrides the previous definition of @samp{lib} with a new one.
26619 The new definition adds in some extra command-line options before
26620 including the text of the old definition.
26622 @dfn{Spec strings} are a list of command-line options to be passed to their
26623 corresponding program.  In addition, the spec strings can contain
26624 @samp{%}-prefixed sequences to substitute variable text or to
26625 conditionally insert text into the command line.  Using these constructs
26626 it is possible to generate quite complex command lines.
26628 Here is a table of all defined @samp{%}-sequences for spec
26629 strings.  Note that spaces are not generated automatically around the
26630 results of expanding these sequences.  Therefore you can concatenate them
26631 together or combine them with constant text in a single argument.
26633 @table @code
26634 @item %%
26635 Substitute one @samp{%} into the program name or argument.
26637 @item %i
26638 Substitute the name of the input file being processed.
26640 @item %b
26641 Substitute the basename of the input file being processed.
26642 This is the substring up to (and not including) the last period
26643 and not including the directory.
26645 @item %B
26646 This is the same as @samp{%b}, but include the file suffix (text after
26647 the last period).
26649 @item %d
26650 Marks the argument containing or following the @samp{%d} as a
26651 temporary file name, so that that file is deleted if GCC exits
26652 successfully.  Unlike @samp{%g}, this contributes no text to the
26653 argument.
26655 @item %g@var{suffix}
26656 Substitute a file name that has suffix @var{suffix} and is chosen
26657 once per compilation, and mark the argument in the same way as
26658 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26659 name is now chosen in a way that is hard to predict even when previously
26660 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26661 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26662 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26663 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26664 was simply substituted with a file name chosen once per compilation,
26665 without regard to any appended suffix (which was therefore treated
26666 just like ordinary text), making such attacks more likely to succeed.
26668 @item %u@var{suffix}
26669 Like @samp{%g}, but generates a new temporary file name
26670 each time it appears instead of once per compilation.
26672 @item %U@var{suffix}
26673 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26674 new one if there is no such last file name.  In the absence of any
26675 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26676 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26677 involves the generation of two distinct file names, one
26678 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26679 simply substituted with a file name chosen for the previous @samp{%u},
26680 without regard to any appended suffix.
26682 @item %j@var{suffix}
26683 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26684 writable, and if @option{-save-temps} is not used; 
26685 otherwise, substitute the name
26686 of a temporary file, just like @samp{%u}.  This temporary file is not
26687 meant for communication between processes, but rather as a junk
26688 disposal mechanism.
26690 @item %|@var{suffix}
26691 @itemx %m@var{suffix}
26692 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26693 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26694 all.  These are the two most common ways to instruct a program that it
26695 should read from standard input or write to standard output.  If you
26696 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26697 construct: see for example @file{f/lang-specs.h}.
26699 @item %.@var{SUFFIX}
26700 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26701 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26702 terminated by the next space or %.
26704 @item %w
26705 Marks the argument containing or following the @samp{%w} as the
26706 designated output file of this compilation.  This puts the argument
26707 into the sequence of arguments that @samp{%o} substitutes.
26709 @item %o
26710 Substitutes the names of all the output files, with spaces
26711 automatically placed around them.  You should write spaces
26712 around the @samp{%o} as well or the results are undefined.
26713 @samp{%o} is for use in the specs for running the linker.
26714 Input files whose names have no recognized suffix are not compiled
26715 at all, but they are included among the output files, so they are
26716 linked.
26718 @item %O
26719 Substitutes the suffix for object files.  Note that this is
26720 handled specially when it immediately follows @samp{%g, %u, or %U},
26721 because of the need for those to form complete file names.  The
26722 handling is such that @samp{%O} is treated exactly as if it had already
26723 been substituted, except that @samp{%g, %u, and %U} do not currently
26724 support additional @var{suffix} characters following @samp{%O} as they do
26725 following, for example, @samp{.o}.
26727 @item %p
26728 Substitutes the standard macro predefinitions for the
26729 current target machine.  Use this when running @command{cpp}.
26731 @item %P
26732 Like @samp{%p}, but puts @samp{__} before and after the name of each
26733 predefined macro, except for macros that start with @samp{__} or with
26734 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26737 @item %I
26738 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26739 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26740 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26741 and @option{-imultilib} as necessary.
26743 @item %s
26744 Current argument is the name of a library or startup file of some sort.
26745 Search for that file in a standard list of directories and substitute
26746 the full name found.  The current working directory is included in the
26747 list of directories scanned.
26749 @item %T
26750 Current argument is the name of a linker script.  Search for that file
26751 in the current list of directories to scan for libraries. If the file
26752 is located insert a @option{--script} option into the command line
26753 followed by the full path name found.  If the file is not found then
26754 generate an error message.  Note: the current working directory is not
26755 searched.
26757 @item %e@var{str}
26758 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26759 Use this when inconsistent options are detected.
26761 @item %(@var{name})
26762 Substitute the contents of spec string @var{name} at this point.
26764 @item %x@{@var{option}@}
26765 Accumulate an option for @samp{%X}.
26767 @item %X
26768 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26769 spec string.
26771 @item %Y
26772 Output the accumulated assembler options specified by @option{-Wa}.
26774 @item %Z
26775 Output the accumulated preprocessor options specified by @option{-Wp}.
26777 @item %a
26778 Process the @code{asm} spec.  This is used to compute the
26779 switches to be passed to the assembler.
26781 @item %A
26782 Process the @code{asm_final} spec.  This is a spec string for
26783 passing switches to an assembler post-processor, if such a program is
26784 needed.
26786 @item %l
26787 Process the @code{link} spec.  This is the spec for computing the
26788 command line passed to the linker.  Typically it makes use of the
26789 @samp{%L %G %S %D and %E} sequences.
26791 @item %D
26792 Dump out a @option{-L} option for each directory that GCC believes might
26793 contain startup files.  If the target supports multilibs then the
26794 current multilib directory is prepended to each of these paths.
26796 @item %L
26797 Process the @code{lib} spec.  This is a spec string for deciding which
26798 libraries are included on the command line to the linker.
26800 @item %G
26801 Process the @code{libgcc} spec.  This is a spec string for deciding
26802 which GCC support library is included on the command line to the linker.
26804 @item %S
26805 Process the @code{startfile} spec.  This is a spec for deciding which
26806 object files are the first ones passed to the linker.  Typically
26807 this might be a file named @file{crt0.o}.
26809 @item %E
26810 Process the @code{endfile} spec.  This is a spec string that specifies
26811 the last object files that are passed to the linker.
26813 @item %C
26814 Process the @code{cpp} spec.  This is used to construct the arguments
26815 to be passed to the C preprocessor.
26817 @item %1
26818 Process the @code{cc1} spec.  This is used to construct the options to be
26819 passed to the actual C compiler (@command{cc1}).
26821 @item %2
26822 Process the @code{cc1plus} spec.  This is used to construct the options to be
26823 passed to the actual C++ compiler (@command{cc1plus}).
26825 @item %*
26826 Substitute the variable part of a matched option.  See below.
26827 Note that each comma in the substituted string is replaced by
26828 a single space.
26830 @item %<S
26831 Remove all occurrences of @code{-S} from the command line.  Note---this
26832 command is position dependent.  @samp{%} commands in the spec string
26833 before this one see @code{-S}, @samp{%} commands in the spec string
26834 after this one do not.
26836 @item %:@var{function}(@var{args})
26837 Call the named function @var{function}, passing it @var{args}.
26838 @var{args} is first processed as a nested spec string, then split
26839 into an argument vector in the usual fashion.  The function returns
26840 a string which is processed as if it had appeared literally as part
26841 of the current spec.
26843 The following built-in spec functions are provided:
26845 @table @code
26846 @item @code{getenv}
26847 The @code{getenv} spec function takes two arguments: an environment
26848 variable name and a string.  If the environment variable is not
26849 defined, a fatal error is issued.  Otherwise, the return value is the
26850 value of the environment variable concatenated with the string.  For
26851 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26853 @smallexample
26854 %:getenv(TOPDIR /include)
26855 @end smallexample
26857 expands to @file{/path/to/top/include}.
26859 @item @code{if-exists}
26860 The @code{if-exists} spec function takes one argument, an absolute
26861 pathname to a file.  If the file exists, @code{if-exists} returns the
26862 pathname.  Here is a small example of its usage:
26864 @smallexample
26865 *startfile:
26866 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26867 @end smallexample
26869 @item @code{if-exists-else}
26870 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26871 spec function, except that it takes two arguments.  The first argument is
26872 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26873 returns the pathname.  If it does not exist, it returns the second argument.
26874 This way, @code{if-exists-else} can be used to select one file or another,
26875 based on the existence of the first.  Here is a small example of its usage:
26877 @smallexample
26878 *startfile:
26879 crt0%O%s %:if-exists(crti%O%s) \
26880 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26881 @end smallexample
26883 @item @code{replace-outfile}
26884 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26885 first argument in the outfiles array and replaces it with the second argument.  Here
26886 is a small example of its usage:
26888 @smallexample
26889 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26890 @end smallexample
26892 @item @code{remove-outfile}
26893 The @code{remove-outfile} spec function takes one argument.  It looks for the
26894 first argument in the outfiles array and removes it.  Here is a small example
26895 its usage:
26897 @smallexample
26898 %:remove-outfile(-lm)
26899 @end smallexample
26901 @item @code{pass-through-libs}
26902 The @code{pass-through-libs} spec function takes any number of arguments.  It
26903 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26904 assumes are the names of linker input library archive files) and returns a
26905 result containing all the found arguments each prepended by
26906 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26907 intended to be passed to the LTO linker plugin.
26909 @smallexample
26910 %:pass-through-libs(%G %L %G)
26911 @end smallexample
26913 @item @code{print-asm-header}
26914 The @code{print-asm-header} function takes no arguments and simply
26915 prints a banner like:
26917 @smallexample
26918 Assembler options
26919 =================
26921 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26922 @end smallexample
26924 It is used to separate compiler options from assembler options
26925 in the @option{--target-help} output.
26926 @end table
26928 @item %@{S@}
26929 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26930 If that switch is not specified, this substitutes nothing.  Note that
26931 the leading dash is omitted when specifying this option, and it is
26932 automatically inserted if the substitution is performed.  Thus the spec
26933 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26934 and outputs the command-line option @option{-foo}.
26936 @item %W@{S@}
26937 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26938 deleted on failure.
26940 @item %@{S*@}
26941 Substitutes all the switches specified to GCC whose names start
26942 with @code{-S}, but which also take an argument.  This is used for
26943 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26944 GCC considers @option{-o foo} as being
26945 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26946 text, including the space.  Thus two arguments are generated.
26948 @item %@{S*&T*@}
26949 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26950 (the order of @code{S} and @code{T} in the spec is not significant).
26951 There can be any number of ampersand-separated variables; for each the
26952 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26954 @item %@{S:X@}
26955 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26957 @item %@{!S:X@}
26958 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26960 @item %@{S*:X@}
26961 Substitutes @code{X} if one or more switches whose names start with
26962 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26963 once, no matter how many such switches appeared.  However, if @code{%*}
26964 appears somewhere in @code{X}, then @code{X} is substituted once
26965 for each matching switch, with the @code{%*} replaced by the part of
26966 that switch matching the @code{*}.
26968 If @code{%*} appears as the last part of a spec sequence then a space
26969 is added after the end of the last substitution.  If there is more
26970 text in the sequence, however, then a space is not generated.  This
26971 allows the @code{%*} substitution to be used as part of a larger
26972 string.  For example, a spec string like this:
26974 @smallexample
26975 %@{mcu=*:--script=%*/memory.ld@}
26976 @end smallexample
26978 @noindent
26979 when matching an option like @option{-mcu=newchip} produces:
26981 @smallexample
26982 --script=newchip/memory.ld
26983 @end smallexample
26985 @item %@{.S:X@}
26986 Substitutes @code{X}, if processing a file with suffix @code{S}.
26988 @item %@{!.S:X@}
26989 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26991 @item %@{,S:X@}
26992 Substitutes @code{X}, if processing a file for language @code{S}.
26994 @item %@{!,S:X@}
26995 Substitutes @code{X}, if not processing a file for language @code{S}.
26997 @item %@{S|P:X@}
26998 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26999 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27000 @code{*} sequences as well, although they have a stronger binding than
27001 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27002 alternatives must be starred, and only the first matching alternative
27003 is substituted.
27005 For example, a spec string like this:
27007 @smallexample
27008 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27009 @end smallexample
27011 @noindent
27012 outputs the following command-line options from the following input
27013 command-line options:
27015 @smallexample
27016 fred.c        -foo -baz
27017 jim.d         -bar -boggle
27018 -d fred.c     -foo -baz -boggle
27019 -d jim.d      -bar -baz -boggle
27020 @end smallexample
27022 @item %@{S:X; T:Y; :D@}
27024 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27025 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27026 be as many clauses as you need.  This may be combined with @code{.},
27027 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27030 @end table
27032 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27033 or similar construct can use a backslash to ignore the special meaning
27034 of the character following it, thus allowing literal matching of a
27035 character that is otherwise specially treated.  For example,
27036 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27037 @option{-std=iso9899:1999} option is given.
27039 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27040 construct may contain other nested @samp{%} constructs or spaces, or
27041 even newlines.  They are processed as usual, as described above.
27042 Trailing white space in @code{X} is ignored.  White space may also
27043 appear anywhere on the left side of the colon in these constructs,
27044 except between @code{.} or @code{*} and the corresponding word.
27046 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27047 handled specifically in these constructs.  If another value of
27048 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27049 @option{-W} switch is found later in the command line, the earlier
27050 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27051 just one letter, which passes all matching options.
27053 The character @samp{|} at the beginning of the predicate text is used to
27054 indicate that a command should be piped to the following command, but
27055 only if @option{-pipe} is specified.
27057 It is built into GCC which switches take arguments and which do not.
27058 (You might think it would be useful to generalize this to allow each
27059 compiler's spec to say which switches take arguments.  But this cannot
27060 be done in a consistent fashion.  GCC cannot even decide which input
27061 files have been specified without knowing which switches take arguments,
27062 and it must know which input files to compile in order to tell which
27063 compilers to run).
27065 GCC also knows implicitly that arguments starting in @option{-l} are to be
27066 treated as compiler output files, and passed to the linker in their
27067 proper position among the other output files.
27069 @node Environment Variables
27070 @section Environment Variables Affecting GCC
27071 @cindex environment variables
27073 @c man begin ENVIRONMENT
27074 This section describes several environment variables that affect how GCC
27075 operates.  Some of them work by specifying directories or prefixes to use
27076 when searching for various kinds of files.  Some are used to specify other
27077 aspects of the compilation environment.
27079 Note that you can also specify places to search using options such as
27080 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27081 take precedence over places specified using environment variables, which
27082 in turn take precedence over those specified by the configuration of GCC@.
27083 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27084 GNU Compiler Collection (GCC) Internals}.
27086 @table @env
27087 @item LANG
27088 @itemx LC_CTYPE
27089 @c @itemx LC_COLLATE
27090 @itemx LC_MESSAGES
27091 @c @itemx LC_MONETARY
27092 @c @itemx LC_NUMERIC
27093 @c @itemx LC_TIME
27094 @itemx LC_ALL
27095 @findex LANG
27096 @findex LC_CTYPE
27097 @c @findex LC_COLLATE
27098 @findex LC_MESSAGES
27099 @c @findex LC_MONETARY
27100 @c @findex LC_NUMERIC
27101 @c @findex LC_TIME
27102 @findex LC_ALL
27103 @cindex locale
27104 These environment variables control the way that GCC uses
27105 localization information which allows GCC to work with different
27106 national conventions.  GCC inspects the locale categories
27107 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27108 so.  These locale categories can be set to any value supported by your
27109 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27110 Kingdom encoded in UTF-8.
27112 The @env{LC_CTYPE} environment variable specifies character
27113 classification.  GCC uses it to determine the character boundaries in
27114 a string; this is needed for some multibyte encodings that contain quote
27115 and escape characters that are otherwise interpreted as a string
27116 end or escape.
27118 The @env{LC_MESSAGES} environment variable specifies the language to
27119 use in diagnostic messages.
27121 If the @env{LC_ALL} environment variable is set, it overrides the value
27122 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27123 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27124 environment variable.  If none of these variables are set, GCC
27125 defaults to traditional C English behavior.
27127 @item TMPDIR
27128 @findex TMPDIR
27129 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27130 files.  GCC uses temporary files to hold the output of one stage of
27131 compilation which is to be used as input to the next stage: for example,
27132 the output of the preprocessor, which is the input to the compiler
27133 proper.
27135 @item GCC_COMPARE_DEBUG
27136 @findex GCC_COMPARE_DEBUG
27137 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27138 @option{-fcompare-debug} to the compiler driver.  See the documentation
27139 of this option for more details.
27141 @item GCC_EXEC_PREFIX
27142 @findex GCC_EXEC_PREFIX
27143 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27144 names of the subprograms executed by the compiler.  No slash is added
27145 when this prefix is combined with the name of a subprogram, but you can
27146 specify a prefix that ends with a slash if you wish.
27148 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27149 an appropriate prefix to use based on the pathname it is invoked with.
27151 If GCC cannot find the subprogram using the specified prefix, it
27152 tries looking in the usual places for the subprogram.
27154 The default value of @env{GCC_EXEC_PREFIX} is
27155 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27156 the installed compiler. In many cases @var{prefix} is the value
27157 of @code{prefix} when you ran the @file{configure} script.
27159 Other prefixes specified with @option{-B} take precedence over this prefix.
27161 This prefix is also used for finding files such as @file{crt0.o} that are
27162 used for linking.
27164 In addition, the prefix is used in an unusual way in finding the
27165 directories to search for header files.  For each of the standard
27166 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27167 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27168 replacing that beginning with the specified prefix to produce an
27169 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27170 @file{foo/bar} just before it searches the standard directory 
27171 @file{/usr/local/lib/bar}.
27172 If a standard directory begins with the configured
27173 @var{prefix} then the value of @var{prefix} is replaced by
27174 @env{GCC_EXEC_PREFIX} when looking for header files.
27176 @item COMPILER_PATH
27177 @findex COMPILER_PATH
27178 The value of @env{COMPILER_PATH} is a colon-separated list of
27179 directories, much like @env{PATH}.  GCC tries the directories thus
27180 specified when searching for subprograms, if it cannot find the
27181 subprograms using @env{GCC_EXEC_PREFIX}.
27183 @item LIBRARY_PATH
27184 @findex LIBRARY_PATH
27185 The value of @env{LIBRARY_PATH} is a colon-separated list of
27186 directories, much like @env{PATH}.  When configured as a native compiler,
27187 GCC tries the directories thus specified when searching for special
27188 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27189 using GCC also uses these directories when searching for ordinary
27190 libraries for the @option{-l} option (but directories specified with
27191 @option{-L} come first).
27193 @item LANG
27194 @findex LANG
27195 @cindex locale definition
27196 This variable is used to pass locale information to the compiler.  One way in
27197 which this information is used is to determine the character set to be used
27198 when character literals, string literals and comments are parsed in C and C++.
27199 When the compiler is configured to allow multibyte characters,
27200 the following values for @env{LANG} are recognized:
27202 @table @samp
27203 @item C-JIS
27204 Recognize JIS characters.
27205 @item C-SJIS
27206 Recognize SJIS characters.
27207 @item C-EUCJP
27208 Recognize EUCJP characters.
27209 @end table
27211 If @env{LANG} is not defined, or if it has some other value, then the
27212 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27213 recognize and translate multibyte characters.
27214 @end table
27216 @noindent
27217 Some additional environment variables affect the behavior of the
27218 preprocessor.
27220 @include cppenv.texi
27222 @c man end
27224 @node Precompiled Headers
27225 @section Using Precompiled Headers
27226 @cindex precompiled headers
27227 @cindex speed of compilation
27229 Often large projects have many header files that are included in every
27230 source file.  The time the compiler takes to process these header files
27231 over and over again can account for nearly all of the time required to
27232 build the project.  To make builds faster, GCC allows you to
27233 @dfn{precompile} a header file.
27235 To create a precompiled header file, simply compile it as you would any
27236 other file, if necessary using the @option{-x} option to make the driver
27237 treat it as a C or C++ header file.  You may want to use a
27238 tool like @command{make} to keep the precompiled header up-to-date when
27239 the headers it contains change.
27241 A precompiled header file is searched for when @code{#include} is
27242 seen in the compilation.  As it searches for the included file
27243 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27244 compiler looks for a precompiled header in each directory just before it
27245 looks for the include file in that directory.  The name searched for is
27246 the name specified in the @code{#include} with @samp{.gch} appended.  If
27247 the precompiled header file cannot be used, it is ignored.
27249 For instance, if you have @code{#include "all.h"}, and you have
27250 @file{all.h.gch} in the same directory as @file{all.h}, then the
27251 precompiled header file is used if possible, and the original
27252 header is used otherwise.
27254 Alternatively, you might decide to put the precompiled header file in a
27255 directory and use @option{-I} to ensure that directory is searched
27256 before (or instead of) the directory containing the original header.
27257 Then, if you want to check that the precompiled header file is always
27258 used, you can put a file of the same name as the original header in this
27259 directory containing an @code{#error} command.
27261 This also works with @option{-include}.  So yet another way to use
27262 precompiled headers, good for projects not designed with precompiled
27263 header files in mind, is to simply take most of the header files used by
27264 a project, include them from another header file, precompile that header
27265 file, and @option{-include} the precompiled header.  If the header files
27266 have guards against multiple inclusion, they are skipped because
27267 they've already been included (in the precompiled header).
27269 If you need to precompile the same header file for different
27270 languages, targets, or compiler options, you can instead make a
27271 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27272 header in the directory, perhaps using @option{-o}.  It doesn't matter
27273 what you call the files in the directory; every precompiled header in
27274 the directory is considered.  The first precompiled header
27275 encountered in the directory that is valid for this compilation is
27276 used; they're searched in no particular order.
27278 There are many other possibilities, limited only by your imagination,
27279 good sense, and the constraints of your build system.
27281 A precompiled header file can be used only when these conditions apply:
27283 @itemize
27284 @item
27285 Only one precompiled header can be used in a particular compilation.
27287 @item
27288 A precompiled header cannot be used once the first C token is seen.  You
27289 can have preprocessor directives before a precompiled header; you cannot
27290 include a precompiled header from inside another header.
27292 @item
27293 The precompiled header file must be produced for the same language as
27294 the current compilation.  You cannot use a C precompiled header for a C++
27295 compilation.
27297 @item
27298 The precompiled header file must have been produced by the same compiler
27299 binary as the current compilation is using.
27301 @item
27302 Any macros defined before the precompiled header is included must
27303 either be defined in the same way as when the precompiled header was
27304 generated, or must not affect the precompiled header, which usually
27305 means that they don't appear in the precompiled header at all.
27307 The @option{-D} option is one way to define a macro before a
27308 precompiled header is included; using a @code{#define} can also do it.
27309 There are also some options that define macros implicitly, like
27310 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27311 defined this way.
27313 @item If debugging information is output when using the precompiled
27314 header, using @option{-g} or similar, the same kind of debugging information
27315 must have been output when building the precompiled header.  However,
27316 a precompiled header built using @option{-g} can be used in a compilation
27317 when no debugging information is being output.
27319 @item The same @option{-m} options must generally be used when building
27320 and using the precompiled header.  @xref{Submodel Options},
27321 for any cases where this rule is relaxed.
27323 @item Each of the following options must be the same when building and using
27324 the precompiled header:
27326 @gccoptlist{-fexceptions}
27328 @item
27329 Some other command-line options starting with @option{-f},
27330 @option{-p}, or @option{-O} must be defined in the same way as when
27331 the precompiled header was generated.  At present, it's not clear
27332 which options are safe to change and which are not; the safest choice
27333 is to use exactly the same options when generating and using the
27334 precompiled header.  The following are known to be safe:
27336 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27337 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27338 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27339 -pedantic-errors}
27341 @end itemize
27343 For all of these except the last, the compiler automatically
27344 ignores the precompiled header if the conditions aren't met.  If you
27345 find an option combination that doesn't work and doesn't cause the
27346 precompiled header to be ignored, please consider filing a bug report,
27347 see @ref{Bugs}.
27349 If you do use differing options when generating and using the
27350 precompiled header, the actual behavior is a mixture of the
27351 behavior for the options.  For instance, if you use @option{-g} to
27352 generate the precompiled header but not when using it, you may or may
27353 not get debugging information for routines in the precompiled header.