[C++ PATCH] Deprecate -ffriend-injection
[official-gcc.git] / gcc / doc / invoke.texi
blob277c99a0527b302fc8578b9ee9cbbf15f1a54b5b
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -ffile-prefix-map=@var{old}=@var{new}  @gol
176 -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
177 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
179 @item C Language Options
180 @xref{C Dialect Options,,Options Controlling C Dialect}.
181 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
182 -fpermitted-flt-eval-methods=@var{standard} @gol
183 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
184 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
185 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
186 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
187 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
188 -fsigned-bitfields  -fsigned-char @gol
189 -funsigned-bitfields  -funsigned-char}
191 @item C++ Language Options
192 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
193 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
194 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
195 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
196 -ffriend-injection @gol
197 -fno-elide-constructors @gol
198 -fno-enforce-eh-specs @gol
199 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
200 -fno-implicit-templates @gol
201 -fno-implicit-inline-templates @gol
202 -fno-implement-inlines  -fms-extensions @gol
203 -fnew-inheriting-ctors @gol
204 -fnew-ttp-matching @gol
205 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
206 -fno-optional-diags  -fpermissive @gol
207 -fno-pretty-templates @gol
208 -frepo  -fno-rtti  -fsized-deallocation @gol
209 -ftemplate-backtrace-limit=@var{n} @gol
210 -ftemplate-depth=@var{n} @gol
211 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
212 -fno-weak  -nostdinc++ @gol
213 -fvisibility-inlines-hidden @gol
214 -fvisibility-ms-compat @gol
215 -fext-numeric-literals @gol
216 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
217 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
218 -Wnamespaces  -Wnarrowing @gol
219 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
220 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
221 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
222 -Wno-non-template-friend  -Wold-style-cast @gol
223 -Woverloaded-virtual  -Wno-pmf-conversions @gol
224 -Wsign-promo  -Wvirtual-inheritance}
226 @item Objective-C and Objective-C++ Language Options
227 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
228 Objective-C and Objective-C++ Dialects}.
229 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
230 -fgnu-runtime  -fnext-runtime @gol
231 -fno-nil-receivers @gol
232 -fobjc-abi-version=@var{n} @gol
233 -fobjc-call-cxx-cdtors @gol
234 -fobjc-direct-dispatch @gol
235 -fobjc-exceptions @gol
236 -fobjc-gc @gol
237 -fobjc-nilcheck @gol
238 -fobjc-std=objc1 @gol
239 -fno-local-ivars @gol
240 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
241 -freplace-objc-classes @gol
242 -fzero-link @gol
243 -gen-decls @gol
244 -Wassign-intercept @gol
245 -Wno-protocol  -Wselector @gol
246 -Wstrict-selector-match @gol
247 -Wundeclared-selector}
249 @item Diagnostic Message Formatting Options
250 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
251 @gccoptlist{-fmessage-length=@var{n}  @gol
252 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
253 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
254 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
255 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
256 -fdiagnostics-show-template-tree -fno-elide-type @gol
257 -fno-show-column}
259 @item Warning Options
260 @xref{Warning Options,,Options to Request or Suppress Warnings}.
261 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
262 -pedantic-errors @gol
263 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
264 -Walloc-zero  -Walloc-size-larger-than=@var{n}
265 -Walloca  -Walloca-larger-than=@var{n} @gol
266 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
267 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
268 -Wno-builtin-declaration-mismatch @gol
269 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
270 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
271 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
272 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
273 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
274 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
275 -Wdelete-incomplete @gol
276 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
277 -Wdisabled-optimization @gol
278 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
279 -Wno-div-by-zero  -Wdouble-promotion @gol
280 -Wduplicated-branches  -Wduplicated-cond @gol
281 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
282 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
283 -Wfloat-equal  -Wformat  -Wformat=2 @gol
284 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
285 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
286 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
287 -Wformat-y2k  -Wframe-address @gol
288 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
289 -Wif-not-aligned @gol
290 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
291 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
292 -Wimplicit-function-declaration  -Wimplicit-int @gol
293 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
294 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
295 -Winvalid-pch  -Wlarger-than=@var{len} @gol
296 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
297 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
298 -Wmisleading-indentation  -Wmissing-braces @gol
299 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
300 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
301 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
302 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
303 -Woverride-init-side-effects  -Woverlength-strings @gol
304 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
305 -Wparentheses  -Wno-pedantic-ms-format @gol
306 -Wplacement-new  -Wplacement-new=@var{n} @gol
307 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
308 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
309 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
310 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
311 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
312 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
313 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
314 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
315 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
316 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
317 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
318 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
319 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
320 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
321 -Wmissing-format-attribute  -Wsubobject-linkage @gol
322 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
323 -Wswitch-unreachable  -Wsync-nand @gol
324 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
325 -Wtype-limits  -Wundef @gol
326 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
327 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
328 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
329 -Wunused-parameter  -Wno-unused-result @gol
330 -Wunused-value  -Wunused-variable @gol
331 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
332 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
333 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
334 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
335 -Wzero-as-null-pointer-constant  -Whsa}
337 @item C and Objective-C-only Warning Options
338 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
339 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
340 -Wold-style-declaration  -Wold-style-definition @gol
341 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
342 -Wdeclaration-after-statement  -Wpointer-sign}
344 @item Debugging Options
345 @xref{Debugging Options,,Options for Debugging Your Program}.
346 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
347 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
348 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
349 -gas-loc-support  -gno-as-loc-support @gol
350 -gas-locview-support  -gno-as-locview-support @gol
351 -gcolumn-info  -gno-column-info @gol
352 -gstatement-frontiers  -gno-statement-frontiers @gol
353 -gvariable-location-views  -gno-variable-location-views @gol
354 -ginternal-reset-location-views  -gno-internal-reset-location-views @gol
355 -ginline-points  -gno-inline-points @gol
356 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
357 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
358 -fno-eliminate-unused-debug-types @gol
359 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
360 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
361 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
362 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
363 -fvar-tracking  -fvar-tracking-assignments}
365 @item Optimization Options
366 @xref{Optimize Options,,Options that Control Optimization}.
367 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
368 -falign-jumps[=@var{n}] @gol
369 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
370 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
371 -fauto-inc-dec  -fbranch-probabilities @gol
372 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
373 -fbtr-bb-exclusive  -fcaller-saves @gol
374 -fcombine-stack-adjustments  -fconserve-stack @gol
375 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
376 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
377 -fcx-limited-range @gol
378 -fdata-sections  -fdce  -fdelayed-branch @gol
379 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
380 -fdevirtualize-at-ltrans  -fdse @gol
381 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
382 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
383 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
384 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
385 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
386 -fif-conversion2  -findirect-inlining @gol
387 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
388 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
389 -fipa-bit-cp -fipa-vrp @gol
390 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
391 -fira-algorithm=@var{algorithm} @gol
392 -fira-region=@var{region}  -fira-hoist-pressure @gol
393 -fira-loop-pressure  -fno-ira-share-save-slots @gol
394 -fno-ira-share-spill-slots @gol
395 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
396 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
397 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
398 -floop-block  -floop-interchange  -floop-strip-mine @gol
399 -floop-unroll-and-jam  -floop-nest-optimize @gol
400 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
401 -flto-partition=@var{alg}  -fmerge-all-constants @gol
402 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
403 -fmove-loop-invariants  -fno-branch-count-reg @gol
404 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
405 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
406 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
407 -fno-sched-spec  -fno-signed-zeros @gol
408 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
409 -fomit-frame-pointer  -foptimize-sibling-calls @gol
410 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
411 -fprefetch-loop-arrays @gol
412 -fprofile-correction @gol
413 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
414 -fprofile-reorder-functions @gol
415 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
416 -freorder-blocks-algorithm=@var{algorithm} @gol
417 -freorder-blocks-and-partition  -freorder-functions @gol
418 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
419 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
420 -fsched-spec-load  -fsched-spec-load-dangerous @gol
421 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
422 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
423 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
424 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
425 -fschedule-fusion @gol
426 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
427 -fselective-scheduling  -fselective-scheduling2 @gol
428 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
429 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
430 -fsignaling-nans @gol
431 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
432 -fsplit-paths @gol
433 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
434 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
435 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
436 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
437 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
438 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
439 -ftree-loop-if-convert  -ftree-loop-im @gol
440 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
441 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
442 -ftree-loop-vectorize @gol
443 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
444 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
445 -ftree-switch-conversion  -ftree-tail-merge @gol
446 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
447 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
448 -funsafe-math-optimizations  -funswitch-loops @gol
449 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
450 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
451 --param @var{name}=@var{value}
452 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
454 @item Program Instrumentation Options
455 @xref{Instrumentation Options,,Program Instrumentation Options}.
456 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
457 -fprofile-abs-path @gol
458 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
459 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
460 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
461 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
462 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
463 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
464 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
465 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
466 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
467 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
468 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
469 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
470 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
471 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
472 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
473 -fstack-protector-explicit  -fstack-check @gol
474 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
475 -fno-stack-limit  -fsplit-stack @gol
476 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
477 -fvtv-counts  -fvtv-debug @gol
478 -finstrument-functions @gol
479 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
480 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
482 @item Preprocessor Options
483 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
484 @gccoptlist{-A@var{question}=@var{answer} @gol
485 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
486 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
487 -dD  -dI  -dM  -dN  -dU @gol
488 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
489 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
490 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
491 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
492 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
493 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
494 -H  -imacros @var{file}  -include @var{file} @gol
495 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
496 -no-integrated-cpp  -P  -pthread  -remap @gol
497 -traditional  -traditional-cpp  -trigraphs @gol
498 -U@var{macro}  -undef  @gol
499 -Wp,@var{option}  -Xpreprocessor @var{option}}
501 @item Assembler Options
502 @xref{Assembler Options,,Passing Options to the Assembler}.
503 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
505 @item Linker Options
506 @xref{Link Options,,Options for Linking}.
507 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
508 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
509 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
510 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
511 -static-libmpx  -static-libmpxwrappers @gol
512 -shared  -shared-libgcc  -symbolic @gol
513 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
514 -u @var{symbol}  -z @var{keyword}}
516 @item Directory Options
517 @xref{Directory Options,,Options for Directory Search}.
518 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
519 -idirafter @var{dir} @gol
520 -imacros @var{file}  -imultilib @var{dir} @gol
521 -iplugindir=@var{dir}  -iprefix @var{file} @gol
522 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
523 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
524 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
525 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
527 @item Code Generation Options
528 @xref{Code Gen Options,,Options for Code Generation Conventions}.
529 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
530 -ffixed-@var{reg}  -fexceptions @gol
531 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
532 -fasynchronous-unwind-tables @gol
533 -fno-gnu-unique @gol
534 -finhibit-size-directive  -fno-common  -fno-ident @gol
535 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
536 -fno-jump-tables @gol
537 -frecord-gcc-switches @gol
538 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
539 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
540 -fleading-underscore  -ftls-model=@var{model} @gol
541 -fstack-reuse=@var{reuse_level} @gol
542 -ftrampolines  -ftrapv  -fwrapv @gol
543 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
544 -fstrict-volatile-bitfields  -fsync-libcalls}
546 @item Developer Options
547 @xref{Developer Options,,GCC Developer Options}.
548 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
549 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
550 -fdbg-cnt=@var{counter-value-list} @gol
551 -fdisable-ipa-@var{pass_name} @gol
552 -fdisable-rtl-@var{pass_name} @gol
553 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
554 -fdisable-tree-@var{pass_name} @gol
555 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
556 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
557 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
558 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
559 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
560 -fdump-lang-all @gol
561 -fdump-lang-@var{switch} @gol
562 -fdump-lang-@var{switch}-@var{options} @gol
563 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
564 -fdump-passes @gol
565 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
566 -fdump-statistics @gol
567 -fdump-tree-all @gol
568 -fdump-tree-@var{switch} @gol
569 -fdump-tree-@var{switch}-@var{options} @gol
570 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
571 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
572 -fenable-@var{kind}-@var{pass} @gol
573 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
574 -fira-verbose=@var{n} @gol
575 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
576 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
577 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
578 -fprofile-report @gol
579 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
580 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
581 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
582 -fvar-tracking-assignments-toggle  -gtoggle @gol
583 -print-file-name=@var{library}  -print-libgcc-file-name @gol
584 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
585 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
586 -print-sysroot  -print-sysroot-headers-suffix @gol
587 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
589 @item Machine-Dependent Options
590 @xref{Submodel Options,,Machine-Dependent Options}.
591 @c This list is ordered alphanumerically by subsection name.
592 @c Try and put the significant identifier (CPU or system) first,
593 @c so users have a clue at guessing where the ones they want will be.
595 @emph{AArch64 Options}
596 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
597 -mgeneral-regs-only @gol
598 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
599 -mstrict-align @gol
600 -momit-leaf-frame-pointer @gol
601 -mtls-dialect=desc  -mtls-dialect=traditional @gol
602 -mtls-size=@var{size} @gol
603 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
604 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
605 -mpc-relative-literal-loads @gol
606 -msign-return-address=@var{scope} @gol
607 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
608 -moverride=@var{string}  -mverbose-cost-dump}
610 @emph{Adapteva Epiphany Options}
611 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
612 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
613 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
614 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
615 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
616 -msplit-vecmove-early  -m1reg-@var{reg}}
618 @emph{ARC Options}
619 @gccoptlist{-mbarrel-shifter -mjli-always @gol
620 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
621 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
622 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
623 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
624 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
625 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
626 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
627 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
628 -mvolatile-cache  -mtp-regno=@var{regno} @gol
629 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
630 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
631 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
632 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
633 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
634 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
635 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
636 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16}
638 @emph{ARM Options}
639 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
640 -mabi=@var{name} @gol
641 -mapcs-stack-check  -mno-apcs-stack-check @gol
642 -mapcs-reentrant  -mno-apcs-reentrant @gol
643 -msched-prolog  -mno-sched-prolog @gol
644 -mlittle-endian  -mbig-endian @gol
645 -mbe8 -mbe32 @gol
646 -mfloat-abi=@var{name} @gol
647 -mfp16-format=@var{name}
648 -mthumb-interwork  -mno-thumb-interwork @gol
649 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
650 -mtune=@var{name}  -mprint-tune-info @gol
651 -mstructure-size-boundary=@var{n} @gol
652 -mabort-on-noreturn @gol
653 -mlong-calls  -mno-long-calls @gol
654 -msingle-pic-base  -mno-single-pic-base @gol
655 -mpic-register=@var{reg} @gol
656 -mnop-fun-dllimport @gol
657 -mpoke-function-name @gol
658 -mthumb  -marm  -mflip-thumb @gol
659 -mtpcs-frame  -mtpcs-leaf-frame @gol
660 -mcaller-super-interworking  -mcallee-super-interworking @gol
661 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
662 -mword-relocations @gol
663 -mfix-cortex-m3-ldrd @gol
664 -munaligned-access @gol
665 -mneon-for-64bits @gol
666 -mslow-flash-data @gol
667 -masm-syntax-unified @gol
668 -mrestrict-it @gol
669 -mverbose-cost-dump @gol
670 -mpure-code @gol
671 -mcmse}
673 @emph{AVR Options}
674 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
675 -mbranch-cost=@var{cost} @gol
676 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
677 -mn_flash=@var{size}  -mno-interrupts @gol
678 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
679 -mfract-convert-truncate @gol
680 -mshort-calls  -nodevicelib @gol
681 -Waddr-space-convert  -Wmisspelled-isr}
683 @emph{Blackfin Options}
684 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
685 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
686 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
687 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
688 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
689 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
690 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
691 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
692 -micplb}
694 @emph{C6X Options}
695 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
696 -msim  -msdata=@var{sdata-type}}
698 @emph{CRIS Options}
699 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
700 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
701 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
702 -mstack-align  -mdata-align  -mconst-align @gol
703 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
704 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
705 -mmul-bug-workaround  -mno-mul-bug-workaround}
707 @emph{CR16 Options}
708 @gccoptlist{-mmac @gol
709 -mcr16cplus  -mcr16c @gol
710 -msim  -mint32  -mbit-ops
711 -mdata-model=@var{model}}
713 @emph{Darwin Options}
714 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
715 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
716 -client_name  -compatibility_version  -current_version @gol
717 -dead_strip @gol
718 -dependency-file  -dylib_file  -dylinker_install_name @gol
719 -dynamic  -dynamiclib  -exported_symbols_list @gol
720 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
721 -force_flat_namespace  -headerpad_max_install_names @gol
722 -iframework @gol
723 -image_base  -init  -install_name  -keep_private_externs @gol
724 -multi_module  -multiply_defined  -multiply_defined_unused @gol
725 -noall_load   -no_dead_strip_inits_and_terms @gol
726 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
727 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
728 -private_bundle  -read_only_relocs  -sectalign @gol
729 -sectobjectsymbols  -whyload  -seg1addr @gol
730 -sectcreate  -sectobjectsymbols  -sectorder @gol
731 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
732 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
733 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
734 -single_module  -static  -sub_library  -sub_umbrella @gol
735 -twolevel_namespace  -umbrella  -undefined @gol
736 -unexported_symbols_list  -weak_reference_mismatches @gol
737 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
738 -mkernel  -mone-byte-bool}
740 @emph{DEC Alpha Options}
741 @gccoptlist{-mno-fp-regs  -msoft-float @gol
742 -mieee  -mieee-with-inexact  -mieee-conformant @gol
743 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
744 -mtrap-precision=@var{mode}  -mbuild-constants @gol
745 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
746 -mbwx  -mmax  -mfix  -mcix @gol
747 -mfloat-vax  -mfloat-ieee @gol
748 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
749 -msmall-text  -mlarge-text @gol
750 -mmemory-latency=@var{time}}
752 @emph{FR30 Options}
753 @gccoptlist{-msmall-model  -mno-lsim}
755 @emph{FT32 Options}
756 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
758 @emph{FRV Options}
759 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
760 -mhard-float  -msoft-float @gol
761 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
762 -mdouble  -mno-double @gol
763 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
764 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
765 -mlinked-fp  -mlong-calls  -malign-labels @gol
766 -mlibrary-pic  -macc-4  -macc-8 @gol
767 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
768 -moptimize-membar  -mno-optimize-membar @gol
769 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
770 -mvliw-branch  -mno-vliw-branch @gol
771 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
772 -mno-nested-cond-exec  -mtomcat-stats @gol
773 -mTLS  -mtls @gol
774 -mcpu=@var{cpu}}
776 @emph{GNU/Linux Options}
777 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
778 -tno-android-cc  -tno-android-ld}
780 @emph{H8/300 Options}
781 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
783 @emph{HPPA Options}
784 @gccoptlist{-march=@var{architecture-type} @gol
785 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
786 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
787 -mfixed-range=@var{register-range} @gol
788 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
789 -mlong-load-store  -mno-disable-fpregs @gol
790 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
791 -mno-jump-in-delay  -mno-long-load-store @gol
792 -mno-portable-runtime  -mno-soft-float @gol
793 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
794 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
795 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
796 -munix=@var{unix-std}  -nolibdld  -static  -threads}
798 @emph{IA-64 Options}
799 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
800 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
801 -mconstant-gp  -mauto-pic  -mfused-madd @gol
802 -minline-float-divide-min-latency @gol
803 -minline-float-divide-max-throughput @gol
804 -mno-inline-float-divide @gol
805 -minline-int-divide-min-latency @gol
806 -minline-int-divide-max-throughput  @gol
807 -mno-inline-int-divide @gol
808 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
809 -mno-inline-sqrt @gol
810 -mdwarf2-asm  -mearly-stop-bits @gol
811 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
812 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
813 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
814 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
815 -msched-spec-ldc  -msched-spec-control-ldc @gol
816 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
817 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
818 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
819 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
821 @emph{LM32 Options}
822 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
823 -msign-extend-enabled  -muser-enabled}
825 @emph{M32R/D Options}
826 @gccoptlist{-m32r2  -m32rx  -m32r @gol
827 -mdebug @gol
828 -malign-loops  -mno-align-loops @gol
829 -missue-rate=@var{number} @gol
830 -mbranch-cost=@var{number} @gol
831 -mmodel=@var{code-size-model-type} @gol
832 -msdata=@var{sdata-type} @gol
833 -mno-flush-func  -mflush-func=@var{name} @gol
834 -mno-flush-trap  -mflush-trap=@var{number} @gol
835 -G @var{num}}
837 @emph{M32C Options}
838 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
840 @emph{M680x0 Options}
841 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
842 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
843 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
844 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
845 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
846 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
847 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
848 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
849 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
851 @emph{MCore Options}
852 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
853 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
854 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
855 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
856 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
858 @emph{MeP Options}
859 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
860 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
861 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
862 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
863 -mtiny=@var{n}}
865 @emph{MicroBlaze Options}
866 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
867 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
868 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
869 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
870 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
872 @emph{MIPS Options}
873 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
874 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
875 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
876 -mips16  -mno-mips16  -mflip-mips16 @gol
877 -minterlink-compressed  -mno-interlink-compressed @gol
878 -minterlink-mips16  -mno-interlink-mips16 @gol
879 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
880 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
881 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
882 -mno-float  -msingle-float  -mdouble-float @gol
883 -modd-spreg  -mno-odd-spreg @gol
884 -mabs=@var{mode}  -mnan=@var{encoding} @gol
885 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
886 -mmcu  -mmno-mcu @gol
887 -meva  -mno-eva @gol
888 -mvirt  -mno-virt @gol
889 -mxpa  -mno-xpa @gol
890 -mmicromips  -mno-micromips @gol
891 -mmsa  -mno-msa @gol
892 -mfpu=@var{fpu-type} @gol
893 -msmartmips  -mno-smartmips @gol
894 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
895 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
896 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
897 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
898 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
899 -membedded-data  -mno-embedded-data @gol
900 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
901 -mcode-readable=@var{setting} @gol
902 -msplit-addresses  -mno-split-addresses @gol
903 -mexplicit-relocs  -mno-explicit-relocs @gol
904 -mcheck-zero-division  -mno-check-zero-division @gol
905 -mdivide-traps  -mdivide-breaks @gol
906 -mload-store-pairs  -mno-load-store-pairs @gol
907 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
908 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
909 -mfix-24k  -mno-fix-24k @gol
910 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
911 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
912 -mfix-vr4120  -mno-fix-vr4120 @gol
913 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
914 -mflush-func=@var{func}  -mno-flush-func @gol
915 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
916 -mcompact-branches=@var{policy} @gol
917 -mfp-exceptions  -mno-fp-exceptions @gol
918 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
919 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
920 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
921 -mframe-header-opt  -mno-frame-header-opt}
923 @emph{MMIX Options}
924 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
925 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
926 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
927 -mno-base-addresses  -msingle-exit  -mno-single-exit}
929 @emph{MN10300 Options}
930 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
931 -mno-am33  -mam33  -mam33-2  -mam34 @gol
932 -mtune=@var{cpu-type} @gol
933 -mreturn-pointer-on-d0 @gol
934 -mno-crt0  -mrelax  -mliw  -msetlb}
936 @emph{Moxie Options}
937 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
939 @emph{MSP430 Options}
940 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
941 -mwarn-mcu @gol
942 -mcode-region=  -mdata-region= @gol
943 -msilicon-errata=  -msilicon-errata-warn= @gol
944 -mhwmult=  -minrt}
946 @emph{NDS32 Options}
947 @gccoptlist{-mbig-endian  -mlittle-endian @gol
948 -mreduced-regs  -mfull-regs @gol
949 -mcmov  -mno-cmov @gol
950 -mext-perf  -mno-ext-perf @gol
951 -mext-perf2  -mno-ext-perf2 @gol
952 -mext-string  -mno-ext-string @gol
953 -mv3push  -mno-v3push @gol
954 -m16bit  -mno-16bit @gol
955 -misr-vector-size=@var{num} @gol
956 -mcache-block-size=@var{num} @gol
957 -march=@var{arch} @gol
958 -mcmodel=@var{code-model} @gol
959 -mctor-dtor  -mrelax}
961 @emph{Nios II Options}
962 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
963 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
964 -mel  -meb @gol
965 -mno-bypass-cache  -mbypass-cache @gol
966 -mno-cache-volatile  -mcache-volatile @gol
967 -mno-fast-sw-div  -mfast-sw-div @gol
968 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
969 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
970 -mcustom-fpu-cfg=@var{name} @gol
971 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
972 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
974 @emph{Nvidia PTX Options}
975 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
977 @emph{PDP-11 Options}
978 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
979 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
980 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
981 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
982 -mbranch-expensive  -mbranch-cheap @gol
983 -munix-asm  -mdec-asm}
985 @emph{picoChip Options}
986 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
987 -msymbol-as-address  -mno-inefficient-warnings}
989 @emph{PowerPC Options}
990 See RS/6000 and PowerPC Options.
992 @emph{PowerPC SPE Options}
993 @gccoptlist{-mcpu=@var{cpu-type} @gol
994 -mtune=@var{cpu-type} @gol
995 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
996 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
997 -m32  -mxl-compat  -mno-xl-compat @gol
998 -malign-power  -malign-natural @gol
999 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1000 -msingle-float  -mdouble-float @gol
1001 -mupdate  -mno-update @gol
1002 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1003 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1004 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1005 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1006 -msingle-pic-base @gol
1007 -mprioritize-restricted-insns=@var{priority} @gol
1008 -msched-costly-dep=@var{dependence_type} @gol
1009 -minsert-sched-nops=@var{scheme} @gol
1010 -mcall-sysv  -mcall-netbsd @gol
1011 -maix-struct-return  -msvr4-struct-return @gol
1012 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1013 -mblock-move-inline-limit=@var{num} @gol
1014 -misel  -mno-isel @gol
1015 -misel=yes  -misel=no @gol
1016 -mspe  -mno-spe @gol
1017 -mspe=yes  -mspe=no @gol
1018 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1019 -mprototype  -mno-prototype @gol
1020 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1021 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1022 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1023 -mno-recip-precision @gol
1024 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1025 -msave-toc-indirect  -mno-save-toc-indirect @gol
1026 -mcompat-align-parm  -mno-compat-align-parm @gol
1027 -mfloat128  -mno-float128 @gol
1028 -mgnu-attribute  -mno-gnu-attribute @gol
1029 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1030 -mstack-protector-guard-offset=@var{offset}}
1032 @emph{RISC-V Options}
1033 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1034 -mplt  -mno-plt @gol
1035 -mabi=@var{ABI-string} @gol
1036 -mfdiv  -mno-fdiv @gol
1037 -mdiv  -mno-div @gol
1038 -march=@var{ISA-string} @gol
1039 -mtune=@var{processor-string} @gol
1040 -mpreferred-stack-boundary=@var{num} @gol
1041 -msmall-data-limit=@var{N-bytes} @gol
1042 -msave-restore  -mno-save-restore @gol
1043 -mstrict-align -mno-strict-align @gol
1044 -mcmodel=medlow -mcmodel=medany @gol
1045 -mexplicit-relocs  -mno-explicit-relocs @gol}
1047 @emph{RL78 Options}
1048 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1049 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1050 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1052 @emph{RS/6000 and PowerPC Options}
1053 @gccoptlist{-mcpu=@var{cpu-type} @gol
1054 -mtune=@var{cpu-type} @gol
1055 -mcmodel=@var{code-model} @gol
1056 -mpowerpc64 @gol
1057 -maltivec  -mno-altivec @gol
1058 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1059 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1060 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1061 -mfprnd  -mno-fprnd @gol
1062 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1063 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1064 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1065 -malign-power  -malign-natural @gol
1066 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1067 -msingle-float  -mdouble-float  -msimple-fpu @gol
1068 -mupdate  -mno-update @gol
1069 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1070 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1071 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1072 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1073 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1074 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1075 -mprioritize-restricted-insns=@var{priority} @gol
1076 -msched-costly-dep=@var{dependence_type} @gol
1077 -minsert-sched-nops=@var{scheme} @gol
1078 -mcall-sysv  -mcall-netbsd @gol
1079 -maix-struct-return  -msvr4-struct-return @gol
1080 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1081 -mblock-move-inline-limit=@var{num} @gol
1082 -misel  -mno-isel @gol
1083 -misel=yes  -misel=no @gol
1084 -mpaired @gol
1085 -mvrsave  -mno-vrsave @gol
1086 -mmulhw  -mno-mulhw @gol
1087 -mdlmzb  -mno-dlmzb @gol
1088 -mprototype  -mno-prototype @gol
1089 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1090 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1091 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1092 -mno-recip-precision @gol
1093 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1094 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1095 -msave-toc-indirect  -mno-save-toc-indirect @gol
1096 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1097 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1098 -mquad-memory  -mno-quad-memory @gol
1099 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1100 -mcompat-align-parm  -mno-compat-align-parm @gol
1101 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1102 -mgnu-attribute  -mno-gnu-attribute @gol
1103 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1104 -mstack-protector-guard-offset=@var{offset}}
1106 @emph{RX Options}
1107 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1108 -mcpu=@gol
1109 -mbig-endian-data  -mlittle-endian-data @gol
1110 -msmall-data @gol
1111 -msim  -mno-sim@gol
1112 -mas100-syntax  -mno-as100-syntax@gol
1113 -mrelax@gol
1114 -mmax-constant-size=@gol
1115 -mint-register=@gol
1116 -mpid@gol
1117 -mallow-string-insns  -mno-allow-string-insns@gol
1118 -mjsr@gol
1119 -mno-warn-multiple-fast-interrupts@gol
1120 -msave-acc-in-interrupts}
1122 @emph{S/390 and zSeries Options}
1123 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1124 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1125 -mlong-double-64  -mlong-double-128 @gol
1126 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1127 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1128 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1129 -mhtm  -mvx  -mzvector @gol
1130 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1131 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1132 -mhotpatch=@var{halfwords},@var{halfwords}}
1134 @emph{Score Options}
1135 @gccoptlist{-meb  -mel @gol
1136 -mnhwloop @gol
1137 -muls @gol
1138 -mmac @gol
1139 -mscore5  -mscore5u  -mscore7  -mscore7d}
1141 @emph{SH Options}
1142 @gccoptlist{-m1  -m2  -m2e @gol
1143 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1144 -m3  -m3e @gol
1145 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1146 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1147 -mb  -ml  -mdalign  -mrelax @gol
1148 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1149 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1150 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1151 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1152 -maccumulate-outgoing-args @gol
1153 -matomic-model=@var{atomic-model} @gol
1154 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1155 -mcbranch-force-delay-slot @gol
1156 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1157 -mpretend-cmove  -mtas}
1159 @emph{Solaris 2 Options}
1160 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1161 -pthreads}
1163 @emph{SPARC Options}
1164 @gccoptlist{-mcpu=@var{cpu-type} @gol
1165 -mtune=@var{cpu-type} @gol
1166 -mcmodel=@var{code-model} @gol
1167 -mmemory-model=@var{mem-model} @gol
1168 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1169 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1170 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1171 -mhard-quad-float  -msoft-quad-float @gol
1172 -mstack-bias  -mno-stack-bias @gol
1173 -mstd-struct-return  -mno-std-struct-return @gol
1174 -munaligned-doubles  -mno-unaligned-doubles @gol
1175 -muser-mode  -mno-user-mode @gol
1176 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1177 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1178 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1179 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1180 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1181 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1182 -mlra  -mno-lra}
1184 @emph{SPU Options}
1185 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1186 -msafe-dma  -munsafe-dma @gol
1187 -mbranch-hints @gol
1188 -msmall-mem  -mlarge-mem  -mstdmain @gol
1189 -mfixed-range=@var{register-range} @gol
1190 -mea32  -mea64 @gol
1191 -maddress-space-conversion  -mno-address-space-conversion @gol
1192 -mcache-size=@var{cache-size} @gol
1193 -matomic-updates  -mno-atomic-updates}
1195 @emph{System V Options}
1196 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1198 @emph{TILE-Gx Options}
1199 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1200 -mcmodel=@var{code-model}}
1202 @emph{TILEPro Options}
1203 @gccoptlist{-mcpu=@var{cpu}  -m32}
1205 @emph{V850 Options}
1206 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1207 -mprolog-function  -mno-prolog-function  -mspace @gol
1208 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1209 -mapp-regs  -mno-app-regs @gol
1210 -mdisable-callt  -mno-disable-callt @gol
1211 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1212 -mv850e  -mv850  -mv850e3v5 @gol
1213 -mloop @gol
1214 -mrelax @gol
1215 -mlong-jumps @gol
1216 -msoft-float @gol
1217 -mhard-float @gol
1218 -mgcc-abi @gol
1219 -mrh850-abi @gol
1220 -mbig-switch}
1222 @emph{VAX Options}
1223 @gccoptlist{-mg  -mgnu  -munix}
1225 @emph{Visium Options}
1226 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1227 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1229 @emph{VMS Options}
1230 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1231 -mpointer-size=@var{size}}
1233 @emph{VxWorks Options}
1234 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1235 -Xbind-lazy  -Xbind-now}
1237 @emph{x86 Options}
1238 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1239 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1240 -mfpmath=@var{unit} @gol
1241 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1242 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1243 -mno-wide-multiply  -mrtd  -malign-double @gol
1244 -mpreferred-stack-boundary=@var{num} @gol
1245 -mincoming-stack-boundary=@var{num} @gol
1246 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1247 -mrecip  -mrecip=@var{opt} @gol
1248 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1249 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1250 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1251 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1252 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1253 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1254 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1255 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1256 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1257 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1258 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1259 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1260 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1261 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1262 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1263 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1264 -mregparm=@var{num}  -msseregparm @gol
1265 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1266 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1267 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1268 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1269 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1270 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1271 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1272 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1273 -mstack-protector-guard-reg=@var{reg} @gol
1274 -mstack-protector-guard-offset=@var{offset} @gol
1275 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1276 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1277 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1278 -mindirect-branch-register}
1280 @emph{x86 Windows Options}
1281 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1282 -mnop-fun-dllimport  -mthread @gol
1283 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1285 @emph{Xstormy16 Options}
1286 @gccoptlist{-msim}
1288 @emph{Xtensa Options}
1289 @gccoptlist{-mconst16  -mno-const16 @gol
1290 -mfused-madd  -mno-fused-madd @gol
1291 -mforce-no-pic @gol
1292 -mserialize-volatile  -mno-serialize-volatile @gol
1293 -mtext-section-literals  -mno-text-section-literals @gol
1294 -mauto-litpools  -mno-auto-litpools @gol
1295 -mtarget-align  -mno-target-align @gol
1296 -mlongcalls  -mno-longcalls}
1298 @emph{zSeries Options}
1299 See S/390 and zSeries Options.
1300 @end table
1303 @node Overall Options
1304 @section Options Controlling the Kind of Output
1306 Compilation can involve up to four stages: preprocessing, compilation
1307 proper, assembly and linking, always in that order.  GCC is capable of
1308 preprocessing and compiling several files either into several
1309 assembler input files, or into one assembler input file; then each
1310 assembler input file produces an object file, and linking combines all
1311 the object files (those newly compiled, and those specified as input)
1312 into an executable file.
1314 @cindex file name suffix
1315 For any given input file, the file name suffix determines what kind of
1316 compilation is done:
1318 @table @gcctabopt
1319 @item @var{file}.c
1320 C source code that must be preprocessed.
1322 @item @var{file}.i
1323 C source code that should not be preprocessed.
1325 @item @var{file}.ii
1326 C++ source code that should not be preprocessed.
1328 @item @var{file}.m
1329 Objective-C source code.  Note that you must link with the @file{libobjc}
1330 library to make an Objective-C program work.
1332 @item @var{file}.mi
1333 Objective-C source code that should not be preprocessed.
1335 @item @var{file}.mm
1336 @itemx @var{file}.M
1337 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1338 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1339 to a literal capital M@.
1341 @item @var{file}.mii
1342 Objective-C++ source code that should not be preprocessed.
1344 @item @var{file}.h
1345 C, C++, Objective-C or Objective-C++ header file to be turned into a
1346 precompiled header (default), or C, C++ header file to be turned into an
1347 Ada spec (via the @option{-fdump-ada-spec} switch).
1349 @item @var{file}.cc
1350 @itemx @var{file}.cp
1351 @itemx @var{file}.cxx
1352 @itemx @var{file}.cpp
1353 @itemx @var{file}.CPP
1354 @itemx @var{file}.c++
1355 @itemx @var{file}.C
1356 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1357 the last two letters must both be literally @samp{x}.  Likewise,
1358 @samp{.C} refers to a literal capital C@.
1360 @item @var{file}.mm
1361 @itemx @var{file}.M
1362 Objective-C++ source code that must be preprocessed.
1364 @item @var{file}.mii
1365 Objective-C++ source code that should not be preprocessed.
1367 @item @var{file}.hh
1368 @itemx @var{file}.H
1369 @itemx @var{file}.hp
1370 @itemx @var{file}.hxx
1371 @itemx @var{file}.hpp
1372 @itemx @var{file}.HPP
1373 @itemx @var{file}.h++
1374 @itemx @var{file}.tcc
1375 C++ header file to be turned into a precompiled header or Ada spec.
1377 @item @var{file}.f
1378 @itemx @var{file}.for
1379 @itemx @var{file}.ftn
1380 Fixed form Fortran source code that should not be preprocessed.
1382 @item @var{file}.F
1383 @itemx @var{file}.FOR
1384 @itemx @var{file}.fpp
1385 @itemx @var{file}.FPP
1386 @itemx @var{file}.FTN
1387 Fixed form Fortran source code that must be preprocessed (with the traditional
1388 preprocessor).
1390 @item @var{file}.f90
1391 @itemx @var{file}.f95
1392 @itemx @var{file}.f03
1393 @itemx @var{file}.f08
1394 Free form Fortran source code that should not be preprocessed.
1396 @item @var{file}.F90
1397 @itemx @var{file}.F95
1398 @itemx @var{file}.F03
1399 @itemx @var{file}.F08
1400 Free form Fortran source code that must be preprocessed (with the
1401 traditional preprocessor).
1403 @item @var{file}.go
1404 Go source code.
1406 @item @var{file}.brig
1407 BRIG files (binary representation of HSAIL).
1409 @item @var{file}.ads
1410 Ada source code file that contains a library unit declaration (a
1411 declaration of a package, subprogram, or generic, or a generic
1412 instantiation), or a library unit renaming declaration (a package,
1413 generic, or subprogram renaming declaration).  Such files are also
1414 called @dfn{specs}.
1416 @item @var{file}.adb
1417 Ada source code file containing a library unit body (a subprogram or
1418 package body).  Such files are also called @dfn{bodies}.
1420 @c GCC also knows about some suffixes for languages not yet included:
1421 @c Pascal:
1422 @c @var{file}.p
1423 @c @var{file}.pas
1424 @c Ratfor:
1425 @c @var{file}.r
1427 @item @var{file}.s
1428 Assembler code.
1430 @item @var{file}.S
1431 @itemx @var{file}.sx
1432 Assembler code that must be preprocessed.
1434 @item @var{other}
1435 An object file to be fed straight into linking.
1436 Any file name with no recognized suffix is treated this way.
1437 @end table
1439 @opindex x
1440 You can specify the input language explicitly with the @option{-x} option:
1442 @table @gcctabopt
1443 @item -x @var{language}
1444 Specify explicitly the @var{language} for the following input files
1445 (rather than letting the compiler choose a default based on the file
1446 name suffix).  This option applies to all following input files until
1447 the next @option{-x} option.  Possible values for @var{language} are:
1448 @smallexample
1449 c  c-header  cpp-output
1450 c++  c++-header  c++-cpp-output
1451 objective-c  objective-c-header  objective-c-cpp-output
1452 objective-c++ objective-c++-header objective-c++-cpp-output
1453 assembler  assembler-with-cpp
1455 f77  f77-cpp-input f95  f95-cpp-input
1457 brig
1458 @end smallexample
1460 @item -x none
1461 Turn off any specification of a language, so that subsequent files are
1462 handled according to their file name suffixes (as they are if @option{-x}
1463 has not been used at all).
1464 @end table
1466 If you only want some of the stages of compilation, you can use
1467 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1468 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1469 @command{gcc} is to stop.  Note that some combinations (for example,
1470 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1472 @table @gcctabopt
1473 @item -c
1474 @opindex c
1475 Compile or assemble the source files, but do not link.  The linking
1476 stage simply is not done.  The ultimate output is in the form of an
1477 object file for each source file.
1479 By default, the object file name for a source file is made by replacing
1480 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1482 Unrecognized input files, not requiring compilation or assembly, are
1483 ignored.
1485 @item -S
1486 @opindex S
1487 Stop after the stage of compilation proper; do not assemble.  The output
1488 is in the form of an assembler code file for each non-assembler input
1489 file specified.
1491 By default, the assembler file name for a source file is made by
1492 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1494 Input files that don't require compilation are ignored.
1496 @item -E
1497 @opindex E
1498 Stop after the preprocessing stage; do not run the compiler proper.  The
1499 output is in the form of preprocessed source code, which is sent to the
1500 standard output.
1502 Input files that don't require preprocessing are ignored.
1504 @cindex output file option
1505 @item -o @var{file}
1506 @opindex o
1507 Place output in file @var{file}.  This applies to whatever
1508 sort of output is being produced, whether it be an executable file,
1509 an object file, an assembler file or preprocessed C code.
1511 If @option{-o} is not specified, the default is to put an executable
1512 file in @file{a.out}, the object file for
1513 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1514 assembler file in @file{@var{source}.s}, a precompiled header file in
1515 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1516 standard output.
1518 @item -v
1519 @opindex v
1520 Print (on standard error output) the commands executed to run the stages
1521 of compilation.  Also print the version number of the compiler driver
1522 program and of the preprocessor and the compiler proper.
1524 @item -###
1525 @opindex ###
1526 Like @option{-v} except the commands are not executed and arguments
1527 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1528 This is useful for shell scripts to capture the driver-generated command lines.
1530 @item --help
1531 @opindex help
1532 Print (on the standard output) a description of the command-line options
1533 understood by @command{gcc}.  If the @option{-v} option is also specified
1534 then @option{--help} is also passed on to the various processes
1535 invoked by @command{gcc}, so that they can display the command-line options
1536 they accept.  If the @option{-Wextra} option has also been specified
1537 (prior to the @option{--help} option), then command-line options that
1538 have no documentation associated with them are also displayed.
1540 @item --target-help
1541 @opindex target-help
1542 Print (on the standard output) a description of target-specific command-line
1543 options for each tool.  For some targets extra target-specific
1544 information may also be printed.
1546 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1547 Print (on the standard output) a description of the command-line
1548 options understood by the compiler that fit into all specified classes
1549 and qualifiers.  These are the supported classes:
1551 @table @asis
1552 @item @samp{optimizers}
1553 Display all of the optimization options supported by the
1554 compiler.
1556 @item @samp{warnings}
1557 Display all of the options controlling warning messages
1558 produced by the compiler.
1560 @item @samp{target}
1561 Display target-specific options.  Unlike the
1562 @option{--target-help} option however, target-specific options of the
1563 linker and assembler are not displayed.  This is because those
1564 tools do not currently support the extended @option{--help=} syntax.
1566 @item @samp{params}
1567 Display the values recognized by the @option{--param}
1568 option.
1570 @item @var{language}
1571 Display the options supported for @var{language}, where
1572 @var{language} is the name of one of the languages supported in this
1573 version of GCC@.
1575 @item @samp{common}
1576 Display the options that are common to all languages.
1577 @end table
1579 These are the supported qualifiers:
1581 @table @asis
1582 @item @samp{undocumented}
1583 Display only those options that are undocumented.
1585 @item @samp{joined}
1586 Display options taking an argument that appears after an equal
1587 sign in the same continuous piece of text, such as:
1588 @samp{--help=target}.
1590 @item @samp{separate}
1591 Display options taking an argument that appears as a separate word
1592 following the original option, such as: @samp{-o output-file}.
1593 @end table
1595 Thus for example to display all the undocumented target-specific
1596 switches supported by the compiler, use:
1598 @smallexample
1599 --help=target,undocumented
1600 @end smallexample
1602 The sense of a qualifier can be inverted by prefixing it with the
1603 @samp{^} character, so for example to display all binary warning
1604 options (i.e., ones that are either on or off and that do not take an
1605 argument) that have a description, use:
1607 @smallexample
1608 --help=warnings,^joined,^undocumented
1609 @end smallexample
1611 The argument to @option{--help=} should not consist solely of inverted
1612 qualifiers.
1614 Combining several classes is possible, although this usually
1615 restricts the output so much that there is nothing to display.  One
1616 case where it does work, however, is when one of the classes is
1617 @var{target}.  For example, to display all the target-specific
1618 optimization options, use:
1620 @smallexample
1621 --help=target,optimizers
1622 @end smallexample
1624 The @option{--help=} option can be repeated on the command line.  Each
1625 successive use displays its requested class of options, skipping
1626 those that have already been displayed.
1628 If the @option{-Q} option appears on the command line before the
1629 @option{--help=} option, then the descriptive text displayed by
1630 @option{--help=} is changed.  Instead of describing the displayed
1631 options, an indication is given as to whether the option is enabled,
1632 disabled or set to a specific value (assuming that the compiler
1633 knows this at the point where the @option{--help=} option is used).
1635 Here is a truncated example from the ARM port of @command{gcc}:
1637 @smallexample
1638   % gcc -Q -mabi=2 --help=target -c
1639   The following options are target specific:
1640   -mabi=                                2
1641   -mabort-on-noreturn                   [disabled]
1642   -mapcs                                [disabled]
1643 @end smallexample
1645 The output is sensitive to the effects of previous command-line
1646 options, so for example it is possible to find out which optimizations
1647 are enabled at @option{-O2} by using:
1649 @smallexample
1650 -Q -O2 --help=optimizers
1651 @end smallexample
1653 Alternatively you can discover which binary optimizations are enabled
1654 by @option{-O3} by using:
1656 @smallexample
1657 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1658 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1659 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1660 @end smallexample
1662 @item --version
1663 @opindex version
1664 Display the version number and copyrights of the invoked GCC@.
1666 @item -pass-exit-codes
1667 @opindex pass-exit-codes
1668 Normally the @command{gcc} program exits with the code of 1 if any
1669 phase of the compiler returns a non-success return code.  If you specify
1670 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1671 the numerically highest error produced by any phase returning an error
1672 indication.  The C, C++, and Fortran front ends return 4 if an internal
1673 compiler error is encountered.
1675 @item -pipe
1676 @opindex pipe
1677 Use pipes rather than temporary files for communication between the
1678 various stages of compilation.  This fails to work on some systems where
1679 the assembler is unable to read from a pipe; but the GNU assembler has
1680 no trouble.
1682 @item -specs=@var{file}
1683 @opindex specs
1684 Process @var{file} after the compiler reads in the standard @file{specs}
1685 file, in order to override the defaults which the @command{gcc} driver
1686 program uses when determining what switches to pass to @command{cc1},
1687 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1688 @option{-specs=@var{file}} can be specified on the command line, and they
1689 are processed in order, from left to right.  @xref{Spec Files}, for
1690 information about the format of the @var{file}.
1692 @item -wrapper
1693 @opindex wrapper
1694 Invoke all subcommands under a wrapper program.  The name of the
1695 wrapper program and its parameters are passed as a comma separated
1696 list.
1698 @smallexample
1699 gcc -c t.c -wrapper gdb,--args
1700 @end smallexample
1702 @noindent
1703 This invokes all subprograms of @command{gcc} under
1704 @samp{gdb --args}, thus the invocation of @command{cc1} is
1705 @samp{gdb --args cc1 @dots{}}.
1707 @item -ffile-prefix-map=@var{old}=@var{new}
1708 @opindex ffile-prefix-map
1709 When compiling files residing in directory @file{@var{old}}, record
1710 any references to them in the result of the compilation as if the
1711 files resided in directory @file{@var{new}} instead.  Specifying this
1712 option is equivalent to specifying all the individual
1713 @option{-f*-prefix-map} options.  This can be used to make reproducible
1714 builds that are location independent.  See also
1715 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1717 @item -fplugin=@var{name}.so
1718 @opindex fplugin
1719 Load the plugin code in file @var{name}.so, assumed to be a
1720 shared object to be dlopen'd by the compiler.  The base name of
1721 the shared object file is used to identify the plugin for the
1722 purposes of argument parsing (See
1723 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1724 Each plugin should define the callback functions specified in the
1725 Plugins API.
1727 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1728 @opindex fplugin-arg
1729 Define an argument called @var{key} with a value of @var{value}
1730 for the plugin called @var{name}.
1732 @item -fdump-ada-spec@r{[}-slim@r{]}
1733 @opindex fdump-ada-spec
1734 For C and C++ source and include files, generate corresponding Ada specs.
1735 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1736 GNAT User's Guide}, which provides detailed documentation on this feature.
1738 @item -fada-spec-parent=@var{unit}
1739 @opindex fada-spec-parent
1740 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1741 Ada specs as child units of parent @var{unit}.
1743 @item -fdump-go-spec=@var{file}
1744 @opindex fdump-go-spec
1745 For input files in any language, generate corresponding Go
1746 declarations in @var{file}.  This generates Go @code{const},
1747 @code{type}, @code{var}, and @code{func} declarations which may be a
1748 useful way to start writing a Go interface to code written in some
1749 other language.
1751 @include @value{srcdir}/../libiberty/at-file.texi
1752 @end table
1754 @node Invoking G++
1755 @section Compiling C++ Programs
1757 @cindex suffixes for C++ source
1758 @cindex C++ source file suffixes
1759 C++ source files conventionally use one of the suffixes @samp{.C},
1760 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1761 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1762 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1763 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1764 files with these names and compiles them as C++ programs even if you
1765 call the compiler the same way as for compiling C programs (usually
1766 with the name @command{gcc}).
1768 @findex g++
1769 @findex c++
1770 However, the use of @command{gcc} does not add the C++ library.
1771 @command{g++} is a program that calls GCC and automatically specifies linking
1772 against the C++ library.  It treats @samp{.c},
1773 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1774 files unless @option{-x} is used.  This program is also useful when
1775 precompiling a C header file with a @samp{.h} extension for use in C++
1776 compilations.  On many systems, @command{g++} is also installed with
1777 the name @command{c++}.
1779 @cindex invoking @command{g++}
1780 When you compile C++ programs, you may specify many of the same
1781 command-line options that you use for compiling programs in any
1782 language; or command-line options meaningful for C and related
1783 languages; or options that are meaningful only for C++ programs.
1784 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1785 explanations of options for languages related to C@.
1786 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1787 explanations of options that are meaningful only for C++ programs.
1789 @node C Dialect Options
1790 @section Options Controlling C Dialect
1791 @cindex dialect options
1792 @cindex language dialect options
1793 @cindex options, dialect
1795 The following options control the dialect of C (or languages derived
1796 from C, such as C++, Objective-C and Objective-C++) that the compiler
1797 accepts:
1799 @table @gcctabopt
1800 @cindex ANSI support
1801 @cindex ISO support
1802 @item -ansi
1803 @opindex ansi
1804 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1805 equivalent to @option{-std=c++98}.
1807 This turns off certain features of GCC that are incompatible with ISO
1808 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1809 such as the @code{asm} and @code{typeof} keywords, and
1810 predefined macros such as @code{unix} and @code{vax} that identify the
1811 type of system you are using.  It also enables the undesirable and
1812 rarely used ISO trigraph feature.  For the C compiler,
1813 it disables recognition of C++ style @samp{//} comments as well as
1814 the @code{inline} keyword.
1816 The alternate keywords @code{__asm__}, @code{__extension__},
1817 @code{__inline__} and @code{__typeof__} continue to work despite
1818 @option{-ansi}.  You would not want to use them in an ISO C program, of
1819 course, but it is useful to put them in header files that might be included
1820 in compilations done with @option{-ansi}.  Alternate predefined macros
1821 such as @code{__unix__} and @code{__vax__} are also available, with or
1822 without @option{-ansi}.
1824 The @option{-ansi} option does not cause non-ISO programs to be
1825 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1826 addition to @option{-ansi}.  @xref{Warning Options}.
1828 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1829 option is used.  Some header files may notice this macro and refrain
1830 from declaring certain functions or defining certain macros that the
1831 ISO standard doesn't call for; this is to avoid interfering with any
1832 programs that might use these names for other things.
1834 Functions that are normally built in but do not have semantics
1835 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1836 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1837 built-in functions provided by GCC}, for details of the functions
1838 affected.
1840 @item -std=
1841 @opindex std
1842 Determine the language standard. @xref{Standards,,Language Standards
1843 Supported by GCC}, for details of these standard versions.  This option
1844 is currently only supported when compiling C or C++.
1846 The compiler can accept several base standards, such as @samp{c90} or
1847 @samp{c++98}, and GNU dialects of those standards, such as
1848 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1849 compiler accepts all programs following that standard plus those
1850 using GNU extensions that do not contradict it.  For example,
1851 @option{-std=c90} turns off certain features of GCC that are
1852 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1853 keywords, but not other GNU extensions that do not have a meaning in
1854 ISO C90, such as omitting the middle term of a @code{?:}
1855 expression. On the other hand, when a GNU dialect of a standard is
1856 specified, all features supported by the compiler are enabled, even when
1857 those features change the meaning of the base standard.  As a result, some
1858 strict-conforming programs may be rejected.  The particular standard
1859 is used by @option{-Wpedantic} to identify which features are GNU
1860 extensions given that version of the standard. For example
1861 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1862 comments, while @option{-std=gnu99 -Wpedantic} does not.
1864 A value for this option must be provided; possible values are
1866 @table @samp
1867 @item c90
1868 @itemx c89
1869 @itemx iso9899:1990
1870 Support all ISO C90 programs (certain GNU extensions that conflict
1871 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1873 @item iso9899:199409
1874 ISO C90 as modified in amendment 1.
1876 @item c99
1877 @itemx c9x
1878 @itemx iso9899:1999
1879 @itemx iso9899:199x
1880 ISO C99.  This standard is substantially completely supported, modulo
1881 bugs and floating-point issues
1882 (mainly but not entirely relating to optional C99 features from
1883 Annexes F and G).  See
1884 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1885 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1887 @item c11
1888 @itemx c1x
1889 @itemx iso9899:2011
1890 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1891 substantially completely supported, modulo bugs, floating-point issues
1892 (mainly but not entirely relating to optional C11 features from
1893 Annexes F and G) and the optional Annexes K (Bounds-checking
1894 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1896 @item c17
1897 @itemx c18
1898 @itemx iso9899:2017
1899 @itemx iso9899:2018
1900 ISO C17, the 2017 revision of the ISO C standard (expected to be
1901 published in 2018).  This standard is
1902 same as C11 except for corrections of defects (all of which are also
1903 applied with @option{-std=c11}) and a new value of
1904 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1906 @item gnu90
1907 @itemx gnu89
1908 GNU dialect of ISO C90 (including some C99 features).
1910 @item gnu99
1911 @itemx gnu9x
1912 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1914 @item gnu11
1915 @itemx gnu1x
1916 GNU dialect of ISO C11.
1917 The name @samp{gnu1x} is deprecated.
1919 @item gnu17
1920 @itemx gnu18
1921 GNU dialect of ISO C17.  This is the default for C code.
1923 @item c++98
1924 @itemx c++03
1925 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1926 additional defect reports. Same as @option{-ansi} for C++ code.
1928 @item gnu++98
1929 @itemx gnu++03
1930 GNU dialect of @option{-std=c++98}.
1932 @item c++11
1933 @itemx c++0x
1934 The 2011 ISO C++ standard plus amendments.
1935 The name @samp{c++0x} is deprecated.
1937 @item gnu++11
1938 @itemx gnu++0x
1939 GNU dialect of @option{-std=c++11}.
1940 The name @samp{gnu++0x} is deprecated.
1942 @item c++14
1943 @itemx c++1y
1944 The 2014 ISO C++ standard plus amendments.
1945 The name @samp{c++1y} is deprecated.
1947 @item gnu++14
1948 @itemx gnu++1y
1949 GNU dialect of @option{-std=c++14}.
1950 This is the default for C++ code.
1951 The name @samp{gnu++1y} is deprecated.
1953 @item c++17
1954 @itemx c++1z
1955 The 2017 ISO C++ standard plus amendments.
1956 The name @samp{c++1z} is deprecated.
1958 @item gnu++17
1959 @itemx gnu++1z
1960 GNU dialect of @option{-std=c++17}.
1961 The name @samp{gnu++1z} is deprecated.
1963 @item c++2a
1964 The next revision of the ISO C++ standard, tentatively planned for
1965 2020.  Support is highly experimental, and will almost certainly
1966 change in incompatible ways in future releases.
1968 @item gnu++2a
1969 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1970 and will almost certainly change in incompatible ways in future
1971 releases.
1972 @end table
1974 @item -fgnu89-inline
1975 @opindex fgnu89-inline
1976 The option @option{-fgnu89-inline} tells GCC to use the traditional
1977 GNU semantics for @code{inline} functions when in C99 mode.
1978 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1979 Using this option is roughly equivalent to adding the
1980 @code{gnu_inline} function attribute to all inline functions
1981 (@pxref{Function Attributes}).
1983 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1984 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1985 specifies the default behavior).
1986 This option is not supported in @option{-std=c90} or
1987 @option{-std=gnu90} mode.
1989 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1990 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1991 in effect for @code{inline} functions.  @xref{Common Predefined
1992 Macros,,,cpp,The C Preprocessor}.
1994 @item -fpermitted-flt-eval-methods=@var{style}
1995 @opindex fpermitted-flt-eval-methods
1996 @opindex fpermitted-flt-eval-methods=c11
1997 @opindex fpermitted-flt-eval-methods=ts-18661-3
1998 ISO/IEC TS 18661-3 defines new permissible values for
1999 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2000 a semantic type that is an interchange or extended format should be
2001 evaluated to the precision and range of that type.  These new values are
2002 a superset of those permitted under C99/C11, which does not specify the
2003 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2004 conforming to C11 may not have been written expecting the possibility of
2005 the new values.
2007 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2008 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2009 or the extended set of values specified in ISO/IEC TS 18661-3.
2011 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2013 The default when in a standards compliant mode (@option{-std=c11} or similar)
2014 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2015 dialect (@option{-std=gnu11} or similar) is
2016 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2018 @item -aux-info @var{filename}
2019 @opindex aux-info
2020 Output to the given filename prototyped declarations for all functions
2021 declared and/or defined in a translation unit, including those in header
2022 files.  This option is silently ignored in any language other than C@.
2024 Besides declarations, the file indicates, in comments, the origin of
2025 each declaration (source file and line), whether the declaration was
2026 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2027 @samp{O} for old, respectively, in the first character after the line
2028 number and the colon), and whether it came from a declaration or a
2029 definition (@samp{C} or @samp{F}, respectively, in the following
2030 character).  In the case of function definitions, a K&R-style list of
2031 arguments followed by their declarations is also provided, inside
2032 comments, after the declaration.
2034 @item -fallow-parameterless-variadic-functions
2035 @opindex fallow-parameterless-variadic-functions
2036 Accept variadic functions without named parameters.
2038 Although it is possible to define such a function, this is not very
2039 useful as it is not possible to read the arguments.  This is only
2040 supported for C as this construct is allowed by C++.
2042 @item -fno-asm
2043 @opindex fno-asm
2044 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2045 keyword, so that code can use these words as identifiers.  You can use
2046 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2047 instead.  @option{-ansi} implies @option{-fno-asm}.
2049 In C++, this switch only affects the @code{typeof} keyword, since
2050 @code{asm} and @code{inline} are standard keywords.  You may want to
2051 use the @option{-fno-gnu-keywords} flag instead, which has the same
2052 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2053 switch only affects the @code{asm} and @code{typeof} keywords, since
2054 @code{inline} is a standard keyword in ISO C99.
2056 @item -fno-builtin
2057 @itemx -fno-builtin-@var{function}
2058 @opindex fno-builtin
2059 @cindex built-in functions
2060 Don't recognize built-in functions that do not begin with
2061 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2062 functions provided by GCC}, for details of the functions affected,
2063 including those which are not built-in functions when @option{-ansi} or
2064 @option{-std} options for strict ISO C conformance are used because they
2065 do not have an ISO standard meaning.
2067 GCC normally generates special code to handle certain built-in functions
2068 more efficiently; for instance, calls to @code{alloca} may become single
2069 instructions which adjust the stack directly, and calls to @code{memcpy}
2070 may become inline copy loops.  The resulting code is often both smaller
2071 and faster, but since the function calls no longer appear as such, you
2072 cannot set a breakpoint on those calls, nor can you change the behavior
2073 of the functions by linking with a different library.  In addition,
2074 when a function is recognized as a built-in function, GCC may use
2075 information about that function to warn about problems with calls to
2076 that function, or to generate more efficient code, even if the
2077 resulting code still contains calls to that function.  For example,
2078 warnings are given with @option{-Wformat} for bad calls to
2079 @code{printf} when @code{printf} is built in and @code{strlen} is
2080 known not to modify global memory.
2082 With the @option{-fno-builtin-@var{function}} option
2083 only the built-in function @var{function} is
2084 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2085 function is named that is not built-in in this version of GCC, this
2086 option is ignored.  There is no corresponding
2087 @option{-fbuiltin-@var{function}} option; if you wish to enable
2088 built-in functions selectively when using @option{-fno-builtin} or
2089 @option{-ffreestanding}, you may define macros such as:
2091 @smallexample
2092 #define abs(n)          __builtin_abs ((n))
2093 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2094 @end smallexample
2096 @item -fgimple
2097 @opindex fgimple
2099 Enable parsing of function definitions marked with @code{__GIMPLE}.
2100 This is an experimental feature that allows unit testing of GIMPLE
2101 passes.
2103 @item -fhosted
2104 @opindex fhosted
2105 @cindex hosted environment
2107 Assert that compilation targets a hosted environment.  This implies
2108 @option{-fbuiltin}.  A hosted environment is one in which the
2109 entire standard library is available, and in which @code{main} has a return
2110 type of @code{int}.  Examples are nearly everything except a kernel.
2111 This is equivalent to @option{-fno-freestanding}.
2113 @item -ffreestanding
2114 @opindex ffreestanding
2115 @cindex hosted environment
2117 Assert that compilation targets a freestanding environment.  This
2118 implies @option{-fno-builtin}.  A freestanding environment
2119 is one in which the standard library may not exist, and program startup may
2120 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2121 This is equivalent to @option{-fno-hosted}.
2123 @xref{Standards,,Language Standards Supported by GCC}, for details of
2124 freestanding and hosted environments.
2126 @item -fopenacc
2127 @opindex fopenacc
2128 @cindex OpenACC accelerator programming
2129 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2130 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2131 compiler generates accelerated code according to the OpenACC Application
2132 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2133 implies @option{-pthread}, and thus is only supported on targets that
2134 have support for @option{-pthread}.
2136 @item -fopenacc-dim=@var{geom}
2137 @opindex fopenacc-dim
2138 @cindex OpenACC accelerator programming
2139 Specify default compute dimensions for parallel offload regions that do
2140 not explicitly specify.  The @var{geom} value is a triple of
2141 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2142 can be omitted, to use a target-specific default value.
2144 @item -fopenmp
2145 @opindex fopenmp
2146 @cindex OpenMP parallel
2147 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2148 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2149 compiler generates parallel code according to the OpenMP Application
2150 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2151 implies @option{-pthread}, and thus is only supported on targets that
2152 have support for @option{-pthread}. @option{-fopenmp} implies
2153 @option{-fopenmp-simd}.
2155 @item -fopenmp-simd
2156 @opindex fopenmp-simd
2157 @cindex OpenMP SIMD
2158 @cindex SIMD
2159 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2160 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2161 are ignored.
2163 @item -fgnu-tm
2164 @opindex fgnu-tm
2165 When the option @option{-fgnu-tm} is specified, the compiler
2166 generates code for the Linux variant of Intel's current Transactional
2167 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2168 an experimental feature whose interface may change in future versions
2169 of GCC, as the official specification changes.  Please note that not
2170 all architectures are supported for this feature.
2172 For more information on GCC's support for transactional memory,
2173 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2174 Transactional Memory Library}.
2176 Note that the transactional memory feature is not supported with
2177 non-call exceptions (@option{-fnon-call-exceptions}).
2179 @item -fms-extensions
2180 @opindex fms-extensions
2181 Accept some non-standard constructs used in Microsoft header files.
2183 In C++ code, this allows member names in structures to be similar
2184 to previous types declarations.
2186 @smallexample
2187 typedef int UOW;
2188 struct ABC @{
2189   UOW UOW;
2191 @end smallexample
2193 Some cases of unnamed fields in structures and unions are only
2194 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2195 fields within structs/unions}, for details.
2197 Note that this option is off for all targets but x86 
2198 targets using ms-abi.
2200 @item -fplan9-extensions
2201 @opindex fplan9-extensions
2202 Accept some non-standard constructs used in Plan 9 code.
2204 This enables @option{-fms-extensions}, permits passing pointers to
2205 structures with anonymous fields to functions that expect pointers to
2206 elements of the type of the field, and permits referring to anonymous
2207 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2208 struct/union fields within structs/unions}, for details.  This is only
2209 supported for C, not C++.
2211 @item -fcond-mismatch
2212 @opindex fcond-mismatch
2213 Allow conditional expressions with mismatched types in the second and
2214 third arguments.  The value of such an expression is void.  This option
2215 is not supported for C++.
2217 @item -flax-vector-conversions
2218 @opindex flax-vector-conversions
2219 Allow implicit conversions between vectors with differing numbers of
2220 elements and/or incompatible element types.  This option should not be
2221 used for new code.
2223 @item -funsigned-char
2224 @opindex funsigned-char
2225 Let the type @code{char} be unsigned, like @code{unsigned char}.
2227 Each kind of machine has a default for what @code{char} should
2228 be.  It is either like @code{unsigned char} by default or like
2229 @code{signed char} by default.
2231 Ideally, a portable program should always use @code{signed char} or
2232 @code{unsigned char} when it depends on the signedness of an object.
2233 But many programs have been written to use plain @code{char} and
2234 expect it to be signed, or expect it to be unsigned, depending on the
2235 machines they were written for.  This option, and its inverse, let you
2236 make such a program work with the opposite default.
2238 The type @code{char} is always a distinct type from each of
2239 @code{signed char} or @code{unsigned char}, even though its behavior
2240 is always just like one of those two.
2242 @item -fsigned-char
2243 @opindex fsigned-char
2244 Let the type @code{char} be signed, like @code{signed char}.
2246 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2247 the negative form of @option{-funsigned-char}.  Likewise, the option
2248 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2250 @item -fsigned-bitfields
2251 @itemx -funsigned-bitfields
2252 @itemx -fno-signed-bitfields
2253 @itemx -fno-unsigned-bitfields
2254 @opindex fsigned-bitfields
2255 @opindex funsigned-bitfields
2256 @opindex fno-signed-bitfields
2257 @opindex fno-unsigned-bitfields
2258 These options control whether a bit-field is signed or unsigned, when the
2259 declaration does not use either @code{signed} or @code{unsigned}.  By
2260 default, such a bit-field is signed, because this is consistent: the
2261 basic integer types such as @code{int} are signed types.
2263 @item -fsso-struct=@var{endianness}
2264 @opindex fsso-struct
2265 Set the default scalar storage order of structures and unions to the
2266 specified endianness.  The accepted values are @samp{big-endian},
2267 @samp{little-endian} and @samp{native} for the native endianness of
2268 the target (the default).  This option is not supported for C++.
2270 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2271 code that is not binary compatible with code generated without it if the
2272 specified endianness is not the native endianness of the target.
2273 @end table
2275 @node C++ Dialect Options
2276 @section Options Controlling C++ Dialect
2278 @cindex compiler options, C++
2279 @cindex C++ options, command-line
2280 @cindex options, C++
2281 This section describes the command-line options that are only meaningful
2282 for C++ programs.  You can also use most of the GNU compiler options
2283 regardless of what language your program is in.  For example, you
2284 might compile a file @file{firstClass.C} like this:
2286 @smallexample
2287 g++ -g -fstrict-enums -O -c firstClass.C
2288 @end smallexample
2290 @noindent
2291 In this example, only @option{-fstrict-enums} is an option meant
2292 only for C++ programs; you can use the other options with any
2293 language supported by GCC@.
2295 Some options for compiling C programs, such as @option{-std}, are also
2296 relevant for C++ programs.
2297 @xref{C Dialect Options,,Options Controlling C Dialect}.
2299 Here is a list of options that are @emph{only} for compiling C++ programs:
2301 @table @gcctabopt
2303 @item -fabi-version=@var{n}
2304 @opindex fabi-version
2305 Use version @var{n} of the C++ ABI@.  The default is version 0.
2307 Version 0 refers to the version conforming most closely to
2308 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2309 will change in different versions of G++ as ABI bugs are fixed.
2311 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2313 Version 2 is the version of the C++ ABI that first appeared in G++
2314 3.4, and was the default through G++ 4.9.
2316 Version 3 corrects an error in mangling a constant address as a
2317 template argument.
2319 Version 4, which first appeared in G++ 4.5, implements a standard
2320 mangling for vector types.
2322 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2323 attribute const/volatile on function pointer types, decltype of a
2324 plain decl, and use of a function parameter in the declaration of
2325 another parameter.
2327 Version 6, which first appeared in G++ 4.7, corrects the promotion
2328 behavior of C++11 scoped enums and the mangling of template argument
2329 packs, const/static_cast, prefix ++ and --, and a class scope function
2330 used as a template argument.
2332 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2333 builtin type and corrects the mangling of lambdas in default argument
2334 scope.
2336 Version 8, which first appeared in G++ 4.9, corrects the substitution
2337 behavior of function types with function-cv-qualifiers.
2339 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2340 @code{nullptr_t}.
2342 Version 10, which first appeared in G++ 6.1, adds mangling of
2343 attributes that affect type identity, such as ia32 calling convention
2344 attributes (e.g. @samp{stdcall}).
2346 Version 11, which first appeared in G++ 7, corrects the mangling of
2347 sizeof... expressions and operator names.  For multiple entities with
2348 the same name within a function, that are declared in different scopes,
2349 the mangling now changes starting with the twelfth occurrence.  It also
2350 implies @option{-fnew-inheriting-ctors}.
2352 See also @option{-Wabi}.
2354 @item -fabi-compat-version=@var{n}
2355 @opindex fabi-compat-version
2356 On targets that support strong aliases, G++
2357 works around mangling changes by creating an alias with the correct
2358 mangled name when defining a symbol with an incorrect mangled name.
2359 This switch specifies which ABI version to use for the alias.
2361 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2362 compatibility).  If another ABI version is explicitly selected, this
2363 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2364 use @option{-fabi-compat-version=2}.
2366 If this option is not provided but @option{-Wabi=@var{n}} is, that
2367 version is used for compatibility aliases.  If this option is provided
2368 along with @option{-Wabi} (without the version), the version from this
2369 option is used for the warning.
2371 @item -fno-access-control
2372 @opindex fno-access-control
2373 Turn off all access checking.  This switch is mainly useful for working
2374 around bugs in the access control code.
2376 @item -faligned-new
2377 @opindex faligned-new
2378 Enable support for C++17 @code{new} of types that require more
2379 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2380 numeric argument such as @code{-faligned-new=32} can be used to
2381 specify how much alignment (in bytes) is provided by that function,
2382 but few users will need to override the default of
2383 @code{alignof(std::max_align_t)}.
2385 This flag is enabled by default for @option{-std=c++17}.
2387 @item -fcheck-new
2388 @opindex fcheck-new
2389 Check that the pointer returned by @code{operator new} is non-null
2390 before attempting to modify the storage allocated.  This check is
2391 normally unnecessary because the C++ standard specifies that
2392 @code{operator new} only returns @code{0} if it is declared
2393 @code{throw()}, in which case the compiler always checks the
2394 return value even without this option.  In all other cases, when
2395 @code{operator new} has a non-empty exception specification, memory
2396 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2397 @samp{new (nothrow)}.
2399 @item -fconcepts
2400 @opindex fconcepts
2401 Enable support for the C++ Extensions for Concepts Technical
2402 Specification, ISO 19217 (2015), which allows code like
2404 @smallexample
2405 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2406 template <Addable T> T add (T a, T b) @{ return a + b; @}
2407 @end smallexample
2409 @item -fconstexpr-depth=@var{n}
2410 @opindex fconstexpr-depth
2411 Set the maximum nested evaluation depth for C++11 constexpr functions
2412 to @var{n}.  A limit is needed to detect endless recursion during
2413 constant expression evaluation.  The minimum specified by the standard
2414 is 512.
2416 @item -fconstexpr-loop-limit=@var{n}
2417 @opindex fconstexpr-loop-limit
2418 Set the maximum number of iterations for a loop in C++14 constexpr functions
2419 to @var{n}.  A limit is needed to detect infinite loops during
2420 constant expression evaluation.  The default is 262144 (1<<18).
2422 @item -fdeduce-init-list
2423 @opindex fdeduce-init-list
2424 Enable deduction of a template type parameter as
2425 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2427 @smallexample
2428 template <class T> auto forward(T t) -> decltype (realfn (t))
2430   return realfn (t);
2433 void f()
2435   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2437 @end smallexample
2439 This deduction was implemented as a possible extension to the
2440 originally proposed semantics for the C++11 standard, but was not part
2441 of the final standard, so it is disabled by default.  This option is
2442 deprecated, and may be removed in a future version of G++.
2444 @item -ffriend-injection
2445 @opindex ffriend-injection
2446 Inject friend functions into the enclosing namespace, so that they are
2447 visible outside the scope of the class in which they are declared.
2448 Friend functions were documented to work this way in the old Annotated
2449 C++ Reference Manual.  
2450 However, in ISO C++ a friend function that is not declared
2451 in an enclosing scope can only be found using argument dependent
2452 lookup.  GCC defaults to the standard behavior.
2454 This option is deprecated and will be removed.
2456 @item -fno-elide-constructors
2457 @opindex fno-elide-constructors
2458 The C++ standard allows an implementation to omit creating a temporary
2459 that is only used to initialize another object of the same type.
2460 Specifying this option disables that optimization, and forces G++ to
2461 call the copy constructor in all cases.  This option also causes G++
2462 to call trivial member functions which otherwise would be expanded inline.
2464 In C++17, the compiler is required to omit these temporaries, but this
2465 option still affects trivial member functions.
2467 @item -fno-enforce-eh-specs
2468 @opindex fno-enforce-eh-specs
2469 Don't generate code to check for violation of exception specifications
2470 at run time.  This option violates the C++ standard, but may be useful
2471 for reducing code size in production builds, much like defining
2472 @code{NDEBUG}.  This does not give user code permission to throw
2473 exceptions in violation of the exception specifications; the compiler
2474 still optimizes based on the specifications, so throwing an
2475 unexpected exception results in undefined behavior at run time.
2477 @item -fextern-tls-init
2478 @itemx -fno-extern-tls-init
2479 @opindex fextern-tls-init
2480 @opindex fno-extern-tls-init
2481 The C++11 and OpenMP standards allow @code{thread_local} and
2482 @code{threadprivate} variables to have dynamic (runtime)
2483 initialization.  To support this, any use of such a variable goes
2484 through a wrapper function that performs any necessary initialization.
2485 When the use and definition of the variable are in the same
2486 translation unit, this overhead can be optimized away, but when the
2487 use is in a different translation unit there is significant overhead
2488 even if the variable doesn't actually need dynamic initialization.  If
2489 the programmer can be sure that no use of the variable in a
2490 non-defining TU needs to trigger dynamic initialization (either
2491 because the variable is statically initialized, or a use of the
2492 variable in the defining TU will be executed before any uses in
2493 another TU), they can avoid this overhead with the
2494 @option{-fno-extern-tls-init} option.
2496 On targets that support symbol aliases, the default is
2497 @option{-fextern-tls-init}.  On targets that do not support symbol
2498 aliases, the default is @option{-fno-extern-tls-init}.
2500 @item -ffor-scope
2501 @itemx -fno-for-scope
2502 @opindex ffor-scope
2503 @opindex fno-for-scope
2504 If @option{-ffor-scope} is specified, the scope of variables declared in
2505 a @i{for-init-statement} is limited to the @code{for} loop itself,
2506 as specified by the C++ standard.
2507 If @option{-fno-for-scope} is specified, the scope of variables declared in
2508 a @i{for-init-statement} extends to the end of the enclosing scope,
2509 as was the case in old versions of G++, and other (traditional)
2510 implementations of C++.
2512 This option is deprecated and the associated non-standard
2513 functionality will be removed.
2515 @item -fno-gnu-keywords
2516 @opindex fno-gnu-keywords
2517 Do not recognize @code{typeof} as a keyword, so that code can use this
2518 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2519 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2520 @option{-std=c++98}, @option{-std=c++11}, etc.
2522 @item -fno-implicit-templates
2523 @opindex fno-implicit-templates
2524 Never emit code for non-inline templates that are instantiated
2525 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2526 @xref{Template Instantiation}, for more information.
2528 @item -fno-implicit-inline-templates
2529 @opindex fno-implicit-inline-templates
2530 Don't emit code for implicit instantiations of inline templates, either.
2531 The default is to handle inlines differently so that compiles with and
2532 without optimization need the same set of explicit instantiations.
2534 @item -fno-implement-inlines
2535 @opindex fno-implement-inlines
2536 To save space, do not emit out-of-line copies of inline functions
2537 controlled by @code{#pragma implementation}.  This causes linker
2538 errors if these functions are not inlined everywhere they are called.
2540 @item -fms-extensions
2541 @opindex fms-extensions
2542 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2543 int and getting a pointer to member function via non-standard syntax.
2545 @item -fnew-inheriting-ctors
2546 @opindex fnew-inheriting-ctors
2547 Enable the P0136 adjustment to the semantics of C++11 constructor
2548 inheritance.  This is part of C++17 but also considered to be a Defect
2549 Report against C++11 and C++14.  This flag is enabled by default
2550 unless @option{-fabi-version=10} or lower is specified.
2552 @item -fnew-ttp-matching
2553 @opindex fnew-ttp-matching
2554 Enable the P0522 resolution to Core issue 150, template template
2555 parameters and default arguments: this allows a template with default
2556 template arguments as an argument for a template template parameter
2557 with fewer template parameters.  This flag is enabled by default for
2558 @option{-std=c++17}.
2560 @item -fno-nonansi-builtins
2561 @opindex fno-nonansi-builtins
2562 Disable built-in declarations of functions that are not mandated by
2563 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2564 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2566 @item -fnothrow-opt
2567 @opindex fnothrow-opt
2568 Treat a @code{throw()} exception specification as if it were a
2569 @code{noexcept} specification to reduce or eliminate the text size
2570 overhead relative to a function with no exception specification.  If
2571 the function has local variables of types with non-trivial
2572 destructors, the exception specification actually makes the
2573 function smaller because the EH cleanups for those variables can be
2574 optimized away.  The semantic effect is that an exception thrown out of
2575 a function with such an exception specification results in a call
2576 to @code{terminate} rather than @code{unexpected}.
2578 @item -fno-operator-names
2579 @opindex fno-operator-names
2580 Do not treat the operator name keywords @code{and}, @code{bitand},
2581 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2582 synonyms as keywords.
2584 @item -fno-optional-diags
2585 @opindex fno-optional-diags
2586 Disable diagnostics that the standard says a compiler does not need to
2587 issue.  Currently, the only such diagnostic issued by G++ is the one for
2588 a name having multiple meanings within a class.
2590 @item -fpermissive
2591 @opindex fpermissive
2592 Downgrade some diagnostics about nonconformant code from errors to
2593 warnings.  Thus, using @option{-fpermissive} allows some
2594 nonconforming code to compile.
2596 @item -fno-pretty-templates
2597 @opindex fno-pretty-templates
2598 When an error message refers to a specialization of a function
2599 template, the compiler normally prints the signature of the
2600 template followed by the template arguments and any typedefs or
2601 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2602 rather than @code{void f(int)}) so that it's clear which template is
2603 involved.  When an error message refers to a specialization of a class
2604 template, the compiler omits any template arguments that match
2605 the default template arguments for that template.  If either of these
2606 behaviors make it harder to understand the error message rather than
2607 easier, you can use @option{-fno-pretty-templates} to disable them.
2609 @item -frepo
2610 @opindex frepo
2611 Enable automatic template instantiation at link time.  This option also
2612 implies @option{-fno-implicit-templates}.  @xref{Template
2613 Instantiation}, for more information.
2615 @item -fno-rtti
2616 @opindex fno-rtti
2617 Disable generation of information about every class with virtual
2618 functions for use by the C++ run-time type identification features
2619 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2620 of the language, you can save some space by using this flag.  Note that
2621 exception handling uses the same information, but G++ generates it as
2622 needed. The @code{dynamic_cast} operator can still be used for casts that
2623 do not require run-time type information, i.e.@: casts to @code{void *} or to
2624 unambiguous base classes.
2626 @item -fsized-deallocation
2627 @opindex fsized-deallocation
2628 Enable the built-in global declarations
2629 @smallexample
2630 void operator delete (void *, std::size_t) noexcept;
2631 void operator delete[] (void *, std::size_t) noexcept;
2632 @end smallexample
2633 as introduced in C++14.  This is useful for user-defined replacement
2634 deallocation functions that, for example, use the size of the object
2635 to make deallocation faster.  Enabled by default under
2636 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2637 warns about places that might want to add a definition.
2639 @item -fstrict-enums
2640 @opindex fstrict-enums
2641 Allow the compiler to optimize using the assumption that a value of
2642 enumerated type can only be one of the values of the enumeration (as
2643 defined in the C++ standard; basically, a value that can be
2644 represented in the minimum number of bits needed to represent all the
2645 enumerators).  This assumption may not be valid if the program uses a
2646 cast to convert an arbitrary integer value to the enumerated type.
2648 @item -fstrong-eval-order
2649 @opindex fstrong-eval-order
2650 Evaluate member access, array subscripting, and shift expressions in
2651 left-to-right order, and evaluate assignment in right-to-left order,
2652 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2653 @option{-fstrong-eval-order=some} enables just the ordering of member
2654 access and shift expressions, and is the default without
2655 @option{-std=c++17}.
2657 @item -ftemplate-backtrace-limit=@var{n}
2658 @opindex ftemplate-backtrace-limit
2659 Set the maximum number of template instantiation notes for a single
2660 warning or error to @var{n}.  The default value is 10.
2662 @item -ftemplate-depth=@var{n}
2663 @opindex ftemplate-depth
2664 Set the maximum instantiation depth for template classes to @var{n}.
2665 A limit on the template instantiation depth is needed to detect
2666 endless recursions during template class instantiation.  ANSI/ISO C++
2667 conforming programs must not rely on a maximum depth greater than 17
2668 (changed to 1024 in C++11).  The default value is 900, as the compiler
2669 can run out of stack space before hitting 1024 in some situations.
2671 @item -fno-threadsafe-statics
2672 @opindex fno-threadsafe-statics
2673 Do not emit the extra code to use the routines specified in the C++
2674 ABI for thread-safe initialization of local statics.  You can use this
2675 option to reduce code size slightly in code that doesn't need to be
2676 thread-safe.
2678 @item -fuse-cxa-atexit
2679 @opindex fuse-cxa-atexit
2680 Register destructors for objects with static storage duration with the
2681 @code{__cxa_atexit} function rather than the @code{atexit} function.
2682 This option is required for fully standards-compliant handling of static
2683 destructors, but only works if your C library supports
2684 @code{__cxa_atexit}.
2686 @item -fno-use-cxa-get-exception-ptr
2687 @opindex fno-use-cxa-get-exception-ptr
2688 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2689 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2690 if the runtime routine is not available.
2692 @item -fvisibility-inlines-hidden
2693 @opindex fvisibility-inlines-hidden
2694 This switch declares that the user does not attempt to compare
2695 pointers to inline functions or methods where the addresses of the two functions
2696 are taken in different shared objects.
2698 The effect of this is that GCC may, effectively, mark inline methods with
2699 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2700 appear in the export table of a DSO and do not require a PLT indirection
2701 when used within the DSO@.  Enabling this option can have a dramatic effect
2702 on load and link times of a DSO as it massively reduces the size of the
2703 dynamic export table when the library makes heavy use of templates.
2705 The behavior of this switch is not quite the same as marking the
2706 methods as hidden directly, because it does not affect static variables
2707 local to the function or cause the compiler to deduce that
2708 the function is defined in only one shared object.
2710 You may mark a method as having a visibility explicitly to negate the
2711 effect of the switch for that method.  For example, if you do want to
2712 compare pointers to a particular inline method, you might mark it as
2713 having default visibility.  Marking the enclosing class with explicit
2714 visibility has no effect.
2716 Explicitly instantiated inline methods are unaffected by this option
2717 as their linkage might otherwise cross a shared library boundary.
2718 @xref{Template Instantiation}.
2720 @item -fvisibility-ms-compat
2721 @opindex fvisibility-ms-compat
2722 This flag attempts to use visibility settings to make GCC's C++
2723 linkage model compatible with that of Microsoft Visual Studio.
2725 The flag makes these changes to GCC's linkage model:
2727 @enumerate
2728 @item
2729 It sets the default visibility to @code{hidden}, like
2730 @option{-fvisibility=hidden}.
2732 @item
2733 Types, but not their members, are not hidden by default.
2735 @item
2736 The One Definition Rule is relaxed for types without explicit
2737 visibility specifications that are defined in more than one
2738 shared object: those declarations are permitted if they are
2739 permitted when this option is not used.
2740 @end enumerate
2742 In new code it is better to use @option{-fvisibility=hidden} and
2743 export those classes that are intended to be externally visible.
2744 Unfortunately it is possible for code to rely, perhaps accidentally,
2745 on the Visual Studio behavior.
2747 Among the consequences of these changes are that static data members
2748 of the same type with the same name but defined in different shared
2749 objects are different, so changing one does not change the other;
2750 and that pointers to function members defined in different shared
2751 objects may not compare equal.  When this flag is given, it is a
2752 violation of the ODR to define types with the same name differently.
2754 @item -fno-weak
2755 @opindex fno-weak
2756 Do not use weak symbol support, even if it is provided by the linker.
2757 By default, G++ uses weak symbols if they are available.  This
2758 option exists only for testing, and should not be used by end-users;
2759 it results in inferior code and has no benefits.  This option may
2760 be removed in a future release of G++.
2762 @item -nostdinc++
2763 @opindex nostdinc++
2764 Do not search for header files in the standard directories specific to
2765 C++, but do still search the other standard directories.  (This option
2766 is used when building the C++ library.)
2767 @end table
2769 In addition, these optimization, warning, and code generation options
2770 have meanings only for C++ programs:
2772 @table @gcctabopt
2773 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2774 @opindex Wabi
2775 @opindex Wno-abi
2776 Warn when G++ it generates code that is probably not compatible with
2777 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2778 ABI with each major release, normally @option{-Wabi} will warn only if
2779 there is a check added later in a release series for an ABI issue
2780 discovered since the initial release.  @option{-Wabi} will warn about
2781 more things if an older ABI version is selected (with
2782 @option{-fabi-version=@var{n}}).
2784 @option{-Wabi} can also be used with an explicit version number to
2785 warn about compatibility with a particular @option{-fabi-version}
2786 level, e.g. @option{-Wabi=2} to warn about changes relative to
2787 @option{-fabi-version=2}.
2789 If an explicit version number is provided and
2790 @option{-fabi-compat-version} is not specified, the version number
2791 from this option is used for compatibility aliases.  If no explicit
2792 version number is provided with this option, but
2793 @option{-fabi-compat-version} is specified, that version number is
2794 used for ABI warnings.
2796 Although an effort has been made to warn about
2797 all such cases, there are probably some cases that are not warned about,
2798 even though G++ is generating incompatible code.  There may also be
2799 cases where warnings are emitted even though the code that is generated
2800 is compatible.
2802 You should rewrite your code to avoid these warnings if you are
2803 concerned about the fact that code generated by G++ may not be binary
2804 compatible with code generated by other compilers.
2806 Known incompatibilities in @option{-fabi-version=2} (which was the
2807 default from GCC 3.4 to 4.9) include:
2809 @itemize @bullet
2811 @item
2812 A template with a non-type template parameter of reference type was
2813 mangled incorrectly:
2814 @smallexample
2815 extern int N;
2816 template <int &> struct S @{@};
2817 void n (S<N>) @{2@}
2818 @end smallexample
2820 This was fixed in @option{-fabi-version=3}.
2822 @item
2823 SIMD vector types declared using @code{__attribute ((vector_size))} were
2824 mangled in a non-standard way that does not allow for overloading of
2825 functions taking vectors of different sizes.
2827 The mangling was changed in @option{-fabi-version=4}.
2829 @item
2830 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2831 qualifiers, and @code{decltype} of a plain declaration was folded away.
2833 These mangling issues were fixed in @option{-fabi-version=5}.
2835 @item
2836 Scoped enumerators passed as arguments to a variadic function are
2837 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2838 On most targets this does not actually affect the parameter passing
2839 ABI, as there is no way to pass an argument smaller than @code{int}.
2841 Also, the ABI changed the mangling of template argument packs,
2842 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2843 a class scope function used as a template argument.
2845 These issues were corrected in @option{-fabi-version=6}.
2847 @item
2848 Lambdas in default argument scope were mangled incorrectly, and the
2849 ABI changed the mangling of @code{nullptr_t}.
2851 These issues were corrected in @option{-fabi-version=7}.
2853 @item
2854 When mangling a function type with function-cv-qualifiers, the
2855 un-qualified function type was incorrectly treated as a substitution
2856 candidate.
2858 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2860 @item
2861 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2862 unaligned accesses.  Note that this did not affect the ABI of a
2863 function with a @code{nullptr_t} parameter, as parameters have a
2864 minimum alignment.
2866 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2868 @item
2869 Target-specific attributes that affect the identity of a type, such as
2870 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2871 did not affect the mangled name, leading to name collisions when
2872 function pointers were used as template arguments.
2874 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2876 @end itemize
2878 It also warns about psABI-related changes.  The known psABI changes at this
2879 point include:
2881 @itemize @bullet
2883 @item
2884 For SysV/x86-64, unions with @code{long double} members are 
2885 passed in memory as specified in psABI.  For example:
2887 @smallexample
2888 union U @{
2889   long double ld;
2890   int i;
2892 @end smallexample
2894 @noindent
2895 @code{union U} is always passed in memory.
2897 @end itemize
2899 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2900 @opindex Wabi-tag
2901 @opindex -Wabi-tag
2902 Warn when a type with an ABI tag is used in a context that does not
2903 have that ABI tag.  See @ref{C++ Attributes} for more information
2904 about ABI tags.
2906 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2907 @opindex Wctor-dtor-privacy
2908 @opindex Wno-ctor-dtor-privacy
2909 Warn when a class seems unusable because all the constructors or
2910 destructors in that class are private, and it has neither friends nor
2911 public static member functions.  Also warn if there are no non-private
2912 methods, and there's at least one private member function that isn't
2913 a constructor or destructor.
2915 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2916 @opindex Wdelete-non-virtual-dtor
2917 @opindex Wno-delete-non-virtual-dtor
2918 Warn when @code{delete} is used to destroy an instance of a class that
2919 has virtual functions and non-virtual destructor. It is unsafe to delete
2920 an instance of a derived class through a pointer to a base class if the
2921 base class does not have a virtual destructor.  This warning is enabled
2922 by @option{-Wall}.
2924 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2925 @opindex Wliteral-suffix
2926 @opindex Wno-literal-suffix
2927 Warn when a string or character literal is followed by a ud-suffix which does
2928 not begin with an underscore.  As a conforming extension, GCC treats such
2929 suffixes as separate preprocessing tokens in order to maintain backwards
2930 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2931 For example:
2933 @smallexample
2934 #define __STDC_FORMAT_MACROS
2935 #include <inttypes.h>
2936 #include <stdio.h>
2938 int main() @{
2939   int64_t i64 = 123;
2940   printf("My int64: %" PRId64"\n", i64);
2942 @end smallexample
2944 In this case, @code{PRId64} is treated as a separate preprocessing token.
2946 Additionally, warn when a user-defined literal operator is declared with
2947 a literal suffix identifier that doesn't begin with an underscore. Literal
2948 suffix identifiers that don't begin with an underscore are reserved for
2949 future standardization.
2951 This warning is enabled by default.
2953 @item -Wlto-type-mismatch
2954 @opindex Wlto-type-mismatch
2955 @opindex Wno-lto-type-mismatch
2957 During the link-time optimization warn about type mismatches in
2958 global declarations from different compilation units.
2959 Requires @option{-flto} to be enabled.  Enabled by default.
2961 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2962 @opindex Wnarrowing
2963 @opindex Wno-narrowing
2964 For C++11 and later standards, narrowing conversions are diagnosed by default,
2965 as required by the standard.  A narrowing conversion from a constant produces
2966 an error, and a narrowing conversion from a non-constant produces a warning,
2967 but @option{-Wno-narrowing} suppresses the diagnostic.
2968 Note that this does not affect the meaning of well-formed code;
2969 narrowing conversions are still considered ill-formed in SFINAE contexts.
2971 With @option{-Wnarrowing} in C++98, warn when a narrowing
2972 conversion prohibited by C++11 occurs within
2973 @samp{@{ @}}, e.g.
2975 @smallexample
2976 int i = @{ 2.2 @}; // error: narrowing from double to int
2977 @end smallexample
2979 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2981 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2982 @opindex Wnoexcept
2983 @opindex Wno-noexcept
2984 Warn when a noexcept-expression evaluates to false because of a call
2985 to a function that does not have a non-throwing exception
2986 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2987 the compiler to never throw an exception.
2989 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2990 @opindex Wnoexcept-type
2991 @opindex Wno-noexcept-type
2992 Warn if the C++17 feature making @code{noexcept} part of a function
2993 type changes the mangled name of a symbol relative to C++14.  Enabled
2994 by @option{-Wabi} and @option{-Wc++17-compat}.
2996 As an example:
2998 @smallexample
2999 template <class T> void f(T t) @{ t(); @};
3000 void g() noexcept;
3001 void h() @{ f(g); @} 
3002 @end smallexample
3004 @noindent
3005 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
3006 C++17 it calls @code{f<void(*)()noexcept>}.
3008 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3009 @opindex Wclass-memaccess
3010 Warn when the destination of a call to a raw memory function such as
3011 @code{memset} or @code{memcpy} is an object of class type, and when writing
3012 into such an object might bypass the class non-trivial or deleted constructor
3013 or copy assignment, violate const-correctness or encapsulation, or corrupt
3014 virtual table pointers.  Modifying the representation of such objects may
3015 violate invariants maintained by member functions of the class.  For example,
3016 the call to @code{memset} below is undefined because it modifies a non-trivial
3017 class object and is, therefore, diagnosed.  The safe way to either initialize
3018 or clear the storage of objects of such types is by using the appropriate
3019 constructor or assignment operator, if one is available.
3020 @smallexample
3021 std::string str = "abc";
3022 memset (&str, 0, sizeof str);
3023 @end smallexample
3024 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3025 Explicitly casting the pointer to the class object to @code{void *} or
3026 to a type that can be safely accessed by the raw memory function suppresses
3027 the warning.
3029 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3030 @opindex Wnon-virtual-dtor
3031 @opindex Wno-non-virtual-dtor
3032 Warn when a class has virtual functions and an accessible non-virtual
3033 destructor itself or in an accessible polymorphic base class, in which
3034 case it is possible but unsafe to delete an instance of a derived
3035 class through a pointer to the class itself or base class.  This
3036 warning is automatically enabled if @option{-Weffc++} is specified.
3038 @item -Wregister @r{(C++ and Objective-C++ only)}
3039 @opindex Wregister
3040 @opindex Wno-register
3041 Warn on uses of the @code{register} storage class specifier, except
3042 when it is part of the GNU @ref{Explicit Register Variables} extension.
3043 The use of the @code{register} keyword as storage class specifier has
3044 been deprecated in C++11 and removed in C++17.
3045 Enabled by default with @option{-std=c++17}.
3047 @item -Wreorder @r{(C++ and Objective-C++ only)}
3048 @opindex Wreorder
3049 @opindex Wno-reorder
3050 @cindex reordering, warning
3051 @cindex warning for reordering of member initializers
3052 Warn when the order of member initializers given in the code does not
3053 match the order in which they must be executed.  For instance:
3055 @smallexample
3056 struct A @{
3057   int i;
3058   int j;
3059   A(): j (0), i (1) @{ @}
3061 @end smallexample
3063 @noindent
3064 The compiler rearranges the member initializers for @code{i}
3065 and @code{j} to match the declaration order of the members, emitting
3066 a warning to that effect.  This warning is enabled by @option{-Wall}.
3068 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3069 @opindex fext-numeric-literals
3070 @opindex fno-ext-numeric-literals
3071 Accept imaginary, fixed-point, or machine-defined
3072 literal number suffixes as GNU extensions.
3073 When this option is turned off these suffixes are treated
3074 as C++11 user-defined literal numeric suffixes.
3075 This is on by default for all pre-C++11 dialects and all GNU dialects:
3076 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3077 @option{-std=gnu++14}.
3078 This option is off by default
3079 for ISO C++11 onwards (@option{-std=c++11}, ...).
3080 @end table
3082 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3084 @table @gcctabopt
3085 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3086 @opindex Weffc++
3087 @opindex Wno-effc++
3088 Warn about violations of the following style guidelines from Scott Meyers'
3089 @cite{Effective C++} series of books:
3091 @itemize @bullet
3092 @item
3093 Define a copy constructor and an assignment operator for classes
3094 with dynamically-allocated memory.
3096 @item
3097 Prefer initialization to assignment in constructors.
3099 @item
3100 Have @code{operator=} return a reference to @code{*this}.
3102 @item
3103 Don't try to return a reference when you must return an object.
3105 @item
3106 Distinguish between prefix and postfix forms of increment and
3107 decrement operators.
3109 @item
3110 Never overload @code{&&}, @code{||}, or @code{,}.
3112 @end itemize
3114 This option also enables @option{-Wnon-virtual-dtor}, which is also
3115 one of the effective C++ recommendations.  However, the check is
3116 extended to warn about the lack of virtual destructor in accessible
3117 non-polymorphic bases classes too.
3119 When selecting this option, be aware that the standard library
3120 headers do not obey all of these guidelines; use @samp{grep -v}
3121 to filter out those warnings.
3123 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3124 @opindex Wstrict-null-sentinel
3125 @opindex Wno-strict-null-sentinel
3126 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3127 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3128 to @code{__null}.  Although it is a null pointer constant rather than a
3129 null pointer, it is guaranteed to be of the same size as a pointer.
3130 But this use is not portable across different compilers.
3132 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3133 @opindex Wno-non-template-friend
3134 @opindex Wnon-template-friend
3135 Disable warnings when non-template friend functions are declared
3136 within a template.  In very old versions of GCC that predate implementation
3137 of the ISO standard, declarations such as 
3138 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3139 could be interpreted as a particular specialization of a template
3140 function; the warning exists to diagnose compatibility problems, 
3141 and is enabled by default.
3143 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3144 @opindex Wold-style-cast
3145 @opindex Wno-old-style-cast
3146 Warn if an old-style (C-style) cast to a non-void type is used within
3147 a C++ program.  The new-style casts (@code{dynamic_cast},
3148 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3149 less vulnerable to unintended effects and much easier to search for.
3151 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3152 @opindex Woverloaded-virtual
3153 @opindex Wno-overloaded-virtual
3154 @cindex overloaded virtual function, warning
3155 @cindex warning for overloaded virtual function
3156 Warn when a function declaration hides virtual functions from a
3157 base class.  For example, in:
3159 @smallexample
3160 struct A @{
3161   virtual void f();
3164 struct B: public A @{
3165   void f(int);
3167 @end smallexample
3169 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3170 like:
3172 @smallexample
3173 B* b;
3174 b->f();
3175 @end smallexample
3177 @noindent
3178 fails to compile.
3180 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3181 @opindex Wno-pmf-conversions
3182 @opindex Wpmf-conversions
3183 Disable the diagnostic for converting a bound pointer to member function
3184 to a plain pointer.
3186 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3187 @opindex Wsign-promo
3188 @opindex Wno-sign-promo
3189 Warn when overload resolution chooses a promotion from unsigned or
3190 enumerated type to a signed type, over a conversion to an unsigned type of
3191 the same size.  Previous versions of G++ tried to preserve
3192 unsignedness, but the standard mandates the current behavior.
3194 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3195 @opindex Wtemplates
3196 Warn when a primary template declaration is encountered.  Some coding
3197 rules disallow templates, and this may be used to enforce that rule.
3198 The warning is inactive inside a system header file, such as the STL, so
3199 one can still use the STL.  One may also instantiate or specialize
3200 templates.
3202 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3203 @opindex Wmultiple-inheritance
3204 Warn when a class is defined with multiple direct base classes.  Some
3205 coding rules disallow multiple inheritance, and this may be used to
3206 enforce that rule.  The warning is inactive inside a system header file,
3207 such as the STL, so one can still use the STL.  One may also define
3208 classes that indirectly use multiple inheritance.
3210 @item -Wvirtual-inheritance
3211 @opindex Wvirtual-inheritance
3212 Warn when a class is defined with a virtual direct base class.  Some
3213 coding rules disallow multiple inheritance, and this may be used to
3214 enforce that rule.  The warning is inactive inside a system header file,
3215 such as the STL, so one can still use the STL.  One may also define
3216 classes that indirectly use virtual inheritance.
3218 @item -Wnamespaces
3219 @opindex Wnamespaces
3220 Warn when a namespace definition is opened.  Some coding rules disallow
3221 namespaces, and this may be used to enforce that rule.  The warning is
3222 inactive inside a system header file, such as the STL, so one can still
3223 use the STL.  One may also use using directives and qualified names.
3225 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3226 @opindex Wterminate
3227 @opindex Wno-terminate
3228 Disable the warning about a throw-expression that will immediately
3229 result in a call to @code{terminate}.
3230 @end table
3232 @node Objective-C and Objective-C++ Dialect Options
3233 @section Options Controlling Objective-C and Objective-C++ Dialects
3235 @cindex compiler options, Objective-C and Objective-C++
3236 @cindex Objective-C and Objective-C++ options, command-line
3237 @cindex options, Objective-C and Objective-C++
3238 (NOTE: This manual does not describe the Objective-C and Objective-C++
3239 languages themselves.  @xref{Standards,,Language Standards
3240 Supported by GCC}, for references.)
3242 This section describes the command-line options that are only meaningful
3243 for Objective-C and Objective-C++ programs.  You can also use most of
3244 the language-independent GNU compiler options.
3245 For example, you might compile a file @file{some_class.m} like this:
3247 @smallexample
3248 gcc -g -fgnu-runtime -O -c some_class.m
3249 @end smallexample
3251 @noindent
3252 In this example, @option{-fgnu-runtime} is an option meant only for
3253 Objective-C and Objective-C++ programs; you can use the other options with
3254 any language supported by GCC@.
3256 Note that since Objective-C is an extension of the C language, Objective-C
3257 compilations may also use options specific to the C front-end (e.g.,
3258 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3259 C++-specific options (e.g., @option{-Wabi}).
3261 Here is a list of options that are @emph{only} for compiling Objective-C
3262 and Objective-C++ programs:
3264 @table @gcctabopt
3265 @item -fconstant-string-class=@var{class-name}
3266 @opindex fconstant-string-class
3267 Use @var{class-name} as the name of the class to instantiate for each
3268 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3269 class name is @code{NXConstantString} if the GNU runtime is being used, and
3270 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3271 @option{-fconstant-cfstrings} option, if also present, overrides the
3272 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3273 to be laid out as constant CoreFoundation strings.
3275 @item -fgnu-runtime
3276 @opindex fgnu-runtime
3277 Generate object code compatible with the standard GNU Objective-C
3278 runtime.  This is the default for most types of systems.
3280 @item -fnext-runtime
3281 @opindex fnext-runtime
3282 Generate output compatible with the NeXT runtime.  This is the default
3283 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3284 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3285 used.
3287 @item -fno-nil-receivers
3288 @opindex fno-nil-receivers
3289 Assume that all Objective-C message dispatches (@code{[receiver
3290 message:arg]}) in this translation unit ensure that the receiver is
3291 not @code{nil}.  This allows for more efficient entry points in the
3292 runtime to be used.  This option is only available in conjunction with
3293 the NeXT runtime and ABI version 0 or 1.
3295 @item -fobjc-abi-version=@var{n}
3296 @opindex fobjc-abi-version
3297 Use version @var{n} of the Objective-C ABI for the selected runtime.
3298 This option is currently supported only for the NeXT runtime.  In that
3299 case, Version 0 is the traditional (32-bit) ABI without support for
3300 properties and other Objective-C 2.0 additions.  Version 1 is the
3301 traditional (32-bit) ABI with support for properties and other
3302 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3303 nothing is specified, the default is Version 0 on 32-bit target
3304 machines, and Version 2 on 64-bit target machines.
3306 @item -fobjc-call-cxx-cdtors
3307 @opindex fobjc-call-cxx-cdtors
3308 For each Objective-C class, check if any of its instance variables is a
3309 C++ object with a non-trivial default constructor.  If so, synthesize a
3310 special @code{- (id) .cxx_construct} instance method which runs
3311 non-trivial default constructors on any such instance variables, in order,
3312 and then return @code{self}.  Similarly, check if any instance variable
3313 is a C++ object with a non-trivial destructor, and if so, synthesize a
3314 special @code{- (void) .cxx_destruct} method which runs
3315 all such default destructors, in reverse order.
3317 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3318 methods thusly generated only operate on instance variables
3319 declared in the current Objective-C class, and not those inherited
3320 from superclasses.  It is the responsibility of the Objective-C
3321 runtime to invoke all such methods in an object's inheritance
3322 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3323 by the runtime immediately after a new object instance is allocated;
3324 the @code{- (void) .cxx_destruct} methods are invoked immediately
3325 before the runtime deallocates an object instance.
3327 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3328 support for invoking the @code{- (id) .cxx_construct} and
3329 @code{- (void) .cxx_destruct} methods.
3331 @item -fobjc-direct-dispatch
3332 @opindex fobjc-direct-dispatch
3333 Allow fast jumps to the message dispatcher.  On Darwin this is
3334 accomplished via the comm page.
3336 @item -fobjc-exceptions
3337 @opindex fobjc-exceptions
3338 Enable syntactic support for structured exception handling in
3339 Objective-C, similar to what is offered by C++.  This option
3340 is required to use the Objective-C keywords @code{@@try},
3341 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3342 @code{@@synchronized}.  This option is available with both the GNU
3343 runtime and the NeXT runtime (but not available in conjunction with
3344 the NeXT runtime on Mac OS X 10.2 and earlier).
3346 @item -fobjc-gc
3347 @opindex fobjc-gc
3348 Enable garbage collection (GC) in Objective-C and Objective-C++
3349 programs.  This option is only available with the NeXT runtime; the
3350 GNU runtime has a different garbage collection implementation that
3351 does not require special compiler flags.
3353 @item -fobjc-nilcheck
3354 @opindex fobjc-nilcheck
3355 For the NeXT runtime with version 2 of the ABI, check for a nil
3356 receiver in method invocations before doing the actual method call.
3357 This is the default and can be disabled using
3358 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3359 checked for nil in this way no matter what this flag is set to.
3360 Currently this flag does nothing when the GNU runtime, or an older
3361 version of the NeXT runtime ABI, is used.
3363 @item -fobjc-std=objc1
3364 @opindex fobjc-std
3365 Conform to the language syntax of Objective-C 1.0, the language
3366 recognized by GCC 4.0.  This only affects the Objective-C additions to
3367 the C/C++ language; it does not affect conformance to C/C++ standards,
3368 which is controlled by the separate C/C++ dialect option flags.  When
3369 this option is used with the Objective-C or Objective-C++ compiler,
3370 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3371 This is useful if you need to make sure that your Objective-C code can
3372 be compiled with older versions of GCC@.
3374 @item -freplace-objc-classes
3375 @opindex freplace-objc-classes
3376 Emit a special marker instructing @command{ld(1)} not to statically link in
3377 the resulting object file, and allow @command{dyld(1)} to load it in at
3378 run time instead.  This is used in conjunction with the Fix-and-Continue
3379 debugging mode, where the object file in question may be recompiled and
3380 dynamically reloaded in the course of program execution, without the need
3381 to restart the program itself.  Currently, Fix-and-Continue functionality
3382 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3383 and later.
3385 @item -fzero-link
3386 @opindex fzero-link
3387 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3388 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3389 compile time) with static class references that get initialized at load time,
3390 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3391 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3392 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3393 for individual class implementations to be modified during program execution.
3394 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3395 regardless of command-line options.
3397 @item -fno-local-ivars
3398 @opindex fno-local-ivars
3399 @opindex flocal-ivars
3400 By default instance variables in Objective-C can be accessed as if
3401 they were local variables from within the methods of the class they're
3402 declared in.  This can lead to shadowing between instance variables
3403 and other variables declared either locally inside a class method or
3404 globally with the same name.  Specifying the @option{-fno-local-ivars}
3405 flag disables this behavior thus avoiding variable shadowing issues.
3407 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3408 @opindex fivar-visibility
3409 Set the default instance variable visibility to the specified option
3410 so that instance variables declared outside the scope of any access
3411 modifier directives default to the specified visibility.
3413 @item -gen-decls
3414 @opindex gen-decls
3415 Dump interface declarations for all classes seen in the source file to a
3416 file named @file{@var{sourcename}.decl}.
3418 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3419 @opindex Wassign-intercept
3420 @opindex Wno-assign-intercept
3421 Warn whenever an Objective-C assignment is being intercepted by the
3422 garbage collector.
3424 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3425 @opindex Wno-protocol
3426 @opindex Wprotocol
3427 If a class is declared to implement a protocol, a warning is issued for
3428 every method in the protocol that is not implemented by the class.  The
3429 default behavior is to issue a warning for every method not explicitly
3430 implemented in the class, even if a method implementation is inherited
3431 from the superclass.  If you use the @option{-Wno-protocol} option, then
3432 methods inherited from the superclass are considered to be implemented,
3433 and no warning is issued for them.
3435 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3436 @opindex Wselector
3437 @opindex Wno-selector
3438 Warn if multiple methods of different types for the same selector are
3439 found during compilation.  The check is performed on the list of methods
3440 in the final stage of compilation.  Additionally, a check is performed
3441 for each selector appearing in a @code{@@selector(@dots{})}
3442 expression, and a corresponding method for that selector has been found
3443 during compilation.  Because these checks scan the method table only at
3444 the end of compilation, these warnings are not produced if the final
3445 stage of compilation is not reached, for example because an error is
3446 found during compilation, or because the @option{-fsyntax-only} option is
3447 being used.
3449 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3450 @opindex Wstrict-selector-match
3451 @opindex Wno-strict-selector-match
3452 Warn if multiple methods with differing argument and/or return types are
3453 found for a given selector when attempting to send a message using this
3454 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3455 is off (which is the default behavior), the compiler omits such warnings
3456 if any differences found are confined to types that share the same size
3457 and alignment.
3459 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3460 @opindex Wundeclared-selector
3461 @opindex Wno-undeclared-selector
3462 Warn if a @code{@@selector(@dots{})} expression referring to an
3463 undeclared selector is found.  A selector is considered undeclared if no
3464 method with that name has been declared before the
3465 @code{@@selector(@dots{})} expression, either explicitly in an
3466 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3467 an @code{@@implementation} section.  This option always performs its
3468 checks as soon as a @code{@@selector(@dots{})} expression is found,
3469 while @option{-Wselector} only performs its checks in the final stage of
3470 compilation.  This also enforces the coding style convention
3471 that methods and selectors must be declared before being used.
3473 @item -print-objc-runtime-info
3474 @opindex print-objc-runtime-info
3475 Generate C header describing the largest structure that is passed by
3476 value, if any.
3478 @end table
3480 @node Diagnostic Message Formatting Options
3481 @section Options to Control Diagnostic Messages Formatting
3482 @cindex options to control diagnostics formatting
3483 @cindex diagnostic messages
3484 @cindex message formatting
3486 Traditionally, diagnostic messages have been formatted irrespective of
3487 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3488 options described below
3489 to control the formatting algorithm for diagnostic messages, 
3490 e.g.@: how many characters per line, how often source location
3491 information should be reported.  Note that some language front ends may not
3492 honor these options.
3494 @table @gcctabopt
3495 @item -fmessage-length=@var{n}
3496 @opindex fmessage-length
3497 Try to format error messages so that they fit on lines of about
3498 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3499 done; each error message appears on a single line.  This is the
3500 default for all front ends.
3502 @item -fdiagnostics-show-location=once
3503 @opindex fdiagnostics-show-location
3504 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3505 reporter to emit source location information @emph{once}; that is, in
3506 case the message is too long to fit on a single physical line and has to
3507 be wrapped, the source location won't be emitted (as prefix) again,
3508 over and over, in subsequent continuation lines.  This is the default
3509 behavior.
3511 @item -fdiagnostics-show-location=every-line
3512 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3513 messages reporter to emit the same source location information (as
3514 prefix) for physical lines that result from the process of breaking
3515 a message which is too long to fit on a single line.
3517 @item -fdiagnostics-color[=@var{WHEN}]
3518 @itemx -fno-diagnostics-color
3519 @opindex fdiagnostics-color
3520 @cindex highlight, color
3521 @vindex GCC_COLORS @r{environment variable}
3522 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3523 or @samp{auto}.  The default depends on how the compiler has been configured,
3524 it can be any of the above @var{WHEN} options or also @samp{never}
3525 if @env{GCC_COLORS} environment variable isn't present in the environment,
3526 and @samp{auto} otherwise.
3527 @samp{auto} means to use color only when the standard error is a terminal.
3528 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3529 aliases for @option{-fdiagnostics-color=always} and
3530 @option{-fdiagnostics-color=never}, respectively.
3532 The colors are defined by the environment variable @env{GCC_COLORS}.
3533 Its value is a colon-separated list of capabilities and Select Graphic
3534 Rendition (SGR) substrings. SGR commands are interpreted by the
3535 terminal or terminal emulator.  (See the section in the documentation
3536 of your text terminal for permitted values and their meanings as
3537 character attributes.)  These substring values are integers in decimal
3538 representation and can be concatenated with semicolons.
3539 Common values to concatenate include
3540 @samp{1} for bold,
3541 @samp{4} for underline,
3542 @samp{5} for blink,
3543 @samp{7} for inverse,
3544 @samp{39} for default foreground color,
3545 @samp{30} to @samp{37} for foreground colors,
3546 @samp{90} to @samp{97} for 16-color mode foreground colors,
3547 @samp{38;5;0} to @samp{38;5;255}
3548 for 88-color and 256-color modes foreground colors,
3549 @samp{49} for default background color,
3550 @samp{40} to @samp{47} for background colors,
3551 @samp{100} to @samp{107} for 16-color mode background colors,
3552 and @samp{48;5;0} to @samp{48;5;255}
3553 for 88-color and 256-color modes background colors.
3555 The default @env{GCC_COLORS} is
3556 @smallexample
3557 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3558 quote=01:fixit-insert=32:fixit-delete=31:\
3559 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3560 type-diff=01;32
3561 @end smallexample
3562 @noindent
3563 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3564 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3565 @samp{01} is bold, and @samp{31} is red.
3566 Setting @env{GCC_COLORS} to the empty string disables colors.
3567 Supported capabilities are as follows.
3569 @table @code
3570 @item error=
3571 @vindex error GCC_COLORS @r{capability}
3572 SGR substring for error: markers.
3574 @item warning=
3575 @vindex warning GCC_COLORS @r{capability}
3576 SGR substring for warning: markers.
3578 @item note=
3579 @vindex note GCC_COLORS @r{capability}
3580 SGR substring for note: markers.
3582 @item range1=
3583 @vindex range1 GCC_COLORS @r{capability}
3584 SGR substring for first additional range.
3586 @item range2=
3587 @vindex range2 GCC_COLORS @r{capability}
3588 SGR substring for second additional range.
3590 @item locus=
3591 @vindex locus GCC_COLORS @r{capability}
3592 SGR substring for location information, @samp{file:line} or
3593 @samp{file:line:column} etc.
3595 @item quote=
3596 @vindex quote GCC_COLORS @r{capability}
3597 SGR substring for information printed within quotes.
3599 @item fixit-insert=
3600 @vindex fixit-insert GCC_COLORS @r{capability}
3601 SGR substring for fix-it hints suggesting text to
3602 be inserted or replaced.
3604 @item fixit-delete=
3605 @vindex fixit-delete GCC_COLORS @r{capability}
3606 SGR substring for fix-it hints suggesting text to
3607 be deleted.
3609 @item diff-filename=
3610 @vindex diff-filename GCC_COLORS @r{capability}
3611 SGR substring for filename headers within generated patches.
3613 @item diff-hunk=
3614 @vindex diff-hunk GCC_COLORS @r{capability}
3615 SGR substring for the starts of hunks within generated patches.
3617 @item diff-delete=
3618 @vindex diff-delete GCC_COLORS @r{capability}
3619 SGR substring for deleted lines within generated patches.
3621 @item diff-insert=
3622 @vindex diff-insert GCC_COLORS @r{capability}
3623 SGR substring for inserted lines within generated patches.
3625 @item type-diff=
3626 @vindex type-diff GCC_COLORS @r{capability}
3627 SGR substring for highlighting mismatching types within template
3628 arguments in the C++ frontend.
3629 @end table
3631 @item -fno-diagnostics-show-option
3632 @opindex fno-diagnostics-show-option
3633 @opindex fdiagnostics-show-option
3634 By default, each diagnostic emitted includes text indicating the
3635 command-line option that directly controls the diagnostic (if such an
3636 option is known to the diagnostic machinery).  Specifying the
3637 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3639 @item -fno-diagnostics-show-caret
3640 @opindex fno-diagnostics-show-caret
3641 @opindex fdiagnostics-show-caret
3642 By default, each diagnostic emitted includes the original source line
3643 and a caret @samp{^} indicating the column.  This option suppresses this
3644 information.  The source line is truncated to @var{n} characters, if
3645 the @option{-fmessage-length=n} option is given.  When the output is done
3646 to the terminal, the width is limited to the width given by the
3647 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3649 @item -fdiagnostics-parseable-fixits
3650 @opindex fdiagnostics-parseable-fixits
3651 Emit fix-it hints in a machine-parseable format, suitable for consumption
3652 by IDEs.  For each fix-it, a line will be printed after the relevant
3653 diagnostic, starting with the string ``fix-it:''.  For example:
3655 @smallexample
3656 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3657 @end smallexample
3659 The location is expressed as a half-open range, expressed as a count of
3660 bytes, starting at byte 1 for the initial column.  In the above example,
3661 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3662 given string:
3664 @smallexample
3665 00000000011111111112222222222
3666 12345678901234567890123456789
3667   gtk_widget_showall (dlg);
3668   ^^^^^^^^^^^^^^^^^^
3669   gtk_widget_show_all
3670 @end smallexample
3672 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3673 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3674 (e.g. vertical tab as ``\013'').
3676 An empty replacement string indicates that the given range is to be removed.
3677 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3678 be inserted at the given position.
3680 @item -fdiagnostics-generate-patch
3681 @opindex fdiagnostics-generate-patch
3682 Print fix-it hints to stderr in unified diff format, after any diagnostics
3683 are printed.  For example:
3685 @smallexample
3686 --- test.c
3687 +++ test.c
3688 @@ -42,5 +42,5 @@
3690  void show_cb(GtkDialog *dlg)
3691  @{
3692 -  gtk_widget_showall(dlg);
3693 +  gtk_widget_show_all(dlg);
3694  @}
3696 @end smallexample
3698 The diff may or may not be colorized, following the same rules
3699 as for diagnostics (see @option{-fdiagnostics-color}).
3701 @item -fdiagnostics-show-template-tree
3702 @opindex fdiagnostics-show-template-tree
3704 In the C++ frontend, when printing diagnostics showing mismatching
3705 template types, such as:
3707 @smallexample
3708   could not convert 'std::map<int, std::vector<double> >()'
3709     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3710 @end smallexample
3712 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3713 tree-like structure showing the common and differing parts of the types,
3714 such as:
3716 @smallexample
3717   map<
3718     [...],
3719     vector<
3720       [double != float]>>
3721 @end smallexample
3723 The parts that differ are highlighted with color (``double'' and
3724 ``float'' in this case).
3726 @item -fno-elide-type
3727 @opindex fno-elide-type
3728 @opindex felide-type
3729 By default when the C++ frontend prints diagnostics showing mismatching
3730 template types, common parts of the types are printed as ``[...]'' to
3731 simplify the error message.  For example:
3733 @smallexample
3734   could not convert 'std::map<int, std::vector<double> >()'
3735     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3736 @end smallexample
3738 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3739 This flag also affects the output of the
3740 @option{-fdiagnostics-show-template-tree} flag.
3742 @item -fno-show-column
3743 @opindex fno-show-column
3744 Do not print column numbers in diagnostics.  This may be necessary if
3745 diagnostics are being scanned by a program that does not understand the
3746 column numbers, such as @command{dejagnu}.
3748 @end table
3750 @node Warning Options
3751 @section Options to Request or Suppress Warnings
3752 @cindex options to control warnings
3753 @cindex warning messages
3754 @cindex messages, warning
3755 @cindex suppressing warnings
3757 Warnings are diagnostic messages that report constructions that
3758 are not inherently erroneous but that are risky or suggest there
3759 may have been an error.
3761 The following language-independent options do not enable specific
3762 warnings but control the kinds of diagnostics produced by GCC@.
3764 @table @gcctabopt
3765 @cindex syntax checking
3766 @item -fsyntax-only
3767 @opindex fsyntax-only
3768 Check the code for syntax errors, but don't do anything beyond that.
3770 @item -fmax-errors=@var{n}
3771 @opindex fmax-errors
3772 Limits the maximum number of error messages to @var{n}, at which point
3773 GCC bails out rather than attempting to continue processing the source
3774 code.  If @var{n} is 0 (the default), there is no limit on the number
3775 of error messages produced.  If @option{-Wfatal-errors} is also
3776 specified, then @option{-Wfatal-errors} takes precedence over this
3777 option.
3779 @item -w
3780 @opindex w
3781 Inhibit all warning messages.
3783 @item -Werror
3784 @opindex Werror
3785 @opindex Wno-error
3786 Make all warnings into errors.
3788 @item -Werror=
3789 @opindex Werror=
3790 @opindex Wno-error=
3791 Make the specified warning into an error.  The specifier for a warning
3792 is appended; for example @option{-Werror=switch} turns the warnings
3793 controlled by @option{-Wswitch} into errors.  This switch takes a
3794 negative form, to be used to negate @option{-Werror} for specific
3795 warnings; for example @option{-Wno-error=switch} makes
3796 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3797 is in effect.
3799 The warning message for each controllable warning includes the
3800 option that controls the warning.  That option can then be used with
3801 @option{-Werror=} and @option{-Wno-error=} as described above.
3802 (Printing of the option in the warning message can be disabled using the
3803 @option{-fno-diagnostics-show-option} flag.)
3805 Note that specifying @option{-Werror=}@var{foo} automatically implies
3806 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3807 imply anything.
3809 @item -Wfatal-errors
3810 @opindex Wfatal-errors
3811 @opindex Wno-fatal-errors
3812 This option causes the compiler to abort compilation on the first error
3813 occurred rather than trying to keep going and printing further error
3814 messages.
3816 @end table
3818 You can request many specific warnings with options beginning with
3819 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3820 implicit declarations.  Each of these specific warning options also
3821 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3822 example, @option{-Wno-implicit}.  This manual lists only one of the
3823 two forms, whichever is not the default.  For further
3824 language-specific options also refer to @ref{C++ Dialect Options} and
3825 @ref{Objective-C and Objective-C++ Dialect Options}.
3827 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3828 options, such as @option{-Wunused}, which may turn on further options,
3829 such as @option{-Wunused-value}. The combined effect of positive and
3830 negative forms is that more specific options have priority over less
3831 specific ones, independently of their position in the command-line. For
3832 options of the same specificity, the last one takes effect. Options
3833 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3834 as if they appeared at the end of the command-line.
3836 When an unrecognized warning option is requested (e.g.,
3837 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3838 that the option is not recognized.  However, if the @option{-Wno-} form
3839 is used, the behavior is slightly different: no diagnostic is
3840 produced for @option{-Wno-unknown-warning} unless other diagnostics
3841 are being produced.  This allows the use of new @option{-Wno-} options
3842 with old compilers, but if something goes wrong, the compiler
3843 warns that an unrecognized option is present.
3845 @table @gcctabopt
3846 @item -Wpedantic
3847 @itemx -pedantic
3848 @opindex pedantic
3849 @opindex Wpedantic
3850 Issue all the warnings demanded by strict ISO C and ISO C++;
3851 reject all programs that use forbidden extensions, and some other
3852 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3853 version of the ISO C standard specified by any @option{-std} option used.
3855 Valid ISO C and ISO C++ programs should compile properly with or without
3856 this option (though a rare few require @option{-ansi} or a
3857 @option{-std} option specifying the required version of ISO C)@.  However,
3858 without this option, certain GNU extensions and traditional C and C++
3859 features are supported as well.  With this option, they are rejected.
3861 @option{-Wpedantic} does not cause warning messages for use of the
3862 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3863 warnings are also disabled in the expression that follows
3864 @code{__extension__}.  However, only system header files should use
3865 these escape routes; application programs should avoid them.
3866 @xref{Alternate Keywords}.
3868 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3869 C conformance.  They soon find that it does not do quite what they want:
3870 it finds some non-ISO practices, but not all---only those for which
3871 ISO C @emph{requires} a diagnostic, and some others for which
3872 diagnostics have been added.
3874 A feature to report any failure to conform to ISO C might be useful in
3875 some instances, but would require considerable additional work and would
3876 be quite different from @option{-Wpedantic}.  We don't have plans to
3877 support such a feature in the near future.
3879 Where the standard specified with @option{-std} represents a GNU
3880 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3881 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3882 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3883 where they are required by the base standard.  (It does not make sense
3884 for such warnings to be given only for features not in the specified GNU
3885 C dialect, since by definition the GNU dialects of C include all
3886 features the compiler supports with the given option, and there would be
3887 nothing to warn about.)
3889 @item -pedantic-errors
3890 @opindex pedantic-errors
3891 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3892 requires a diagnostic, in some cases where there is undefined behavior
3893 at compile-time and in some other cases that do not prevent compilation
3894 of programs that are valid according to the standard. This is not
3895 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3896 by this option and not enabled by the latter and vice versa.
3898 @item -Wall
3899 @opindex Wall
3900 @opindex Wno-all
3901 This enables all the warnings about constructions that some users
3902 consider questionable, and that are easy to avoid (or modify to
3903 prevent the warning), even in conjunction with macros.  This also
3904 enables some language-specific warnings described in @ref{C++ Dialect
3905 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3907 @option{-Wall} turns on the following warning flags:
3909 @gccoptlist{-Waddress   @gol
3910 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3911 -Wbool-compare  @gol
3912 -Wbool-operation  @gol
3913 -Wc++11-compat  -Wc++14-compat  @gol
3914 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3915 -Wchar-subscripts  @gol
3916 -Wcomment  @gol
3917 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3918 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3919 -Wformat   @gol
3920 -Wint-in-bool-context  @gol
3921 -Wimplicit @r{(C and Objective-C only)} @gol
3922 -Wimplicit-int @r{(C and Objective-C only)} @gol
3923 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3924 -Winit-self @r{(only for C++)} @gol
3925 -Wlogical-not-parentheses @gol
3926 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3927 -Wmaybe-uninitialized @gol
3928 -Wmemset-elt-size @gol
3929 -Wmemset-transposed-args @gol
3930 -Wmisleading-indentation @r{(only for C/C++)} @gol
3931 -Wmissing-braces @r{(only for C/ObjC)} @gol
3932 -Wmultistatement-macros  @gol
3933 -Wnarrowing @r{(only for C++)}  @gol
3934 -Wnonnull  @gol
3935 -Wnonnull-compare  @gol
3936 -Wopenmp-simd @gol
3937 -Wparentheses  @gol
3938 -Wpointer-sign  @gol
3939 -Wreorder   @gol
3940 -Wrestrict   @gol
3941 -Wreturn-type  @gol
3942 -Wsequence-point  @gol
3943 -Wsign-compare @r{(only in C++)}  @gol
3944 -Wsizeof-pointer-div @gol
3945 -Wsizeof-pointer-memaccess @gol
3946 -Wstrict-aliasing  @gol
3947 -Wstrict-overflow=1  @gol
3948 -Wswitch  @gol
3949 -Wtautological-compare  @gol
3950 -Wtrigraphs  @gol
3951 -Wuninitialized  @gol
3952 -Wunknown-pragmas  @gol
3953 -Wunused-function  @gol
3954 -Wunused-label     @gol
3955 -Wunused-value     @gol
3956 -Wunused-variable  @gol
3957 -Wvolatile-register-var @gol
3960 Note that some warning flags are not implied by @option{-Wall}.  Some of
3961 them warn about constructions that users generally do not consider
3962 questionable, but which occasionally you might wish to check for;
3963 others warn about constructions that are necessary or hard to avoid in
3964 some cases, and there is no simple way to modify the code to suppress
3965 the warning. Some of them are enabled by @option{-Wextra} but many of
3966 them must be enabled individually.
3968 @item -Wextra
3969 @opindex W
3970 @opindex Wextra
3971 @opindex Wno-extra
3972 This enables some extra warning flags that are not enabled by
3973 @option{-Wall}. (This option used to be called @option{-W}.  The older
3974 name is still supported, but the newer name is more descriptive.)
3976 @gccoptlist{-Wclobbered  @gol
3977 -Wcast-function-type  @gol
3978 -Wempty-body  @gol
3979 -Wignored-qualifiers @gol
3980 -Wimplicit-fallthrough=3 @gol
3981 -Wmissing-field-initializers  @gol
3982 -Wmissing-parameter-type @r{(C only)}  @gol
3983 -Wold-style-declaration @r{(C only)}  @gol
3984 -Woverride-init  @gol
3985 -Wsign-compare @r{(C only)} @gol
3986 -Wtype-limits  @gol
3987 -Wuninitialized  @gol
3988 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3989 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3990 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3993 The option @option{-Wextra} also prints warning messages for the
3994 following cases:
3996 @itemize @bullet
3998 @item
3999 A pointer is compared against integer zero with @code{<}, @code{<=},
4000 @code{>}, or @code{>=}.
4002 @item
4003 (C++ only) An enumerator and a non-enumerator both appear in a
4004 conditional expression.
4006 @item
4007 (C++ only) Ambiguous virtual bases.
4009 @item
4010 (C++ only) Subscripting an array that has been declared @code{register}.
4012 @item
4013 (C++ only) Taking the address of a variable that has been declared
4014 @code{register}.
4016 @item
4017 (C++ only) A base class is not initialized in the copy constructor
4018 of a derived class.
4020 @end itemize
4022 @item -Wchar-subscripts
4023 @opindex Wchar-subscripts
4024 @opindex Wno-char-subscripts
4025 Warn if an array subscript has type @code{char}.  This is a common cause
4026 of error, as programmers often forget that this type is signed on some
4027 machines.
4028 This warning is enabled by @option{-Wall}.
4030 @item -Wchkp
4031 @opindex Wchkp
4032 Warn about an invalid memory access that is found by Pointer Bounds Checker
4033 (@option{-fcheck-pointer-bounds}).
4035 @item -Wno-coverage-mismatch
4036 @opindex Wno-coverage-mismatch
4037 Warn if feedback profiles do not match when using the
4038 @option{-fprofile-use} option.
4039 If a source file is changed between compiling with @option{-fprofile-gen} and
4040 with @option{-fprofile-use}, the files with the profile feedback can fail
4041 to match the source file and GCC cannot use the profile feedback
4042 information.  By default, this warning is enabled and is treated as an
4043 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4044 warning or @option{-Wno-error=coverage-mismatch} can be used to
4045 disable the error.  Disabling the error for this warning can result in
4046 poorly optimized code and is useful only in the
4047 case of very minor changes such as bug fixes to an existing code-base.
4048 Completely disabling the warning is not recommended.
4050 @item -Wno-cpp
4051 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4053 Suppress warning messages emitted by @code{#warning} directives.
4055 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4056 @opindex Wdouble-promotion
4057 @opindex Wno-double-promotion
4058 Give a warning when a value of type @code{float} is implicitly
4059 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4060 floating-point unit implement @code{float} in hardware, but emulate
4061 @code{double} in software.  On such a machine, doing computations
4062 using @code{double} values is much more expensive because of the
4063 overhead required for software emulation.
4065 It is easy to accidentally do computations with @code{double} because
4066 floating-point literals are implicitly of type @code{double}.  For
4067 example, in:
4068 @smallexample
4069 @group
4070 float area(float radius)
4072    return 3.14159 * radius * radius;
4074 @end group
4075 @end smallexample
4076 the compiler performs the entire computation with @code{double}
4077 because the floating-point literal is a @code{double}.
4079 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4080 @opindex Wduplicate-decl-specifier
4081 @opindex Wno-duplicate-decl-specifier
4082 Warn if a declaration has duplicate @code{const}, @code{volatile},
4083 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4084 @option{-Wall}.
4086 @item -Wformat
4087 @itemx -Wformat=@var{n}
4088 @opindex Wformat
4089 @opindex Wno-format
4090 @opindex ffreestanding
4091 @opindex fno-builtin
4092 @opindex Wformat=
4093 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4094 the arguments supplied have types appropriate to the format string
4095 specified, and that the conversions specified in the format string make
4096 sense.  This includes standard functions, and others specified by format
4097 attributes (@pxref{Function Attributes}), in the @code{printf},
4098 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4099 not in the C standard) families (or other target-specific families).
4100 Which functions are checked without format attributes having been
4101 specified depends on the standard version selected, and such checks of
4102 functions without the attribute specified are disabled by
4103 @option{-ffreestanding} or @option{-fno-builtin}.
4105 The formats are checked against the format features supported by GNU
4106 libc version 2.2.  These include all ISO C90 and C99 features, as well
4107 as features from the Single Unix Specification and some BSD and GNU
4108 extensions.  Other library implementations may not support all these
4109 features; GCC does not support warning about features that go beyond a
4110 particular library's limitations.  However, if @option{-Wpedantic} is used
4111 with @option{-Wformat}, warnings are given about format features not
4112 in the selected standard version (but not for @code{strfmon} formats,
4113 since those are not in any version of the C standard).  @xref{C Dialect
4114 Options,,Options Controlling C Dialect}.
4116 @table @gcctabopt
4117 @item -Wformat=1
4118 @itemx -Wformat
4119 @opindex Wformat
4120 @opindex Wformat=1
4121 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4122 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4123 @option{-Wformat} also checks for null format arguments for several
4124 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4125 aspects of this level of format checking can be disabled by the
4126 options: @option{-Wno-format-contains-nul},
4127 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4128 @option{-Wformat} is enabled by @option{-Wall}.
4130 @item -Wno-format-contains-nul
4131 @opindex Wno-format-contains-nul
4132 @opindex Wformat-contains-nul
4133 If @option{-Wformat} is specified, do not warn about format strings that
4134 contain NUL bytes.
4136 @item -Wno-format-extra-args
4137 @opindex Wno-format-extra-args
4138 @opindex Wformat-extra-args
4139 If @option{-Wformat} is specified, do not warn about excess arguments to a
4140 @code{printf} or @code{scanf} format function.  The C standard specifies
4141 that such arguments are ignored.
4143 Where the unused arguments lie between used arguments that are
4144 specified with @samp{$} operand number specifications, normally
4145 warnings are still given, since the implementation could not know what
4146 type to pass to @code{va_arg} to skip the unused arguments.  However,
4147 in the case of @code{scanf} formats, this option suppresses the
4148 warning if the unused arguments are all pointers, since the Single
4149 Unix Specification says that such unused arguments are allowed.
4151 @item -Wformat-overflow
4152 @itemx -Wformat-overflow=@var{level}
4153 @opindex Wformat-overflow
4154 @opindex Wno-format-overflow
4155 Warn about calls to formatted input/output functions such as @code{sprintf}
4156 and @code{vsprintf} that might overflow the destination buffer.  When the
4157 exact number of bytes written by a format directive cannot be determined
4158 at compile-time it is estimated based on heuristics that depend on the
4159 @var{level} argument and on optimization.  While enabling optimization
4160 will in most cases improve the accuracy of the warning, it may also
4161 result in false positives.
4163 @table @gcctabopt
4164 @item -Wformat-overflow
4165 @itemx -Wformat-overflow=1
4166 @opindex Wformat-overflow
4167 @opindex Wno-format-overflow
4168 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4169 employs a conservative approach that warns only about calls that most
4170 likely overflow the buffer.  At this level, numeric arguments to format
4171 directives with unknown values are assumed to have the value of one, and
4172 strings of unknown length to be empty.  Numeric arguments that are known
4173 to be bounded to a subrange of their type, or string arguments whose output
4174 is bounded either by their directive's precision or by a finite set of
4175 string literals, are assumed to take on the value within the range that
4176 results in the most bytes on output.  For example, the call to @code{sprintf}
4177 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4178 the terminating NUL character (@code{'\0'}) appended by the function
4179 to the destination buffer will be written past its end.  Increasing
4180 the size of the buffer by a single byte is sufficient to avoid the
4181 warning, though it may not be sufficient to avoid the overflow.
4183 @smallexample
4184 void f (int a, int b)
4186   char buf [13];
4187   sprintf (buf, "a = %i, b = %i\n", a, b);
4189 @end smallexample
4191 @item -Wformat-overflow=2
4192 Level @var{2} warns also about calls that might overflow the destination
4193 buffer given an argument of sufficient length or magnitude.  At level
4194 @var{2}, unknown numeric arguments are assumed to have the minimum
4195 representable value for signed types with a precision greater than 1, and
4196 the maximum representable value otherwise.  Unknown string arguments whose
4197 length cannot be assumed to be bounded either by the directive's precision,
4198 or by a finite set of string literals they may evaluate to, or the character
4199 array they may point to, are assumed to be 1 character long.
4201 At level @var{2}, the call in the example above is again diagnosed, but
4202 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4203 @code{%i} directive will write some of its digits beyond the end of
4204 the destination buffer.  To make the call safe regardless of the values
4205 of the two variables, the size of the destination buffer must be increased
4206 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4207 an informational note following the warning.
4209 An alternative to increasing the size of the destination buffer is to
4210 constrain the range of formatted values.  The maximum length of string
4211 arguments can be bounded by specifying the precision in the format
4212 directive.  When numeric arguments of format directives can be assumed
4213 to be bounded by less than the precision of their type, choosing
4214 an appropriate length modifier to the format specifier will reduce
4215 the required buffer size.  For example, if @var{a} and @var{b} in the
4216 example above can be assumed to be within the precision of
4217 the @code{short int} type then using either the @code{%hi} format
4218 directive or casting the argument to @code{short} reduces the maximum
4219 required size of the buffer to 24 bytes.
4221 @smallexample
4222 void f (int a, int b)
4224   char buf [23];
4225   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4227 @end smallexample
4228 @end table
4230 @item -Wno-format-zero-length
4231 @opindex Wno-format-zero-length
4232 @opindex Wformat-zero-length
4233 If @option{-Wformat} is specified, do not warn about zero-length formats.
4234 The C standard specifies that zero-length formats are allowed.
4237 @item -Wformat=2
4238 @opindex Wformat=2
4239 Enable @option{-Wformat} plus additional format checks.  Currently
4240 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4241 -Wformat-y2k}.
4243 @item -Wformat-nonliteral
4244 @opindex Wformat-nonliteral
4245 @opindex Wno-format-nonliteral
4246 If @option{-Wformat} is specified, also warn if the format string is not a
4247 string literal and so cannot be checked, unless the format function
4248 takes its format arguments as a @code{va_list}.
4250 @item -Wformat-security
4251 @opindex Wformat-security
4252 @opindex Wno-format-security
4253 If @option{-Wformat} is specified, also warn about uses of format
4254 functions that represent possible security problems.  At present, this
4255 warns about calls to @code{printf} and @code{scanf} functions where the
4256 format string is not a string literal and there are no format arguments,
4257 as in @code{printf (foo);}.  This may be a security hole if the format
4258 string came from untrusted input and contains @samp{%n}.  (This is
4259 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4260 in future warnings may be added to @option{-Wformat-security} that are not
4261 included in @option{-Wformat-nonliteral}.)
4263 @item -Wformat-signedness
4264 @opindex Wformat-signedness
4265 @opindex Wno-format-signedness
4266 If @option{-Wformat} is specified, also warn if the format string
4267 requires an unsigned argument and the argument is signed and vice versa.
4269 @item -Wformat-truncation
4270 @itemx -Wformat-truncation=@var{level}
4271 @opindex Wformat-truncation
4272 @opindex Wno-format-truncation
4273 Warn about calls to formatted input/output functions such as @code{snprintf}
4274 and @code{vsnprintf} that might result in output truncation.  When the exact
4275 number of bytes written by a format directive cannot be determined at
4276 compile-time it is estimated based on heuristics that depend on
4277 the @var{level} argument and on optimization.  While enabling optimization
4278 will in most cases improve the accuracy of the warning, it may also result
4279 in false positives.  Except as noted otherwise, the option uses the same
4280 logic @option{-Wformat-overflow}.
4282 @table @gcctabopt
4283 @item -Wformat-truncation
4284 @itemx -Wformat-truncation=1
4285 @opindex Wformat-truncation
4286 @opindex Wno-format-overflow
4287 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4288 employs a conservative approach that warns only about calls to bounded
4289 functions whose return value is unused and that will most likely result
4290 in output truncation.
4292 @item -Wformat-truncation=2
4293 Level @var{2} warns also about calls to bounded functions whose return
4294 value is used and that might result in truncation given an argument of
4295 sufficient length or magnitude.
4296 @end table
4298 @item -Wformat-y2k
4299 @opindex Wformat-y2k
4300 @opindex Wno-format-y2k
4301 If @option{-Wformat} is specified, also warn about @code{strftime}
4302 formats that may yield only a two-digit year.
4303 @end table
4305 @item -Wnonnull
4306 @opindex Wnonnull
4307 @opindex Wno-nonnull
4308 Warn about passing a null pointer for arguments marked as
4309 requiring a non-null value by the @code{nonnull} function attribute.
4311 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4312 can be disabled with the @option{-Wno-nonnull} option.
4314 @item -Wnonnull-compare
4315 @opindex Wnonnull-compare
4316 @opindex Wno-nonnull-compare
4317 Warn when comparing an argument marked with the @code{nonnull}
4318 function attribute against null inside the function.
4320 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4321 can be disabled with the @option{-Wno-nonnull-compare} option.
4323 @item -Wnull-dereference
4324 @opindex Wnull-dereference
4325 @opindex Wno-null-dereference
4326 Warn if the compiler detects paths that trigger erroneous or
4327 undefined behavior due to dereferencing a null pointer.  This option
4328 is only active when @option{-fdelete-null-pointer-checks} is active,
4329 which is enabled by optimizations in most targets.  The precision of
4330 the warnings depends on the optimization options used.
4332 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4333 @opindex Winit-self
4334 @opindex Wno-init-self
4335 Warn about uninitialized variables that are initialized with themselves.
4336 Note this option can only be used with the @option{-Wuninitialized} option.
4338 For example, GCC warns about @code{i} being uninitialized in the
4339 following snippet only when @option{-Winit-self} has been specified:
4340 @smallexample
4341 @group
4342 int f()
4344   int i = i;
4345   return i;
4347 @end group
4348 @end smallexample
4350 This warning is enabled by @option{-Wall} in C++.
4352 @item -Wimplicit-int @r{(C and Objective-C only)}
4353 @opindex Wimplicit-int
4354 @opindex Wno-implicit-int
4355 Warn when a declaration does not specify a type.
4356 This warning is enabled by @option{-Wall}.
4358 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4359 @opindex Wimplicit-function-declaration
4360 @opindex Wno-implicit-function-declaration
4361 Give a warning whenever a function is used before being declared. In
4362 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4363 enabled by default and it is made into an error by
4364 @option{-pedantic-errors}. This warning is also enabled by
4365 @option{-Wall}.
4367 @item -Wimplicit @r{(C and Objective-C only)}
4368 @opindex Wimplicit
4369 @opindex Wno-implicit
4370 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4371 This warning is enabled by @option{-Wall}.
4373 @item -Wimplicit-fallthrough
4374 @opindex Wimplicit-fallthrough
4375 @opindex Wno-implicit-fallthrough
4376 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4377 and @option{-Wno-implicit-fallthrough} is the same as
4378 @option{-Wimplicit-fallthrough=0}.
4380 @item -Wimplicit-fallthrough=@var{n}
4381 @opindex Wimplicit-fallthrough=
4382 Warn when a switch case falls through.  For example:
4384 @smallexample
4385 @group
4386 switch (cond)
4387   @{
4388   case 1:
4389     a = 1;
4390     break;
4391   case 2:
4392     a = 2;
4393   case 3:
4394     a = 3;
4395     break;
4396   @}
4397 @end group
4398 @end smallexample
4400 This warning does not warn when the last statement of a case cannot
4401 fall through, e.g. when there is a return statement or a call to function
4402 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4403 also takes into account control flow statements, such as ifs, and only
4404 warns when appropriate.  E.g.@:
4406 @smallexample
4407 @group
4408 switch (cond)
4409   @{
4410   case 1:
4411     if (i > 3) @{
4412       bar (5);
4413       break;
4414     @} else if (i < 1) @{
4415       bar (0);
4416     @} else
4417       return;
4418   default:
4419     @dots{}
4420   @}
4421 @end group
4422 @end smallexample
4424 Since there are occasions where a switch case fall through is desirable,
4425 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4426 to be used along with a null statement to suppress this warning that
4427 would normally occur:
4429 @smallexample
4430 @group
4431 switch (cond)
4432   @{
4433   case 1:
4434     bar (0);
4435     __attribute__ ((fallthrough));
4436   default:
4437     @dots{}
4438   @}
4439 @end group
4440 @end smallexample
4442 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4443 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4444 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4445 Instead of these attributes, it is also possible to add a fallthrough comment
4446 to silence the warning.  The whole body of the C or C++ style comment should
4447 match the given regular expressions listed below.  The option argument @var{n}
4448 specifies what kind of comments are accepted:
4450 @itemize @bullet
4452 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4454 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4455 expression, any comment is used as fallthrough comment.
4457 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4458 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4460 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4461 following regular expressions:
4463 @itemize @bullet
4465 @item @code{-fallthrough}
4467 @item @code{@@fallthrough@@}
4469 @item @code{lint -fallthrough[ \t]*}
4471 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4473 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4475 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4477 @end itemize
4479 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4480 following regular expressions:
4482 @itemize @bullet
4484 @item @code{-fallthrough}
4486 @item @code{@@fallthrough@@}
4488 @item @code{lint -fallthrough[ \t]*}
4490 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4492 @end itemize
4494 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4495 fallthrough comments, only attributes disable the warning.
4497 @end itemize
4499 The comment needs to be followed after optional whitespace and other comments
4500 by @code{case} or @code{default} keywords or by a user label that precedes some
4501 @code{case} or @code{default} label.
4503 @smallexample
4504 @group
4505 switch (cond)
4506   @{
4507   case 1:
4508     bar (0);
4509     /* FALLTHRU */
4510   default:
4511     @dots{}
4512   @}
4513 @end group
4514 @end smallexample
4516 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4518 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4519 @opindex Wif-not-aligned
4520 @opindex Wno-if-not-aligned
4521 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4522 should be issued.  This is is enabled by default.
4523 Use @option{-Wno-if-not-aligned} to disable it.
4525 @item -Wignored-qualifiers @r{(C and C++ only)}
4526 @opindex Wignored-qualifiers
4527 @opindex Wno-ignored-qualifiers
4528 Warn if the return type of a function has a type qualifier
4529 such as @code{const}.  For ISO C such a type qualifier has no effect,
4530 since the value returned by a function is not an lvalue.
4531 For C++, the warning is only emitted for scalar types or @code{void}.
4532 ISO C prohibits qualified @code{void} return types on function
4533 definitions, so such return types always receive a warning
4534 even without this option.
4536 This warning is also enabled by @option{-Wextra}.
4538 @item -Wignored-attributes @r{(C and C++ only)}
4539 @opindex Wignored-attributes
4540 @opindex Wno-ignored-attributes
4541 Warn when an attribute is ignored.  This is different from the
4542 @option{-Wattributes} option in that it warns whenever the compiler decides
4543 to drop an attribute, not that the attribute is either unknown, used in a
4544 wrong place, etc.  This warning is enabled by default.
4546 @item -Wmain
4547 @opindex Wmain
4548 @opindex Wno-main
4549 Warn if the type of @code{main} is suspicious.  @code{main} should be
4550 a function with external linkage, returning int, taking either zero
4551 arguments, two, or three arguments of appropriate types.  This warning
4552 is enabled by default in C++ and is enabled by either @option{-Wall}
4553 or @option{-Wpedantic}.
4555 @item -Wmisleading-indentation @r{(C and C++ only)}
4556 @opindex Wmisleading-indentation
4557 @opindex Wno-misleading-indentation
4558 Warn when the indentation of the code does not reflect the block structure.
4559 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4560 @code{for} clauses with a guarded statement that does not use braces,
4561 followed by an unguarded statement with the same indentation.
4563 In the following example, the call to ``bar'' is misleadingly indented as
4564 if it were guarded by the ``if'' conditional.
4566 @smallexample
4567   if (some_condition ())
4568     foo ();
4569     bar ();  /* Gotcha: this is not guarded by the "if".  */
4570 @end smallexample
4572 In the case of mixed tabs and spaces, the warning uses the
4573 @option{-ftabstop=} option to determine if the statements line up
4574 (defaulting to 8).
4576 The warning is not issued for code involving multiline preprocessor logic
4577 such as the following example.
4579 @smallexample
4580   if (flagA)
4581     foo (0);
4582 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4583   if (flagB)
4584 #endif
4585     foo (1);
4586 @end smallexample
4588 The warning is not issued after a @code{#line} directive, since this
4589 typically indicates autogenerated code, and no assumptions can be made
4590 about the layout of the file that the directive references.
4592 This warning is enabled by @option{-Wall} in C and C++.
4594 @item -Wmissing-braces
4595 @opindex Wmissing-braces
4596 @opindex Wno-missing-braces
4597 Warn if an aggregate or union initializer is not fully bracketed.  In
4598 the following example, the initializer for @code{a} is not fully
4599 bracketed, but that for @code{b} is fully bracketed.  This warning is
4600 enabled by @option{-Wall} in C.
4602 @smallexample
4603 int a[2][2] = @{ 0, 1, 2, 3 @};
4604 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4605 @end smallexample
4607 This warning is enabled by @option{-Wall}.
4609 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4610 @opindex Wmissing-include-dirs
4611 @opindex Wno-missing-include-dirs
4612 Warn if a user-supplied include directory does not exist.
4614 @item -Wmultistatement-macros
4615 @opindex Wmultistatement-macros
4616 @opindex Wno-multistatement-macros
4617 Warn about unsafe multiple statement macros that appear to be guarded
4618 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4619 @code{while}, in which only the first statement is actually guarded after
4620 the macro is expanded.
4622 For example:
4624 @smallexample
4625 #define DOIT x++; y++
4626 if (c)
4627   DOIT;
4628 @end smallexample
4630 will increment @code{y} unconditionally, not just when @code{c} holds.
4631 The can usually be fixed by wrapping the macro in a do-while loop:
4632 @smallexample
4633 #define DOIT do @{ x++; y++; @} while (0)
4634 if (c)
4635   DOIT;
4636 @end smallexample
4638 This warning is enabled by @option{-Wall} in C and C++.
4640 @item -Wparentheses
4641 @opindex Wparentheses
4642 @opindex Wno-parentheses
4643 Warn if parentheses are omitted in certain contexts, such
4644 as when there is an assignment in a context where a truth value
4645 is expected, or when operators are nested whose precedence people
4646 often get confused about.
4648 Also warn if a comparison like @code{x<=y<=z} appears; this is
4649 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4650 interpretation from that of ordinary mathematical notation.
4652 Also warn for dangerous uses of the GNU extension to
4653 @code{?:} with omitted middle operand. When the condition
4654 in the @code{?}: operator is a boolean expression, the omitted value is
4655 always 1.  Often programmers expect it to be a value computed
4656 inside the conditional expression instead.
4658 For C++ this also warns for some cases of unnecessary parentheses in
4659 declarations, which can indicate an attempt at a function call instead
4660 of a declaration:
4661 @smallexample
4663   // Declares a local variable called mymutex.
4664   std::unique_lock<std::mutex> (mymutex);
4665   // User meant std::unique_lock<std::mutex> lock (mymutex);
4667 @end smallexample
4669 This warning is enabled by @option{-Wall}.
4671 @item -Wsequence-point
4672 @opindex Wsequence-point
4673 @opindex Wno-sequence-point
4674 Warn about code that may have undefined semantics because of violations
4675 of sequence point rules in the C and C++ standards.
4677 The C and C++ standards define the order in which expressions in a C/C++
4678 program are evaluated in terms of @dfn{sequence points}, which represent
4679 a partial ordering between the execution of parts of the program: those
4680 executed before the sequence point, and those executed after it.  These
4681 occur after the evaluation of a full expression (one which is not part
4682 of a larger expression), after the evaluation of the first operand of a
4683 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4684 function is called (but after the evaluation of its arguments and the
4685 expression denoting the called function), and in certain other places.
4686 Other than as expressed by the sequence point rules, the order of
4687 evaluation of subexpressions of an expression is not specified.  All
4688 these rules describe only a partial order rather than a total order,
4689 since, for example, if two functions are called within one expression
4690 with no sequence point between them, the order in which the functions
4691 are called is not specified.  However, the standards committee have
4692 ruled that function calls do not overlap.
4694 It is not specified when between sequence points modifications to the
4695 values of objects take effect.  Programs whose behavior depends on this
4696 have undefined behavior; the C and C++ standards specify that ``Between
4697 the previous and next sequence point an object shall have its stored
4698 value modified at most once by the evaluation of an expression.
4699 Furthermore, the prior value shall be read only to determine the value
4700 to be stored.''.  If a program breaks these rules, the results on any
4701 particular implementation are entirely unpredictable.
4703 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4704 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4705 diagnosed by this option, and it may give an occasional false positive
4706 result, but in general it has been found fairly effective at detecting
4707 this sort of problem in programs.
4709 The C++17 standard will define the order of evaluation of operands in
4710 more cases: in particular it requires that the right-hand side of an
4711 assignment be evaluated before the left-hand side, so the above
4712 examples are no longer undefined.  But this warning will still warn
4713 about them, to help people avoid writing code that is undefined in C
4714 and earlier revisions of C++.
4716 The standard is worded confusingly, therefore there is some debate
4717 over the precise meaning of the sequence point rules in subtle cases.
4718 Links to discussions of the problem, including proposed formal
4719 definitions, may be found on the GCC readings page, at
4720 @uref{http://gcc.gnu.org/@/readings.html}.
4722 This warning is enabled by @option{-Wall} for C and C++.
4724 @item -Wno-return-local-addr
4725 @opindex Wno-return-local-addr
4726 @opindex Wreturn-local-addr
4727 Do not warn about returning a pointer (or in C++, a reference) to a
4728 variable that goes out of scope after the function returns.
4730 @item -Wreturn-type
4731 @opindex Wreturn-type
4732 @opindex Wno-return-type
4733 Warn whenever a function is defined with a return type that defaults
4734 to @code{int}.  Also warn about any @code{return} statement with no
4735 return value in a function whose return type is not @code{void}
4736 (falling off the end of the function body is considered returning
4737 without a value).
4739 For C only, warn about a @code{return} statement with an expression in a
4740 function whose return type is @code{void}, unless the expression type is
4741 also @code{void}.  As a GNU extension, the latter case is accepted
4742 without a warning unless @option{-Wpedantic} is used.
4744 For C++, a function without return type always produces a diagnostic
4745 message, even when @option{-Wno-return-type} is specified.  The only
4746 exceptions are @code{main} and functions defined in system headers.
4748 This warning is enabled by @option{-Wall}.
4750 @item -Wshift-count-negative
4751 @opindex Wshift-count-negative
4752 @opindex Wno-shift-count-negative
4753 Warn if shift count is negative. This warning is enabled by default.
4755 @item -Wshift-count-overflow
4756 @opindex Wshift-count-overflow
4757 @opindex Wno-shift-count-overflow
4758 Warn if shift count >= width of type. This warning is enabled by default.
4760 @item -Wshift-negative-value
4761 @opindex Wshift-negative-value
4762 @opindex Wno-shift-negative-value
4763 Warn if left shifting a negative value.  This warning is enabled by
4764 @option{-Wextra} in C99 and C++11 modes (and newer).
4766 @item -Wshift-overflow
4767 @itemx -Wshift-overflow=@var{n}
4768 @opindex Wshift-overflow
4769 @opindex Wno-shift-overflow
4770 Warn about left shift overflows.  This warning is enabled by
4771 default in C99 and C++11 modes (and newer).
4773 @table @gcctabopt
4774 @item -Wshift-overflow=1
4775 This is the warning level of @option{-Wshift-overflow} and is enabled
4776 by default in C99 and C++11 modes (and newer).  This warning level does
4777 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4778 an overflow is still rejected in contexts where an integer constant expression
4779 is required.)
4781 @item -Wshift-overflow=2
4782 This warning level also warns about left-shifting 1 into the sign bit,
4783 unless C++14 mode is active.
4784 @end table
4786 @item -Wswitch
4787 @opindex Wswitch
4788 @opindex Wno-switch
4789 Warn whenever a @code{switch} statement has an index of enumerated type
4790 and lacks a @code{case} for one or more of the named codes of that
4791 enumeration.  (The presence of a @code{default} label prevents this
4792 warning.)  @code{case} labels outside the enumeration range also
4793 provoke warnings when this option is used (even if there is a
4794 @code{default} label).
4795 This warning is enabled by @option{-Wall}.
4797 @item -Wswitch-default
4798 @opindex Wswitch-default
4799 @opindex Wno-switch-default
4800 Warn whenever a @code{switch} statement does not have a @code{default}
4801 case.
4803 @item -Wswitch-enum
4804 @opindex Wswitch-enum
4805 @opindex Wno-switch-enum
4806 Warn whenever a @code{switch} statement has an index of enumerated type
4807 and lacks a @code{case} for one or more of the named codes of that
4808 enumeration.  @code{case} labels outside the enumeration range also
4809 provoke warnings when this option is used.  The only difference
4810 between @option{-Wswitch} and this option is that this option gives a
4811 warning about an omitted enumeration code even if there is a
4812 @code{default} label.
4814 @item -Wswitch-bool
4815 @opindex Wswitch-bool
4816 @opindex Wno-switch-bool
4817 Warn whenever a @code{switch} statement has an index of boolean type
4818 and the case values are outside the range of a boolean type.
4819 It is possible to suppress this warning by casting the controlling
4820 expression to a type other than @code{bool}.  For example:
4821 @smallexample
4822 @group
4823 switch ((int) (a == 4))
4824   @{
4825   @dots{}
4826   @}
4827 @end group
4828 @end smallexample
4829 This warning is enabled by default for C and C++ programs.
4831 @item -Wswitch-unreachable
4832 @opindex Wswitch-unreachable
4833 @opindex Wno-switch-unreachable
4834 Warn whenever a @code{switch} statement contains statements between the
4835 controlling expression and the first case label, which will never be
4836 executed.  For example:
4837 @smallexample
4838 @group
4839 switch (cond)
4840   @{
4841    i = 15;
4842   @dots{}
4843    case 5:
4844   @dots{}
4845   @}
4846 @end group
4847 @end smallexample
4848 @option{-Wswitch-unreachable} does not warn if the statement between the
4849 controlling expression and the first case label is just a declaration:
4850 @smallexample
4851 @group
4852 switch (cond)
4853   @{
4854    int i;
4855   @dots{}
4856    case 5:
4857    i = 5;
4858   @dots{}
4859   @}
4860 @end group
4861 @end smallexample
4862 This warning is enabled by default for C and C++ programs.
4864 @item -Wsync-nand @r{(C and C++ only)}
4865 @opindex Wsync-nand
4866 @opindex Wno-sync-nand
4867 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4868 built-in functions are used.  These functions changed semantics in GCC 4.4.
4870 @item -Wunused-but-set-parameter
4871 @opindex Wunused-but-set-parameter
4872 @opindex Wno-unused-but-set-parameter
4873 Warn whenever a function parameter is assigned to, but otherwise unused
4874 (aside from its declaration).
4876 To suppress this warning use the @code{unused} attribute
4877 (@pxref{Variable Attributes}).
4879 This warning is also enabled by @option{-Wunused} together with
4880 @option{-Wextra}.
4882 @item -Wunused-but-set-variable
4883 @opindex Wunused-but-set-variable
4884 @opindex Wno-unused-but-set-variable
4885 Warn whenever a local variable is assigned to, but otherwise unused
4886 (aside from its declaration).
4887 This warning is enabled by @option{-Wall}.
4889 To suppress this warning use the @code{unused} attribute
4890 (@pxref{Variable Attributes}).
4892 This warning is also enabled by @option{-Wunused}, which is enabled
4893 by @option{-Wall}.
4895 @item -Wunused-function
4896 @opindex Wunused-function
4897 @opindex Wno-unused-function
4898 Warn whenever a static function is declared but not defined or a
4899 non-inline static function is unused.
4900 This warning is enabled by @option{-Wall}.
4902 @item -Wunused-label
4903 @opindex Wunused-label
4904 @opindex Wno-unused-label
4905 Warn whenever a label is declared but not used.
4906 This warning is enabled by @option{-Wall}.
4908 To suppress this warning use the @code{unused} attribute
4909 (@pxref{Variable Attributes}).
4911 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4912 @opindex Wunused-local-typedefs
4913 Warn when a typedef locally defined in a function is not used.
4914 This warning is enabled by @option{-Wall}.
4916 @item -Wunused-parameter
4917 @opindex Wunused-parameter
4918 @opindex Wno-unused-parameter
4919 Warn whenever a function parameter is unused aside from its declaration.
4921 To suppress this warning use the @code{unused} attribute
4922 (@pxref{Variable Attributes}).
4924 @item -Wno-unused-result
4925 @opindex Wunused-result
4926 @opindex Wno-unused-result
4927 Do not warn if a caller of a function marked with attribute
4928 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4929 its return value. The default is @option{-Wunused-result}.
4931 @item -Wunused-variable
4932 @opindex Wunused-variable
4933 @opindex Wno-unused-variable
4934 Warn whenever a local or static variable is unused aside from its
4935 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4936 but not for C++. This warning is enabled by @option{-Wall}.
4938 To suppress this warning use the @code{unused} attribute
4939 (@pxref{Variable Attributes}).
4941 @item -Wunused-const-variable
4942 @itemx -Wunused-const-variable=@var{n}
4943 @opindex Wunused-const-variable
4944 @opindex Wno-unused-const-variable
4945 Warn whenever a constant static variable is unused aside from its declaration.
4946 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4947 for C, but not for C++. In C this declares variable storage, but in C++ this
4948 is not an error since const variables take the place of @code{#define}s.
4950 To suppress this warning use the @code{unused} attribute
4951 (@pxref{Variable Attributes}).
4953 @table @gcctabopt
4954 @item -Wunused-const-variable=1
4955 This is the warning level that is enabled by @option{-Wunused-variable} for
4956 C.  It warns only about unused static const variables defined in the main
4957 compilation unit, but not about static const variables declared in any
4958 header included.
4960 @item -Wunused-const-variable=2
4961 This warning level also warns for unused constant static variables in
4962 headers (excluding system headers).  This is the warning level of
4963 @option{-Wunused-const-variable} and must be explicitly requested since
4964 in C++ this isn't an error and in C it might be harder to clean up all
4965 headers included.
4966 @end table
4968 @item -Wunused-value
4969 @opindex Wunused-value
4970 @opindex Wno-unused-value
4971 Warn whenever a statement computes a result that is explicitly not
4972 used. To suppress this warning cast the unused expression to
4973 @code{void}. This includes an expression-statement or the left-hand
4974 side of a comma expression that contains no side effects. For example,
4975 an expression such as @code{x[i,j]} causes a warning, while
4976 @code{x[(void)i,j]} does not.
4978 This warning is enabled by @option{-Wall}.
4980 @item -Wunused
4981 @opindex Wunused
4982 @opindex Wno-unused
4983 All the above @option{-Wunused} options combined.
4985 In order to get a warning about an unused function parameter, you must
4986 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4987 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4989 @item -Wuninitialized
4990 @opindex Wuninitialized
4991 @opindex Wno-uninitialized
4992 Warn if an automatic variable is used without first being initialized
4993 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4994 warn if a non-static reference or non-static @code{const} member
4995 appears in a class without constructors.
4997 If you want to warn about code that uses the uninitialized value of the
4998 variable in its own initializer, use the @option{-Winit-self} option.
5000 These warnings occur for individual uninitialized or clobbered
5001 elements of structure, union or array variables as well as for
5002 variables that are uninitialized or clobbered as a whole.  They do
5003 not occur for variables or elements declared @code{volatile}.  Because
5004 these warnings depend on optimization, the exact variables or elements
5005 for which there are warnings depends on the precise optimization
5006 options and version of GCC used.
5008 Note that there may be no warning about a variable that is used only
5009 to compute a value that itself is never used, because such
5010 computations may be deleted by data flow analysis before the warnings
5011 are printed.
5013 @item -Winvalid-memory-model
5014 @opindex Winvalid-memory-model
5015 @opindex Wno-invalid-memory-model
5016 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5017 and the C11 atomic generic functions with a memory consistency argument
5018 that is either invalid for the operation or outside the range of values
5019 of the @code{memory_order} enumeration.  For example, since the
5020 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5021 defined for the relaxed, release, and sequentially consistent memory
5022 orders the following code is diagnosed:
5024 @smallexample
5025 void store (int *i)
5027   __atomic_store_n (i, 0, memory_order_consume);
5029 @end smallexample
5031 @option{-Winvalid-memory-model} is enabled by default.
5033 @item -Wmaybe-uninitialized
5034 @opindex Wmaybe-uninitialized
5035 @opindex Wno-maybe-uninitialized
5036 For an automatic (i.e.@ local) variable, if there exists a path from the
5037 function entry to a use of the variable that is initialized, but there exist
5038 some other paths for which the variable is not initialized, the compiler
5039 emits a warning if it cannot prove the uninitialized paths are not
5040 executed at run time.
5042 These warnings are only possible in optimizing compilation, because otherwise
5043 GCC does not keep track of the state of variables.
5045 These warnings are made optional because GCC may not be able to determine when
5046 the code is correct in spite of appearing to have an error.  Here is one
5047 example of how this can happen:
5049 @smallexample
5050 @group
5052   int x;
5053   switch (y)
5054     @{
5055     case 1: x = 1;
5056       break;
5057     case 2: x = 4;
5058       break;
5059     case 3: x = 5;
5060     @}
5061   foo (x);
5063 @end group
5064 @end smallexample
5066 @noindent
5067 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5068 always initialized, but GCC doesn't know this. To suppress the
5069 warning, you need to provide a default case with assert(0) or
5070 similar code.
5072 @cindex @code{longjmp} warnings
5073 This option also warns when a non-volatile automatic variable might be
5074 changed by a call to @code{longjmp}.
5075 The compiler sees only the calls to @code{setjmp}.  It cannot know
5076 where @code{longjmp} will be called; in fact, a signal handler could
5077 call it at any point in the code.  As a result, you may get a warning
5078 even when there is in fact no problem because @code{longjmp} cannot
5079 in fact be called at the place that would cause a problem.
5081 Some spurious warnings can be avoided if you declare all the functions
5082 you use that never return as @code{noreturn}.  @xref{Function
5083 Attributes}.
5085 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5087 @item -Wunknown-pragmas
5088 @opindex Wunknown-pragmas
5089 @opindex Wno-unknown-pragmas
5090 @cindex warning for unknown pragmas
5091 @cindex unknown pragmas, warning
5092 @cindex pragmas, warning of unknown
5093 Warn when a @code{#pragma} directive is encountered that is not understood by 
5094 GCC@.  If this command-line option is used, warnings are even issued
5095 for unknown pragmas in system header files.  This is not the case if
5096 the warnings are only enabled by the @option{-Wall} command-line option.
5098 @item -Wno-pragmas
5099 @opindex Wno-pragmas
5100 @opindex Wpragmas
5101 Do not warn about misuses of pragmas, such as incorrect parameters,
5102 invalid syntax, or conflicts between pragmas.  See also
5103 @option{-Wunknown-pragmas}.
5105 @item -Wstrict-aliasing
5106 @opindex Wstrict-aliasing
5107 @opindex Wno-strict-aliasing
5108 This option is only active when @option{-fstrict-aliasing} is active.
5109 It warns about code that might break the strict aliasing rules that the
5110 compiler is using for optimization.  The warning does not catch all
5111 cases, but does attempt to catch the more common pitfalls.  It is
5112 included in @option{-Wall}.
5113 It is equivalent to @option{-Wstrict-aliasing=3}
5115 @item -Wstrict-aliasing=n
5116 @opindex Wstrict-aliasing=n
5117 This option is only active when @option{-fstrict-aliasing} is active.
5118 It warns about code that might break the strict aliasing rules that the
5119 compiler is using for optimization.
5120 Higher levels correspond to higher accuracy (fewer false positives).
5121 Higher levels also correspond to more effort, similar to the way @option{-O} 
5122 works.
5123 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5125 Level 1: Most aggressive, quick, least accurate.
5126 Possibly useful when higher levels
5127 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5128 false negatives.  However, it has many false positives.
5129 Warns for all pointer conversions between possibly incompatible types,
5130 even if never dereferenced.  Runs in the front end only.
5132 Level 2: Aggressive, quick, not too precise.
5133 May still have many false positives (not as many as level 1 though),
5134 and few false negatives (but possibly more than level 1).
5135 Unlike level 1, it only warns when an address is taken.  Warns about
5136 incomplete types.  Runs in the front end only.
5138 Level 3 (default for @option{-Wstrict-aliasing}):
5139 Should have very few false positives and few false
5140 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5141 Takes care of the common pun+dereference pattern in the front end:
5142 @code{*(int*)&some_float}.
5143 If optimization is enabled, it also runs in the back end, where it deals
5144 with multiple statement cases using flow-sensitive points-to information.
5145 Only warns when the converted pointer is dereferenced.
5146 Does not warn about incomplete types.
5148 @item -Wstrict-overflow
5149 @itemx -Wstrict-overflow=@var{n}
5150 @opindex Wstrict-overflow
5151 @opindex Wno-strict-overflow
5152 This option is only active when signed overflow is undefined.
5153 It warns about cases where the compiler optimizes based on the
5154 assumption that signed overflow does not occur.  Note that it does not
5155 warn about all cases where the code might overflow: it only warns
5156 about cases where the compiler implements some optimization.  Thus
5157 this warning depends on the optimization level.
5159 An optimization that assumes that signed overflow does not occur is
5160 perfectly safe if the values of the variables involved are such that
5161 overflow never does, in fact, occur.  Therefore this warning can
5162 easily give a false positive: a warning about code that is not
5163 actually a problem.  To help focus on important issues, several
5164 warning levels are defined.  No warnings are issued for the use of
5165 undefined signed overflow when estimating how many iterations a loop
5166 requires, in particular when determining whether a loop will be
5167 executed at all.
5169 @table @gcctabopt
5170 @item -Wstrict-overflow=1
5171 Warn about cases that are both questionable and easy to avoid.  For
5172 example the compiler simplifies
5173 @code{x + 1 > x} to @code{1}.  This level of
5174 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5175 are not, and must be explicitly requested.
5177 @item -Wstrict-overflow=2
5178 Also warn about other cases where a comparison is simplified to a
5179 constant.  For example: @code{abs (x) >= 0}.  This can only be
5180 simplified when signed integer overflow is undefined, because
5181 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5182 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5183 @option{-Wstrict-overflow=2}.
5185 @item -Wstrict-overflow=3
5186 Also warn about other cases where a comparison is simplified.  For
5187 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5189 @item -Wstrict-overflow=4
5190 Also warn about other simplifications not covered by the above cases.
5191 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5193 @item -Wstrict-overflow=5
5194 Also warn about cases where the compiler reduces the magnitude of a
5195 constant involved in a comparison.  For example: @code{x + 2 > y} is
5196 simplified to @code{x + 1 >= y}.  This is reported only at the
5197 highest warning level because this simplification applies to many
5198 comparisons, so this warning level gives a very large number of
5199 false positives.
5200 @end table
5202 @item -Wstringop-overflow
5203 @itemx -Wstringop-overflow=@var{type}
5204 @opindex Wstringop-overflow
5205 @opindex Wno-stringop-overflow
5206 Warn for calls to string manipulation functions such as @code{memcpy} and
5207 @code{strcpy} that are determined to overflow the destination buffer.  The
5208 optional argument is one greater than the type of Object Size Checking to
5209 perform to determine the size of the destination.  @xref{Object Size Checking}.
5210 The argument is meaningful only for functions that operate on character arrays
5211 but not for raw memory functions like @code{memcpy} which always make use
5212 of Object Size type-0.  The option also warns for calls that specify a size
5213 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5214 The option produces the best results with optimization enabled but can detect
5215 a small subset of simple buffer overflows even without optimization in
5216 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5217 correspond to the standard functions.  In any case, the option warns about
5218 just a subset of buffer overflows detected by the corresponding overflow
5219 checking built-ins.  For example, the option will issue a warning for
5220 the @code{strcpy} call below because it copies at least 5 characters
5221 (the string @code{"blue"} including the terminating NUL) into the buffer
5222 of size 4.
5224 @smallexample
5225 enum Color @{ blue, purple, yellow @};
5226 const char* f (enum Color clr)
5228   static char buf [4];
5229   const char *str;
5230   switch (clr)
5231     @{
5232       case blue: str = "blue"; break;
5233       case purple: str = "purple"; break;
5234       case yellow: str = "yellow"; break;
5235     @}
5237   return strcpy (buf, str);   // warning here
5239 @end smallexample
5241 Option @option{-Wstringop-overflow=2} is enabled by default.
5243 @table @gcctabopt
5244 @item -Wstringop-overflow
5245 @itemx -Wstringop-overflow=1
5246 @opindex Wstringop-overflow
5247 @opindex Wno-stringop-overflow
5248 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5249 to determine the sizes of destination objects.  This is the default setting
5250 of the option.  At this setting the option will not warn for writes past
5251 the end of subobjects of larger objects accessed by pointers unless the
5252 size of the largest surrounding object is known.  When the destination may
5253 be one of several objects it is assumed to be the largest one of them.  On
5254 Linux systems, when optimization is enabled at this setting the option warns
5255 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5256 a non-zero value.
5258 @item -Wstringop-overflow=2
5259 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5260 to determine the sizes of destination objects.  At this setting the option
5261 will warn about overflows when writing to members of the largest complete
5262 objects whose exact size is known.  It will, however, not warn for excessive
5263 writes to the same members of unknown objects referenced by pointers since
5264 they may point to arrays containing unknown numbers of elements.
5266 @item -Wstringop-overflow=3
5267 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5268 to determine the sizes of destination objects.  At this setting the option
5269 warns about overflowing the smallest object or data member.  This is the
5270 most restrictive setting of the option that may result in warnings for safe
5271 code.
5273 @item -Wstringop-overflow=4
5274 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5275 to determine the sizes of destination objects.  At this setting the option
5276 will warn about overflowing any data members, and when the destination is
5277 one of several objects it uses the size of the largest of them to decide
5278 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5279 setting of the option may result in warnings for benign code.
5280 @end table
5282 @item -Wstringop-truncation
5283 @opindex Wstringop-truncation
5284 @opindex Wno-stringop-truncation
5285 Warn for calls to bounded string manipulation functions such as @code{strncat},
5286 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5287 or leave the destination unchanged.
5289 In the following example, the call to @code{strncat} specifies a bound that
5290 is less than the length of the source string.  As a result, the copy of
5291 the source will be truncated and so the call is diagnosed.  To avoid the
5292 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5294 @smallexample
5295 void append (char *buf, size_t bufsize)
5297   strncat (buf, ".txt", 3);
5299 @end smallexample
5301 As another example, the following call to @code{strncpy} results in copying
5302 to @code{d} just the characters preceding the terminating NUL, without
5303 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5304 necessarily a NUL-terminated string is a common mistake, and so the call
5305 is diagnosed.  To avoid the warning when the result is not expected to be
5306 NUL-terminated, call @code{memcpy} instead.
5308 @smallexample
5309 void copy (char *d, const char *s)
5311   strncpy (d, s, strlen (s));
5313 @end smallexample
5315 In the following example, the call to @code{strncpy} specifies the size
5316 of the destination buffer as the bound.  If the length of the source
5317 string is equal to or greater than this size the result of the copy will
5318 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5319 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5320 element of the buffer to @code{NUL}.
5322 @smallexample
5323 void copy (const char *s)
5325   char buf[80];
5326   strncpy (buf, s, sizeof buf);
5327   @dots{}
5329 @end smallexample
5331 In situations where a character array is intended to store a sequence
5332 of bytes with no terminating @code{NUL} such an array may be annotated
5333 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5334 however, are not suitable arguments to functions that expect
5335 @code{NUL}-terminated strings.  To help detect accidental misuses of
5336 such arrays GCC issues warnings unless it can prove that the use is
5337 safe.  @xref{Common Variable Attributes}.
5339 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5340 @opindex Wsuggest-attribute=
5341 @opindex Wno-suggest-attribute=
5342 Warn for cases where adding an attribute may be beneficial. The
5343 attributes currently supported are listed below.
5345 @table @gcctabopt
5346 @item -Wsuggest-attribute=pure
5347 @itemx -Wsuggest-attribute=const
5348 @itemx -Wsuggest-attribute=noreturn
5349 @itemx -Wsuggest-attribute=malloc
5350 @opindex Wsuggest-attribute=pure
5351 @opindex Wno-suggest-attribute=pure
5352 @opindex Wsuggest-attribute=const
5353 @opindex Wno-suggest-attribute=const
5354 @opindex Wsuggest-attribute=noreturn
5355 @opindex Wno-suggest-attribute=noreturn
5356 @opindex Wsuggest-attribute=malloc
5357 @opindex Wno-suggest-attribute=malloc
5359 Warn about functions that might be candidates for attributes
5360 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5361 only warns for functions visible in other compilation units or (in the case of
5362 @code{pure} and @code{const}) if it cannot prove that the function returns
5363 normally. A function returns normally if it doesn't contain an infinite loop or
5364 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5365 requires option @option{-fipa-pure-const}, which is enabled by default at
5366 @option{-O} and higher.  Higher optimization levels improve the accuracy
5367 of the analysis.
5369 @item -Wsuggest-attribute=format
5370 @itemx -Wmissing-format-attribute
5371 @opindex Wsuggest-attribute=format
5372 @opindex Wmissing-format-attribute
5373 @opindex Wno-suggest-attribute=format
5374 @opindex Wno-missing-format-attribute
5375 @opindex Wformat
5376 @opindex Wno-format
5378 Warn about function pointers that might be candidates for @code{format}
5379 attributes.  Note these are only possible candidates, not absolute ones.
5380 GCC guesses that function pointers with @code{format} attributes that
5381 are used in assignment, initialization, parameter passing or return
5382 statements should have a corresponding @code{format} attribute in the
5383 resulting type.  I.e.@: the left-hand side of the assignment or
5384 initialization, the type of the parameter variable, or the return type
5385 of the containing function respectively should also have a @code{format}
5386 attribute to avoid the warning.
5388 GCC also warns about function definitions that might be
5389 candidates for @code{format} attributes.  Again, these are only
5390 possible candidates.  GCC guesses that @code{format} attributes
5391 might be appropriate for any function that calls a function like
5392 @code{vprintf} or @code{vscanf}, but this might not always be the
5393 case, and some functions for which @code{format} attributes are
5394 appropriate may not be detected.
5396 @item -Wsuggest-attribute=cold
5397 @opindex Wsuggest-attribute=cold
5398 @opindex Wno-suggest-attribute=cold
5400 Warn about functions that might be candidates for @code{cold} attribute.  This
5401 is based on static detection and generally will only warn about functions which
5402 always leads to a call to another @code{cold} function such as wrappers of
5403 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5404 @end table
5406 @item -Wsuggest-final-types
5407 @opindex Wno-suggest-final-types
5408 @opindex Wsuggest-final-types
5409 Warn about types with virtual methods where code quality would be improved
5410 if the type were declared with the C++11 @code{final} specifier, 
5411 or, if possible,
5412 declared in an anonymous namespace. This allows GCC to more aggressively
5413 devirtualize the polymorphic calls. This warning is more effective with link
5414 time optimization, where the information about the class hierarchy graph is
5415 more complete.
5417 @item -Wsuggest-final-methods
5418 @opindex Wno-suggest-final-methods
5419 @opindex Wsuggest-final-methods
5420 Warn about virtual methods where code quality would be improved if the method
5421 were declared with the C++11 @code{final} specifier, 
5422 or, if possible, its type were
5423 declared in an anonymous namespace or with the @code{final} specifier.
5424 This warning is
5425 more effective with link-time optimization, where the information about the
5426 class hierarchy graph is more complete. It is recommended to first consider
5427 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5428 annotations.
5430 @item -Wsuggest-override
5431 Warn about overriding virtual functions that are not marked with the override
5432 keyword.
5434 @item -Walloc-zero
5435 @opindex Wno-alloc-zero
5436 @opindex Walloc-zero
5437 Warn about calls to allocation functions decorated with attribute
5438 @code{alloc_size} that specify zero bytes, including those to the built-in
5439 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5440 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5441 when called with a zero size differs among implementations (and in the case
5442 of @code{realloc} has been deprecated) relying on it may result in subtle
5443 portability bugs and should be avoided.
5445 @item -Walloc-size-larger-than=@var{n}
5446 Warn about calls to functions decorated with attribute @code{alloc_size}
5447 that attempt to allocate objects larger than the specified number of bytes,
5448 or where the result of the size computation in an integer type with infinite
5449 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5450 may end in one of the standard suffixes designating a multiple of bytes
5451 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5452 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5453 @xref{Function Attributes}.
5455 @item -Walloca
5456 @opindex Wno-alloca
5457 @opindex Walloca
5458 This option warns on all uses of @code{alloca} in the source.
5460 @item -Walloca-larger-than=@var{n}
5461 This option warns on calls to @code{alloca} that are not bounded by a
5462 controlling predicate limiting its argument of integer type to at most
5463 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5464 Arguments of non-integer types are considered unbounded even if they
5465 appear to be constrained to the expected range.
5467 For example, a bounded case of @code{alloca} could be:
5469 @smallexample
5470 void func (size_t n)
5472   void *p;
5473   if (n <= 1000)
5474     p = alloca (n);
5475   else
5476     p = malloc (n);
5477   f (p);
5479 @end smallexample
5481 In the above example, passing @code{-Walloca-larger-than=1000} would not
5482 issue a warning because the call to @code{alloca} is known to be at most
5483 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5484 the compiler would emit a warning.
5486 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5487 controlling predicate constraining its integer argument.  For example:
5489 @smallexample
5490 void func ()
5492   void *p = alloca (n);
5493   f (p);
5495 @end smallexample
5497 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5498 a warning, but this time because of the lack of bounds checking.
5500 Note, that even seemingly correct code involving signed integers could
5501 cause a warning:
5503 @smallexample
5504 void func (signed int n)
5506   if (n < 500)
5507     @{
5508       p = alloca (n);
5509       f (p);
5510     @}
5512 @end smallexample
5514 In the above example, @var{n} could be negative, causing a larger than
5515 expected argument to be implicitly cast into the @code{alloca} call.
5517 This option also warns when @code{alloca} is used in a loop.
5519 This warning is not enabled by @option{-Wall}, and is only active when
5520 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5522 See also @option{-Wvla-larger-than=@var{n}}.
5524 @item -Warray-bounds
5525 @itemx -Warray-bounds=@var{n}
5526 @opindex Wno-array-bounds
5527 @opindex Warray-bounds
5528 This option is only active when @option{-ftree-vrp} is active
5529 (default for @option{-O2} and above). It warns about subscripts to arrays
5530 that are always out of bounds. This warning is enabled by @option{-Wall}.
5532 @table @gcctabopt
5533 @item -Warray-bounds=1
5534 This is the warning level of @option{-Warray-bounds} and is enabled
5535 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5537 @item -Warray-bounds=2
5538 This warning level also warns about out of bounds access for
5539 arrays at the end of a struct and for arrays accessed through
5540 pointers. This warning level may give a larger number of
5541 false positives and is deactivated by default.
5542 @end table
5544 @item -Wattribute-alias
5545 Warn about declarations using the @code{alias} and similar attributes whose
5546 target is incompatible with the type of the alias.  @xref{Function Attributes,
5547 ,Declaring Attributes of Functions}.
5549 @item -Wbool-compare
5550 @opindex Wno-bool-compare
5551 @opindex Wbool-compare
5552 Warn about boolean expression compared with an integer value different from
5553 @code{true}/@code{false}.  For instance, the following comparison is
5554 always false:
5555 @smallexample
5556 int n = 5;
5557 @dots{}
5558 if ((n > 1) == 2) @{ @dots{} @}
5559 @end smallexample
5560 This warning is enabled by @option{-Wall}.
5562 @item -Wbool-operation
5563 @opindex Wno-bool-operation
5564 @opindex Wbool-operation
5565 Warn about suspicious operations on expressions of a boolean type.  For
5566 instance, bitwise negation of a boolean is very likely a bug in the program.
5567 For C, this warning also warns about incrementing or decrementing a boolean,
5568 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5569 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5571 This warning is enabled by @option{-Wall}.
5573 @item -Wduplicated-branches
5574 @opindex Wno-duplicated-branches
5575 @opindex Wduplicated-branches
5576 Warn when an if-else has identical branches.  This warning detects cases like
5577 @smallexample
5578 if (p != NULL)
5579   return 0;
5580 else
5581   return 0;
5582 @end smallexample
5583 It doesn't warn when both branches contain just a null statement.  This warning
5584 also warn for conditional operators:
5585 @smallexample
5586   int i = x ? *p : *p;
5587 @end smallexample
5589 @item -Wduplicated-cond
5590 @opindex Wno-duplicated-cond
5591 @opindex Wduplicated-cond
5592 Warn about duplicated conditions in an if-else-if chain.  For instance,
5593 warn for the following code:
5594 @smallexample
5595 if (p->q != NULL) @{ @dots{} @}
5596 else if (p->q != NULL) @{ @dots{} @}
5597 @end smallexample
5599 @item -Wframe-address
5600 @opindex Wno-frame-address
5601 @opindex Wframe-address
5602 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5603 is called with an argument greater than 0.  Such calls may return indeterminate
5604 values or crash the program.  The warning is included in @option{-Wall}.
5606 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5607 @opindex Wno-discarded-qualifiers
5608 @opindex Wdiscarded-qualifiers
5609 Do not warn if type qualifiers on pointers are being discarded.
5610 Typically, the compiler warns if a @code{const char *} variable is
5611 passed to a function that takes a @code{char *} parameter.  This option
5612 can be used to suppress such a warning.
5614 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5615 @opindex Wno-discarded-array-qualifiers
5616 @opindex Wdiscarded-array-qualifiers
5617 Do not warn if type qualifiers on arrays which are pointer targets
5618 are being discarded. Typically, the compiler warns if a
5619 @code{const int (*)[]} variable is passed to a function that
5620 takes a @code{int (*)[]} parameter.  This option can be used to
5621 suppress such a warning.
5623 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5624 @opindex Wno-incompatible-pointer-types
5625 @opindex Wincompatible-pointer-types
5626 Do not warn when there is a conversion between pointers that have incompatible
5627 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5628 which warns for pointer argument passing or assignment with different
5629 signedness.
5631 @item -Wno-int-conversion @r{(C and Objective-C only)}
5632 @opindex Wno-int-conversion
5633 @opindex Wint-conversion
5634 Do not warn about incompatible integer to pointer and pointer to integer
5635 conversions.  This warning is about implicit conversions; for explicit
5636 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5637 @option{-Wno-pointer-to-int-cast} may be used.
5639 @item -Wno-div-by-zero
5640 @opindex Wno-div-by-zero
5641 @opindex Wdiv-by-zero
5642 Do not warn about compile-time integer division by zero.  Floating-point
5643 division by zero is not warned about, as it can be a legitimate way of
5644 obtaining infinities and NaNs.
5646 @item -Wsystem-headers
5647 @opindex Wsystem-headers
5648 @opindex Wno-system-headers
5649 @cindex warnings from system headers
5650 @cindex system headers, warnings from
5651 Print warning messages for constructs found in system header files.
5652 Warnings from system headers are normally suppressed, on the assumption
5653 that they usually do not indicate real problems and would only make the
5654 compiler output harder to read.  Using this command-line option tells
5655 GCC to emit warnings from system headers as if they occurred in user
5656 code.  However, note that using @option{-Wall} in conjunction with this
5657 option does @emph{not} warn about unknown pragmas in system
5658 headers---for that, @option{-Wunknown-pragmas} must also be used.
5660 @item -Wtautological-compare
5661 @opindex Wtautological-compare
5662 @opindex Wno-tautological-compare
5663 Warn if a self-comparison always evaluates to true or false.  This
5664 warning detects various mistakes such as:
5665 @smallexample
5666 int i = 1;
5667 @dots{}
5668 if (i > i) @{ @dots{} @}
5669 @end smallexample
5671 This warning also warns about bitwise comparisons that always evaluate
5672 to true or false, for instance:
5673 @smallexample
5674 if ((a & 16) == 10) @{ @dots{} @}
5675 @end smallexample
5676 will always be false.
5678 This warning is enabled by @option{-Wall}.
5680 @item -Wtrampolines
5681 @opindex Wtrampolines
5682 @opindex Wno-trampolines
5683 Warn about trampolines generated for pointers to nested functions.
5684 A trampoline is a small piece of data or code that is created at run
5685 time on the stack when the address of a nested function is taken, and is
5686 used to call the nested function indirectly.  For some targets, it is
5687 made up of data only and thus requires no special treatment.  But, for
5688 most targets, it is made up of code and thus requires the stack to be
5689 made executable in order for the program to work properly.
5691 @item -Wfloat-equal
5692 @opindex Wfloat-equal
5693 @opindex Wno-float-equal
5694 Warn if floating-point values are used in equality comparisons.
5696 The idea behind this is that sometimes it is convenient (for the
5697 programmer) to consider floating-point values as approximations to
5698 infinitely precise real numbers.  If you are doing this, then you need
5699 to compute (by analyzing the code, or in some other way) the maximum or
5700 likely maximum error that the computation introduces, and allow for it
5701 when performing comparisons (and when producing output, but that's a
5702 different problem).  In particular, instead of testing for equality, you
5703 should check to see whether the two values have ranges that overlap; and
5704 this is done with the relational operators, so equality comparisons are
5705 probably mistaken.
5707 @item -Wtraditional @r{(C and Objective-C only)}
5708 @opindex Wtraditional
5709 @opindex Wno-traditional
5710 Warn about certain constructs that behave differently in traditional and
5711 ISO C@.  Also warn about ISO C constructs that have no traditional C
5712 equivalent, and/or problematic constructs that should be avoided.
5714 @itemize @bullet
5715 @item
5716 Macro parameters that appear within string literals in the macro body.
5717 In traditional C macro replacement takes place within string literals,
5718 but in ISO C it does not.
5720 @item
5721 In traditional C, some preprocessor directives did not exist.
5722 Traditional preprocessors only considered a line to be a directive
5723 if the @samp{#} appeared in column 1 on the line.  Therefore
5724 @option{-Wtraditional} warns about directives that traditional C
5725 understands but ignores because the @samp{#} does not appear as the
5726 first character on the line.  It also suggests you hide directives like
5727 @code{#pragma} not understood by traditional C by indenting them.  Some
5728 traditional implementations do not recognize @code{#elif}, so this option
5729 suggests avoiding it altogether.
5731 @item
5732 A function-like macro that appears without arguments.
5734 @item
5735 The unary plus operator.
5737 @item
5738 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5739 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5740 constants.)  Note, these suffixes appear in macros defined in the system
5741 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5742 Use of these macros in user code might normally lead to spurious
5743 warnings, however GCC's integrated preprocessor has enough context to
5744 avoid warning in these cases.
5746 @item
5747 A function declared external in one block and then used after the end of
5748 the block.
5750 @item
5751 A @code{switch} statement has an operand of type @code{long}.
5753 @item
5754 A non-@code{static} function declaration follows a @code{static} one.
5755 This construct is not accepted by some traditional C compilers.
5757 @item
5758 The ISO type of an integer constant has a different width or
5759 signedness from its traditional type.  This warning is only issued if
5760 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5761 typically represent bit patterns, are not warned about.
5763 @item
5764 Usage of ISO string concatenation is detected.
5766 @item
5767 Initialization of automatic aggregates.
5769 @item
5770 Identifier conflicts with labels.  Traditional C lacks a separate
5771 namespace for labels.
5773 @item
5774 Initialization of unions.  If the initializer is zero, the warning is
5775 omitted.  This is done under the assumption that the zero initializer in
5776 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5777 initializer warnings and relies on default initialization to zero in the
5778 traditional C case.
5780 @item
5781 Conversions by prototypes between fixed/floating-point values and vice
5782 versa.  The absence of these prototypes when compiling with traditional
5783 C causes serious problems.  This is a subset of the possible
5784 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5786 @item
5787 Use of ISO C style function definitions.  This warning intentionally is
5788 @emph{not} issued for prototype declarations or variadic functions
5789 because these ISO C features appear in your code when using
5790 libiberty's traditional C compatibility macros, @code{PARAMS} and
5791 @code{VPARAMS}.  This warning is also bypassed for nested functions
5792 because that feature is already a GCC extension and thus not relevant to
5793 traditional C compatibility.
5794 @end itemize
5796 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5797 @opindex Wtraditional-conversion
5798 @opindex Wno-traditional-conversion
5799 Warn if a prototype causes a type conversion that is different from what
5800 would happen to the same argument in the absence of a prototype.  This
5801 includes conversions of fixed point to floating and vice versa, and
5802 conversions changing the width or signedness of a fixed-point argument
5803 except when the same as the default promotion.
5805 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5806 @opindex Wdeclaration-after-statement
5807 @opindex Wno-declaration-after-statement
5808 Warn when a declaration is found after a statement in a block.  This
5809 construct, known from C++, was introduced with ISO C99 and is by default
5810 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5812 @item -Wshadow
5813 @opindex Wshadow
5814 @opindex Wno-shadow
5815 Warn whenever a local variable or type declaration shadows another
5816 variable, parameter, type, class member (in C++), or instance variable
5817 (in Objective-C) or whenever a built-in function is shadowed. Note
5818 that in C++, the compiler warns if a local variable shadows an
5819 explicit typedef, but not if it shadows a struct/class/enum.
5820 Same as @option{-Wshadow=global}.
5822 @item -Wno-shadow-ivar @r{(Objective-C only)}
5823 @opindex Wno-shadow-ivar
5824 @opindex Wshadow-ivar
5825 Do not warn whenever a local variable shadows an instance variable in an
5826 Objective-C method.
5828 @item -Wshadow=global
5829 @opindex Wshadow=local
5830 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5832 @item -Wshadow=local
5833 @opindex Wshadow=local
5834 Warn when a local variable shadows another local variable or parameter.
5835 This warning is enabled by @option{-Wshadow=global}.
5837 @item -Wshadow=compatible-local
5838 @opindex Wshadow=compatible-local
5839 Warn when a local variable shadows another local variable or parameter
5840 whose type is compatible with that of the shadowing variable. In C++,
5841 type compatibility here means the type of the shadowing variable can be
5842 converted to that of the shadowed variable. The creation of this flag
5843 (in addition to @option{-Wshadow=local}) is based on the idea that when
5844 a local variable shadows another one of incompatible type, it is most
5845 likely intentional, not a bug or typo, as shown in the following example:
5847 @smallexample
5848 @group
5849 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5851   for (int i = 0; i < N; ++i)
5852   @{
5853     ...
5854   @}
5855   ...
5857 @end group
5858 @end smallexample
5860 Since the two variable @code{i} in the example above have incompatible types,
5861 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5862 Because their types are incompatible, if a programmer accidentally uses one
5863 in place of the other, type checking will catch that and emit an error or
5864 warning. So not warning (about shadowing) in this case will not lead to
5865 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5866 possibly reduce the number of warnings triggered by intentional shadowing.
5868 This warning is enabled by @option{-Wshadow=local}.
5870 @item -Wlarger-than=@var{len}
5871 @opindex Wlarger-than=@var{len}
5872 @opindex Wlarger-than-@var{len}
5873 Warn whenever an object of larger than @var{len} bytes is defined.
5875 @item -Wframe-larger-than=@var{len}
5876 @opindex Wframe-larger-than
5877 Warn if the size of a function frame is larger than @var{len} bytes.
5878 The computation done to determine the stack frame size is approximate
5879 and not conservative.
5880 The actual requirements may be somewhat greater than @var{len}
5881 even if you do not get a warning.  In addition, any space allocated
5882 via @code{alloca}, variable-length arrays, or related constructs
5883 is not included by the compiler when determining
5884 whether or not to issue a warning.
5886 @item -Wno-free-nonheap-object
5887 @opindex Wno-free-nonheap-object
5888 @opindex Wfree-nonheap-object
5889 Do not warn when attempting to free an object that was not allocated
5890 on the heap.
5892 @item -Wstack-usage=@var{len}
5893 @opindex Wstack-usage
5894 Warn if the stack usage of a function might be larger than @var{len} bytes.
5895 The computation done to determine the stack usage is conservative.
5896 Any space allocated via @code{alloca}, variable-length arrays, or related
5897 constructs is included by the compiler when determining whether or not to
5898 issue a warning.
5900 The message is in keeping with the output of @option{-fstack-usage}.
5902 @itemize
5903 @item
5904 If the stack usage is fully static but exceeds the specified amount, it's:
5906 @smallexample
5907   warning: stack usage is 1120 bytes
5908 @end smallexample
5909 @item
5910 If the stack usage is (partly) dynamic but bounded, it's:
5912 @smallexample
5913   warning: stack usage might be 1648 bytes
5914 @end smallexample
5915 @item
5916 If the stack usage is (partly) dynamic and not bounded, it's:
5918 @smallexample
5919   warning: stack usage might be unbounded
5920 @end smallexample
5921 @end itemize
5923 @item -Wunsafe-loop-optimizations
5924 @opindex Wunsafe-loop-optimizations
5925 @opindex Wno-unsafe-loop-optimizations
5926 Warn if the loop cannot be optimized because the compiler cannot
5927 assume anything on the bounds of the loop indices.  With
5928 @option{-funsafe-loop-optimizations} warn if the compiler makes
5929 such assumptions.
5931 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5932 @opindex Wno-pedantic-ms-format
5933 @opindex Wpedantic-ms-format
5934 When used in combination with @option{-Wformat}
5935 and @option{-pedantic} without GNU extensions, this option
5936 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5937 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5938 which depend on the MS runtime.
5940 @item -Waligned-new
5941 @opindex Waligned-new
5942 @opindex Wno-aligned-new
5943 Warn about a new-expression of a type that requires greater alignment
5944 than the @code{alignof(std::max_align_t)} but uses an allocation
5945 function without an explicit alignment parameter. This option is
5946 enabled by @option{-Wall}.
5948 Normally this only warns about global allocation functions, but
5949 @option{-Waligned-new=all} also warns about class member allocation
5950 functions.
5952 @item -Wplacement-new
5953 @itemx -Wplacement-new=@var{n}
5954 @opindex Wplacement-new
5955 @opindex Wno-placement-new
5956 Warn about placement new expressions with undefined behavior, such as
5957 constructing an object in a buffer that is smaller than the type of
5958 the object.  For example, the placement new expression below is diagnosed
5959 because it attempts to construct an array of 64 integers in a buffer only
5960 64 bytes large.
5961 @smallexample
5962 char buf [64];
5963 new (buf) int[64];
5964 @end smallexample
5965 This warning is enabled by default.
5967 @table @gcctabopt
5968 @item -Wplacement-new=1
5969 This is the default warning level of @option{-Wplacement-new}.  At this
5970 level the warning is not issued for some strictly undefined constructs that
5971 GCC allows as extensions for compatibility with legacy code.  For example,
5972 the following @code{new} expression is not diagnosed at this level even
5973 though it has undefined behavior according to the C++ standard because
5974 it writes past the end of the one-element array.
5975 @smallexample
5976 struct S @{ int n, a[1]; @};
5977 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5978 new (s->a)int [32]();
5979 @end smallexample
5981 @item -Wplacement-new=2
5982 At this level, in addition to diagnosing all the same constructs as at level
5983 1, a diagnostic is also issued for placement new expressions that construct
5984 an object in the last member of structure whose type is an array of a single
5985 element and whose size is less than the size of the object being constructed.
5986 While the previous example would be diagnosed, the following construct makes
5987 use of the flexible member array extension to avoid the warning at level 2.
5988 @smallexample
5989 struct S @{ int n, a[]; @};
5990 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5991 new (s->a)int [32]();
5992 @end smallexample
5994 @end table
5996 @item -Wpointer-arith
5997 @opindex Wpointer-arith
5998 @opindex Wno-pointer-arith
5999 Warn about anything that depends on the ``size of'' a function type or
6000 of @code{void}.  GNU C assigns these types a size of 1, for
6001 convenience in calculations with @code{void *} pointers and pointers
6002 to functions.  In C++, warn also when an arithmetic operation involves
6003 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6005 @item -Wpointer-compare
6006 @opindex Wpointer-compare
6007 @opindex Wno-pointer-compare
6008 Warn if a pointer is compared with a zero character constant.  This usually
6009 means that the pointer was meant to be dereferenced.  For example:
6011 @smallexample
6012 const char *p = foo ();
6013 if (p == '\0')
6014   return 42;
6015 @end smallexample
6017 Note that the code above is invalid in C++11.
6019 This warning is enabled by default.
6021 @item -Wtype-limits
6022 @opindex Wtype-limits
6023 @opindex Wno-type-limits
6024 Warn if a comparison is always true or always false due to the limited
6025 range of the data type, but do not warn for constant expressions.  For
6026 example, warn if an unsigned variable is compared against zero with
6027 @code{<} or @code{>=}.  This warning is also enabled by
6028 @option{-Wextra}.
6030 @include cppwarnopts.texi
6032 @item -Wbad-function-cast @r{(C and Objective-C only)}
6033 @opindex Wbad-function-cast
6034 @opindex Wno-bad-function-cast
6035 Warn when a function call is cast to a non-matching type.
6036 For example, warn if a call to a function returning an integer type 
6037 is cast to a pointer type.
6039 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6040 @opindex Wc90-c99-compat
6041 @opindex Wno-c90-c99-compat
6042 Warn about features not present in ISO C90, but present in ISO C99.
6043 For instance, warn about use of variable length arrays, @code{long long}
6044 type, @code{bool} type, compound literals, designated initializers, and so
6045 on.  This option is independent of the standards mode.  Warnings are disabled
6046 in the expression that follows @code{__extension__}.
6048 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6049 @opindex Wc99-c11-compat
6050 @opindex Wno-c99-c11-compat
6051 Warn about features not present in ISO C99, but present in ISO C11.
6052 For instance, warn about use of anonymous structures and unions,
6053 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6054 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6055 and so on.  This option is independent of the standards mode.  Warnings are
6056 disabled in the expression that follows @code{__extension__}.
6058 @item -Wc++-compat @r{(C and Objective-C only)}
6059 @opindex Wc++-compat
6060 Warn about ISO C constructs that are outside of the common subset of
6061 ISO C and ISO C++, e.g.@: request for implicit conversion from
6062 @code{void *} to a pointer to non-@code{void} type.
6064 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6065 @opindex Wc++11-compat
6066 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6067 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6068 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6069 enabled by @option{-Wall}.
6071 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6072 @opindex Wc++14-compat
6073 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6074 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6076 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6077 @opindex Wc++17-compat
6078 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6079 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6081 @item -Wcast-qual
6082 @opindex Wcast-qual
6083 @opindex Wno-cast-qual
6084 Warn whenever a pointer is cast so as to remove a type qualifier from
6085 the target type.  For example, warn if a @code{const char *} is cast
6086 to an ordinary @code{char *}.
6088 Also warn when making a cast that introduces a type qualifier in an
6089 unsafe way.  For example, casting @code{char **} to @code{const char **}
6090 is unsafe, as in this example:
6092 @smallexample
6093   /* p is char ** value.  */
6094   const char **q = (const char **) p;
6095   /* Assignment of readonly string to const char * is OK.  */
6096   *q = "string";
6097   /* Now char** pointer points to read-only memory.  */
6098   **p = 'b';
6099 @end smallexample
6101 @item -Wcast-align
6102 @opindex Wcast-align
6103 @opindex Wno-cast-align
6104 Warn whenever a pointer is cast such that the required alignment of the
6105 target is increased.  For example, warn if a @code{char *} is cast to
6106 an @code{int *} on machines where integers can only be accessed at
6107 two- or four-byte boundaries.
6109 @item -Wcast-align=strict
6110 @opindex Wcast-align=strict
6111 Warn whenever a pointer is cast such that the required alignment of the
6112 target is increased.  For example, warn if a @code{char *} is cast to
6113 an @code{int *} regardless of the target machine.
6115 @item -Wcast-function-type
6116 @opindex Wcast-function-type
6117 @opindex Wno-cast-function-type
6118 Warn when a function pointer is cast to an incompatible function pointer.
6119 In a cast involving function types with a variable argument list only
6120 the types of initial arguments that are provided are considered.
6121 Any parameter of pointer-type matches any other pointer-type.  Any benign
6122 differences in integral types are ignored, like @code{int} vs. @code{long}
6123 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6124 type @code{void (*) (void)} is special and matches everything, which can
6125 be used to suppress this warning.
6126 In a cast involving pointer to member types this warning warns whenever
6127 the type cast is changing the pointer to member type.
6128 This warning is enabled by @option{-Wextra}.
6130 @item -Wwrite-strings
6131 @opindex Wwrite-strings
6132 @opindex Wno-write-strings
6133 When compiling C, give string constants the type @code{const
6134 char[@var{length}]} so that copying the address of one into a
6135 non-@code{const} @code{char *} pointer produces a warning.  These
6136 warnings help you find at compile time code that can try to write
6137 into a string constant, but only if you have been very careful about
6138 using @code{const} in declarations and prototypes.  Otherwise, it is
6139 just a nuisance. This is why we did not make @option{-Wall} request
6140 these warnings.
6142 When compiling C++, warn about the deprecated conversion from string
6143 literals to @code{char *}.  This warning is enabled by default for C++
6144 programs.
6146 @item -Wcatch-value
6147 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6148 @opindex Wcatch-value
6149 @opindex Wno-catch-value
6150 Warn about catch handlers that do not catch via reference.
6151 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6152 warn about polymorphic class types that are caught by value.
6153 With @option{-Wcatch-value=2} warn about all class types that are caught
6154 by value. With @option{-Wcatch-value=3} warn about all types that are
6155 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6157 @item -Wclobbered
6158 @opindex Wclobbered
6159 @opindex Wno-clobbered
6160 Warn for variables that might be changed by @code{longjmp} or
6161 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6163 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6164 @opindex Wconditionally-supported
6165 @opindex Wno-conditionally-supported
6166 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6168 @item -Wconversion
6169 @opindex Wconversion
6170 @opindex Wno-conversion
6171 Warn for implicit conversions that may alter a value. This includes
6172 conversions between real and integer, like @code{abs (x)} when
6173 @code{x} is @code{double}; conversions between signed and unsigned,
6174 like @code{unsigned ui = -1}; and conversions to smaller types, like
6175 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6176 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6177 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6178 conversions between signed and unsigned integers can be disabled by
6179 using @option{-Wno-sign-conversion}.
6181 For C++, also warn for confusing overload resolution for user-defined
6182 conversions; and conversions that never use a type conversion
6183 operator: conversions to @code{void}, the same type, a base class or a
6184 reference to them. Warnings about conversions between signed and
6185 unsigned integers are disabled by default in C++ unless
6186 @option{-Wsign-conversion} is explicitly enabled.
6188 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6189 @opindex Wconversion-null
6190 @opindex Wno-conversion-null
6191 Do not warn for conversions between @code{NULL} and non-pointer
6192 types. @option{-Wconversion-null} is enabled by default.
6194 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6195 @opindex Wzero-as-null-pointer-constant
6196 @opindex Wno-zero-as-null-pointer-constant
6197 Warn when a literal @samp{0} is used as null pointer constant.  This can
6198 be useful to facilitate the conversion to @code{nullptr} in C++11.
6200 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6201 @opindex Wsubobject-linkage
6202 @opindex Wno-subobject-linkage
6203 Warn if a class type has a base or a field whose type uses the anonymous
6204 namespace or depends on a type with no linkage.  If a type A depends on
6205 a type B with no or internal linkage, defining it in multiple
6206 translation units would be an ODR violation because the meaning of B
6207 is different in each translation unit.  If A only appears in a single
6208 translation unit, the best way to silence the warning is to give it
6209 internal linkage by putting it in an anonymous namespace as well.  The
6210 compiler doesn't give this warning for types defined in the main .C
6211 file, as those are unlikely to have multiple definitions.
6212 @option{-Wsubobject-linkage} is enabled by default.
6214 @item -Wdangling-else
6215 @opindex Wdangling-else
6216 @opindex Wno-dangling-else
6217 Warn about constructions where there may be confusion to which
6218 @code{if} statement an @code{else} branch belongs.  Here is an example of
6219 such a case:
6221 @smallexample
6222 @group
6224   if (a)
6225     if (b)
6226       foo ();
6227   else
6228     bar ();
6230 @end group
6231 @end smallexample
6233 In C/C++, every @code{else} branch belongs to the innermost possible
6234 @code{if} statement, which in this example is @code{if (b)}.  This is
6235 often not what the programmer expected, as illustrated in the above
6236 example by indentation the programmer chose.  When there is the
6237 potential for this confusion, GCC issues a warning when this flag
6238 is specified.  To eliminate the warning, add explicit braces around
6239 the innermost @code{if} statement so there is no way the @code{else}
6240 can belong to the enclosing @code{if}.  The resulting code
6241 looks like this:
6243 @smallexample
6244 @group
6246   if (a)
6247     @{
6248       if (b)
6249         foo ();
6250       else
6251         bar ();
6252     @}
6254 @end group
6255 @end smallexample
6257 This warning is enabled by @option{-Wparentheses}.
6259 @item -Wdate-time
6260 @opindex Wdate-time
6261 @opindex Wno-date-time
6262 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6263 are encountered as they might prevent bit-wise-identical reproducible
6264 compilations.
6266 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6267 @opindex Wdelete-incomplete
6268 @opindex Wno-delete-incomplete
6269 Warn when deleting a pointer to incomplete type, which may cause
6270 undefined behavior at runtime.  This warning is enabled by default.
6272 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6273 @opindex Wuseless-cast
6274 @opindex Wno-useless-cast
6275 Warn when an expression is casted to its own type.
6277 @item -Wempty-body
6278 @opindex Wempty-body
6279 @opindex Wno-empty-body
6280 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6281 while} statement.  This warning is also enabled by @option{-Wextra}.
6283 @item -Wenum-compare
6284 @opindex Wenum-compare
6285 @opindex Wno-enum-compare
6286 Warn about a comparison between values of different enumerated types.
6287 In C++ enumerated type mismatches in conditional expressions are also
6288 diagnosed and the warning is enabled by default.  In C this warning is 
6289 enabled by @option{-Wall}.
6291 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6292 @opindex Wextra-semi
6293 @opindex Wno-extra-semi
6294 Warn about redundant semicolon after in-class function definition.
6296 @item -Wjump-misses-init @r{(C, Objective-C only)}
6297 @opindex Wjump-misses-init
6298 @opindex Wno-jump-misses-init
6299 Warn if a @code{goto} statement or a @code{switch} statement jumps
6300 forward across the initialization of a variable, or jumps backward to a
6301 label after the variable has been initialized.  This only warns about
6302 variables that are initialized when they are declared.  This warning is
6303 only supported for C and Objective-C; in C++ this sort of branch is an
6304 error in any case.
6306 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6307 can be disabled with the @option{-Wno-jump-misses-init} option.
6309 @item -Wsign-compare
6310 @opindex Wsign-compare
6311 @opindex Wno-sign-compare
6312 @cindex warning for comparison of signed and unsigned values
6313 @cindex comparison of signed and unsigned values, warning
6314 @cindex signed and unsigned values, comparison warning
6315 Warn when a comparison between signed and unsigned values could produce
6316 an incorrect result when the signed value is converted to unsigned.
6317 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6318 also enabled by @option{-Wextra}.
6320 @item -Wsign-conversion
6321 @opindex Wsign-conversion
6322 @opindex Wno-sign-conversion
6323 Warn for implicit conversions that may change the sign of an integer
6324 value, like assigning a signed integer expression to an unsigned
6325 integer variable. An explicit cast silences the warning. In C, this
6326 option is enabled also by @option{-Wconversion}.
6328 @item -Wfloat-conversion
6329 @opindex Wfloat-conversion
6330 @opindex Wno-float-conversion
6331 Warn for implicit conversions that reduce the precision of a real value.
6332 This includes conversions from real to integer, and from higher precision
6333 real to lower precision real values.  This option is also enabled by
6334 @option{-Wconversion}.
6336 @item -Wno-scalar-storage-order
6337 @opindex -Wno-scalar-storage-order
6338 @opindex -Wscalar-storage-order
6339 Do not warn on suspicious constructs involving reverse scalar storage order.
6341 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6342 @opindex Wsized-deallocation
6343 @opindex Wno-sized-deallocation
6344 Warn about a definition of an unsized deallocation function
6345 @smallexample
6346 void operator delete (void *) noexcept;
6347 void operator delete[] (void *) noexcept;
6348 @end smallexample
6349 without a definition of the corresponding sized deallocation function
6350 @smallexample
6351 void operator delete (void *, std::size_t) noexcept;
6352 void operator delete[] (void *, std::size_t) noexcept;
6353 @end smallexample
6354 or vice versa.  Enabled by @option{-Wextra} along with
6355 @option{-fsized-deallocation}.
6357 @item -Wsizeof-pointer-div
6358 @opindex Wsizeof-pointer-div
6359 @opindex Wno-sizeof-pointer-div
6360 Warn for suspicious divisions of two sizeof expressions that divide
6361 the pointer size by the element size, which is the usual way to compute
6362 the array size but won't work out correctly with pointers.  This warning
6363 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6364 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6366 @item -Wsizeof-pointer-memaccess
6367 @opindex Wsizeof-pointer-memaccess
6368 @opindex Wno-sizeof-pointer-memaccess
6369 Warn for suspicious length parameters to certain string and memory built-in
6370 functions if the argument uses @code{sizeof}.  This warning triggers for
6371 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6372 an array, but a pointer, and suggests a possible fix, or about
6373 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6374 also warns about calls to bounded string copy functions like @code{strncat}
6375 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6376 the source array.  For example, in the following function the call to
6377 @code{strncat} specifies the size of the source string as the bound.  That
6378 is almost certainly a mistake and so the call is diagnosed.
6379 @smallexample
6380 void make_file (const char *name)
6382   char path[PATH_MAX];
6383   strncpy (path, name, sizeof path - 1);
6384   strncat (path, ".text", sizeof ".text");
6385   @dots{}
6387 @end smallexample
6389 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6391 @item -Wsizeof-array-argument
6392 @opindex Wsizeof-array-argument
6393 @opindex Wno-sizeof-array-argument
6394 Warn when the @code{sizeof} operator is applied to a parameter that is
6395 declared as an array in a function definition.  This warning is enabled by
6396 default for C and C++ programs.
6398 @item -Wmemset-elt-size
6399 @opindex Wmemset-elt-size
6400 @opindex Wno-memset-elt-size
6401 Warn for suspicious calls to the @code{memset} built-in function, if the
6402 first argument references an array, and the third argument is a number
6403 equal to the number of elements, but not equal to the size of the array
6404 in memory.  This indicates that the user has omitted a multiplication by
6405 the element size.  This warning is enabled by @option{-Wall}.
6407 @item -Wmemset-transposed-args
6408 @opindex Wmemset-transposed-args
6409 @opindex Wno-memset-transposed-args
6410 Warn for suspicious calls to the @code{memset} built-in function, if the
6411 second argument is not zero and the third argument is zero.  This warns e.g.@
6412 about @code{memset (buf, sizeof buf, 0)} where most probably
6413 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6414 is only emitted if the third argument is literal zero.  If it is some
6415 expression that is folded to zero, a cast of zero to some type, etc., 
6416 it is far less likely that the user has mistakenly exchanged the arguments 
6417 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6419 @item -Waddress
6420 @opindex Waddress
6421 @opindex Wno-address
6422 Warn about suspicious uses of memory addresses. These include using
6423 the address of a function in a conditional expression, such as
6424 @code{void func(void); if (func)}, and comparisons against the memory
6425 address of a string literal, such as @code{if (x == "abc")}.  Such
6426 uses typically indicate a programmer error: the address of a function
6427 always evaluates to true, so their use in a conditional usually
6428 indicate that the programmer forgot the parentheses in a function
6429 call; and comparisons against string literals result in unspecified
6430 behavior and are not portable in C, so they usually indicate that the
6431 programmer intended to use @code{strcmp}.  This warning is enabled by
6432 @option{-Wall}.
6434 @item -Wlogical-op
6435 @opindex Wlogical-op
6436 @opindex Wno-logical-op
6437 Warn about suspicious uses of logical operators in expressions.
6438 This includes using logical operators in contexts where a
6439 bit-wise operator is likely to be expected.  Also warns when
6440 the operands of a logical operator are the same:
6441 @smallexample
6442 extern int a;
6443 if (a < 0 && a < 0) @{ @dots{} @}
6444 @end smallexample
6446 @item -Wlogical-not-parentheses
6447 @opindex Wlogical-not-parentheses
6448 @opindex Wno-logical-not-parentheses
6449 Warn about logical not used on the left hand side operand of a comparison.
6450 This option does not warn if the right operand is considered to be a boolean
6451 expression.  Its purpose is to detect suspicious code like the following:
6452 @smallexample
6453 int a;
6454 @dots{}
6455 if (!a > 1) @{ @dots{} @}
6456 @end smallexample
6458 It is possible to suppress the warning by wrapping the LHS into
6459 parentheses:
6460 @smallexample
6461 if ((!a) > 1) @{ @dots{} @}
6462 @end smallexample
6464 This warning is enabled by @option{-Wall}.
6466 @item -Waggregate-return
6467 @opindex Waggregate-return
6468 @opindex Wno-aggregate-return
6469 Warn if any functions that return structures or unions are defined or
6470 called.  (In languages where you can return an array, this also elicits
6471 a warning.)
6473 @item -Wno-aggressive-loop-optimizations
6474 @opindex Wno-aggressive-loop-optimizations
6475 @opindex Waggressive-loop-optimizations
6476 Warn if in a loop with constant number of iterations the compiler detects
6477 undefined behavior in some statement during one or more of the iterations.
6479 @item -Wno-attributes
6480 @opindex Wno-attributes
6481 @opindex Wattributes
6482 Do not warn if an unexpected @code{__attribute__} is used, such as
6483 unrecognized attributes, function attributes applied to variables,
6484 etc.  This does not stop errors for incorrect use of supported
6485 attributes.
6487 @item -Wno-builtin-declaration-mismatch
6488 @opindex Wno-builtin-declaration-mismatch
6489 @opindex Wbuiltin-declaration-mismatch
6490 Warn if a built-in function is declared with the wrong signature or 
6491 as non-function.
6492 This warning is enabled by default.
6494 @item -Wno-builtin-macro-redefined
6495 @opindex Wno-builtin-macro-redefined
6496 @opindex Wbuiltin-macro-redefined
6497 Do not warn if certain built-in macros are redefined.  This suppresses
6498 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6499 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6501 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6502 @opindex Wstrict-prototypes
6503 @opindex Wno-strict-prototypes
6504 Warn if a function is declared or defined without specifying the
6505 argument types.  (An old-style function definition is permitted without
6506 a warning if preceded by a declaration that specifies the argument
6507 types.)
6509 @item -Wold-style-declaration @r{(C and Objective-C only)}
6510 @opindex Wold-style-declaration
6511 @opindex Wno-old-style-declaration
6512 Warn for obsolescent usages, according to the C Standard, in a
6513 declaration. For example, warn if storage-class specifiers like
6514 @code{static} are not the first things in a declaration.  This warning
6515 is also enabled by @option{-Wextra}.
6517 @item -Wold-style-definition @r{(C and Objective-C only)}
6518 @opindex Wold-style-definition
6519 @opindex Wno-old-style-definition
6520 Warn if an old-style function definition is used.  A warning is given
6521 even if there is a previous prototype.
6523 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6524 @opindex Wmissing-parameter-type
6525 @opindex Wno-missing-parameter-type
6526 A function parameter is declared without a type specifier in K&R-style
6527 functions:
6529 @smallexample
6530 void foo(bar) @{ @}
6531 @end smallexample
6533 This warning is also enabled by @option{-Wextra}.
6535 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6536 @opindex Wmissing-prototypes
6537 @opindex Wno-missing-prototypes
6538 Warn if a global function is defined without a previous prototype
6539 declaration.  This warning is issued even if the definition itself
6540 provides a prototype.  Use this option to detect global functions
6541 that do not have a matching prototype declaration in a header file.
6542 This option is not valid for C++ because all function declarations
6543 provide prototypes and a non-matching declaration declares an
6544 overload rather than conflict with an earlier declaration.
6545 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6547 @item -Wmissing-declarations
6548 @opindex Wmissing-declarations
6549 @opindex Wno-missing-declarations
6550 Warn if a global function is defined without a previous declaration.
6551 Do so even if the definition itself provides a prototype.
6552 Use this option to detect global functions that are not declared in
6553 header files.  In C, no warnings are issued for functions with previous
6554 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6555 missing prototypes.  In C++, no warnings are issued for function templates,
6556 or for inline functions, or for functions in anonymous namespaces.
6558 @item -Wmissing-field-initializers
6559 @opindex Wmissing-field-initializers
6560 @opindex Wno-missing-field-initializers
6561 @opindex W
6562 @opindex Wextra
6563 @opindex Wno-extra
6564 Warn if a structure's initializer has some fields missing.  For
6565 example, the following code causes such a warning, because
6566 @code{x.h} is implicitly zero:
6568 @smallexample
6569 struct s @{ int f, g, h; @};
6570 struct s x = @{ 3, 4 @};
6571 @end smallexample
6573 This option does not warn about designated initializers, so the following
6574 modification does not trigger a warning:
6576 @smallexample
6577 struct s @{ int f, g, h; @};
6578 struct s x = @{ .f = 3, .g = 4 @};
6579 @end smallexample
6581 In C this option does not warn about the universal zero initializer
6582 @samp{@{ 0 @}}:
6584 @smallexample
6585 struct s @{ int f, g, h; @};
6586 struct s x = @{ 0 @};
6587 @end smallexample
6589 Likewise, in C++ this option does not warn about the empty @{ @}
6590 initializer, for example:
6592 @smallexample
6593 struct s @{ int f, g, h; @};
6594 s x = @{ @};
6595 @end smallexample
6597 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6598 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6600 @item -Wno-multichar
6601 @opindex Wno-multichar
6602 @opindex Wmultichar
6603 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6604 Usually they indicate a typo in the user's code, as they have
6605 implementation-defined values, and should not be used in portable code.
6607 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6608 @opindex Wnormalized=
6609 @opindex Wnormalized
6610 @opindex Wno-normalized
6611 @cindex NFC
6612 @cindex NFKC
6613 @cindex character set, input normalization
6614 In ISO C and ISO C++, two identifiers are different if they are
6615 different sequences of characters.  However, sometimes when characters
6616 outside the basic ASCII character set are used, you can have two
6617 different character sequences that look the same.  To avoid confusion,
6618 the ISO 10646 standard sets out some @dfn{normalization rules} which
6619 when applied ensure that two sequences that look the same are turned into
6620 the same sequence.  GCC can warn you if you are using identifiers that
6621 have not been normalized; this option controls that warning.
6623 There are four levels of warning supported by GCC@.  The default is
6624 @option{-Wnormalized=nfc}, which warns about any identifier that is
6625 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6626 recommended form for most uses.  It is equivalent to
6627 @option{-Wnormalized}.
6629 Unfortunately, there are some characters allowed in identifiers by
6630 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6631 identifiers.  That is, there's no way to use these symbols in portable
6632 ISO C or C++ and have all your identifiers in NFC@.
6633 @option{-Wnormalized=id} suppresses the warning for these characters.
6634 It is hoped that future versions of the standards involved will correct
6635 this, which is why this option is not the default.
6637 You can switch the warning off for all characters by writing
6638 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6639 only do this if you are using some other normalization scheme (like
6640 ``D''), because otherwise you can easily create bugs that are
6641 literally impossible to see.
6643 Some characters in ISO 10646 have distinct meanings but look identical
6644 in some fonts or display methodologies, especially once formatting has
6645 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6646 LETTER N'', displays just like a regular @code{n} that has been
6647 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6648 normalization scheme to convert all these into a standard form as
6649 well, and GCC warns if your code is not in NFKC if you use
6650 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6651 about every identifier that contains the letter O because it might be
6652 confused with the digit 0, and so is not the default, but may be
6653 useful as a local coding convention if the programming environment 
6654 cannot be fixed to display these characters distinctly.
6656 @item -Wno-deprecated
6657 @opindex Wno-deprecated
6658 @opindex Wdeprecated
6659 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6661 @item -Wno-deprecated-declarations
6662 @opindex Wno-deprecated-declarations
6663 @opindex Wdeprecated-declarations
6664 Do not warn about uses of functions (@pxref{Function Attributes}),
6665 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6666 Attributes}) marked as deprecated by using the @code{deprecated}
6667 attribute.
6669 @item -Wno-overflow
6670 @opindex Wno-overflow
6671 @opindex Woverflow
6672 Do not warn about compile-time overflow in constant expressions.
6674 @item -Wno-odr
6675 @opindex Wno-odr
6676 @opindex Wodr
6677 Warn about One Definition Rule violations during link-time optimization.
6678 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6680 @item -Wopenmp-simd
6681 @opindex Wopenm-simd
6682 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6683 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6684 option can be used to relax the cost model.
6686 @item -Woverride-init @r{(C and Objective-C only)}
6687 @opindex Woverride-init
6688 @opindex Wno-override-init
6689 @opindex W
6690 @opindex Wextra
6691 @opindex Wno-extra
6692 Warn if an initialized field without side effects is overridden when
6693 using designated initializers (@pxref{Designated Inits, , Designated
6694 Initializers}).
6696 This warning is included in @option{-Wextra}.  To get other
6697 @option{-Wextra} warnings without this one, use @option{-Wextra
6698 -Wno-override-init}.
6700 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6701 @opindex Woverride-init-side-effects
6702 @opindex Wno-override-init-side-effects
6703 Warn if an initialized field with side effects is overridden when
6704 using designated initializers (@pxref{Designated Inits, , Designated
6705 Initializers}).  This warning is enabled by default.
6707 @item -Wpacked
6708 @opindex Wpacked
6709 @opindex Wno-packed
6710 Warn if a structure is given the packed attribute, but the packed
6711 attribute has no effect on the layout or size of the structure.
6712 Such structures may be mis-aligned for little benefit.  For
6713 instance, in this code, the variable @code{f.x} in @code{struct bar}
6714 is misaligned even though @code{struct bar} does not itself
6715 have the packed attribute:
6717 @smallexample
6718 @group
6719 struct foo @{
6720   int x;
6721   char a, b, c, d;
6722 @} __attribute__((packed));
6723 struct bar @{
6724   char z;
6725   struct foo f;
6727 @end group
6728 @end smallexample
6730 @item -Wpacked-bitfield-compat
6731 @opindex Wpacked-bitfield-compat
6732 @opindex Wno-packed-bitfield-compat
6733 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6734 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6735 the change can lead to differences in the structure layout.  GCC
6736 informs you when the offset of such a field has changed in GCC 4.4.
6737 For example there is no longer a 4-bit padding between field @code{a}
6738 and @code{b} in this structure:
6740 @smallexample
6741 struct foo
6743   char a:4;
6744   char b:8;
6745 @} __attribute__ ((packed));
6746 @end smallexample
6748 This warning is enabled by default.  Use
6749 @option{-Wno-packed-bitfield-compat} to disable this warning.
6751 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6752 @opindex Wpacked-not-aligned
6753 @opindex Wno-packed-not-aligned
6754 Warn if a structure field with explicitly specified alignment in a
6755 packed struct or union is misaligned.  For example, a warning will
6756 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6757 'struct S' is less than 8}, in this code:
6759 @smallexample
6760 @group
6761 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6762 struct __attribute__ ((packed)) S @{
6763   struct S8 s8;
6765 @end group
6766 @end smallexample
6768 This warning is enabled by @option{-Wall}.
6770 @item -Wpadded
6771 @opindex Wpadded
6772 @opindex Wno-padded
6773 Warn if padding is included in a structure, either to align an element
6774 of the structure or to align the whole structure.  Sometimes when this
6775 happens it is possible to rearrange the fields of the structure to
6776 reduce the padding and so make the structure smaller.
6778 @item -Wredundant-decls
6779 @opindex Wredundant-decls
6780 @opindex Wno-redundant-decls
6781 Warn if anything is declared more than once in the same scope, even in
6782 cases where multiple declaration is valid and changes nothing.
6784 @item -Wno-restrict
6785 @opindex Wrestrict
6786 @opindex Wno-restrict
6787 Warn when an object referenced by a @code{restrict}-qualified parameter
6788 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6789 argument, or when copies between such objects overlap.  For example,
6790 the call to the @code{strcpy} function below attempts to truncate the string
6791 by replacing its initial characters with the last four.  However, because
6792 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6793 the call is diagnosed.
6795 @smallexample
6796 struct foo
6798   char a[] = "abcd1234";
6799   strcpy (a, a + 4);
6801 @end smallexample
6802 The @option{-Wrestrict} is included in @option{-Wall}.
6804 @item -Wnested-externs @r{(C and Objective-C only)}
6805 @opindex Wnested-externs
6806 @opindex Wno-nested-externs
6807 Warn if an @code{extern} declaration is encountered within a function.
6809 @item -Wno-inherited-variadic-ctor
6810 @opindex Winherited-variadic-ctor
6811 @opindex Wno-inherited-variadic-ctor
6812 Suppress warnings about use of C++11 inheriting constructors when the
6813 base class inherited from has a C variadic constructor; the warning is
6814 on by default because the ellipsis is not inherited.
6816 @item -Winline
6817 @opindex Winline
6818 @opindex Wno-inline
6819 Warn if a function that is declared as inline cannot be inlined.
6820 Even with this option, the compiler does not warn about failures to
6821 inline functions declared in system headers.
6823 The compiler uses a variety of heuristics to determine whether or not
6824 to inline a function.  For example, the compiler takes into account
6825 the size of the function being inlined and the amount of inlining
6826 that has already been done in the current function.  Therefore,
6827 seemingly insignificant changes in the source program can cause the
6828 warnings produced by @option{-Winline} to appear or disappear.
6830 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6831 @opindex Wno-invalid-offsetof
6832 @opindex Winvalid-offsetof
6833 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6834 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6835 to a non-standard-layout type is undefined.  In existing C++ implementations,
6836 however, @code{offsetof} typically gives meaningful results.
6837 This flag is for users who are aware that they are
6838 writing nonportable code and who have deliberately chosen to ignore the
6839 warning about it.
6841 The restrictions on @code{offsetof} may be relaxed in a future version
6842 of the C++ standard.
6844 @item -Wint-in-bool-context
6845 @opindex Wint-in-bool-context
6846 @opindex Wno-int-in-bool-context
6847 Warn for suspicious use of integer values where boolean values are expected,
6848 such as conditional expressions (?:) using non-boolean integer constants in
6849 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6850 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6851 for all kinds of multiplications regardless of the data type.
6852 This warning is enabled by @option{-Wall}.
6854 @item -Wno-int-to-pointer-cast
6855 @opindex Wno-int-to-pointer-cast
6856 @opindex Wint-to-pointer-cast
6857 Suppress warnings from casts to pointer type of an integer of a
6858 different size. In C++, casting to a pointer type of smaller size is
6859 an error. @option{Wint-to-pointer-cast} is enabled by default.
6862 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6863 @opindex Wno-pointer-to-int-cast
6864 @opindex Wpointer-to-int-cast
6865 Suppress warnings from casts from a pointer to an integer type of a
6866 different size.
6868 @item -Winvalid-pch
6869 @opindex Winvalid-pch
6870 @opindex Wno-invalid-pch
6871 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6872 the search path but cannot be used.
6874 @item -Wlong-long
6875 @opindex Wlong-long
6876 @opindex Wno-long-long
6877 Warn if @code{long long} type is used.  This is enabled by either
6878 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6879 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6881 @item -Wvariadic-macros
6882 @opindex Wvariadic-macros
6883 @opindex Wno-variadic-macros
6884 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6885 alternate syntax is used in ISO C99 mode.  This is enabled by either
6886 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6887 messages, use @option{-Wno-variadic-macros}.
6889 @item -Wvarargs
6890 @opindex Wvarargs
6891 @opindex Wno-varargs
6892 Warn upon questionable usage of the macros used to handle variable
6893 arguments like @code{va_start}.  This is default.  To inhibit the
6894 warning messages, use @option{-Wno-varargs}.
6896 @item -Wvector-operation-performance
6897 @opindex Wvector-operation-performance
6898 @opindex Wno-vector-operation-performance
6899 Warn if vector operation is not implemented via SIMD capabilities of the
6900 architecture.  Mainly useful for the performance tuning.
6901 Vector operation can be implemented @code{piecewise}, which means that the
6902 scalar operation is performed on every vector element; 
6903 @code{in parallel}, which means that the vector operation is implemented
6904 using scalars of wider type, which normally is more performance efficient;
6905 and @code{as a single scalar}, which means that vector fits into a
6906 scalar type.
6908 @item -Wno-virtual-move-assign
6909 @opindex Wvirtual-move-assign
6910 @opindex Wno-virtual-move-assign
6911 Suppress warnings about inheriting from a virtual base with a
6912 non-trivial C++11 move assignment operator.  This is dangerous because
6913 if the virtual base is reachable along more than one path, it is
6914 moved multiple times, which can mean both objects end up in the
6915 moved-from state.  If the move assignment operator is written to avoid
6916 moving from a moved-from object, this warning can be disabled.
6918 @item -Wvla
6919 @opindex Wvla
6920 @opindex Wno-vla
6921 Warn if a variable-length array is used in the code.
6922 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6923 the variable-length array.
6925 @item -Wvla-larger-than=@var{n}
6926 If this option is used, the compiler will warn on uses of
6927 variable-length arrays where the size is either unbounded, or bounded
6928 by an argument that can be larger than @var{n} bytes.  This is similar
6929 to how @option{-Walloca-larger-than=@var{n}} works, but with
6930 variable-length arrays.
6932 Note that GCC may optimize small variable-length arrays of a known
6933 value into plain arrays, so this warning may not get triggered for
6934 such arrays.
6936 This warning is not enabled by @option{-Wall}, and is only active when
6937 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6939 See also @option{-Walloca-larger-than=@var{n}}.
6941 @item -Wvolatile-register-var
6942 @opindex Wvolatile-register-var
6943 @opindex Wno-volatile-register-var
6944 Warn if a register variable is declared volatile.  The volatile
6945 modifier does not inhibit all optimizations that may eliminate reads
6946 and/or writes to register variables.  This warning is enabled by
6947 @option{-Wall}.
6949 @item -Wdisabled-optimization
6950 @opindex Wdisabled-optimization
6951 @opindex Wno-disabled-optimization
6952 Warn if a requested optimization pass is disabled.  This warning does
6953 not generally indicate that there is anything wrong with your code; it
6954 merely indicates that GCC's optimizers are unable to handle the code
6955 effectively.  Often, the problem is that your code is too big or too
6956 complex; GCC refuses to optimize programs when the optimization
6957 itself is likely to take inordinate amounts of time.
6959 @item -Wpointer-sign @r{(C and Objective-C only)}
6960 @opindex Wpointer-sign
6961 @opindex Wno-pointer-sign
6962 Warn for pointer argument passing or assignment with different signedness.
6963 This option is only supported for C and Objective-C@.  It is implied by
6964 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6965 @option{-Wno-pointer-sign}.
6967 @item -Wstack-protector
6968 @opindex Wstack-protector
6969 @opindex Wno-stack-protector
6970 This option is only active when @option{-fstack-protector} is active.  It
6971 warns about functions that are not protected against stack smashing.
6973 @item -Woverlength-strings
6974 @opindex Woverlength-strings
6975 @opindex Wno-overlength-strings
6976 Warn about string constants that are longer than the ``minimum
6977 maximum'' length specified in the C standard.  Modern compilers
6978 generally allow string constants that are much longer than the
6979 standard's minimum limit, but very portable programs should avoid
6980 using longer strings.
6982 The limit applies @emph{after} string constant concatenation, and does
6983 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6984 C99, it was raised to 4095.  C++98 does not specify a normative
6985 minimum maximum, so we do not diagnose overlength strings in C++@.
6987 This option is implied by @option{-Wpedantic}, and can be disabled with
6988 @option{-Wno-overlength-strings}.
6990 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6991 @opindex Wunsuffixed-float-constants
6993 Issue a warning for any floating constant that does not have
6994 a suffix.  When used together with @option{-Wsystem-headers} it
6995 warns about such constants in system header files.  This can be useful
6996 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6997 from the decimal floating-point extension to C99.
6999 @item -Wno-designated-init @r{(C and Objective-C only)}
7000 Suppress warnings when a positional initializer is used to initialize
7001 a structure that has been marked with the @code{designated_init}
7002 attribute.
7004 @item -Whsa
7005 Issue a warning when HSAIL cannot be emitted for the compiled function or
7006 OpenMP construct.
7008 @end table
7010 @node Debugging Options
7011 @section Options for Debugging Your Program
7012 @cindex options, debugging
7013 @cindex debugging information options
7015 To tell GCC to emit extra information for use by a debugger, in almost 
7016 all cases you need only to add @option{-g} to your other options.
7018 GCC allows you to use @option{-g} with
7019 @option{-O}.  The shortcuts taken by optimized code may occasionally
7020 be surprising: some variables you declared may not exist
7021 at all; flow of control may briefly move where you did not expect it;
7022 some statements may not be executed because they compute constant
7023 results or their values are already at hand; some statements may
7024 execute in different places because they have been moved out of loops.
7025 Nevertheless it is possible to debug optimized output.  This makes
7026 it reasonable to use the optimizer for programs that might have bugs.
7028 If you are not using some other optimization option, consider
7029 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7030 With no @option{-O} option at all, some compiler passes that collect
7031 information useful for debugging do not run at all, so that
7032 @option{-Og} may result in a better debugging experience.
7034 @table @gcctabopt
7035 @item -g
7036 @opindex g
7037 Produce debugging information in the operating system's native format
7038 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7039 information.
7041 On most systems that use stabs format, @option{-g} enables use of extra
7042 debugging information that only GDB can use; this extra information
7043 makes debugging work better in GDB but probably makes other debuggers
7044 crash or
7045 refuse to read the program.  If you want to control for certain whether
7046 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7047 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7049 @item -ggdb
7050 @opindex ggdb
7051 Produce debugging information for use by GDB@.  This means to use the
7052 most expressive format available (DWARF, stabs, or the native format
7053 if neither of those are supported), including GDB extensions if at all
7054 possible.
7056 @item -gdwarf
7057 @itemx -gdwarf-@var{version}
7058 @opindex gdwarf
7059 Produce debugging information in DWARF format (if that is supported).
7060 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7061 for most targets is 4.  DWARF Version 5 is only experimental.
7063 Note that with DWARF Version 2, some ports require and always
7064 use some non-conflicting DWARF 3 extensions in the unwind tables.
7066 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7067 for maximum benefit.
7069 GCC no longer supports DWARF Version 1, which is substantially
7070 different than Version 2 and later.  For historical reasons, some
7071 other DWARF-related options such as
7072 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7073 in their names, but apply to all currently-supported versions of DWARF.
7075 @item -gstabs
7076 @opindex gstabs
7077 Produce debugging information in stabs format (if that is supported),
7078 without GDB extensions.  This is the format used by DBX on most BSD
7079 systems.  On MIPS, Alpha and System V Release 4 systems this option
7080 produces stabs debugging output that is not understood by DBX@.
7081 On System V Release 4 systems this option requires the GNU assembler.
7083 @item -gstabs+
7084 @opindex gstabs+
7085 Produce debugging information in stabs format (if that is supported),
7086 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7087 use of these extensions is likely to make other debuggers crash or
7088 refuse to read the program.
7090 @item -gxcoff
7091 @opindex gxcoff
7092 Produce debugging information in XCOFF format (if that is supported).
7093 This is the format used by the DBX debugger on IBM RS/6000 systems.
7095 @item -gxcoff+
7096 @opindex gxcoff+
7097 Produce debugging information in XCOFF format (if that is supported),
7098 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7099 use of these extensions is likely to make other debuggers crash or
7100 refuse to read the program, and may cause assemblers other than the GNU
7101 assembler (GAS) to fail with an error.
7103 @item -gvms
7104 @opindex gvms
7105 Produce debugging information in Alpha/VMS debug format (if that is
7106 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7108 @item -g@var{level}
7109 @itemx -ggdb@var{level}
7110 @itemx -gstabs@var{level}
7111 @itemx -gxcoff@var{level}
7112 @itemx -gvms@var{level}
7113 Request debugging information and also use @var{level} to specify how
7114 much information.  The default level is 2.
7116 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7117 @option{-g}.
7119 Level 1 produces minimal information, enough for making backtraces in
7120 parts of the program that you don't plan to debug.  This includes
7121 descriptions of functions and external variables, and line number
7122 tables, but no information about local variables.
7124 Level 3 includes extra information, such as all the macro definitions
7125 present in the program.  Some debuggers support macro expansion when
7126 you use @option{-g3}.
7128 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7129 confusion with @option{-gdwarf-@var{level}}.
7130 Instead use an additional @option{-g@var{level}} option to change the
7131 debug level for DWARF.
7133 @item -feliminate-unused-debug-symbols
7134 @opindex feliminate-unused-debug-symbols
7135 Produce debugging information in stabs format (if that is supported),
7136 for only symbols that are actually used.
7138 @item -femit-class-debug-always
7139 @opindex femit-class-debug-always
7140 Instead of emitting debugging information for a C++ class in only one
7141 object file, emit it in all object files using the class.  This option
7142 should be used only with debuggers that are unable to handle the way GCC
7143 normally emits debugging information for classes because using this
7144 option increases the size of debugging information by as much as a
7145 factor of two.
7147 @item -fno-merge-debug-strings
7148 @opindex fmerge-debug-strings
7149 @opindex fno-merge-debug-strings
7150 Direct the linker to not merge together strings in the debugging
7151 information that are identical in different object files.  Merging is
7152 not supported by all assemblers or linkers.  Merging decreases the size
7153 of the debug information in the output file at the cost of increasing
7154 link processing time.  Merging is enabled by default.
7156 @item -fdebug-prefix-map=@var{old}=@var{new}
7157 @opindex fdebug-prefix-map
7158 When compiling files residing in directory @file{@var{old}}, record
7159 debugging information describing them as if the files resided in
7160 directory @file{@var{new}} instead.  This can be used to replace a
7161 build-time path with an install-time path in the debug info.  It can
7162 also be used to change an absolute path to a relative path by using
7163 @file{.} for @var{new}.  This can give more reproducible builds, which
7164 are location independent, but may require an extra command to tell GDB
7165 where to find the source files. See also @option{-ffile-prefix-map}.
7167 @item -fvar-tracking
7168 @opindex fvar-tracking
7169 Run variable tracking pass.  It computes where variables are stored at each
7170 position in code.  Better debugging information is then generated
7171 (if the debugging information format supports this information).
7173 It is enabled by default when compiling with optimization (@option{-Os},
7174 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7175 the debug info format supports it.
7177 @item -fvar-tracking-assignments
7178 @opindex fvar-tracking-assignments
7179 @opindex fno-var-tracking-assignments
7180 Annotate assignments to user variables early in the compilation and
7181 attempt to carry the annotations over throughout the compilation all the
7182 way to the end, in an attempt to improve debug information while
7183 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7185 It can be enabled even if var-tracking is disabled, in which case
7186 annotations are created and maintained, but discarded at the end.
7187 By default, this flag is enabled together with @option{-fvar-tracking},
7188 except when selective scheduling is enabled.
7190 @item -gsplit-dwarf
7191 @opindex gsplit-dwarf
7192 Separate as much DWARF debugging information as possible into a
7193 separate output file with the extension @file{.dwo}.  This option allows
7194 the build system to avoid linking files with debug information.  To
7195 be useful, this option requires a debugger capable of reading @file{.dwo}
7196 files.
7198 @item -gpubnames
7199 @opindex gpubnames
7200 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7202 @item -ggnu-pubnames
7203 @opindex ggnu-pubnames
7204 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7205 suitable for conversion into a GDB@ index.  This option is only useful
7206 with a linker that can produce GDB@ index version 7.
7208 @item -fdebug-types-section
7209 @opindex fdebug-types-section
7210 @opindex fno-debug-types-section
7211 When using DWARF Version 4 or higher, type DIEs can be put into
7212 their own @code{.debug_types} section instead of making them part of the
7213 @code{.debug_info} section.  It is more efficient to put them in a separate
7214 comdat sections since the linker can then remove duplicates.
7215 But not all DWARF consumers support @code{.debug_types} sections yet
7216 and on some objects @code{.debug_types} produces larger instead of smaller
7217 debugging information.
7219 @item -grecord-gcc-switches
7220 @itemx -gno-record-gcc-switches
7221 @opindex grecord-gcc-switches
7222 @opindex gno-record-gcc-switches
7223 This switch causes the command-line options used to invoke the
7224 compiler that may affect code generation to be appended to the
7225 DW_AT_producer attribute in DWARF debugging information.  The options
7226 are concatenated with spaces separating them from each other and from
7227 the compiler version.  
7228 It is enabled by default.
7229 See also @option{-frecord-gcc-switches} for another
7230 way of storing compiler options into the object file.  
7232 @item -gstrict-dwarf
7233 @opindex gstrict-dwarf
7234 Disallow using extensions of later DWARF standard version than selected
7235 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7236 DWARF extensions from later standard versions is allowed.
7238 @item -gno-strict-dwarf
7239 @opindex gno-strict-dwarf
7240 Allow using extensions of later DWARF standard version than selected with
7241 @option{-gdwarf-@var{version}}.
7243 @item -gas-loc-support
7244 @opindex gas-loc-support
7245 Inform the compiler that the assembler supports @code{.loc} directives.
7246 It may then use them for the assembler to generate DWARF2+ line number
7247 tables.
7249 This is generally desirable, because assembler-generated line-number
7250 tables are a lot more compact than those the compiler can generate
7251 itself.
7253 This option will be enabled by default if, at GCC configure time, the
7254 assembler was found to support such directives.
7256 @item -gno-as-loc-support
7257 @opindex gno-as-loc-support
7258 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7259 line number tables are to be generated.
7261 @item gas-locview-support
7262 @opindex gas-locview-support
7263 Inform the compiler that the assembler supports @code{view} assignment
7264 and reset assertion checking in @code{.loc} directives.
7266 This option will be enabled by default if, at GCC configure time, the
7267 assembler was found to support them.
7269 @item gno-as-locview-support
7270 Force GCC to assign view numbers internally, if
7271 @option{-gvariable-location-views} are explicitly requested.
7273 @item -gcolumn-info
7274 @itemx -gno-column-info
7275 @opindex gcolumn-info
7276 @opindex gno-column-info
7277 Emit location column information into DWARF debugging information, rather
7278 than just file and line.
7279 This option is enabled by default.
7281 @item -gstatement-frontiers
7282 @itemx -gno-statement-frontiers
7283 @opindex gstatement-frontiers
7284 @opindex gno-statement-frontiers
7285 This option causes GCC to create markers in the internal representation
7286 at the beginning of statements, and to keep them roughly in place
7287 throughout compilation, using them to guide the output of @code{is_stmt}
7288 markers in the line number table.  This is enabled by default when
7289 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7290 @dots{}), and outputting DWARF 2 debug information at the normal level.
7292 @item -gvariable-location-views
7293 @itemx -gvariable-location-views=incompat5
7294 @itemx -gno-variable-location-views
7295 @opindex gvariable-location-views
7296 @opindex gvariable-location-views=incompat5
7297 @opindex gno-variable-location-views
7298 Augment variable location lists with progressive view numbers implied
7299 from the line number table.  This enables debug information consumers to
7300 inspect state at certain points of the program, even if no instructions
7301 associated with the corresponding source locations are present at that
7302 point.  If the assembler lacks support for view numbers in line number
7303 tables, this will cause the compiler to emit the line number table,
7304 which generally makes them somewhat less compact.  The augmented line
7305 number tables and location lists are fully backward-compatible, so they
7306 can be consumed by debug information consumers that are not aware of
7307 these augmentations, but they won't derive any benefit from them either.
7309 This is enabled by default when outputting DWARF 2 debug information at
7310 the normal level, as long as there is assembler support,
7311 @option{-fvar-tracking-assignments} is enabled and
7312 @option{-gstrict-dwarf} is not.  When assembler support is not
7313 available, this may still be enabled, but it will force GCC to output
7314 internal line number tables, and if
7315 @option{-ginternal-reset-location-views} is not enabled, that will most
7316 certainly lead to silently mismatching location views.
7318 There is a proposed representation for view numbers that is not backward
7319 compatible with the location list format introduced in DWARF 5, that can
7320 be enabled with @option{-gvariable-location-views=incompat5}.  This
7321 option may be removed in the future, is only provided as a reference
7322 implementation of the proposed representation.  Debug information
7323 consumers are not expected to support this extended format, and they
7324 would be rendered unable to decode location lists using it.
7326 @item -ginternal-reset-location-views
7327 @itemx -gnointernal-reset-location-views
7328 @opindex ginternal-reset-location-views
7329 @opindex gno-internal-reset-location-views
7330 Attempt to determine location views that can be omitted from location
7331 view lists.  This requires the compiler to have very accurate insn
7332 length estimates, which isn't always the case, and it may cause
7333 incorrect view lists to be generated silently when using an assembler
7334 that does not support location view lists.  The GNU assembler will flag
7335 any such error as a @code{view number mismatch}.  This is only enabled
7336 on ports that define a reliable estimation function.
7338 @item -ginline-points
7339 @itemx -gno-inline-points
7340 @opindex ginline-points
7341 @opindex gno-inline-points
7342 Generate extended debug information for inlined functions.  Location
7343 view tracking markers are inserted at inlined entry points, so that
7344 address and view numbers can be computed and output in debug
7345 information.  This can be enabled independently of location views, in
7346 which case the view numbers won't be output, but it can only be enabled
7347 along with statement frontiers, and it is only enabled by default if
7348 location views are enabled.
7350 @item -gz@r{[}=@var{type}@r{]}
7351 @opindex gz
7352 Produce compressed debug sections in DWARF format, if that is supported.
7353 If @var{type} is not given, the default type depends on the capabilities
7354 of the assembler and linker used.  @var{type} may be one of
7355 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7356 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7357 compression in traditional GNU format).  If the linker doesn't support
7358 writing compressed debug sections, the option is rejected.  Otherwise,
7359 if the assembler does not support them, @option{-gz} is silently ignored
7360 when producing object files.
7362 @item -femit-struct-debug-baseonly
7363 @opindex femit-struct-debug-baseonly
7364 Emit debug information for struct-like types
7365 only when the base name of the compilation source file
7366 matches the base name of file in which the struct is defined.
7368 This option substantially reduces the size of debugging information,
7369 but at significant potential loss in type information to the debugger.
7370 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7371 See @option{-femit-struct-debug-detailed} for more detailed control.
7373 This option works only with DWARF debug output.
7375 @item -femit-struct-debug-reduced
7376 @opindex femit-struct-debug-reduced
7377 Emit debug information for struct-like types
7378 only when the base name of the compilation source file
7379 matches the base name of file in which the type is defined,
7380 unless the struct is a template or defined in a system header.
7382 This option significantly reduces the size of debugging information,
7383 with some potential loss in type information to the debugger.
7384 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7385 See @option{-femit-struct-debug-detailed} for more detailed control.
7387 This option works only with DWARF debug output.
7389 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7390 @opindex femit-struct-debug-detailed
7391 Specify the struct-like types
7392 for which the compiler generates debug information.
7393 The intent is to reduce duplicate struct debug information
7394 between different object files within the same program.
7396 This option is a detailed version of
7397 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7398 which serves for most needs.
7400 A specification has the syntax@*
7401 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7403 The optional first word limits the specification to
7404 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7405 A struct type is used directly when it is the type of a variable, member.
7406 Indirect uses arise through pointers to structs.
7407 That is, when use of an incomplete struct is valid, the use is indirect.
7408 An example is
7409 @samp{struct one direct; struct two * indirect;}.
7411 The optional second word limits the specification to
7412 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7413 Generic structs are a bit complicated to explain.
7414 For C++, these are non-explicit specializations of template classes,
7415 or non-template classes within the above.
7416 Other programming languages have generics,
7417 but @option{-femit-struct-debug-detailed} does not yet implement them.
7419 The third word specifies the source files for those
7420 structs for which the compiler should emit debug information.
7421 The values @samp{none} and @samp{any} have the normal meaning.
7422 The value @samp{base} means that
7423 the base of name of the file in which the type declaration appears
7424 must match the base of the name of the main compilation file.
7425 In practice, this means that when compiling @file{foo.c}, debug information
7426 is generated for types declared in that file and @file{foo.h},
7427 but not other header files.
7428 The value @samp{sys} means those types satisfying @samp{base}
7429 or declared in system or compiler headers.
7431 You may need to experiment to determine the best settings for your application.
7433 The default is @option{-femit-struct-debug-detailed=all}.
7435 This option works only with DWARF debug output.
7437 @item -fno-dwarf2-cfi-asm
7438 @opindex fdwarf2-cfi-asm
7439 @opindex fno-dwarf2-cfi-asm
7440 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7441 instead of using GAS @code{.cfi_*} directives.
7443 @item -fno-eliminate-unused-debug-types
7444 @opindex feliminate-unused-debug-types
7445 @opindex fno-eliminate-unused-debug-types
7446 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7447 output for types that are nowhere used in the source file being compiled.
7448 Sometimes it is useful to have GCC emit debugging
7449 information for all types declared in a compilation
7450 unit, regardless of whether or not they are actually used
7451 in that compilation unit, for example 
7452 if, in the debugger, you want to cast a value to a type that is
7453 not actually used in your program (but is declared).  More often,
7454 however, this results in a significant amount of wasted space.
7455 @end table
7457 @node Optimize Options
7458 @section Options That Control Optimization
7459 @cindex optimize options
7460 @cindex options, optimization
7462 These options control various sorts of optimizations.
7464 Without any optimization option, the compiler's goal is to reduce the
7465 cost of compilation and to make debugging produce the expected
7466 results.  Statements are independent: if you stop the program with a
7467 breakpoint between statements, you can then assign a new value to any
7468 variable or change the program counter to any other statement in the
7469 function and get exactly the results you expect from the source
7470 code.
7472 Turning on optimization flags makes the compiler attempt to improve
7473 the performance and/or code size at the expense of compilation time
7474 and possibly the ability to debug the program.
7476 The compiler performs optimization based on the knowledge it has of the
7477 program.  Compiling multiple files at once to a single output file mode allows
7478 the compiler to use information gained from all of the files when compiling
7479 each of them.
7481 Not all optimizations are controlled directly by a flag.  Only
7482 optimizations that have a flag are listed in this section.
7484 Most optimizations are only enabled if an @option{-O} level is set on
7485 the command line.  Otherwise they are disabled, even if individual
7486 optimization flags are specified.
7488 Depending on the target and how GCC was configured, a slightly different
7489 set of optimizations may be enabled at each @option{-O} level than
7490 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7491 to find out the exact set of optimizations that are enabled at each level.
7492 @xref{Overall Options}, for examples.
7494 @table @gcctabopt
7495 @item -O
7496 @itemx -O1
7497 @opindex O
7498 @opindex O1
7499 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7500 more memory for a large function.
7502 With @option{-O}, the compiler tries to reduce code size and execution
7503 time, without performing any optimizations that take a great deal of
7504 compilation time.
7506 @option{-O} turns on the following optimization flags:
7507 @gccoptlist{
7508 -fauto-inc-dec @gol
7509 -fbranch-count-reg @gol
7510 -fcombine-stack-adjustments @gol
7511 -fcompare-elim @gol
7512 -fcprop-registers @gol
7513 -fdce @gol
7514 -fdefer-pop @gol
7515 -fdelayed-branch @gol
7516 -fdse @gol
7517 -fforward-propagate @gol
7518 -fguess-branch-probability @gol
7519 -fif-conversion2 @gol
7520 -fif-conversion @gol
7521 -finline-functions-called-once @gol
7522 -fipa-pure-const @gol
7523 -fipa-profile @gol
7524 -fipa-reference @gol
7525 -fmerge-constants @gol
7526 -fmove-loop-invariants @gol
7527 -fomit-frame-pointer @gol
7528 -freorder-blocks @gol
7529 -fshrink-wrap @gol
7530 -fshrink-wrap-separate @gol
7531 -fsplit-wide-types @gol
7532 -fssa-backprop @gol
7533 -fssa-phiopt @gol
7534 -ftree-bit-ccp @gol
7535 -ftree-ccp @gol
7536 -ftree-ch @gol
7537 -ftree-coalesce-vars @gol
7538 -ftree-copy-prop @gol
7539 -ftree-dce @gol
7540 -ftree-dominator-opts @gol
7541 -ftree-dse @gol
7542 -ftree-forwprop @gol
7543 -ftree-fre @gol
7544 -ftree-phiprop @gol
7545 -ftree-sink @gol
7546 -ftree-slsr @gol
7547 -ftree-sra @gol
7548 -ftree-pta @gol
7549 -ftree-ter @gol
7550 -funit-at-a-time}
7552 @item -O2
7553 @opindex O2
7554 Optimize even more.  GCC performs nearly all supported optimizations
7555 that do not involve a space-speed tradeoff.
7556 As compared to @option{-O}, this option increases both compilation time
7557 and the performance of the generated code.
7559 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7560 also turns on the following optimization flags:
7561 @gccoptlist{-fthread-jumps @gol
7562 -falign-functions  -falign-jumps @gol
7563 -falign-loops  -falign-labels @gol
7564 -fcaller-saves @gol
7565 -fcrossjumping @gol
7566 -fcse-follow-jumps  -fcse-skip-blocks @gol
7567 -fdelete-null-pointer-checks @gol
7568 -fdevirtualize -fdevirtualize-speculatively @gol
7569 -fexpensive-optimizations @gol
7570 -fgcse  -fgcse-lm  @gol
7571 -fhoist-adjacent-loads @gol
7572 -finline-small-functions @gol
7573 -findirect-inlining @gol
7574 -fipa-cp @gol
7575 -fipa-bit-cp @gol
7576 -fipa-vrp @gol
7577 -fipa-sra @gol
7578 -fipa-icf @gol
7579 -fisolate-erroneous-paths-dereference @gol
7580 -flra-remat @gol
7581 -foptimize-sibling-calls @gol
7582 -foptimize-strlen @gol
7583 -fpartial-inlining @gol
7584 -fpeephole2 @gol
7585 -freorder-blocks-algorithm=stc @gol
7586 -freorder-blocks-and-partition -freorder-functions @gol
7587 -frerun-cse-after-loop  @gol
7588 -fsched-interblock  -fsched-spec @gol
7589 -fschedule-insns  -fschedule-insns2 @gol
7590 -fstore-merging @gol
7591 -fstrict-aliasing @gol
7592 -ftree-builtin-call-dce @gol
7593 -ftree-switch-conversion -ftree-tail-merge @gol
7594 -fcode-hoisting @gol
7595 -ftree-pre @gol
7596 -ftree-vrp @gol
7597 -fipa-ra}
7599 Please note the warning under @option{-fgcse} about
7600 invoking @option{-O2} on programs that use computed gotos.
7602 @item -O3
7603 @opindex O3
7604 Optimize yet more.  @option{-O3} turns on all optimizations specified
7605 by @option{-O2} and also turns on the following optimization flags:
7606 @gccoptlist{-finline-functions @gol
7607 -funswitch-loops @gol
7608 -fpredictive-commoning @gol
7609 -fgcse-after-reload @gol
7610 -ftree-loop-vectorize @gol
7611 -ftree-loop-distribution @gol
7612 -ftree-loop-distribute-patterns @gol
7613 -floop-interchange @gol
7614 -fsplit-paths @gol
7615 -ftree-slp-vectorize @gol
7616 -fvect-cost-model @gol
7617 -ftree-partial-pre @gol
7618 -fpeel-loops @gol
7619 -fipa-cp-clone}
7621 @item -O0
7622 @opindex O0
7623 Reduce compilation time and make debugging produce the expected
7624 results.  This is the default.
7626 @item -Os
7627 @opindex Os
7628 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7629 do not typically increase code size.  It also performs further
7630 optimizations designed to reduce code size.
7632 @option{-Os} disables the following optimization flags:
7633 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7634 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7635 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7637 @item -Ofast
7638 @opindex Ofast
7639 Disregard strict standards compliance.  @option{-Ofast} enables all
7640 @option{-O3} optimizations.  It also enables optimizations that are not
7641 valid for all standard-compliant programs.
7642 It turns on @option{-ffast-math} and the Fortran-specific
7643 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7644 specified, and @option{-fno-protect-parens}.
7646 @item -Og
7647 @opindex Og
7648 Optimize debugging experience.  @option{-Og} enables optimizations
7649 that do not interfere with debugging. It should be the optimization
7650 level of choice for the standard edit-compile-debug cycle, offering
7651 a reasonable level of optimization while maintaining fast compilation
7652 and a good debugging experience.
7653 @end table
7655 If you use multiple @option{-O} options, with or without level numbers,
7656 the last such option is the one that is effective.
7658 Options of the form @option{-f@var{flag}} specify machine-independent
7659 flags.  Most flags have both positive and negative forms; the negative
7660 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7661 below, only one of the forms is listed---the one you typically 
7662 use.  You can figure out the other form by either removing @samp{no-}
7663 or adding it.
7665 The following options control specific optimizations.  They are either
7666 activated by @option{-O} options or are related to ones that are.  You
7667 can use the following flags in the rare cases when ``fine-tuning'' of
7668 optimizations to be performed is desired.
7670 @table @gcctabopt
7671 @item -fno-defer-pop
7672 @opindex fno-defer-pop
7673 Always pop the arguments to each function call as soon as that function
7674 returns.  For machines that must pop arguments after a function call,
7675 the compiler normally lets arguments accumulate on the stack for several
7676 function calls and pops them all at once.
7678 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7680 @item -fforward-propagate
7681 @opindex fforward-propagate
7682 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7683 instructions and checks if the result can be simplified.  If loop unrolling
7684 is active, two passes are performed and the second is scheduled after
7685 loop unrolling.
7687 This option is enabled by default at optimization levels @option{-O},
7688 @option{-O2}, @option{-O3}, @option{-Os}.
7690 @item -ffp-contract=@var{style}
7691 @opindex ffp-contract
7692 @option{-ffp-contract=off} disables floating-point expression contraction.
7693 @option{-ffp-contract=fast} enables floating-point expression contraction
7694 such as forming of fused multiply-add operations if the target has
7695 native support for them.
7696 @option{-ffp-contract=on} enables floating-point expression contraction
7697 if allowed by the language standard.  This is currently not implemented
7698 and treated equal to @option{-ffp-contract=off}.
7700 The default is @option{-ffp-contract=fast}.
7702 @item -fomit-frame-pointer
7703 @opindex fomit-frame-pointer
7704 Omit the frame pointer in functions that don't need one.  This avoids the
7705 instructions to save, set up and restore the frame pointer; on many targets
7706 it also makes an extra register available.
7708 On some targets this flag has no effect because the standard calling sequence
7709 always uses a frame pointer, so it cannot be omitted.
7711 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7712 is used in all functions.  Several targets always omit the frame pointer in
7713 leaf functions.
7715 Enabled by default at @option{-O} and higher.
7717 @item -foptimize-sibling-calls
7718 @opindex foptimize-sibling-calls
7719 Optimize sibling and tail recursive calls.
7721 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7723 @item -foptimize-strlen
7724 @opindex foptimize-strlen
7725 Optimize various standard C string functions (e.g. @code{strlen},
7726 @code{strchr} or @code{strcpy}) and
7727 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7729 Enabled at levels @option{-O2}, @option{-O3}.
7731 @item -fno-inline
7732 @opindex fno-inline
7733 Do not expand any functions inline apart from those marked with
7734 the @code{always_inline} attribute.  This is the default when not
7735 optimizing.
7737 Single functions can be exempted from inlining by marking them
7738 with the @code{noinline} attribute.
7740 @item -finline-small-functions
7741 @opindex finline-small-functions
7742 Integrate functions into their callers when their body is smaller than expected
7743 function call code (so overall size of program gets smaller).  The compiler
7744 heuristically decides which functions are simple enough to be worth integrating
7745 in this way.  This inlining applies to all functions, even those not declared
7746 inline.
7748 Enabled at level @option{-O2}.
7750 @item -findirect-inlining
7751 @opindex findirect-inlining
7752 Inline also indirect calls that are discovered to be known at compile
7753 time thanks to previous inlining.  This option has any effect only
7754 when inlining itself is turned on by the @option{-finline-functions}
7755 or @option{-finline-small-functions} options.
7757 Enabled at level @option{-O2}.
7759 @item -finline-functions
7760 @opindex finline-functions
7761 Consider all functions for inlining, even if they are not declared inline.
7762 The compiler heuristically decides which functions are worth integrating
7763 in this way.
7765 If all calls to a given function are integrated, and the function is
7766 declared @code{static}, then the function is normally not output as
7767 assembler code in its own right.
7769 Enabled at level @option{-O3}.
7771 @item -finline-functions-called-once
7772 @opindex finline-functions-called-once
7773 Consider all @code{static} functions called once for inlining into their
7774 caller even if they are not marked @code{inline}.  If a call to a given
7775 function is integrated, then the function is not output as assembler code
7776 in its own right.
7778 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7780 @item -fearly-inlining
7781 @opindex fearly-inlining
7782 Inline functions marked by @code{always_inline} and functions whose body seems
7783 smaller than the function call overhead early before doing
7784 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7785 makes profiling significantly cheaper and usually inlining faster on programs
7786 having large chains of nested wrapper functions.
7788 Enabled by default.
7790 @item -fipa-sra
7791 @opindex fipa-sra
7792 Perform interprocedural scalar replacement of aggregates, removal of
7793 unused parameters and replacement of parameters passed by reference
7794 by parameters passed by value.
7796 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7798 @item -finline-limit=@var{n}
7799 @opindex finline-limit
7800 By default, GCC limits the size of functions that can be inlined.  This flag
7801 allows coarse control of this limit.  @var{n} is the size of functions that
7802 can be inlined in number of pseudo instructions.
7804 Inlining is actually controlled by a number of parameters, which may be
7805 specified individually by using @option{--param @var{name}=@var{value}}.
7806 The @option{-finline-limit=@var{n}} option sets some of these parameters
7807 as follows:
7809 @table @gcctabopt
7810 @item max-inline-insns-single
7811 is set to @var{n}/2.
7812 @item max-inline-insns-auto
7813 is set to @var{n}/2.
7814 @end table
7816 See below for a documentation of the individual
7817 parameters controlling inlining and for the defaults of these parameters.
7819 @emph{Note:} there may be no value to @option{-finline-limit} that results
7820 in default behavior.
7822 @emph{Note:} pseudo instruction represents, in this particular context, an
7823 abstract measurement of function's size.  In no way does it represent a count
7824 of assembly instructions and as such its exact meaning might change from one
7825 release to an another.
7827 @item -fno-keep-inline-dllexport
7828 @opindex fno-keep-inline-dllexport
7829 This is a more fine-grained version of @option{-fkeep-inline-functions},
7830 which applies only to functions that are declared using the @code{dllexport}
7831 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7832 Functions}.
7834 @item -fkeep-inline-functions
7835 @opindex fkeep-inline-functions
7836 In C, emit @code{static} functions that are declared @code{inline}
7837 into the object file, even if the function has been inlined into all
7838 of its callers.  This switch does not affect functions using the
7839 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7840 inline functions into the object file.
7842 @item -fkeep-static-functions
7843 @opindex fkeep-static-functions
7844 Emit @code{static} functions into the object file, even if the function
7845 is never used.
7847 @item -fkeep-static-consts
7848 @opindex fkeep-static-consts
7849 Emit variables declared @code{static const} when optimization isn't turned
7850 on, even if the variables aren't referenced.
7852 GCC enables this option by default.  If you want to force the compiler to
7853 check if a variable is referenced, regardless of whether or not
7854 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7856 @item -fmerge-constants
7857 @opindex fmerge-constants
7858 Attempt to merge identical constants (string constants and floating-point
7859 constants) across compilation units.
7861 This option is the default for optimized compilation if the assembler and
7862 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7863 behavior.
7865 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7867 @item -fmerge-all-constants
7868 @opindex fmerge-all-constants
7869 Attempt to merge identical constants and identical variables.
7871 This option implies @option{-fmerge-constants}.  In addition to
7872 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7873 arrays or initialized constant variables with integral or floating-point
7874 types.  Languages like C or C++ require each variable, including multiple
7875 instances of the same variable in recursive calls, to have distinct locations,
7876 so using this option results in non-conforming
7877 behavior.
7879 @item -fmodulo-sched
7880 @opindex fmodulo-sched
7881 Perform swing modulo scheduling immediately before the first scheduling
7882 pass.  This pass looks at innermost loops and reorders their
7883 instructions by overlapping different iterations.
7885 @item -fmodulo-sched-allow-regmoves
7886 @opindex fmodulo-sched-allow-regmoves
7887 Perform more aggressive SMS-based modulo scheduling with register moves
7888 allowed.  By setting this flag certain anti-dependences edges are
7889 deleted, which triggers the generation of reg-moves based on the
7890 life-range analysis.  This option is effective only with
7891 @option{-fmodulo-sched} enabled.
7893 @item -fno-branch-count-reg
7894 @opindex fno-branch-count-reg
7895 Avoid running a pass scanning for opportunities to use ``decrement and
7896 branch'' instructions on a count register instead of generating sequences
7897 of instructions that decrement a register, compare it against zero, and
7898 then branch based upon the result.  This option is only meaningful on
7899 architectures that support such instructions, which include x86, PowerPC,
7900 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7901 doesn't remove the decrement and branch instructions from the generated
7902 instruction stream introduced by other optimization passes.
7904 Enabled by default at @option{-O1} and higher.
7906 The default is @option{-fbranch-count-reg}.
7908 @item -fno-function-cse
7909 @opindex fno-function-cse
7910 Do not put function addresses in registers; make each instruction that
7911 calls a constant function contain the function's address explicitly.
7913 This option results in less efficient code, but some strange hacks
7914 that alter the assembler output may be confused by the optimizations
7915 performed when this option is not used.
7917 The default is @option{-ffunction-cse}
7919 @item -fno-zero-initialized-in-bss
7920 @opindex fno-zero-initialized-in-bss
7921 If the target supports a BSS section, GCC by default puts variables that
7922 are initialized to zero into BSS@.  This can save space in the resulting
7923 code.
7925 This option turns off this behavior because some programs explicitly
7926 rely on variables going to the data section---e.g., so that the
7927 resulting executable can find the beginning of that section and/or make
7928 assumptions based on that.
7930 The default is @option{-fzero-initialized-in-bss}.
7932 @item -fthread-jumps
7933 @opindex fthread-jumps
7934 Perform optimizations that check to see if a jump branches to a
7935 location where another comparison subsumed by the first is found.  If
7936 so, the first branch is redirected to either the destination of the
7937 second branch or a point immediately following it, depending on whether
7938 the condition is known to be true or false.
7940 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7942 @item -fsplit-wide-types
7943 @opindex fsplit-wide-types
7944 When using a type that occupies multiple registers, such as @code{long
7945 long} on a 32-bit system, split the registers apart and allocate them
7946 independently.  This normally generates better code for those types,
7947 but may make debugging more difficult.
7949 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7950 @option{-Os}.
7952 @item -fcse-follow-jumps
7953 @opindex fcse-follow-jumps
7954 In common subexpression elimination (CSE), scan through jump instructions
7955 when the target of the jump is not reached by any other path.  For
7956 example, when CSE encounters an @code{if} statement with an
7957 @code{else} clause, CSE follows the jump when the condition
7958 tested is false.
7960 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7962 @item -fcse-skip-blocks
7963 @opindex fcse-skip-blocks
7964 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7965 follow jumps that conditionally skip over blocks.  When CSE
7966 encounters a simple @code{if} statement with no else clause,
7967 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7968 body of the @code{if}.
7970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7972 @item -frerun-cse-after-loop
7973 @opindex frerun-cse-after-loop
7974 Re-run common subexpression elimination after loop optimizations are
7975 performed.
7977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7979 @item -fgcse
7980 @opindex fgcse
7981 Perform a global common subexpression elimination pass.
7982 This pass also performs global constant and copy propagation.
7984 @emph{Note:} When compiling a program using computed gotos, a GCC
7985 extension, you may get better run-time performance if you disable
7986 the global common subexpression elimination pass by adding
7987 @option{-fno-gcse} to the command line.
7989 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7991 @item -fgcse-lm
7992 @opindex fgcse-lm
7993 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7994 attempts to move loads that are only killed by stores into themselves.  This
7995 allows a loop containing a load/store sequence to be changed to a load outside
7996 the loop, and a copy/store within the loop.
7998 Enabled by default when @option{-fgcse} is enabled.
8000 @item -fgcse-sm
8001 @opindex fgcse-sm
8002 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8003 global common subexpression elimination.  This pass attempts to move
8004 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8005 loops containing a load/store sequence can be changed to a load before
8006 the loop and a store after the loop.
8008 Not enabled at any optimization level.
8010 @item -fgcse-las
8011 @opindex fgcse-las
8012 When @option{-fgcse-las} is enabled, the global common subexpression
8013 elimination pass eliminates redundant loads that come after stores to the
8014 same memory location (both partial and full redundancies).
8016 Not enabled at any optimization level.
8018 @item -fgcse-after-reload
8019 @opindex fgcse-after-reload
8020 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8021 pass is performed after reload.  The purpose of this pass is to clean up
8022 redundant spilling.
8024 @item -faggressive-loop-optimizations
8025 @opindex faggressive-loop-optimizations
8026 This option tells the loop optimizer to use language constraints to
8027 derive bounds for the number of iterations of a loop.  This assumes that
8028 loop code does not invoke undefined behavior by for example causing signed
8029 integer overflows or out-of-bound array accesses.  The bounds for the
8030 number of iterations of a loop are used to guide loop unrolling and peeling
8031 and loop exit test optimizations.
8032 This option is enabled by default.
8034 @item -funconstrained-commons
8035 @opindex funconstrained-commons
8036 This option tells the compiler that variables declared in common blocks
8037 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8038 prevents certain optimizations that depend on knowing the array bounds.
8040 @item -fcrossjumping
8041 @opindex fcrossjumping
8042 Perform cross-jumping transformation.
8043 This transformation unifies equivalent code and saves code size.  The
8044 resulting code may or may not perform better than without cross-jumping.
8046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8048 @item -fauto-inc-dec
8049 @opindex fauto-inc-dec
8050 Combine increments or decrements of addresses with memory accesses.
8051 This pass is always skipped on architectures that do not have
8052 instructions to support this.  Enabled by default at @option{-O} and
8053 higher on architectures that support this.
8055 @item -fdce
8056 @opindex fdce
8057 Perform dead code elimination (DCE) on RTL@.
8058 Enabled by default at @option{-O} and higher.
8060 @item -fdse
8061 @opindex fdse
8062 Perform dead store elimination (DSE) on RTL@.
8063 Enabled by default at @option{-O} and higher.
8065 @item -fif-conversion
8066 @opindex fif-conversion
8067 Attempt to transform conditional jumps into branch-less equivalents.  This
8068 includes use of conditional moves, min, max, set flags and abs instructions, and
8069 some tricks doable by standard arithmetics.  The use of conditional execution
8070 on chips where it is available is controlled by @option{-fif-conversion2}.
8072 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8074 @item -fif-conversion2
8075 @opindex fif-conversion2
8076 Use conditional execution (where available) to transform conditional jumps into
8077 branch-less equivalents.
8079 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8081 @item -fdeclone-ctor-dtor
8082 @opindex fdeclone-ctor-dtor
8083 The C++ ABI requires multiple entry points for constructors and
8084 destructors: one for a base subobject, one for a complete object, and
8085 one for a virtual destructor that calls operator delete afterwards.
8086 For a hierarchy with virtual bases, the base and complete variants are
8087 clones, which means two copies of the function.  With this option, the
8088 base and complete variants are changed to be thunks that call a common
8089 implementation.
8091 Enabled by @option{-Os}.
8093 @item -fdelete-null-pointer-checks
8094 @opindex fdelete-null-pointer-checks
8095 Assume that programs cannot safely dereference null pointers, and that
8096 no code or data element resides at address zero.
8097 This option enables simple constant
8098 folding optimizations at all optimization levels.  In addition, other
8099 optimization passes in GCC use this flag to control global dataflow
8100 analyses that eliminate useless checks for null pointers; these assume
8101 that a memory access to address zero always results in a trap, so
8102 that if a pointer is checked after it has already been dereferenced,
8103 it cannot be null.
8105 Note however that in some environments this assumption is not true.
8106 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8107 for programs that depend on that behavior.
8109 This option is enabled by default on most targets.  On Nios II ELF, it
8110 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8112 Passes that use the dataflow information
8113 are enabled independently at different optimization levels.
8115 @item -fdevirtualize
8116 @opindex fdevirtualize
8117 Attempt to convert calls to virtual functions to direct calls.  This
8118 is done both within a procedure and interprocedurally as part of
8119 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8120 propagation (@option{-fipa-cp}).
8121 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8123 @item -fdevirtualize-speculatively
8124 @opindex fdevirtualize-speculatively
8125 Attempt to convert calls to virtual functions to speculative direct calls.
8126 Based on the analysis of the type inheritance graph, determine for a given call
8127 the set of likely targets. If the set is small, preferably of size 1, change
8128 the call into a conditional deciding between direct and indirect calls.  The
8129 speculative calls enable more optimizations, such as inlining.  When they seem
8130 useless after further optimization, they are converted back into original form.
8132 @item -fdevirtualize-at-ltrans
8133 @opindex fdevirtualize-at-ltrans
8134 Stream extra information needed for aggressive devirtualization when running
8135 the link-time optimizer in local transformation mode.  
8136 This option enables more devirtualization but
8137 significantly increases the size of streamed data. For this reason it is
8138 disabled by default.
8140 @item -fexpensive-optimizations
8141 @opindex fexpensive-optimizations
8142 Perform a number of minor optimizations that are relatively expensive.
8144 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8146 @item -free
8147 @opindex free
8148 Attempt to remove redundant extension instructions.  This is especially
8149 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8150 registers after writing to their lower 32-bit half.
8152 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8153 @option{-O3}, @option{-Os}.
8155 @item -fno-lifetime-dse
8156 @opindex fno-lifetime-dse
8157 In C++ the value of an object is only affected by changes within its
8158 lifetime: when the constructor begins, the object has an indeterminate
8159 value, and any changes during the lifetime of the object are dead when
8160 the object is destroyed.  Normally dead store elimination will take
8161 advantage of this; if your code relies on the value of the object
8162 storage persisting beyond the lifetime of the object, you can use this
8163 flag to disable this optimization.  To preserve stores before the
8164 constructor starts (e.g. because your operator new clears the object
8165 storage) but still treat the object as dead after the destructor you,
8166 can use @option{-flifetime-dse=1}.  The default behavior can be
8167 explicitly selected with @option{-flifetime-dse=2}.
8168 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8170 @item -flive-range-shrinkage
8171 @opindex flive-range-shrinkage
8172 Attempt to decrease register pressure through register live range
8173 shrinkage.  This is helpful for fast processors with small or moderate
8174 size register sets.
8176 @item -fira-algorithm=@var{algorithm}
8177 @opindex fira-algorithm
8178 Use the specified coloring algorithm for the integrated register
8179 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8180 specifies Chow's priority coloring, or @samp{CB}, which specifies
8181 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8182 for all architectures, but for those targets that do support it, it is
8183 the default because it generates better code.
8185 @item -fira-region=@var{region}
8186 @opindex fira-region
8187 Use specified regions for the integrated register allocator.  The
8188 @var{region} argument should be one of the following:
8190 @table @samp
8192 @item all
8193 Use all loops as register allocation regions.
8194 This can give the best results for machines with a small and/or
8195 irregular register set.
8197 @item mixed
8198 Use all loops except for loops with small register pressure 
8199 as the regions.  This value usually gives
8200 the best results in most cases and for most architectures,
8201 and is enabled by default when compiling with optimization for speed
8202 (@option{-O}, @option{-O2}, @dots{}).
8204 @item one
8205 Use all functions as a single region.  
8206 This typically results in the smallest code size, and is enabled by default for
8207 @option{-Os} or @option{-O0}.
8209 @end table
8211 @item -fira-hoist-pressure
8212 @opindex fira-hoist-pressure
8213 Use IRA to evaluate register pressure in the code hoisting pass for
8214 decisions to hoist expressions.  This option usually results in smaller
8215 code, but it can slow the compiler down.
8217 This option is enabled at level @option{-Os} for all targets.
8219 @item -fira-loop-pressure
8220 @opindex fira-loop-pressure
8221 Use IRA to evaluate register pressure in loops for decisions to move
8222 loop invariants.  This option usually results in generation
8223 of faster and smaller code on machines with large register files (>= 32
8224 registers), but it can slow the compiler down.
8226 This option is enabled at level @option{-O3} for some targets.
8228 @item -fno-ira-share-save-slots
8229 @opindex fno-ira-share-save-slots
8230 Disable sharing of stack slots used for saving call-used hard
8231 registers living through a call.  Each hard register gets a
8232 separate stack slot, and as a result function stack frames are
8233 larger.
8235 @item -fno-ira-share-spill-slots
8236 @opindex fno-ira-share-spill-slots
8237 Disable sharing of stack slots allocated for pseudo-registers.  Each
8238 pseudo-register that does not get a hard register gets a separate
8239 stack slot, and as a result function stack frames are larger.
8241 @item -flra-remat
8242 @opindex flra-remat
8243 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8244 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8245 values if it is profitable.
8247 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8249 @item -fdelayed-branch
8250 @opindex fdelayed-branch
8251 If supported for the target machine, attempt to reorder instructions
8252 to exploit instruction slots available after delayed branch
8253 instructions.
8255 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8257 @item -fschedule-insns
8258 @opindex fschedule-insns
8259 If supported for the target machine, attempt to reorder instructions to
8260 eliminate execution stalls due to required data being unavailable.  This
8261 helps machines that have slow floating point or memory load instructions
8262 by allowing other instructions to be issued until the result of the load
8263 or floating-point instruction is required.
8265 Enabled at levels @option{-O2}, @option{-O3}.
8267 @item -fschedule-insns2
8268 @opindex fschedule-insns2
8269 Similar to @option{-fschedule-insns}, but requests an additional pass of
8270 instruction scheduling after register allocation has been done.  This is
8271 especially useful on machines with a relatively small number of
8272 registers and where memory load instructions take more than one cycle.
8274 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8276 @item -fno-sched-interblock
8277 @opindex fno-sched-interblock
8278 Don't schedule instructions across basic blocks.  This is normally
8279 enabled by default when scheduling before register allocation, i.e.@:
8280 with @option{-fschedule-insns} or at @option{-O2} or higher.
8282 @item -fno-sched-spec
8283 @opindex fno-sched-spec
8284 Don't allow speculative motion of non-load instructions.  This is normally
8285 enabled by default when scheduling before register allocation, i.e.@:
8286 with @option{-fschedule-insns} or at @option{-O2} or higher.
8288 @item -fsched-pressure
8289 @opindex fsched-pressure
8290 Enable register pressure sensitive insn scheduling before register
8291 allocation.  This only makes sense when scheduling before register
8292 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8293 @option{-O2} or higher.  Usage of this option can improve the
8294 generated code and decrease its size by preventing register pressure
8295 increase above the number of available hard registers and subsequent
8296 spills in register allocation.
8298 @item -fsched-spec-load
8299 @opindex fsched-spec-load
8300 Allow speculative motion of some load instructions.  This only makes
8301 sense when scheduling before register allocation, i.e.@: with
8302 @option{-fschedule-insns} or at @option{-O2} or higher.
8304 @item -fsched-spec-load-dangerous
8305 @opindex fsched-spec-load-dangerous
8306 Allow speculative motion of more load instructions.  This only makes
8307 sense when scheduling before register allocation, i.e.@: with
8308 @option{-fschedule-insns} or at @option{-O2} or higher.
8310 @item -fsched-stalled-insns
8311 @itemx -fsched-stalled-insns=@var{n}
8312 @opindex fsched-stalled-insns
8313 Define how many insns (if any) can be moved prematurely from the queue
8314 of stalled insns into the ready list during the second scheduling pass.
8315 @option{-fno-sched-stalled-insns} means that no insns are moved
8316 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8317 on how many queued insns can be moved prematurely.
8318 @option{-fsched-stalled-insns} without a value is equivalent to
8319 @option{-fsched-stalled-insns=1}.
8321 @item -fsched-stalled-insns-dep
8322 @itemx -fsched-stalled-insns-dep=@var{n}
8323 @opindex fsched-stalled-insns-dep
8324 Define how many insn groups (cycles) are examined for a dependency
8325 on a stalled insn that is a candidate for premature removal from the queue
8326 of stalled insns.  This has an effect only during the second scheduling pass,
8327 and only if @option{-fsched-stalled-insns} is used.
8328 @option{-fno-sched-stalled-insns-dep} is equivalent to
8329 @option{-fsched-stalled-insns-dep=0}.
8330 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8331 @option{-fsched-stalled-insns-dep=1}.
8333 @item -fsched2-use-superblocks
8334 @opindex fsched2-use-superblocks
8335 When scheduling after register allocation, use superblock scheduling.
8336 This allows motion across basic block boundaries,
8337 resulting in faster schedules.  This option is experimental, as not all machine
8338 descriptions used by GCC model the CPU closely enough to avoid unreliable
8339 results from the algorithm.
8341 This only makes sense when scheduling after register allocation, i.e.@: with
8342 @option{-fschedule-insns2} or at @option{-O2} or higher.
8344 @item -fsched-group-heuristic
8345 @opindex fsched-group-heuristic
8346 Enable the group heuristic in the scheduler.  This heuristic favors
8347 the instruction that belongs to a schedule group.  This is enabled
8348 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8349 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8351 @item -fsched-critical-path-heuristic
8352 @opindex fsched-critical-path-heuristic
8353 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8354 instructions on the critical path.  This is enabled by default when
8355 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8356 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8358 @item -fsched-spec-insn-heuristic
8359 @opindex fsched-spec-insn-heuristic
8360 Enable the speculative instruction heuristic in the scheduler.  This
8361 heuristic favors speculative instructions with greater dependency weakness.
8362 This is enabled by default when scheduling is enabled, i.e.@:
8363 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8364 or at @option{-O2} or higher.
8366 @item -fsched-rank-heuristic
8367 @opindex fsched-rank-heuristic
8368 Enable the rank heuristic in the scheduler.  This heuristic favors
8369 the instruction belonging to a basic block with greater size or frequency.
8370 This is enabled by default when scheduling is enabled, i.e.@:
8371 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8372 at @option{-O2} or higher.
8374 @item -fsched-last-insn-heuristic
8375 @opindex fsched-last-insn-heuristic
8376 Enable the last-instruction heuristic in the scheduler.  This heuristic
8377 favors the instruction that is less dependent on the last instruction
8378 scheduled.  This is enabled by default when scheduling is enabled,
8379 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8380 at @option{-O2} or higher.
8382 @item -fsched-dep-count-heuristic
8383 @opindex fsched-dep-count-heuristic
8384 Enable the dependent-count heuristic in the scheduler.  This heuristic
8385 favors the instruction that has more instructions depending on it.
8386 This is enabled by default when scheduling is enabled, i.e.@:
8387 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8388 at @option{-O2} or higher.
8390 @item -freschedule-modulo-scheduled-loops
8391 @opindex freschedule-modulo-scheduled-loops
8392 Modulo scheduling is performed before traditional scheduling.  If a loop
8393 is modulo scheduled, later scheduling passes may change its schedule.  
8394 Use this option to control that behavior.
8396 @item -fselective-scheduling
8397 @opindex fselective-scheduling
8398 Schedule instructions using selective scheduling algorithm.  Selective
8399 scheduling runs instead of the first scheduler pass.
8401 @item -fselective-scheduling2
8402 @opindex fselective-scheduling2
8403 Schedule instructions using selective scheduling algorithm.  Selective
8404 scheduling runs instead of the second scheduler pass.
8406 @item -fsel-sched-pipelining
8407 @opindex fsel-sched-pipelining
8408 Enable software pipelining of innermost loops during selective scheduling.
8409 This option has no effect unless one of @option{-fselective-scheduling} or
8410 @option{-fselective-scheduling2} is turned on.
8412 @item -fsel-sched-pipelining-outer-loops
8413 @opindex fsel-sched-pipelining-outer-loops
8414 When pipelining loops during selective scheduling, also pipeline outer loops.
8415 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8417 @item -fsemantic-interposition
8418 @opindex fsemantic-interposition
8419 Some object formats, like ELF, allow interposing of symbols by the 
8420 dynamic linker.
8421 This means that for symbols exported from the DSO, the compiler cannot perform
8422 interprocedural propagation, inlining and other optimizations in anticipation
8423 that the function or variable in question may change. While this feature is
8424 useful, for example, to rewrite memory allocation functions by a debugging
8425 implementation, it is expensive in the terms of code quality.
8426 With @option{-fno-semantic-interposition} the compiler assumes that 
8427 if interposition happens for functions the overwriting function will have 
8428 precisely the same semantics (and side effects). 
8429 Similarly if interposition happens
8430 for variables, the constructor of the variable will be the same. The flag
8431 has no effect for functions explicitly declared inline 
8432 (where it is never allowed for interposition to change semantics) 
8433 and for symbols explicitly declared weak.
8435 @item -fshrink-wrap
8436 @opindex fshrink-wrap
8437 Emit function prologues only before parts of the function that need it,
8438 rather than at the top of the function.  This flag is enabled by default at
8439 @option{-O} and higher.
8441 @item -fshrink-wrap-separate
8442 @opindex fshrink-wrap-separate
8443 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8444 those parts are only executed when needed.
8445 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8446 is also turned on and the target supports this.
8448 @item -fcaller-saves
8449 @opindex fcaller-saves
8450 Enable allocation of values to registers that are clobbered by
8451 function calls, by emitting extra instructions to save and restore the
8452 registers around such calls.  Such allocation is done only when it
8453 seems to result in better code.
8455 This option is always enabled by default on certain machines, usually
8456 those which have no call-preserved registers to use instead.
8458 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8460 @item -fcombine-stack-adjustments
8461 @opindex fcombine-stack-adjustments
8462 Tracks stack adjustments (pushes and pops) and stack memory references
8463 and then tries to find ways to combine them.
8465 Enabled by default at @option{-O1} and higher.
8467 @item -fipa-ra
8468 @opindex fipa-ra
8469 Use caller save registers for allocation if those registers are not used by
8470 any called function.  In that case it is not necessary to save and restore
8471 them around calls.  This is only possible if called functions are part of
8472 same compilation unit as current function and they are compiled before it.
8474 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8475 is disabled if generated code will be instrumented for profiling
8476 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8477 exactly (this happens on targets that do not expose prologues
8478 and epilogues in RTL).
8480 @item -fconserve-stack
8481 @opindex fconserve-stack
8482 Attempt to minimize stack usage.  The compiler attempts to use less
8483 stack space, even if that makes the program slower.  This option
8484 implies setting the @option{large-stack-frame} parameter to 100
8485 and the @option{large-stack-frame-growth} parameter to 400.
8487 @item -ftree-reassoc
8488 @opindex ftree-reassoc
8489 Perform reassociation on trees.  This flag is enabled by default
8490 at @option{-O} and higher.
8492 @item -fcode-hoisting
8493 @opindex fcode-hoisting
8494 Perform code hoisting.  Code hoisting tries to move the
8495 evaluation of expressions executed on all paths to the function exit
8496 as early as possible.  This is especially useful as a code size
8497 optimization, but it often helps for code speed as well.
8498 This flag is enabled by default at @option{-O2} and higher.
8500 @item -ftree-pre
8501 @opindex ftree-pre
8502 Perform partial redundancy elimination (PRE) on trees.  This flag is
8503 enabled by default at @option{-O2} and @option{-O3}.
8505 @item -ftree-partial-pre
8506 @opindex ftree-partial-pre
8507 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8508 enabled by default at @option{-O3}.
8510 @item -ftree-forwprop
8511 @opindex ftree-forwprop
8512 Perform forward propagation on trees.  This flag is enabled by default
8513 at @option{-O} and higher.
8515 @item -ftree-fre
8516 @opindex ftree-fre
8517 Perform full redundancy elimination (FRE) on trees.  The difference
8518 between FRE and PRE is that FRE only considers expressions
8519 that are computed on all paths leading to the redundant computation.
8520 This analysis is faster than PRE, though it exposes fewer redundancies.
8521 This flag is enabled by default at @option{-O} and higher.
8523 @item -ftree-phiprop
8524 @opindex ftree-phiprop
8525 Perform hoisting of loads from conditional pointers on trees.  This
8526 pass is enabled by default at @option{-O} and higher.
8528 @item -fhoist-adjacent-loads
8529 @opindex fhoist-adjacent-loads
8530 Speculatively hoist loads from both branches of an if-then-else if the
8531 loads are from adjacent locations in the same structure and the target
8532 architecture has a conditional move instruction.  This flag is enabled
8533 by default at @option{-O2} and higher.
8535 @item -ftree-copy-prop
8536 @opindex ftree-copy-prop
8537 Perform copy propagation on trees.  This pass eliminates unnecessary
8538 copy operations.  This flag is enabled by default at @option{-O} and
8539 higher.
8541 @item -fipa-pure-const
8542 @opindex fipa-pure-const
8543 Discover which functions are pure or constant.
8544 Enabled by default at @option{-O} and higher.
8546 @item -fipa-reference
8547 @opindex fipa-reference
8548 Discover which static variables do not escape the
8549 compilation unit.
8550 Enabled by default at @option{-O} and higher.
8552 @item -fipa-pta
8553 @opindex fipa-pta
8554 Perform interprocedural pointer analysis and interprocedural modification
8555 and reference analysis.  This option can cause excessive memory and
8556 compile-time usage on large compilation units.  It is not enabled by
8557 default at any optimization level.
8559 @item -fipa-profile
8560 @opindex fipa-profile
8561 Perform interprocedural profile propagation.  The functions called only from
8562 cold functions are marked as cold. Also functions executed once (such as
8563 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8564 functions and loop less parts of functions executed once are then optimized for
8565 size.
8566 Enabled by default at @option{-O} and higher.
8568 @item -fipa-cp
8569 @opindex fipa-cp
8570 Perform interprocedural constant propagation.
8571 This optimization analyzes the program to determine when values passed
8572 to functions are constants and then optimizes accordingly.
8573 This optimization can substantially increase performance
8574 if the application has constants passed to functions.
8575 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8577 @item -fipa-cp-clone
8578 @opindex fipa-cp-clone
8579 Perform function cloning to make interprocedural constant propagation stronger.
8580 When enabled, interprocedural constant propagation performs function cloning
8581 when externally visible function can be called with constant arguments.
8582 Because this optimization can create multiple copies of functions,
8583 it may significantly increase code size
8584 (see @option{--param ipcp-unit-growth=@var{value}}).
8585 This flag is enabled by default at @option{-O3}.
8587 @item -fipa-bit-cp
8588 @opindex -fipa-bit-cp
8589 When enabled, perform interprocedural bitwise constant
8590 propagation. This flag is enabled by default at @option{-O2}. It
8591 requires that @option{-fipa-cp} is enabled.
8593 @item -fipa-vrp
8594 @opindex -fipa-vrp
8595 When enabled, perform interprocedural propagation of value
8596 ranges. This flag is enabled by default at @option{-O2}. It requires
8597 that @option{-fipa-cp} is enabled.
8599 @item -fipa-icf
8600 @opindex fipa-icf
8601 Perform Identical Code Folding for functions and read-only variables.
8602 The optimization reduces code size and may disturb unwind stacks by replacing
8603 a function by equivalent one with a different name. The optimization works
8604 more effectively with link-time optimization enabled.
8606 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8607 works on different levels and thus the optimizations are not same - there are
8608 equivalences that are found only by GCC and equivalences found only by Gold.
8610 This flag is enabled by default at @option{-O2} and @option{-Os}.
8612 @item -fisolate-erroneous-paths-dereference
8613 @opindex fisolate-erroneous-paths-dereference
8614 Detect paths that trigger erroneous or undefined behavior due to
8615 dereferencing a null pointer.  Isolate those paths from the main control
8616 flow and turn the statement with erroneous or undefined behavior into a trap.
8617 This flag is enabled by default at @option{-O2} and higher and depends on
8618 @option{-fdelete-null-pointer-checks} also being enabled.
8620 @item -fisolate-erroneous-paths-attribute
8621 @opindex fisolate-erroneous-paths-attribute
8622 Detect paths that trigger erroneous or undefined behavior due a null value
8623 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8624 attribute.  Isolate those paths from the main control flow and turn the
8625 statement with erroneous or undefined behavior into a trap.  This is not
8626 currently enabled, but may be enabled by @option{-O2} in the future.
8628 @item -ftree-sink
8629 @opindex ftree-sink
8630 Perform forward store motion on trees.  This flag is
8631 enabled by default at @option{-O} and higher.
8633 @item -ftree-bit-ccp
8634 @opindex ftree-bit-ccp
8635 Perform sparse conditional bit constant propagation on trees and propagate
8636 pointer alignment information.
8637 This pass only operates on local scalar variables and is enabled by default
8638 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8640 @item -ftree-ccp
8641 @opindex ftree-ccp
8642 Perform sparse conditional constant propagation (CCP) on trees.  This
8643 pass only operates on local scalar variables and is enabled by default
8644 at @option{-O} and higher.
8646 @item -fssa-backprop
8647 @opindex fssa-backprop
8648 Propagate information about uses of a value up the definition chain
8649 in order to simplify the definitions.  For example, this pass strips
8650 sign operations if the sign of a value never matters.  The flag is
8651 enabled by default at @option{-O} and higher.
8653 @item -fssa-phiopt
8654 @opindex fssa-phiopt
8655 Perform pattern matching on SSA PHI nodes to optimize conditional
8656 code.  This pass is enabled by default at @option{-O} and higher.
8658 @item -ftree-switch-conversion
8659 @opindex ftree-switch-conversion
8660 Perform conversion of simple initializations in a switch to
8661 initializations from a scalar array.  This flag is enabled by default
8662 at @option{-O2} and higher.
8664 @item -ftree-tail-merge
8665 @opindex ftree-tail-merge
8666 Look for identical code sequences.  When found, replace one with a jump to the
8667 other.  This optimization is known as tail merging or cross jumping.  This flag
8668 is enabled by default at @option{-O2} and higher.  The compilation time
8669 in this pass can
8670 be limited using @option{max-tail-merge-comparisons} parameter and
8671 @option{max-tail-merge-iterations} parameter.
8673 @item -ftree-dce
8674 @opindex ftree-dce
8675 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8676 default at @option{-O} and higher.
8678 @item -ftree-builtin-call-dce
8679 @opindex ftree-builtin-call-dce
8680 Perform conditional dead code elimination (DCE) for calls to built-in functions
8681 that may set @code{errno} but are otherwise side-effect free.  This flag is
8682 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8683 specified.
8685 @item -ftree-dominator-opts
8686 @opindex ftree-dominator-opts
8687 Perform a variety of simple scalar cleanups (constant/copy
8688 propagation, redundancy elimination, range propagation and expression
8689 simplification) based on a dominator tree traversal.  This also
8690 performs jump threading (to reduce jumps to jumps). This flag is
8691 enabled by default at @option{-O} and higher.
8693 @item -ftree-dse
8694 @opindex ftree-dse
8695 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8696 a memory location that is later overwritten by another store without
8697 any intervening loads.  In this case the earlier store can be deleted.  This
8698 flag is enabled by default at @option{-O} and higher.
8700 @item -ftree-ch
8701 @opindex ftree-ch
8702 Perform loop header copying on trees.  This is beneficial since it increases
8703 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8704 is enabled by default at @option{-O} and higher.  It is not enabled
8705 for @option{-Os}, since it usually increases code size.
8707 @item -ftree-loop-optimize
8708 @opindex ftree-loop-optimize
8709 Perform loop optimizations on trees.  This flag is enabled by default
8710 at @option{-O} and higher.
8712 @item -ftree-loop-linear
8713 @itemx -floop-strip-mine
8714 @itemx -floop-block
8715 @opindex ftree-loop-linear
8716 @opindex floop-strip-mine
8717 @opindex floop-block
8718 Perform loop nest optimizations.  Same as
8719 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8720 to be configured with @option{--with-isl} to enable the Graphite loop
8721 transformation infrastructure.
8723 @item -fgraphite-identity
8724 @opindex fgraphite-identity
8725 Enable the identity transformation for graphite.  For every SCoP we generate
8726 the polyhedral representation and transform it back to gimple.  Using
8727 @option{-fgraphite-identity} we can check the costs or benefits of the
8728 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8729 are also performed by the code generator isl, like index splitting and
8730 dead code elimination in loops.
8732 @item -floop-nest-optimize
8733 @opindex floop-nest-optimize
8734 Enable the isl based loop nest optimizer.  This is a generic loop nest
8735 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8736 structure optimized for data-locality and parallelism.  This option
8737 is experimental.
8739 @item -floop-parallelize-all
8740 @opindex floop-parallelize-all
8741 Use the Graphite data dependence analysis to identify loops that can
8742 be parallelized.  Parallelize all the loops that can be analyzed to
8743 not contain loop carried dependences without checking that it is
8744 profitable to parallelize the loops.
8746 @item -ftree-coalesce-vars
8747 @opindex ftree-coalesce-vars
8748 While transforming the program out of the SSA representation, attempt to
8749 reduce copying by coalescing versions of different user-defined
8750 variables, instead of just compiler temporaries.  This may severely
8751 limit the ability to debug an optimized program compiled with
8752 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8753 prevents SSA coalescing of user variables.  This option is enabled by
8754 default if optimization is enabled, and it does very little otherwise.
8756 @item -ftree-loop-if-convert
8757 @opindex ftree-loop-if-convert
8758 Attempt to transform conditional jumps in the innermost loops to
8759 branch-less equivalents.  The intent is to remove control-flow from
8760 the innermost loops in order to improve the ability of the
8761 vectorization pass to handle these loops.  This is enabled by default
8762 if vectorization is enabled.
8764 @item -ftree-loop-distribution
8765 @opindex ftree-loop-distribution
8766 Perform loop distribution.  This flag can improve cache performance on
8767 big loop bodies and allow further loop optimizations, like
8768 parallelization or vectorization, to take place.  For example, the loop
8769 @smallexample
8770 DO I = 1, N
8771   A(I) = B(I) + C
8772   D(I) = E(I) * F
8773 ENDDO
8774 @end smallexample
8775 is transformed to
8776 @smallexample
8777 DO I = 1, N
8778    A(I) = B(I) + C
8779 ENDDO
8780 DO I = 1, N
8781    D(I) = E(I) * F
8782 ENDDO
8783 @end smallexample
8785 @item -ftree-loop-distribute-patterns
8786 @opindex ftree-loop-distribute-patterns
8787 Perform loop distribution of patterns that can be code generated with
8788 calls to a library.  This flag is enabled by default at @option{-O3}.
8790 This pass distributes the initialization loops and generates a call to
8791 memset zero.  For example, the loop
8792 @smallexample
8793 DO I = 1, N
8794   A(I) = 0
8795   B(I) = A(I) + I
8796 ENDDO
8797 @end smallexample
8798 is transformed to
8799 @smallexample
8800 DO I = 1, N
8801    A(I) = 0
8802 ENDDO
8803 DO I = 1, N
8804    B(I) = A(I) + I
8805 ENDDO
8806 @end smallexample
8807 and the initialization loop is transformed into a call to memset zero.
8809 @item -floop-interchange
8810 @opindex floop-interchange
8811 Perform loop interchange outside of graphite.  This flag can improve cache
8812 performance on loop nest and allow further loop optimizations, like
8813 vectorization, to take place.  For example, the loop
8814 @smallexample
8815 for (int i = 0; i < N; i++)
8816   for (int j = 0; j < N; j++)
8817     for (int k = 0; k < N; k++)
8818       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8819 @end smallexample
8820 is transformed to
8821 @smallexample
8822 for (int i = 0; i < N; i++)
8823   for (int k = 0; k < N; k++)
8824     for (int j = 0; j < N; j++)
8825       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8826 @end smallexample
8828 @item -ftree-loop-im
8829 @opindex ftree-loop-im
8830 Perform loop invariant motion on trees.  This pass moves only invariants that
8831 are hard to handle at RTL level (function calls, operations that expand to
8832 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8833 operands of conditions that are invariant out of the loop, so that we can use
8834 just trivial invariantness analysis in loop unswitching.  The pass also includes
8835 store motion.
8837 @item -ftree-loop-ivcanon
8838 @opindex ftree-loop-ivcanon
8839 Create a canonical counter for number of iterations in loops for which
8840 determining number of iterations requires complicated analysis.  Later
8841 optimizations then may determine the number easily.  Useful especially
8842 in connection with unrolling.
8844 @item -fivopts
8845 @opindex fivopts
8846 Perform induction variable optimizations (strength reduction, induction
8847 variable merging and induction variable elimination) on trees.
8849 @item -ftree-parallelize-loops=n
8850 @opindex ftree-parallelize-loops
8851 Parallelize loops, i.e., split their iteration space to run in n threads.
8852 This is only possible for loops whose iterations are independent
8853 and can be arbitrarily reordered.  The optimization is only
8854 profitable on multiprocessor machines, for loops that are CPU-intensive,
8855 rather than constrained e.g.@: by memory bandwidth.  This option
8856 implies @option{-pthread}, and thus is only supported on targets
8857 that have support for @option{-pthread}.
8859 @item -ftree-pta
8860 @opindex ftree-pta
8861 Perform function-local points-to analysis on trees.  This flag is
8862 enabled by default at @option{-O} and higher.
8864 @item -ftree-sra
8865 @opindex ftree-sra
8866 Perform scalar replacement of aggregates.  This pass replaces structure
8867 references with scalars to prevent committing structures to memory too
8868 early.  This flag is enabled by default at @option{-O} and higher.
8870 @item -fstore-merging
8871 @opindex fstore-merging
8872 Perform merging of narrow stores to consecutive memory addresses.  This pass
8873 merges contiguous stores of immediate values narrower than a word into fewer
8874 wider stores to reduce the number of instructions.  This is enabled by default
8875 at @option{-O2} and higher as well as @option{-Os}.
8877 @item -ftree-ter
8878 @opindex ftree-ter
8879 Perform temporary expression replacement during the SSA->normal phase.  Single
8880 use/single def temporaries are replaced at their use location with their
8881 defining expression.  This results in non-GIMPLE code, but gives the expanders
8882 much more complex trees to work on resulting in better RTL generation.  This is
8883 enabled by default at @option{-O} and higher.
8885 @item -ftree-slsr
8886 @opindex ftree-slsr
8887 Perform straight-line strength reduction on trees.  This recognizes related
8888 expressions involving multiplications and replaces them by less expensive
8889 calculations when possible.  This is enabled by default at @option{-O} and
8890 higher.
8892 @item -ftree-vectorize
8893 @opindex ftree-vectorize
8894 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8895 and @option{-ftree-slp-vectorize} if not explicitly specified.
8897 @item -ftree-loop-vectorize
8898 @opindex ftree-loop-vectorize
8899 Perform loop vectorization on trees. This flag is enabled by default at
8900 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8902 @item -ftree-slp-vectorize
8903 @opindex ftree-slp-vectorize
8904 Perform basic block vectorization on trees. This flag is enabled by default at
8905 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8907 @item -fvect-cost-model=@var{model}
8908 @opindex fvect-cost-model
8909 Alter the cost model used for vectorization.  The @var{model} argument
8910 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8911 With the @samp{unlimited} model the vectorized code-path is assumed
8912 to be profitable while with the @samp{dynamic} model a runtime check
8913 guards the vectorized code-path to enable it only for iteration
8914 counts that will likely execute faster than when executing the original
8915 scalar loop.  The @samp{cheap} model disables vectorization of
8916 loops where doing so would be cost prohibitive for example due to
8917 required runtime checks for data dependence or alignment but otherwise
8918 is equal to the @samp{dynamic} model.
8919 The default cost model depends on other optimization flags and is
8920 either @samp{dynamic} or @samp{cheap}.
8922 @item -fsimd-cost-model=@var{model}
8923 @opindex fsimd-cost-model
8924 Alter the cost model used for vectorization of loops marked with the OpenMP
8925 or Cilk Plus simd directive.  The @var{model} argument should be one of
8926 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8927 have the same meaning as described in @option{-fvect-cost-model} and by
8928 default a cost model defined with @option{-fvect-cost-model} is used.
8930 @item -ftree-vrp
8931 @opindex ftree-vrp
8932 Perform Value Range Propagation on trees.  This is similar to the
8933 constant propagation pass, but instead of values, ranges of values are
8934 propagated.  This allows the optimizers to remove unnecessary range
8935 checks like array bound checks and null pointer checks.  This is
8936 enabled by default at @option{-O2} and higher.  Null pointer check
8937 elimination is only done if @option{-fdelete-null-pointer-checks} is
8938 enabled.
8940 @item -fsplit-paths
8941 @opindex fsplit-paths
8942 Split paths leading to loop backedges.  This can improve dead code
8943 elimination and common subexpression elimination.  This is enabled by
8944 default at @option{-O2} and above.
8946 @item -fsplit-ivs-in-unroller
8947 @opindex fsplit-ivs-in-unroller
8948 Enables expression of values of induction variables in later iterations
8949 of the unrolled loop using the value in the first iteration.  This breaks
8950 long dependency chains, thus improving efficiency of the scheduling passes.
8952 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8953 same effect.  However, that is not reliable in cases where the loop body
8954 is more complicated than a single basic block.  It also does not work at all
8955 on some architectures due to restrictions in the CSE pass.
8957 This optimization is enabled by default.
8959 @item -fvariable-expansion-in-unroller
8960 @opindex fvariable-expansion-in-unroller
8961 With this option, the compiler creates multiple copies of some
8962 local variables when unrolling a loop, which can result in superior code.
8964 @item -fpartial-inlining
8965 @opindex fpartial-inlining
8966 Inline parts of functions.  This option has any effect only
8967 when inlining itself is turned on by the @option{-finline-functions}
8968 or @option{-finline-small-functions} options.
8970 Enabled at level @option{-O2}.
8972 @item -fpredictive-commoning
8973 @opindex fpredictive-commoning
8974 Perform predictive commoning optimization, i.e., reusing computations
8975 (especially memory loads and stores) performed in previous
8976 iterations of loops.
8978 This option is enabled at level @option{-O3}.
8980 @item -fprefetch-loop-arrays
8981 @opindex fprefetch-loop-arrays
8982 If supported by the target machine, generate instructions to prefetch
8983 memory to improve the performance of loops that access large arrays.
8985 This option may generate better or worse code; results are highly
8986 dependent on the structure of loops within the source code.
8988 Disabled at level @option{-Os}.
8990 @item -fno-printf-return-value
8991 @opindex fno-printf-return-value
8992 Do not substitute constants for known return value of formatted output
8993 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8994 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8995 transformation allows GCC to optimize or even eliminate branches based
8996 on the known return value of these functions called with arguments that
8997 are either constant, or whose values are known to be in a range that
8998 makes determining the exact return value possible.  For example, when
8999 @option{-fprintf-return-value} is in effect, both the branch and the
9000 body of the @code{if} statement (but not the call to @code{snprint})
9001 can be optimized away when @code{i} is a 32-bit or smaller integer
9002 because the return value is guaranteed to be at most 8.
9004 @smallexample
9005 char buf[9];
9006 if (snprintf (buf, "%08x", i) >= sizeof buf)
9007   @dots{}
9008 @end smallexample
9010 The @option{-fprintf-return-value} option relies on other optimizations
9011 and yields best results with @option{-O2}.  It works in tandem with the
9012 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
9013 The @option{-fprintf-return-value} option is enabled by default.
9015 @item -fno-peephole
9016 @itemx -fno-peephole2
9017 @opindex fno-peephole
9018 @opindex fno-peephole2
9019 Disable any machine-specific peephole optimizations.  The difference
9020 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9021 are implemented in the compiler; some targets use one, some use the
9022 other, a few use both.
9024 @option{-fpeephole} is enabled by default.
9025 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9027 @item -fno-guess-branch-probability
9028 @opindex fno-guess-branch-probability
9029 Do not guess branch probabilities using heuristics.
9031 GCC uses heuristics to guess branch probabilities if they are
9032 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9033 heuristics are based on the control flow graph.  If some branch probabilities
9034 are specified by @code{__builtin_expect}, then the heuristics are
9035 used to guess branch probabilities for the rest of the control flow graph,
9036 taking the @code{__builtin_expect} info into account.  The interactions
9037 between the heuristics and @code{__builtin_expect} can be complex, and in
9038 some cases, it may be useful to disable the heuristics so that the effects
9039 of @code{__builtin_expect} are easier to understand.
9041 The default is @option{-fguess-branch-probability} at levels
9042 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9044 @item -freorder-blocks
9045 @opindex freorder-blocks
9046 Reorder basic blocks in the compiled function in order to reduce number of
9047 taken branches and improve code locality.
9049 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9051 @item -freorder-blocks-algorithm=@var{algorithm}
9052 @opindex freorder-blocks-algorithm
9053 Use the specified algorithm for basic block reordering.  The
9054 @var{algorithm} argument can be @samp{simple}, which does not increase
9055 code size (except sometimes due to secondary effects like alignment),
9056 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9057 put all often executed code together, minimizing the number of branches
9058 executed by making extra copies of code.
9060 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9061 @samp{stc} at levels @option{-O2}, @option{-O3}.
9063 @item -freorder-blocks-and-partition
9064 @opindex freorder-blocks-and-partition
9065 In addition to reordering basic blocks in the compiled function, in order
9066 to reduce number of taken branches, partitions hot and cold basic blocks
9067 into separate sections of the assembly and @file{.o} files, to improve
9068 paging and cache locality performance.
9070 This optimization is automatically turned off in the presence of
9071 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9072 section attribute and on any architecture that does not support named
9073 sections.  When @option{-fsplit-stack} is used this option is not
9074 enabled by default (to avoid linker errors), but may be enabled
9075 explicitly (if using a working linker).
9077 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9079 @item -freorder-functions
9080 @opindex freorder-functions
9081 Reorder functions in the object file in order to
9082 improve code locality.  This is implemented by using special
9083 subsections @code{.text.hot} for most frequently executed functions and
9084 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9085 the linker so object file format must support named sections and linker must
9086 place them in a reasonable way.
9088 Also profile feedback must be available to make this option effective.  See
9089 @option{-fprofile-arcs} for details.
9091 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9093 @item -fstrict-aliasing
9094 @opindex fstrict-aliasing
9095 Allow the compiler to assume the strictest aliasing rules applicable to
9096 the language being compiled.  For C (and C++), this activates
9097 optimizations based on the type of expressions.  In particular, an
9098 object of one type is assumed never to reside at the same address as an
9099 object of a different type, unless the types are almost the same.  For
9100 example, an @code{unsigned int} can alias an @code{int}, but not a
9101 @code{void*} or a @code{double}.  A character type may alias any other
9102 type.
9104 @anchor{Type-punning}Pay special attention to code like this:
9105 @smallexample
9106 union a_union @{
9107   int i;
9108   double d;
9111 int f() @{
9112   union a_union t;
9113   t.d = 3.0;
9114   return t.i;
9116 @end smallexample
9117 The practice of reading from a different union member than the one most
9118 recently written to (called ``type-punning'') is common.  Even with
9119 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9120 is accessed through the union type.  So, the code above works as
9121 expected.  @xref{Structures unions enumerations and bit-fields
9122 implementation}.  However, this code might not:
9123 @smallexample
9124 int f() @{
9125   union a_union t;
9126   int* ip;
9127   t.d = 3.0;
9128   ip = &t.i;
9129   return *ip;
9131 @end smallexample
9133 Similarly, access by taking the address, casting the resulting pointer
9134 and dereferencing the result has undefined behavior, even if the cast
9135 uses a union type, e.g.:
9136 @smallexample
9137 int f() @{
9138   double d = 3.0;
9139   return ((union a_union *) &d)->i;
9141 @end smallexample
9143 The @option{-fstrict-aliasing} option is enabled at levels
9144 @option{-O2}, @option{-O3}, @option{-Os}.
9146 @item -falign-functions
9147 @itemx -falign-functions=@var{n}
9148 @opindex falign-functions
9149 Align the start of functions to the next power-of-two greater than
9150 @var{n}, skipping up to @var{n} bytes.  For instance,
9151 @option{-falign-functions=32} aligns functions to the next 32-byte
9152 boundary, but @option{-falign-functions=24} aligns to the next
9153 32-byte boundary only if this can be done by skipping 23 bytes or less.
9155 @option{-fno-align-functions} and @option{-falign-functions=1} are
9156 equivalent and mean that functions are not aligned.
9158 Some assemblers only support this flag when @var{n} is a power of two;
9159 in that case, it is rounded up.
9161 If @var{n} is not specified or is zero, use a machine-dependent default.
9163 Enabled at levels @option{-O2}, @option{-O3}.
9165 @item -flimit-function-alignment
9166 If this option is enabled, the compiler tries to avoid unnecessarily
9167 overaligning functions. It attempts to instruct the assembler to align
9168 by the amount specified by @option{-falign-functions}, but not to
9169 skip more bytes than the size of the function.
9171 @item -falign-labels
9172 @itemx -falign-labels=@var{n}
9173 @opindex falign-labels
9174 Align all branch targets to a power-of-two boundary, skipping up to
9175 @var{n} bytes like @option{-falign-functions}.  This option can easily
9176 make code slower, because it must insert dummy operations for when the
9177 branch target is reached in the usual flow of the code.
9179 @option{-fno-align-labels} and @option{-falign-labels=1} are
9180 equivalent and mean that labels are not aligned.
9182 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9183 are greater than this value, then their values are used instead.
9185 If @var{n} is not specified or is zero, use a machine-dependent default
9186 which is very likely to be @samp{1}, meaning no alignment.
9188 Enabled at levels @option{-O2}, @option{-O3}.
9190 @item -falign-loops
9191 @itemx -falign-loops=@var{n}
9192 @opindex falign-loops
9193 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9194 like @option{-falign-functions}.  If the loops are
9195 executed many times, this makes up for any execution of the dummy
9196 operations.
9198 @option{-fno-align-loops} and @option{-falign-loops=1} are
9199 equivalent and mean that loops are not aligned.
9201 If @var{n} is not specified or is zero, use a machine-dependent default.
9203 Enabled at levels @option{-O2}, @option{-O3}.
9205 @item -falign-jumps
9206 @itemx -falign-jumps=@var{n}
9207 @opindex falign-jumps
9208 Align branch targets to a power-of-two boundary, for branch targets
9209 where the targets can only be reached by jumping, skipping up to @var{n}
9210 bytes like @option{-falign-functions}.  In this case, no dummy operations
9211 need be executed.
9213 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9214 equivalent and mean that loops are not aligned.
9216 If @var{n} is not specified or is zero, use a machine-dependent default.
9218 Enabled at levels @option{-O2}, @option{-O3}.
9220 @item -funit-at-a-time
9221 @opindex funit-at-a-time
9222 This option is left for compatibility reasons. @option{-funit-at-a-time}
9223 has no effect, while @option{-fno-unit-at-a-time} implies
9224 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9226 Enabled by default.
9228 @item -fno-toplevel-reorder
9229 @opindex fno-toplevel-reorder
9230 Do not reorder top-level functions, variables, and @code{asm}
9231 statements.  Output them in the same order that they appear in the
9232 input file.  When this option is used, unreferenced static variables
9233 are not removed.  This option is intended to support existing code
9234 that relies on a particular ordering.  For new code, it is better to
9235 use attributes when possible.
9237 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9238 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9239 targets.
9241 @item -fweb
9242 @opindex fweb
9243 Constructs webs as commonly used for register allocation purposes and assign
9244 each web individual pseudo register.  This allows the register allocation pass
9245 to operate on pseudos directly, but also strengthens several other optimization
9246 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9247 however, make debugging impossible, since variables no longer stay in a
9248 ``home register''.
9250 Enabled by default with @option{-funroll-loops}.
9252 @item -fwhole-program
9253 @opindex fwhole-program
9254 Assume that the current compilation unit represents the whole program being
9255 compiled.  All public functions and variables with the exception of @code{main}
9256 and those merged by attribute @code{externally_visible} become static functions
9257 and in effect are optimized more aggressively by interprocedural optimizers.
9259 This option should not be used in combination with @option{-flto}.
9260 Instead relying on a linker plugin should provide safer and more precise
9261 information.
9263 @item -flto[=@var{n}]
9264 @opindex flto
9265 This option runs the standard link-time optimizer.  When invoked
9266 with source code, it generates GIMPLE (one of GCC's internal
9267 representations) and writes it to special ELF sections in the object
9268 file.  When the object files are linked together, all the function
9269 bodies are read from these ELF sections and instantiated as if they
9270 had been part of the same translation unit.
9272 To use the link-time optimizer, @option{-flto} and optimization
9273 options should be specified at compile time and during the final link.
9274 It is recommended that you compile all the files participating in the
9275 same link with the same options and also specify those options at
9276 link time.  
9277 For example:
9279 @smallexample
9280 gcc -c -O2 -flto foo.c
9281 gcc -c -O2 -flto bar.c
9282 gcc -o myprog -flto -O2 foo.o bar.o
9283 @end smallexample
9285 The first two invocations to GCC save a bytecode representation
9286 of GIMPLE into special ELF sections inside @file{foo.o} and
9287 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9288 @file{foo.o} and @file{bar.o}, merges the two files into a single
9289 internal image, and compiles the result as usual.  Since both
9290 @file{foo.o} and @file{bar.o} are merged into a single image, this
9291 causes all the interprocedural analyses and optimizations in GCC to
9292 work across the two files as if they were a single one.  This means,
9293 for example, that the inliner is able to inline functions in
9294 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9296 Another (simpler) way to enable link-time optimization is:
9298 @smallexample
9299 gcc -o myprog -flto -O2 foo.c bar.c
9300 @end smallexample
9302 The above generates bytecode for @file{foo.c} and @file{bar.c},
9303 merges them together into a single GIMPLE representation and optimizes
9304 them as usual to produce @file{myprog}.
9306 The only important thing to keep in mind is that to enable link-time
9307 optimizations you need to use the GCC driver to perform the link step.
9308 GCC then automatically performs link-time optimization if any of the
9309 objects involved were compiled with the @option{-flto} command-line option.  
9310 You generally
9311 should specify the optimization options to be used for link-time
9312 optimization though GCC tries to be clever at guessing an
9313 optimization level to use from the options used at compile time
9314 if you fail to specify one at link time.  You can always override
9315 the automatic decision to do link-time optimization
9316 by passing @option{-fno-lto} to the link command.
9318 To make whole program optimization effective, it is necessary to make
9319 certain whole program assumptions.  The compiler needs to know
9320 what functions and variables can be accessed by libraries and runtime
9321 outside of the link-time optimized unit.  When supported by the linker,
9322 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9323 to the compiler about used and externally visible symbols.  When
9324 the linker plugin is not available, @option{-fwhole-program} should be
9325 used to allow the compiler to make these assumptions, which leads
9326 to more aggressive optimization decisions.
9328 When @option{-fuse-linker-plugin} is not enabled, when a file is
9329 compiled with @option{-flto}, the generated object file is larger than
9330 a regular object file because it contains GIMPLE bytecodes and the usual
9331 final code (see @option{-ffat-lto-objects}.  This means that
9332 object files with LTO information can be linked as normal object
9333 files; if @option{-fno-lto} is passed to the linker, no
9334 interprocedural optimizations are applied.  Note that when
9335 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9336 but you cannot perform a regular, non-LTO link on them.
9338 Additionally, the optimization flags used to compile individual files
9339 are not necessarily related to those used at link time.  For instance,
9341 @smallexample
9342 gcc -c -O0 -ffat-lto-objects -flto foo.c
9343 gcc -c -O0 -ffat-lto-objects -flto bar.c
9344 gcc -o myprog -O3 foo.o bar.o
9345 @end smallexample
9347 This produces individual object files with unoptimized assembler
9348 code, but the resulting binary @file{myprog} is optimized at
9349 @option{-O3}.  If, instead, the final binary is generated with
9350 @option{-fno-lto}, then @file{myprog} is not optimized.
9352 When producing the final binary, GCC only
9353 applies link-time optimizations to those files that contain bytecode.
9354 Therefore, you can mix and match object files and libraries with
9355 GIMPLE bytecodes and final object code.  GCC automatically selects
9356 which files to optimize in LTO mode and which files to link without
9357 further processing.
9359 There are some code generation flags preserved by GCC when
9360 generating bytecodes, as they need to be used during the final link
9361 stage.  Generally options specified at link time override those
9362 specified at compile time.
9364 If you do not specify an optimization level option @option{-O} at
9365 link time, then GCC uses the highest optimization level 
9366 used when compiling the object files.
9368 Currently, the following options and their settings are taken from
9369 the first object file that explicitly specifies them: 
9370 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9371 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9372 and all the @option{-m} target flags.
9374 Certain ABI-changing flags are required to match in all compilation units,
9375 and trying to override this at link time with a conflicting value
9376 is ignored.  This includes options such as @option{-freg-struct-return}
9377 and @option{-fpcc-struct-return}. 
9379 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9380 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9381 are passed through to the link stage and merged conservatively for
9382 conflicting translation units.  Specifically
9383 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9384 precedence; and for example @option{-ffp-contract=off} takes precedence
9385 over @option{-ffp-contract=fast}.  You can override them at link time.
9387 If LTO encounters objects with C linkage declared with incompatible
9388 types in separate translation units to be linked together (undefined
9389 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9390 issued.  The behavior is still undefined at run time.  Similar
9391 diagnostics may be raised for other languages.
9393 Another feature of LTO is that it is possible to apply interprocedural
9394 optimizations on files written in different languages:
9396 @smallexample
9397 gcc -c -flto foo.c
9398 g++ -c -flto bar.cc
9399 gfortran -c -flto baz.f90
9400 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9401 @end smallexample
9403 Notice that the final link is done with @command{g++} to get the C++
9404 runtime libraries and @option{-lgfortran} is added to get the Fortran
9405 runtime libraries.  In general, when mixing languages in LTO mode, you
9406 should use the same link command options as when mixing languages in a
9407 regular (non-LTO) compilation.
9409 If object files containing GIMPLE bytecode are stored in a library archive, say
9410 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9411 are using a linker with plugin support.  To create static libraries suitable
9412 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9413 and @command{ranlib}; 
9414 to show the symbols of object files with GIMPLE bytecode, use
9415 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9416 and @command{nm} have been compiled with plugin support.  At link time, use the the
9417 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9418 the LTO optimization process:
9420 @smallexample
9421 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9422 @end smallexample
9424 With the linker plugin enabled, the linker extracts the needed
9425 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9426 to make them part of the aggregated GIMPLE image to be optimized.
9428 If you are not using a linker with plugin support and/or do not
9429 enable the linker plugin, then the objects inside @file{libfoo.a}
9430 are extracted and linked as usual, but they do not participate
9431 in the LTO optimization process.  In order to make a static library suitable
9432 for both LTO optimization and usual linkage, compile its object files with
9433 @option{-flto} @option{-ffat-lto-objects}.
9435 Link-time optimizations do not require the presence of the whole program to
9436 operate.  If the program does not require any symbols to be exported, it is
9437 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9438 the interprocedural optimizers to use more aggressive assumptions which may
9439 lead to improved optimization opportunities.
9440 Use of @option{-fwhole-program} is not needed when linker plugin is
9441 active (see @option{-fuse-linker-plugin}).
9443 The current implementation of LTO makes no
9444 attempt to generate bytecode that is portable between different
9445 types of hosts.  The bytecode files are versioned and there is a
9446 strict version check, so bytecode files generated in one version of
9447 GCC do not work with an older or newer version of GCC.
9449 Link-time optimization does not work well with generation of debugging
9450 information.  Combining @option{-flto} with
9451 @option{-g} is currently experimental and expected to produce unexpected
9452 results.
9454 If you specify the optional @var{n}, the optimization and code
9455 generation done at link time is executed in parallel using @var{n}
9456 parallel jobs by utilizing an installed @command{make} program.  The
9457 environment variable @env{MAKE} may be used to override the program
9458 used.  The default value for @var{n} is 1.
9460 You can also specify @option{-flto=jobserver} to use GNU make's
9461 job server mode to determine the number of parallel jobs. This
9462 is useful when the Makefile calling GCC is already executing in parallel.
9463 You must prepend a @samp{+} to the command recipe in the parent Makefile
9464 for this to work.  This option likely only works if @env{MAKE} is
9465 GNU make.
9467 @item -flto-partition=@var{alg}
9468 @opindex flto-partition
9469 Specify the partitioning algorithm used by the link-time optimizer.
9470 The value is either @samp{1to1} to specify a partitioning mirroring
9471 the original source files or @samp{balanced} to specify partitioning
9472 into equally sized chunks (whenever possible) or @samp{max} to create
9473 new partition for every symbol where possible.  Specifying @samp{none}
9474 as an algorithm disables partitioning and streaming completely. 
9475 The default value is @samp{balanced}. While @samp{1to1} can be used
9476 as an workaround for various code ordering issues, the @samp{max}
9477 partitioning is intended for internal testing only.
9478 The value @samp{one} specifies that exactly one partition should be
9479 used while the value @samp{none} bypasses partitioning and executes
9480 the link-time optimization step directly from the WPA phase.
9482 @item -flto-odr-type-merging
9483 @opindex flto-odr-type-merging
9484 Enable streaming of mangled types names of C++ types and their unification
9485 at link time.  This increases size of LTO object files, but enables
9486 diagnostics about One Definition Rule violations.
9488 @item -flto-compression-level=@var{n}
9489 @opindex flto-compression-level
9490 This option specifies the level of compression used for intermediate
9491 language written to LTO object files, and is only meaningful in
9492 conjunction with LTO mode (@option{-flto}).  Valid
9493 values are 0 (no compression) to 9 (maximum compression).  Values
9494 outside this range are clamped to either 0 or 9.  If the option is not
9495 given, a default balanced compression setting is used.
9497 @item -fuse-linker-plugin
9498 @opindex fuse-linker-plugin
9499 Enables the use of a linker plugin during link-time optimization.  This
9500 option relies on plugin support in the linker, which is available in gold
9501 or in GNU ld 2.21 or newer.
9503 This option enables the extraction of object files with GIMPLE bytecode out
9504 of library archives. This improves the quality of optimization by exposing
9505 more code to the link-time optimizer.  This information specifies what
9506 symbols can be accessed externally (by non-LTO object or during dynamic
9507 linking).  Resulting code quality improvements on binaries (and shared
9508 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9509 See @option{-flto} for a description of the effect of this flag and how to
9510 use it.
9512 This option is enabled by default when LTO support in GCC is enabled
9513 and GCC was configured for use with
9514 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9516 @item -ffat-lto-objects
9517 @opindex ffat-lto-objects
9518 Fat LTO objects are object files that contain both the intermediate language
9519 and the object code. This makes them usable for both LTO linking and normal
9520 linking. This option is effective only when compiling with @option{-flto}
9521 and is ignored at link time.
9523 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9524 requires the complete toolchain to be aware of LTO. It requires a linker with
9525 linker plugin support for basic functionality.  Additionally,
9526 @command{nm}, @command{ar} and @command{ranlib}
9527 need to support linker plugins to allow a full-featured build environment
9528 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9529 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9530 to these tools. With non fat LTO makefiles need to be modified to use them.
9532 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9533 support.
9535 @item -fcompare-elim
9536 @opindex fcompare-elim
9537 After register allocation and post-register allocation instruction splitting,
9538 identify arithmetic instructions that compute processor flags similar to a
9539 comparison operation based on that arithmetic.  If possible, eliminate the
9540 explicit comparison operation.
9542 This pass only applies to certain targets that cannot explicitly represent
9543 the comparison operation before register allocation is complete.
9545 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9547 @item -fcprop-registers
9548 @opindex fcprop-registers
9549 After register allocation and post-register allocation instruction splitting,
9550 perform a copy-propagation pass to try to reduce scheduling dependencies
9551 and occasionally eliminate the copy.
9553 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9555 @item -fprofile-correction
9556 @opindex fprofile-correction
9557 Profiles collected using an instrumented binary for multi-threaded programs may
9558 be inconsistent due to missed counter updates. When this option is specified,
9559 GCC uses heuristics to correct or smooth out such inconsistencies. By
9560 default, GCC emits an error message when an inconsistent profile is detected.
9562 @item -fprofile-use
9563 @itemx -fprofile-use=@var{path}
9564 @opindex fprofile-use
9565 Enable profile feedback-directed optimizations, 
9566 and the following optimizations
9567 which are generally profitable only with profile feedback available:
9568 @option{-fbranch-probabilities}, @option{-fvpt},
9569 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9570 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9572 Before you can use this option, you must first generate profiling information.
9573 @xref{Instrumentation Options}, for information about the
9574 @option{-fprofile-generate} option.
9576 By default, GCC emits an error message if the feedback profiles do not
9577 match the source code.  This error can be turned into a warning by using
9578 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9579 code.
9581 If @var{path} is specified, GCC looks at the @var{path} to find
9582 the profile feedback data files. See @option{-fprofile-dir}.
9584 @item -fauto-profile
9585 @itemx -fauto-profile=@var{path}
9586 @opindex fauto-profile
9587 Enable sampling-based feedback-directed optimizations, 
9588 and the following optimizations
9589 which are generally profitable only with profile feedback available:
9590 @option{-fbranch-probabilities}, @option{-fvpt},
9591 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9592 @option{-ftree-vectorize},
9593 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9594 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9595 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9597 @var{path} is the name of a file containing AutoFDO profile information.
9598 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9600 Producing an AutoFDO profile data file requires running your program
9601 with the @command{perf} utility on a supported GNU/Linux target system.
9602 For more information, see @uref{https://perf.wiki.kernel.org/}.
9604 E.g.
9605 @smallexample
9606 perf record -e br_inst_retired:near_taken -b -o perf.data \
9607     -- your_program
9608 @end smallexample
9610 Then use the @command{create_gcov} tool to convert the raw profile data
9611 to a format that can be used by GCC.@  You must also supply the 
9612 unstripped binary for your program to this tool.  
9613 See @uref{https://github.com/google/autofdo}.
9615 E.g.
9616 @smallexample
9617 create_gcov --binary=your_program.unstripped --profile=perf.data \
9618     --gcov=profile.afdo
9619 @end smallexample
9620 @end table
9622 The following options control compiler behavior regarding floating-point 
9623 arithmetic.  These options trade off between speed and
9624 correctness.  All must be specifically enabled.
9626 @table @gcctabopt
9627 @item -ffloat-store
9628 @opindex ffloat-store
9629 Do not store floating-point variables in registers, and inhibit other
9630 options that might change whether a floating-point value is taken from a
9631 register or memory.
9633 @cindex floating-point precision
9634 This option prevents undesirable excess precision on machines such as
9635 the 68000 where the floating registers (of the 68881) keep more
9636 precision than a @code{double} is supposed to have.  Similarly for the
9637 x86 architecture.  For most programs, the excess precision does only
9638 good, but a few programs rely on the precise definition of IEEE floating
9639 point.  Use @option{-ffloat-store} for such programs, after modifying
9640 them to store all pertinent intermediate computations into variables.
9642 @item -fexcess-precision=@var{style}
9643 @opindex fexcess-precision
9644 This option allows further control over excess precision on machines
9645 where floating-point operations occur in a format with more precision or
9646 range than the IEEE standard and interchange floating-point types.  By
9647 default, @option{-fexcess-precision=fast} is in effect; this means that
9648 operations may be carried out in a wider precision than the types specified
9649 in the source if that would result in faster code, and it is unpredictable
9650 when rounding to the types specified in the source code takes place.
9651 When compiling C, if @option{-fexcess-precision=standard} is specified then
9652 excess precision follows the rules specified in ISO C99; in particular,
9653 both casts and assignments cause values to be rounded to their
9654 semantic types (whereas @option{-ffloat-store} only affects
9655 assignments).  This option is enabled by default for C if a strict
9656 conformance option such as @option{-std=c99} is used.
9657 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9658 regardless of whether a strict conformance option is used.
9660 @opindex mfpmath
9661 @option{-fexcess-precision=standard} is not implemented for languages
9662 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9663 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9664 semantics apply without excess precision, and in the latter, rounding
9665 is unpredictable.
9667 @item -ffast-math
9668 @opindex ffast-math
9669 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9670 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9671 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9672 @option{-fexcess-precision=fast}.
9674 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9676 This option is not turned on by any @option{-O} option besides
9677 @option{-Ofast} since it can result in incorrect output for programs
9678 that depend on an exact implementation of IEEE or ISO rules/specifications
9679 for math functions. It may, however, yield faster code for programs
9680 that do not require the guarantees of these specifications.
9682 @item -fno-math-errno
9683 @opindex fno-math-errno
9684 Do not set @code{errno} after calling math functions that are executed
9685 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9686 IEEE exceptions for math error handling may want to use this flag
9687 for speed while maintaining IEEE arithmetic compatibility.
9689 This option is not turned on by any @option{-O} option since
9690 it can result in incorrect output for programs that depend on
9691 an exact implementation of IEEE or ISO rules/specifications for
9692 math functions. It may, however, yield faster code for programs
9693 that do not require the guarantees of these specifications.
9695 The default is @option{-fmath-errno}.
9697 On Darwin systems, the math library never sets @code{errno}.  There is
9698 therefore no reason for the compiler to consider the possibility that
9699 it might, and @option{-fno-math-errno} is the default.
9701 @item -funsafe-math-optimizations
9702 @opindex funsafe-math-optimizations
9704 Allow optimizations for floating-point arithmetic that (a) assume
9705 that arguments and results are valid and (b) may violate IEEE or
9706 ANSI standards.  When used at link time, it may include libraries
9707 or startup files that change the default FPU control word or other
9708 similar optimizations.
9710 This option is not turned on by any @option{-O} option since
9711 it can result in incorrect output for programs that depend on
9712 an exact implementation of IEEE or ISO rules/specifications for
9713 math functions. It may, however, yield faster code for programs
9714 that do not require the guarantees of these specifications.
9715 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9716 @option{-fassociative-math} and @option{-freciprocal-math}.
9718 The default is @option{-fno-unsafe-math-optimizations}.
9720 @item -fassociative-math
9721 @opindex fassociative-math
9723 Allow re-association of operands in series of floating-point operations.
9724 This violates the ISO C and C++ language standard by possibly changing
9725 computation result.  NOTE: re-ordering may change the sign of zero as
9726 well as ignore NaNs and inhibit or create underflow or overflow (and
9727 thus cannot be used on code that relies on rounding behavior like
9728 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9729 and thus may not be used when ordered comparisons are required.
9730 This option requires that both @option{-fno-signed-zeros} and
9731 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9732 much sense with @option{-frounding-math}. For Fortran the option
9733 is automatically enabled when both @option{-fno-signed-zeros} and
9734 @option{-fno-trapping-math} are in effect.
9736 The default is @option{-fno-associative-math}.
9738 @item -freciprocal-math
9739 @opindex freciprocal-math
9741 Allow the reciprocal of a value to be used instead of dividing by
9742 the value if this enables optimizations.  For example @code{x / y}
9743 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9744 is subject to common subexpression elimination.  Note that this loses
9745 precision and increases the number of flops operating on the value.
9747 The default is @option{-fno-reciprocal-math}.
9749 @item -ffinite-math-only
9750 @opindex ffinite-math-only
9751 Allow optimizations for floating-point arithmetic that assume
9752 that arguments and results are not NaNs or +-Infs.
9754 This option is not turned on by any @option{-O} option since
9755 it can result in incorrect output for programs that depend on
9756 an exact implementation of IEEE or ISO rules/specifications for
9757 math functions. It may, however, yield faster code for programs
9758 that do not require the guarantees of these specifications.
9760 The default is @option{-fno-finite-math-only}.
9762 @item -fno-signed-zeros
9763 @opindex fno-signed-zeros
9764 Allow optimizations for floating-point arithmetic that ignore the
9765 signedness of zero.  IEEE arithmetic specifies the behavior of
9766 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9767 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9768 This option implies that the sign of a zero result isn't significant.
9770 The default is @option{-fsigned-zeros}.
9772 @item -fno-trapping-math
9773 @opindex fno-trapping-math
9774 Compile code assuming that floating-point operations cannot generate
9775 user-visible traps.  These traps include division by zero, overflow,
9776 underflow, inexact result and invalid operation.  This option requires
9777 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9778 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9780 This option should never be turned on by any @option{-O} option since
9781 it can result in incorrect output for programs that depend on
9782 an exact implementation of IEEE or ISO rules/specifications for
9783 math functions.
9785 The default is @option{-ftrapping-math}.
9787 @item -frounding-math
9788 @opindex frounding-math
9789 Disable transformations and optimizations that assume default floating-point
9790 rounding behavior.  This is round-to-zero for all floating point
9791 to integer conversions, and round-to-nearest for all other arithmetic
9792 truncations.  This option should be specified for programs that change
9793 the FP rounding mode dynamically, or that may be executed with a
9794 non-default rounding mode.  This option disables constant folding of
9795 floating-point expressions at compile time (which may be affected by
9796 rounding mode) and arithmetic transformations that are unsafe in the
9797 presence of sign-dependent rounding modes.
9799 The default is @option{-fno-rounding-math}.
9801 This option is experimental and does not currently guarantee to
9802 disable all GCC optimizations that are affected by rounding mode.
9803 Future versions of GCC may provide finer control of this setting
9804 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9805 will be used to specify the default state for @code{FENV_ACCESS}.
9807 @item -fsignaling-nans
9808 @opindex fsignaling-nans
9809 Compile code assuming that IEEE signaling NaNs may generate user-visible
9810 traps during floating-point operations.  Setting this option disables
9811 optimizations that may change the number of exceptions visible with
9812 signaling NaNs.  This option implies @option{-ftrapping-math}.
9814 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9815 be defined.
9817 The default is @option{-fno-signaling-nans}.
9819 This option is experimental and does not currently guarantee to
9820 disable all GCC optimizations that affect signaling NaN behavior.
9822 @item -fno-fp-int-builtin-inexact
9823 @opindex fno-fp-int-builtin-inexact
9824 Do not allow the built-in functions @code{ceil}, @code{floor},
9825 @code{round} and @code{trunc}, and their @code{float} and @code{long
9826 double} variants, to generate code that raises the ``inexact''
9827 floating-point exception for noninteger arguments.  ISO C99 and C11
9828 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9829 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9830 functions to do so.
9832 The default is @option{-ffp-int-builtin-inexact}, allowing the
9833 exception to be raised.  This option does nothing unless
9834 @option{-ftrapping-math} is in effect.
9836 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9837 generate a call to a library function then the ``inexact'' exception
9838 may be raised if the library implementation does not follow TS 18661.
9840 @item -fsingle-precision-constant
9841 @opindex fsingle-precision-constant
9842 Treat floating-point constants as single precision instead of
9843 implicitly converting them to double-precision constants.
9845 @item -fcx-limited-range
9846 @opindex fcx-limited-range
9847 When enabled, this option states that a range reduction step is not
9848 needed when performing complex division.  Also, there is no checking
9849 whether the result of a complex multiplication or division is @code{NaN
9850 + I*NaN}, with an attempt to rescue the situation in that case.  The
9851 default is @option{-fno-cx-limited-range}, but is enabled by
9852 @option{-ffast-math}.
9854 This option controls the default setting of the ISO C99
9855 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9856 all languages.
9858 @item -fcx-fortran-rules
9859 @opindex fcx-fortran-rules
9860 Complex multiplication and division follow Fortran rules.  Range
9861 reduction is done as part of complex division, but there is no checking
9862 whether the result of a complex multiplication or division is @code{NaN
9863 + I*NaN}, with an attempt to rescue the situation in that case.
9865 The default is @option{-fno-cx-fortran-rules}.
9867 @end table
9869 The following options control optimizations that may improve
9870 performance, but are not enabled by any @option{-O} options.  This
9871 section includes experimental options that may produce broken code.
9873 @table @gcctabopt
9874 @item -fbranch-probabilities
9875 @opindex fbranch-probabilities
9876 After running a program compiled with @option{-fprofile-arcs}
9877 (@pxref{Instrumentation Options}),
9878 you can compile it a second time using
9879 @option{-fbranch-probabilities}, to improve optimizations based on
9880 the number of times each branch was taken.  When a program
9881 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9882 counts to a file called @file{@var{sourcename}.gcda} for each source
9883 file.  The information in this data file is very dependent on the
9884 structure of the generated code, so you must use the same source code
9885 and the same optimization options for both compilations.
9887 With @option{-fbranch-probabilities}, GCC puts a
9888 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9889 These can be used to improve optimization.  Currently, they are only
9890 used in one place: in @file{reorg.c}, instead of guessing which path a
9891 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9892 exactly determine which path is taken more often.
9894 @item -fprofile-values
9895 @opindex fprofile-values
9896 If combined with @option{-fprofile-arcs}, it adds code so that some
9897 data about values of expressions in the program is gathered.
9899 With @option{-fbranch-probabilities}, it reads back the data gathered
9900 from profiling values of expressions for usage in optimizations.
9902 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9904 @item -fprofile-reorder-functions
9905 @opindex fprofile-reorder-functions
9906 Function reordering based on profile instrumentation collects
9907 first time of execution of a function and orders these functions
9908 in ascending order.
9910 Enabled with @option{-fprofile-use}.
9912 @item -fvpt
9913 @opindex fvpt
9914 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9915 to add code to gather information about values of expressions.
9917 With @option{-fbranch-probabilities}, it reads back the data gathered
9918 and actually performs the optimizations based on them.
9919 Currently the optimizations include specialization of division operations
9920 using the knowledge about the value of the denominator.
9922 @item -frename-registers
9923 @opindex frename-registers
9924 Attempt to avoid false dependencies in scheduled code by making use
9925 of registers left over after register allocation.  This optimization
9926 most benefits processors with lots of registers.  Depending on the
9927 debug information format adopted by the target, however, it can
9928 make debugging impossible, since variables no longer stay in
9929 a ``home register''.
9931 Enabled by default with @option{-funroll-loops}.
9933 @item -fschedule-fusion
9934 @opindex fschedule-fusion
9935 Performs a target dependent pass over the instruction stream to schedule
9936 instructions of same type together because target machine can execute them
9937 more efficiently if they are adjacent to each other in the instruction flow.
9939 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9941 @item -ftracer
9942 @opindex ftracer
9943 Perform tail duplication to enlarge superblock size.  This transformation
9944 simplifies the control flow of the function allowing other optimizations to do
9945 a better job.
9947 Enabled with @option{-fprofile-use}.
9949 @item -funroll-loops
9950 @opindex funroll-loops
9951 Unroll loops whose number of iterations can be determined at compile time or
9952 upon entry to the loop.  @option{-funroll-loops} implies
9953 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9954 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9955 a small constant number of iterations).  This option makes code larger, and may
9956 or may not make it run faster.
9958 Enabled with @option{-fprofile-use}.
9960 @item -funroll-all-loops
9961 @opindex funroll-all-loops
9962 Unroll all loops, even if their number of iterations is uncertain when
9963 the loop is entered.  This usually makes programs run more slowly.
9964 @option{-funroll-all-loops} implies the same options as
9965 @option{-funroll-loops}.
9967 @item -fpeel-loops
9968 @opindex fpeel-loops
9969 Peels loops for which there is enough information that they do not
9970 roll much (from profile feedback or static analysis).  It also turns on
9971 complete loop peeling (i.e.@: complete removal of loops with small constant
9972 number of iterations).
9974 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9976 @item -fmove-loop-invariants
9977 @opindex fmove-loop-invariants
9978 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9979 at level @option{-O1}
9981 @item -fsplit-loops
9982 @opindex fsplit-loops
9983 Split a loop into two if it contains a condition that's always true
9984 for one side of the iteration space and false for the other.
9986 @item -funswitch-loops
9987 @opindex funswitch-loops
9988 Move branches with loop invariant conditions out of the loop, with duplicates
9989 of the loop on both branches (modified according to result of the condition).
9991 @item -floop-unroll-and-jam
9992 @opindex floop-unroll-and-jam
9993 Apply unroll and jam transformations on feasible loops.  In a loop
9994 nest this unrolls the outer loop by some factor and fuses the resulting
9995 multiple inner loops.
9997 @item -ffunction-sections
9998 @itemx -fdata-sections
9999 @opindex ffunction-sections
10000 @opindex fdata-sections
10001 Place each function or data item into its own section in the output
10002 file if the target supports arbitrary sections.  The name of the
10003 function or the name of the data item determines the section's name
10004 in the output file.
10006 Use these options on systems where the linker can perform optimizations to
10007 improve locality of reference in the instruction space.  Most systems using the
10008 ELF object format have linkers with such optimizations.  On AIX, the linker
10009 rearranges sections (CSECTs) based on the call graph.  The performance impact
10010 varies.
10012 Together with a linker garbage collection (linker @option{--gc-sections}
10013 option) these options may lead to smaller statically-linked executables (after
10014 stripping).
10016 On ELF/DWARF systems these options do not degenerate the quality of the debug
10017 information.  There could be issues with other object files/debug info formats.
10019 Only use these options when there are significant benefits from doing so.  When
10020 you specify these options, the assembler and linker create larger object and
10021 executable files and are also slower.  These options affect code generation.
10022 They prevent optimizations by the compiler and assembler using relative
10023 locations inside a translation unit since the locations are unknown until
10024 link time.  An example of such an optimization is relaxing calls to short call
10025 instructions.
10027 @item -fbranch-target-load-optimize
10028 @opindex fbranch-target-load-optimize
10029 Perform branch target register load optimization before prologue / epilogue
10030 threading.
10031 The use of target registers can typically be exposed only during reload,
10032 thus hoisting loads out of loops and doing inter-block scheduling needs
10033 a separate optimization pass.
10035 @item -fbranch-target-load-optimize2
10036 @opindex fbranch-target-load-optimize2
10037 Perform branch target register load optimization after prologue / epilogue
10038 threading.
10040 @item -fbtr-bb-exclusive
10041 @opindex fbtr-bb-exclusive
10042 When performing branch target register load optimization, don't reuse
10043 branch target registers within any basic block.
10045 @item -fstdarg-opt
10046 @opindex fstdarg-opt
10047 Optimize the prologue of variadic argument functions with respect to usage of
10048 those arguments.
10050 @item -fsection-anchors
10051 @opindex fsection-anchors
10052 Try to reduce the number of symbolic address calculations by using
10053 shared ``anchor'' symbols to address nearby objects.  This transformation
10054 can help to reduce the number of GOT entries and GOT accesses on some
10055 targets.
10057 For example, the implementation of the following function @code{foo}:
10059 @smallexample
10060 static int a, b, c;
10061 int foo (void) @{ return a + b + c; @}
10062 @end smallexample
10064 @noindent
10065 usually calculates the addresses of all three variables, but if you
10066 compile it with @option{-fsection-anchors}, it accesses the variables
10067 from a common anchor point instead.  The effect is similar to the
10068 following pseudocode (which isn't valid C):
10070 @smallexample
10071 int foo (void)
10073   register int *xr = &x;
10074   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10076 @end smallexample
10078 Not all targets support this option.
10080 @item --param @var{name}=@var{value}
10081 @opindex param
10082 In some places, GCC uses various constants to control the amount of
10083 optimization that is done.  For example, GCC does not inline functions
10084 that contain more than a certain number of instructions.  You can
10085 control some of these constants on the command line using the
10086 @option{--param} option.
10088 The names of specific parameters, and the meaning of the values, are
10089 tied to the internals of the compiler, and are subject to change
10090 without notice in future releases.
10092 In each case, the @var{value} is an integer.  The allowable choices for
10093 @var{name} are:
10095 @table @gcctabopt
10096 @item predictable-branch-outcome
10097 When branch is predicted to be taken with probability lower than this threshold
10098 (in percent), then it is considered well predictable. The default is 10.
10100 @item max-rtl-if-conversion-insns
10101 RTL if-conversion tries to remove conditional branches around a block and
10102 replace them with conditionally executed instructions.  This parameter
10103 gives the maximum number of instructions in a block which should be
10104 considered for if-conversion.  The default is 10, though the compiler will
10105 also use other heuristics to decide whether if-conversion is likely to be
10106 profitable.
10108 @item max-rtl-if-conversion-predictable-cost
10109 @itemx max-rtl-if-conversion-unpredictable-cost
10110 RTL if-conversion will try to remove conditional branches around a block
10111 and replace them with conditionally executed instructions.  These parameters
10112 give the maximum permissible cost for the sequence that would be generated
10113 by if-conversion depending on whether the branch is statically determined
10114 to be predictable or not.  The units for this parameter are the same as
10115 those for the GCC internal seq_cost metric.  The compiler will try to
10116 provide a reasonable default for this parameter using the BRANCH_COST
10117 target macro.
10119 @item max-crossjump-edges
10120 The maximum number of incoming edges to consider for cross-jumping.
10121 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10122 the number of edges incoming to each block.  Increasing values mean
10123 more aggressive optimization, making the compilation time increase with
10124 probably small improvement in executable size.
10126 @item min-crossjump-insns
10127 The minimum number of instructions that must be matched at the end
10128 of two blocks before cross-jumping is performed on them.  This
10129 value is ignored in the case where all instructions in the block being
10130 cross-jumped from are matched.  The default value is 5.
10132 @item max-grow-copy-bb-insns
10133 The maximum code size expansion factor when copying basic blocks
10134 instead of jumping.  The expansion is relative to a jump instruction.
10135 The default value is 8.
10137 @item max-goto-duplication-insns
10138 The maximum number of instructions to duplicate to a block that jumps
10139 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10140 passes, GCC factors computed gotos early in the compilation process,
10141 and unfactors them as late as possible.  Only computed jumps at the
10142 end of a basic blocks with no more than max-goto-duplication-insns are
10143 unfactored.  The default value is 8.
10145 @item max-delay-slot-insn-search
10146 The maximum number of instructions to consider when looking for an
10147 instruction to fill a delay slot.  If more than this arbitrary number of
10148 instructions are searched, the time savings from filling the delay slot
10149 are minimal, so stop searching.  Increasing values mean more
10150 aggressive optimization, making the compilation time increase with probably
10151 small improvement in execution time.
10153 @item max-delay-slot-live-search
10154 When trying to fill delay slots, the maximum number of instructions to
10155 consider when searching for a block with valid live register
10156 information.  Increasing this arbitrarily chosen value means more
10157 aggressive optimization, increasing the compilation time.  This parameter
10158 should be removed when the delay slot code is rewritten to maintain the
10159 control-flow graph.
10161 @item max-gcse-memory
10162 The approximate maximum amount of memory that can be allocated in
10163 order to perform the global common subexpression elimination
10164 optimization.  If more memory than specified is required, the
10165 optimization is not done.
10167 @item max-gcse-insertion-ratio
10168 If the ratio of expression insertions to deletions is larger than this value
10169 for any expression, then RTL PRE inserts or removes the expression and thus
10170 leaves partially redundant computations in the instruction stream.  The default value is 20.
10172 @item max-pending-list-length
10173 The maximum number of pending dependencies scheduling allows
10174 before flushing the current state and starting over.  Large functions
10175 with few branches or calls can create excessively large lists which
10176 needlessly consume memory and resources.
10178 @item max-modulo-backtrack-attempts
10179 The maximum number of backtrack attempts the scheduler should make
10180 when modulo scheduling a loop.  Larger values can exponentially increase
10181 compilation time.
10183 @item max-inline-insns-single
10184 Several parameters control the tree inliner used in GCC@.
10185 This number sets the maximum number of instructions (counted in GCC's
10186 internal representation) in a single function that the tree inliner
10187 considers for inlining.  This only affects functions declared
10188 inline and methods implemented in a class declaration (C++).
10189 The default value is 400.
10191 @item max-inline-insns-auto
10192 When you use @option{-finline-functions} (included in @option{-O3}),
10193 a lot of functions that would otherwise not be considered for inlining
10194 by the compiler are investigated.  To those functions, a different
10195 (more restrictive) limit compared to functions declared inline can
10196 be applied.
10197 The default value is 30.
10199 @item inline-min-speedup
10200 When estimated performance improvement of caller + callee runtime exceeds this
10201 threshold (in percent), the function can be inlined regardless of the limit on
10202 @option{--param max-inline-insns-single} and @option{--param
10203 max-inline-insns-auto}.
10204 The default value is 15.
10206 @item large-function-insns
10207 The limit specifying really large functions.  For functions larger than this
10208 limit after inlining, inlining is constrained by
10209 @option{--param large-function-growth}.  This parameter is useful primarily
10210 to avoid extreme compilation time caused by non-linear algorithms used by the
10211 back end.
10212 The default value is 2700.
10214 @item large-function-growth
10215 Specifies maximal growth of large function caused by inlining in percents.
10216 The default value is 100 which limits large function growth to 2.0 times
10217 the original size.
10219 @item large-unit-insns
10220 The limit specifying large translation unit.  Growth caused by inlining of
10221 units larger than this limit is limited by @option{--param inline-unit-growth}.
10222 For small units this might be too tight.
10223 For example, consider a unit consisting of function A
10224 that is inline and B that just calls A three times.  If B is small relative to
10225 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10226 large units consisting of small inlineable functions, however, the overall unit
10227 growth limit is needed to avoid exponential explosion of code size.  Thus for
10228 smaller units, the size is increased to @option{--param large-unit-insns}
10229 before applying @option{--param inline-unit-growth}.  The default is 10000.
10231 @item inline-unit-growth
10232 Specifies maximal overall growth of the compilation unit caused by inlining.
10233 The default value is 20 which limits unit growth to 1.2 times the original
10234 size. Cold functions (either marked cold via an attribute or by profile
10235 feedback) are not accounted into the unit size.
10237 @item ipcp-unit-growth
10238 Specifies maximal overall growth of the compilation unit caused by
10239 interprocedural constant propagation.  The default value is 10 which limits
10240 unit growth to 1.1 times the original size.
10242 @item large-stack-frame
10243 The limit specifying large stack frames.  While inlining the algorithm is trying
10244 to not grow past this limit too much.  The default value is 256 bytes.
10246 @item large-stack-frame-growth
10247 Specifies maximal growth of large stack frames caused by inlining in percents.
10248 The default value is 1000 which limits large stack frame growth to 11 times
10249 the original size.
10251 @item max-inline-insns-recursive
10252 @itemx max-inline-insns-recursive-auto
10253 Specifies the maximum number of instructions an out-of-line copy of a
10254 self-recursive inline
10255 function can grow into by performing recursive inlining.
10257 @option{--param max-inline-insns-recursive} applies to functions
10258 declared inline.
10259 For functions not declared inline, recursive inlining
10260 happens only when @option{-finline-functions} (included in @option{-O3}) is
10261 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10262 default value is 450.
10264 @item max-inline-recursive-depth
10265 @itemx max-inline-recursive-depth-auto
10266 Specifies the maximum recursion depth used for recursive inlining.
10268 @option{--param max-inline-recursive-depth} applies to functions
10269 declared inline.  For functions not declared inline, recursive inlining
10270 happens only when @option{-finline-functions} (included in @option{-O3}) is
10271 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10272 default value is 8.
10274 @item min-inline-recursive-probability
10275 Recursive inlining is profitable only for function having deep recursion
10276 in average and can hurt for function having little recursion depth by
10277 increasing the prologue size or complexity of function body to other
10278 optimizers.
10280 When profile feedback is available (see @option{-fprofile-generate}) the actual
10281 recursion depth can be guessed from the probability that function recurses
10282 via a given call expression.  This parameter limits inlining only to call
10283 expressions whose probability exceeds the given threshold (in percents).
10284 The default value is 10.
10286 @item early-inlining-insns
10287 Specify growth that the early inliner can make.  In effect it increases
10288 the amount of inlining for code having a large abstraction penalty.
10289 The default value is 14.
10291 @item max-early-inliner-iterations
10292 Limit of iterations of the early inliner.  This basically bounds
10293 the number of nested indirect calls the early inliner can resolve.
10294 Deeper chains are still handled by late inlining.
10296 @item comdat-sharing-probability
10297 Probability (in percent) that C++ inline function with comdat visibility
10298 are shared across multiple compilation units.  The default value is 20.
10300 @item profile-func-internal-id
10301 A parameter to control whether to use function internal id in profile
10302 database lookup. If the value is 0, the compiler uses an id that
10303 is based on function assembler name and filename, which makes old profile
10304 data more tolerant to source changes such as function reordering etc.
10305 The default value is 0.
10307 @item min-vect-loop-bound
10308 The minimum number of iterations under which loops are not vectorized
10309 when @option{-ftree-vectorize} is used.  The number of iterations after
10310 vectorization needs to be greater than the value specified by this option
10311 to allow vectorization.  The default value is 0.
10313 @item gcse-cost-distance-ratio
10314 Scaling factor in calculation of maximum distance an expression
10315 can be moved by GCSE optimizations.  This is currently supported only in the
10316 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10317 is with simple expressions, i.e., the expressions that have cost
10318 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10319 hoisting of simple expressions.  The default value is 10.
10321 @item gcse-unrestricted-cost
10322 Cost, roughly measured as the cost of a single typical machine
10323 instruction, at which GCSE optimizations do not constrain
10324 the distance an expression can travel.  This is currently
10325 supported only in the code hoisting pass.  The lesser the cost,
10326 the more aggressive code hoisting is.  Specifying 0 
10327 allows all expressions to travel unrestricted distances.
10328 The default value is 3.
10330 @item max-hoist-depth
10331 The depth of search in the dominator tree for expressions to hoist.
10332 This is used to avoid quadratic behavior in hoisting algorithm.
10333 The value of 0 does not limit on the search, but may slow down compilation
10334 of huge functions.  The default value is 30.
10336 @item max-tail-merge-comparisons
10337 The maximum amount of similar bbs to compare a bb with.  This is used to
10338 avoid quadratic behavior in tree tail merging.  The default value is 10.
10340 @item max-tail-merge-iterations
10341 The maximum amount of iterations of the pass over the function.  This is used to
10342 limit compilation time in tree tail merging.  The default value is 2.
10344 @item store-merging-allow-unaligned
10345 Allow the store merging pass to introduce unaligned stores if it is legal to
10346 do so.  The default value is 1.
10348 @item max-stores-to-merge
10349 The maximum number of stores to attempt to merge into wider stores in the store
10350 merging pass.  The minimum value is 2 and the default is 64.
10352 @item max-unrolled-insns
10353 The maximum number of instructions that a loop may have to be unrolled.
10354 If a loop is unrolled, this parameter also determines how many times
10355 the loop code is unrolled.
10357 @item max-average-unrolled-insns
10358 The maximum number of instructions biased by probabilities of their execution
10359 that a loop may have to be unrolled.  If a loop is unrolled,
10360 this parameter also determines how many times the loop code is unrolled.
10362 @item max-unroll-times
10363 The maximum number of unrollings of a single loop.
10365 @item max-peeled-insns
10366 The maximum number of instructions that a loop may have to be peeled.
10367 If a loop is peeled, this parameter also determines how many times
10368 the loop code is peeled.
10370 @item max-peel-times
10371 The maximum number of peelings of a single loop.
10373 @item max-peel-branches
10374 The maximum number of branches on the hot path through the peeled sequence.
10376 @item max-completely-peeled-insns
10377 The maximum number of insns of a completely peeled loop.
10379 @item max-completely-peel-times
10380 The maximum number of iterations of a loop to be suitable for complete peeling.
10382 @item max-completely-peel-loop-nest-depth
10383 The maximum depth of a loop nest suitable for complete peeling.
10385 @item max-unswitch-insns
10386 The maximum number of insns of an unswitched loop.
10388 @item max-unswitch-level
10389 The maximum number of branches unswitched in a single loop.
10391 @item max-loop-headers-insns
10392 The maximum number of insns in loop header duplicated by the copy loop headers
10393 pass.
10395 @item lim-expensive
10396 The minimum cost of an expensive expression in the loop invariant motion.
10398 @item iv-consider-all-candidates-bound
10399 Bound on number of candidates for induction variables, below which
10400 all candidates are considered for each use in induction variable
10401 optimizations.  If there are more candidates than this,
10402 only the most relevant ones are considered to avoid quadratic time complexity.
10404 @item iv-max-considered-uses
10405 The induction variable optimizations give up on loops that contain more
10406 induction variable uses.
10408 @item iv-always-prune-cand-set-bound
10409 If the number of candidates in the set is smaller than this value,
10410 always try to remove unnecessary ivs from the set
10411 when adding a new one.
10413 @item avg-loop-niter
10414 Average number of iterations of a loop.
10416 @item dse-max-object-size
10417 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10418 Larger values may result in larger compilation times.
10420 @item scev-max-expr-size
10421 Bound on size of expressions used in the scalar evolutions analyzer.
10422 Large expressions slow the analyzer.
10424 @item scev-max-expr-complexity
10425 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10426 Complex expressions slow the analyzer.
10428 @item max-tree-if-conversion-phi-args
10429 Maximum number of arguments in a PHI supported by TREE if conversion
10430 unless the loop is marked with simd pragma.
10432 @item vect-max-version-for-alignment-checks
10433 The maximum number of run-time checks that can be performed when
10434 doing loop versioning for alignment in the vectorizer.
10436 @item vect-max-version-for-alias-checks
10437 The maximum number of run-time checks that can be performed when
10438 doing loop versioning for alias in the vectorizer.
10440 @item vect-max-peeling-for-alignment
10441 The maximum number of loop peels to enhance access alignment
10442 for vectorizer. Value -1 means no limit.
10444 @item max-iterations-to-track
10445 The maximum number of iterations of a loop the brute-force algorithm
10446 for analysis of the number of iterations of the loop tries to evaluate.
10448 @item hot-bb-count-ws-permille
10449 A basic block profile count is considered hot if it contributes to 
10450 the given permillage (i.e. 0...1000) of the entire profiled execution.
10452 @item hot-bb-frequency-fraction
10453 Select fraction of the entry block frequency of executions of basic block in
10454 function given basic block needs to have to be considered hot.
10456 @item max-predicted-iterations
10457 The maximum number of loop iterations we predict statically.  This is useful
10458 in cases where a function contains a single loop with known bound and
10459 another loop with unknown bound.
10460 The known number of iterations is predicted correctly, while
10461 the unknown number of iterations average to roughly 10.  This means that the
10462 loop without bounds appears artificially cold relative to the other one.
10464 @item builtin-expect-probability
10465 Control the probability of the expression having the specified value. This
10466 parameter takes a percentage (i.e. 0 ... 100) as input.
10467 The default probability of 90 is obtained empirically.
10469 @item align-threshold
10471 Select fraction of the maximal frequency of executions of a basic block in
10472 a function to align the basic block.
10474 @item align-loop-iterations
10476 A loop expected to iterate at least the selected number of iterations is
10477 aligned.
10479 @item tracer-dynamic-coverage
10480 @itemx tracer-dynamic-coverage-feedback
10482 This value is used to limit superblock formation once the given percentage of
10483 executed instructions is covered.  This limits unnecessary code size
10484 expansion.
10486 The @option{tracer-dynamic-coverage-feedback} parameter
10487 is used only when profile
10488 feedback is available.  The real profiles (as opposed to statically estimated
10489 ones) are much less balanced allowing the threshold to be larger value.
10491 @item tracer-max-code-growth
10492 Stop tail duplication once code growth has reached given percentage.  This is
10493 a rather artificial limit, as most of the duplicates are eliminated later in
10494 cross jumping, so it may be set to much higher values than is the desired code
10495 growth.
10497 @item tracer-min-branch-ratio
10499 Stop reverse growth when the reverse probability of best edge is less than this
10500 threshold (in percent).
10502 @item tracer-min-branch-probability
10503 @itemx tracer-min-branch-probability-feedback
10505 Stop forward growth if the best edge has probability lower than this
10506 threshold.
10508 Similarly to @option{tracer-dynamic-coverage} two parameters are
10509 provided.  @option{tracer-min-branch-probability-feedback} is used for
10510 compilation with profile feedback and @option{tracer-min-branch-probability}
10511 compilation without.  The value for compilation with profile feedback
10512 needs to be more conservative (higher) in order to make tracer
10513 effective.
10515 @item stack-clash-protection-guard-size
10516 Specify the size of the operating system provided stack guard as
10517 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10518 Acceptable values are between 12 and 30.  Higher values may reduce the
10519 number of explicit probes, but a value larger than the operating system
10520 provided guard will leave code vulnerable to stack clash style attacks.
10522 @item stack-clash-protection-probe-interval
10523 Stack clash protection involves probing stack space as it is allocated.  This
10524 param controls the maximum distance between probes into the stack as 2 raised
10525 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10526 12.  Higher values may reduce the number of explicit probes, but a value
10527 larger than the operating system provided guard will leave code vulnerable to
10528 stack clash style attacks.
10530 @item max-cse-path-length
10532 The maximum number of basic blocks on path that CSE considers.
10533 The default is 10.
10535 @item max-cse-insns
10536 The maximum number of instructions CSE processes before flushing.
10537 The default is 1000.
10539 @item ggc-min-expand
10541 GCC uses a garbage collector to manage its own memory allocation.  This
10542 parameter specifies the minimum percentage by which the garbage
10543 collector's heap should be allowed to expand between collections.
10544 Tuning this may improve compilation speed; it has no effect on code
10545 generation.
10547 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10548 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10549 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10550 GCC is not able to calculate RAM on a particular platform, the lower
10551 bound of 30% is used.  Setting this parameter and
10552 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10553 every opportunity.  This is extremely slow, but can be useful for
10554 debugging.
10556 @item ggc-min-heapsize
10558 Minimum size of the garbage collector's heap before it begins bothering
10559 to collect garbage.  The first collection occurs after the heap expands
10560 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10561 tuning this may improve compilation speed, and has no effect on code
10562 generation.
10564 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10565 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10566 with a lower bound of 4096 (four megabytes) and an upper bound of
10567 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10568 particular platform, the lower bound is used.  Setting this parameter
10569 very large effectively disables garbage collection.  Setting this
10570 parameter and @option{ggc-min-expand} to zero causes a full collection
10571 to occur at every opportunity.
10573 @item max-reload-search-insns
10574 The maximum number of instruction reload should look backward for equivalent
10575 register.  Increasing values mean more aggressive optimization, making the
10576 compilation time increase with probably slightly better performance.
10577 The default value is 100.
10579 @item max-cselib-memory-locations
10580 The maximum number of memory locations cselib should take into account.
10581 Increasing values mean more aggressive optimization, making the compilation time
10582 increase with probably slightly better performance.  The default value is 500.
10584 @item max-sched-ready-insns
10585 The maximum number of instructions ready to be issued the scheduler should
10586 consider at any given time during the first scheduling pass.  Increasing
10587 values mean more thorough searches, making the compilation time increase
10588 with probably little benefit.  The default value is 100.
10590 @item max-sched-region-blocks
10591 The maximum number of blocks in a region to be considered for
10592 interblock scheduling.  The default value is 10.
10594 @item max-pipeline-region-blocks
10595 The maximum number of blocks in a region to be considered for
10596 pipelining in the selective scheduler.  The default value is 15.
10598 @item max-sched-region-insns
10599 The maximum number of insns in a region to be considered for
10600 interblock scheduling.  The default value is 100.
10602 @item max-pipeline-region-insns
10603 The maximum number of insns in a region to be considered for
10604 pipelining in the selective scheduler.  The default value is 200.
10606 @item min-spec-prob
10607 The minimum probability (in percents) of reaching a source block
10608 for interblock speculative scheduling.  The default value is 40.
10610 @item max-sched-extend-regions-iters
10611 The maximum number of iterations through CFG to extend regions.
10612 A value of 0 (the default) disables region extensions.
10614 @item max-sched-insn-conflict-delay
10615 The maximum conflict delay for an insn to be considered for speculative motion.
10616 The default value is 3.
10618 @item sched-spec-prob-cutoff
10619 The minimal probability of speculation success (in percents), so that
10620 speculative insns are scheduled.
10621 The default value is 40.
10623 @item sched-state-edge-prob-cutoff
10624 The minimum probability an edge must have for the scheduler to save its
10625 state across it.
10626 The default value is 10.
10628 @item sched-mem-true-dep-cost
10629 Minimal distance (in CPU cycles) between store and load targeting same
10630 memory locations.  The default value is 1.
10632 @item selsched-max-lookahead
10633 The maximum size of the lookahead window of selective scheduling.  It is a
10634 depth of search for available instructions.
10635 The default value is 50.
10637 @item selsched-max-sched-times
10638 The maximum number of times that an instruction is scheduled during
10639 selective scheduling.  This is the limit on the number of iterations
10640 through which the instruction may be pipelined.  The default value is 2.
10642 @item selsched-insns-to-rename
10643 The maximum number of best instructions in the ready list that are considered
10644 for renaming in the selective scheduler.  The default value is 2.
10646 @item sms-min-sc
10647 The minimum value of stage count that swing modulo scheduler
10648 generates.  The default value is 2.
10650 @item max-last-value-rtl
10651 The maximum size measured as number of RTLs that can be recorded in an expression
10652 in combiner for a pseudo register as last known value of that register.  The default
10653 is 10000.
10655 @item max-combine-insns
10656 The maximum number of instructions the RTL combiner tries to combine.
10657 The default value is 2 at @option{-Og} and 4 otherwise.
10659 @item integer-share-limit
10660 Small integer constants can use a shared data structure, reducing the
10661 compiler's memory usage and increasing its speed.  This sets the maximum
10662 value of a shared integer constant.  The default value is 256.
10664 @item ssp-buffer-size
10665 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10666 protection when @option{-fstack-protection} is used.
10668 @item min-size-for-stack-sharing
10669 The minimum size of variables taking part in stack slot sharing when not
10670 optimizing. The default value is 32.
10672 @item max-jump-thread-duplication-stmts
10673 Maximum number of statements allowed in a block that needs to be
10674 duplicated when threading jumps.
10676 @item max-fields-for-field-sensitive
10677 Maximum number of fields in a structure treated in
10678 a field sensitive manner during pointer analysis.  The default is zero
10679 for @option{-O0} and @option{-O1},
10680 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10682 @item prefetch-latency
10683 Estimate on average number of instructions that are executed before
10684 prefetch finishes.  The distance prefetched ahead is proportional
10685 to this constant.  Increasing this number may also lead to less
10686 streams being prefetched (see @option{simultaneous-prefetches}).
10688 @item simultaneous-prefetches
10689 Maximum number of prefetches that can run at the same time.
10691 @item l1-cache-line-size
10692 The size of cache line in L1 cache, in bytes.
10694 @item l1-cache-size
10695 The size of L1 cache, in kilobytes.
10697 @item l2-cache-size
10698 The size of L2 cache, in kilobytes.
10700 @item loop-interchange-max-num-stmts
10701 The maximum number of stmts in a loop to be interchanged.
10703 @item loop-interchange-stride-ratio
10704 The minimum ratio between stride of two loops for interchange to be profitable.
10706 @item min-insn-to-prefetch-ratio
10707 The minimum ratio between the number of instructions and the
10708 number of prefetches to enable prefetching in a loop.
10710 @item prefetch-min-insn-to-mem-ratio
10711 The minimum ratio between the number of instructions and the
10712 number of memory references to enable prefetching in a loop.
10714 @item use-canonical-types
10715 Whether the compiler should use the ``canonical'' type system.  By
10716 default, this should always be 1, which uses a more efficient internal
10717 mechanism for comparing types in C++ and Objective-C++.  However, if
10718 bugs in the canonical type system are causing compilation failures,
10719 set this value to 0 to disable canonical types.
10721 @item switch-conversion-max-branch-ratio
10722 Switch initialization conversion refuses to create arrays that are
10723 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10724 branches in the switch.
10726 @item max-partial-antic-length
10727 Maximum length of the partial antic set computed during the tree
10728 partial redundancy elimination optimization (@option{-ftree-pre}) when
10729 optimizing at @option{-O3} and above.  For some sorts of source code
10730 the enhanced partial redundancy elimination optimization can run away,
10731 consuming all of the memory available on the host machine.  This
10732 parameter sets a limit on the length of the sets that are computed,
10733 which prevents the runaway behavior.  Setting a value of 0 for
10734 this parameter allows an unlimited set length.
10736 @item sccvn-max-scc-size
10737 Maximum size of a strongly connected component (SCC) during SCCVN
10738 processing.  If this limit is hit, SCCVN processing for the whole
10739 function is not done and optimizations depending on it are
10740 disabled.  The default maximum SCC size is 10000.
10742 @item sccvn-max-alias-queries-per-access
10743 Maximum number of alias-oracle queries we perform when looking for
10744 redundancies for loads and stores.  If this limit is hit the search
10745 is aborted and the load or store is not considered redundant.  The
10746 number of queries is algorithmically limited to the number of
10747 stores on all paths from the load to the function entry.
10748 The default maximum number of queries is 1000.
10750 @item ira-max-loops-num
10751 IRA uses regional register allocation by default.  If a function
10752 contains more loops than the number given by this parameter, only at most
10753 the given number of the most frequently-executed loops form regions
10754 for regional register allocation.  The default value of the
10755 parameter is 100.
10757 @item ira-max-conflict-table-size 
10758 Although IRA uses a sophisticated algorithm to compress the conflict
10759 table, the table can still require excessive amounts of memory for
10760 huge functions.  If the conflict table for a function could be more
10761 than the size in MB given by this parameter, the register allocator
10762 instead uses a faster, simpler, and lower-quality
10763 algorithm that does not require building a pseudo-register conflict table.  
10764 The default value of the parameter is 2000.
10766 @item ira-loop-reserved-regs
10767 IRA can be used to evaluate more accurate register pressure in loops
10768 for decisions to move loop invariants (see @option{-O3}).  The number
10769 of available registers reserved for some other purposes is given
10770 by this parameter.  The default value of the parameter is 2, which is
10771 the minimal number of registers needed by typical instructions.
10772 This value is the best found from numerous experiments.
10774 @item lra-inheritance-ebb-probability-cutoff
10775 LRA tries to reuse values reloaded in registers in subsequent insns.
10776 This optimization is called inheritance.  EBB is used as a region to
10777 do this optimization.  The parameter defines a minimal fall-through
10778 edge probability in percentage used to add BB to inheritance EBB in
10779 LRA.  The default value of the parameter is 40.  The value was chosen
10780 from numerous runs of SPEC2000 on x86-64.
10782 @item loop-invariant-max-bbs-in-loop
10783 Loop invariant motion can be very expensive, both in compilation time and
10784 in amount of needed compile-time memory, with very large loops.  Loops
10785 with more basic blocks than this parameter won't have loop invariant
10786 motion optimization performed on them.  The default value of the
10787 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10789 @item loop-max-datarefs-for-datadeps
10790 Building data dependencies is expensive for very large loops.  This
10791 parameter limits the number of data references in loops that are
10792 considered for data dependence analysis.  These large loops are no
10793 handled by the optimizations using loop data dependencies.
10794 The default value is 1000.
10796 @item max-vartrack-size
10797 Sets a maximum number of hash table slots to use during variable
10798 tracking dataflow analysis of any function.  If this limit is exceeded
10799 with variable tracking at assignments enabled, analysis for that
10800 function is retried without it, after removing all debug insns from
10801 the function.  If the limit is exceeded even without debug insns, var
10802 tracking analysis is completely disabled for the function.  Setting
10803 the parameter to zero makes it unlimited.
10805 @item max-vartrack-expr-depth
10806 Sets a maximum number of recursion levels when attempting to map
10807 variable names or debug temporaries to value expressions.  This trades
10808 compilation time for more complete debug information.  If this is set too
10809 low, value expressions that are available and could be represented in
10810 debug information may end up not being used; setting this higher may
10811 enable the compiler to find more complex debug expressions, but compile
10812 time and memory use may grow.  The default is 12.
10814 @item max-debug-marker-count
10815 Sets a threshold on the number of debug markers (e.g. begin stmt
10816 markers) to avoid complexity explosion at inlining or expanding to RTL.
10817 If a function has more such gimple stmts than the set limit, such stmts
10818 will be dropped from the inlined copy of a function, and from its RTL
10819 expansion.  The default is 100000.
10821 @item min-nondebug-insn-uid
10822 Use uids starting at this parameter for nondebug insns.  The range below
10823 the parameter is reserved exclusively for debug insns created by
10824 @option{-fvar-tracking-assignments}, but debug insns may get
10825 (non-overlapping) uids above it if the reserved range is exhausted.
10827 @item ipa-sra-ptr-growth-factor
10828 IPA-SRA replaces a pointer to an aggregate with one or more new
10829 parameters only when their cumulative size is less or equal to
10830 @option{ipa-sra-ptr-growth-factor} times the size of the original
10831 pointer parameter.
10833 @item sra-max-scalarization-size-Ospeed
10834 @itemx sra-max-scalarization-size-Osize
10835 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10836 replace scalar parts of aggregates with uses of independent scalar
10837 variables.  These parameters control the maximum size, in storage units,
10838 of aggregate which is considered for replacement when compiling for
10839 speed
10840 (@option{sra-max-scalarization-size-Ospeed}) or size
10841 (@option{sra-max-scalarization-size-Osize}) respectively.
10843 @item tm-max-aggregate-size
10844 When making copies of thread-local variables in a transaction, this
10845 parameter specifies the size in bytes after which variables are
10846 saved with the logging functions as opposed to save/restore code
10847 sequence pairs.  This option only applies when using
10848 @option{-fgnu-tm}.
10850 @item graphite-max-nb-scop-params
10851 To avoid exponential effects in the Graphite loop transforms, the
10852 number of parameters in a Static Control Part (SCoP) is bounded.  The
10853 default value is 10 parameters, a value of zero can be used to lift
10854 the bound.  A variable whose value is unknown at compilation time and
10855 defined outside a SCoP is a parameter of the SCoP.
10857 @item loop-block-tile-size
10858 Loop blocking or strip mining transforms, enabled with
10859 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10860 loop in the loop nest by a given number of iterations.  The strip
10861 length can be changed using the @option{loop-block-tile-size}
10862 parameter.  The default value is 51 iterations.
10864 @item loop-unroll-jam-size
10865 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10866 default value is 4.
10868 @item loop-unroll-jam-depth
10869 Specify the dimension to be unrolled (counting from the most inner loop)
10870 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10872 @item ipa-cp-value-list-size
10873 IPA-CP attempts to track all possible values and types passed to a function's
10874 parameter in order to propagate them and perform devirtualization.
10875 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10876 stores per one formal parameter of a function.
10878 @item ipa-cp-eval-threshold
10879 IPA-CP calculates its own score of cloning profitability heuristics
10880 and performs those cloning opportunities with scores that exceed
10881 @option{ipa-cp-eval-threshold}.
10883 @item ipa-cp-recursion-penalty
10884 Percentage penalty the recursive functions will receive when they
10885 are evaluated for cloning.
10887 @item ipa-cp-single-call-penalty
10888 Percentage penalty functions containing a single call to another
10889 function will receive when they are evaluated for cloning.
10892 @item ipa-max-agg-items
10893 IPA-CP is also capable to propagate a number of scalar values passed
10894 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10895 number of such values per one parameter.
10897 @item ipa-cp-loop-hint-bonus
10898 When IPA-CP determines that a cloning candidate would make the number
10899 of iterations of a loop known, it adds a bonus of
10900 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10901 the candidate.
10903 @item ipa-cp-array-index-hint-bonus
10904 When IPA-CP determines that a cloning candidate would make the index of
10905 an array access known, it adds a bonus of
10906 @option{ipa-cp-array-index-hint-bonus} to the profitability
10907 score of the candidate.
10909 @item ipa-max-aa-steps
10910 During its analysis of function bodies, IPA-CP employs alias analysis
10911 in order to track values pointed to by function parameters.  In order
10912 not spend too much time analyzing huge functions, it gives up and
10913 consider all memory clobbered after examining
10914 @option{ipa-max-aa-steps} statements modifying memory.
10916 @item lto-partitions
10917 Specify desired number of partitions produced during WHOPR compilation.
10918 The number of partitions should exceed the number of CPUs used for compilation.
10919 The default value is 32.
10921 @item lto-min-partition
10922 Size of minimal partition for WHOPR (in estimated instructions).
10923 This prevents expenses of splitting very small programs into too many
10924 partitions.
10926 @item lto-max-partition
10927 Size of max partition for WHOPR (in estimated instructions).
10928 to provide an upper bound for individual size of partition.
10929 Meant to be used only with balanced partitioning.
10931 @item cxx-max-namespaces-for-diagnostic-help
10932 The maximum number of namespaces to consult for suggestions when C++
10933 name lookup fails for an identifier.  The default is 1000.
10935 @item sink-frequency-threshold
10936 The maximum relative execution frequency (in percents) of the target block
10937 relative to a statement's original block to allow statement sinking of a
10938 statement.  Larger numbers result in more aggressive statement sinking.
10939 The default value is 75.  A small positive adjustment is applied for
10940 statements with memory operands as those are even more profitable so sink.
10942 @item max-stores-to-sink
10943 The maximum number of conditional store pairs that can be sunk.  Set to 0
10944 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10945 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10947 @item allow-store-data-races
10948 Allow optimizers to introduce new data races on stores.
10949 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10950 at optimization level @option{-Ofast}.
10952 @item case-values-threshold
10953 The smallest number of different values for which it is best to use a
10954 jump-table instead of a tree of conditional branches.  If the value is
10955 0, use the default for the machine.  The default is 0.
10957 @item tree-reassoc-width
10958 Set the maximum number of instructions executed in parallel in
10959 reassociated tree. This parameter overrides target dependent
10960 heuristics used by default if has non zero value.
10962 @item sched-pressure-algorithm
10963 Choose between the two available implementations of
10964 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10965 and is the more likely to prevent instructions from being reordered.
10966 Algorithm 2 was designed to be a compromise between the relatively
10967 conservative approach taken by algorithm 1 and the rather aggressive
10968 approach taken by the default scheduler.  It relies more heavily on
10969 having a regular register file and accurate register pressure classes.
10970 See @file{haifa-sched.c} in the GCC sources for more details.
10972 The default choice depends on the target.
10974 @item max-slsr-cand-scan
10975 Set the maximum number of existing candidates that are considered when
10976 seeking a basis for a new straight-line strength reduction candidate.
10978 @item asan-globals
10979 Enable buffer overflow detection for global objects.  This kind
10980 of protection is enabled by default if you are using
10981 @option{-fsanitize=address} option.
10982 To disable global objects protection use @option{--param asan-globals=0}.
10984 @item asan-stack
10985 Enable buffer overflow detection for stack objects.  This kind of
10986 protection is enabled by default when using @option{-fsanitize=address}.
10987 To disable stack protection use @option{--param asan-stack=0} option.
10989 @item asan-instrument-reads
10990 Enable buffer overflow detection for memory reads.  This kind of
10991 protection is enabled by default when using @option{-fsanitize=address}.
10992 To disable memory reads protection use
10993 @option{--param asan-instrument-reads=0}.
10995 @item asan-instrument-writes
10996 Enable buffer overflow detection for memory writes.  This kind of
10997 protection is enabled by default when using @option{-fsanitize=address}.
10998 To disable memory writes protection use
10999 @option{--param asan-instrument-writes=0} option.
11001 @item asan-memintrin
11002 Enable detection for built-in functions.  This kind of protection
11003 is enabled by default when using @option{-fsanitize=address}.
11004 To disable built-in functions protection use
11005 @option{--param asan-memintrin=0}.
11007 @item asan-use-after-return
11008 Enable detection of use-after-return.  This kind of protection
11009 is enabled by default when using the @option{-fsanitize=address} option.
11010 To disable it use @option{--param asan-use-after-return=0}.
11012 Note: By default the check is disabled at run time.  To enable it,
11013 add @code{detect_stack_use_after_return=1} to the environment variable
11014 @env{ASAN_OPTIONS}.
11016 @item asan-instrumentation-with-call-threshold
11017 If number of memory accesses in function being instrumented
11018 is greater or equal to this number, use callbacks instead of inline checks.
11019 E.g. to disable inline code use
11020 @option{--param asan-instrumentation-with-call-threshold=0}.
11022 @item use-after-scope-direct-emission-threshold
11023 If the size of a local variable in bytes is smaller or equal to this
11024 number, directly poison (or unpoison) shadow memory instead of using
11025 run-time callbacks.  The default value is 256.
11027 @item chkp-max-ctor-size
11028 Static constructors generated by Pointer Bounds Checker may become very
11029 large and significantly increase compile time at optimization level
11030 @option{-O1} and higher.  This parameter is a maximum number of statements
11031 in a single generated constructor.  Default value is 5000.
11033 @item max-fsm-thread-path-insns
11034 Maximum number of instructions to copy when duplicating blocks on a
11035 finite state automaton jump thread path.  The default is 100.
11037 @item max-fsm-thread-length
11038 Maximum number of basic blocks on a finite state automaton jump thread
11039 path.  The default is 10.
11041 @item max-fsm-thread-paths
11042 Maximum number of new jump thread paths to create for a finite state
11043 automaton.  The default is 50.
11045 @item parloops-chunk-size
11046 Chunk size of omp schedule for loops parallelized by parloops.  The default
11047 is 0.
11049 @item parloops-schedule
11050 Schedule type of omp schedule for loops parallelized by parloops (static,
11051 dynamic, guided, auto, runtime).  The default is static.
11053 @item parloops-min-per-thread
11054 The minimum number of iterations per thread of an innermost parallelized
11055 loop for which the parallelized variant is prefered over the single threaded
11056 one.  The default is 100.  Note that for a parallelized loop nest the
11057 minimum number of iterations of the outermost loop per thread is two.
11059 @item max-ssa-name-query-depth
11060 Maximum depth of recursion when querying properties of SSA names in things
11061 like fold routines.  One level of recursion corresponds to following a
11062 use-def chain.
11064 @item hsa-gen-debug-stores
11065 Enable emission of special debug stores within HSA kernels which are
11066 then read and reported by libgomp plugin.  Generation of these stores
11067 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11068 enable it.
11070 @item max-speculative-devirt-maydefs
11071 The maximum number of may-defs we analyze when looking for a must-def
11072 specifying the dynamic type of an object that invokes a virtual call
11073 we may be able to devirtualize speculatively.
11075 @item max-vrp-switch-assertions
11076 The maximum number of assertions to add along the default edge of a switch
11077 statement during VRP.  The default is 10.
11079 @item unroll-jam-min-percent
11080 The minimum percentage of memory references that must be optimized
11081 away for the unroll-and-jam transformation to be considered profitable.
11083 @item unroll-jam-max-unroll
11084 The maximum number of times the outer loop should be unrolled by
11085 the unroll-and-jam transformation.
11086 @end table
11087 @end table
11089 @node Instrumentation Options
11090 @section Program Instrumentation Options
11091 @cindex instrumentation options
11092 @cindex program instrumentation options
11093 @cindex run-time error checking options
11094 @cindex profiling options
11095 @cindex options, program instrumentation
11096 @cindex options, run-time error checking
11097 @cindex options, profiling
11099 GCC supports a number of command-line options that control adding
11100 run-time instrumentation to the code it normally generates.  
11101 For example, one purpose of instrumentation is collect profiling
11102 statistics for use in finding program hot spots, code coverage
11103 analysis, or profile-guided optimizations.
11104 Another class of program instrumentation is adding run-time checking 
11105 to detect programming errors like invalid pointer
11106 dereferences or out-of-bounds array accesses, as well as deliberately
11107 hostile attacks such as stack smashing or C++ vtable hijacking.
11108 There is also a general hook which can be used to implement other
11109 forms of tracing or function-level instrumentation for debug or
11110 program analysis purposes.
11112 @table @gcctabopt
11113 @cindex @command{prof}
11114 @item -p
11115 @opindex p
11116 Generate extra code to write profile information suitable for the
11117 analysis program @command{prof}.  You must use this option when compiling
11118 the source files you want data about, and you must also use it when
11119 linking.
11121 @cindex @command{gprof}
11122 @item -pg
11123 @opindex pg
11124 Generate extra code to write profile information suitable for the
11125 analysis program @command{gprof}.  You must use this option when compiling
11126 the source files you want data about, and you must also use it when
11127 linking.
11129 @item -fprofile-arcs
11130 @opindex fprofile-arcs
11131 Add code so that program flow @dfn{arcs} are instrumented.  During
11132 execution the program records how many times each branch and call is
11133 executed and how many times it is taken or returns.  On targets that support
11134 constructors with priority support, profiling properly handles constructors,
11135 destructors and C++ constructors (and destructors) of classes which are used
11136 as a type of a global variable.
11138 When the compiled
11139 program exits it saves this data to a file called
11140 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11141 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11142 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11143 @var{auxname} is generated from the name of the output file, if
11144 explicitly specified and it is not the final executable, otherwise it is
11145 the basename of the source file.  In both cases any suffix is removed
11146 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11147 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11148 @xref{Cross-profiling}.
11150 @cindex @command{gcov}
11151 @item --coverage
11152 @opindex coverage
11154 This option is used to compile and link code instrumented for coverage
11155 analysis.  The option is a synonym for @option{-fprofile-arcs}
11156 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11157 linking).  See the documentation for those options for more details.
11159 @itemize
11161 @item
11162 Compile the source files with @option{-fprofile-arcs} plus optimization
11163 and code generation options.  For test coverage analysis, use the
11164 additional @option{-ftest-coverage} option.  You do not need to profile
11165 every source file in a program.
11167 @item
11168 Compile the source files additionally with @option{-fprofile-abs-path}
11169 to create absolute path names in the @file{.gcno} files.  This allows
11170 @command{gcov} to find the correct sources in projects where compilations
11171 occur with different working directories.
11173 @item
11174 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11175 (the latter implies the former).
11177 @item
11178 Run the program on a representative workload to generate the arc profile
11179 information.  This may be repeated any number of times.  You can run
11180 concurrent instances of your program, and provided that the file system
11181 supports locking, the data files will be correctly updated.  Unless
11182 a strict ISO C dialect option is in effect, @code{fork} calls are
11183 detected and correctly handled without double counting.
11185 @item
11186 For profile-directed optimizations, compile the source files again with
11187 the same optimization and code generation options plus
11188 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11189 Control Optimization}).
11191 @item
11192 For test coverage analysis, use @command{gcov} to produce human readable
11193 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11194 @command{gcov} documentation for further information.
11196 @end itemize
11198 With @option{-fprofile-arcs}, for each function of your program GCC
11199 creates a program flow graph, then finds a spanning tree for the graph.
11200 Only arcs that are not on the spanning tree have to be instrumented: the
11201 compiler adds code to count the number of times that these arcs are
11202 executed.  When an arc is the only exit or only entrance to a block, the
11203 instrumentation code can be added to the block; otherwise, a new basic
11204 block must be created to hold the instrumentation code.
11206 @need 2000
11207 @item -ftest-coverage
11208 @opindex ftest-coverage
11209 Produce a notes file that the @command{gcov} code-coverage utility
11210 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11211 show program coverage.  Each source file's note file is called
11212 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11213 above for a description of @var{auxname} and instructions on how to
11214 generate test coverage data.  Coverage data matches the source files
11215 more closely if you do not optimize.
11217 @item -fprofile-abs-path
11218 @opindex fprofile-abs-path
11219 Automatically convert relative source file names to absolute path names
11220 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11221 sources in projects where compilations occur with different working
11222 directories.
11224 @item -fprofile-dir=@var{path}
11225 @opindex fprofile-dir
11227 Set the directory to search for the profile data files in to @var{path}.
11228 This option affects only the profile data generated by
11229 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11230 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11231 and its related options.  Both absolute and relative paths can be used.
11232 By default, GCC uses the current directory as @var{path}, thus the
11233 profile data file appears in the same directory as the object file.
11235 @item -fprofile-generate
11236 @itemx -fprofile-generate=@var{path}
11237 @opindex fprofile-generate
11239 Enable options usually used for instrumenting application to produce
11240 profile useful for later recompilation with profile feedback based
11241 optimization.  You must use @option{-fprofile-generate} both when
11242 compiling and when linking your program.
11244 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11246 If @var{path} is specified, GCC looks at the @var{path} to find
11247 the profile feedback data files. See @option{-fprofile-dir}.
11249 To optimize the program based on the collected profile information, use
11250 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11252 @item -fprofile-update=@var{method}
11253 @opindex fprofile-update
11255 Alter the update method for an application instrumented for profile
11256 feedback based optimization.  The @var{method} argument should be one of
11257 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11258 The first one is useful for single-threaded applications,
11259 while the second one prevents profile corruption by emitting thread-safe code.
11261 @strong{Warning:} When an application does not properly join all threads
11262 (or creates an detached thread), a profile file can be still corrupted.
11264 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11265 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11266 automatically selects @samp{prefer-atomic} when @option{-pthread}
11267 is present in the command line.
11269 @item -fsanitize=address
11270 @opindex fsanitize=address
11271 Enable AddressSanitizer, a fast memory error detector.
11272 Memory access instructions are instrumented to detect
11273 out-of-bounds and use-after-free bugs.
11274 The option enables @option{-fsanitize-address-use-after-scope}.
11275 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11276 more details.  The run-time behavior can be influenced using the
11277 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11278 the available options are shown at startup of the instrumented program.  See
11279 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11280 for a list of supported options.
11281 The option cannot be combined with @option{-fsanitize=thread}
11282 and/or @option{-fcheck-pointer-bounds}.
11284 @item -fsanitize=kernel-address
11285 @opindex fsanitize=kernel-address
11286 Enable AddressSanitizer for Linux kernel.
11287 See @uref{https://github.com/google/kasan/wiki} for more details.
11288 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11290 @item -fsanitize=pointer-compare
11291 @opindex fsanitize=pointer-compare
11292 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11293 The option must be combined with either @option{-fsanitize=kernel-address} or
11294 @option{-fsanitize=address}
11295 The option cannot be combined with @option{-fsanitize=thread}
11296 and/or @option{-fcheck-pointer-bounds}.
11297 Note: By default the check is disabled at run time.  To enable it,
11298 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11299 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11300 invalid operation only when both pointers are non-null.
11302 @item -fsanitize=pointer-subtract
11303 @opindex fsanitize=pointer-subtract
11304 Instrument subtraction with pointer operands.
11305 The option must be combined with either @option{-fsanitize=kernel-address} or
11306 @option{-fsanitize=address}
11307 The option cannot be combined with @option{-fsanitize=thread}
11308 and/or @option{-fcheck-pointer-bounds}.
11309 Note: By default the check is disabled at run time.  To enable it,
11310 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11311 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11312 invalid operation only when both pointers are non-null.
11314 @item -fsanitize=thread
11315 @opindex fsanitize=thread
11316 Enable ThreadSanitizer, a fast data race detector.
11317 Memory access instructions are instrumented to detect
11318 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11319 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11320 environment variable; see
11321 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11322 supported options.
11323 The option cannot be combined with @option{-fsanitize=address},
11324 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11326 Note that sanitized atomic builtins cannot throw exceptions when
11327 operating on invalid memory addresses with non-call exceptions
11328 (@option{-fnon-call-exceptions}).
11330 @item -fsanitize=leak
11331 @opindex fsanitize=leak
11332 Enable LeakSanitizer, a memory leak detector.
11333 This option only matters for linking of executables and
11334 the executable is linked against a library that overrides @code{malloc}
11335 and other allocator functions.  See
11336 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11337 details.  The run-time behavior can be influenced using the
11338 @env{LSAN_OPTIONS} environment variable.
11339 The option cannot be combined with @option{-fsanitize=thread}.
11341 @item -fsanitize=undefined
11342 @opindex fsanitize=undefined
11343 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11344 Various computations are instrumented to detect undefined behavior
11345 at runtime.  Current suboptions are:
11347 @table @gcctabopt
11349 @item -fsanitize=shift
11350 @opindex fsanitize=shift
11351 This option enables checking that the result of a shift operation is
11352 not undefined.  Note that what exactly is considered undefined differs
11353 slightly between C and C++, as well as between ISO C90 and C99, etc.
11354 This option has two suboptions, @option{-fsanitize=shift-base} and
11355 @option{-fsanitize=shift-exponent}.
11357 @item -fsanitize=shift-exponent
11358 @opindex fsanitize=shift-exponent
11359 This option enables checking that the second argument of a shift operation
11360 is not negative and is smaller than the precision of the promoted first
11361 argument.
11363 @item -fsanitize=shift-base
11364 @opindex fsanitize=shift-base
11365 If the second argument of a shift operation is within range, check that the
11366 result of a shift operation is not undefined.  Note that what exactly is
11367 considered undefined differs slightly between C and C++, as well as between
11368 ISO C90 and C99, etc.
11370 @item -fsanitize=integer-divide-by-zero
11371 @opindex fsanitize=integer-divide-by-zero
11372 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11374 @item -fsanitize=unreachable
11375 @opindex fsanitize=unreachable
11376 With this option, the compiler turns the @code{__builtin_unreachable}
11377 call into a diagnostics message call instead.  When reaching the
11378 @code{__builtin_unreachable} call, the behavior is undefined.
11380 @item -fsanitize=vla-bound
11381 @opindex fsanitize=vla-bound
11382 This option instructs the compiler to check that the size of a variable
11383 length array is positive.
11385 @item -fsanitize=null
11386 @opindex fsanitize=null
11387 This option enables pointer checking.  Particularly, the application
11388 built with this option turned on will issue an error message when it
11389 tries to dereference a NULL pointer, or if a reference (possibly an
11390 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11391 on an object pointed by a NULL pointer.
11393 @item -fsanitize=return
11394 @opindex fsanitize=return
11395 This option enables return statement checking.  Programs
11396 built with this option turned on will issue an error message
11397 when the end of a non-void function is reached without actually
11398 returning a value.  This option works in C++ only.
11400 @item -fsanitize=signed-integer-overflow
11401 @opindex fsanitize=signed-integer-overflow
11402 This option enables signed integer overflow checking.  We check that
11403 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11404 does not overflow in the signed arithmetics.  Note, integer promotion
11405 rules must be taken into account.  That is, the following is not an
11406 overflow:
11407 @smallexample
11408 signed char a = SCHAR_MAX;
11409 a++;
11410 @end smallexample
11412 @item -fsanitize=bounds
11413 @opindex fsanitize=bounds
11414 This option enables instrumentation of array bounds.  Various out of bounds
11415 accesses are detected.  Flexible array members, flexible array member-like
11416 arrays, and initializers of variables with static storage are not instrumented.
11417 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11419 @item -fsanitize=bounds-strict
11420 @opindex fsanitize=bounds-strict
11421 This option enables strict instrumentation of array bounds.  Most out of bounds
11422 accesses are detected, including flexible array members and flexible array
11423 member-like arrays.  Initializers of variables with static storage are not
11424 instrumented.  The option cannot be combined
11425 with @option{-fcheck-pointer-bounds}.
11427 @item -fsanitize=alignment
11428 @opindex fsanitize=alignment
11430 This option enables checking of alignment of pointers when they are
11431 dereferenced, or when a reference is bound to insufficiently aligned target,
11432 or when a method or constructor is invoked on insufficiently aligned object.
11434 @item -fsanitize=object-size
11435 @opindex fsanitize=object-size
11436 This option enables instrumentation of memory references using the
11437 @code{__builtin_object_size} function.  Various out of bounds pointer
11438 accesses are detected.
11440 @item -fsanitize=float-divide-by-zero
11441 @opindex fsanitize=float-divide-by-zero
11442 Detect floating-point division by zero.  Unlike other similar options,
11443 @option{-fsanitize=float-divide-by-zero} is not enabled by
11444 @option{-fsanitize=undefined}, since floating-point division by zero can
11445 be a legitimate way of obtaining infinities and NaNs.
11447 @item -fsanitize=float-cast-overflow
11448 @opindex fsanitize=float-cast-overflow
11449 This option enables floating-point type to integer conversion checking.
11450 We check that the result of the conversion does not overflow.
11451 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11452 not enabled by @option{-fsanitize=undefined}.
11453 This option does not work well with @code{FE_INVALID} exceptions enabled.
11455 @item -fsanitize=nonnull-attribute
11456 @opindex fsanitize=nonnull-attribute
11458 This option enables instrumentation of calls, checking whether null values
11459 are not passed to arguments marked as requiring a non-null value by the
11460 @code{nonnull} function attribute.
11462 @item -fsanitize=returns-nonnull-attribute
11463 @opindex fsanitize=returns-nonnull-attribute
11465 This option enables instrumentation of return statements in functions
11466 marked with @code{returns_nonnull} function attribute, to detect returning
11467 of null values from such functions.
11469 @item -fsanitize=bool
11470 @opindex fsanitize=bool
11472 This option enables instrumentation of loads from bool.  If a value other
11473 than 0/1 is loaded, a run-time error is issued.
11475 @item -fsanitize=enum
11476 @opindex fsanitize=enum
11478 This option enables instrumentation of loads from an enum type.  If
11479 a value outside the range of values for the enum type is loaded,
11480 a run-time error is issued.
11482 @item -fsanitize=vptr
11483 @opindex fsanitize=vptr
11485 This option enables instrumentation of C++ member function calls, member
11486 accesses and some conversions between pointers to base and derived classes,
11487 to verify the referenced object has the correct dynamic type.
11489 @item -fsanitize=pointer-overflow
11490 @opindex fsanitize=pointer-overflow
11492 This option enables instrumentation of pointer arithmetics.  If the pointer
11493 arithmetics overflows, a run-time error is issued.
11495 @item -fsanitize=builtin
11496 @opindex fsanitize=builtin
11498 This option enables instrumentation of arguments to selected builtin
11499 functions.  If an invalid value is passed to such arguments, a run-time
11500 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11501 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11502 by this option.
11504 @end table
11506 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11507 @option{-fsanitize=undefined} gives a diagnostic message.
11508 This currently works only for the C family of languages.
11510 @item -fno-sanitize=all
11511 @opindex fno-sanitize=all
11513 This option disables all previously enabled sanitizers.
11514 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11515 together.
11517 @item -fasan-shadow-offset=@var{number}
11518 @opindex fasan-shadow-offset
11519 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11520 It is useful for experimenting with different shadow memory layouts in
11521 Kernel AddressSanitizer.
11523 @item -fsanitize-sections=@var{s1},@var{s2},...
11524 @opindex fsanitize-sections
11525 Sanitize global variables in selected user-defined sections.  @var{si} may
11526 contain wildcards.
11528 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11529 @opindex fsanitize-recover
11530 @opindex fno-sanitize-recover
11531 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11532 mentioned in comma-separated list of @var{opts}.  Enabling this option
11533 for a sanitizer component causes it to attempt to continue
11534 running the program as if no error happened.  This means multiple
11535 runtime errors can be reported in a single program run, and the exit
11536 code of the program may indicate success even when errors
11537 have been reported.  The @option{-fno-sanitize-recover=} option
11538 can be used to alter
11539 this behavior: only the first detected error is reported
11540 and program then exits with a non-zero exit code.
11542 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11543 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11544 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11545 @option{-fsanitize=bounds-strict},
11546 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11547 For these sanitizers error recovery is turned on by default,
11548 except @option{-fsanitize=address}, for which this feature is experimental.
11549 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11550 accepted, the former enables recovery for all sanitizers that support it,
11551 the latter disables recovery for all sanitizers that support it.
11553 Even if a recovery mode is turned on the compiler side, it needs to be also
11554 enabled on the runtime library side, otherwise the failures are still fatal.
11555 The runtime library defaults to @code{halt_on_error=0} for
11556 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11557 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11558 setting the @code{halt_on_error} flag in the corresponding environment variable.
11560 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11561 equivalent to specifying an @var{opts} list of:
11563 @smallexample
11564 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11565 @end smallexample
11567 @item -fsanitize-address-use-after-scope
11568 @opindex fsanitize-address-use-after-scope
11569 Enable sanitization of local variables to detect use-after-scope bugs.
11570 The option sets @option{-fstack-reuse} to @samp{none}.
11572 @item -fsanitize-undefined-trap-on-error
11573 @opindex fsanitize-undefined-trap-on-error
11574 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11575 report undefined behavior using @code{__builtin_trap} rather than
11576 a @code{libubsan} library routine.  The advantage of this is that the
11577 @code{libubsan} library is not needed and is not linked in, so this
11578 is usable even in freestanding environments.
11580 @item -fsanitize-coverage=trace-pc
11581 @opindex fsanitize-coverage=trace-pc
11582 Enable coverage-guided fuzzing code instrumentation.
11583 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11585 @item -fsanitize-coverage=trace-cmp
11586 @opindex fsanitize-coverage=trace-cmp
11587 Enable dataflow guided fuzzing code instrumentation.
11588 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11589 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11590 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11591 variable or @code{__sanitizer_cov_trace_const_cmp1},
11592 @code{__sanitizer_cov_trace_const_cmp2},
11593 @code{__sanitizer_cov_trace_const_cmp4} or
11594 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11595 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11596 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11597 @code{__sanitizer_cov_trace_switch} for switch statements.
11599 @item -fbounds-check
11600 @opindex fbounds-check
11601 For front ends that support it, generate additional code to check that
11602 indices used to access arrays are within the declared range.  This is
11603 currently only supported by the Fortran front end, where this option
11604 defaults to false.
11606 @item -fcheck-pointer-bounds
11607 @opindex fcheck-pointer-bounds
11608 @opindex fno-check-pointer-bounds
11609 @cindex Pointer Bounds Checker options
11610 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11611 is instrumented with checks of the pointer used for memory access against
11612 bounds associated with that pointer.  
11614 Currently there
11615 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11616 and @option{-mmpx} are required to enable this feature.  
11617 MPX-based instrumentation requires
11618 a runtime library to enable MPX in hardware and handle bounds
11619 violation signals.  By default when @option{-fcheck-pointer-bounds}
11620 and @option{-mmpx} options are used to link a program, the GCC driver
11621 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11622 Bounds checking on calls to dynamic libraries requires a linker
11623 with @option{-z bndplt} support; if GCC was configured with a linker
11624 without support for this option (including the Gold linker and older
11625 versions of ld), a warning is given if you link with @option{-mmpx}
11626 without also specifying @option{-static}, since the overall effectiveness
11627 of the bounds checking protection is reduced.
11628 See also @option{-static-libmpxwrappers}.
11630 MPX-based instrumentation
11631 may be used for debugging and also may be included in production code
11632 to increase program security.  Depending on usage, you may
11633 have different requirements for the runtime library.  The current version
11634 of the MPX runtime library is more oriented for use as a debugging
11635 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11636 also @option{-static-libmpx}.  The runtime library  behavior can be
11637 influenced using various @env{CHKP_RT_*} environment variables.  See
11638 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11639 for more details.
11641 Generated instrumentation may be controlled by various
11642 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11643 structure field attribute (@pxref{Type Attributes}) and
11644 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11645 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11646 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11647 Bounds Checker builtins}, for more information.
11649 @item -fchkp-check-incomplete-type
11650 @opindex fchkp-check-incomplete-type
11651 @opindex fno-chkp-check-incomplete-type
11652 Generate pointer bounds checks for variables with incomplete type.
11653 Enabled by default.
11655 @item -fchkp-narrow-bounds
11656 @opindex fchkp-narrow-bounds
11657 @opindex fno-chkp-narrow-bounds
11658 Controls bounds used by Pointer Bounds Checker for pointers to object
11659 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11660 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11661 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11663 @item -fchkp-first-field-has-own-bounds
11664 @opindex fchkp-first-field-has-own-bounds
11665 @opindex fno-chkp-first-field-has-own-bounds
11666 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11667 first field in the structure.  By default a pointer to the first field has
11668 the same bounds as a pointer to the whole structure.
11670 @item -fchkp-flexible-struct-trailing-arrays
11671 @opindex fchkp-flexible-struct-trailing-arrays
11672 @opindex fno-chkp-flexible-struct-trailing-arrays
11673 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11674 possibly flexible.  By default only array fields with zero length or that are
11675 marked with attribute bnd_variable_size are treated as flexible.
11677 @item -fchkp-narrow-to-innermost-array
11678 @opindex fchkp-narrow-to-innermost-array
11679 @opindex fno-chkp-narrow-to-innermost-array
11680 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11681 case of nested static array access.  By default this option is disabled and
11682 bounds of the outermost array are used.
11684 @item -fchkp-optimize
11685 @opindex fchkp-optimize
11686 @opindex fno-chkp-optimize
11687 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11688 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11690 @item -fchkp-use-fast-string-functions
11691 @opindex fchkp-use-fast-string-functions
11692 @opindex fno-chkp-use-fast-string-functions
11693 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11694 by Pointer Bounds Checker.  Disabled by default.
11696 @item -fchkp-use-nochk-string-functions
11697 @opindex fchkp-use-nochk-string-functions
11698 @opindex fno-chkp-use-nochk-string-functions
11699 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11700 by Pointer Bounds Checker.  Disabled by default.
11702 @item -fchkp-use-static-bounds
11703 @opindex fchkp-use-static-bounds
11704 @opindex fno-chkp-use-static-bounds
11705 Allow Pointer Bounds Checker to generate static bounds holding
11706 bounds of static variables.  Enabled by default.
11708 @item -fchkp-use-static-const-bounds
11709 @opindex fchkp-use-static-const-bounds
11710 @opindex fno-chkp-use-static-const-bounds
11711 Use statically-initialized bounds for constant bounds instead of
11712 generating them each time they are required.  By default enabled when
11713 @option{-fchkp-use-static-bounds} is enabled.
11715 @item -fchkp-treat-zero-dynamic-size-as-infinite
11716 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11717 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11718 With this option, objects with incomplete type whose
11719 dynamically-obtained size is zero are treated as having infinite size
11720 instead by Pointer Bounds
11721 Checker.  This option may be helpful if a program is linked with a library
11722 missing size information for some symbols.  Disabled by default.
11724 @item -fchkp-check-read
11725 @opindex fchkp-check-read
11726 @opindex fno-chkp-check-read
11727 Instructs Pointer Bounds Checker to generate checks for all read
11728 accesses to memory.  Enabled by default.
11730 @item -fchkp-check-write
11731 @opindex fchkp-check-write
11732 @opindex fno-chkp-check-write
11733 Instructs Pointer Bounds Checker to generate checks for all write
11734 accesses to memory.  Enabled by default.
11736 @item -fchkp-store-bounds
11737 @opindex fchkp-store-bounds
11738 @opindex fno-chkp-store-bounds
11739 Instructs Pointer Bounds Checker to generate bounds stores for
11740 pointer writes.  Enabled by default.
11742 @item -fchkp-instrument-calls
11743 @opindex fchkp-instrument-calls
11744 @opindex fno-chkp-instrument-calls
11745 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11746 Enabled by default.
11748 @item -fchkp-instrument-marked-only
11749 @opindex fchkp-instrument-marked-only
11750 @opindex fno-chkp-instrument-marked-only
11751 Instructs Pointer Bounds Checker to instrument only functions
11752 marked with the @code{bnd_instrument} attribute
11753 (@pxref{Function Attributes}).  Disabled by default.
11755 @item -fchkp-use-wrappers
11756 @opindex fchkp-use-wrappers
11757 @opindex fno-chkp-use-wrappers
11758 Allows Pointer Bounds Checker to replace calls to built-in functions
11759 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11760 is used to link a program, the GCC driver automatically links
11761 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11762 Enabled by default.
11764 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11765 @opindex fcf-protection
11766 Enable code instrumentation of control-flow transfers to increase
11767 program security by checking that target addresses of control-flow
11768 transfer instructions (such as indirect function call, function return,
11769 indirect jump) are valid.  This prevents diverting the flow of control
11770 to an unexpected target.  This is intended to protect against such
11771 threats as Return-oriented Programming (ROP), and similarly
11772 call/jmp-oriented programming (COP/JOP).
11774 The value @code{branch} tells the compiler to implement checking of
11775 validity of control-flow transfer at the point of indirect branch
11776 instructions, i.e. call/jmp instructions.  The value @code{return}
11777 implements checking of validity at the point of returning from a
11778 function.  The value @code{full} is an alias for specifying both
11779 @code{branch} and @code{return}. The value @code{none} turns off
11780 instrumentation.
11782 You can also use the @code{nocf_check} attribute to identify
11783 which functions and calls should be skipped from instrumentation
11784 (@pxref{Function Attributes}).
11786 Currently the x86 GNU/Linux target provides an implementation based
11787 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11788 for x86 is controlled by target-specific options @option{-mcet},
11789 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11791 @item -fstack-protector
11792 @opindex fstack-protector
11793 Emit extra code to check for buffer overflows, such as stack smashing
11794 attacks.  This is done by adding a guard variable to functions with
11795 vulnerable objects.  This includes functions that call @code{alloca}, and
11796 functions with buffers larger than 8 bytes.  The guards are initialized
11797 when a function is entered and then checked when the function exits.
11798 If a guard check fails, an error message is printed and the program exits.
11800 @item -fstack-protector-all
11801 @opindex fstack-protector-all
11802 Like @option{-fstack-protector} except that all functions are protected.
11804 @item -fstack-protector-strong
11805 @opindex fstack-protector-strong
11806 Like @option{-fstack-protector} but includes additional functions to
11807 be protected --- those that have local array definitions, or have
11808 references to local frame addresses.
11810 @item -fstack-protector-explicit
11811 @opindex fstack-protector-explicit
11812 Like @option{-fstack-protector} but only protects those functions which
11813 have the @code{stack_protect} attribute.
11815 @item -fstack-check
11816 @opindex fstack-check
11817 Generate code to verify that you do not go beyond the boundary of the
11818 stack.  You should specify this flag if you are running in an
11819 environment with multiple threads, but you only rarely need to specify it in
11820 a single-threaded environment since stack overflow is automatically
11821 detected on nearly all systems if there is only one stack.
11823 Note that this switch does not actually cause checking to be done; the
11824 operating system or the language runtime must do that.  The switch causes
11825 generation of code to ensure that they see the stack being extended.
11827 You can additionally specify a string parameter: @samp{no} means no
11828 checking, @samp{generic} means force the use of old-style checking,
11829 @samp{specific} means use the best checking method and is equivalent
11830 to bare @option{-fstack-check}.
11832 Old-style checking is a generic mechanism that requires no specific
11833 target support in the compiler but comes with the following drawbacks:
11835 @enumerate
11836 @item
11837 Modified allocation strategy for large objects: they are always
11838 allocated dynamically if their size exceeds a fixed threshold.  Note this
11839 may change the semantics of some code.
11841 @item
11842 Fixed limit on the size of the static frame of functions: when it is
11843 topped by a particular function, stack checking is not reliable and
11844 a warning is issued by the compiler.
11846 @item
11847 Inefficiency: because of both the modified allocation strategy and the
11848 generic implementation, code performance is hampered.
11849 @end enumerate
11851 Note that old-style stack checking is also the fallback method for
11852 @samp{specific} if no target support has been added in the compiler.
11854 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11855 and stack overflows.  @samp{specific} is an excellent choice when compiling
11856 Ada code.  It is not generally sufficient to protect against stack-clash
11857 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11859 @item -fstack-clash-protection
11860 @opindex fstack-clash-protection
11861 Generate code to prevent stack clash style attacks.  When this option is
11862 enabled, the compiler will only allocate one page of stack space at a time
11863 and each page is accessed immediately after allocation.  Thus, it prevents
11864 allocations from jumping over any stack guard page provided by the
11865 operating system.
11867 Most targets do not fully support stack clash protection.  However, on
11868 those targets @option{-fstack-clash-protection} will protect dynamic stack
11869 allocations.  @option{-fstack-clash-protection} may also provide limited
11870 protection for static stack allocations if the target supports
11871 @option{-fstack-check=specific}.
11873 @item -fstack-limit-register=@var{reg}
11874 @itemx -fstack-limit-symbol=@var{sym}
11875 @itemx -fno-stack-limit
11876 @opindex fstack-limit-register
11877 @opindex fstack-limit-symbol
11878 @opindex fno-stack-limit
11879 Generate code to ensure that the stack does not grow beyond a certain value,
11880 either the value of a register or the address of a symbol.  If a larger
11881 stack is required, a signal is raised at run time.  For most targets,
11882 the signal is raised before the stack overruns the boundary, so
11883 it is possible to catch the signal without taking special precautions.
11885 For instance, if the stack starts at absolute address @samp{0x80000000}
11886 and grows downwards, you can use the flags
11887 @option{-fstack-limit-symbol=__stack_limit} and
11888 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11889 of 128KB@.  Note that this may only work with the GNU linker.
11891 You can locally override stack limit checking by using the
11892 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11894 @item -fsplit-stack
11895 @opindex fsplit-stack
11896 Generate code to automatically split the stack before it overflows.
11897 The resulting program has a discontiguous stack which can only
11898 overflow if the program is unable to allocate any more memory.  This
11899 is most useful when running threaded programs, as it is no longer
11900 necessary to calculate a good stack size to use for each thread.  This
11901 is currently only implemented for the x86 targets running
11902 GNU/Linux.
11904 When code compiled with @option{-fsplit-stack} calls code compiled
11905 without @option{-fsplit-stack}, there may not be much stack space
11906 available for the latter code to run.  If compiling all code,
11907 including library code, with @option{-fsplit-stack} is not an option,
11908 then the linker can fix up these calls so that the code compiled
11909 without @option{-fsplit-stack} always has a large stack.  Support for
11910 this is implemented in the gold linker in GNU binutils release 2.21
11911 and later.
11913 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11914 @opindex fvtable-verify
11915 This option is only available when compiling C++ code.
11916 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11917 feature that verifies at run time, for every virtual call, that
11918 the vtable pointer through which the call is made is valid for the type of
11919 the object, and has not been corrupted or overwritten.  If an invalid vtable
11920 pointer is detected at run time, an error is reported and execution of the
11921 program is immediately halted.
11923 This option causes run-time data structures to be built at program startup,
11924 which are used for verifying the vtable pointers.  
11925 The options @samp{std} and @samp{preinit}
11926 control the timing of when these data structures are built.  In both cases the
11927 data structures are built before execution reaches @code{main}.  Using
11928 @option{-fvtable-verify=std} causes the data structures to be built after
11929 shared libraries have been loaded and initialized.
11930 @option{-fvtable-verify=preinit} causes them to be built before shared
11931 libraries have been loaded and initialized.
11933 If this option appears multiple times in the command line with different
11934 values specified, @samp{none} takes highest priority over both @samp{std} and
11935 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11937 @item -fvtv-debug
11938 @opindex fvtv-debug
11939 When used in conjunction with @option{-fvtable-verify=std} or 
11940 @option{-fvtable-verify=preinit}, causes debug versions of the 
11941 runtime functions for the vtable verification feature to be called.  
11942 This flag also causes the compiler to log information about which 
11943 vtable pointers it finds for each class.
11944 This information is written to a file named @file{vtv_set_ptr_data.log} 
11945 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11946 if that is defined or the current working directory otherwise.
11948 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11949 file, be sure to delete any existing one.
11951 @item -fvtv-counts
11952 @opindex fvtv-counts
11953 This is a debugging flag.  When used in conjunction with
11954 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11955 causes the compiler to keep track of the total number of virtual calls
11956 it encounters and the number of verifications it inserts.  It also
11957 counts the number of calls to certain run-time library functions
11958 that it inserts and logs this information for each compilation unit.
11959 The compiler writes this information to a file named
11960 @file{vtv_count_data.log} in the directory named by the environment
11961 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11962 directory otherwise.  It also counts the size of the vtable pointer sets
11963 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11964 in the same directory.
11966 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11967 files, be sure to delete any existing ones.
11969 @item -finstrument-functions
11970 @opindex finstrument-functions
11971 Generate instrumentation calls for entry and exit to functions.  Just
11972 after function entry and just before function exit, the following
11973 profiling functions are called with the address of the current
11974 function and its call site.  (On some platforms,
11975 @code{__builtin_return_address} does not work beyond the current
11976 function, so the call site information may not be available to the
11977 profiling functions otherwise.)
11979 @smallexample
11980 void __cyg_profile_func_enter (void *this_fn,
11981                                void *call_site);
11982 void __cyg_profile_func_exit  (void *this_fn,
11983                                void *call_site);
11984 @end smallexample
11986 The first argument is the address of the start of the current function,
11987 which may be looked up exactly in the symbol table.
11989 This instrumentation is also done for functions expanded inline in other
11990 functions.  The profiling calls indicate where, conceptually, the
11991 inline function is entered and exited.  This means that addressable
11992 versions of such functions must be available.  If all your uses of a
11993 function are expanded inline, this may mean an additional expansion of
11994 code size.  If you use @code{extern inline} in your C code, an
11995 addressable version of such functions must be provided.  (This is
11996 normally the case anyway, but if you get lucky and the optimizer always
11997 expands the functions inline, you might have gotten away without
11998 providing static copies.)
12000 A function may be given the attribute @code{no_instrument_function}, in
12001 which case this instrumentation is not done.  This can be used, for
12002 example, for the profiling functions listed above, high-priority
12003 interrupt routines, and any functions from which the profiling functions
12004 cannot safely be called (perhaps signal handlers, if the profiling
12005 routines generate output or allocate memory).
12007 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12008 @opindex finstrument-functions-exclude-file-list
12010 Set the list of functions that are excluded from instrumentation (see
12011 the description of @option{-finstrument-functions}).  If the file that
12012 contains a function definition matches with one of @var{file}, then
12013 that function is not instrumented.  The match is done on substrings:
12014 if the @var{file} parameter is a substring of the file name, it is
12015 considered to be a match.
12017 For example:
12019 @smallexample
12020 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12021 @end smallexample
12023 @noindent
12024 excludes any inline function defined in files whose pathnames
12025 contain @file{/bits/stl} or @file{include/sys}.
12027 If, for some reason, you want to include letter @samp{,} in one of
12028 @var{sym}, write @samp{\,}. For example,
12029 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12030 (note the single quote surrounding the option).
12032 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12033 @opindex finstrument-functions-exclude-function-list
12035 This is similar to @option{-finstrument-functions-exclude-file-list},
12036 but this option sets the list of function names to be excluded from
12037 instrumentation.  The function name to be matched is its user-visible
12038 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12039 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12040 match is done on substrings: if the @var{sym} parameter is a substring
12041 of the function name, it is considered to be a match.  For C99 and C++
12042 extended identifiers, the function name must be given in UTF-8, not
12043 using universal character names.
12045 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12046 @opindex fpatchable-function-entry
12047 Generate @var{N} NOPs right at the beginning
12048 of each function, with the function entry point before the @var{M}th NOP.
12049 If @var{M} is omitted, it defaults to @code{0} so the
12050 function entry points to the address just at the first NOP.
12051 The NOP instructions reserve extra space which can be used to patch in
12052 any desired instrumentation at run time, provided that the code segment
12053 is writable.  The amount of space is controllable indirectly via
12054 the number of NOPs; the NOP instruction used corresponds to the instruction
12055 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12056 is target-specific and may also depend on the architecture variant and/or
12057 other compilation options.
12059 For run-time identification, the starting addresses of these areas,
12060 which correspond to their respective function entries minus @var{M},
12061 are additionally collected in the @code{__patchable_function_entries}
12062 section of the resulting binary.
12064 Note that the value of @code{__attribute__ ((patchable_function_entry
12065 (N,M)))} takes precedence over command-line option
12066 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12067 the area size or to remove it completely on a single function.
12068 If @code{N=0}, no pad location is recorded.
12070 The NOP instructions are inserted at---and maybe before, depending on
12071 @var{M}---the function entry address, even before the prologue.
12073 @end table
12076 @node Preprocessor Options
12077 @section Options Controlling the Preprocessor
12078 @cindex preprocessor options
12079 @cindex options, preprocessor
12081 These options control the C preprocessor, which is run on each C source
12082 file before actual compilation.
12084 If you use the @option{-E} option, nothing is done except preprocessing.
12085 Some of these options make sense only together with @option{-E} because
12086 they cause the preprocessor output to be unsuitable for actual
12087 compilation.
12089 In addition to the options listed here, there are a number of options 
12090 to control search paths for include files documented in 
12091 @ref{Directory Options}.  
12092 Options to control preprocessor diagnostics are listed in 
12093 @ref{Warning Options}.
12095 @table @gcctabopt
12096 @include cppopts.texi
12098 @item -Wp,@var{option}
12099 @opindex Wp
12100 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12101 and pass @var{option} directly through to the preprocessor.  If
12102 @var{option} contains commas, it is split into multiple options at the
12103 commas.  However, many options are modified, translated or interpreted
12104 by the compiler driver before being passed to the preprocessor, and
12105 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12106 interface is undocumented and subject to change, so whenever possible
12107 you should avoid using @option{-Wp} and let the driver handle the
12108 options instead.
12110 @item -Xpreprocessor @var{option}
12111 @opindex Xpreprocessor
12112 Pass @var{option} as an option to the preprocessor.  You can use this to
12113 supply system-specific preprocessor options that GCC does not 
12114 recognize.
12116 If you want to pass an option that takes an argument, you must use
12117 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12119 @item -no-integrated-cpp
12120 @opindex no-integrated-cpp
12121 Perform preprocessing as a separate pass before compilation.
12122 By default, GCC performs preprocessing as an integrated part of
12123 input tokenization and parsing.
12124 If this option is provided, the appropriate language front end
12125 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12126 and Objective-C, respectively) is instead invoked twice,
12127 once for preprocessing only and once for actual compilation
12128 of the preprocessed input.
12129 This option may be useful in conjunction with the @option{-B} or
12130 @option{-wrapper} options to specify an alternate preprocessor or
12131 perform additional processing of the program source between
12132 normal preprocessing and compilation.
12134 @end table
12136 @node Assembler Options
12137 @section Passing Options to the Assembler
12139 @c prevent bad page break with this line
12140 You can pass options to the assembler.
12142 @table @gcctabopt
12143 @item -Wa,@var{option}
12144 @opindex Wa
12145 Pass @var{option} as an option to the assembler.  If @var{option}
12146 contains commas, it is split into multiple options at the commas.
12148 @item -Xassembler @var{option}
12149 @opindex Xassembler
12150 Pass @var{option} as an option to the assembler.  You can use this to
12151 supply system-specific assembler options that GCC does not
12152 recognize.
12154 If you want to pass an option that takes an argument, you must use
12155 @option{-Xassembler} twice, once for the option and once for the argument.
12157 @end table
12159 @node Link Options
12160 @section Options for Linking
12161 @cindex link options
12162 @cindex options, linking
12164 These options come into play when the compiler links object files into
12165 an executable output file.  They are meaningless if the compiler is
12166 not doing a link step.
12168 @table @gcctabopt
12169 @cindex file names
12170 @item @var{object-file-name}
12171 A file name that does not end in a special recognized suffix is
12172 considered to name an object file or library.  (Object files are
12173 distinguished from libraries by the linker according to the file
12174 contents.)  If linking is done, these object files are used as input
12175 to the linker.
12177 @item -c
12178 @itemx -S
12179 @itemx -E
12180 @opindex c
12181 @opindex S
12182 @opindex E
12183 If any of these options is used, then the linker is not run, and
12184 object file names should not be used as arguments.  @xref{Overall
12185 Options}.
12187 @item -fuse-ld=bfd
12188 @opindex fuse-ld=bfd
12189 Use the @command{bfd} linker instead of the default linker.
12191 @item -fuse-ld=gold
12192 @opindex fuse-ld=gold
12193 Use the @command{gold} linker instead of the default linker.
12195 @cindex Libraries
12196 @item -l@var{library}
12197 @itemx -l @var{library}
12198 @opindex l
12199 Search the library named @var{library} when linking.  (The second
12200 alternative with the library as a separate argument is only for
12201 POSIX compliance and is not recommended.)
12203 It makes a difference where in the command you write this option; the
12204 linker searches and processes libraries and object files in the order they
12205 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12206 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12207 to functions in @samp{z}, those functions may not be loaded.
12209 The linker searches a standard list of directories for the library,
12210 which is actually a file named @file{lib@var{library}.a}.  The linker
12211 then uses this file as if it had been specified precisely by name.
12213 The directories searched include several standard system directories
12214 plus any that you specify with @option{-L}.
12216 Normally the files found this way are library files---archive files
12217 whose members are object files.  The linker handles an archive file by
12218 scanning through it for members which define symbols that have so far
12219 been referenced but not defined.  But if the file that is found is an
12220 ordinary object file, it is linked in the usual fashion.  The only
12221 difference between using an @option{-l} option and specifying a file name
12222 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12223 and searches several directories.
12225 @item -lobjc
12226 @opindex lobjc
12227 You need this special case of the @option{-l} option in order to
12228 link an Objective-C or Objective-C++ program.
12230 @item -nostartfiles
12231 @opindex nostartfiles
12232 Do not use the standard system startup files when linking.
12233 The standard system libraries are used normally, unless @option{-nostdlib}
12234 or @option{-nodefaultlibs} is used.
12236 @item -nodefaultlibs
12237 @opindex nodefaultlibs
12238 Do not use the standard system libraries when linking.
12239 Only the libraries you specify are passed to the linker, and options
12240 specifying linkage of the system libraries, such as @option{-static-libgcc}
12241 or @option{-shared-libgcc}, are ignored.  
12242 The standard startup files are used normally, unless @option{-nostartfiles}
12243 is used.  
12245 The compiler may generate calls to @code{memcmp},
12246 @code{memset}, @code{memcpy} and @code{memmove}.
12247 These entries are usually resolved by entries in
12248 libc.  These entry points should be supplied through some other
12249 mechanism when this option is specified.
12251 @item -nostdlib
12252 @opindex nostdlib
12253 Do not use the standard system startup files or libraries when linking.
12254 No startup files and only the libraries you specify are passed to
12255 the linker, and options specifying linkage of the system libraries, such as
12256 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12258 The compiler may generate calls to @code{memcmp}, @code{memset},
12259 @code{memcpy} and @code{memmove}.
12260 These entries are usually resolved by entries in
12261 libc.  These entry points should be supplied through some other
12262 mechanism when this option is specified.
12264 @cindex @option{-lgcc}, use with @option{-nostdlib}
12265 @cindex @option{-nostdlib} and unresolved references
12266 @cindex unresolved references and @option{-nostdlib}
12267 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12268 @cindex @option{-nodefaultlibs} and unresolved references
12269 @cindex unresolved references and @option{-nodefaultlibs}
12270 One of the standard libraries bypassed by @option{-nostdlib} and
12271 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12272 which GCC uses to overcome shortcomings of particular machines, or special
12273 needs for some languages.
12274 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12275 Collection (GCC) Internals},
12276 for more discussion of @file{libgcc.a}.)
12277 In most cases, you need @file{libgcc.a} even when you want to avoid
12278 other standard libraries.  In other words, when you specify @option{-nostdlib}
12279 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12280 This ensures that you have no unresolved references to internal GCC
12281 library subroutines.
12282 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12283 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12284 GNU Compiler Collection (GCC) Internals}.)
12286 @item -pie
12287 @opindex pie
12288 Produce a dynamically linked position independent executable on targets
12289 that support it.  For predictable results, you must also specify the same
12290 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12291 or model suboptions) when you specify this linker option.
12293 @item -no-pie
12294 @opindex no-pie
12295 Don't produce a dynamically linked position independent executable.
12297 @item -static-pie
12298 @opindex static-pie
12299 Produce a static position independent executable on targets that support
12300 it.  A static position independent executable is similar to a static
12301 executable, but can be loaded at any address without a dynamic linker.
12302 For predictable results, you must also specify the same set of options
12303 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12304 suboptions) when you specify this linker option.
12306 @item -pthread
12307 @opindex pthread
12308 Link with the POSIX threads library.  This option is supported on 
12309 GNU/Linux targets, most other Unix derivatives, and also on 
12310 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12311 flags for the preprocessor, so it should be used consistently for both
12312 compilation and linking.
12314 @item -rdynamic
12315 @opindex rdynamic
12316 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12317 that support it. This instructs the linker to add all symbols, not
12318 only used ones, to the dynamic symbol table. This option is needed
12319 for some uses of @code{dlopen} or to allow obtaining backtraces
12320 from within a program.
12322 @item -s
12323 @opindex s
12324 Remove all symbol table and relocation information from the executable.
12326 @item -static
12327 @opindex static
12328 On systems that support dynamic linking, this overrides @option{-pie}
12329 and prevents linking with the shared libraries.  On other systems, this
12330 option has no effect.
12332 @item -shared
12333 @opindex shared
12334 Produce a shared object which can then be linked with other objects to
12335 form an executable.  Not all systems support this option.  For predictable
12336 results, you must also specify the same set of options used for compilation
12337 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12338 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12339 needs to build supplementary stub code for constructors to work.  On
12340 multi-libbed systems, @samp{gcc -shared} must select the correct support
12341 libraries to link against.  Failing to supply the correct flags may lead
12342 to subtle defects.  Supplying them in cases where they are not necessary
12343 is innocuous.}
12345 @item -shared-libgcc
12346 @itemx -static-libgcc
12347 @opindex shared-libgcc
12348 @opindex static-libgcc
12349 On systems that provide @file{libgcc} as a shared library, these options
12350 force the use of either the shared or static version, respectively.
12351 If no shared version of @file{libgcc} was built when the compiler was
12352 configured, these options have no effect.
12354 There are several situations in which an application should use the
12355 shared @file{libgcc} instead of the static version.  The most common
12356 of these is when the application wishes to throw and catch exceptions
12357 across different shared libraries.  In that case, each of the libraries
12358 as well as the application itself should use the shared @file{libgcc}.
12360 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12361  whenever you build a shared library or a main executable, because C++
12362  programs typically use exceptions, so this is the right thing to do.
12364 If, instead, you use the GCC driver to create shared libraries, you may
12365 find that they are not always linked with the shared @file{libgcc}.
12366 If GCC finds, at its configuration time, that you have a non-GNU linker
12367 or a GNU linker that does not support option @option{--eh-frame-hdr},
12368 it links the shared version of @file{libgcc} into shared libraries
12369 by default.  Otherwise, it takes advantage of the linker and optimizes
12370 away the linking with the shared version of @file{libgcc}, linking with
12371 the static version of libgcc by default.  This allows exceptions to
12372 propagate through such shared libraries, without incurring relocation
12373 costs at library load time.
12375 However, if a library or main executable is supposed to throw or catch
12376 exceptions, you must link it using the G++ driver, as appropriate
12377 for the languages used in the program, or using the option
12378 @option{-shared-libgcc}, such that it is linked with the shared
12379 @file{libgcc}.
12381 @item -static-libasan
12382 @opindex static-libasan
12383 When the @option{-fsanitize=address} option is used to link a program,
12384 the GCC driver automatically links against @option{libasan}.  If
12385 @file{libasan} is available as a shared library, and the @option{-static}
12386 option is not used, then this links against the shared version of
12387 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12388 driver to link @file{libasan} statically, without necessarily linking
12389 other libraries statically.
12391 @item -static-libtsan
12392 @opindex static-libtsan
12393 When the @option{-fsanitize=thread} option is used to link a program,
12394 the GCC driver automatically links against @option{libtsan}.  If
12395 @file{libtsan} is available as a shared library, and the @option{-static}
12396 option is not used, then this links against the shared version of
12397 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12398 driver to link @file{libtsan} statically, without necessarily linking
12399 other libraries statically.
12401 @item -static-liblsan
12402 @opindex static-liblsan
12403 When the @option{-fsanitize=leak} option is used to link a program,
12404 the GCC driver automatically links against @option{liblsan}.  If
12405 @file{liblsan} is available as a shared library, and the @option{-static}
12406 option is not used, then this links against the shared version of
12407 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12408 driver to link @file{liblsan} statically, without necessarily linking
12409 other libraries statically.
12411 @item -static-libubsan
12412 @opindex static-libubsan
12413 When the @option{-fsanitize=undefined} option is used to link a program,
12414 the GCC driver automatically links against @option{libubsan}.  If
12415 @file{libubsan} is available as a shared library, and the @option{-static}
12416 option is not used, then this links against the shared version of
12417 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12418 driver to link @file{libubsan} statically, without necessarily linking
12419 other libraries statically.
12421 @item -static-libmpx
12422 @opindex static-libmpx
12423 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12424 used to link a program, the GCC driver automatically links against
12425 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12426 and the @option{-static} option is not used, then this links against
12427 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12428 option directs the GCC driver to link @file{libmpx} statically,
12429 without necessarily linking other libraries statically.
12431 @item -static-libmpxwrappers
12432 @opindex static-libmpxwrappers
12433 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12434 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12435 GCC driver automatically links against @file{libmpxwrappers}.  If
12436 @file{libmpxwrappers} is available as a shared library, and the
12437 @option{-static} option is not used, then this links against the shared
12438 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12439 option directs the GCC driver to link @file{libmpxwrappers} statically,
12440 without necessarily linking other libraries statically.
12442 @item -static-libstdc++
12443 @opindex static-libstdc++
12444 When the @command{g++} program is used to link a C++ program, it
12445 normally automatically links against @option{libstdc++}.  If
12446 @file{libstdc++} is available as a shared library, and the
12447 @option{-static} option is not used, then this links against the
12448 shared version of @file{libstdc++}.  That is normally fine.  However, it
12449 is sometimes useful to freeze the version of @file{libstdc++} used by
12450 the program without going all the way to a fully static link.  The
12451 @option{-static-libstdc++} option directs the @command{g++} driver to
12452 link @file{libstdc++} statically, without necessarily linking other
12453 libraries statically.
12455 @item -symbolic
12456 @opindex symbolic
12457 Bind references to global symbols when building a shared object.  Warn
12458 about any unresolved references (unless overridden by the link editor
12459 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12460 this option.
12462 @item -T @var{script}
12463 @opindex T
12464 @cindex linker script
12465 Use @var{script} as the linker script.  This option is supported by most
12466 systems using the GNU linker.  On some targets, such as bare-board
12467 targets without an operating system, the @option{-T} option may be required
12468 when linking to avoid references to undefined symbols.
12470 @item -Xlinker @var{option}
12471 @opindex Xlinker
12472 Pass @var{option} as an option to the linker.  You can use this to
12473 supply system-specific linker options that GCC does not recognize.
12475 If you want to pass an option that takes a separate argument, you must use
12476 @option{-Xlinker} twice, once for the option and once for the argument.
12477 For example, to pass @option{-assert definitions}, you must write
12478 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12479 @option{-Xlinker "-assert definitions"}, because this passes the entire
12480 string as a single argument, which is not what the linker expects.
12482 When using the GNU linker, it is usually more convenient to pass
12483 arguments to linker options using the @option{@var{option}=@var{value}}
12484 syntax than as separate arguments.  For example, you can specify
12485 @option{-Xlinker -Map=output.map} rather than
12486 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12487 this syntax for command-line options.
12489 @item -Wl,@var{option}
12490 @opindex Wl
12491 Pass @var{option} as an option to the linker.  If @var{option} contains
12492 commas, it is split into multiple options at the commas.  You can use this
12493 syntax to pass an argument to the option.
12494 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12495 linker.  When using the GNU linker, you can also get the same effect with
12496 @option{-Wl,-Map=output.map}.
12498 @item -u @var{symbol}
12499 @opindex u
12500 Pretend the symbol @var{symbol} is undefined, to force linking of
12501 library modules to define it.  You can use @option{-u} multiple times with
12502 different symbols to force loading of additional library modules.
12504 @item -z @var{keyword}
12505 @opindex z
12506 @option{-z} is passed directly on to the linker along with the keyword
12507 @var{keyword}. See the section in the documentation of your linker for
12508 permitted values and their meanings.
12509 @end table
12511 @node Directory Options
12512 @section Options for Directory Search
12513 @cindex directory options
12514 @cindex options, directory search
12515 @cindex search path
12517 These options specify directories to search for header files, for
12518 libraries and for parts of the compiler:
12520 @table @gcctabopt
12521 @include cppdiropts.texi
12523 @item -iplugindir=@var{dir}
12524 @opindex iplugindir=
12525 Set the directory to search for plugins that are passed
12526 by @option{-fplugin=@var{name}} instead of
12527 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12528 to be used by the user, but only passed by the driver.
12530 @item -L@var{dir}
12531 @opindex L
12532 Add directory @var{dir} to the list of directories to be searched
12533 for @option{-l}.
12535 @item -B@var{prefix}
12536 @opindex B
12537 This option specifies where to find the executables, libraries,
12538 include files, and data files of the compiler itself.
12540 The compiler driver program runs one or more of the subprograms
12541 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12542 @var{prefix} as a prefix for each program it tries to run, both with and
12543 without @samp{@var{machine}/@var{version}/} for the corresponding target
12544 machine and compiler version.
12546 For each subprogram to be run, the compiler driver first tries the
12547 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12548 is not specified, the driver tries two standard prefixes, 
12549 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12550 those results in a file name that is found, the unmodified program
12551 name is searched for using the directories specified in your
12552 @env{PATH} environment variable.
12554 The compiler checks to see if the path provided by @option{-B}
12555 refers to a directory, and if necessary it adds a directory
12556 separator character at the end of the path.
12558 @option{-B} prefixes that effectively specify directory names also apply
12559 to libraries in the linker, because the compiler translates these
12560 options into @option{-L} options for the linker.  They also apply to
12561 include files in the preprocessor, because the compiler translates these
12562 options into @option{-isystem} options for the preprocessor.  In this case,
12563 the compiler appends @samp{include} to the prefix.
12565 The runtime support file @file{libgcc.a} can also be searched for using
12566 the @option{-B} prefix, if needed.  If it is not found there, the two
12567 standard prefixes above are tried, and that is all.  The file is left
12568 out of the link if it is not found by those means.
12570 Another way to specify a prefix much like the @option{-B} prefix is to use
12571 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12572 Variables}.
12574 As a special kludge, if the path provided by @option{-B} is
12575 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12576 9, then it is replaced by @file{[dir/]include}.  This is to help
12577 with boot-strapping the compiler.
12579 @item -no-canonical-prefixes
12580 @opindex no-canonical-prefixes
12581 Do not expand any symbolic links, resolve references to @samp{/../}
12582 or @samp{/./}, or make the path absolute when generating a relative
12583 prefix.
12585 @item --sysroot=@var{dir}
12586 @opindex sysroot
12587 Use @var{dir} as the logical root directory for headers and libraries.
12588 For example, if the compiler normally searches for headers in
12589 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12590 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12592 If you use both this option and the @option{-isysroot} option, then
12593 the @option{--sysroot} option applies to libraries, but the
12594 @option{-isysroot} option applies to header files.
12596 The GNU linker (beginning with version 2.16) has the necessary support
12597 for this option.  If your linker does not support this option, the
12598 header file aspect of @option{--sysroot} still works, but the
12599 library aspect does not.
12601 @item --no-sysroot-suffix
12602 @opindex no-sysroot-suffix
12603 For some targets, a suffix is added to the root directory specified
12604 with @option{--sysroot}, depending on the other options used, so that
12605 headers may for example be found in
12606 @file{@var{dir}/@var{suffix}/usr/include} instead of
12607 @file{@var{dir}/usr/include}.  This option disables the addition of
12608 such a suffix.
12610 @end table
12612 @node Code Gen Options
12613 @section Options for Code Generation Conventions
12614 @cindex code generation conventions
12615 @cindex options, code generation
12616 @cindex run-time options
12618 These machine-independent options control the interface conventions
12619 used in code generation.
12621 Most of them have both positive and negative forms; the negative form
12622 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12623 one of the forms is listed---the one that is not the default.  You
12624 can figure out the other form by either removing @samp{no-} or adding
12627 @table @gcctabopt
12628 @item -fstack-reuse=@var{reuse-level}
12629 @opindex fstack_reuse
12630 This option controls stack space reuse for user declared local/auto variables
12631 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12632 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12633 local variables and temporaries, @samp{named_vars} enables the reuse only for
12634 user defined local variables with names, and @samp{none} disables stack reuse
12635 completely. The default value is @samp{all}. The option is needed when the
12636 program extends the lifetime of a scoped local variable or a compiler generated
12637 temporary beyond the end point defined by the language.  When a lifetime of
12638 a variable ends, and if the variable lives in memory, the optimizing compiler
12639 has the freedom to reuse its stack space with other temporaries or scoped
12640 local variables whose live range does not overlap with it. Legacy code extending
12641 local lifetime is likely to break with the stack reuse optimization.
12643 For example,
12645 @smallexample
12646    int *p;
12647    @{
12648      int local1;
12650      p = &local1;
12651      local1 = 10;
12652      ....
12653    @}
12654    @{
12655       int local2;
12656       local2 = 20;
12657       ...
12658    @}
12660    if (*p == 10)  // out of scope use of local1
12661      @{
12663      @}
12664 @end smallexample
12666 Another example:
12667 @smallexample
12669    struct A
12670    @{
12671        A(int k) : i(k), j(k) @{ @}
12672        int i;
12673        int j;
12674    @};
12676    A *ap;
12678    void foo(const A& ar)
12679    @{
12680       ap = &ar;
12681    @}
12683    void bar()
12684    @{
12685       foo(A(10)); // temp object's lifetime ends when foo returns
12687       @{
12688         A a(20);
12689         ....
12690       @}
12691       ap->i+= 10;  // ap references out of scope temp whose space
12692                    // is reused with a. What is the value of ap->i?
12693    @}
12695 @end smallexample
12697 The lifetime of a compiler generated temporary is well defined by the C++
12698 standard. When a lifetime of a temporary ends, and if the temporary lives
12699 in memory, the optimizing compiler has the freedom to reuse its stack
12700 space with other temporaries or scoped local variables whose live range
12701 does not overlap with it. However some of the legacy code relies on
12702 the behavior of older compilers in which temporaries' stack space is
12703 not reused, the aggressive stack reuse can lead to runtime errors. This
12704 option is used to control the temporary stack reuse optimization.
12706 @item -ftrapv
12707 @opindex ftrapv
12708 This option generates traps for signed overflow on addition, subtraction,
12709 multiplication operations.
12710 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12711 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12712 @option{-fwrapv} being effective.  Note that only active options override, so
12713 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12714 results in @option{-ftrapv} being effective.
12716 @item -fwrapv
12717 @opindex fwrapv
12718 This option instructs the compiler to assume that signed arithmetic
12719 overflow of addition, subtraction and multiplication wraps around
12720 using twos-complement representation.  This flag enables some optimizations
12721 and disables others.
12722 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12723 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12724 @option{-fwrapv} being effective.  Note that only active options override, so
12725 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12726 results in @option{-ftrapv} being effective.
12728 @item -fwrapv-pointer
12729 @opindex fwrapv-pointer
12730 This option instructs the compiler to assume that pointer arithmetic
12731 overflow on addition and subtraction wraps around using twos-complement
12732 representation.  This flag disables some optimizations which assume
12733 pointer overflow is invalid.
12735 @item -fstrict-overflow
12736 @opindex fstrict-overflow
12737 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12738 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12740 @item -fexceptions
12741 @opindex fexceptions
12742 Enable exception handling.  Generates extra code needed to propagate
12743 exceptions.  For some targets, this implies GCC generates frame
12744 unwind information for all functions, which can produce significant data
12745 size overhead, although it does not affect execution.  If you do not
12746 specify this option, GCC enables it by default for languages like
12747 C++ that normally require exception handling, and disables it for
12748 languages like C that do not normally require it.  However, you may need
12749 to enable this option when compiling C code that needs to interoperate
12750 properly with exception handlers written in C++.  You may also wish to
12751 disable this option if you are compiling older C++ programs that don't
12752 use exception handling.
12754 @item -fnon-call-exceptions
12755 @opindex fnon-call-exceptions
12756 Generate code that allows trapping instructions to throw exceptions.
12757 Note that this requires platform-specific runtime support that does
12758 not exist everywhere.  Moreover, it only allows @emph{trapping}
12759 instructions to throw exceptions, i.e.@: memory references or floating-point
12760 instructions.  It does not allow exceptions to be thrown from
12761 arbitrary signal handlers such as @code{SIGALRM}.
12763 @item -fdelete-dead-exceptions
12764 @opindex fdelete-dead-exceptions
12765 Consider that instructions that may throw exceptions but don't otherwise
12766 contribute to the execution of the program can be optimized away.
12767 This option is enabled by default for the Ada front end, as permitted by
12768 the Ada language specification.
12769 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12771 @item -funwind-tables
12772 @opindex funwind-tables
12773 Similar to @option{-fexceptions}, except that it just generates any needed
12774 static data, but does not affect the generated code in any other way.
12775 You normally do not need to enable this option; instead, a language processor
12776 that needs this handling enables it on your behalf.
12778 @item -fasynchronous-unwind-tables
12779 @opindex fasynchronous-unwind-tables
12780 Generate unwind table in DWARF format, if supported by target machine.  The
12781 table is exact at each instruction boundary, so it can be used for stack
12782 unwinding from asynchronous events (such as debugger or garbage collector).
12784 @item -fno-gnu-unique
12785 @opindex fno-gnu-unique
12786 On systems with recent GNU assembler and C library, the C++ compiler
12787 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12788 of template static data members and static local variables in inline
12789 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12790 is necessary to avoid problems with a library used by two different
12791 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12792 therefore disagreeing with the other one about the binding of the
12793 symbol.  But this causes @code{dlclose} to be ignored for affected
12794 DSOs; if your program relies on reinitialization of a DSO via
12795 @code{dlclose} and @code{dlopen}, you can use
12796 @option{-fno-gnu-unique}.
12798 @item -fpcc-struct-return
12799 @opindex fpcc-struct-return
12800 Return ``short'' @code{struct} and @code{union} values in memory like
12801 longer ones, rather than in registers.  This convention is less
12802 efficient, but it has the advantage of allowing intercallability between
12803 GCC-compiled files and files compiled with other compilers, particularly
12804 the Portable C Compiler (pcc).
12806 The precise convention for returning structures in memory depends
12807 on the target configuration macros.
12809 Short structures and unions are those whose size and alignment match
12810 that of some integer type.
12812 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12813 switch is not binary compatible with code compiled with the
12814 @option{-freg-struct-return} switch.
12815 Use it to conform to a non-default application binary interface.
12817 @item -freg-struct-return
12818 @opindex freg-struct-return
12819 Return @code{struct} and @code{union} values in registers when possible.
12820 This is more efficient for small structures than
12821 @option{-fpcc-struct-return}.
12823 If you specify neither @option{-fpcc-struct-return} nor
12824 @option{-freg-struct-return}, GCC defaults to whichever convention is
12825 standard for the target.  If there is no standard convention, GCC
12826 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12827 the principal compiler.  In those cases, we can choose the standard, and
12828 we chose the more efficient register return alternative.
12830 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12831 switch is not binary compatible with code compiled with the
12832 @option{-fpcc-struct-return} switch.
12833 Use it to conform to a non-default application binary interface.
12835 @item -fshort-enums
12836 @opindex fshort-enums
12837 Allocate to an @code{enum} type only as many bytes as it needs for the
12838 declared range of possible values.  Specifically, the @code{enum} type
12839 is equivalent to the smallest integer type that has enough room.
12841 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12842 code that is not binary compatible with code generated without that switch.
12843 Use it to conform to a non-default application binary interface.
12845 @item -fshort-wchar
12846 @opindex fshort-wchar
12847 Override the underlying type for @code{wchar_t} to be @code{short
12848 unsigned int} instead of the default for the target.  This option is
12849 useful for building programs to run under WINE@.
12851 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12852 code that is not binary compatible with code generated without that switch.
12853 Use it to conform to a non-default application binary interface.
12855 @item -fno-common
12856 @opindex fno-common
12857 @cindex tentative definitions
12858 In C code, this option controls the placement of global variables 
12859 defined without an initializer, known as @dfn{tentative definitions} 
12860 in the C standard.  Tentative definitions are distinct from declarations 
12861 of a variable with the @code{extern} keyword, which do not allocate storage.
12863 Unix C compilers have traditionally allocated storage for
12864 uninitialized global variables in a common block.  This allows the
12865 linker to resolve all tentative definitions of the same variable
12866 in different compilation units to the same object, or to a non-tentative
12867 definition.  
12868 This is the behavior specified by @option{-fcommon}, and is the default for 
12869 GCC on most targets.  
12870 On the other hand, this behavior is not required by ISO
12871 C, and on some targets may carry a speed or code size penalty on
12872 variable references.
12874 The @option{-fno-common} option specifies that the compiler should instead
12875 place uninitialized global variables in the data section of the object file.
12876 This inhibits the merging of tentative definitions by the linker so
12877 you get a multiple-definition error if the same 
12878 variable is defined in more than one compilation unit.
12879 Compiling with @option{-fno-common} is useful on targets for which
12880 it provides better performance, or if you wish to verify that the
12881 program will work on other systems that always treat uninitialized
12882 variable definitions this way.
12884 @item -fno-ident
12885 @opindex fno-ident
12886 Ignore the @code{#ident} directive.
12888 @item -finhibit-size-directive
12889 @opindex finhibit-size-directive
12890 Don't output a @code{.size} assembler directive, or anything else that
12891 would cause trouble if the function is split in the middle, and the
12892 two halves are placed at locations far apart in memory.  This option is
12893 used when compiling @file{crtstuff.c}; you should not need to use it
12894 for anything else.
12896 @item -fverbose-asm
12897 @opindex fverbose-asm
12898 Put extra commentary information in the generated assembly code to
12899 make it more readable.  This option is generally only of use to those
12900 who actually need to read the generated assembly code (perhaps while
12901 debugging the compiler itself).
12903 @option{-fno-verbose-asm}, the default, causes the
12904 extra information to be omitted and is useful when comparing two assembler
12905 files.
12907 The added comments include:
12909 @itemize @bullet
12911 @item
12912 information on the compiler version and command-line options,
12914 @item
12915 the source code lines associated with the assembly instructions,
12916 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12918 @item
12919 hints on which high-level expressions correspond to
12920 the various assembly instruction operands.
12922 @end itemize
12924 For example, given this C source file:
12926 @smallexample
12927 int test (int n)
12929   int i;
12930   int total = 0;
12932   for (i = 0; i < n; i++)
12933     total += i * i;
12935   return total;
12937 @end smallexample
12939 compiling to (x86_64) assembly via @option{-S} and emitting the result
12940 direct to stdout via @option{-o} @option{-}
12942 @smallexample
12943 gcc -S test.c -fverbose-asm -Os -o -
12944 @end smallexample
12946 gives output similar to this:
12948 @smallexample
12949         .file   "test.c"
12950 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12951   [...snip...]
12952 # options passed:
12953   [...snip...]
12955         .text
12956         .globl  test
12957         .type   test, @@function
12958 test:
12959 .LFB0:
12960         .cfi_startproc
12961 # test.c:4:   int total = 0;
12962         xorl    %eax, %eax      # <retval>
12963 # test.c:6:   for (i = 0; i < n; i++)
12964         xorl    %edx, %edx      # i
12965 .L2:
12966 # test.c:6:   for (i = 0; i < n; i++)
12967         cmpl    %edi, %edx      # n, i
12968         jge     .L5     #,
12969 # test.c:7:     total += i * i;
12970         movl    %edx, %ecx      # i, tmp92
12971         imull   %edx, %ecx      # i, tmp92
12972 # test.c:6:   for (i = 0; i < n; i++)
12973         incl    %edx    # i
12974 # test.c:7:     total += i * i;
12975         addl    %ecx, %eax      # tmp92, <retval>
12976         jmp     .L2     #
12977 .L5:
12978 # test.c:10: @}
12979         ret
12980         .cfi_endproc
12981 .LFE0:
12982         .size   test, .-test
12983         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12984         .section        .note.GNU-stack,"",@@progbits
12985 @end smallexample
12987 The comments are intended for humans rather than machines and hence the
12988 precise format of the comments is subject to change.
12990 @item -frecord-gcc-switches
12991 @opindex frecord-gcc-switches
12992 This switch causes the command line used to invoke the
12993 compiler to be recorded into the object file that is being created.
12994 This switch is only implemented on some targets and the exact format
12995 of the recording is target and binary file format dependent, but it
12996 usually takes the form of a section containing ASCII text.  This
12997 switch is related to the @option{-fverbose-asm} switch, but that
12998 switch only records information in the assembler output file as
12999 comments, so it never reaches the object file.
13000 See also @option{-grecord-gcc-switches} for another
13001 way of storing compiler options into the object file.
13003 @item -fpic
13004 @opindex fpic
13005 @cindex global offset table
13006 @cindex PIC
13007 Generate position-independent code (PIC) suitable for use in a shared
13008 library, if supported for the target machine.  Such code accesses all
13009 constant addresses through a global offset table (GOT)@.  The dynamic
13010 loader resolves the GOT entries when the program starts (the dynamic
13011 loader is not part of GCC; it is part of the operating system).  If
13012 the GOT size for the linked executable exceeds a machine-specific
13013 maximum size, you get an error message from the linker indicating that
13014 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13015 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13016 on the m68k and RS/6000.  The x86 has no such limit.)
13018 Position-independent code requires special support, and therefore works
13019 only on certain machines.  For the x86, GCC supports PIC for System V
13020 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13021 position-independent.
13023 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13024 are defined to 1.
13026 @item -fPIC
13027 @opindex fPIC
13028 If supported for the target machine, emit position-independent code,
13029 suitable for dynamic linking and avoiding any limit on the size of the
13030 global offset table.  This option makes a difference on AArch64, m68k,
13031 PowerPC and SPARC@.
13033 Position-independent code requires special support, and therefore works
13034 only on certain machines.
13036 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13037 are defined to 2.
13039 @item -fpie
13040 @itemx -fPIE
13041 @opindex fpie
13042 @opindex fPIE
13043 These options are similar to @option{-fpic} and @option{-fPIC}, but
13044 generated position independent code can be only linked into executables.
13045 Usually these options are used when @option{-pie} GCC option is
13046 used during linking.
13048 @option{-fpie} and @option{-fPIE} both define the macros
13049 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13050 for @option{-fpie} and 2 for @option{-fPIE}.
13052 @item -fno-plt
13053 @opindex fno-plt
13054 Do not use the PLT for external function calls in position-independent code.
13055 Instead, load the callee address at call sites from the GOT and branch to it.
13056 This leads to more efficient code by eliminating PLT stubs and exposing
13057 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13058 PLT stubs expect the GOT pointer in a specific register, this gives more
13059 register allocation freedom to the compiler.
13060 Lazy binding requires use of the PLT; 
13061 with @option{-fno-plt} all external symbols are resolved at load time.
13063 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13064 through the PLT for specific external functions.
13066 In position-dependent code, a few targets also convert calls to
13067 functions that are marked to not use the PLT to use the GOT instead.
13069 @item -fno-jump-tables
13070 @opindex fno-jump-tables
13071 Do not use jump tables for switch statements even where it would be
13072 more efficient than other code generation strategies.  This option is
13073 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13074 building code that forms part of a dynamic linker and cannot
13075 reference the address of a jump table.  On some targets, jump tables
13076 do not require a GOT and this option is not needed.
13078 @item -ffixed-@var{reg}
13079 @opindex ffixed
13080 Treat the register named @var{reg} as a fixed register; generated code
13081 should never refer to it (except perhaps as a stack pointer, frame
13082 pointer or in some other fixed role).
13084 @var{reg} must be the name of a register.  The register names accepted
13085 are machine-specific and are defined in the @code{REGISTER_NAMES}
13086 macro in the machine description macro file.
13088 This flag does not have a negative form, because it specifies a
13089 three-way choice.
13091 @item -fcall-used-@var{reg}
13092 @opindex fcall-used
13093 Treat the register named @var{reg} as an allocable register that is
13094 clobbered by function calls.  It may be allocated for temporaries or
13095 variables that do not live across a call.  Functions compiled this way
13096 do not save and restore the register @var{reg}.
13098 It is an error to use this flag with the frame pointer or stack pointer.
13099 Use of this flag for other registers that have fixed pervasive roles in
13100 the machine's execution model produces disastrous results.
13102 This flag does not have a negative form, because it specifies a
13103 three-way choice.
13105 @item -fcall-saved-@var{reg}
13106 @opindex fcall-saved
13107 Treat the register named @var{reg} as an allocable register saved by
13108 functions.  It may be allocated even for temporaries or variables that
13109 live across a call.  Functions compiled this way save and restore
13110 the register @var{reg} if they use it.
13112 It is an error to use this flag with the frame pointer or stack pointer.
13113 Use of this flag for other registers that have fixed pervasive roles in
13114 the machine's execution model produces disastrous results.
13116 A different sort of disaster results from the use of this flag for
13117 a register in which function values may be returned.
13119 This flag does not have a negative form, because it specifies a
13120 three-way choice.
13122 @item -fpack-struct[=@var{n}]
13123 @opindex fpack-struct
13124 Without a value specified, pack all structure members together without
13125 holes.  When a value is specified (which must be a small power of two), pack
13126 structure members according to this value, representing the maximum
13127 alignment (that is, objects with default alignment requirements larger than
13128 this are output potentially unaligned at the next fitting location.
13130 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13131 code that is not binary compatible with code generated without that switch.
13132 Additionally, it makes the code suboptimal.
13133 Use it to conform to a non-default application binary interface.
13135 @item -fleading-underscore
13136 @opindex fleading-underscore
13137 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13138 change the way C symbols are represented in the object file.  One use
13139 is to help link with legacy assembly code.
13141 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13142 generate code that is not binary compatible with code generated without that
13143 switch.  Use it to conform to a non-default application binary interface.
13144 Not all targets provide complete support for this switch.
13146 @item -ftls-model=@var{model}
13147 @opindex ftls-model
13148 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13149 The @var{model} argument should be one of @samp{global-dynamic},
13150 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13151 Note that the choice is subject to optimization: the compiler may use
13152 a more efficient model for symbols not visible outside of the translation
13153 unit, or if @option{-fpic} is not given on the command line.
13155 The default without @option{-fpic} is @samp{initial-exec}; with
13156 @option{-fpic} the default is @samp{global-dynamic}.
13158 @item -ftrampolines
13159 @opindex ftrampolines
13160 For targets that normally need trampolines for nested functions, always
13161 generate them instead of using descriptors.  Otherwise, for targets that
13162 do not need them, like for example HP-PA or IA-64, do nothing.
13164 A trampoline is a small piece of code that is created at run time on the
13165 stack when the address of a nested function is taken, and is used to call
13166 the nested function indirectly.  Therefore, it requires the stack to be
13167 made executable in order for the program to work properly.
13169 @option{-fno-trampolines} is enabled by default on a language by language
13170 basis to let the compiler avoid generating them, if it computes that this
13171 is safe, and replace them with descriptors.  Descriptors are made up of data
13172 only, but the generated code must be prepared to deal with them.  As of this
13173 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13175 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13176 @option{-fno-trampolines} are not binary compatible if nested functions are
13177 present.  This option must therefore be used on a program-wide basis and be
13178 manipulated with extreme care.
13180 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13181 @opindex fvisibility
13182 Set the default ELF image symbol visibility to the specified option---all
13183 symbols are marked with this unless overridden within the code.
13184 Using this feature can very substantially improve linking and
13185 load times of shared object libraries, produce more optimized
13186 code, provide near-perfect API export and prevent symbol clashes.
13187 It is @strong{strongly} recommended that you use this in any shared objects
13188 you distribute.
13190 Despite the nomenclature, @samp{default} always means public; i.e.,
13191 available to be linked against from outside the shared object.
13192 @samp{protected} and @samp{internal} are pretty useless in real-world
13193 usage so the only other commonly used option is @samp{hidden}.
13194 The default if @option{-fvisibility} isn't specified is
13195 @samp{default}, i.e., make every symbol public.
13197 A good explanation of the benefits offered by ensuring ELF
13198 symbols have the correct visibility is given by ``How To Write
13199 Shared Libraries'' by Ulrich Drepper (which can be found at
13200 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13201 solution made possible by this option to marking things hidden when
13202 the default is public is to make the default hidden and mark things
13203 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13204 and @code{__attribute__ ((visibility("default")))} instead of
13205 @code{__declspec(dllexport)} you get almost identical semantics with
13206 identical syntax.  This is a great boon to those working with
13207 cross-platform projects.
13209 For those adding visibility support to existing code, you may find
13210 @code{#pragma GCC visibility} of use.  This works by you enclosing
13211 the declarations you wish to set visibility for with (for example)
13212 @code{#pragma GCC visibility push(hidden)} and
13213 @code{#pragma GCC visibility pop}.
13214 Bear in mind that symbol visibility should be viewed @strong{as
13215 part of the API interface contract} and thus all new code should
13216 always specify visibility when it is not the default; i.e., declarations
13217 only for use within the local DSO should @strong{always} be marked explicitly
13218 as hidden as so to avoid PLT indirection overheads---making this
13219 abundantly clear also aids readability and self-documentation of the code.
13220 Note that due to ISO C++ specification requirements, @code{operator new} and
13221 @code{operator delete} must always be of default visibility.
13223 Be aware that headers from outside your project, in particular system
13224 headers and headers from any other library you use, may not be
13225 expecting to be compiled with visibility other than the default.  You
13226 may need to explicitly say @code{#pragma GCC visibility push(default)}
13227 before including any such headers.
13229 @code{extern} declarations are not affected by @option{-fvisibility}, so
13230 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13231 no modifications.  However, this means that calls to @code{extern}
13232 functions with no explicit visibility use the PLT, so it is more
13233 effective to use @code{__attribute ((visibility))} and/or
13234 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13235 declarations should be treated as hidden.
13237 Note that @option{-fvisibility} does affect C++ vague linkage
13238 entities. This means that, for instance, an exception class that is
13239 be thrown between DSOs must be explicitly marked with default
13240 visibility so that the @samp{type_info} nodes are unified between
13241 the DSOs.
13243 An overview of these techniques, their benefits and how to use them
13244 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13246 @item -fstrict-volatile-bitfields
13247 @opindex fstrict-volatile-bitfields
13248 This option should be used if accesses to volatile bit-fields (or other
13249 structure fields, although the compiler usually honors those types
13250 anyway) should use a single access of the width of the
13251 field's type, aligned to a natural alignment if possible.  For
13252 example, targets with memory-mapped peripheral registers might require
13253 all such accesses to be 16 bits wide; with this flag you can
13254 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13255 is 16 bits on these targets) to force GCC to use 16-bit accesses
13256 instead of, perhaps, a more efficient 32-bit access.
13258 If this option is disabled, the compiler uses the most efficient
13259 instruction.  In the previous example, that might be a 32-bit load
13260 instruction, even though that accesses bytes that do not contain
13261 any portion of the bit-field, or memory-mapped registers unrelated to
13262 the one being updated.
13264 In some cases, such as when the @code{packed} attribute is applied to a 
13265 structure field, it may not be possible to access the field with a single
13266 read or write that is correctly aligned for the target machine.  In this
13267 case GCC falls back to generating multiple accesses rather than code that 
13268 will fault or truncate the result at run time.
13270 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13271 not allowed to touch non bit-field members.  It is therefore recommended
13272 to define all bits of the field's type as bit-field members.
13274 The default value of this option is determined by the application binary
13275 interface for the target processor.
13277 @item -fsync-libcalls
13278 @opindex fsync-libcalls
13279 This option controls whether any out-of-line instance of the @code{__sync}
13280 family of functions may be used to implement the C++11 @code{__atomic}
13281 family of functions.
13283 The default value of this option is enabled, thus the only useful form
13284 of the option is @option{-fno-sync-libcalls}.  This option is used in
13285 the implementation of the @file{libatomic} runtime library.
13287 @end table
13289 @node Developer Options
13290 @section GCC Developer Options
13291 @cindex developer options
13292 @cindex debugging GCC
13293 @cindex debug dump options
13294 @cindex dump options
13295 @cindex compilation statistics
13297 This section describes command-line options that are primarily of
13298 interest to GCC developers, including options to support compiler
13299 testing and investigation of compiler bugs and compile-time
13300 performance problems.  This includes options that produce debug dumps
13301 at various points in the compilation; that print statistics such as
13302 memory use and execution time; and that print information about GCC's
13303 configuration, such as where it searches for libraries.  You should
13304 rarely need to use any of these options for ordinary compilation and
13305 linking tasks.
13307 @table @gcctabopt
13309 @item -d@var{letters}
13310 @itemx -fdump-rtl-@var{pass}
13311 @itemx -fdump-rtl-@var{pass}=@var{filename}
13312 @opindex d
13313 @opindex fdump-rtl-@var{pass}
13314 Says to make debugging dumps during compilation at times specified by
13315 @var{letters}.  This is used for debugging the RTL-based passes of the
13316 compiler.  The file names for most of the dumps are made by appending
13317 a pass number and a word to the @var{dumpname}, and the files are
13318 created in the directory of the output file.  In case of
13319 @option{=@var{filename}} option, the dump is output on the given file
13320 instead of the pass numbered dump files.  Note that the pass number is
13321 assigned as passes are registered into the pass manager.  Most passes
13322 are registered in the order that they will execute and for these passes
13323 the number corresponds to the pass execution order.  However, passes
13324 registered by plugins, passes specific to compilation targets, or
13325 passes that are otherwise registered after all the other passes are
13326 numbered higher than a pass named "final", even if they are executed
13327 earlier.  @var{dumpname} is generated from the name of the output
13328 file if explicitly specified and not an executable, otherwise it is
13329 the basename of the source file.  
13331 Some @option{-d@var{letters}} switches have different meaning when
13332 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13333 for information about preprocessor-specific dump options.
13335 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13336 @option{-d} option @var{letters}.  Here are the possible
13337 letters for use in @var{pass} and @var{letters}, and their meanings:
13339 @table @gcctabopt
13341 @item -fdump-rtl-alignments
13342 @opindex fdump-rtl-alignments
13343 Dump after branch alignments have been computed.
13345 @item -fdump-rtl-asmcons
13346 @opindex fdump-rtl-asmcons
13347 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13349 @item -fdump-rtl-auto_inc_dec
13350 @opindex fdump-rtl-auto_inc_dec
13351 Dump after auto-inc-dec discovery.  This pass is only run on
13352 architectures that have auto inc or auto dec instructions.
13354 @item -fdump-rtl-barriers
13355 @opindex fdump-rtl-barriers
13356 Dump after cleaning up the barrier instructions.
13358 @item -fdump-rtl-bbpart
13359 @opindex fdump-rtl-bbpart
13360 Dump after partitioning hot and cold basic blocks.
13362 @item -fdump-rtl-bbro
13363 @opindex fdump-rtl-bbro
13364 Dump after block reordering.
13366 @item -fdump-rtl-btl1
13367 @itemx -fdump-rtl-btl2
13368 @opindex fdump-rtl-btl2
13369 @opindex fdump-rtl-btl2
13370 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13371 after the two branch
13372 target load optimization passes.
13374 @item -fdump-rtl-bypass
13375 @opindex fdump-rtl-bypass
13376 Dump after jump bypassing and control flow optimizations.
13378 @item -fdump-rtl-combine
13379 @opindex fdump-rtl-combine
13380 Dump after the RTL instruction combination pass.
13382 @item -fdump-rtl-compgotos
13383 @opindex fdump-rtl-compgotos
13384 Dump after duplicating the computed gotos.
13386 @item -fdump-rtl-ce1
13387 @itemx -fdump-rtl-ce2
13388 @itemx -fdump-rtl-ce3
13389 @opindex fdump-rtl-ce1
13390 @opindex fdump-rtl-ce2
13391 @opindex fdump-rtl-ce3
13392 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13393 @option{-fdump-rtl-ce3} enable dumping after the three
13394 if conversion passes.
13396 @item -fdump-rtl-cprop_hardreg
13397 @opindex fdump-rtl-cprop_hardreg
13398 Dump after hard register copy propagation.
13400 @item -fdump-rtl-csa
13401 @opindex fdump-rtl-csa
13402 Dump after combining stack adjustments.
13404 @item -fdump-rtl-cse1
13405 @itemx -fdump-rtl-cse2
13406 @opindex fdump-rtl-cse1
13407 @opindex fdump-rtl-cse2
13408 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13409 the two common subexpression elimination passes.
13411 @item -fdump-rtl-dce
13412 @opindex fdump-rtl-dce
13413 Dump after the standalone dead code elimination passes.
13415 @item -fdump-rtl-dbr
13416 @opindex fdump-rtl-dbr
13417 Dump after delayed branch scheduling.
13419 @item -fdump-rtl-dce1
13420 @itemx -fdump-rtl-dce2
13421 @opindex fdump-rtl-dce1
13422 @opindex fdump-rtl-dce2
13423 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13424 the two dead store elimination passes.
13426 @item -fdump-rtl-eh
13427 @opindex fdump-rtl-eh
13428 Dump after finalization of EH handling code.
13430 @item -fdump-rtl-eh_ranges
13431 @opindex fdump-rtl-eh_ranges
13432 Dump after conversion of EH handling range regions.
13434 @item -fdump-rtl-expand
13435 @opindex fdump-rtl-expand
13436 Dump after RTL generation.
13438 @item -fdump-rtl-fwprop1
13439 @itemx -fdump-rtl-fwprop2
13440 @opindex fdump-rtl-fwprop1
13441 @opindex fdump-rtl-fwprop2
13442 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13443 dumping after the two forward propagation passes.
13445 @item -fdump-rtl-gcse1
13446 @itemx -fdump-rtl-gcse2
13447 @opindex fdump-rtl-gcse1
13448 @opindex fdump-rtl-gcse2
13449 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13450 after global common subexpression elimination.
13452 @item -fdump-rtl-init-regs
13453 @opindex fdump-rtl-init-regs
13454 Dump after the initialization of the registers.
13456 @item -fdump-rtl-initvals
13457 @opindex fdump-rtl-initvals
13458 Dump after the computation of the initial value sets.
13460 @item -fdump-rtl-into_cfglayout
13461 @opindex fdump-rtl-into_cfglayout
13462 Dump after converting to cfglayout mode.
13464 @item -fdump-rtl-ira
13465 @opindex fdump-rtl-ira
13466 Dump after iterated register allocation.
13468 @item -fdump-rtl-jump
13469 @opindex fdump-rtl-jump
13470 Dump after the second jump optimization.
13472 @item -fdump-rtl-loop2
13473 @opindex fdump-rtl-loop2
13474 @option{-fdump-rtl-loop2} enables dumping after the rtl
13475 loop optimization passes.
13477 @item -fdump-rtl-mach
13478 @opindex fdump-rtl-mach
13479 Dump after performing the machine dependent reorganization pass, if that
13480 pass exists.
13482 @item -fdump-rtl-mode_sw
13483 @opindex fdump-rtl-mode_sw
13484 Dump after removing redundant mode switches.
13486 @item -fdump-rtl-rnreg
13487 @opindex fdump-rtl-rnreg
13488 Dump after register renumbering.
13490 @item -fdump-rtl-outof_cfglayout
13491 @opindex fdump-rtl-outof_cfglayout
13492 Dump after converting from cfglayout mode.
13494 @item -fdump-rtl-peephole2
13495 @opindex fdump-rtl-peephole2
13496 Dump after the peephole pass.
13498 @item -fdump-rtl-postreload
13499 @opindex fdump-rtl-postreload
13500 Dump after post-reload optimizations.
13502 @item -fdump-rtl-pro_and_epilogue
13503 @opindex fdump-rtl-pro_and_epilogue
13504 Dump after generating the function prologues and epilogues.
13506 @item -fdump-rtl-sched1
13507 @itemx -fdump-rtl-sched2
13508 @opindex fdump-rtl-sched1
13509 @opindex fdump-rtl-sched2
13510 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13511 after the basic block scheduling passes.
13513 @item -fdump-rtl-ree
13514 @opindex fdump-rtl-ree
13515 Dump after sign/zero extension elimination.
13517 @item -fdump-rtl-seqabstr
13518 @opindex fdump-rtl-seqabstr
13519 Dump after common sequence discovery.
13521 @item -fdump-rtl-shorten
13522 @opindex fdump-rtl-shorten
13523 Dump after shortening branches.
13525 @item -fdump-rtl-sibling
13526 @opindex fdump-rtl-sibling
13527 Dump after sibling call optimizations.
13529 @item -fdump-rtl-split1
13530 @itemx -fdump-rtl-split2
13531 @itemx -fdump-rtl-split3
13532 @itemx -fdump-rtl-split4
13533 @itemx -fdump-rtl-split5
13534 @opindex fdump-rtl-split1
13535 @opindex fdump-rtl-split2
13536 @opindex fdump-rtl-split3
13537 @opindex fdump-rtl-split4
13538 @opindex fdump-rtl-split5
13539 These options enable dumping after five rounds of
13540 instruction splitting.
13542 @item -fdump-rtl-sms
13543 @opindex fdump-rtl-sms
13544 Dump after modulo scheduling.  This pass is only run on some
13545 architectures.
13547 @item -fdump-rtl-stack
13548 @opindex fdump-rtl-stack
13549 Dump after conversion from GCC's ``flat register file'' registers to the
13550 x87's stack-like registers.  This pass is only run on x86 variants.
13552 @item -fdump-rtl-subreg1
13553 @itemx -fdump-rtl-subreg2
13554 @opindex fdump-rtl-subreg1
13555 @opindex fdump-rtl-subreg2
13556 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13557 the two subreg expansion passes.
13559 @item -fdump-rtl-unshare
13560 @opindex fdump-rtl-unshare
13561 Dump after all rtl has been unshared.
13563 @item -fdump-rtl-vartrack
13564 @opindex fdump-rtl-vartrack
13565 Dump after variable tracking.
13567 @item -fdump-rtl-vregs
13568 @opindex fdump-rtl-vregs
13569 Dump after converting virtual registers to hard registers.
13571 @item -fdump-rtl-web
13572 @opindex fdump-rtl-web
13573 Dump after live range splitting.
13575 @item -fdump-rtl-regclass
13576 @itemx -fdump-rtl-subregs_of_mode_init
13577 @itemx -fdump-rtl-subregs_of_mode_finish
13578 @itemx -fdump-rtl-dfinit
13579 @itemx -fdump-rtl-dfinish
13580 @opindex fdump-rtl-regclass
13581 @opindex fdump-rtl-subregs_of_mode_init
13582 @opindex fdump-rtl-subregs_of_mode_finish
13583 @opindex fdump-rtl-dfinit
13584 @opindex fdump-rtl-dfinish
13585 These dumps are defined but always produce empty files.
13587 @item -da
13588 @itemx -fdump-rtl-all
13589 @opindex da
13590 @opindex fdump-rtl-all
13591 Produce all the dumps listed above.
13593 @item -dA
13594 @opindex dA
13595 Annotate the assembler output with miscellaneous debugging information.
13597 @item -dD
13598 @opindex dD
13599 Dump all macro definitions, at the end of preprocessing, in addition to
13600 normal output.
13602 @item -dH
13603 @opindex dH
13604 Produce a core dump whenever an error occurs.
13606 @item -dp
13607 @opindex dp
13608 Annotate the assembler output with a comment indicating which
13609 pattern and alternative is used.  The length and cost of each instruction are
13610 also printed.
13612 @item -dP
13613 @opindex dP
13614 Dump the RTL in the assembler output as a comment before each instruction.
13615 Also turns on @option{-dp} annotation.
13617 @item -dx
13618 @opindex dx
13619 Just generate RTL for a function instead of compiling it.  Usually used
13620 with @option{-fdump-rtl-expand}.
13621 @end table
13623 @item -fdump-noaddr
13624 @opindex fdump-noaddr
13625 When doing debugging dumps, suppress address output.  This makes it more
13626 feasible to use diff on debugging dumps for compiler invocations with
13627 different compiler binaries and/or different
13628 text / bss / data / heap / stack / dso start locations.
13630 @item -freport-bug
13631 @opindex freport-bug
13632 Collect and dump debug information into a temporary file if an
13633 internal compiler error (ICE) occurs.
13635 @item -fdump-unnumbered
13636 @opindex fdump-unnumbered
13637 When doing debugging dumps, suppress instruction numbers and address output.
13638 This makes it more feasible to use diff on debugging dumps for compiler
13639 invocations with different options, in particular with and without
13640 @option{-g}.
13642 @item -fdump-unnumbered-links
13643 @opindex fdump-unnumbered-links
13644 When doing debugging dumps (see @option{-d} option above), suppress
13645 instruction numbers for the links to the previous and next instructions
13646 in a sequence.
13648 @item -fdump-ipa-@var{switch}
13649 @opindex fdump-ipa
13650 Control the dumping at various stages of inter-procedural analysis
13651 language tree to a file.  The file name is generated by appending a
13652 switch specific suffix to the source file name, and the file is created
13653 in the same directory as the output file.  The following dumps are
13654 possible:
13656 @table @samp
13657 @item all
13658 Enables all inter-procedural analysis dumps.
13660 @item cgraph
13661 Dumps information about call-graph optimization, unused function removal,
13662 and inlining decisions.
13664 @item inline
13665 Dump after function inlining.
13667 @end table
13669 @item -fdump-lang-all
13670 @itemx -fdump-lang-@var{switch}
13671 @itemx -fdump-lang-@var{switch}-@var{options}
13672 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13673 @opindex fdump-lang-all
13674 @opindex fdump-lang
13675 Control the dumping of language-specific information.  The @var{options}
13676 and @var{filename} portions behave as described in the
13677 @option{-fdump-tree} option.  The following @var{switch} values are
13678 accepted:
13680 @table @samp
13681 @item all
13683 Enable all language-specific dumps.
13685 @item class
13686 Dump class hierarchy information.  Virtual table information is emitted
13687 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13689 @item raw
13690 Dump the raw internal tree data.  This option is applicable to C++ only.
13692 @end table
13694 @item -fdump-passes
13695 @opindex fdump-passes
13696 Print on @file{stderr} the list of optimization passes that are turned
13697 on and off by the current command-line options.
13699 @item -fdump-statistics-@var{option}
13700 @opindex fdump-statistics
13701 Enable and control dumping of pass statistics in a separate file.  The
13702 file name is generated by appending a suffix ending in
13703 @samp{.statistics} to the source file name, and the file is created in
13704 the same directory as the output file.  If the @samp{-@var{option}}
13705 form is used, @samp{-stats} causes counters to be summed over the
13706 whole compilation unit while @samp{-details} dumps every event as
13707 the passes generate them.  The default with no option is to sum
13708 counters for each function compiled.
13710 @item -fdump-tree-all
13711 @itemx -fdump-tree-@var{switch}
13712 @itemx -fdump-tree-@var{switch}-@var{options}
13713 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13714 @opindex fdump-tree-all
13715 @opindex fdump-tree
13716 Control the dumping at various stages of processing the intermediate
13717 language tree to a file.  The file name is generated by appending a
13718 switch-specific suffix to the source file name, and the file is
13719 created in the same directory as the output file. In case of
13720 @option{=@var{filename}} option, the dump is output on the given file
13721 instead of the auto named dump files.  If the @samp{-@var{options}}
13722 form is used, @var{options} is a list of @samp{-} separated options
13723 which control the details of the dump.  Not all options are applicable
13724 to all dumps; those that are not meaningful are ignored.  The
13725 following options are available
13727 @table @samp
13728 @item address
13729 Print the address of each node.  Usually this is not meaningful as it
13730 changes according to the environment and source file.  Its primary use
13731 is for tying up a dump file with a debug environment.
13732 @item asmname
13733 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13734 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13735 use working backward from mangled names in the assembly file.
13736 @item slim
13737 When dumping front-end intermediate representations, inhibit dumping
13738 of members of a scope or body of a function merely because that scope
13739 has been reached.  Only dump such items when they are directly reachable
13740 by some other path.
13742 When dumping pretty-printed trees, this option inhibits dumping the
13743 bodies of control structures.
13745 When dumping RTL, print the RTL in slim (condensed) form instead of
13746 the default LISP-like representation.
13747 @item raw
13748 Print a raw representation of the tree.  By default, trees are
13749 pretty-printed into a C-like representation.
13750 @item details
13751 Enable more detailed dumps (not honored by every dump option). Also
13752 include information from the optimization passes.
13753 @item stats
13754 Enable dumping various statistics about the pass (not honored by every dump
13755 option).
13756 @item blocks
13757 Enable showing basic block boundaries (disabled in raw dumps).
13758 @item graph
13759 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13760 dump a representation of the control flow graph suitable for viewing with
13761 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13762 the file is pretty-printed as a subgraph, so that GraphViz can render them
13763 all in a single plot.
13765 This option currently only works for RTL dumps, and the RTL is always
13766 dumped in slim form.
13767 @item vops
13768 Enable showing virtual operands for every statement.
13769 @item lineno
13770 Enable showing line numbers for statements.
13771 @item uid
13772 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13773 @item verbose
13774 Enable showing the tree dump for each statement.
13775 @item eh
13776 Enable showing the EH region number holding each statement.
13777 @item scev
13778 Enable showing scalar evolution analysis details.
13779 @item optimized
13780 Enable showing optimization information (only available in certain
13781 passes).
13782 @item missed
13783 Enable showing missed optimization information (only available in certain
13784 passes).
13785 @item note
13786 Enable other detailed optimization information (only available in
13787 certain passes).
13788 @item =@var{filename}
13789 Instead of an auto named dump file, output into the given file
13790 name. The file names @file{stdout} and @file{stderr} are treated
13791 specially and are considered already open standard streams. For
13792 example,
13794 @smallexample
13795 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13796      -fdump-tree-pre=/dev/stderr file.c
13797 @end smallexample
13799 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13800 output on to @file{stderr}. If two conflicting dump filenames are
13801 given for the same pass, then the latter option overrides the earlier
13802 one.
13804 @item all
13805 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13806 and @option{lineno}.
13808 @item optall
13809 Turn on all optimization options, i.e., @option{optimized},
13810 @option{missed}, and @option{note}.
13811 @end table
13813 To determine what tree dumps are available or find the dump for a pass
13814 of interest follow the steps below.
13816 @enumerate
13817 @item
13818 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13819 look for a code that corresponds to the pass you are interested in.
13820 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13821 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13822 The number at the end distinguishes distinct invocations of the same pass.
13823 @item
13824 To enable the creation of the dump file, append the pass code to
13825 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13826 to enable the dump from the Early Value Range Propagation pass, invoke
13827 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13828 specify the name of the dump file.  If you don't specify one, GCC
13829 creates as described below.
13830 @item
13831 Find the pass dump in a file whose name is composed of three components
13832 separated by a period: the name of the source file GCC was invoked to
13833 compile, a numeric suffix indicating the pass number followed by the
13834 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13835 and finally the pass code.  For example, the Early VRP pass dump might
13836 be in a file named @file{myfile.c.038t.evrp} in the current working
13837 directory.  Note that the numeric codes are not stable and may change
13838 from one version of GCC to another.
13839 @end enumerate
13841 @item -fopt-info
13842 @itemx -fopt-info-@var{options}
13843 @itemx -fopt-info-@var{options}=@var{filename}
13844 @opindex fopt-info
13845 Controls optimization dumps from various optimization passes. If the
13846 @samp{-@var{options}} form is used, @var{options} is a list of
13847 @samp{-} separated option keywords to select the dump details and
13848 optimizations.  
13850 The @var{options} can be divided into two groups: options describing the
13851 verbosity of the dump, and options describing which optimizations
13852 should be included. The options from both the groups can be freely
13853 mixed as they are non-overlapping. However, in case of any conflicts,
13854 the later options override the earlier options on the command
13855 line. 
13857 The following options control the dump verbosity:
13859 @table @samp
13860 @item optimized
13861 Print information when an optimization is successfully applied. It is
13862 up to a pass to decide which information is relevant. For example, the
13863 vectorizer passes print the source location of loops which are
13864 successfully vectorized.
13865 @item missed
13866 Print information about missed optimizations. Individual passes
13867 control which information to include in the output. 
13868 @item note
13869 Print verbose information about optimizations, such as certain
13870 transformations, more detailed messages about decisions etc.
13871 @item all
13872 Print detailed optimization information. This includes
13873 @samp{optimized}, @samp{missed}, and @samp{note}.
13874 @end table
13876 One or more of the following option keywords can be used to describe a
13877 group of optimizations:
13879 @table @samp
13880 @item ipa
13881 Enable dumps from all interprocedural optimizations.
13882 @item loop
13883 Enable dumps from all loop optimizations.
13884 @item inline
13885 Enable dumps from all inlining optimizations.
13886 @item omp
13887 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13888 @item vec
13889 Enable dumps from all vectorization optimizations.
13890 @item optall
13891 Enable dumps from all optimizations. This is a superset of
13892 the optimization groups listed above.
13893 @end table
13895 If @var{options} is
13896 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13897 info about successful optimizations from all the passes.  
13899 If the @var{filename} is provided, then the dumps from all the
13900 applicable optimizations are concatenated into the @var{filename}.
13901 Otherwise the dump is output onto @file{stderr}. Though multiple
13902 @option{-fopt-info} options are accepted, only one of them can include
13903 a @var{filename}. If other filenames are provided then all but the
13904 first such option are ignored.
13906 Note that the output @var{filename} is overwritten
13907 in case of multiple translation units. If a combined output from
13908 multiple translation units is desired, @file{stderr} should be used
13909 instead.
13911 In the following example, the optimization info is output to
13912 @file{stderr}:
13914 @smallexample
13915 gcc -O3 -fopt-info
13916 @end smallexample
13918 This example:
13919 @smallexample
13920 gcc -O3 -fopt-info-missed=missed.all
13921 @end smallexample
13923 @noindent
13924 outputs missed optimization report from all the passes into
13925 @file{missed.all}, and this one:
13927 @smallexample
13928 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13929 @end smallexample
13931 @noindent
13932 prints information about missed optimization opportunities from
13933 vectorization passes on @file{stderr}.  
13934 Note that @option{-fopt-info-vec-missed} is equivalent to 
13935 @option{-fopt-info-missed-vec}.  The order of the optimization group
13936 names and message types listed after @option{-fopt-info} does not matter.
13938 As another example,
13939 @smallexample
13940 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13941 @end smallexample
13943 @noindent
13944 outputs information about missed optimizations as well as
13945 optimized locations from all the inlining passes into
13946 @file{inline.txt}.
13948 Finally, consider:
13950 @smallexample
13951 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13952 @end smallexample
13954 @noindent
13955 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13956 in conflict since only one output file is allowed. In this case, only
13957 the first option takes effect and the subsequent options are
13958 ignored. Thus only @file{vec.miss} is produced which contains
13959 dumps from the vectorizer about missed opportunities.
13961 @item -fsched-verbose=@var{n}
13962 @opindex fsched-verbose
13963 On targets that use instruction scheduling, this option controls the
13964 amount of debugging output the scheduler prints to the dump files.
13966 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13967 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13968 For @var{n} greater than one, it also output basic block probabilities,
13969 detailed ready list information and unit/insn info.  For @var{n} greater
13970 than two, it includes RTL at abort point, control-flow and regions info.
13971 And for @var{n} over four, @option{-fsched-verbose} also includes
13972 dependence info.
13976 @item -fenable-@var{kind}-@var{pass}
13977 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13978 @opindex fdisable-
13979 @opindex fenable-
13981 This is a set of options that are used to explicitly disable/enable
13982 optimization passes.  These options are intended for use for debugging GCC.
13983 Compiler users should use regular options for enabling/disabling
13984 passes instead.
13986 @table @gcctabopt
13988 @item -fdisable-ipa-@var{pass}
13989 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13990 statically invoked in the compiler multiple times, the pass name should be
13991 appended with a sequential number starting from 1.
13993 @item -fdisable-rtl-@var{pass}
13994 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13995 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13996 statically invoked in the compiler multiple times, the pass name should be
13997 appended with a sequential number starting from 1.  @var{range-list} is a 
13998 comma-separated list of function ranges or assembler names.  Each range is a number
13999 pair separated by a colon.  The range is inclusive in both ends.  If the range
14000 is trivial, the number pair can be simplified as a single number.  If the
14001 function's call graph node's @var{uid} falls within one of the specified ranges,
14002 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14003 function header of a dump file, and the pass names can be dumped by using
14004 option @option{-fdump-passes}.
14006 @item -fdisable-tree-@var{pass}
14007 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14008 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14009 option arguments.
14011 @item -fenable-ipa-@var{pass}
14012 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14013 statically invoked in the compiler multiple times, the pass name should be
14014 appended with a sequential number starting from 1.
14016 @item -fenable-rtl-@var{pass}
14017 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14018 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14019 description and examples.
14021 @item -fenable-tree-@var{pass}
14022 @itemx -fenable-tree-@var{pass}=@var{range-list}
14023 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14024 of option arguments.
14026 @end table
14028 Here are some examples showing uses of these options.
14030 @smallexample
14032 # disable ccp1 for all functions
14033    -fdisable-tree-ccp1
14034 # disable complete unroll for function whose cgraph node uid is 1
14035    -fenable-tree-cunroll=1
14036 # disable gcse2 for functions at the following ranges [1,1],
14037 # [300,400], and [400,1000]
14038 # disable gcse2 for functions foo and foo2
14039    -fdisable-rtl-gcse2=foo,foo2
14040 # disable early inlining
14041    -fdisable-tree-einline
14042 # disable ipa inlining
14043    -fdisable-ipa-inline
14044 # enable tree full unroll
14045    -fenable-tree-unroll
14047 @end smallexample
14049 @item -fchecking
14050 @itemx -fchecking=@var{n}
14051 @opindex fchecking
14052 @opindex fno-checking
14053 Enable internal consistency checking.  The default depends on
14054 the compiler configuration.  @option{-fchecking=2} enables further
14055 internal consistency checking that might affect code generation.
14057 @item -frandom-seed=@var{string}
14058 @opindex frandom-seed
14059 This option provides a seed that GCC uses in place of
14060 random numbers in generating certain symbol names
14061 that have to be different in every compiled file.  It is also used to
14062 place unique stamps in coverage data files and the object files that
14063 produce them.  You can use the @option{-frandom-seed} option to produce
14064 reproducibly identical object files.
14066 The @var{string} can either be a number (decimal, octal or hex) or an
14067 arbitrary string (in which case it's converted to a number by
14068 computing CRC32).
14070 The @var{string} should be different for every file you compile.
14072 @item -save-temps
14073 @itemx -save-temps=cwd
14074 @opindex save-temps
14075 Store the usual ``temporary'' intermediate files permanently; place them
14076 in the current directory and name them based on the source file.  Thus,
14077 compiling @file{foo.c} with @option{-c -save-temps} produces files
14078 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14079 preprocessed @file{foo.i} output file even though the compiler now
14080 normally uses an integrated preprocessor.
14082 When used in combination with the @option{-x} command-line option,
14083 @option{-save-temps} is sensible enough to avoid over writing an
14084 input source file with the same extension as an intermediate file.
14085 The corresponding intermediate file may be obtained by renaming the
14086 source file before using @option{-save-temps}.
14088 If you invoke GCC in parallel, compiling several different source
14089 files that share a common base name in different subdirectories or the
14090 same source file compiled for multiple output destinations, it is
14091 likely that the different parallel compilers will interfere with each
14092 other, and overwrite the temporary files.  For instance:
14094 @smallexample
14095 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14096 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14097 @end smallexample
14099 may result in @file{foo.i} and @file{foo.o} being written to
14100 simultaneously by both compilers.
14102 @item -save-temps=obj
14103 @opindex save-temps=obj
14104 Store the usual ``temporary'' intermediate files permanently.  If the
14105 @option{-o} option is used, the temporary files are based on the
14106 object file.  If the @option{-o} option is not used, the
14107 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14109 For example:
14111 @smallexample
14112 gcc -save-temps=obj -c foo.c
14113 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14114 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14115 @end smallexample
14117 @noindent
14118 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14119 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14120 @file{dir2/yfoobar.o}.
14122 @item -time@r{[}=@var{file}@r{]}
14123 @opindex time
14124 Report the CPU time taken by each subprocess in the compilation
14125 sequence.  For C source files, this is the compiler proper and assembler
14126 (plus the linker if linking is done).
14128 Without the specification of an output file, the output looks like this:
14130 @smallexample
14131 # cc1 0.12 0.01
14132 # as 0.00 0.01
14133 @end smallexample
14135 The first number on each line is the ``user time'', that is time spent
14136 executing the program itself.  The second number is ``system time'',
14137 time spent executing operating system routines on behalf of the program.
14138 Both numbers are in seconds.
14140 With the specification of an output file, the output is appended to the
14141 named file, and it looks like this:
14143 @smallexample
14144 0.12 0.01 cc1 @var{options}
14145 0.00 0.01 as @var{options}
14146 @end smallexample
14148 The ``user time'' and the ``system time'' are moved before the program
14149 name, and the options passed to the program are displayed, so that one
14150 can later tell what file was being compiled, and with which options.
14152 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14153 @opindex fdump-final-insns
14154 Dump the final internal representation (RTL) to @var{file}.  If the
14155 optional argument is omitted (or if @var{file} is @code{.}), the name
14156 of the dump file is determined by appending @code{.gkd} to the
14157 compilation output file name.
14159 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14160 @opindex fcompare-debug
14161 @opindex fno-compare-debug
14162 If no error occurs during compilation, run the compiler a second time,
14163 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14164 passed to the second compilation.  Dump the final internal
14165 representation in both compilations, and print an error if they differ.
14167 If the equal sign is omitted, the default @option{-gtoggle} is used.
14169 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14170 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14171 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14172 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14173 is used.
14175 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14176 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14177 of the final representation and the second compilation, preventing even
14178 @env{GCC_COMPARE_DEBUG} from taking effect.
14180 To verify full coverage during @option{-fcompare-debug} testing, set
14181 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14182 which GCC rejects as an invalid option in any actual compilation
14183 (rather than preprocessing, assembly or linking).  To get just a
14184 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14185 not overridden} will do.
14187 @item -fcompare-debug-second
14188 @opindex fcompare-debug-second
14189 This option is implicitly passed to the compiler for the second
14190 compilation requested by @option{-fcompare-debug}, along with options to
14191 silence warnings, and omitting other options that would cause
14192 side-effect compiler outputs to files or to the standard output.  Dump
14193 files and preserved temporary files are renamed so as to contain the
14194 @code{.gk} additional extension during the second compilation, to avoid
14195 overwriting those generated by the first.
14197 When this option is passed to the compiler driver, it causes the
14198 @emph{first} compilation to be skipped, which makes it useful for little
14199 other than debugging the compiler proper.
14201 @item -gtoggle
14202 @opindex gtoggle
14203 Turn off generation of debug info, if leaving out this option
14204 generates it, or turn it on at level 2 otherwise.  The position of this
14205 argument in the command line does not matter; it takes effect after all
14206 other options are processed, and it does so only once, no matter how
14207 many times it is given.  This is mainly intended to be used with
14208 @option{-fcompare-debug}.
14210 @item -fvar-tracking-assignments-toggle
14211 @opindex fvar-tracking-assignments-toggle
14212 @opindex fno-var-tracking-assignments-toggle
14213 Toggle @option{-fvar-tracking-assignments}, in the same way that
14214 @option{-gtoggle} toggles @option{-g}.
14216 @item -Q
14217 @opindex Q
14218 Makes the compiler print out each function name as it is compiled, and
14219 print some statistics about each pass when it finishes.
14221 @item -ftime-report
14222 @opindex ftime-report
14223 Makes the compiler print some statistics about the time consumed by each
14224 pass when it finishes.
14226 @item -ftime-report-details
14227 @opindex ftime-report-details
14228 Record the time consumed by infrastructure parts separately for each pass.
14230 @item -fira-verbose=@var{n}
14231 @opindex fira-verbose
14232 Control the verbosity of the dump file for the integrated register allocator.
14233 The default value is 5.  If the value @var{n} is greater or equal to 10,
14234 the dump output is sent to stderr using the same format as @var{n} minus 10.
14236 @item -flto-report
14237 @opindex flto-report
14238 Prints a report with internal details on the workings of the link-time
14239 optimizer.  The contents of this report vary from version to version.
14240 It is meant to be useful to GCC developers when processing object
14241 files in LTO mode (via @option{-flto}).
14243 Disabled by default.
14245 @item -flto-report-wpa
14246 @opindex flto-report-wpa
14247 Like @option{-flto-report}, but only print for the WPA phase of Link
14248 Time Optimization.
14250 @item -fmem-report
14251 @opindex fmem-report
14252 Makes the compiler print some statistics about permanent memory
14253 allocation when it finishes.
14255 @item -fmem-report-wpa
14256 @opindex fmem-report-wpa
14257 Makes the compiler print some statistics about permanent memory
14258 allocation for the WPA phase only.
14260 @item -fpre-ipa-mem-report
14261 @opindex fpre-ipa-mem-report
14262 @item -fpost-ipa-mem-report
14263 @opindex fpost-ipa-mem-report
14264 Makes the compiler print some statistics about permanent memory
14265 allocation before or after interprocedural optimization.
14267 @item -fprofile-report
14268 @opindex fprofile-report
14269 Makes the compiler print some statistics about consistency of the
14270 (estimated) profile and effect of individual passes.
14272 @item -fstack-usage
14273 @opindex fstack-usage
14274 Makes the compiler output stack usage information for the program, on a
14275 per-function basis.  The filename for the dump is made by appending
14276 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14277 the output file, if explicitly specified and it is not an executable,
14278 otherwise it is the basename of the source file.  An entry is made up
14279 of three fields:
14281 @itemize
14282 @item
14283 The name of the function.
14284 @item
14285 A number of bytes.
14286 @item
14287 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14288 @end itemize
14290 The qualifier @code{static} means that the function manipulates the stack
14291 statically: a fixed number of bytes are allocated for the frame on function
14292 entry and released on function exit; no stack adjustments are otherwise made
14293 in the function.  The second field is this fixed number of bytes.
14295 The qualifier @code{dynamic} means that the function manipulates the stack
14296 dynamically: in addition to the static allocation described above, stack
14297 adjustments are made in the body of the function, for example to push/pop
14298 arguments around function calls.  If the qualifier @code{bounded} is also
14299 present, the amount of these adjustments is bounded at compile time and
14300 the second field is an upper bound of the total amount of stack used by
14301 the function.  If it is not present, the amount of these adjustments is
14302 not bounded at compile time and the second field only represents the
14303 bounded part.
14305 @item -fstats
14306 @opindex fstats
14307 Emit statistics about front-end processing at the end of the compilation.
14308 This option is supported only by the C++ front end, and
14309 the information is generally only useful to the G++ development team.
14311 @item -fdbg-cnt-list
14312 @opindex fdbg-cnt-list
14313 Print the name and the counter upper bound for all debug counters.
14316 @item -fdbg-cnt=@var{counter-value-list}
14317 @opindex fdbg-cnt
14318 Set the internal debug counter upper bound.  @var{counter-value-list}
14319 is a comma-separated list of @var{name}:@var{value} pairs
14320 which sets the upper bound of each debug counter @var{name} to @var{value}.
14321 All debug counters have the initial upper bound of @code{UINT_MAX};
14322 thus @code{dbg_cnt} returns true always unless the upper bound
14323 is set by this option.
14324 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14325 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14327 @item -print-file-name=@var{library}
14328 @opindex print-file-name
14329 Print the full absolute name of the library file @var{library} that
14330 would be used when linking---and don't do anything else.  With this
14331 option, GCC does not compile or link anything; it just prints the
14332 file name.
14334 @item -print-multi-directory
14335 @opindex print-multi-directory
14336 Print the directory name corresponding to the multilib selected by any
14337 other switches present in the command line.  This directory is supposed
14338 to exist in @env{GCC_EXEC_PREFIX}.
14340 @item -print-multi-lib
14341 @opindex print-multi-lib
14342 Print the mapping from multilib directory names to compiler switches
14343 that enable them.  The directory name is separated from the switches by
14344 @samp{;}, and each switch starts with an @samp{@@} instead of the
14345 @samp{-}, without spaces between multiple switches.  This is supposed to
14346 ease shell processing.
14348 @item -print-multi-os-directory
14349 @opindex print-multi-os-directory
14350 Print the path to OS libraries for the selected
14351 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14352 present in the @file{lib} subdirectory and no multilibs are used, this is
14353 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14354 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14355 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14356 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14358 @item -print-multiarch
14359 @opindex print-multiarch
14360 Print the path to OS libraries for the selected multiarch,
14361 relative to some @file{lib} subdirectory.
14363 @item -print-prog-name=@var{program}
14364 @opindex print-prog-name
14365 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14367 @item -print-libgcc-file-name
14368 @opindex print-libgcc-file-name
14369 Same as @option{-print-file-name=libgcc.a}.
14371 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14372 but you do want to link with @file{libgcc.a}.  You can do:
14374 @smallexample
14375 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14376 @end smallexample
14378 @item -print-search-dirs
14379 @opindex print-search-dirs
14380 Print the name of the configured installation directory and a list of
14381 program and library directories @command{gcc} searches---and don't do anything else.
14383 This is useful when @command{gcc} prints the error message
14384 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14385 To resolve this you either need to put @file{cpp0} and the other compiler
14386 components where @command{gcc} expects to find them, or you can set the environment
14387 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14388 Don't forget the trailing @samp{/}.
14389 @xref{Environment Variables}.
14391 @item -print-sysroot
14392 @opindex print-sysroot
14393 Print the target sysroot directory that is used during
14394 compilation.  This is the target sysroot specified either at configure
14395 time or using the @option{--sysroot} option, possibly with an extra
14396 suffix that depends on compilation options.  If no target sysroot is
14397 specified, the option prints nothing.
14399 @item -print-sysroot-headers-suffix
14400 @opindex print-sysroot-headers-suffix
14401 Print the suffix added to the target sysroot when searching for
14402 headers, or give an error if the compiler is not configured with such
14403 a suffix---and don't do anything else.
14405 @item -dumpmachine
14406 @opindex dumpmachine
14407 Print the compiler's target machine (for example,
14408 @samp{i686-pc-linux-gnu})---and don't do anything else.
14410 @item -dumpversion
14411 @opindex dumpversion
14412 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14413 anything else.  This is the compiler version used in filesystem paths,
14414 specs, can be depending on how the compiler has been configured just
14415 a single number (major version), two numbers separated by dot (major and
14416 minor version) or three numbers separated by dots (major, minor and patchlevel
14417 version).
14419 @item -dumpfullversion
14420 @opindex dumpfullversion
14421 Print the full compiler version, always 3 numbers separated by dots,
14422 major, minor and patchlevel version.
14424 @item -dumpspecs
14425 @opindex dumpspecs
14426 Print the compiler's built-in specs---and don't do anything else.  (This
14427 is used when GCC itself is being built.)  @xref{Spec Files}.
14428 @end table
14430 @node Submodel Options
14431 @section Machine-Dependent Options
14432 @cindex submodel options
14433 @cindex specifying hardware config
14434 @cindex hardware models and configurations, specifying
14435 @cindex target-dependent options
14436 @cindex machine-dependent options
14438 Each target machine supported by GCC can have its own options---for
14439 example, to allow you to compile for a particular processor variant or
14440 ABI, or to control optimizations specific to that machine.  By
14441 convention, the names of machine-specific options start with
14442 @samp{-m}.
14444 Some configurations of the compiler also support additional target-specific
14445 options, usually for compatibility with other compilers on the same
14446 platform.
14448 @c This list is ordered alphanumerically by subsection name.
14449 @c It should be the same order and spelling as these options are listed
14450 @c in Machine Dependent Options
14452 @menu
14453 * AArch64 Options::
14454 * Adapteva Epiphany Options::
14455 * ARC Options::
14456 * ARM Options::
14457 * AVR Options::
14458 * Blackfin Options::
14459 * C6X Options::
14460 * CRIS Options::
14461 * CR16 Options::
14462 * Darwin Options::
14463 * DEC Alpha Options::
14464 * FR30 Options::
14465 * FT32 Options::
14466 * FRV Options::
14467 * GNU/Linux Options::
14468 * H8/300 Options::
14469 * HPPA Options::
14470 * IA-64 Options::
14471 * LM32 Options::
14472 * M32C Options::
14473 * M32R/D Options::
14474 * M680x0 Options::
14475 * MCore Options::
14476 * MeP Options::
14477 * MicroBlaze Options::
14478 * MIPS Options::
14479 * MMIX Options::
14480 * MN10300 Options::
14481 * Moxie Options::
14482 * MSP430 Options::
14483 * NDS32 Options::
14484 * Nios II Options::
14485 * Nvidia PTX Options::
14486 * PDP-11 Options::
14487 * picoChip Options::
14488 * PowerPC Options::
14489 * PowerPC SPE Options::
14490 * RISC-V Options::
14491 * RL78 Options::
14492 * RS/6000 and PowerPC Options::
14493 * RX Options::
14494 * S/390 and zSeries Options::
14495 * Score Options::
14496 * SH Options::
14497 * Solaris 2 Options::
14498 * SPARC Options::
14499 * SPU Options::
14500 * System V Options::
14501 * TILE-Gx Options::
14502 * TILEPro Options::
14503 * V850 Options::
14504 * VAX Options::
14505 * Visium Options::
14506 * VMS Options::
14507 * VxWorks Options::
14508 * x86 Options::
14509 * x86 Windows Options::
14510 * Xstormy16 Options::
14511 * Xtensa Options::
14512 * zSeries Options::
14513 @end menu
14515 @node AArch64 Options
14516 @subsection AArch64 Options
14517 @cindex AArch64 Options
14519 These options are defined for AArch64 implementations:
14521 @table @gcctabopt
14523 @item -mabi=@var{name}
14524 @opindex mabi
14525 Generate code for the specified data model.  Permissible values
14526 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14527 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14528 but long int and pointers are 64 bits.
14530 The default depends on the specific target configuration.  Note that
14531 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14532 entire program with the same ABI, and link with a compatible set of libraries.
14534 @item -mbig-endian
14535 @opindex mbig-endian
14536 Generate big-endian code.  This is the default when GCC is configured for an
14537 @samp{aarch64_be-*-*} target.
14539 @item -mgeneral-regs-only
14540 @opindex mgeneral-regs-only
14541 Generate code which uses only the general-purpose registers.  This will prevent
14542 the compiler from using floating-point and Advanced SIMD registers but will not
14543 impose any restrictions on the assembler.
14545 @item -mlittle-endian
14546 @opindex mlittle-endian
14547 Generate little-endian code.  This is the default when GCC is configured for an
14548 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14550 @item -mcmodel=tiny
14551 @opindex mcmodel=tiny
14552 Generate code for the tiny code model.  The program and its statically defined
14553 symbols must be within 1MB of each other.  Programs can be statically or
14554 dynamically linked.
14556 @item -mcmodel=small
14557 @opindex mcmodel=small
14558 Generate code for the small code model.  The program and its statically defined
14559 symbols must be within 4GB of each other.  Programs can be statically or
14560 dynamically linked.  This is the default code model.
14562 @item -mcmodel=large
14563 @opindex mcmodel=large
14564 Generate code for the large code model.  This makes no assumptions about
14565 addresses and sizes of sections.  Programs can be statically linked only.
14567 @item -mstrict-align
14568 @opindex mstrict-align
14569 Avoid generating memory accesses that may not be aligned on a natural object
14570 boundary as described in the architecture specification.
14572 @item -momit-leaf-frame-pointer
14573 @itemx -mno-omit-leaf-frame-pointer
14574 @opindex momit-leaf-frame-pointer
14575 @opindex mno-omit-leaf-frame-pointer
14576 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14577 default.
14579 @item -mtls-dialect=desc
14580 @opindex mtls-dialect=desc
14581 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14582 of TLS variables.  This is the default.
14584 @item -mtls-dialect=traditional
14585 @opindex mtls-dialect=traditional
14586 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14587 of TLS variables.
14589 @item -mtls-size=@var{size}
14590 @opindex mtls-size
14591 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14592 This option requires binutils 2.26 or newer.
14594 @item -mfix-cortex-a53-835769
14595 @itemx -mno-fix-cortex-a53-835769
14596 @opindex mfix-cortex-a53-835769
14597 @opindex mno-fix-cortex-a53-835769
14598 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14599 This involves inserting a NOP instruction between memory instructions and
14600 64-bit integer multiply-accumulate instructions.
14602 @item -mfix-cortex-a53-843419
14603 @itemx -mno-fix-cortex-a53-843419
14604 @opindex mfix-cortex-a53-843419
14605 @opindex mno-fix-cortex-a53-843419
14606 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14607 This erratum workaround is made at link time and this will only pass the
14608 corresponding flag to the linker.
14610 @item -mlow-precision-recip-sqrt
14611 @itemx -mno-low-precision-recip-sqrt
14612 @opindex mlow-precision-recip-sqrt
14613 @opindex mno-low-precision-recip-sqrt
14614 Enable or disable the reciprocal square root approximation.
14615 This option only has an effect if @option{-ffast-math} or
14616 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14617 precision of reciprocal square root results to about 16 bits for
14618 single precision and to 32 bits for double precision.
14620 @item -mlow-precision-sqrt
14621 @itemx -mno-low-precision-sqrt
14622 @opindex -mlow-precision-sqrt
14623 @opindex -mno-low-precision-sqrt
14624 Enable or disable the square root approximation.
14625 This option only has an effect if @option{-ffast-math} or
14626 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14627 precision of square root results to about 16 bits for
14628 single precision and to 32 bits for double precision.
14629 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14631 @item -mlow-precision-div
14632 @itemx -mno-low-precision-div
14633 @opindex -mlow-precision-div
14634 @opindex -mno-low-precision-div
14635 Enable or disable the division approximation.
14636 This option only has an effect if @option{-ffast-math} or
14637 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14638 precision of division results to about 16 bits for
14639 single precision and to 32 bits for double precision.
14641 @item -march=@var{name}
14642 @opindex march
14643 Specify the name of the target architecture and, optionally, one or
14644 more feature modifiers.  This option has the form
14645 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14647 The permissible values for @var{arch} are @samp{armv8-a},
14648 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14649 or @var{native}.
14651 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14652 support for the ARMv8.4-A architecture extensions.
14654 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14655 support for the ARMv8.3-A architecture extensions.
14657 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14658 support for the ARMv8.2-A architecture extensions.
14660 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14661 support for the ARMv8.1-A architecture extension.  In particular, it
14662 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14664 The value @samp{native} is available on native AArch64 GNU/Linux and
14665 causes the compiler to pick the architecture of the host system.  This
14666 option has no effect if the compiler is unable to recognize the
14667 architecture of the host system,
14669 The permissible values for @var{feature} are listed in the sub-section
14670 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14671 Feature Modifiers}.  Where conflicting feature modifiers are
14672 specified, the right-most feature is used.
14674 GCC uses @var{name} to determine what kind of instructions it can emit
14675 when generating assembly code.  If @option{-march} is specified
14676 without either of @option{-mtune} or @option{-mcpu} also being
14677 specified, the code is tuned to perform well across a range of target
14678 processors implementing the target architecture.
14680 @item -mtune=@var{name}
14681 @opindex mtune
14682 Specify the name of the target processor for which GCC should tune the
14683 performance of the code.  Permissible values for this option are:
14684 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14685 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14686 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14687 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14688 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14689 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14690 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14691 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14692 @samp{native}.
14694 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14695 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14696 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14697 big.LITTLE system.
14699 Additionally on native AArch64 GNU/Linux systems the value
14700 @samp{native} tunes performance to the host system.  This option has no effect
14701 if the compiler is unable to recognize the processor of the host system.
14703 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14704 are specified, the code is tuned to perform well across a range
14705 of target processors.
14707 This option cannot be suffixed by feature modifiers.
14709 @item -mcpu=@var{name}
14710 @opindex mcpu
14711 Specify the name of the target processor, optionally suffixed by one
14712 or more feature modifiers.  This option has the form
14713 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14714 the permissible values for @var{cpu} are the same as those available
14715 for @option{-mtune}.  The permissible values for @var{feature} are
14716 documented in the sub-section on
14717 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14718 Feature Modifiers}.  Where conflicting feature modifiers are
14719 specified, the right-most feature is used.
14721 GCC uses @var{name} to determine what kind of instructions it can emit when
14722 generating assembly code (as if by @option{-march}) and to determine
14723 the target processor for which to tune for performance (as if
14724 by @option{-mtune}).  Where this option is used in conjunction
14725 with @option{-march} or @option{-mtune}, those options take precedence
14726 over the appropriate part of this option.
14728 @item -moverride=@var{string}
14729 @opindex moverride
14730 Override tuning decisions made by the back-end in response to a
14731 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14732 for @var{string} in this option are not guaranteed to be consistent
14733 across releases.
14735 This option is only intended to be useful when developing GCC.
14737 @item -mverbose-cost-dump
14738 @opindex mverbose-cost-dump
14739 Enable verbose cost model dumping in the debug dump files.  This option is
14740 provided for use in debugging the compiler.
14742 @item -mpc-relative-literal-loads
14743 @itemx -mno-pc-relative-literal-loads
14744 @opindex mpc-relative-literal-loads
14745 @opindex mno-pc-relative-literal-loads
14746 Enable or disable PC-relative literal loads.  With this option literal pools are
14747 accessed using a single instruction and emitted after each function.  This
14748 limits the maximum size of functions to 1MB.  This is enabled by default for
14749 @option{-mcmodel=tiny}.
14751 @item -msign-return-address=@var{scope}
14752 @opindex msign-return-address
14753 Select the function scope on which return address signing will be applied.
14754 Permissible values are @samp{none}, which disables return address signing,
14755 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14756 functions, and @samp{all}, which enables pointer signing for all functions.  The
14757 default value is @samp{none}.
14759 @item -msve-vector-bits=@var{bits}
14760 @opindex msve-vector-bits
14761 Specify the number of bits in an SVE vector register.  This option only has
14762 an effect when SVE is enabled.
14764 GCC supports two forms of SVE code generation: ``vector-length
14765 agnostic'' output that works with any size of vector register and
14766 ``vector-length specific'' output that only works when the vector
14767 registers are a particular size.  Replacing @var{bits} with
14768 @samp{scalable} selects vector-length agnostic output while
14769 replacing it with a number selects vector-length specific output.
14770 The possible lengths in the latter case are: 128, 256, 512, 1024
14771 and 2048.  @samp{scalable} is the default.
14773 At present, @samp{-msve-vector-bits=128} produces the same output
14774 as @samp{-msve-vector-bits=scalable}.
14776 @end table
14778 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14779 @anchor{aarch64-feature-modifiers}
14780 @cindex @option{-march} feature modifiers
14781 @cindex @option{-mcpu} feature modifiers
14782 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14783 the following and their inverses @option{no@var{feature}}:
14785 @table @samp
14786 @item crc
14787 Enable CRC extension.  This is on by default for
14788 @option{-march=armv8.1-a}.
14789 @item crypto
14790 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14791 instructions.
14792 @item fp
14793 Enable floating-point instructions.  This is on by default for all possible
14794 values for options @option{-march} and @option{-mcpu}.
14795 @item simd
14796 Enable Advanced SIMD instructions.  This also enables floating-point
14797 instructions.  This is on by default for all possible values for options
14798 @option{-march} and @option{-mcpu}.
14799 @item sve
14800 Enable Scalable Vector Extension instructions.  This also enables Advanced
14801 SIMD and floating-point instructions.
14802 @item lse
14803 Enable Large System Extension instructions.  This is on by default for
14804 @option{-march=armv8.1-a}.
14805 @item rdma
14806 Enable Round Double Multiply Accumulate instructions.  This is on by default
14807 for @option{-march=armv8.1-a}.
14808 @item fp16
14809 Enable FP16 extension.  This also enables floating-point instructions.
14810 @item fp16fml
14811 Enable FP16 fmla extension.  This also enables FP16 extensions and
14812 floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported.
14814 @item rcpc
14815 Enable the RcPc extension.  This does not change code generation from GCC,
14816 but is passed on to the assembler, enabling inline asm statements to use
14817 instructions from the RcPc extension.
14818 @item dotprod
14819 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14820 @item aes
14821 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14822 SIMD instructions.
14823 @item sha2
14824 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14825 @item sha3
14826 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14827 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14828 @item sm4
14829 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14830 Use of this option with architectures prior to Armv8.2-A is not supported.
14832 @end table
14834 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14835 which implies @option{fp}.
14836 Conversely, @option{nofp} implies @option{nosimd}, which implies
14837 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14839 @node Adapteva Epiphany Options
14840 @subsection Adapteva Epiphany Options
14842 These @samp{-m} options are defined for Adapteva Epiphany:
14844 @table @gcctabopt
14845 @item -mhalf-reg-file
14846 @opindex mhalf-reg-file
14847 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14848 That allows code to run on hardware variants that lack these registers.
14850 @item -mprefer-short-insn-regs
14851 @opindex mprefer-short-insn-regs
14852 Preferentially allocate registers that allow short instruction generation.
14853 This can result in increased instruction count, so this may either reduce or
14854 increase overall code size.
14856 @item -mbranch-cost=@var{num}
14857 @opindex mbranch-cost
14858 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14859 This cost is only a heuristic and is not guaranteed to produce
14860 consistent results across releases.
14862 @item -mcmove
14863 @opindex mcmove
14864 Enable the generation of conditional moves.
14866 @item -mnops=@var{num}
14867 @opindex mnops
14868 Emit @var{num} NOPs before every other generated instruction.
14870 @item -mno-soft-cmpsf
14871 @opindex mno-soft-cmpsf
14872 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14873 and test the flags.  This is faster than a software comparison, but can
14874 get incorrect results in the presence of NaNs, or when two different small
14875 numbers are compared such that their difference is calculated as zero.
14876 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14877 software comparisons.
14879 @item -mstack-offset=@var{num}
14880 @opindex mstack-offset
14881 Set the offset between the top of the stack and the stack pointer.
14882 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14883 can be used by leaf functions without stack allocation.
14884 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14885 Note also that this option changes the ABI; compiling a program with a
14886 different stack offset than the libraries have been compiled with
14887 generally does not work.
14888 This option can be useful if you want to evaluate if a different stack
14889 offset would give you better code, but to actually use a different stack
14890 offset to build working programs, it is recommended to configure the
14891 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14893 @item -mno-round-nearest
14894 @opindex mno-round-nearest
14895 Make the scheduler assume that the rounding mode has been set to
14896 truncating.  The default is @option{-mround-nearest}.
14898 @item -mlong-calls
14899 @opindex mlong-calls
14900 If not otherwise specified by an attribute, assume all calls might be beyond
14901 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14902 function address into a register before performing a (otherwise direct) call.
14903 This is the default.
14905 @item -mshort-calls
14906 @opindex short-calls
14907 If not otherwise specified by an attribute, assume all direct calls are
14908 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14909 for direct calls.  The default is @option{-mlong-calls}.
14911 @item -msmall16
14912 @opindex msmall16
14913 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14914 apply to function addresses for which @option{-mlong-calls} semantics
14915 are in effect.
14917 @item -mfp-mode=@var{mode}
14918 @opindex mfp-mode
14919 Set the prevailing mode of the floating-point unit.
14920 This determines the floating-point mode that is provided and expected
14921 at function call and return time.  Making this mode match the mode you
14922 predominantly need at function start can make your programs smaller and
14923 faster by avoiding unnecessary mode switches.
14925 @var{mode} can be set to one the following values:
14927 @table @samp
14928 @item caller
14929 Any mode at function entry is valid, and retained or restored when
14930 the function returns, and when it calls other functions.
14931 This mode is useful for compiling libraries or other compilation units
14932 you might want to incorporate into different programs with different
14933 prevailing FPU modes, and the convenience of being able to use a single
14934 object file outweighs the size and speed overhead for any extra
14935 mode switching that might be needed, compared with what would be needed
14936 with a more specific choice of prevailing FPU mode.
14938 @item truncate
14939 This is the mode used for floating-point calculations with
14940 truncating (i.e.@: round towards zero) rounding mode.  That includes
14941 conversion from floating point to integer.
14943 @item round-nearest
14944 This is the mode used for floating-point calculations with
14945 round-to-nearest-or-even rounding mode.
14947 @item int
14948 This is the mode used to perform integer calculations in the FPU, e.g.@:
14949 integer multiply, or integer multiply-and-accumulate.
14950 @end table
14952 The default is @option{-mfp-mode=caller}
14954 @item -mnosplit-lohi
14955 @itemx -mno-postinc
14956 @itemx -mno-postmodify
14957 @opindex mnosplit-lohi
14958 @opindex mno-postinc
14959 @opindex mno-postmodify
14960 Code generation tweaks that disable, respectively, splitting of 32-bit
14961 loads, generation of post-increment addresses, and generation of
14962 post-modify addresses.  The defaults are @option{msplit-lohi},
14963 @option{-mpost-inc}, and @option{-mpost-modify}.
14965 @item -mnovect-double
14966 @opindex mno-vect-double
14967 Change the preferred SIMD mode to SImode.  The default is
14968 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14970 @item -max-vect-align=@var{num}
14971 @opindex max-vect-align
14972 The maximum alignment for SIMD vector mode types.
14973 @var{num} may be 4 or 8.  The default is 8.
14974 Note that this is an ABI change, even though many library function
14975 interfaces are unaffected if they don't use SIMD vector modes
14976 in places that affect size and/or alignment of relevant types.
14978 @item -msplit-vecmove-early
14979 @opindex msplit-vecmove-early
14980 Split vector moves into single word moves before reload.  In theory this
14981 can give better register allocation, but so far the reverse seems to be
14982 generally the case.
14984 @item -m1reg-@var{reg}
14985 @opindex m1reg-
14986 Specify a register to hold the constant @minus{}1, which makes loading small negative
14987 constants and certain bitmasks faster.
14988 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14989 which specify use of that register as a fixed register,
14990 and @samp{none}, which means that no register is used for this
14991 purpose.  The default is @option{-m1reg-none}.
14993 @end table
14995 @node ARC Options
14996 @subsection ARC Options
14997 @cindex ARC options
14999 The following options control the architecture variant for which code
15000 is being compiled:
15002 @c architecture variants
15003 @table @gcctabopt
15005 @item -mbarrel-shifter
15006 @opindex mbarrel-shifter
15007 Generate instructions supported by barrel shifter.  This is the default
15008 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15010 @item -mjli-always
15011 @opindex mjli-alawys
15012 Force to call a function using jli_s instruction.  This option is
15013 valid only for ARCv2 architecture.
15015 @item -mcpu=@var{cpu}
15016 @opindex mcpu
15017 Set architecture type, register usage, and instruction scheduling
15018 parameters for @var{cpu}.  There are also shortcut alias options
15019 available for backward compatibility and convenience.  Supported
15020 values for @var{cpu} are
15022 @table @samp
15023 @opindex mA6
15024 @opindex mARC600
15025 @item arc600
15026 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15028 @item arc601
15029 @opindex mARC601
15030 Compile for ARC601.  Alias: @option{-mARC601}.
15032 @item arc700
15033 @opindex mA7
15034 @opindex mARC700
15035 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15036 This is the default when configured with @option{--with-cpu=arc700}@.
15038 @item arcem
15039 Compile for ARC EM.
15041 @item archs
15042 Compile for ARC HS.
15044 @item em
15045 Compile for ARC EM CPU with no hardware extensions.
15047 @item em4
15048 Compile for ARC EM4 CPU.
15050 @item em4_dmips
15051 Compile for ARC EM4 DMIPS CPU.
15053 @item em4_fpus
15054 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15055 extension.
15057 @item em4_fpuda
15058 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15059 double assist instructions.
15061 @item hs
15062 Compile for ARC HS CPU with no hardware extensions except the atomic
15063 instructions.
15065 @item hs34
15066 Compile for ARC HS34 CPU.
15068 @item hs38
15069 Compile for ARC HS38 CPU.
15071 @item hs38_linux
15072 Compile for ARC HS38 CPU with all hardware extensions on.
15074 @item arc600_norm
15075 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15077 @item arc600_mul32x16
15078 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15079 instructions enabled.
15081 @item arc600_mul64
15082 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15083 instructions enabled.
15085 @item arc601_norm
15086 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15088 @item arc601_mul32x16
15089 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15090 instructions enabled.
15092 @item arc601_mul64
15093 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15094 instructions enabled.
15096 @item nps400
15097 Compile for ARC 700 on NPS400 chip.
15099 @item em_mini
15100 Compile for ARC EM minimalist configuration featuring reduced register
15101 set.
15103 @end table
15105 @item -mdpfp
15106 @opindex mdpfp
15107 @itemx -mdpfp-compact
15108 @opindex mdpfp-compact
15109 Generate double-precision FPX instructions, tuned for the compact
15110 implementation.
15112 @item -mdpfp-fast
15113 @opindex mdpfp-fast
15114 Generate double-precision FPX instructions, tuned for the fast
15115 implementation.
15117 @item -mno-dpfp-lrsr
15118 @opindex mno-dpfp-lrsr
15119 Disable @code{lr} and @code{sr} instructions from using FPX extension
15120 aux registers.
15122 @item -mea
15123 @opindex mea
15124 Generate extended arithmetic instructions.  Currently only
15125 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15126 supported.  This is always enabled for @option{-mcpu=ARC700}.
15128 @item -mno-mpy
15129 @opindex mno-mpy
15130 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15131 deprecated.
15133 @item -mmul32x16
15134 @opindex mmul32x16
15135 Generate 32x16-bit multiply and multiply-accumulate instructions.
15137 @item -mmul64
15138 @opindex mmul64
15139 Generate @code{mul64} and @code{mulu64} instructions.  
15140 Only valid for @option{-mcpu=ARC600}.
15142 @item -mnorm
15143 @opindex mnorm
15144 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15145 is in effect.
15147 @item -mspfp
15148 @opindex mspfp
15149 @itemx -mspfp-compact
15150 @opindex mspfp-compact
15151 Generate single-precision FPX instructions, tuned for the compact
15152 implementation.
15154 @item -mspfp-fast
15155 @opindex mspfp-fast
15156 Generate single-precision FPX instructions, tuned for the fast
15157 implementation.
15159 @item -msimd
15160 @opindex msimd
15161 Enable generation of ARC SIMD instructions via target-specific
15162 builtins.  Only valid for @option{-mcpu=ARC700}.
15164 @item -msoft-float
15165 @opindex msoft-float
15166 This option ignored; it is provided for compatibility purposes only.
15167 Software floating-point code is emitted by default, and this default
15168 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15169 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15170 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15172 @item -mswap
15173 @opindex mswap
15174 Generate @code{swap} instructions.
15176 @item -matomic
15177 @opindex matomic
15178 This enables use of the locked load/store conditional extension to implement
15179 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15180 EM cores.
15182 @item -mdiv-rem
15183 @opindex mdiv-rem
15184 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15186 @item -mcode-density
15187 @opindex mcode-density
15188 Enable code density instructions for ARC EM.  
15189 This option is on by default for ARC HS.
15191 @item -mll64
15192 @opindex mll64
15193 Enable double load/store operations for ARC HS cores.
15195 @item -mtp-regno=@var{regno}
15196 @opindex mtp-regno
15197 Specify thread pointer register number.
15199 @item -mmpy-option=@var{multo}
15200 @opindex mmpy-option
15201 Compile ARCv2 code with a multiplier design option.  You can specify 
15202 the option using either a string or numeric value for @var{multo}.  
15203 @samp{wlh1} is the default value.  The recognized values are:
15205 @table @samp
15206 @item 0
15207 @itemx none
15208 No multiplier available.
15210 @item 1
15211 @itemx w
15212 16x16 multiplier, fully pipelined.
15213 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15215 @item 2
15216 @itemx wlh1
15217 32x32 multiplier, fully
15218 pipelined (1 stage).  The following instructions are additionally
15219 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15221 @item 3
15222 @itemx wlh2
15223 32x32 multiplier, fully pipelined
15224 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15225 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15227 @item 4
15228 @itemx wlh3
15229 Two 16x16 multipliers, blocking,
15230 sequential.  The following instructions are additionally enabled: @code{mpy},
15231 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15233 @item 5
15234 @itemx wlh4
15235 One 16x16 multiplier, blocking,
15236 sequential.  The following instructions are additionally enabled: @code{mpy},
15237 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15239 @item 6
15240 @itemx wlh5
15241 One 32x4 multiplier, blocking,
15242 sequential.  The following instructions are additionally enabled: @code{mpy},
15243 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15245 @item 7
15246 @itemx plus_dmpy
15247 ARC HS SIMD support.
15249 @item 8
15250 @itemx plus_macd
15251 ARC HS SIMD support.
15253 @item 9
15254 @itemx plus_qmacw
15255 ARC HS SIMD support.
15257 @end table
15259 This option is only available for ARCv2 cores@.
15261 @item -mfpu=@var{fpu}
15262 @opindex mfpu
15263 Enables support for specific floating-point hardware extensions for ARCv2
15264 cores.  Supported values for @var{fpu} are:
15266 @table @samp
15268 @item fpus
15269 Enables support for single-precision floating-point hardware
15270 extensions@.
15272 @item fpud
15273 Enables support for double-precision floating-point hardware
15274 extensions.  The single-precision floating-point extension is also
15275 enabled.  Not available for ARC EM@.
15277 @item fpuda
15278 Enables support for double-precision floating-point hardware
15279 extensions using double-precision assist instructions.  The single-precision
15280 floating-point extension is also enabled.  This option is
15281 only available for ARC EM@.
15283 @item fpuda_div
15284 Enables support for double-precision floating-point hardware
15285 extensions using double-precision assist instructions.
15286 The single-precision floating-point, square-root, and divide 
15287 extensions are also enabled.  This option is
15288 only available for ARC EM@.
15290 @item fpuda_fma
15291 Enables support for double-precision floating-point hardware
15292 extensions using double-precision assist instructions.
15293 The single-precision floating-point and fused multiply and add 
15294 hardware extensions are also enabled.  This option is
15295 only available for ARC EM@.
15297 @item fpuda_all
15298 Enables support for double-precision floating-point hardware
15299 extensions using double-precision assist instructions.
15300 All single-precision floating-point hardware extensions are also
15301 enabled.  This option is only available for ARC EM@.
15303 @item fpus_div
15304 Enables support for single-precision floating-point, square-root and divide 
15305 hardware extensions@.
15307 @item fpud_div
15308 Enables support for double-precision floating-point, square-root and divide 
15309 hardware extensions.  This option
15310 includes option @samp{fpus_div}. Not available for ARC EM@.
15312 @item fpus_fma
15313 Enables support for single-precision floating-point and 
15314 fused multiply and add hardware extensions@.
15316 @item fpud_fma
15317 Enables support for double-precision floating-point and 
15318 fused multiply and add hardware extensions.  This option
15319 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15321 @item fpus_all
15322 Enables support for all single-precision floating-point hardware
15323 extensions@.
15325 @item fpud_all
15326 Enables support for all single- and double-precision floating-point
15327 hardware extensions.  Not available for ARC EM@.
15329 @end table
15331 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15332 @opindex mirq-ctrl-saved
15333 Specifies general-purposes registers that the processor automatically
15334 saves/restores on interrupt entry and exit.  @var{register-range} is
15335 specified as two registers separated by a dash.  The register range
15336 always starts with @code{r0}, the upper limit is @code{fp} register.
15337 @var{blink} and @var{lp_count} are optional.  This option is only
15338 valid for ARC EM and ARC HS cores.
15340 @item -mrgf-banked-regs=@var{number}
15341 @opindex mrgf-banked-regs
15342 Specifies the number of registers replicated in second register bank
15343 on entry to fast interrupt.  Fast interrupts are interrupts with the
15344 highest priority level P0.  These interrupts save only PC and STATUS32
15345 registers to avoid memory transactions during interrupt entry and exit
15346 sequences.  Use this option when you are using fast interrupts in an
15347 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15349 @item -mlpc-width=@var{width}
15350 @opindex mlpc-width
15351 Specify the width of the @code{lp_count} register.  Valid values for
15352 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15353 fixed to 32 bits.  If the width is less than 32, the compiler does not
15354 attempt to transform loops in your program to use the zero-delay loop
15355 mechanism unless it is known that the @code{lp_count} register can
15356 hold the required loop-counter value.  Depending on the width
15357 specified, the compiler and run-time library might continue to use the
15358 loop mechanism for various needs.  This option defines macro
15359 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15361 @item -mrf16
15362 @opindex mrf16
15363 This option instructs the compiler to generate code for a 16-entry
15364 register file.  This option defines the @code{__ARC_RF16__}
15365 preprocessor macro.
15367 @end table
15369 The following options are passed through to the assembler, and also
15370 define preprocessor macro symbols.
15372 @c Flags used by the assembler, but for which we define preprocessor
15373 @c macro symbols as well.
15374 @table @gcctabopt
15375 @item -mdsp-packa
15376 @opindex mdsp-packa
15377 Passed down to the assembler to enable the DSP Pack A extensions.
15378 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15379 deprecated.
15381 @item -mdvbf
15382 @opindex mdvbf
15383 Passed down to the assembler to enable the dual Viterbi butterfly
15384 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15385 option is deprecated.
15387 @c ARC700 4.10 extension instruction
15388 @item -mlock
15389 @opindex mlock
15390 Passed down to the assembler to enable the locked load/store
15391 conditional extension.  Also sets the preprocessor symbol
15392 @code{__Xlock}.
15394 @item -mmac-d16
15395 @opindex mmac-d16
15396 Passed down to the assembler.  Also sets the preprocessor symbol
15397 @code{__Xxmac_d16}.  This option is deprecated.
15399 @item -mmac-24
15400 @opindex mmac-24
15401 Passed down to the assembler.  Also sets the preprocessor symbol
15402 @code{__Xxmac_24}.  This option is deprecated.
15404 @c ARC700 4.10 extension instruction
15405 @item -mrtsc
15406 @opindex mrtsc
15407 Passed down to the assembler to enable the 64-bit time-stamp counter
15408 extension instruction.  Also sets the preprocessor symbol
15409 @code{__Xrtsc}.  This option is deprecated.
15411 @c ARC700 4.10 extension instruction
15412 @item -mswape
15413 @opindex mswape
15414 Passed down to the assembler to enable the swap byte ordering
15415 extension instruction.  Also sets the preprocessor symbol
15416 @code{__Xswape}.
15418 @item -mtelephony
15419 @opindex mtelephony
15420 Passed down to the assembler to enable dual- and single-operand
15421 instructions for telephony.  Also sets the preprocessor symbol
15422 @code{__Xtelephony}.  This option is deprecated.
15424 @item -mxy
15425 @opindex mxy
15426 Passed down to the assembler to enable the XY memory extension.  Also
15427 sets the preprocessor symbol @code{__Xxy}.
15429 @end table
15431 The following options control how the assembly code is annotated:
15433 @c Assembly annotation options
15434 @table @gcctabopt
15435 @item -misize
15436 @opindex misize
15437 Annotate assembler instructions with estimated addresses.
15439 @item -mannotate-align
15440 @opindex mannotate-align
15441 Explain what alignment considerations lead to the decision to make an
15442 instruction short or long.
15444 @end table
15446 The following options are passed through to the linker:
15448 @c options passed through to the linker
15449 @table @gcctabopt
15450 @item -marclinux
15451 @opindex marclinux
15452 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15453 This option is enabled by default in tool chains built for
15454 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15455 when profiling is not requested.
15457 @item -marclinux_prof
15458 @opindex marclinux_prof
15459 Passed through to the linker, to specify use of the
15460 @code{arclinux_prof} emulation.  This option is enabled by default in
15461 tool chains built for @w{@code{arc-linux-uclibc}} and
15462 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15464 @end table
15466 The following options control the semantics of generated code:
15468 @c semantically relevant code generation options
15469 @table @gcctabopt
15470 @item -mlong-calls
15471 @opindex mlong-calls
15472 Generate calls as register indirect calls, thus providing access
15473 to the full 32-bit address range.
15475 @item -mmedium-calls
15476 @opindex mmedium-calls
15477 Don't use less than 25-bit addressing range for calls, which is the
15478 offset available for an unconditional branch-and-link
15479 instruction.  Conditional execution of function calls is suppressed, to
15480 allow use of the 25-bit range, rather than the 21-bit range with
15481 conditional branch-and-link.  This is the default for tool chains built
15482 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15484 @item -G @var{num}
15485 @opindex G
15486 Put definitions of externally-visible data in a small data section if
15487 that data is no bigger than @var{num} bytes.  The default value of
15488 @var{num} is 4 for any ARC configuration, or 8 when we have double
15489 load/store operations.
15491 @item -mno-sdata
15492 @opindex mno-sdata
15493 Do not generate sdata references.  This is the default for tool chains
15494 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15495 targets.
15497 @item -mvolatile-cache
15498 @opindex mvolatile-cache
15499 Use ordinarily cached memory accesses for volatile references.  This is the
15500 default.
15502 @item -mno-volatile-cache
15503 @opindex mno-volatile-cache
15504 Enable cache bypass for volatile references.
15506 @end table
15508 The following options fine tune code generation:
15509 @c code generation tuning options
15510 @table @gcctabopt
15511 @item -malign-call
15512 @opindex malign-call
15513 Do alignment optimizations for call instructions.
15515 @item -mauto-modify-reg
15516 @opindex mauto-modify-reg
15517 Enable the use of pre/post modify with register displacement.
15519 @item -mbbit-peephole
15520 @opindex mbbit-peephole
15521 Enable bbit peephole2.
15523 @item -mno-brcc
15524 @opindex mno-brcc
15525 This option disables a target-specific pass in @file{arc_reorg} to
15526 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15527 It has no effect on
15528 generation of these instructions driven by the combiner pass.
15530 @item -mcase-vector-pcrel
15531 @opindex mcase-vector-pcrel
15532 Use PC-relative switch case tables to enable case table shortening.
15533 This is the default for @option{-Os}.
15535 @item -mcompact-casesi
15536 @opindex mcompact-casesi
15537 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15538 and only available for ARCv1 cores.
15540 @item -mno-cond-exec
15541 @opindex mno-cond-exec
15542 Disable the ARCompact-specific pass to generate conditional 
15543 execution instructions.
15545 Due to delay slot scheduling and interactions between operand numbers,
15546 literal sizes, instruction lengths, and the support for conditional execution,
15547 the target-independent pass to generate conditional execution is often lacking,
15548 so the ARC port has kept a special pass around that tries to find more
15549 conditional execution generation opportunities after register allocation,
15550 branch shortening, and delay slot scheduling have been done.  This pass
15551 generally, but not always, improves performance and code size, at the cost of
15552 extra compilation time, which is why there is an option to switch it off.
15553 If you have a problem with call instructions exceeding their allowable
15554 offset range because they are conditionalized, you should consider using
15555 @option{-mmedium-calls} instead.
15557 @item -mearly-cbranchsi
15558 @opindex mearly-cbranchsi
15559 Enable pre-reload use of the @code{cbranchsi} pattern.
15561 @item -mexpand-adddi
15562 @opindex mexpand-adddi
15563 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15564 @code{add.f}, @code{adc} etc.  This option is deprecated.
15566 @item -mindexed-loads
15567 @opindex mindexed-loads
15568 Enable the use of indexed loads.  This can be problematic because some
15569 optimizers then assume that indexed stores exist, which is not
15570 the case.
15572 @item -mlra
15573 @opindex mlra
15574 Enable Local Register Allocation.  This is still experimental for ARC,
15575 so by default the compiler uses standard reload
15576 (i.e. @option{-mno-lra}).
15578 @item -mlra-priority-none
15579 @opindex mlra-priority-none
15580 Don't indicate any priority for target registers.
15582 @item -mlra-priority-compact
15583 @opindex mlra-priority-compact
15584 Indicate target register priority for r0..r3 / r12..r15.
15586 @item -mlra-priority-noncompact
15587 @opindex mlra-priority-noncompact
15588 Reduce target register priority for r0..r3 / r12..r15.
15590 @item -mno-millicode
15591 @opindex mno-millicode
15592 When optimizing for size (using @option{-Os}), prologues and epilogues
15593 that have to save or restore a large number of registers are often
15594 shortened by using call to a special function in libgcc; this is
15595 referred to as a @emph{millicode} call.  As these calls can pose
15596 performance issues, and/or cause linking issues when linking in a
15597 nonstandard way, this option is provided to turn off millicode call
15598 generation.
15600 @item -mmixed-code
15601 @opindex mmixed-code
15602 Tweak register allocation to help 16-bit instruction generation.
15603 This generally has the effect of decreasing the average instruction size
15604 while increasing the instruction count.
15606 @item -mq-class
15607 @opindex mq-class
15608 Enable @samp{q} instruction alternatives.
15609 This is the default for @option{-Os}.
15611 @item -mRcq
15612 @opindex mRcq
15613 Enable @samp{Rcq} constraint handling.  
15614 Most short code generation depends on this.
15615 This is the default.
15617 @item -mRcw
15618 @opindex mRcw
15619 Enable @samp{Rcw} constraint handling.  
15620 Most ccfsm condexec mostly depends on this.
15621 This is the default.
15623 @item -msize-level=@var{level}
15624 @opindex msize-level
15625 Fine-tune size optimization with regards to instruction lengths and alignment.
15626 The recognized values for @var{level} are:
15627 @table @samp
15628 @item 0
15629 No size optimization.  This level is deprecated and treated like @samp{1}.
15631 @item 1
15632 Short instructions are used opportunistically.
15634 @item 2
15635 In addition, alignment of loops and of code after barriers are dropped.
15637 @item 3
15638 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15640 @end table
15642 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15643 the behavior when this is not set is equivalent to level @samp{1}.
15645 @item -mtune=@var{cpu}
15646 @opindex mtune
15647 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15648 by @option{-mcpu=}.
15650 Supported values for @var{cpu} are
15652 @table @samp
15653 @item ARC600
15654 Tune for ARC600 CPU.
15656 @item ARC601
15657 Tune for ARC601 CPU.
15659 @item ARC700
15660 Tune for ARC700 CPU with standard multiplier block.
15662 @item ARC700-xmac
15663 Tune for ARC700 CPU with XMAC block.
15665 @item ARC725D
15666 Tune for ARC725D CPU.
15668 @item ARC750D
15669 Tune for ARC750D CPU.
15671 @end table
15673 @item -mmultcost=@var{num}
15674 @opindex mmultcost
15675 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15676 normal instruction.
15678 @item -munalign-prob-threshold=@var{probability}
15679 @opindex munalign-prob-threshold
15680 Set probability threshold for unaligning branches.
15681 When tuning for @samp{ARC700} and optimizing for speed, branches without
15682 filled delay slot are preferably emitted unaligned and long, unless
15683 profiling indicates that the probability for the branch to be taken
15684 is below @var{probability}.  @xref{Cross-profiling}.
15685 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15687 @end table
15689 The following options are maintained for backward compatibility, but
15690 are now deprecated and will be removed in a future release:
15692 @c Deprecated options
15693 @table @gcctabopt
15695 @item -margonaut
15696 @opindex margonaut
15697 Obsolete FPX.
15699 @item -mbig-endian
15700 @opindex mbig-endian
15701 @itemx -EB
15702 @opindex EB
15703 Compile code for big-endian targets.  Use of these options is now
15704 deprecated.  Big-endian code is supported by configuring GCC to build
15705 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15706 for which big endian is the default.
15708 @item -mlittle-endian
15709 @opindex mlittle-endian
15710 @itemx -EL
15711 @opindex EL
15712 Compile code for little-endian targets.  Use of these options is now
15713 deprecated.  Little-endian code is supported by configuring GCC to build 
15714 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15715 for which little endian is the default.
15717 @item -mbarrel_shifter
15718 @opindex mbarrel_shifter
15719 Replaced by @option{-mbarrel-shifter}.
15721 @item -mdpfp_compact
15722 @opindex mdpfp_compact
15723 Replaced by @option{-mdpfp-compact}.
15725 @item -mdpfp_fast
15726 @opindex mdpfp_fast
15727 Replaced by @option{-mdpfp-fast}.
15729 @item -mdsp_packa
15730 @opindex mdsp_packa
15731 Replaced by @option{-mdsp-packa}.
15733 @item -mEA
15734 @opindex mEA
15735 Replaced by @option{-mea}.
15737 @item -mmac_24
15738 @opindex mmac_24
15739 Replaced by @option{-mmac-24}.
15741 @item -mmac_d16
15742 @opindex mmac_d16
15743 Replaced by @option{-mmac-d16}.
15745 @item -mspfp_compact
15746 @opindex mspfp_compact
15747 Replaced by @option{-mspfp-compact}.
15749 @item -mspfp_fast
15750 @opindex mspfp_fast
15751 Replaced by @option{-mspfp-fast}.
15753 @item -mtune=@var{cpu}
15754 @opindex mtune
15755 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15756 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15757 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15759 @item -multcost=@var{num}
15760 @opindex multcost
15761 Replaced by @option{-mmultcost}.
15763 @end table
15765 @node ARM Options
15766 @subsection ARM Options
15767 @cindex ARM options
15769 These @samp{-m} options are defined for the ARM port:
15771 @table @gcctabopt
15772 @item -mabi=@var{name}
15773 @opindex mabi
15774 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15775 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15777 @item -mapcs-frame
15778 @opindex mapcs-frame
15779 Generate a stack frame that is compliant with the ARM Procedure Call
15780 Standard for all functions, even if this is not strictly necessary for
15781 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15782 with this option causes the stack frames not to be generated for
15783 leaf functions.  The default is @option{-mno-apcs-frame}.
15784 This option is deprecated.
15786 @item -mapcs
15787 @opindex mapcs
15788 This is a synonym for @option{-mapcs-frame} and is deprecated.
15790 @ignore
15791 @c not currently implemented
15792 @item -mapcs-stack-check
15793 @opindex mapcs-stack-check
15794 Generate code to check the amount of stack space available upon entry to
15795 every function (that actually uses some stack space).  If there is
15796 insufficient space available then either the function
15797 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15798 called, depending upon the amount of stack space required.  The runtime
15799 system is required to provide these functions.  The default is
15800 @option{-mno-apcs-stack-check}, since this produces smaller code.
15802 @c not currently implemented
15803 @item -mapcs-reentrant
15804 @opindex mapcs-reentrant
15805 Generate reentrant, position-independent code.  The default is
15806 @option{-mno-apcs-reentrant}.
15807 @end ignore
15809 @item -mthumb-interwork
15810 @opindex mthumb-interwork
15811 Generate code that supports calling between the ARM and Thumb
15812 instruction sets.  Without this option, on pre-v5 architectures, the
15813 two instruction sets cannot be reliably used inside one program.  The
15814 default is @option{-mno-thumb-interwork}, since slightly larger code
15815 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15816 configurations this option is meaningless.
15818 @item -mno-sched-prolog
15819 @opindex mno-sched-prolog
15820 Prevent the reordering of instructions in the function prologue, or the
15821 merging of those instruction with the instructions in the function's
15822 body.  This means that all functions start with a recognizable set
15823 of instructions (or in fact one of a choice from a small set of
15824 different function prologues), and this information can be used to
15825 locate the start of functions inside an executable piece of code.  The
15826 default is @option{-msched-prolog}.
15828 @item -mfloat-abi=@var{name}
15829 @opindex mfloat-abi
15830 Specifies which floating-point ABI to use.  Permissible values
15831 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15833 Specifying @samp{soft} causes GCC to generate output containing
15834 library calls for floating-point operations.
15835 @samp{softfp} allows the generation of code using hardware floating-point
15836 instructions, but still uses the soft-float calling conventions.
15837 @samp{hard} allows generation of floating-point instructions
15838 and uses FPU-specific calling conventions.
15840 The default depends on the specific target configuration.  Note that
15841 the hard-float and soft-float ABIs are not link-compatible; you must
15842 compile your entire program with the same ABI, and link with a
15843 compatible set of libraries.
15845 @item -mlittle-endian
15846 @opindex mlittle-endian
15847 Generate code for a processor running in little-endian mode.  This is
15848 the default for all standard configurations.
15850 @item -mbig-endian
15851 @opindex mbig-endian
15852 Generate code for a processor running in big-endian mode; the default is
15853 to compile code for a little-endian processor.
15855 @item -mbe8
15856 @itemx -mbe32
15857 @opindex mbe8
15858 When linking a big-endian image select between BE8 and BE32 formats.
15859 The option has no effect for little-endian images and is ignored.  The
15860 default is dependent on the selected target architecture.  For ARMv6
15861 and later architectures the default is BE8, for older architectures
15862 the default is BE32.  BE32 format has been deprecated by ARM.
15864 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15865 @opindex march
15866 This specifies the name of the target ARM architecture.  GCC uses this
15867 name to determine what kind of instructions it can emit when generating
15868 assembly code.  This option can be used in conjunction with or instead
15869 of the @option{-mcpu=} option.
15871 Permissible names are:
15872 @samp{armv4t},
15873 @samp{armv5t}, @samp{armv5te},
15874 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15875 @samp{armv6z}, @samp{armv6zk},
15876 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15877 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15878 @samp{armv8.4-a},
15879 @samp{armv7-r},
15880 @samp{armv8-r},
15881 @samp{armv6-m}, @samp{armv6s-m},
15882 @samp{armv7-m}, @samp{armv7e-m},
15883 @samp{armv8-m.base}, @samp{armv8-m.main},
15884 @samp{iwmmxt} and @samp{iwmmxt2}.
15886 Additionally, the following architectures, which lack support for the
15887 Thumb execution state, are recognized but support is deprecated:
15888 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15889 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15891 Many of the architectures support extensions.  These can be added by
15892 appending @samp{+@var{extension}} to the architecture name.  Extension
15893 options are processed in order and capabilities accumulate.  An extension
15894 will also enable any necessary base extensions
15895 upon which it depends.  For example, the @samp{+crypto} extension
15896 will always enable the @samp{+simd} extension.  The exception to the
15897 additive construction is for extensions that are prefixed with
15898 @samp{+no@dots{}}: these extensions disable the specified option and
15899 any other extensions that may depend on the presence of that
15900 extension.
15902 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15903 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15904 entirely disabled by the @samp{+nofp} option that follows it.
15906 Most extension names are generically named, but have an effect that is
15907 dependent upon the architecture to which it is applied.  For example,
15908 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15909 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15910 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15911 variant for @samp{armv8-a}.
15913 The table below lists the supported extensions for each architecture.
15914 Architectures not mentioned do not support any extensions.
15916 @table @samp
15917 @item  armv5e
15918 @itemx armv5te
15919 @itemx armv6
15920 @itemx armv6j
15921 @itemx armv6k
15922 @itemx armv6kz
15923 @itemx armv6t2
15924 @itemx armv6z
15925 @itemx armv6zk
15926 @table @samp
15927 @item +fp
15928 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15929 used as an alias for this extension.
15931 @item +nofp
15932 Disable the floating-point instructions.
15933 @end table
15935 @item armv7
15936 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15937 @table @samp
15938 @item +fp
15939 The VFPv3 floating-point instructions, with 16 double-precision
15940 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15941 for this extension.  Note that floating-point is not supported by the
15942 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15943 ARMv7-R architectures.
15945 @item +nofp
15946 Disable the floating-point instructions.
15947 @end table
15949 @item armv7-a
15950 @table @samp
15951 @item +fp
15952 The VFPv3 floating-point instructions, with 16 double-precision
15953 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15954 for this extension.
15956 @item +simd
15957 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15958 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15959 for this extension.
15961 @item +vfpv3
15962 The VFPv3 floating-point instructions, with 32 double-precision
15963 registers.
15965 @item +vfpv3-d16-fp16
15966 The VFPv3 floating-point instructions, with 16 double-precision
15967 registers and the half-precision floating-point conversion operations.
15969 @item +vfpv3-fp16
15970 The VFPv3 floating-point instructions, with 32 double-precision
15971 registers and the half-precision floating-point conversion operations.
15973 @item +vfpv4-d16
15974 The VFPv4 floating-point instructions, with 16 double-precision
15975 registers.
15977 @item +vfpv4
15978 The VFPv4 floating-point instructions, with 32 double-precision
15979 registers.
15981 @item +neon-fp16
15982 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15983 the half-precision floating-point conversion operations.
15985 @item +neon-vfpv4
15986 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15988 @item +nosimd
15989 Disable the Advanced SIMD instructions (does not disable floating point).
15991 @item +nofp
15992 Disable the floating-point and Advanced SIMD instructions.
15993 @end table
15995 @item armv7ve
15996 The extended version of the ARMv7-A architecture with support for
15997 virtualization.
15998 @table @samp
15999 @item +fp
16000 The VFPv4 floating-point instructions, with 16 double-precision registers.
16001 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16003 @item +simd
16004 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16005 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16007 @item +vfpv3-d16
16008 The VFPv3 floating-point instructions, with 16 double-precision
16009 registers.
16011 @item +vfpv3
16012 The VFPv3 floating-point instructions, with 32 double-precision
16013 registers.
16015 @item +vfpv3-d16-fp16
16016 The VFPv3 floating-point instructions, with 16 double-precision
16017 registers and the half-precision floating-point conversion operations.
16019 @item +vfpv3-fp16
16020 The VFPv3 floating-point instructions, with 32 double-precision
16021 registers and the half-precision floating-point conversion operations.
16023 @item +vfpv4-d16
16024 The VFPv4 floating-point instructions, with 16 double-precision
16025 registers.
16027 @item +vfpv4
16028 The VFPv4 floating-point instructions, with 32 double-precision
16029 registers.
16031 @item +neon
16032 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16033 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16035 @item +neon-fp16
16036 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16037 the half-precision floating-point conversion operations.
16039 @item +nosimd
16040 Disable the Advanced SIMD instructions (does not disable floating point).
16042 @item +nofp
16043 Disable the floating-point and Advanced SIMD instructions.
16044 @end table
16046 @item armv8-a
16047 @table @samp
16048 @item +crc
16049 The Cyclic Redundancy Check (CRC) instructions.
16050 @item +simd
16051 The ARMv8-A Advanced SIMD and floating-point instructions.
16052 @item +crypto
16053 The cryptographic instructions.
16054 @item +nocrypto
16055 Disable the cryptographic instructions.
16056 @item +nofp
16057 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16058 @end table
16060 @item armv8.1-a
16061 @table @samp
16062 @item +simd
16063 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16065 @item +crypto
16066 The cryptographic instructions.  This also enables the Advanced SIMD and
16067 floating-point instructions.
16069 @item +nocrypto
16070 Disable the cryptographic instructions.
16072 @item +nofp
16073 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16074 @end table
16076 @item armv8.2-a
16077 @itemx armv8.3-a
16078 @table @samp
16079 @item +fp16
16080 The half-precision floating-point data processing instructions.
16081 This also enables the Advanced SIMD and floating-point instructions.
16083 @item +fp16fml
16084 The half-precision floating-point fmla extension.  This also enables
16085 the half-precision floating-point extension and Advanced SIMD and
16086 floating-point instructions.
16088 @item +simd
16089 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16091 @item +crypto
16092 The cryptographic instructions.  This also enables the Advanced SIMD and
16093 floating-point instructions.
16095 @item +dotprod
16096 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16098 @item +nocrypto
16099 Disable the cryptographic extension.
16101 @item +nofp
16102 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16103 @end table
16105 @item armv8.4-a
16106 @table @samp
16107 @item +fp16
16108 The half-precision floating-point data processing instructions.
16109 This also enables the Advanced SIMD and floating-point instructions as well
16110 as the Dot Product extension and the half-precision floating-point fmla
16111 extension.
16113 @item +simd
16114 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16115 Dot Product extension.
16117 @item +crypto
16118 The cryptographic instructions.  This also enables the Advanced SIMD and
16119 floating-point instructions as well as the Dot Product extension.
16121 @item +nocrypto
16122 Disable the cryptographic extension.
16124 @item +nofp
16125 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16126 @end table
16128 @item armv7-r
16129 @table @samp
16130 @item +fp.sp
16131 The single-precision VFPv3 floating-point instructions.  The extension
16132 @samp{+vfpv3xd} can be used as an alias for this extension.
16134 @item +fp
16135 The VFPv3 floating-point instructions with 16 double-precision registers.
16136 The extension +vfpv3-d16 can be used as an alias for this extension.
16138 @item +nofp
16139 Disable the floating-point extension.
16141 @item +idiv
16142 The ARM-state integer division instructions.
16144 @item +noidiv
16145 Disable the ARM-state integer division extension.
16146 @end table
16148 @item armv7e-m
16149 @table @samp
16150 @item +fp
16151 The single-precision VFPv4 floating-point instructions.
16153 @item +fpv5
16154 The single-precision FPv5 floating-point instructions.
16156 @item +fp.dp
16157 The single- and double-precision FPv5 floating-point instructions.
16159 @item +nofp
16160 Disable the floating-point extensions.
16161 @end table
16163 @item  armv8-m.main
16164 @table @samp
16165 @item +dsp
16166 The DSP instructions.
16168 @item +nodsp
16169 Disable the DSP extension.
16171 @item +fp
16172 The single-precision floating-point instructions.
16174 @item +fp.dp
16175 The single- and double-precision floating-point instructions.
16177 @item +nofp
16178 Disable the floating-point extension.
16179 @end table
16181 @item armv8-r
16182 @table @samp
16183 @item +crc
16184 The Cyclic Redundancy Check (CRC) instructions.
16185 @item +fp.sp
16186 The single-precision FPv5 floating-point instructions.
16187 @item +simd
16188 The ARMv8-A Advanced SIMD and floating-point instructions.
16189 @item +crypto
16190 The cryptographic instructions.
16191 @item +nocrypto
16192 Disable the cryptographic instructions.
16193 @item +nofp
16194 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16195 @end table
16197 @end table
16199 @option{-march=native} causes the compiler to auto-detect the architecture
16200 of the build computer.  At present, this feature is only supported on
16201 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16202 is unsuccessful the option has no effect.
16204 @item -mtune=@var{name}
16205 @opindex mtune
16206 This option specifies the name of the target ARM processor for
16207 which GCC should tune the performance of the code.
16208 For some ARM implementations better performance can be obtained by using
16209 this option.
16210 Permissible names are: @samp{arm2}, @samp{arm250},
16211 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16212 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16213 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16214 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16215 @samp{arm720},
16216 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16217 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16218 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16219 @samp{strongarm1110},
16220 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16221 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16222 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16223 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16224 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16225 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16226 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16227 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16228 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16229 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16230 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16231 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16232 @samp{cortex-r8}, @samp{cortex-r52},
16233 @samp{cortex-m33},
16234 @samp{cortex-m23},
16235 @samp{cortex-m7},
16236 @samp{cortex-m4},
16237 @samp{cortex-m3},
16238 @samp{cortex-m1},
16239 @samp{cortex-m0},
16240 @samp{cortex-m0plus},
16241 @samp{cortex-m1.small-multiply},
16242 @samp{cortex-m0.small-multiply},
16243 @samp{cortex-m0plus.small-multiply},
16244 @samp{exynos-m1},
16245 @samp{marvell-pj4},
16246 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16247 @samp{fa526}, @samp{fa626},
16248 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16249 @samp{xgene1}.
16251 Additionally, this option can specify that GCC should tune the performance
16252 of the code for a big.LITTLE system.  Permissible names are:
16253 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16254 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16255 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16256 @samp{cortex-a75.cortex-a55}.
16258 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16259 performance for a blend of processors within architecture @var{arch}.
16260 The aim is to generate code that run well on the current most popular
16261 processors, balancing between optimizations that benefit some CPUs in the
16262 range, and avoiding performance pitfalls of other CPUs.  The effects of
16263 this option may change in future GCC versions as CPU models come and go.
16265 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16266 the extension options do not affect the tuning of the generated code.
16268 @option{-mtune=native} causes the compiler to auto-detect the CPU
16269 of the build computer.  At present, this feature is only supported on
16270 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16271 unsuccessful the option has no effect.
16273 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16274 @opindex mcpu
16275 This specifies the name of the target ARM processor.  GCC uses this name
16276 to derive the name of the target ARM architecture (as if specified
16277 by @option{-march}) and the ARM processor type for which to tune for
16278 performance (as if specified by @option{-mtune}).  Where this option
16279 is used in conjunction with @option{-march} or @option{-mtune},
16280 those options take precedence over the appropriate part of this option.
16282 Many of the supported CPUs implement optional architectural
16283 extensions.  Where this is so the architectural extensions are
16284 normally enabled by default.  If implementations that lack the
16285 extension exist, then the extension syntax can be used to disable
16286 those extensions that have been omitted.  For floating-point and
16287 Advanced SIMD (Neon) instructions, the settings of the options
16288 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16289 floating-point and Advanced SIMD instructions will only be used if
16290 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16291 @option{-mfpu} other than @samp{auto} will override the available
16292 floating-point and SIMD extension instructions.
16294 For example, @samp{cortex-a9} can be found in three major
16295 configurations: integer only, with just a floating-point unit or with
16296 floating-point and Advanced SIMD.  The default is to enable all the
16297 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16298 be used to disable just the SIMD or both the SIMD and floating-point
16299 instructions respectively.
16301 Permissible names for this option are the same as those for
16302 @option{-mtune}.
16304 The following extension options are common to the listed CPUs:
16306 @table @samp
16307 @item +nodsp
16308 Disable the DSP instructions on @samp{cortex-m33}.
16310 @item  +nofp
16311 Disables the floating-point instructions on @samp{arm9e},
16312 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16313 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16314 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16315 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16316 Disables the floating-point and SIMD instructions on
16317 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16318 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16319 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16320 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16321 @samp{cortex-a53} and @samp{cortex-a55}.
16323 @item +nofp.dp
16324 Disables the double-precision component of the floating-point instructions
16325 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16327 @item +nosimd
16328 Disables the SIMD (but not floating-point) instructions on
16329 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16330 and @samp{cortex-a9}.
16332 @item +crypto
16333 Enables the cryptographic instructions on @samp{cortex-a32},
16334 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16335 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16336 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16337 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16338 @samp{cortex-a75.cortex-a55}.
16339 @end table
16341 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16342 VFPv3 with 16 double-precision registers.  It supports the following
16343 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16344 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16345 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16346 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16347 @option{-march=armv7-a}.
16349 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16350 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16351 See @option{-mtune} for more information.
16353 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16354 of the build computer.  At present, this feature is only supported on
16355 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16356 is unsuccessful the option has no effect.
16358 @item -mfpu=@var{name}
16359 @opindex mfpu
16360 This specifies what floating-point hardware (or hardware emulation) is
16361 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16362 @samp{vfpv3},
16363 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16364 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16365 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16366 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16367 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16368 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16369 is an alias for @samp{vfpv2}.
16371 The setting @samp{auto} is the default and is special.  It causes the
16372 compiler to select the floating-point and Advanced SIMD instructions
16373 based on the settings of @option{-mcpu} and @option{-march}.
16375 If the selected floating-point hardware includes the NEON extension
16376 (e.g. @option{-mfpu=neon}), note that floating-point
16377 operations are not generated by GCC's auto-vectorization pass unless
16378 @option{-funsafe-math-optimizations} is also specified.  This is
16379 because NEON hardware does not fully implement the IEEE 754 standard for
16380 floating-point arithmetic (in particular denormal values are treated as
16381 zero), so the use of NEON instructions may lead to a loss of precision.
16383 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}).
16385 @item -mfp16-format=@var{name}
16386 @opindex mfp16-format
16387 Specify the format of the @code{__fp16} half-precision floating-point type.
16388 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16389 the default is @samp{none}, in which case the @code{__fp16} type is not
16390 defined.  @xref{Half-Precision}, for more information.
16392 @item -mstructure-size-boundary=@var{n}
16393 @opindex mstructure-size-boundary
16394 The sizes of all structures and unions are rounded up to a multiple
16395 of the number of bits set by this option.  Permissible values are 8, 32
16396 and 64.  The default value varies for different toolchains.  For the COFF
16397 targeted toolchain the default value is 8.  A value of 64 is only allowed
16398 if the underlying ABI supports it.
16400 Specifying a larger number can produce faster, more efficient code, but
16401 can also increase the size of the program.  Different values are potentially
16402 incompatible.  Code compiled with one value cannot necessarily expect to
16403 work with code or libraries compiled with another value, if they exchange
16404 information using structures or unions.
16406 This option is deprecated.
16408 @item -mabort-on-noreturn
16409 @opindex mabort-on-noreturn
16410 Generate a call to the function @code{abort} at the end of a
16411 @code{noreturn} function.  It is executed if the function tries to
16412 return.
16414 @item -mlong-calls
16415 @itemx -mno-long-calls
16416 @opindex mlong-calls
16417 @opindex mno-long-calls
16418 Tells the compiler to perform function calls by first loading the
16419 address of the function into a register and then performing a subroutine
16420 call on this register.  This switch is needed if the target function
16421 lies outside of the 64-megabyte addressing range of the offset-based
16422 version of subroutine call instruction.
16424 Even if this switch is enabled, not all function calls are turned
16425 into long calls.  The heuristic is that static functions, functions
16426 that have the @code{short_call} attribute, functions that are inside
16427 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16428 definitions have already been compiled within the current compilation
16429 unit are not turned into long calls.  The exceptions to this rule are
16430 that weak function definitions, functions with the @code{long_call}
16431 attribute or the @code{section} attribute, and functions that are within
16432 the scope of a @code{#pragma long_calls} directive are always
16433 turned into long calls.
16435 This feature is not enabled by default.  Specifying
16436 @option{-mno-long-calls} restores the default behavior, as does
16437 placing the function calls within the scope of a @code{#pragma
16438 long_calls_off} directive.  Note these switches have no effect on how
16439 the compiler generates code to handle function calls via function
16440 pointers.
16442 @item -msingle-pic-base
16443 @opindex msingle-pic-base
16444 Treat the register used for PIC addressing as read-only, rather than
16445 loading it in the prologue for each function.  The runtime system is
16446 responsible for initializing this register with an appropriate value
16447 before execution begins.
16449 @item -mpic-register=@var{reg}
16450 @opindex mpic-register
16451 Specify the register to be used for PIC addressing.
16452 For standard PIC base case, the default is any suitable register
16453 determined by compiler.  For single PIC base case, the default is
16454 @samp{R9} if target is EABI based or stack-checking is enabled,
16455 otherwise the default is @samp{R10}.
16457 @item -mpic-data-is-text-relative
16458 @opindex mpic-data-is-text-relative
16459 Assume that the displacement between the text and data segments is fixed
16460 at static link time.  This permits using PC-relative addressing
16461 operations to access data known to be in the data segment.  For
16462 non-VxWorks RTP targets, this option is enabled by default.  When
16463 disabled on such targets, it will enable @option{-msingle-pic-base} by
16464 default.
16466 @item -mpoke-function-name
16467 @opindex mpoke-function-name
16468 Write the name of each function into the text section, directly
16469 preceding the function prologue.  The generated code is similar to this:
16471 @smallexample
16472      t0
16473          .ascii "arm_poke_function_name", 0
16474          .align
16475      t1
16476          .word 0xff000000 + (t1 - t0)
16477      arm_poke_function_name
16478          mov     ip, sp
16479          stmfd   sp!, @{fp, ip, lr, pc@}
16480          sub     fp, ip, #4
16481 @end smallexample
16483 When performing a stack backtrace, code can inspect the value of
16484 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16485 location @code{pc - 12} and the top 8 bits are set, then we know that
16486 there is a function name embedded immediately preceding this location
16487 and has length @code{((pc[-3]) & 0xff000000)}.
16489 @item -mthumb
16490 @itemx -marm
16491 @opindex marm
16492 @opindex mthumb
16494 Select between generating code that executes in ARM and Thumb
16495 states.  The default for most configurations is to generate code
16496 that executes in ARM state, but the default can be changed by
16497 configuring GCC with the @option{--with-mode=}@var{state}
16498 configure option.
16500 You can also override the ARM and Thumb mode for each function
16501 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16502 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16504 @item -mflip-thumb 
16505 @opindex mflip-thumb
16506 Switch ARM/Thumb modes on alternating functions.
16507 This option is provided for regression testing of mixed Thumb/ARM code
16508 generation, and is not intended for ordinary use in compiling code.
16510 @item -mtpcs-frame
16511 @opindex mtpcs-frame
16512 Generate a stack frame that is compliant with the Thumb Procedure Call
16513 Standard for all non-leaf functions.  (A leaf function is one that does
16514 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16516 @item -mtpcs-leaf-frame
16517 @opindex mtpcs-leaf-frame
16518 Generate a stack frame that is compliant with the Thumb Procedure Call
16519 Standard for all leaf functions.  (A leaf function is one that does
16520 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16522 @item -mcallee-super-interworking
16523 @opindex mcallee-super-interworking
16524 Gives all externally visible functions in the file being compiled an ARM
16525 instruction set header which switches to Thumb mode before executing the
16526 rest of the function.  This allows these functions to be called from
16527 non-interworking code.  This option is not valid in AAPCS configurations
16528 because interworking is enabled by default.
16530 @item -mcaller-super-interworking
16531 @opindex mcaller-super-interworking
16532 Allows calls via function pointers (including virtual functions) to
16533 execute correctly regardless of whether the target code has been
16534 compiled for interworking or not.  There is a small overhead in the cost
16535 of executing a function pointer if this option is enabled.  This option
16536 is not valid in AAPCS configurations because interworking is enabled
16537 by default.
16539 @item -mtp=@var{name}
16540 @opindex mtp
16541 Specify the access model for the thread local storage pointer.  The valid
16542 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16543 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16544 (supported in the arm6k architecture), and @samp{auto}, which uses the
16545 best available method for the selected processor.  The default setting is
16546 @samp{auto}.
16548 @item -mtls-dialect=@var{dialect}
16549 @opindex mtls-dialect
16550 Specify the dialect to use for accessing thread local storage.  Two
16551 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16552 @samp{gnu} dialect selects the original GNU scheme for supporting
16553 local and global dynamic TLS models.  The @samp{gnu2} dialect
16554 selects the GNU descriptor scheme, which provides better performance
16555 for shared libraries.  The GNU descriptor scheme is compatible with
16556 the original scheme, but does require new assembler, linker and
16557 library support.  Initial and local exec TLS models are unaffected by
16558 this option and always use the original scheme.
16560 @item -mword-relocations
16561 @opindex mword-relocations
16562 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16563 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16564 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16565 is specified.
16567 @item -mfix-cortex-m3-ldrd
16568 @opindex mfix-cortex-m3-ldrd
16569 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16570 with overlapping destination and base registers are used.  This option avoids
16571 generating these instructions.  This option is enabled by default when
16572 @option{-mcpu=cortex-m3} is specified.
16574 @item -munaligned-access
16575 @itemx -mno-unaligned-access
16576 @opindex munaligned-access
16577 @opindex mno-unaligned-access
16578 Enables (or disables) reading and writing of 16- and 32- bit values
16579 from addresses that are not 16- or 32- bit aligned.  By default
16580 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16581 ARMv8-M Baseline architectures, and enabled for all other
16582 architectures.  If unaligned access is not enabled then words in packed
16583 data structures are accessed a byte at a time.
16585 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16586 generated object file to either true or false, depending upon the
16587 setting of this option.  If unaligned access is enabled then the
16588 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16589 defined.
16591 @item -mneon-for-64bits
16592 @opindex mneon-for-64bits
16593 Enables using Neon to handle scalar 64-bits operations. This is
16594 disabled by default since the cost of moving data from core registers
16595 to Neon is high.
16597 @item -mslow-flash-data
16598 @opindex mslow-flash-data
16599 Assume loading data from flash is slower than fetching instruction.
16600 Therefore literal load is minimized for better performance.
16601 This option is only supported when compiling for ARMv7 M-profile and
16602 off by default.
16604 @item -masm-syntax-unified
16605 @opindex masm-syntax-unified
16606 Assume inline assembler is using unified asm syntax.  The default is
16607 currently off which implies divided syntax.  This option has no impact
16608 on Thumb2. However, this may change in future releases of GCC.
16609 Divided syntax should be considered deprecated.
16611 @item -mrestrict-it
16612 @opindex mrestrict-it
16613 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16614 IT blocks can only contain a single 16-bit instruction from a select
16615 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16617 @item -mprint-tune-info
16618 @opindex mprint-tune-info
16619 Print CPU tuning information as comment in assembler file.  This is
16620 an option used only for regression testing of the compiler and not
16621 intended for ordinary use in compiling code.  This option is disabled
16622 by default.
16624 @item -mverbose-cost-dump
16625 @opindex mverbose-cost-dump
16626 Enable verbose cost model dumping in the debug dump files.  This option is
16627 provided for use in debugging the compiler.
16629 @item -mpure-code
16630 @opindex mpure-code
16631 Do not allow constant data to be placed in code sections.
16632 Additionally, when compiling for ELF object format give all text sections the
16633 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16634 is only available when generating non-pic code for M-profile targets with the
16635 MOVT instruction.
16637 @item -mcmse
16638 @opindex mcmse
16639 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16640 Development Tools Engineering Specification", which can be found on
16641 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16642 @end table
16644 @node AVR Options
16645 @subsection AVR Options
16646 @cindex AVR Options
16648 These options are defined for AVR implementations:
16650 @table @gcctabopt
16651 @item -mmcu=@var{mcu}
16652 @opindex mmcu
16653 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16655 The default for this option is@tie{}@samp{avr2}.
16657 GCC supports the following AVR devices and ISAs:
16659 @include avr-mmcu.texi
16661 @item -mabsdata
16662 @opindex mabsdata
16664 Assume that all data in static storage can be accessed by LDS / STS
16665 instructions.  This option has only an effect on reduced Tiny devices like
16666 ATtiny40.  See also the @code{absdata}
16667 @ref{AVR Variable Attributes,variable attribute}.
16669 @item -maccumulate-args
16670 @opindex maccumulate-args
16671 Accumulate outgoing function arguments and acquire/release the needed
16672 stack space for outgoing function arguments once in function
16673 prologue/epilogue.  Without this option, outgoing arguments are pushed
16674 before calling a function and popped afterwards.
16676 Popping the arguments after the function call can be expensive on
16677 AVR so that accumulating the stack space might lead to smaller
16678 executables because arguments need not be removed from the
16679 stack after such a function call.
16681 This option can lead to reduced code size for functions that perform
16682 several calls to functions that get their arguments on the stack like
16683 calls to printf-like functions.
16685 @item -mbranch-cost=@var{cost}
16686 @opindex mbranch-cost
16687 Set the branch costs for conditional branch instructions to
16688 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16689 integers. The default branch cost is 0.
16691 @item -mcall-prologues
16692 @opindex mcall-prologues
16693 Functions prologues/epilogues are expanded as calls to appropriate
16694 subroutines.  Code size is smaller.
16696 @item -mgas-isr-prologues
16697 @opindex mgas-isr-prologues
16698 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16699 instruction supported by GNU Binutils.
16700 If this option is on, the feature can still be disabled for individual
16701 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16702 function attribute.  This feature is activated per default
16703 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16704 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16706 @item -mint8
16707 @opindex mint8
16708 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16709 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16710 and @code{long long} is 4 bytes.  Please note that this option does not
16711 conform to the C standards, but it results in smaller code
16712 size.
16714 @item -mmain-is-OS_task
16715 @opindex mmain-is-OS_task
16716 Do not save registers in @code{main}.  The effect is the same like
16717 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16718 to @code{main}. It is activated per default if optimization is on.
16720 @item -mn-flash=@var{num}
16721 @opindex mn-flash
16722 Assume that the flash memory has a size of 
16723 @var{num} times 64@tie{}KiB.
16725 @item -mno-interrupts
16726 @opindex mno-interrupts
16727 Generated code is not compatible with hardware interrupts.
16728 Code size is smaller.
16730 @item -mrelax
16731 @opindex mrelax
16732 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16733 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16734 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16735 the assembler's command line and the @option{--relax} option to the
16736 linker's command line.
16738 Jump relaxing is performed by the linker because jump offsets are not
16739 known before code is located. Therefore, the assembler code generated by the
16740 compiler is the same, but the instructions in the executable may
16741 differ from instructions in the assembler code.
16743 Relaxing must be turned on if linker stubs are needed, see the
16744 section on @code{EIND} and linker stubs below.
16746 @item -mrmw
16747 @opindex mrmw
16748 Assume that the device supports the Read-Modify-Write
16749 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16751 @item -mshort-calls
16752 @opindex mshort-calls
16754 Assume that @code{RJMP} and @code{RCALL} can target the whole
16755 program memory.
16757 This option is used internally for multilib selection.  It is
16758 not an optimization option, and you don't need to set it by hand.
16760 @item -msp8
16761 @opindex msp8
16762 Treat the stack pointer register as an 8-bit register,
16763 i.e.@: assume the high byte of the stack pointer is zero.
16764 In general, you don't need to set this option by hand.
16766 This option is used internally by the compiler to select and
16767 build multilibs for architectures @code{avr2} and @code{avr25}.
16768 These architectures mix devices with and without @code{SPH}.
16769 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16770 the compiler driver adds or removes this option from the compiler
16771 proper's command line, because the compiler then knows if the device
16772 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16773 register or not.
16775 @item -mstrict-X
16776 @opindex mstrict-X
16777 Use address register @code{X} in a way proposed by the hardware.  This means
16778 that @code{X} is only used in indirect, post-increment or
16779 pre-decrement addressing.
16781 Without this option, the @code{X} register may be used in the same way
16782 as @code{Y} or @code{Z} which then is emulated by additional
16783 instructions.  
16784 For example, loading a value with @code{X+const} addressing with a
16785 small non-negative @code{const < 64} to a register @var{Rn} is
16786 performed as
16788 @example
16789 adiw r26, const   ; X += const
16790 ld   @var{Rn}, X        ; @var{Rn} = *X
16791 sbiw r26, const   ; X -= const
16792 @end example
16794 @item -mtiny-stack
16795 @opindex mtiny-stack
16796 Only change the lower 8@tie{}bits of the stack pointer.
16798 @item -mfract-convert-truncate
16799 @opindex mfract-convert-truncate
16800 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16802 @item -nodevicelib
16803 @opindex nodevicelib
16804 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16806 @item -Waddr-space-convert
16807 @opindex Waddr-space-convert
16808 Warn about conversions between address spaces in the case where the
16809 resulting address space is not contained in the incoming address space.
16811 @item -Wmisspelled-isr
16812 @opindex Wmisspelled-isr
16813 Warn if the ISR is misspelled, i.e. without __vector prefix.
16814 Enabled by default.
16815 @end table
16817 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16818 @cindex @code{EIND}
16819 Pointers in the implementation are 16@tie{}bits wide.
16820 The address of a function or label is represented as word address so
16821 that indirect jumps and calls can target any code address in the
16822 range of 64@tie{}Ki words.
16824 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16825 bytes of program memory space, there is a special function register called
16826 @code{EIND} that serves as most significant part of the target address
16827 when @code{EICALL} or @code{EIJMP} instructions are used.
16829 Indirect jumps and calls on these devices are handled as follows by
16830 the compiler and are subject to some limitations:
16832 @itemize @bullet
16834 @item
16835 The compiler never sets @code{EIND}.
16837 @item
16838 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16839 instructions or might read @code{EIND} directly in order to emulate an
16840 indirect call/jump by means of a @code{RET} instruction.
16842 @item
16843 The compiler assumes that @code{EIND} never changes during the startup
16844 code or during the application. In particular, @code{EIND} is not
16845 saved/restored in function or interrupt service routine
16846 prologue/epilogue.
16848 @item
16849 For indirect calls to functions and computed goto, the linker
16850 generates @emph{stubs}. Stubs are jump pads sometimes also called
16851 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16852 The stub contains a direct jump to the desired address.
16854 @item
16855 Linker relaxation must be turned on so that the linker generates
16856 the stubs correctly in all situations. See the compiler option
16857 @option{-mrelax} and the linker option @option{--relax}.
16858 There are corner cases where the linker is supposed to generate stubs
16859 but aborts without relaxation and without a helpful error message.
16861 @item
16862 The default linker script is arranged for code with @code{EIND = 0}.
16863 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16864 linker script has to be used in order to place the sections whose
16865 name start with @code{.trampolines} into the segment where @code{EIND}
16866 points to.
16868 @item
16869 The startup code from libgcc never sets @code{EIND}.
16870 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16871 For the impact of AVR-LibC on @code{EIND}, see the
16872 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16874 @item
16875 It is legitimate for user-specific startup code to set up @code{EIND}
16876 early, for example by means of initialization code located in
16877 section @code{.init3}. Such code runs prior to general startup code
16878 that initializes RAM and calls constructors, but after the bit
16879 of startup code from AVR-LibC that sets @code{EIND} to the segment
16880 where the vector table is located.
16881 @example
16882 #include <avr/io.h>
16884 static void
16885 __attribute__((section(".init3"),naked,used,no_instrument_function))
16886 init3_set_eind (void)
16888   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16889                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16891 @end example
16893 @noindent
16894 The @code{__trampolines_start} symbol is defined in the linker script.
16896 @item
16897 Stubs are generated automatically by the linker if
16898 the following two conditions are met:
16899 @itemize @minus
16901 @item The address of a label is taken by means of the @code{gs} modifier
16902 (short for @emph{generate stubs}) like so:
16903 @example
16904 LDI r24, lo8(gs(@var{func}))
16905 LDI r25, hi8(gs(@var{func}))
16906 @end example
16907 @item The final location of that label is in a code segment
16908 @emph{outside} the segment where the stubs are located.
16909 @end itemize
16911 @item
16912 The compiler emits such @code{gs} modifiers for code labels in the
16913 following situations:
16914 @itemize @minus
16915 @item Taking address of a function or code label.
16916 @item Computed goto.
16917 @item If prologue-save function is used, see @option{-mcall-prologues}
16918 command-line option.
16919 @item Switch/case dispatch tables. If you do not want such dispatch
16920 tables you can specify the @option{-fno-jump-tables} command-line option.
16921 @item C and C++ constructors/destructors called during startup/shutdown.
16922 @item If the tools hit a @code{gs()} modifier explained above.
16923 @end itemize
16925 @item
16926 Jumping to non-symbolic addresses like so is @emph{not} supported:
16928 @example
16929 int main (void)
16931     /* Call function at word address 0x2 */
16932     return ((int(*)(void)) 0x2)();
16934 @end example
16936 Instead, a stub has to be set up, i.e.@: the function has to be called
16937 through a symbol (@code{func_4} in the example):
16939 @example
16940 int main (void)
16942     extern int func_4 (void);
16944     /* Call function at byte address 0x4 */
16945     return func_4();
16947 @end example
16949 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16950 Alternatively, @code{func_4} can be defined in the linker script.
16951 @end itemize
16953 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16954 @cindex @code{RAMPD}
16955 @cindex @code{RAMPX}
16956 @cindex @code{RAMPY}
16957 @cindex @code{RAMPZ}
16958 Some AVR devices support memories larger than the 64@tie{}KiB range
16959 that can be accessed with 16-bit pointers.  To access memory locations
16960 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16961 register is used as high part of the address:
16962 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16963 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16964 register, respectively, to get a wide address. Similarly,
16965 @code{RAMPD} is used together with direct addressing.
16967 @itemize
16968 @item
16969 The startup code initializes the @code{RAMP} special function
16970 registers with zero.
16972 @item
16973 If a @ref{AVR Named Address Spaces,named address space} other than
16974 generic or @code{__flash} is used, then @code{RAMPZ} is set
16975 as needed before the operation.
16977 @item
16978 If the device supports RAM larger than 64@tie{}KiB and the compiler
16979 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16980 is reset to zero after the operation.
16982 @item
16983 If the device comes with a specific @code{RAMP} register, the ISR
16984 prologue/epilogue saves/restores that SFR and initializes it with
16985 zero in case the ISR code might (implicitly) use it.
16987 @item
16988 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16989 If you use inline assembler to read from locations outside the
16990 16-bit address range and change one of the @code{RAMP} registers,
16991 you must reset it to zero after the access.
16993 @end itemize
16995 @subsubsection AVR Built-in Macros
16997 GCC defines several built-in macros so that the user code can test
16998 for the presence or absence of features.  Almost any of the following
16999 built-in macros are deduced from device capabilities and thus
17000 triggered by the @option{-mmcu=} command-line option.
17002 For even more AVR-specific built-in macros see
17003 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17005 @table @code
17007 @item __AVR_ARCH__
17008 Build-in macro that resolves to a decimal number that identifies the
17009 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17010 Possible values are:
17012 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17013 @code{4}, @code{5}, @code{51}, @code{6}
17015 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17016 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17018 respectively and
17020 @code{100},
17021 @code{102}, @code{103}, @code{104},
17022 @code{105}, @code{106}, @code{107}
17024 for @var{mcu}=@code{avrtiny},
17025 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17026 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17027 If @var{mcu} specifies a device, this built-in macro is set
17028 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17029 defined to @code{4}.
17031 @item __AVR_@var{Device}__
17032 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17033 the device's name. For example, @option{-mmcu=atmega8} defines the
17034 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17035 @code{__AVR_ATtiny261A__}, etc.
17037 The built-in macros' names follow
17038 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17039 the device name as from the AVR user manual. The difference between
17040 @var{Device} in the built-in macro and @var{device} in
17041 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17043 If @var{device} is not a device but only a core architecture like
17044 @samp{avr51}, this macro is not defined.
17046 @item __AVR_DEVICE_NAME__
17047 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17048 the device's name. For example, with @option{-mmcu=atmega8} the macro
17049 is defined to @code{atmega8}.
17051 If @var{device} is not a device but only a core architecture like
17052 @samp{avr51}, this macro is not defined.
17054 @item __AVR_XMEGA__
17055 The device / architecture belongs to the XMEGA family of devices.
17057 @item __AVR_HAVE_ELPM__
17058 The device has the @code{ELPM} instruction.
17060 @item __AVR_HAVE_ELPMX__
17061 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17062 R@var{n},Z+} instructions.
17064 @item __AVR_HAVE_MOVW__
17065 The device has the @code{MOVW} instruction to perform 16-bit
17066 register-register moves.
17068 @item __AVR_HAVE_LPMX__
17069 The device has the @code{LPM R@var{n},Z} and
17070 @code{LPM R@var{n},Z+} instructions.
17072 @item __AVR_HAVE_MUL__
17073 The device has a hardware multiplier. 
17075 @item __AVR_HAVE_JMP_CALL__
17076 The device has the @code{JMP} and @code{CALL} instructions.
17077 This is the case for devices with more than 8@tie{}KiB of program
17078 memory.
17080 @item __AVR_HAVE_EIJMP_EICALL__
17081 @itemx __AVR_3_BYTE_PC__
17082 The device has the @code{EIJMP} and @code{EICALL} instructions.
17083 This is the case for devices with more than 128@tie{}KiB of program memory.
17084 This also means that the program counter
17085 (PC) is 3@tie{}bytes wide.
17087 @item __AVR_2_BYTE_PC__
17088 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17089 with up to 128@tie{}KiB of program memory.
17091 @item __AVR_HAVE_8BIT_SP__
17092 @itemx __AVR_HAVE_16BIT_SP__
17093 The stack pointer (SP) register is treated as 8-bit respectively
17094 16-bit register by the compiler.
17095 The definition of these macros is affected by @option{-mtiny-stack}.
17097 @item __AVR_HAVE_SPH__
17098 @itemx __AVR_SP8__
17099 The device has the SPH (high part of stack pointer) special function
17100 register or has an 8-bit stack pointer, respectively.
17101 The definition of these macros is affected by @option{-mmcu=} and
17102 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17103 by @option{-msp8}.
17105 @item __AVR_HAVE_RAMPD__
17106 @itemx __AVR_HAVE_RAMPX__
17107 @itemx __AVR_HAVE_RAMPY__
17108 @itemx __AVR_HAVE_RAMPZ__
17109 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17110 @code{RAMPZ} special function register, respectively.
17112 @item __NO_INTERRUPTS__
17113 This macro reflects the @option{-mno-interrupts} command-line option.
17115 @item __AVR_ERRATA_SKIP__
17116 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17117 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17118 instructions because of a hardware erratum.  Skip instructions are
17119 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17120 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17121 set.
17123 @item __AVR_ISA_RMW__
17124 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17126 @item __AVR_SFR_OFFSET__=@var{offset}
17127 Instructions that can address I/O special function registers directly
17128 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17129 address as if addressed by an instruction to access RAM like @code{LD}
17130 or @code{STS}. This offset depends on the device architecture and has
17131 to be subtracted from the RAM address in order to get the
17132 respective I/O@tie{}address.
17134 @item __AVR_SHORT_CALLS__
17135 The @option{-mshort-calls} command line option is set.
17137 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17138 Some devices support reading from flash memory by means of @code{LD*}
17139 instructions.  The flash memory is seen in the data address space
17140 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17141 is not defined, this feature is not available.  If defined,
17142 the address space is linear and there is no need to put
17143 @code{.rodata} into RAM.  This is handled by the default linker
17144 description file, and is currently available for
17145 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17146 there is no need to use address spaces like @code{__flash} or
17147 features like attribute @code{progmem} and @code{pgm_read_*}.
17149 @item __WITH_AVRLIBC__
17150 The compiler is configured to be used together with AVR-Libc.
17151 See the @option{--with-avrlibc} configure option.
17153 @end table
17155 @node Blackfin Options
17156 @subsection Blackfin Options
17157 @cindex Blackfin Options
17159 @table @gcctabopt
17160 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17161 @opindex mcpu=
17162 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17163 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17164 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17165 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17166 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17167 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17168 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17169 @samp{bf561}, @samp{bf592}.
17171 The optional @var{sirevision} specifies the silicon revision of the target
17172 Blackfin processor.  Any workarounds available for the targeted silicon revision
17173 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17174 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17175 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17176 hexadecimal digits representing the major and minor numbers in the silicon
17177 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17178 is not defined.  If @var{sirevision} is @samp{any}, the
17179 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17180 If this optional @var{sirevision} is not used, GCC assumes the latest known
17181 silicon revision of the targeted Blackfin processor.
17183 GCC defines a preprocessor macro for the specified @var{cpu}.
17184 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17185 provided by libgloss to be linked in if @option{-msim} is not given.
17187 Without this option, @samp{bf532} is used as the processor by default.
17189 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17190 only the preprocessor macro is defined.
17192 @item -msim
17193 @opindex msim
17194 Specifies that the program will be run on the simulator.  This causes
17195 the simulator BSP provided by libgloss to be linked in.  This option
17196 has effect only for @samp{bfin-elf} toolchain.
17197 Certain other options, such as @option{-mid-shared-library} and
17198 @option{-mfdpic}, imply @option{-msim}.
17200 @item -momit-leaf-frame-pointer
17201 @opindex momit-leaf-frame-pointer
17202 Don't keep the frame pointer in a register for leaf functions.  This
17203 avoids the instructions to save, set up and restore frame pointers and
17204 makes an extra register available in leaf functions.
17206 @item -mspecld-anomaly
17207 @opindex mspecld-anomaly
17208 When enabled, the compiler ensures that the generated code does not
17209 contain speculative loads after jump instructions. If this option is used,
17210 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17212 @item -mno-specld-anomaly
17213 @opindex mno-specld-anomaly
17214 Don't generate extra code to prevent speculative loads from occurring.
17216 @item -mcsync-anomaly
17217 @opindex mcsync-anomaly
17218 When enabled, the compiler ensures that the generated code does not
17219 contain CSYNC or SSYNC instructions too soon after conditional branches.
17220 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17222 @item -mno-csync-anomaly
17223 @opindex mno-csync-anomaly
17224 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17225 occurring too soon after a conditional branch.
17227 @item -mlow-64k
17228 @opindex mlow-64k
17229 When enabled, the compiler is free to take advantage of the knowledge that
17230 the entire program fits into the low 64k of memory.
17232 @item -mno-low-64k
17233 @opindex mno-low-64k
17234 Assume that the program is arbitrarily large.  This is the default.
17236 @item -mstack-check-l1
17237 @opindex mstack-check-l1
17238 Do stack checking using information placed into L1 scratchpad memory by the
17239 uClinux kernel.
17241 @item -mid-shared-library
17242 @opindex mid-shared-library
17243 Generate code that supports shared libraries via the library ID method.
17244 This allows for execute in place and shared libraries in an environment
17245 without virtual memory management.  This option implies @option{-fPIC}.
17246 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17248 @item -mno-id-shared-library
17249 @opindex mno-id-shared-library
17250 Generate code that doesn't assume ID-based shared libraries are being used.
17251 This is the default.
17253 @item -mleaf-id-shared-library
17254 @opindex mleaf-id-shared-library
17255 Generate code that supports shared libraries via the library ID method,
17256 but assumes that this library or executable won't link against any other
17257 ID shared libraries.  That allows the compiler to use faster code for jumps
17258 and calls.
17260 @item -mno-leaf-id-shared-library
17261 @opindex mno-leaf-id-shared-library
17262 Do not assume that the code being compiled won't link against any ID shared
17263 libraries.  Slower code is generated for jump and call insns.
17265 @item -mshared-library-id=n
17266 @opindex mshared-library-id
17267 Specifies the identification number of the ID-based shared library being
17268 compiled.  Specifying a value of 0 generates more compact code; specifying
17269 other values forces the allocation of that number to the current
17270 library but is no more space- or time-efficient than omitting this option.
17272 @item -msep-data
17273 @opindex msep-data
17274 Generate code that allows the data segment to be located in a different
17275 area of memory from the text segment.  This allows for execute in place in
17276 an environment without virtual memory management by eliminating relocations
17277 against the text section.
17279 @item -mno-sep-data
17280 @opindex mno-sep-data
17281 Generate code that assumes that the data segment follows the text segment.
17282 This is the default.
17284 @item -mlong-calls
17285 @itemx -mno-long-calls
17286 @opindex mlong-calls
17287 @opindex mno-long-calls
17288 Tells the compiler to perform function calls by first loading the
17289 address of the function into a register and then performing a subroutine
17290 call on this register.  This switch is needed if the target function
17291 lies outside of the 24-bit addressing range of the offset-based
17292 version of subroutine call instruction.
17294 This feature is not enabled by default.  Specifying
17295 @option{-mno-long-calls} restores the default behavior.  Note these
17296 switches have no effect on how the compiler generates code to handle
17297 function calls via function pointers.
17299 @item -mfast-fp
17300 @opindex mfast-fp
17301 Link with the fast floating-point library. This library relaxes some of
17302 the IEEE floating-point standard's rules for checking inputs against
17303 Not-a-Number (NAN), in the interest of performance.
17305 @item -minline-plt
17306 @opindex minline-plt
17307 Enable inlining of PLT entries in function calls to functions that are
17308 not known to bind locally.  It has no effect without @option{-mfdpic}.
17310 @item -mmulticore
17311 @opindex mmulticore
17312 Build a standalone application for multicore Blackfin processors. 
17313 This option causes proper start files and link scripts supporting 
17314 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17315 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17317 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17318 selects the one-application-per-core programming model.  Without
17319 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17320 programming model is used. In this model, the main function of Core B
17321 should be named as @code{coreb_main}.
17323 If this option is not used, the single-core application programming
17324 model is used.
17326 @item -mcorea
17327 @opindex mcorea
17328 Build a standalone application for Core A of BF561 when using
17329 the one-application-per-core programming model. Proper start files
17330 and link scripts are used to support Core A, and the macro
17331 @code{__BFIN_COREA} is defined.
17332 This option can only be used in conjunction with @option{-mmulticore}.
17334 @item -mcoreb
17335 @opindex mcoreb
17336 Build a standalone application for Core B of BF561 when using
17337 the one-application-per-core programming model. Proper start files
17338 and link scripts are used to support Core B, and the macro
17339 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17340 should be used instead of @code{main}. 
17341 This option can only be used in conjunction with @option{-mmulticore}.
17343 @item -msdram
17344 @opindex msdram
17345 Build a standalone application for SDRAM. Proper start files and
17346 link scripts are used to put the application into SDRAM, and the macro
17347 @code{__BFIN_SDRAM} is defined.
17348 The loader should initialize SDRAM before loading the application.
17350 @item -micplb
17351 @opindex micplb
17352 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17353 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17354 are enabled; for standalone applications the default is off.
17355 @end table
17357 @node C6X Options
17358 @subsection C6X Options
17359 @cindex C6X Options
17361 @table @gcctabopt
17362 @item -march=@var{name}
17363 @opindex march
17364 This specifies the name of the target architecture.  GCC uses this
17365 name to determine what kind of instructions it can emit when generating
17366 assembly code.  Permissible names are: @samp{c62x},
17367 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17369 @item -mbig-endian
17370 @opindex mbig-endian
17371 Generate code for a big-endian target.
17373 @item -mlittle-endian
17374 @opindex mlittle-endian
17375 Generate code for a little-endian target.  This is the default.
17377 @item -msim
17378 @opindex msim
17379 Choose startup files and linker script suitable for the simulator.
17381 @item -msdata=default
17382 @opindex msdata=default
17383 Put small global and static data in the @code{.neardata} section,
17384 which is pointed to by register @code{B14}.  Put small uninitialized
17385 global and static data in the @code{.bss} section, which is adjacent
17386 to the @code{.neardata} section.  Put small read-only data into the
17387 @code{.rodata} section.  The corresponding sections used for large
17388 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17390 @item -msdata=all
17391 @opindex msdata=all
17392 Put all data, not just small objects, into the sections reserved for
17393 small data, and use addressing relative to the @code{B14} register to
17394 access them.
17396 @item -msdata=none
17397 @opindex msdata=none
17398 Make no use of the sections reserved for small data, and use absolute
17399 addresses to access all data.  Put all initialized global and static
17400 data in the @code{.fardata} section, and all uninitialized data in the
17401 @code{.far} section.  Put all constant data into the @code{.const}
17402 section.
17403 @end table
17405 @node CRIS Options
17406 @subsection CRIS Options
17407 @cindex CRIS Options
17409 These options are defined specifically for the CRIS ports.
17411 @table @gcctabopt
17412 @item -march=@var{architecture-type}
17413 @itemx -mcpu=@var{architecture-type}
17414 @opindex march
17415 @opindex mcpu
17416 Generate code for the specified architecture.  The choices for
17417 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17418 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17419 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17420 @samp{v10}.
17422 @item -mtune=@var{architecture-type}
17423 @opindex mtune
17424 Tune to @var{architecture-type} everything applicable about the generated
17425 code, except for the ABI and the set of available instructions.  The
17426 choices for @var{architecture-type} are the same as for
17427 @option{-march=@var{architecture-type}}.
17429 @item -mmax-stack-frame=@var{n}
17430 @opindex mmax-stack-frame
17431 Warn when the stack frame of a function exceeds @var{n} bytes.
17433 @item -metrax4
17434 @itemx -metrax100
17435 @opindex metrax4
17436 @opindex metrax100
17437 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17438 @option{-march=v3} and @option{-march=v8} respectively.
17440 @item -mmul-bug-workaround
17441 @itemx -mno-mul-bug-workaround
17442 @opindex mmul-bug-workaround
17443 @opindex mno-mul-bug-workaround
17444 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17445 models where it applies.  This option is active by default.
17447 @item -mpdebug
17448 @opindex mpdebug
17449 Enable CRIS-specific verbose debug-related information in the assembly
17450 code.  This option also has the effect of turning off the @samp{#NO_APP}
17451 formatted-code indicator to the assembler at the beginning of the
17452 assembly file.
17454 @item -mcc-init
17455 @opindex mcc-init
17456 Do not use condition-code results from previous instruction; always emit
17457 compare and test instructions before use of condition codes.
17459 @item -mno-side-effects
17460 @opindex mno-side-effects
17461 Do not emit instructions with side effects in addressing modes other than
17462 post-increment.
17464 @item -mstack-align
17465 @itemx -mno-stack-align
17466 @itemx -mdata-align
17467 @itemx -mno-data-align
17468 @itemx -mconst-align
17469 @itemx -mno-const-align
17470 @opindex mstack-align
17471 @opindex mno-stack-align
17472 @opindex mdata-align
17473 @opindex mno-data-align
17474 @opindex mconst-align
17475 @opindex mno-const-align
17476 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17477 stack frame, individual data and constants to be aligned for the maximum
17478 single data access size for the chosen CPU model.  The default is to
17479 arrange for 32-bit alignment.  ABI details such as structure layout are
17480 not affected by these options.
17482 @item -m32-bit
17483 @itemx -m16-bit
17484 @itemx -m8-bit
17485 @opindex m32-bit
17486 @opindex m16-bit
17487 @opindex m8-bit
17488 Similar to the stack- data- and const-align options above, these options
17489 arrange for stack frame, writable data and constants to all be 32-bit,
17490 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17492 @item -mno-prologue-epilogue
17493 @itemx -mprologue-epilogue
17494 @opindex mno-prologue-epilogue
17495 @opindex mprologue-epilogue
17496 With @option{-mno-prologue-epilogue}, the normal function prologue and
17497 epilogue which set up the stack frame are omitted and no return
17498 instructions or return sequences are generated in the code.  Use this
17499 option only together with visual inspection of the compiled code: no
17500 warnings or errors are generated when call-saved registers must be saved,
17501 or storage for local variables needs to be allocated.
17503 @item -mno-gotplt
17504 @itemx -mgotplt
17505 @opindex mno-gotplt
17506 @opindex mgotplt
17507 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17508 instruction sequences that load addresses for functions from the PLT part
17509 of the GOT rather than (traditional on other architectures) calls to the
17510 PLT@.  The default is @option{-mgotplt}.
17512 @item -melf
17513 @opindex melf
17514 Legacy no-op option only recognized with the cris-axis-elf and
17515 cris-axis-linux-gnu targets.
17517 @item -mlinux
17518 @opindex mlinux
17519 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17521 @item -sim
17522 @opindex sim
17523 This option, recognized for the cris-axis-elf, arranges
17524 to link with input-output functions from a simulator library.  Code,
17525 initialized data and zero-initialized data are allocated consecutively.
17527 @item -sim2
17528 @opindex sim2
17529 Like @option{-sim}, but pass linker options to locate initialized data at
17530 0x40000000 and zero-initialized data at 0x80000000.
17531 @end table
17533 @node CR16 Options
17534 @subsection CR16 Options
17535 @cindex CR16 Options
17537 These options are defined specifically for the CR16 ports.
17539 @table @gcctabopt
17541 @item -mmac
17542 @opindex mmac
17543 Enable the use of multiply-accumulate instructions. Disabled by default.
17545 @item -mcr16cplus
17546 @itemx -mcr16c
17547 @opindex mcr16cplus
17548 @opindex mcr16c
17549 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17550 is default.
17552 @item -msim
17553 @opindex msim
17554 Links the library libsim.a which is in compatible with simulator. Applicable
17555 to ELF compiler only.
17557 @item -mint32
17558 @opindex mint32
17559 Choose integer type as 32-bit wide.
17561 @item -mbit-ops
17562 @opindex mbit-ops
17563 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17565 @item -mdata-model=@var{model}
17566 @opindex mdata-model
17567 Choose a data model. The choices for @var{model} are @samp{near},
17568 @samp{far} or @samp{medium}. @samp{medium} is default.
17569 However, @samp{far} is not valid with @option{-mcr16c}, as the
17570 CR16C architecture does not support the far data model.
17571 @end table
17573 @node Darwin Options
17574 @subsection Darwin Options
17575 @cindex Darwin options
17577 These options are defined for all architectures running the Darwin operating
17578 system.
17580 FSF GCC on Darwin does not create ``fat'' object files; it creates
17581 an object file for the single architecture that GCC was built to
17582 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17583 @option{-arch} options are used; it does so by running the compiler or
17584 linker multiple times and joining the results together with
17585 @file{lipo}.
17587 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17588 @samp{i686}) is determined by the flags that specify the ISA
17589 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17590 @option{-force_cpusubtype_ALL} option can be used to override this.
17592 The Darwin tools vary in their behavior when presented with an ISA
17593 mismatch.  The assembler, @file{as}, only permits instructions to
17594 be used that are valid for the subtype of the file it is generating,
17595 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17596 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17597 and prints an error if asked to create a shared library with a less
17598 restrictive subtype than its input files (for instance, trying to put
17599 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17600 for executables, @command{ld}, quietly gives the executable the most
17601 restrictive subtype of any of its input files.
17603 @table @gcctabopt
17604 @item -F@var{dir}
17605 @opindex F
17606 Add the framework directory @var{dir} to the head of the list of
17607 directories to be searched for header files.  These directories are
17608 interleaved with those specified by @option{-I} options and are
17609 scanned in a left-to-right order.
17611 A framework directory is a directory with frameworks in it.  A
17612 framework is a directory with a @file{Headers} and/or
17613 @file{PrivateHeaders} directory contained directly in it that ends
17614 in @file{.framework}.  The name of a framework is the name of this
17615 directory excluding the @file{.framework}.  Headers associated with
17616 the framework are found in one of those two directories, with
17617 @file{Headers} being searched first.  A subframework is a framework
17618 directory that is in a framework's @file{Frameworks} directory.
17619 Includes of subframework headers can only appear in a header of a
17620 framework that contains the subframework, or in a sibling subframework
17621 header.  Two subframeworks are siblings if they occur in the same
17622 framework.  A subframework should not have the same name as a
17623 framework; a warning is issued if this is violated.  Currently a
17624 subframework cannot have subframeworks; in the future, the mechanism
17625 may be extended to support this.  The standard frameworks can be found
17626 in @file{/System/Library/Frameworks} and
17627 @file{/Library/Frameworks}.  An example include looks like
17628 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17629 the name of the framework and @file{header.h} is found in the
17630 @file{PrivateHeaders} or @file{Headers} directory.
17632 @item -iframework@var{dir}
17633 @opindex iframework
17634 Like @option{-F} except the directory is a treated as a system
17635 directory.  The main difference between this @option{-iframework} and
17636 @option{-F} is that with @option{-iframework} the compiler does not
17637 warn about constructs contained within header files found via
17638 @var{dir}.  This option is valid only for the C family of languages.
17640 @item -gused
17641 @opindex gused
17642 Emit debugging information for symbols that are used.  For stabs
17643 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17644 This is by default ON@.
17646 @item -gfull
17647 @opindex gfull
17648 Emit debugging information for all symbols and types.
17650 @item -mmacosx-version-min=@var{version}
17651 The earliest version of MacOS X that this executable will run on
17652 is @var{version}.  Typical values of @var{version} include @code{10.1},
17653 @code{10.2}, and @code{10.3.9}.
17655 If the compiler was built to use the system's headers by default,
17656 then the default for this option is the system version on which the
17657 compiler is running, otherwise the default is to make choices that
17658 are compatible with as many systems and code bases as possible.
17660 @item -mkernel
17661 @opindex mkernel
17662 Enable kernel development mode.  The @option{-mkernel} option sets
17663 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17664 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17665 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17666 applicable.  This mode also sets @option{-mno-altivec},
17667 @option{-msoft-float}, @option{-fno-builtin} and
17668 @option{-mlong-branch} for PowerPC targets.
17670 @item -mone-byte-bool
17671 @opindex mone-byte-bool
17672 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17673 By default @code{sizeof(bool)} is @code{4} when compiling for
17674 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17675 option has no effect on x86.
17677 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17678 to generate code that is not binary compatible with code generated
17679 without that switch.  Using this switch may require recompiling all
17680 other modules in a program, including system libraries.  Use this
17681 switch to conform to a non-default data model.
17683 @item -mfix-and-continue
17684 @itemx -ffix-and-continue
17685 @itemx -findirect-data
17686 @opindex mfix-and-continue
17687 @opindex ffix-and-continue
17688 @opindex findirect-data
17689 Generate code suitable for fast turnaround development, such as to
17690 allow GDB to dynamically load @file{.o} files into already-running
17691 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17692 are provided for backwards compatibility.
17694 @item -all_load
17695 @opindex all_load
17696 Loads all members of static archive libraries.
17697 See man ld(1) for more information.
17699 @item -arch_errors_fatal
17700 @opindex arch_errors_fatal
17701 Cause the errors having to do with files that have the wrong architecture
17702 to be fatal.
17704 @item -bind_at_load
17705 @opindex bind_at_load
17706 Causes the output file to be marked such that the dynamic linker will
17707 bind all undefined references when the file is loaded or launched.
17709 @item -bundle
17710 @opindex bundle
17711 Produce a Mach-o bundle format file.
17712 See man ld(1) for more information.
17714 @item -bundle_loader @var{executable}
17715 @opindex bundle_loader
17716 This option specifies the @var{executable} that will load the build
17717 output file being linked.  See man ld(1) for more information.
17719 @item -dynamiclib
17720 @opindex dynamiclib
17721 When passed this option, GCC produces a dynamic library instead of
17722 an executable when linking, using the Darwin @file{libtool} command.
17724 @item -force_cpusubtype_ALL
17725 @opindex force_cpusubtype_ALL
17726 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17727 one controlled by the @option{-mcpu} or @option{-march} option.
17729 @item -allowable_client  @var{client_name}
17730 @itemx -client_name
17731 @itemx -compatibility_version
17732 @itemx -current_version
17733 @itemx -dead_strip
17734 @itemx -dependency-file
17735 @itemx -dylib_file
17736 @itemx -dylinker_install_name
17737 @itemx -dynamic
17738 @itemx -exported_symbols_list
17739 @itemx -filelist
17740 @need 800
17741 @itemx -flat_namespace
17742 @itemx -force_flat_namespace
17743 @itemx -headerpad_max_install_names
17744 @itemx -image_base
17745 @itemx -init
17746 @itemx -install_name
17747 @itemx -keep_private_externs
17748 @itemx -multi_module
17749 @itemx -multiply_defined
17750 @itemx -multiply_defined_unused
17751 @need 800
17752 @itemx -noall_load
17753 @itemx -no_dead_strip_inits_and_terms
17754 @itemx -nofixprebinding
17755 @itemx -nomultidefs
17756 @itemx -noprebind
17757 @itemx -noseglinkedit
17758 @itemx -pagezero_size
17759 @itemx -prebind
17760 @itemx -prebind_all_twolevel_modules
17761 @itemx -private_bundle
17762 @need 800
17763 @itemx -read_only_relocs
17764 @itemx -sectalign
17765 @itemx -sectobjectsymbols
17766 @itemx -whyload
17767 @itemx -seg1addr
17768 @itemx -sectcreate
17769 @itemx -sectobjectsymbols
17770 @itemx -sectorder
17771 @itemx -segaddr
17772 @itemx -segs_read_only_addr
17773 @need 800
17774 @itemx -segs_read_write_addr
17775 @itemx -seg_addr_table
17776 @itemx -seg_addr_table_filename
17777 @itemx -seglinkedit
17778 @itemx -segprot
17779 @itemx -segs_read_only_addr
17780 @itemx -segs_read_write_addr
17781 @itemx -single_module
17782 @itemx -static
17783 @itemx -sub_library
17784 @need 800
17785 @itemx -sub_umbrella
17786 @itemx -twolevel_namespace
17787 @itemx -umbrella
17788 @itemx -undefined
17789 @itemx -unexported_symbols_list
17790 @itemx -weak_reference_mismatches
17791 @itemx -whatsloaded
17792 @opindex allowable_client
17793 @opindex client_name
17794 @opindex compatibility_version
17795 @opindex current_version
17796 @opindex dead_strip
17797 @opindex dependency-file
17798 @opindex dylib_file
17799 @opindex dylinker_install_name
17800 @opindex dynamic
17801 @opindex exported_symbols_list
17802 @opindex filelist
17803 @opindex flat_namespace
17804 @opindex force_flat_namespace
17805 @opindex headerpad_max_install_names
17806 @opindex image_base
17807 @opindex init
17808 @opindex install_name
17809 @opindex keep_private_externs
17810 @opindex multi_module
17811 @opindex multiply_defined
17812 @opindex multiply_defined_unused
17813 @opindex noall_load
17814 @opindex no_dead_strip_inits_and_terms
17815 @opindex nofixprebinding
17816 @opindex nomultidefs
17817 @opindex noprebind
17818 @opindex noseglinkedit
17819 @opindex pagezero_size
17820 @opindex prebind
17821 @opindex prebind_all_twolevel_modules
17822 @opindex private_bundle
17823 @opindex read_only_relocs
17824 @opindex sectalign
17825 @opindex sectobjectsymbols
17826 @opindex whyload
17827 @opindex seg1addr
17828 @opindex sectcreate
17829 @opindex sectobjectsymbols
17830 @opindex sectorder
17831 @opindex segaddr
17832 @opindex segs_read_only_addr
17833 @opindex segs_read_write_addr
17834 @opindex seg_addr_table
17835 @opindex seg_addr_table_filename
17836 @opindex seglinkedit
17837 @opindex segprot
17838 @opindex segs_read_only_addr
17839 @opindex segs_read_write_addr
17840 @opindex single_module
17841 @opindex static
17842 @opindex sub_library
17843 @opindex sub_umbrella
17844 @opindex twolevel_namespace
17845 @opindex umbrella
17846 @opindex undefined
17847 @opindex unexported_symbols_list
17848 @opindex weak_reference_mismatches
17849 @opindex whatsloaded
17850 These options are passed to the Darwin linker.  The Darwin linker man page
17851 describes them in detail.
17852 @end table
17854 @node DEC Alpha Options
17855 @subsection DEC Alpha Options
17857 These @samp{-m} options are defined for the DEC Alpha implementations:
17859 @table @gcctabopt
17860 @item -mno-soft-float
17861 @itemx -msoft-float
17862 @opindex mno-soft-float
17863 @opindex msoft-float
17864 Use (do not use) the hardware floating-point instructions for
17865 floating-point operations.  When @option{-msoft-float} is specified,
17866 functions in @file{libgcc.a} are used to perform floating-point
17867 operations.  Unless they are replaced by routines that emulate the
17868 floating-point operations, or compiled in such a way as to call such
17869 emulations routines, these routines issue floating-point
17870 operations.   If you are compiling for an Alpha without floating-point
17871 operations, you must ensure that the library is built so as not to call
17872 them.
17874 Note that Alpha implementations without floating-point operations are
17875 required to have floating-point registers.
17877 @item -mfp-reg
17878 @itemx -mno-fp-regs
17879 @opindex mfp-reg
17880 @opindex mno-fp-regs
17881 Generate code that uses (does not use) the floating-point register set.
17882 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17883 register set is not used, floating-point operands are passed in integer
17884 registers as if they were integers and floating-point results are passed
17885 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17886 so any function with a floating-point argument or return value called by code
17887 compiled with @option{-mno-fp-regs} must also be compiled with that
17888 option.
17890 A typical use of this option is building a kernel that does not use,
17891 and hence need not save and restore, any floating-point registers.
17893 @item -mieee
17894 @opindex mieee
17895 The Alpha architecture implements floating-point hardware optimized for
17896 maximum performance.  It is mostly compliant with the IEEE floating-point
17897 standard.  However, for full compliance, software assistance is
17898 required.  This option generates code fully IEEE-compliant code
17899 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17900 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17901 defined during compilation.  The resulting code is less efficient but is
17902 able to correctly support denormalized numbers and exceptional IEEE
17903 values such as not-a-number and plus/minus infinity.  Other Alpha
17904 compilers call this option @option{-ieee_with_no_inexact}.
17906 @item -mieee-with-inexact
17907 @opindex mieee-with-inexact
17908 This is like @option{-mieee} except the generated code also maintains
17909 the IEEE @var{inexact-flag}.  Turning on this option causes the
17910 generated code to implement fully-compliant IEEE math.  In addition to
17911 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17912 macro.  On some Alpha implementations the resulting code may execute
17913 significantly slower than the code generated by default.  Since there is
17914 very little code that depends on the @var{inexact-flag}, you should
17915 normally not specify this option.  Other Alpha compilers call this
17916 option @option{-ieee_with_inexact}.
17918 @item -mfp-trap-mode=@var{trap-mode}
17919 @opindex mfp-trap-mode
17920 This option controls what floating-point related traps are enabled.
17921 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17922 The trap mode can be set to one of four values:
17924 @table @samp
17925 @item n
17926 This is the default (normal) setting.  The only traps that are enabled
17927 are the ones that cannot be disabled in software (e.g., division by zero
17928 trap).
17930 @item u
17931 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17932 as well.
17934 @item su
17935 Like @samp{u}, but the instructions are marked to be safe for software
17936 completion (see Alpha architecture manual for details).
17938 @item sui
17939 Like @samp{su}, but inexact traps are enabled as well.
17940 @end table
17942 @item -mfp-rounding-mode=@var{rounding-mode}
17943 @opindex mfp-rounding-mode
17944 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17945 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17948 @table @samp
17949 @item n
17950 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17951 the nearest machine number or towards the even machine number in case
17952 of a tie.
17954 @item m
17955 Round towards minus infinity.
17957 @item c
17958 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17960 @item d
17961 Dynamic rounding mode.  A field in the floating-point control register
17962 (@var{fpcr}, see Alpha architecture reference manual) controls the
17963 rounding mode in effect.  The C library initializes this register for
17964 rounding towards plus infinity.  Thus, unless your program modifies the
17965 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17966 @end table
17968 @item -mtrap-precision=@var{trap-precision}
17969 @opindex mtrap-precision
17970 In the Alpha architecture, floating-point traps are imprecise.  This
17971 means without software assistance it is impossible to recover from a
17972 floating trap and program execution normally needs to be terminated.
17973 GCC can generate code that can assist operating system trap handlers
17974 in determining the exact location that caused a floating-point trap.
17975 Depending on the requirements of an application, different levels of
17976 precisions can be selected:
17978 @table @samp
17979 @item p
17980 Program precision.  This option is the default and means a trap handler
17981 can only identify which program caused a floating-point exception.
17983 @item f
17984 Function precision.  The trap handler can determine the function that
17985 caused a floating-point exception.
17987 @item i
17988 Instruction precision.  The trap handler can determine the exact
17989 instruction that caused a floating-point exception.
17990 @end table
17992 Other Alpha compilers provide the equivalent options called
17993 @option{-scope_safe} and @option{-resumption_safe}.
17995 @item -mieee-conformant
17996 @opindex mieee-conformant
17997 This option marks the generated code as IEEE conformant.  You must not
17998 use this option unless you also specify @option{-mtrap-precision=i} and either
17999 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18000 is to emit the line @samp{.eflag 48} in the function prologue of the
18001 generated assembly file.
18003 @item -mbuild-constants
18004 @opindex mbuild-constants
18005 Normally GCC examines a 32- or 64-bit integer constant to
18006 see if it can construct it from smaller constants in two or three
18007 instructions.  If it cannot, it outputs the constant as a literal and
18008 generates code to load it from the data segment at run time.
18010 Use this option to require GCC to construct @emph{all} integer constants
18011 using code, even if it takes more instructions (the maximum is six).
18013 You typically use this option to build a shared library dynamic
18014 loader.  Itself a shared library, it must relocate itself in memory
18015 before it can find the variables and constants in its own data segment.
18017 @item -mbwx
18018 @itemx -mno-bwx
18019 @itemx -mcix
18020 @itemx -mno-cix
18021 @itemx -mfix
18022 @itemx -mno-fix
18023 @itemx -mmax
18024 @itemx -mno-max
18025 @opindex mbwx
18026 @opindex mno-bwx
18027 @opindex mcix
18028 @opindex mno-cix
18029 @opindex mfix
18030 @opindex mno-fix
18031 @opindex mmax
18032 @opindex mno-max
18033 Indicate whether GCC should generate code to use the optional BWX,
18034 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18035 sets supported by the CPU type specified via @option{-mcpu=} option or that
18036 of the CPU on which GCC was built if none is specified.
18038 @item -mfloat-vax
18039 @itemx -mfloat-ieee
18040 @opindex mfloat-vax
18041 @opindex mfloat-ieee
18042 Generate code that uses (does not use) VAX F and G floating-point
18043 arithmetic instead of IEEE single and double precision.
18045 @item -mexplicit-relocs
18046 @itemx -mno-explicit-relocs
18047 @opindex mexplicit-relocs
18048 @opindex mno-explicit-relocs
18049 Older Alpha assemblers provided no way to generate symbol relocations
18050 except via assembler macros.  Use of these macros does not allow
18051 optimal instruction scheduling.  GNU binutils as of version 2.12
18052 supports a new syntax that allows the compiler to explicitly mark
18053 which relocations should apply to which instructions.  This option
18054 is mostly useful for debugging, as GCC detects the capabilities of
18055 the assembler when it is built and sets the default accordingly.
18057 @item -msmall-data
18058 @itemx -mlarge-data
18059 @opindex msmall-data
18060 @opindex mlarge-data
18061 When @option{-mexplicit-relocs} is in effect, static data is
18062 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18063 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18064 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18065 16-bit relocations off of the @code{$gp} register.  This limits the
18066 size of the small data area to 64KB, but allows the variables to be
18067 directly accessed via a single instruction.
18069 The default is @option{-mlarge-data}.  With this option the data area
18070 is limited to just below 2GB@.  Programs that require more than 2GB of
18071 data must use @code{malloc} or @code{mmap} to allocate the data in the
18072 heap instead of in the program's data segment.
18074 When generating code for shared libraries, @option{-fpic} implies
18075 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18077 @item -msmall-text
18078 @itemx -mlarge-text
18079 @opindex msmall-text
18080 @opindex mlarge-text
18081 When @option{-msmall-text} is used, the compiler assumes that the
18082 code of the entire program (or shared library) fits in 4MB, and is
18083 thus reachable with a branch instruction.  When @option{-msmall-data}
18084 is used, the compiler can assume that all local symbols share the
18085 same @code{$gp} value, and thus reduce the number of instructions
18086 required for a function call from 4 to 1.
18088 The default is @option{-mlarge-text}.
18090 @item -mcpu=@var{cpu_type}
18091 @opindex mcpu
18092 Set the instruction set and instruction scheduling parameters for
18093 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18094 style name or the corresponding chip number.  GCC supports scheduling
18095 parameters for the EV4, EV5 and EV6 family of processors and
18096 chooses the default values for the instruction set from the processor
18097 you specify.  If you do not specify a processor type, GCC defaults
18098 to the processor on which the compiler was built.
18100 Supported values for @var{cpu_type} are
18102 @table @samp
18103 @item ev4
18104 @itemx ev45
18105 @itemx 21064
18106 Schedules as an EV4 and has no instruction set extensions.
18108 @item ev5
18109 @itemx 21164
18110 Schedules as an EV5 and has no instruction set extensions.
18112 @item ev56
18113 @itemx 21164a
18114 Schedules as an EV5 and supports the BWX extension.
18116 @item pca56
18117 @itemx 21164pc
18118 @itemx 21164PC
18119 Schedules as an EV5 and supports the BWX and MAX extensions.
18121 @item ev6
18122 @itemx 21264
18123 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18125 @item ev67
18126 @itemx 21264a
18127 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18128 @end table
18130 Native toolchains also support the value @samp{native},
18131 which selects the best architecture option for the host processor.
18132 @option{-mcpu=native} has no effect if GCC does not recognize
18133 the processor.
18135 @item -mtune=@var{cpu_type}
18136 @opindex mtune
18137 Set only the instruction scheduling parameters for machine type
18138 @var{cpu_type}.  The instruction set is not changed.
18140 Native toolchains also support the value @samp{native},
18141 which selects the best architecture option for the host processor.
18142 @option{-mtune=native} has no effect if GCC does not recognize
18143 the processor.
18145 @item -mmemory-latency=@var{time}
18146 @opindex mmemory-latency
18147 Sets the latency the scheduler should assume for typical memory
18148 references as seen by the application.  This number is highly
18149 dependent on the memory access patterns used by the application
18150 and the size of the external cache on the machine.
18152 Valid options for @var{time} are
18154 @table @samp
18155 @item @var{number}
18156 A decimal number representing clock cycles.
18158 @item L1
18159 @itemx L2
18160 @itemx L3
18161 @itemx main
18162 The compiler contains estimates of the number of clock cycles for
18163 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18164 (also called Dcache, Scache, and Bcache), as well as to main memory.
18165 Note that L3 is only valid for EV5.
18167 @end table
18168 @end table
18170 @node FR30 Options
18171 @subsection FR30 Options
18172 @cindex FR30 Options
18174 These options are defined specifically for the FR30 port.
18176 @table @gcctabopt
18178 @item -msmall-model
18179 @opindex msmall-model
18180 Use the small address space model.  This can produce smaller code, but
18181 it does assume that all symbolic values and addresses fit into a
18182 20-bit range.
18184 @item -mno-lsim
18185 @opindex mno-lsim
18186 Assume that runtime support has been provided and so there is no need
18187 to include the simulator library (@file{libsim.a}) on the linker
18188 command line.
18190 @end table
18192 @node FT32 Options
18193 @subsection FT32 Options
18194 @cindex FT32 Options
18196 These options are defined specifically for the FT32 port.
18198 @table @gcctabopt
18200 @item -msim
18201 @opindex msim
18202 Specifies that the program will be run on the simulator.  This causes
18203 an alternate runtime startup and library to be linked.
18204 You must not use this option when generating programs that will run on
18205 real hardware; you must provide your own runtime library for whatever
18206 I/O functions are needed.
18208 @item -mlra
18209 @opindex mlra
18210 Enable Local Register Allocation.  This is still experimental for FT32,
18211 so by default the compiler uses standard reload.
18213 @item -mnodiv
18214 @opindex mnodiv
18215 Do not use div and mod instructions.
18217 @item -mft32b
18218 @opindex mft32b
18219 Enable use of the extended instructions of the FT32B processor.
18221 @item -mcompress
18222 @opindex mcompress
18223 Compress all code using the Ft32B code compression scheme.
18225 @item -mnopm
18226 @opindex  mnopm
18227 Do not generate code that reads program memory.
18229 @end table
18231 @node FRV Options
18232 @subsection FRV Options
18233 @cindex FRV Options
18235 @table @gcctabopt
18236 @item -mgpr-32
18237 @opindex mgpr-32
18239 Only use the first 32 general-purpose registers.
18241 @item -mgpr-64
18242 @opindex mgpr-64
18244 Use all 64 general-purpose registers.
18246 @item -mfpr-32
18247 @opindex mfpr-32
18249 Use only the first 32 floating-point registers.
18251 @item -mfpr-64
18252 @opindex mfpr-64
18254 Use all 64 floating-point registers.
18256 @item -mhard-float
18257 @opindex mhard-float
18259 Use hardware instructions for floating-point operations.
18261 @item -msoft-float
18262 @opindex msoft-float
18264 Use library routines for floating-point operations.
18266 @item -malloc-cc
18267 @opindex malloc-cc
18269 Dynamically allocate condition code registers.
18271 @item -mfixed-cc
18272 @opindex mfixed-cc
18274 Do not try to dynamically allocate condition code registers, only
18275 use @code{icc0} and @code{fcc0}.
18277 @item -mdword
18278 @opindex mdword
18280 Change ABI to use double word insns.
18282 @item -mno-dword
18283 @opindex mno-dword
18285 Do not use double word instructions.
18287 @item -mdouble
18288 @opindex mdouble
18290 Use floating-point double instructions.
18292 @item -mno-double
18293 @opindex mno-double
18295 Do not use floating-point double instructions.
18297 @item -mmedia
18298 @opindex mmedia
18300 Use media instructions.
18302 @item -mno-media
18303 @opindex mno-media
18305 Do not use media instructions.
18307 @item -mmuladd
18308 @opindex mmuladd
18310 Use multiply and add/subtract instructions.
18312 @item -mno-muladd
18313 @opindex mno-muladd
18315 Do not use multiply and add/subtract instructions.
18317 @item -mfdpic
18318 @opindex mfdpic
18320 Select the FDPIC ABI, which uses function descriptors to represent
18321 pointers to functions.  Without any PIC/PIE-related options, it
18322 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18323 assumes GOT entries and small data are within a 12-bit range from the
18324 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18325 are computed with 32 bits.
18326 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18328 @item -minline-plt
18329 @opindex minline-plt
18331 Enable inlining of PLT entries in function calls to functions that are
18332 not known to bind locally.  It has no effect without @option{-mfdpic}.
18333 It's enabled by default if optimizing for speed and compiling for
18334 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18335 optimization option such as @option{-O3} or above is present in the
18336 command line.
18338 @item -mTLS
18339 @opindex mTLS
18341 Assume a large TLS segment when generating thread-local code.
18343 @item -mtls
18344 @opindex mtls
18346 Do not assume a large TLS segment when generating thread-local code.
18348 @item -mgprel-ro
18349 @opindex mgprel-ro
18351 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18352 that is known to be in read-only sections.  It's enabled by default,
18353 except for @option{-fpic} or @option{-fpie}: even though it may help
18354 make the global offset table smaller, it trades 1 instruction for 4.
18355 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18356 one of which may be shared by multiple symbols, and it avoids the need
18357 for a GOT entry for the referenced symbol, so it's more likely to be a
18358 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18360 @item -multilib-library-pic
18361 @opindex multilib-library-pic
18363 Link with the (library, not FD) pic libraries.  It's implied by
18364 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18365 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18366 it explicitly.
18368 @item -mlinked-fp
18369 @opindex mlinked-fp
18371 Follow the EABI requirement of always creating a frame pointer whenever
18372 a stack frame is allocated.  This option is enabled by default and can
18373 be disabled with @option{-mno-linked-fp}.
18375 @item -mlong-calls
18376 @opindex mlong-calls
18378 Use indirect addressing to call functions outside the current
18379 compilation unit.  This allows the functions to be placed anywhere
18380 within the 32-bit address space.
18382 @item -malign-labels
18383 @opindex malign-labels
18385 Try to align labels to an 8-byte boundary by inserting NOPs into the
18386 previous packet.  This option only has an effect when VLIW packing
18387 is enabled.  It doesn't create new packets; it merely adds NOPs to
18388 existing ones.
18390 @item -mlibrary-pic
18391 @opindex mlibrary-pic
18393 Generate position-independent EABI code.
18395 @item -macc-4
18396 @opindex macc-4
18398 Use only the first four media accumulator registers.
18400 @item -macc-8
18401 @opindex macc-8
18403 Use all eight media accumulator registers.
18405 @item -mpack
18406 @opindex mpack
18408 Pack VLIW instructions.
18410 @item -mno-pack
18411 @opindex mno-pack
18413 Do not pack VLIW instructions.
18415 @item -mno-eflags
18416 @opindex mno-eflags
18418 Do not mark ABI switches in e_flags.
18420 @item -mcond-move
18421 @opindex mcond-move
18423 Enable the use of conditional-move instructions (default).
18425 This switch is mainly for debugging the compiler and will likely be removed
18426 in a future version.
18428 @item -mno-cond-move
18429 @opindex mno-cond-move
18431 Disable the use of conditional-move instructions.
18433 This switch is mainly for debugging the compiler and will likely be removed
18434 in a future version.
18436 @item -mscc
18437 @opindex mscc
18439 Enable the use of conditional set instructions (default).
18441 This switch is mainly for debugging the compiler and will likely be removed
18442 in a future version.
18444 @item -mno-scc
18445 @opindex mno-scc
18447 Disable the use of conditional set instructions.
18449 This switch is mainly for debugging the compiler and will likely be removed
18450 in a future version.
18452 @item -mcond-exec
18453 @opindex mcond-exec
18455 Enable the use of conditional execution (default).
18457 This switch is mainly for debugging the compiler and will likely be removed
18458 in a future version.
18460 @item -mno-cond-exec
18461 @opindex mno-cond-exec
18463 Disable the use of conditional execution.
18465 This switch is mainly for debugging the compiler and will likely be removed
18466 in a future version.
18468 @item -mvliw-branch
18469 @opindex mvliw-branch
18471 Run a pass to pack branches into VLIW instructions (default).
18473 This switch is mainly for debugging the compiler and will likely be removed
18474 in a future version.
18476 @item -mno-vliw-branch
18477 @opindex mno-vliw-branch
18479 Do not run a pass to pack branches into VLIW instructions.
18481 This switch is mainly for debugging the compiler and will likely be removed
18482 in a future version.
18484 @item -mmulti-cond-exec
18485 @opindex mmulti-cond-exec
18487 Enable optimization of @code{&&} and @code{||} in conditional execution
18488 (default).
18490 This switch is mainly for debugging the compiler and will likely be removed
18491 in a future version.
18493 @item -mno-multi-cond-exec
18494 @opindex mno-multi-cond-exec
18496 Disable optimization of @code{&&} and @code{||} in conditional execution.
18498 This switch is mainly for debugging the compiler and will likely be removed
18499 in a future version.
18501 @item -mnested-cond-exec
18502 @opindex mnested-cond-exec
18504 Enable nested conditional execution optimizations (default).
18506 This switch is mainly for debugging the compiler and will likely be removed
18507 in a future version.
18509 @item -mno-nested-cond-exec
18510 @opindex mno-nested-cond-exec
18512 Disable nested conditional execution optimizations.
18514 This switch is mainly for debugging the compiler and will likely be removed
18515 in a future version.
18517 @item -moptimize-membar
18518 @opindex moptimize-membar
18520 This switch removes redundant @code{membar} instructions from the
18521 compiler-generated code.  It is enabled by default.
18523 @item -mno-optimize-membar
18524 @opindex mno-optimize-membar
18526 This switch disables the automatic removal of redundant @code{membar}
18527 instructions from the generated code.
18529 @item -mtomcat-stats
18530 @opindex mtomcat-stats
18532 Cause gas to print out tomcat statistics.
18534 @item -mcpu=@var{cpu}
18535 @opindex mcpu
18537 Select the processor type for which to generate code.  Possible values are
18538 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18539 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18541 @end table
18543 @node GNU/Linux Options
18544 @subsection GNU/Linux Options
18546 These @samp{-m} options are defined for GNU/Linux targets:
18548 @table @gcctabopt
18549 @item -mglibc
18550 @opindex mglibc
18551 Use the GNU C library.  This is the default except
18552 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18553 @samp{*-*-linux-*android*} targets.
18555 @item -muclibc
18556 @opindex muclibc
18557 Use uClibc C library.  This is the default on
18558 @samp{*-*-linux-*uclibc*} targets.
18560 @item -mmusl
18561 @opindex mmusl
18562 Use the musl C library.  This is the default on
18563 @samp{*-*-linux-*musl*} targets.
18565 @item -mbionic
18566 @opindex mbionic
18567 Use Bionic C library.  This is the default on
18568 @samp{*-*-linux-*android*} targets.
18570 @item -mandroid
18571 @opindex mandroid
18572 Compile code compatible with Android platform.  This is the default on
18573 @samp{*-*-linux-*android*} targets.
18575 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18576 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18577 this option makes the GCC driver pass Android-specific options to the linker.
18578 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18579 to be defined.
18581 @item -tno-android-cc
18582 @opindex tno-android-cc
18583 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18584 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18585 @option{-fno-rtti} by default.
18587 @item -tno-android-ld
18588 @opindex tno-android-ld
18589 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18590 linking options to the linker.
18592 @end table
18594 @node H8/300 Options
18595 @subsection H8/300 Options
18597 These @samp{-m} options are defined for the H8/300 implementations:
18599 @table @gcctabopt
18600 @item -mrelax
18601 @opindex mrelax
18602 Shorten some address references at link time, when possible; uses the
18603 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18604 ld, Using ld}, for a fuller description.
18606 @item -mh
18607 @opindex mh
18608 Generate code for the H8/300H@.
18610 @item -ms
18611 @opindex ms
18612 Generate code for the H8S@.
18614 @item -mn
18615 @opindex mn
18616 Generate code for the H8S and H8/300H in the normal mode.  This switch
18617 must be used either with @option{-mh} or @option{-ms}.
18619 @item -ms2600
18620 @opindex ms2600
18621 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18623 @item -mexr
18624 @opindex mexr
18625 Extended registers are stored on stack before execution of function
18626 with monitor attribute. Default option is @option{-mexr}.
18627 This option is valid only for H8S targets.
18629 @item -mno-exr
18630 @opindex mno-exr
18631 Extended registers are not stored on stack before execution of function 
18632 with monitor attribute. Default option is @option{-mno-exr}. 
18633 This option is valid only for H8S targets.
18635 @item -mint32
18636 @opindex mint32
18637 Make @code{int} data 32 bits by default.
18639 @item -malign-300
18640 @opindex malign-300
18641 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18642 The default for the H8/300H and H8S is to align longs and floats on
18643 4-byte boundaries.
18644 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18645 This option has no effect on the H8/300.
18646 @end table
18648 @node HPPA Options
18649 @subsection HPPA Options
18650 @cindex HPPA Options
18652 These @samp{-m} options are defined for the HPPA family of computers:
18654 @table @gcctabopt
18655 @item -march=@var{architecture-type}
18656 @opindex march
18657 Generate code for the specified architecture.  The choices for
18658 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18659 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18660 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18661 architecture option for your machine.  Code compiled for lower numbered
18662 architectures runs on higher numbered architectures, but not the
18663 other way around.
18665 @item -mpa-risc-1-0
18666 @itemx -mpa-risc-1-1
18667 @itemx -mpa-risc-2-0
18668 @opindex mpa-risc-1-0
18669 @opindex mpa-risc-1-1
18670 @opindex mpa-risc-2-0
18671 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18673 @item -mcaller-copies
18674 @opindex mcaller-copies
18675 The caller copies function arguments passed by hidden reference.  This
18676 option should be used with care as it is not compatible with the default
18677 32-bit runtime.  However, only aggregates larger than eight bytes are
18678 passed by hidden reference and the option provides better compatibility
18679 with OpenMP.
18681 @item -mjump-in-delay
18682 @opindex mjump-in-delay
18683 This option is ignored and provided for compatibility purposes only.
18685 @item -mdisable-fpregs
18686 @opindex mdisable-fpregs
18687 Prevent floating-point registers from being used in any manner.  This is
18688 necessary for compiling kernels that perform lazy context switching of
18689 floating-point registers.  If you use this option and attempt to perform
18690 floating-point operations, the compiler aborts.
18692 @item -mdisable-indexing
18693 @opindex mdisable-indexing
18694 Prevent the compiler from using indexing address modes.  This avoids some
18695 rather obscure problems when compiling MIG generated code under MACH@.
18697 @item -mno-space-regs
18698 @opindex mno-space-regs
18699 Generate code that assumes the target has no space registers.  This allows
18700 GCC to generate faster indirect calls and use unscaled index address modes.
18702 Such code is suitable for level 0 PA systems and kernels.
18704 @item -mfast-indirect-calls
18705 @opindex mfast-indirect-calls
18706 Generate code that assumes calls never cross space boundaries.  This
18707 allows GCC to emit code that performs faster indirect calls.
18709 This option does not work in the presence of shared libraries or nested
18710 functions.
18712 @item -mfixed-range=@var{register-range}
18713 @opindex mfixed-range
18714 Generate code treating the given register range as fixed registers.
18715 A fixed register is one that the register allocator cannot use.  This is
18716 useful when compiling kernel code.  A register range is specified as
18717 two registers separated by a dash.  Multiple register ranges can be
18718 specified separated by a comma.
18720 @item -mlong-load-store
18721 @opindex mlong-load-store
18722 Generate 3-instruction load and store sequences as sometimes required by
18723 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18724 the HP compilers.
18726 @item -mportable-runtime
18727 @opindex mportable-runtime
18728 Use the portable calling conventions proposed by HP for ELF systems.
18730 @item -mgas
18731 @opindex mgas
18732 Enable the use of assembler directives only GAS understands.
18734 @item -mschedule=@var{cpu-type}
18735 @opindex mschedule
18736 Schedule code according to the constraints for the machine type
18737 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18738 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18739 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18740 proper scheduling option for your machine.  The default scheduling is
18741 @samp{8000}.
18743 @item -mlinker-opt
18744 @opindex mlinker-opt
18745 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18746 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18747 linkers in which they give bogus error messages when linking some programs.
18749 @item -msoft-float
18750 @opindex msoft-float
18751 Generate output containing library calls for floating point.
18752 @strong{Warning:} the requisite libraries are not available for all HPPA
18753 targets.  Normally the facilities of the machine's usual C compiler are
18754 used, but this cannot be done directly in cross-compilation.  You must make
18755 your own arrangements to provide suitable library functions for
18756 cross-compilation.
18758 @option{-msoft-float} changes the calling convention in the output file;
18759 therefore, it is only useful if you compile @emph{all} of a program with
18760 this option.  In particular, you need to compile @file{libgcc.a}, the
18761 library that comes with GCC, with @option{-msoft-float} in order for
18762 this to work.
18764 @item -msio
18765 @opindex msio
18766 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18767 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18768 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18769 options are available under HP-UX and HI-UX@.
18771 @item -mgnu-ld
18772 @opindex mgnu-ld
18773 Use options specific to GNU @command{ld}.
18774 This passes @option{-shared} to @command{ld} when
18775 building a shared library.  It is the default when GCC is configured,
18776 explicitly or implicitly, with the GNU linker.  This option does not
18777 affect which @command{ld} is called; it only changes what parameters
18778 are passed to that @command{ld}.
18779 The @command{ld} that is called is determined by the
18780 @option{--with-ld} configure option, GCC's program search path, and
18781 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18782 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18783 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18785 @item -mhp-ld
18786 @opindex mhp-ld
18787 Use options specific to HP @command{ld}.
18788 This passes @option{-b} to @command{ld} when building
18789 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18790 links.  It is the default when GCC is configured, explicitly or
18791 implicitly, with the HP linker.  This option does not affect
18792 which @command{ld} is called; it only changes what parameters are passed to that
18793 @command{ld}.
18794 The @command{ld} that is called is determined by the @option{--with-ld}
18795 configure option, GCC's program search path, and finally by the user's
18796 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18797 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18798 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18800 @item -mlong-calls
18801 @opindex mno-long-calls
18802 Generate code that uses long call sequences.  This ensures that a call
18803 is always able to reach linker generated stubs.  The default is to generate
18804 long calls only when the distance from the call site to the beginning
18805 of the function or translation unit, as the case may be, exceeds a
18806 predefined limit set by the branch type being used.  The limits for
18807 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18808 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18809 240,000 bytes.
18811 Distances are measured from the beginning of functions when using the
18812 @option{-ffunction-sections} option, or when using the @option{-mgas}
18813 and @option{-mno-portable-runtime} options together under HP-UX with
18814 the SOM linker.
18816 It is normally not desirable to use this option as it degrades
18817 performance.  However, it may be useful in large applications,
18818 particularly when partial linking is used to build the application.
18820 The types of long calls used depends on the capabilities of the
18821 assembler and linker, and the type of code being generated.  The
18822 impact on systems that support long absolute calls, and long pic
18823 symbol-difference or pc-relative calls should be relatively small.
18824 However, an indirect call is used on 32-bit ELF systems in pic code
18825 and it is quite long.
18827 @item -munix=@var{unix-std}
18828 @opindex march
18829 Generate compiler predefines and select a startfile for the specified
18830 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18831 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18832 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18833 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18834 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18835 and later.
18837 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18838 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18839 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18840 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18841 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18842 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18844 It is @emph{important} to note that this option changes the interfaces
18845 for various library routines.  It also affects the operational behavior
18846 of the C library.  Thus, @emph{extreme} care is needed in using this
18847 option.
18849 Library code that is intended to operate with more than one UNIX
18850 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18851 as appropriate.  Most GNU software doesn't provide this capability.
18853 @item -nolibdld
18854 @opindex nolibdld
18855 Suppress the generation of link options to search libdld.sl when the
18856 @option{-static} option is specified on HP-UX 10 and later.
18858 @item -static
18859 @opindex static
18860 The HP-UX implementation of setlocale in libc has a dependency on
18861 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18862 when the @option{-static} option is specified, special link options
18863 are needed to resolve this dependency.
18865 On HP-UX 10 and later, the GCC driver adds the necessary options to
18866 link with libdld.sl when the @option{-static} option is specified.
18867 This causes the resulting binary to be dynamic.  On the 64-bit port,
18868 the linkers generate dynamic binaries by default in any case.  The
18869 @option{-nolibdld} option can be used to prevent the GCC driver from
18870 adding these link options.
18872 @item -threads
18873 @opindex threads
18874 Add support for multithreading with the @dfn{dce thread} library
18875 under HP-UX@.  This option sets flags for both the preprocessor and
18876 linker.
18877 @end table
18879 @node IA-64 Options
18880 @subsection IA-64 Options
18881 @cindex IA-64 Options
18883 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18885 @table @gcctabopt
18886 @item -mbig-endian
18887 @opindex mbig-endian
18888 Generate code for a big-endian target.  This is the default for HP-UX@.
18890 @item -mlittle-endian
18891 @opindex mlittle-endian
18892 Generate code for a little-endian target.  This is the default for AIX5
18893 and GNU/Linux.
18895 @item -mgnu-as
18896 @itemx -mno-gnu-as
18897 @opindex mgnu-as
18898 @opindex mno-gnu-as
18899 Generate (or don't) code for the GNU assembler.  This is the default.
18900 @c Also, this is the default if the configure option @option{--with-gnu-as}
18901 @c is used.
18903 @item -mgnu-ld
18904 @itemx -mno-gnu-ld
18905 @opindex mgnu-ld
18906 @opindex mno-gnu-ld
18907 Generate (or don't) code for the GNU linker.  This is the default.
18908 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18909 @c is used.
18911 @item -mno-pic
18912 @opindex mno-pic
18913 Generate code that does not use a global pointer register.  The result
18914 is not position independent code, and violates the IA-64 ABI@.
18916 @item -mvolatile-asm-stop
18917 @itemx -mno-volatile-asm-stop
18918 @opindex mvolatile-asm-stop
18919 @opindex mno-volatile-asm-stop
18920 Generate (or don't) a stop bit immediately before and after volatile asm
18921 statements.
18923 @item -mregister-names
18924 @itemx -mno-register-names
18925 @opindex mregister-names
18926 @opindex mno-register-names
18927 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18928 the stacked registers.  This may make assembler output more readable.
18930 @item -mno-sdata
18931 @itemx -msdata
18932 @opindex mno-sdata
18933 @opindex msdata
18934 Disable (or enable) optimizations that use the small data section.  This may
18935 be useful for working around optimizer bugs.
18937 @item -mconstant-gp
18938 @opindex mconstant-gp
18939 Generate code that uses a single constant global pointer value.  This is
18940 useful when compiling kernel code.
18942 @item -mauto-pic
18943 @opindex mauto-pic
18944 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18945 This is useful when compiling firmware code.
18947 @item -minline-float-divide-min-latency
18948 @opindex minline-float-divide-min-latency
18949 Generate code for inline divides of floating-point values
18950 using the minimum latency algorithm.
18952 @item -minline-float-divide-max-throughput
18953 @opindex minline-float-divide-max-throughput
18954 Generate code for inline divides of floating-point values
18955 using the maximum throughput algorithm.
18957 @item -mno-inline-float-divide
18958 @opindex mno-inline-float-divide
18959 Do not generate inline code for divides of floating-point values.
18961 @item -minline-int-divide-min-latency
18962 @opindex minline-int-divide-min-latency
18963 Generate code for inline divides of integer values
18964 using the minimum latency algorithm.
18966 @item -minline-int-divide-max-throughput
18967 @opindex minline-int-divide-max-throughput
18968 Generate code for inline divides of integer values
18969 using the maximum throughput algorithm.
18971 @item -mno-inline-int-divide
18972 @opindex mno-inline-int-divide
18973 Do not generate inline code for divides of integer values.
18975 @item -minline-sqrt-min-latency
18976 @opindex minline-sqrt-min-latency
18977 Generate code for inline square roots
18978 using the minimum latency algorithm.
18980 @item -minline-sqrt-max-throughput
18981 @opindex minline-sqrt-max-throughput
18982 Generate code for inline square roots
18983 using the maximum throughput algorithm.
18985 @item -mno-inline-sqrt
18986 @opindex mno-inline-sqrt
18987 Do not generate inline code for @code{sqrt}.
18989 @item -mfused-madd
18990 @itemx -mno-fused-madd
18991 @opindex mfused-madd
18992 @opindex mno-fused-madd
18993 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18994 instructions.  The default is to use these instructions.
18996 @item -mno-dwarf2-asm
18997 @itemx -mdwarf2-asm
18998 @opindex mno-dwarf2-asm
18999 @opindex mdwarf2-asm
19000 Don't (or do) generate assembler code for the DWARF line number debugging
19001 info.  This may be useful when not using the GNU assembler.
19003 @item -mearly-stop-bits
19004 @itemx -mno-early-stop-bits
19005 @opindex mearly-stop-bits
19006 @opindex mno-early-stop-bits
19007 Allow stop bits to be placed earlier than immediately preceding the
19008 instruction that triggered the stop bit.  This can improve instruction
19009 scheduling, but does not always do so.
19011 @item -mfixed-range=@var{register-range}
19012 @opindex mfixed-range
19013 Generate code treating the given register range as fixed registers.
19014 A fixed register is one that the register allocator cannot use.  This is
19015 useful when compiling kernel code.  A register range is specified as
19016 two registers separated by a dash.  Multiple register ranges can be
19017 specified separated by a comma.
19019 @item -mtls-size=@var{tls-size}
19020 @opindex mtls-size
19021 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19024 @item -mtune=@var{cpu-type}
19025 @opindex mtune
19026 Tune the instruction scheduling for a particular CPU, Valid values are
19027 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19028 and @samp{mckinley}.
19030 @item -milp32
19031 @itemx -mlp64
19032 @opindex milp32
19033 @opindex mlp64
19034 Generate code for a 32-bit or 64-bit environment.
19035 The 32-bit environment sets int, long and pointer to 32 bits.
19036 The 64-bit environment sets int to 32 bits and long and pointer
19037 to 64 bits.  These are HP-UX specific flags.
19039 @item -mno-sched-br-data-spec
19040 @itemx -msched-br-data-spec
19041 @opindex mno-sched-br-data-spec
19042 @opindex msched-br-data-spec
19043 (Dis/En)able data speculative scheduling before reload.
19044 This results in generation of @code{ld.a} instructions and
19045 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19046 The default setting is disabled.
19048 @item -msched-ar-data-spec
19049 @itemx -mno-sched-ar-data-spec
19050 @opindex msched-ar-data-spec
19051 @opindex mno-sched-ar-data-spec
19052 (En/Dis)able data speculative scheduling after reload.
19053 This results in generation of @code{ld.a} instructions and
19054 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19055 The default setting is enabled.
19057 @item -mno-sched-control-spec
19058 @itemx -msched-control-spec
19059 @opindex mno-sched-control-spec
19060 @opindex msched-control-spec
19061 (Dis/En)able control speculative scheduling.  This feature is
19062 available only during region scheduling (i.e.@: before reload).
19063 This results in generation of the @code{ld.s} instructions and
19064 the corresponding check instructions @code{chk.s}.
19065 The default setting is disabled.
19067 @item -msched-br-in-data-spec
19068 @itemx -mno-sched-br-in-data-spec
19069 @opindex msched-br-in-data-spec
19070 @opindex mno-sched-br-in-data-spec
19071 (En/Dis)able speculative scheduling of the instructions that
19072 are dependent on the data speculative loads before reload.
19073 This is effective only with @option{-msched-br-data-spec} enabled.
19074 The default setting is enabled.
19076 @item -msched-ar-in-data-spec
19077 @itemx -mno-sched-ar-in-data-spec
19078 @opindex msched-ar-in-data-spec
19079 @opindex mno-sched-ar-in-data-spec
19080 (En/Dis)able speculative scheduling of the instructions that
19081 are dependent on the data speculative loads after reload.
19082 This is effective only with @option{-msched-ar-data-spec} enabled.
19083 The default setting is enabled.
19085 @item -msched-in-control-spec
19086 @itemx -mno-sched-in-control-spec
19087 @opindex msched-in-control-spec
19088 @opindex mno-sched-in-control-spec
19089 (En/Dis)able speculative scheduling of the instructions that
19090 are dependent on the control speculative loads.
19091 This is effective only with @option{-msched-control-spec} enabled.
19092 The default setting is enabled.
19094 @item -mno-sched-prefer-non-data-spec-insns
19095 @itemx -msched-prefer-non-data-spec-insns
19096 @opindex mno-sched-prefer-non-data-spec-insns
19097 @opindex msched-prefer-non-data-spec-insns
19098 If enabled, data-speculative instructions are chosen for schedule
19099 only if there are no other choices at the moment.  This makes
19100 the use of the data speculation much more conservative.
19101 The default setting is disabled.
19103 @item -mno-sched-prefer-non-control-spec-insns
19104 @itemx -msched-prefer-non-control-spec-insns
19105 @opindex mno-sched-prefer-non-control-spec-insns
19106 @opindex msched-prefer-non-control-spec-insns
19107 If enabled, control-speculative instructions are chosen for schedule
19108 only if there are no other choices at the moment.  This makes
19109 the use of the control speculation much more conservative.
19110 The default setting is disabled.
19112 @item -mno-sched-count-spec-in-critical-path
19113 @itemx -msched-count-spec-in-critical-path
19114 @opindex mno-sched-count-spec-in-critical-path
19115 @opindex msched-count-spec-in-critical-path
19116 If enabled, speculative dependencies are considered during
19117 computation of the instructions priorities.  This makes the use of the
19118 speculation a bit more conservative.
19119 The default setting is disabled.
19121 @item -msched-spec-ldc
19122 @opindex msched-spec-ldc
19123 Use a simple data speculation check.  This option is on by default.
19125 @item -msched-control-spec-ldc
19126 @opindex msched-spec-ldc
19127 Use a simple check for control speculation.  This option is on by default.
19129 @item -msched-stop-bits-after-every-cycle
19130 @opindex msched-stop-bits-after-every-cycle
19131 Place a stop bit after every cycle when scheduling.  This option is on
19132 by default.
19134 @item -msched-fp-mem-deps-zero-cost
19135 @opindex msched-fp-mem-deps-zero-cost
19136 Assume that floating-point stores and loads are not likely to cause a conflict
19137 when placed into the same instruction group.  This option is disabled by
19138 default.
19140 @item -msel-sched-dont-check-control-spec
19141 @opindex msel-sched-dont-check-control-spec
19142 Generate checks for control speculation in selective scheduling.
19143 This flag is disabled by default.
19145 @item -msched-max-memory-insns=@var{max-insns}
19146 @opindex msched-max-memory-insns
19147 Limit on the number of memory insns per instruction group, giving lower
19148 priority to subsequent memory insns attempting to schedule in the same
19149 instruction group. Frequently useful to prevent cache bank conflicts.
19150 The default value is 1.
19152 @item -msched-max-memory-insns-hard-limit
19153 @opindex msched-max-memory-insns-hard-limit
19154 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19155 disallowing more than that number in an instruction group.
19156 Otherwise, the limit is ``soft'', meaning that non-memory operations
19157 are preferred when the limit is reached, but memory operations may still
19158 be scheduled.
19160 @end table
19162 @node LM32 Options
19163 @subsection LM32 Options
19164 @cindex LM32 options
19166 These @option{-m} options are defined for the LatticeMico32 architecture:
19168 @table @gcctabopt
19169 @item -mbarrel-shift-enabled
19170 @opindex mbarrel-shift-enabled
19171 Enable barrel-shift instructions.
19173 @item -mdivide-enabled
19174 @opindex mdivide-enabled
19175 Enable divide and modulus instructions.
19177 @item -mmultiply-enabled
19178 @opindex multiply-enabled
19179 Enable multiply instructions.
19181 @item -msign-extend-enabled
19182 @opindex msign-extend-enabled
19183 Enable sign extend instructions.
19185 @item -muser-enabled
19186 @opindex muser-enabled
19187 Enable user-defined instructions.
19189 @end table
19191 @node M32C Options
19192 @subsection M32C Options
19193 @cindex M32C options
19195 @table @gcctabopt
19196 @item -mcpu=@var{name}
19197 @opindex mcpu=
19198 Select the CPU for which code is generated.  @var{name} may be one of
19199 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19200 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19201 the M32C/80 series.
19203 @item -msim
19204 @opindex msim
19205 Specifies that the program will be run on the simulator.  This causes
19206 an alternate runtime library to be linked in which supports, for
19207 example, file I/O@.  You must not use this option when generating
19208 programs that will run on real hardware; you must provide your own
19209 runtime library for whatever I/O functions are needed.
19211 @item -memregs=@var{number}
19212 @opindex memregs=
19213 Specifies the number of memory-based pseudo-registers GCC uses
19214 during code generation.  These pseudo-registers are used like real
19215 registers, so there is a tradeoff between GCC's ability to fit the
19216 code into available registers, and the performance penalty of using
19217 memory instead of registers.  Note that all modules in a program must
19218 be compiled with the same value for this option.  Because of that, you
19219 must not use this option with GCC's default runtime libraries.
19221 @end table
19223 @node M32R/D Options
19224 @subsection M32R/D Options
19225 @cindex M32R/D options
19227 These @option{-m} options are defined for Renesas M32R/D architectures:
19229 @table @gcctabopt
19230 @item -m32r2
19231 @opindex m32r2
19232 Generate code for the M32R/2@.
19234 @item -m32rx
19235 @opindex m32rx
19236 Generate code for the M32R/X@.
19238 @item -m32r
19239 @opindex m32r
19240 Generate code for the M32R@.  This is the default.
19242 @item -mmodel=small
19243 @opindex mmodel=small
19244 Assume all objects live in the lower 16MB of memory (so that their addresses
19245 can be loaded with the @code{ld24} instruction), and assume all subroutines
19246 are reachable with the @code{bl} instruction.
19247 This is the default.
19249 The addressability of a particular object can be set with the
19250 @code{model} attribute.
19252 @item -mmodel=medium
19253 @opindex mmodel=medium
19254 Assume objects may be anywhere in the 32-bit address space (the compiler
19255 generates @code{seth/add3} instructions to load their addresses), and
19256 assume all subroutines are reachable with the @code{bl} instruction.
19258 @item -mmodel=large
19259 @opindex mmodel=large
19260 Assume objects may be anywhere in the 32-bit address space (the compiler
19261 generates @code{seth/add3} instructions to load their addresses), and
19262 assume subroutines may not be reachable with the @code{bl} instruction
19263 (the compiler generates the much slower @code{seth/add3/jl}
19264 instruction sequence).
19266 @item -msdata=none
19267 @opindex msdata=none
19268 Disable use of the small data area.  Variables are put into
19269 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19270 @code{section} attribute has been specified).
19271 This is the default.
19273 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19274 Objects may be explicitly put in the small data area with the
19275 @code{section} attribute using one of these sections.
19277 @item -msdata=sdata
19278 @opindex msdata=sdata
19279 Put small global and static data in the small data area, but do not
19280 generate special code to reference them.
19282 @item -msdata=use
19283 @opindex msdata=use
19284 Put small global and static data in the small data area, and generate
19285 special instructions to reference them.
19287 @item -G @var{num}
19288 @opindex G
19289 @cindex smaller data references
19290 Put global and static objects less than or equal to @var{num} bytes
19291 into the small data or BSS sections instead of the normal data or BSS
19292 sections.  The default value of @var{num} is 8.
19293 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19294 for this option to have any effect.
19296 All modules should be compiled with the same @option{-G @var{num}} value.
19297 Compiling with different values of @var{num} may or may not work; if it
19298 doesn't the linker gives an error message---incorrect code is not
19299 generated.
19301 @item -mdebug
19302 @opindex mdebug
19303 Makes the M32R-specific code in the compiler display some statistics
19304 that might help in debugging programs.
19306 @item -malign-loops
19307 @opindex malign-loops
19308 Align all loops to a 32-byte boundary.
19310 @item -mno-align-loops
19311 @opindex mno-align-loops
19312 Do not enforce a 32-byte alignment for loops.  This is the default.
19314 @item -missue-rate=@var{number}
19315 @opindex missue-rate=@var{number}
19316 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19317 or 2.
19319 @item -mbranch-cost=@var{number}
19320 @opindex mbranch-cost=@var{number}
19321 @var{number} can only be 1 or 2.  If it is 1 then branches are
19322 preferred over conditional code, if it is 2, then the opposite applies.
19324 @item -mflush-trap=@var{number}
19325 @opindex mflush-trap=@var{number}
19326 Specifies the trap number to use to flush the cache.  The default is
19327 12.  Valid numbers are between 0 and 15 inclusive.
19329 @item -mno-flush-trap
19330 @opindex mno-flush-trap
19331 Specifies that the cache cannot be flushed by using a trap.
19333 @item -mflush-func=@var{name}
19334 @opindex mflush-func=@var{name}
19335 Specifies the name of the operating system function to call to flush
19336 the cache.  The default is @samp{_flush_cache}, but a function call
19337 is only used if a trap is not available.
19339 @item -mno-flush-func
19340 @opindex mno-flush-func
19341 Indicates that there is no OS function for flushing the cache.
19343 @end table
19345 @node M680x0 Options
19346 @subsection M680x0 Options
19347 @cindex M680x0 options
19349 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19350 The default settings depend on which architecture was selected when
19351 the compiler was configured; the defaults for the most common choices
19352 are given below.
19354 @table @gcctabopt
19355 @item -march=@var{arch}
19356 @opindex march
19357 Generate code for a specific M680x0 or ColdFire instruction set
19358 architecture.  Permissible values of @var{arch} for M680x0
19359 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19360 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19361 architectures are selected according to Freescale's ISA classification
19362 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19363 @samp{isab} and @samp{isac}.
19365 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19366 code for a ColdFire target.  The @var{arch} in this macro is one of the
19367 @option{-march} arguments given above.
19369 When used together, @option{-march} and @option{-mtune} select code
19370 that runs on a family of similar processors but that is optimized
19371 for a particular microarchitecture.
19373 @item -mcpu=@var{cpu}
19374 @opindex mcpu
19375 Generate code for a specific M680x0 or ColdFire processor.
19376 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19377 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19378 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19379 below, which also classifies the CPUs into families:
19381 @multitable @columnfractions 0.20 0.80
19382 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19383 @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}
19384 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19385 @item @samp{5206e} @tab @samp{5206e}
19386 @item @samp{5208} @tab @samp{5207} @samp{5208}
19387 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19388 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19389 @item @samp{5216} @tab @samp{5214} @samp{5216}
19390 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19391 @item @samp{5225} @tab @samp{5224} @samp{5225}
19392 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19393 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19394 @item @samp{5249} @tab @samp{5249}
19395 @item @samp{5250} @tab @samp{5250}
19396 @item @samp{5271} @tab @samp{5270} @samp{5271}
19397 @item @samp{5272} @tab @samp{5272}
19398 @item @samp{5275} @tab @samp{5274} @samp{5275}
19399 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19400 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19401 @item @samp{5307} @tab @samp{5307}
19402 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19403 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19404 @item @samp{5407} @tab @samp{5407}
19405 @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}
19406 @end multitable
19408 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19409 @var{arch} is compatible with @var{cpu}.  Other combinations of
19410 @option{-mcpu} and @option{-march} are rejected.
19412 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19413 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19414 where the value of @var{family} is given by the table above.
19416 @item -mtune=@var{tune}
19417 @opindex mtune
19418 Tune the code for a particular microarchitecture within the
19419 constraints set by @option{-march} and @option{-mcpu}.
19420 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19421 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19422 and @samp{cpu32}.  The ColdFire microarchitectures
19423 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19425 You can also use @option{-mtune=68020-40} for code that needs
19426 to run relatively well on 68020, 68030 and 68040 targets.
19427 @option{-mtune=68020-60} is similar but includes 68060 targets
19428 as well.  These two options select the same tuning decisions as
19429 @option{-m68020-40} and @option{-m68020-60} respectively.
19431 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19432 when tuning for 680x0 architecture @var{arch}.  It also defines
19433 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19434 option is used.  If GCC is tuning for a range of architectures,
19435 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19436 it defines the macros for every architecture in the range.
19438 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19439 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19440 of the arguments given above.
19442 @item -m68000
19443 @itemx -mc68000
19444 @opindex m68000
19445 @opindex mc68000
19446 Generate output for a 68000.  This is the default
19447 when the compiler is configured for 68000-based systems.
19448 It is equivalent to @option{-march=68000}.
19450 Use this option for microcontrollers with a 68000 or EC000 core,
19451 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19453 @item -m68010
19454 @opindex m68010
19455 Generate output for a 68010.  This is the default
19456 when the compiler is configured for 68010-based systems.
19457 It is equivalent to @option{-march=68010}.
19459 @item -m68020
19460 @itemx -mc68020
19461 @opindex m68020
19462 @opindex mc68020
19463 Generate output for a 68020.  This is the default
19464 when the compiler is configured for 68020-based systems.
19465 It is equivalent to @option{-march=68020}.
19467 @item -m68030
19468 @opindex m68030
19469 Generate output for a 68030.  This is the default when the compiler is
19470 configured for 68030-based systems.  It is equivalent to
19471 @option{-march=68030}.
19473 @item -m68040
19474 @opindex m68040
19475 Generate output for a 68040.  This is the default when the compiler is
19476 configured for 68040-based systems.  It is equivalent to
19477 @option{-march=68040}.
19479 This option inhibits the use of 68881/68882 instructions that have to be
19480 emulated by software on the 68040.  Use this option if your 68040 does not
19481 have code to emulate those instructions.
19483 @item -m68060
19484 @opindex m68060
19485 Generate output for a 68060.  This is the default when the compiler is
19486 configured for 68060-based systems.  It is equivalent to
19487 @option{-march=68060}.
19489 This option inhibits the use of 68020 and 68881/68882 instructions that
19490 have to be emulated by software on the 68060.  Use this option if your 68060
19491 does not have code to emulate those instructions.
19493 @item -mcpu32
19494 @opindex mcpu32
19495 Generate output for a CPU32.  This is the default
19496 when the compiler is configured for CPU32-based systems.
19497 It is equivalent to @option{-march=cpu32}.
19499 Use this option for microcontrollers with a
19500 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19501 68336, 68340, 68341, 68349 and 68360.
19503 @item -m5200
19504 @opindex m5200
19505 Generate output for a 520X ColdFire CPU@.  This is the default
19506 when the compiler is configured for 520X-based systems.
19507 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19508 in favor of that option.
19510 Use this option for microcontroller with a 5200 core, including
19511 the MCF5202, MCF5203, MCF5204 and MCF5206.
19513 @item -m5206e
19514 @opindex m5206e
19515 Generate output for a 5206e ColdFire CPU@.  The option is now
19516 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19518 @item -m528x
19519 @opindex m528x
19520 Generate output for a member of the ColdFire 528X family.
19521 The option is now deprecated in favor of the equivalent
19522 @option{-mcpu=528x}.
19524 @item -m5307
19525 @opindex m5307
19526 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19527 in favor of the equivalent @option{-mcpu=5307}.
19529 @item -m5407
19530 @opindex m5407
19531 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19532 in favor of the equivalent @option{-mcpu=5407}.
19534 @item -mcfv4e
19535 @opindex mcfv4e
19536 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19537 This includes use of hardware floating-point instructions.
19538 The option is equivalent to @option{-mcpu=547x}, and is now
19539 deprecated in favor of that option.
19541 @item -m68020-40
19542 @opindex m68020-40
19543 Generate output for a 68040, without using any of the new instructions.
19544 This results in code that can run relatively efficiently on either a
19545 68020/68881 or a 68030 or a 68040.  The generated code does use the
19546 68881 instructions that are emulated on the 68040.
19548 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19550 @item -m68020-60
19551 @opindex m68020-60
19552 Generate output for a 68060, without using any of the new instructions.
19553 This results in code that can run relatively efficiently on either a
19554 68020/68881 or a 68030 or a 68040.  The generated code does use the
19555 68881 instructions that are emulated on the 68060.
19557 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19559 @item -mhard-float
19560 @itemx -m68881
19561 @opindex mhard-float
19562 @opindex m68881
19563 Generate floating-point instructions.  This is the default for 68020
19564 and above, and for ColdFire devices that have an FPU@.  It defines the
19565 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19566 on ColdFire targets.
19568 @item -msoft-float
19569 @opindex msoft-float
19570 Do not generate floating-point instructions; use library calls instead.
19571 This is the default for 68000, 68010, and 68832 targets.  It is also
19572 the default for ColdFire devices that have no FPU.
19574 @item -mdiv
19575 @itemx -mno-div
19576 @opindex mdiv
19577 @opindex mno-div
19578 Generate (do not generate) ColdFire hardware divide and remainder
19579 instructions.  If @option{-march} is used without @option{-mcpu},
19580 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19581 architectures.  Otherwise, the default is taken from the target CPU
19582 (either the default CPU, or the one specified by @option{-mcpu}).  For
19583 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19584 @option{-mcpu=5206e}.
19586 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19588 @item -mshort
19589 @opindex mshort
19590 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19591 Additionally, parameters passed on the stack are also aligned to a
19592 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19594 @item -mno-short
19595 @opindex mno-short
19596 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19598 @item -mnobitfield
19599 @itemx -mno-bitfield
19600 @opindex mnobitfield
19601 @opindex mno-bitfield
19602 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19603 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19605 @item -mbitfield
19606 @opindex mbitfield
19607 Do use the bit-field instructions.  The @option{-m68020} option implies
19608 @option{-mbitfield}.  This is the default if you use a configuration
19609 designed for a 68020.
19611 @item -mrtd
19612 @opindex mrtd
19613 Use a different function-calling convention, in which functions
19614 that take a fixed number of arguments return with the @code{rtd}
19615 instruction, which pops their arguments while returning.  This
19616 saves one instruction in the caller since there is no need to pop
19617 the arguments there.
19619 This calling convention is incompatible with the one normally
19620 used on Unix, so you cannot use it if you need to call libraries
19621 compiled with the Unix compiler.
19623 Also, you must provide function prototypes for all functions that
19624 take variable numbers of arguments (including @code{printf});
19625 otherwise incorrect code is generated for calls to those
19626 functions.
19628 In addition, seriously incorrect code results if you call a
19629 function with too many arguments.  (Normally, extra arguments are
19630 harmlessly ignored.)
19632 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19633 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19635 @item -mno-rtd
19636 @opindex mno-rtd
19637 Do not use the calling conventions selected by @option{-mrtd}.
19638 This is the default.
19640 @item -malign-int
19641 @itemx -mno-align-int
19642 @opindex malign-int
19643 @opindex mno-align-int
19644 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19645 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19646 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19647 Aligning variables on 32-bit boundaries produces code that runs somewhat
19648 faster on processors with 32-bit busses at the expense of more memory.
19650 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19651 aligns structures containing the above types differently than
19652 most published application binary interface specifications for the m68k.
19654 @item -mpcrel
19655 @opindex mpcrel
19656 Use the pc-relative addressing mode of the 68000 directly, instead of
19657 using a global offset table.  At present, this option implies @option{-fpic},
19658 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19659 not presently supported with @option{-mpcrel}, though this could be supported for
19660 68020 and higher processors.
19662 @item -mno-strict-align
19663 @itemx -mstrict-align
19664 @opindex mno-strict-align
19665 @opindex mstrict-align
19666 Do not (do) assume that unaligned memory references are handled by
19667 the system.
19669 @item -msep-data
19670 Generate code that allows the data segment to be located in a different
19671 area of memory from the text segment.  This allows for execute-in-place in
19672 an environment without virtual memory management.  This option implies
19673 @option{-fPIC}.
19675 @item -mno-sep-data
19676 Generate code that assumes that the data segment follows the text segment.
19677 This is the default.
19679 @item -mid-shared-library
19680 Generate code that supports shared libraries via the library ID method.
19681 This allows for execute-in-place and shared libraries in an environment
19682 without virtual memory management.  This option implies @option{-fPIC}.
19684 @item -mno-id-shared-library
19685 Generate code that doesn't assume ID-based shared libraries are being used.
19686 This is the default.
19688 @item -mshared-library-id=n
19689 Specifies the identification number of the ID-based shared library being
19690 compiled.  Specifying a value of 0 generates more compact code; specifying
19691 other values forces the allocation of that number to the current
19692 library, but is no more space- or time-efficient than omitting this option.
19694 @item -mxgot
19695 @itemx -mno-xgot
19696 @opindex mxgot
19697 @opindex mno-xgot
19698 When generating position-independent code for ColdFire, generate code
19699 that works if the GOT has more than 8192 entries.  This code is
19700 larger and slower than code generated without this option.  On M680x0
19701 processors, this option is not needed; @option{-fPIC} suffices.
19703 GCC normally uses a single instruction to load values from the GOT@.
19704 While this is relatively efficient, it only works if the GOT
19705 is smaller than about 64k.  Anything larger causes the linker
19706 to report an error such as:
19708 @cindex relocation truncated to fit (ColdFire)
19709 @smallexample
19710 relocation truncated to fit: R_68K_GOT16O foobar
19711 @end smallexample
19713 If this happens, you should recompile your code with @option{-mxgot}.
19714 It should then work with very large GOTs.  However, code generated with
19715 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19716 the value of a global symbol.
19718 Note that some linkers, including newer versions of the GNU linker,
19719 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19720 you should only need to use @option{-mxgot} when compiling a single
19721 object file that accesses more than 8192 GOT entries.  Very few do.
19723 These options have no effect unless GCC is generating
19724 position-independent code.
19726 @item -mlong-jump-table-offsets
19727 @opindex mlong-jump-table-offsets
19728 Use 32-bit offsets in @code{switch} tables.  The default is to use
19729 16-bit offsets.
19731 @end table
19733 @node MCore Options
19734 @subsection MCore Options
19735 @cindex MCore options
19737 These are the @samp{-m} options defined for the Motorola M*Core
19738 processors.
19740 @table @gcctabopt
19742 @item -mhardlit
19743 @itemx -mno-hardlit
19744 @opindex mhardlit
19745 @opindex mno-hardlit
19746 Inline constants into the code stream if it can be done in two
19747 instructions or less.
19749 @item -mdiv
19750 @itemx -mno-div
19751 @opindex mdiv
19752 @opindex mno-div
19753 Use the divide instruction.  (Enabled by default).
19755 @item -mrelax-immediate
19756 @itemx -mno-relax-immediate
19757 @opindex mrelax-immediate
19758 @opindex mno-relax-immediate
19759 Allow arbitrary-sized immediates in bit operations.
19761 @item -mwide-bitfields
19762 @itemx -mno-wide-bitfields
19763 @opindex mwide-bitfields
19764 @opindex mno-wide-bitfields
19765 Always treat bit-fields as @code{int}-sized.
19767 @item -m4byte-functions
19768 @itemx -mno-4byte-functions
19769 @opindex m4byte-functions
19770 @opindex mno-4byte-functions
19771 Force all functions to be aligned to a 4-byte boundary.
19773 @item -mcallgraph-data
19774 @itemx -mno-callgraph-data
19775 @opindex mcallgraph-data
19776 @opindex mno-callgraph-data
19777 Emit callgraph information.
19779 @item -mslow-bytes
19780 @itemx -mno-slow-bytes
19781 @opindex mslow-bytes
19782 @opindex mno-slow-bytes
19783 Prefer word access when reading byte quantities.
19785 @item -mlittle-endian
19786 @itemx -mbig-endian
19787 @opindex mlittle-endian
19788 @opindex mbig-endian
19789 Generate code for a little-endian target.
19791 @item -m210
19792 @itemx -m340
19793 @opindex m210
19794 @opindex m340
19795 Generate code for the 210 processor.
19797 @item -mno-lsim
19798 @opindex mno-lsim
19799 Assume that runtime support has been provided and so omit the
19800 simulator library (@file{libsim.a)} from the linker command line.
19802 @item -mstack-increment=@var{size}
19803 @opindex mstack-increment
19804 Set the maximum amount for a single stack increment operation.  Large
19805 values can increase the speed of programs that contain functions
19806 that need a large amount of stack space, but they can also trigger a
19807 segmentation fault if the stack is extended too much.  The default
19808 value is 0x1000.
19810 @end table
19812 @node MeP Options
19813 @subsection MeP Options
19814 @cindex MeP options
19816 @table @gcctabopt
19818 @item -mabsdiff
19819 @opindex mabsdiff
19820 Enables the @code{abs} instruction, which is the absolute difference
19821 between two registers.
19823 @item -mall-opts
19824 @opindex mall-opts
19825 Enables all the optional instructions---average, multiply, divide, bit
19826 operations, leading zero, absolute difference, min/max, clip, and
19827 saturation.
19830 @item -maverage
19831 @opindex maverage
19832 Enables the @code{ave} instruction, which computes the average of two
19833 registers.
19835 @item -mbased=@var{n}
19836 @opindex mbased=
19837 Variables of size @var{n} bytes or smaller are placed in the
19838 @code{.based} section by default.  Based variables use the @code{$tp}
19839 register as a base register, and there is a 128-byte limit to the
19840 @code{.based} section.
19842 @item -mbitops
19843 @opindex mbitops
19844 Enables the bit operation instructions---bit test (@code{btstm}), set
19845 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19846 test-and-set (@code{tas}).
19848 @item -mc=@var{name}
19849 @opindex mc=
19850 Selects which section constant data is placed in.  @var{name} may
19851 be @samp{tiny}, @samp{near}, or @samp{far}.
19853 @item -mclip
19854 @opindex mclip
19855 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19856 useful unless you also provide @option{-mminmax}.
19858 @item -mconfig=@var{name}
19859 @opindex mconfig=
19860 Selects one of the built-in core configurations.  Each MeP chip has
19861 one or more modules in it; each module has a core CPU and a variety of
19862 coprocessors, optional instructions, and peripherals.  The
19863 @code{MeP-Integrator} tool, not part of GCC, provides these
19864 configurations through this option; using this option is the same as
19865 using all the corresponding command-line options.  The default
19866 configuration is @samp{default}.
19868 @item -mcop
19869 @opindex mcop
19870 Enables the coprocessor instructions.  By default, this is a 32-bit
19871 coprocessor.  Note that the coprocessor is normally enabled via the
19872 @option{-mconfig=} option.
19874 @item -mcop32
19875 @opindex mcop32
19876 Enables the 32-bit coprocessor's instructions.
19878 @item -mcop64
19879 @opindex mcop64
19880 Enables the 64-bit coprocessor's instructions.
19882 @item -mivc2
19883 @opindex mivc2
19884 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19886 @item -mdc
19887 @opindex mdc
19888 Causes constant variables to be placed in the @code{.near} section.
19890 @item -mdiv
19891 @opindex mdiv
19892 Enables the @code{div} and @code{divu} instructions.
19894 @item -meb
19895 @opindex meb
19896 Generate big-endian code.
19898 @item -mel
19899 @opindex mel
19900 Generate little-endian code.
19902 @item -mio-volatile
19903 @opindex mio-volatile
19904 Tells the compiler that any variable marked with the @code{io}
19905 attribute is to be considered volatile.
19907 @item -ml
19908 @opindex ml
19909 Causes variables to be assigned to the @code{.far} section by default.
19911 @item -mleadz
19912 @opindex mleadz
19913 Enables the @code{leadz} (leading zero) instruction.
19915 @item -mm
19916 @opindex mm
19917 Causes variables to be assigned to the @code{.near} section by default.
19919 @item -mminmax
19920 @opindex mminmax
19921 Enables the @code{min} and @code{max} instructions.
19923 @item -mmult
19924 @opindex mmult
19925 Enables the multiplication and multiply-accumulate instructions.
19927 @item -mno-opts
19928 @opindex mno-opts
19929 Disables all the optional instructions enabled by @option{-mall-opts}.
19931 @item -mrepeat
19932 @opindex mrepeat
19933 Enables the @code{repeat} and @code{erepeat} instructions, used for
19934 low-overhead looping.
19936 @item -ms
19937 @opindex ms
19938 Causes all variables to default to the @code{.tiny} section.  Note
19939 that there is a 65536-byte limit to this section.  Accesses to these
19940 variables use the @code{%gp} base register.
19942 @item -msatur
19943 @opindex msatur
19944 Enables the saturation instructions.  Note that the compiler does not
19945 currently generate these itself, but this option is included for
19946 compatibility with other tools, like @code{as}.
19948 @item -msdram
19949 @opindex msdram
19950 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19952 @item -msim
19953 @opindex msim
19954 Link the simulator run-time libraries.
19956 @item -msimnovec
19957 @opindex msimnovec
19958 Link the simulator runtime libraries, excluding built-in support
19959 for reset and exception vectors and tables.
19961 @item -mtf
19962 @opindex mtf
19963 Causes all functions to default to the @code{.far} section.  Without
19964 this option, functions default to the @code{.near} section.
19966 @item -mtiny=@var{n}
19967 @opindex mtiny=
19968 Variables that are @var{n} bytes or smaller are allocated to the
19969 @code{.tiny} section.  These variables use the @code{$gp} base
19970 register.  The default for this option is 4, but note that there's a
19971 65536-byte limit to the @code{.tiny} section.
19973 @end table
19975 @node MicroBlaze Options
19976 @subsection MicroBlaze Options
19977 @cindex MicroBlaze Options
19979 @table @gcctabopt
19981 @item -msoft-float
19982 @opindex msoft-float
19983 Use software emulation for floating point (default).
19985 @item -mhard-float
19986 @opindex mhard-float
19987 Use hardware floating-point instructions.
19989 @item -mmemcpy
19990 @opindex mmemcpy
19991 Do not optimize block moves, use @code{memcpy}.
19993 @item -mno-clearbss
19994 @opindex mno-clearbss
19995 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19997 @item -mcpu=@var{cpu-type}
19998 @opindex mcpu=
19999 Use features of, and schedule code for, the given CPU.
20000 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20001 where @var{X} is a major version, @var{YY} is the minor version, and
20002 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20003 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20005 @item -mxl-soft-mul
20006 @opindex mxl-soft-mul
20007 Use software multiply emulation (default).
20009 @item -mxl-soft-div
20010 @opindex mxl-soft-div
20011 Use software emulation for divides (default).
20013 @item -mxl-barrel-shift
20014 @opindex mxl-barrel-shift
20015 Use the hardware barrel shifter.
20017 @item -mxl-pattern-compare
20018 @opindex mxl-pattern-compare
20019 Use pattern compare instructions.
20021 @item -msmall-divides
20022 @opindex msmall-divides
20023 Use table lookup optimization for small signed integer divisions.
20025 @item -mxl-stack-check
20026 @opindex mxl-stack-check
20027 This option is deprecated.  Use @option{-fstack-check} instead.
20029 @item -mxl-gp-opt
20030 @opindex mxl-gp-opt
20031 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20033 @item -mxl-multiply-high
20034 @opindex mxl-multiply-high
20035 Use multiply high instructions for high part of 32x32 multiply.
20037 @item -mxl-float-convert
20038 @opindex mxl-float-convert
20039 Use hardware floating-point conversion instructions.
20041 @item -mxl-float-sqrt
20042 @opindex mxl-float-sqrt
20043 Use hardware floating-point square root instruction.
20045 @item -mbig-endian
20046 @opindex mbig-endian
20047 Generate code for a big-endian target.
20049 @item -mlittle-endian
20050 @opindex mlittle-endian
20051 Generate code for a little-endian target.
20053 @item -mxl-reorder
20054 @opindex mxl-reorder
20055 Use reorder instructions (swap and byte reversed load/store).
20057 @item -mxl-mode-@var{app-model}
20058 Select application model @var{app-model}.  Valid models are
20059 @table @samp
20060 @item executable
20061 normal executable (default), uses startup code @file{crt0.o}.
20063 @item xmdstub
20064 for use with Xilinx Microprocessor Debugger (XMD) based
20065 software intrusive debug agent called xmdstub. This uses startup file
20066 @file{crt1.o} and sets the start address of the program to 0x800.
20068 @item bootstrap
20069 for applications that are loaded using a bootloader.
20070 This model uses startup file @file{crt2.o} which does not contain a processor
20071 reset vector handler. This is suitable for transferring control on a
20072 processor reset to the bootloader rather than the application.
20074 @item novectors
20075 for applications that do not require any of the
20076 MicroBlaze vectors. This option may be useful for applications running
20077 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20078 @end table
20080 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20081 @option{-mxl-mode-@var{app-model}}.
20083 @end table
20085 @node MIPS Options
20086 @subsection MIPS Options
20087 @cindex MIPS options
20089 @table @gcctabopt
20091 @item -EB
20092 @opindex EB
20093 Generate big-endian code.
20095 @item -EL
20096 @opindex EL
20097 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20098 configurations.
20100 @item -march=@var{arch}
20101 @opindex march
20102 Generate code that runs on @var{arch}, which can be the name of a
20103 generic MIPS ISA, or the name of a particular processor.
20104 The ISA names are:
20105 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20106 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20107 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20108 @samp{mips64r5} and @samp{mips64r6}.
20109 The processor names are:
20110 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20111 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20112 @samp{5kc}, @samp{5kf},
20113 @samp{20kc},
20114 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20115 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20116 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20117 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20118 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20119 @samp{i6400},
20120 @samp{interaptiv},
20121 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20122 @samp{m4k},
20123 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20124 @samp{m5100}, @samp{m5101},
20125 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20126 @samp{orion},
20127 @samp{p5600},
20128 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20129 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20130 @samp{rm7000}, @samp{rm9000},
20131 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20132 @samp{sb1},
20133 @samp{sr71000},
20134 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20135 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20136 @samp{xlr} and @samp{xlp}.
20137 The special value @samp{from-abi} selects the
20138 most compatible architecture for the selected ABI (that is,
20139 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20141 The native Linux/GNU toolchain also supports the value @samp{native},
20142 which selects the best architecture option for the host processor.
20143 @option{-march=native} has no effect if GCC does not recognize
20144 the processor.
20146 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20147 (for example, @option{-march=r2k}).  Prefixes are optional, and
20148 @samp{vr} may be written @samp{r}.
20150 Names of the form @samp{@var{n}f2_1} refer to processors with
20151 FPUs clocked at half the rate of the core, names of the form
20152 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20153 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20154 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20155 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20156 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20157 accepted as synonyms for @samp{@var{n}f1_1}.
20159 GCC defines two macros based on the value of this option.  The first
20160 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20161 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20162 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20163 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20164 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20166 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20167 above.  In other words, it has the full prefix and does not
20168 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20169 the macro names the resolved architecture (either @code{"mips1"} or
20170 @code{"mips3"}).  It names the default architecture when no
20171 @option{-march} option is given.
20173 @item -mtune=@var{arch}
20174 @opindex mtune
20175 Optimize for @var{arch}.  Among other things, this option controls
20176 the way instructions are scheduled, and the perceived cost of arithmetic
20177 operations.  The list of @var{arch} values is the same as for
20178 @option{-march}.
20180 When this option is not used, GCC optimizes for the processor
20181 specified by @option{-march}.  By using @option{-march} and
20182 @option{-mtune} together, it is possible to generate code that
20183 runs on a family of processors, but optimize the code for one
20184 particular member of that family.
20186 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20187 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20188 @option{-march} ones described above.
20190 @item -mips1
20191 @opindex mips1
20192 Equivalent to @option{-march=mips1}.
20194 @item -mips2
20195 @opindex mips2
20196 Equivalent to @option{-march=mips2}.
20198 @item -mips3
20199 @opindex mips3
20200 Equivalent to @option{-march=mips3}.
20202 @item -mips4
20203 @opindex mips4
20204 Equivalent to @option{-march=mips4}.
20206 @item -mips32
20207 @opindex mips32
20208 Equivalent to @option{-march=mips32}.
20210 @item -mips32r3
20211 @opindex mips32r3
20212 Equivalent to @option{-march=mips32r3}.
20214 @item -mips32r5
20215 @opindex mips32r5
20216 Equivalent to @option{-march=mips32r5}.
20218 @item -mips32r6
20219 @opindex mips32r6
20220 Equivalent to @option{-march=mips32r6}.
20222 @item -mips64
20223 @opindex mips64
20224 Equivalent to @option{-march=mips64}.
20226 @item -mips64r2
20227 @opindex mips64r2
20228 Equivalent to @option{-march=mips64r2}.
20230 @item -mips64r3
20231 @opindex mips64r3
20232 Equivalent to @option{-march=mips64r3}.
20234 @item -mips64r5
20235 @opindex mips64r5
20236 Equivalent to @option{-march=mips64r5}.
20238 @item -mips64r6
20239 @opindex mips64r6
20240 Equivalent to @option{-march=mips64r6}.
20242 @item -mips16
20243 @itemx -mno-mips16
20244 @opindex mips16
20245 @opindex mno-mips16
20246 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20247 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20249 MIPS16 code generation can also be controlled on a per-function basis
20250 by means of @code{mips16} and @code{nomips16} attributes.
20251 @xref{Function Attributes}, for more information.
20253 @item -mflip-mips16
20254 @opindex mflip-mips16
20255 Generate MIPS16 code on alternating functions.  This option is provided
20256 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20257 not intended for ordinary use in compiling user code.
20259 @item -minterlink-compressed
20260 @itemx -mno-interlink-compressed
20261 @opindex minterlink-compressed
20262 @opindex mno-interlink-compressed
20263 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20264 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20266 For example, code using the standard ISA encoding cannot jump directly
20267 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20268 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20269 knows that the target of the jump is not compressed.
20271 @item -minterlink-mips16
20272 @itemx -mno-interlink-mips16
20273 @opindex minterlink-mips16
20274 @opindex mno-interlink-mips16
20275 Aliases of @option{-minterlink-compressed} and
20276 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20277 and are retained for backwards compatibility.
20279 @item -mabi=32
20280 @itemx -mabi=o64
20281 @itemx -mabi=n32
20282 @itemx -mabi=64
20283 @itemx -mabi=eabi
20284 @opindex mabi=32
20285 @opindex mabi=o64
20286 @opindex mabi=n32
20287 @opindex mabi=64
20288 @opindex mabi=eabi
20289 Generate code for the given ABI@.
20291 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20292 generates 64-bit code when you select a 64-bit architecture, but you
20293 can use @option{-mgp32} to get 32-bit code instead.
20295 For information about the O64 ABI, see
20296 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20298 GCC supports a variant of the o32 ABI in which floating-point registers
20299 are 64 rather than 32 bits wide.  You can select this combination with
20300 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20301 and @code{mfhc1} instructions and is therefore only supported for
20302 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20304 The register assignments for arguments and return values remain the
20305 same, but each scalar value is passed in a single 64-bit register
20306 rather than a pair of 32-bit registers.  For example, scalar
20307 floating-point values are returned in @samp{$f0} only, not a
20308 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20309 remains the same in that the even-numbered double-precision registers
20310 are saved.
20312 Two additional variants of the o32 ABI are supported to enable
20313 a transition from 32-bit to 64-bit registers.  These are FPXX
20314 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20315 The FPXX extension mandates that all code must execute correctly
20316 when run using 32-bit or 64-bit registers.  The code can be interlinked
20317 with either FP32 or FP64, but not both.
20318 The FP64A extension is similar to the FP64 extension but forbids the
20319 use of odd-numbered single-precision registers.  This can be used
20320 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20321 processors and allows both FP32 and FP64A code to interlink and
20322 run in the same process without changing FPU modes.
20324 @item -mabicalls
20325 @itemx -mno-abicalls
20326 @opindex mabicalls
20327 @opindex mno-abicalls
20328 Generate (do not generate) code that is suitable for SVR4-style
20329 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20330 systems.
20332 @item -mshared
20333 @itemx -mno-shared
20334 Generate (do not generate) code that is fully position-independent,
20335 and that can therefore be linked into shared libraries.  This option
20336 only affects @option{-mabicalls}.
20338 All @option{-mabicalls} code has traditionally been position-independent,
20339 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20340 as an extension, the GNU toolchain allows executables to use absolute
20341 accesses for locally-binding symbols.  It can also use shorter GP
20342 initialization sequences and generate direct calls to locally-defined
20343 functions.  This mode is selected by @option{-mno-shared}.
20345 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20346 objects that can only be linked by the GNU linker.  However, the option
20347 does not affect the ABI of the final executable; it only affects the ABI
20348 of relocatable objects.  Using @option{-mno-shared} generally makes
20349 executables both smaller and quicker.
20351 @option{-mshared} is the default.
20353 @item -mplt
20354 @itemx -mno-plt
20355 @opindex mplt
20356 @opindex mno-plt
20357 Assume (do not assume) that the static and dynamic linkers
20358 support PLTs and copy relocations.  This option only affects
20359 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20360 has no effect without @option{-msym32}.
20362 You can make @option{-mplt} the default by configuring
20363 GCC with @option{--with-mips-plt}.  The default is
20364 @option{-mno-plt} otherwise.
20366 @item -mxgot
20367 @itemx -mno-xgot
20368 @opindex mxgot
20369 @opindex mno-xgot
20370 Lift (do not lift) the usual restrictions on the size of the global
20371 offset table.
20373 GCC normally uses a single instruction to load values from the GOT@.
20374 While this is relatively efficient, it only works if the GOT
20375 is smaller than about 64k.  Anything larger causes the linker
20376 to report an error such as:
20378 @cindex relocation truncated to fit (MIPS)
20379 @smallexample
20380 relocation truncated to fit: R_MIPS_GOT16 foobar
20381 @end smallexample
20383 If this happens, you should recompile your code with @option{-mxgot}.
20384 This works with very large GOTs, although the code is also
20385 less efficient, since it takes three instructions to fetch the
20386 value of a global symbol.
20388 Note that some linkers can create multiple GOTs.  If you have such a
20389 linker, you should only need to use @option{-mxgot} when a single object
20390 file accesses more than 64k's worth of GOT entries.  Very few do.
20392 These options have no effect unless GCC is generating position
20393 independent code.
20395 @item -mgp32
20396 @opindex mgp32
20397 Assume that general-purpose registers are 32 bits wide.
20399 @item -mgp64
20400 @opindex mgp64
20401 Assume that general-purpose registers are 64 bits wide.
20403 @item -mfp32
20404 @opindex mfp32
20405 Assume that floating-point registers are 32 bits wide.
20407 @item -mfp64
20408 @opindex mfp64
20409 Assume that floating-point registers are 64 bits wide.
20411 @item -mfpxx
20412 @opindex mfpxx
20413 Do not assume the width of floating-point registers.
20415 @item -mhard-float
20416 @opindex mhard-float
20417 Use floating-point coprocessor instructions.
20419 @item -msoft-float
20420 @opindex msoft-float
20421 Do not use floating-point coprocessor instructions.  Implement
20422 floating-point calculations using library calls instead.
20424 @item -mno-float
20425 @opindex mno-float
20426 Equivalent to @option{-msoft-float}, but additionally asserts that the
20427 program being compiled does not perform any floating-point operations.
20428 This option is presently supported only by some bare-metal MIPS
20429 configurations, where it may select a special set of libraries
20430 that lack all floating-point support (including, for example, the
20431 floating-point @code{printf} formats).  
20432 If code compiled with @option{-mno-float} accidentally contains
20433 floating-point operations, it is likely to suffer a link-time
20434 or run-time failure.
20436 @item -msingle-float
20437 @opindex msingle-float
20438 Assume that the floating-point coprocessor only supports single-precision
20439 operations.
20441 @item -mdouble-float
20442 @opindex mdouble-float
20443 Assume that the floating-point coprocessor supports double-precision
20444 operations.  This is the default.
20446 @item -modd-spreg
20447 @itemx -mno-odd-spreg
20448 @opindex modd-spreg
20449 @opindex mno-odd-spreg
20450 Enable the use of odd-numbered single-precision floating-point registers
20451 for the o32 ABI.  This is the default for processors that are known to
20452 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20453 is set by default.
20455 @item -mabs=2008
20456 @itemx -mabs=legacy
20457 @opindex mabs=2008
20458 @opindex mabs=legacy
20459 These options control the treatment of the special not-a-number (NaN)
20460 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20461 @code{neg.@i{fmt}} machine instructions.
20463 By default or when @option{-mabs=legacy} is used the legacy
20464 treatment is selected.  In this case these instructions are considered
20465 arithmetic and avoided where correct operation is required and the
20466 input operand might be a NaN.  A longer sequence of instructions that
20467 manipulate the sign bit of floating-point datum manually is used
20468 instead unless the @option{-ffinite-math-only} option has also been
20469 specified.
20471 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20472 this case these instructions are considered non-arithmetic and therefore
20473 operating correctly in all cases, including in particular where the
20474 input operand is a NaN.  These instructions are therefore always used
20475 for the respective operations.
20477 @item -mnan=2008
20478 @itemx -mnan=legacy
20479 @opindex mnan=2008
20480 @opindex mnan=legacy
20481 These options control the encoding of the special not-a-number (NaN)
20482 IEEE 754 floating-point data.
20484 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20485 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20486 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20487 by the first bit of their trailing significand field being 1.
20489 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20490 this case qNaNs are denoted by the first bit of their trailing
20491 significand field being 1, whereas sNaNs are denoted by the first bit of
20492 their trailing significand field being 0.
20494 The default is @option{-mnan=legacy} unless GCC has been configured with
20495 @option{--with-nan=2008}.
20497 @item -mllsc
20498 @itemx -mno-llsc
20499 @opindex mllsc
20500 @opindex mno-llsc
20501 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20502 implement atomic memory built-in functions.  When neither option is
20503 specified, GCC uses the instructions if the target architecture
20504 supports them.
20506 @option{-mllsc} is useful if the runtime environment can emulate the
20507 instructions and @option{-mno-llsc} can be useful when compiling for
20508 nonstandard ISAs.  You can make either option the default by
20509 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20510 respectively.  @option{--with-llsc} is the default for some
20511 configurations; see the installation documentation for details.
20513 @item -mdsp
20514 @itemx -mno-dsp
20515 @opindex mdsp
20516 @opindex mno-dsp
20517 Use (do not use) revision 1 of the MIPS DSP ASE@.
20518 @xref{MIPS DSP Built-in Functions}.  This option defines the
20519 preprocessor macro @code{__mips_dsp}.  It also defines
20520 @code{__mips_dsp_rev} to 1.
20522 @item -mdspr2
20523 @itemx -mno-dspr2
20524 @opindex mdspr2
20525 @opindex mno-dspr2
20526 Use (do not use) revision 2 of the MIPS DSP ASE@.
20527 @xref{MIPS DSP Built-in Functions}.  This option defines the
20528 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20529 It also defines @code{__mips_dsp_rev} to 2.
20531 @item -msmartmips
20532 @itemx -mno-smartmips
20533 @opindex msmartmips
20534 @opindex mno-smartmips
20535 Use (do not use) the MIPS SmartMIPS ASE.
20537 @item -mpaired-single
20538 @itemx -mno-paired-single
20539 @opindex mpaired-single
20540 @opindex mno-paired-single
20541 Use (do not use) paired-single floating-point instructions.
20542 @xref{MIPS Paired-Single Support}.  This option requires
20543 hardware floating-point support to be enabled.
20545 @item -mdmx
20546 @itemx -mno-mdmx
20547 @opindex mdmx
20548 @opindex mno-mdmx
20549 Use (do not use) MIPS Digital Media Extension instructions.
20550 This option can only be used when generating 64-bit code and requires
20551 hardware floating-point support to be enabled.
20553 @item -mips3d
20554 @itemx -mno-mips3d
20555 @opindex mips3d
20556 @opindex mno-mips3d
20557 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20558 The option @option{-mips3d} implies @option{-mpaired-single}.
20560 @item -mmicromips
20561 @itemx -mno-micromips
20562 @opindex mmicromips
20563 @opindex mno-mmicromips
20564 Generate (do not generate) microMIPS code.
20566 MicroMIPS code generation can also be controlled on a per-function basis
20567 by means of @code{micromips} and @code{nomicromips} attributes.
20568 @xref{Function Attributes}, for more information.
20570 @item -mmt
20571 @itemx -mno-mt
20572 @opindex mmt
20573 @opindex mno-mt
20574 Use (do not use) MT Multithreading instructions.
20576 @item -mmcu
20577 @itemx -mno-mcu
20578 @opindex mmcu
20579 @opindex mno-mcu
20580 Use (do not use) the MIPS MCU ASE instructions.
20582 @item -meva
20583 @itemx -mno-eva
20584 @opindex meva
20585 @opindex mno-eva
20586 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20588 @item -mvirt
20589 @itemx -mno-virt
20590 @opindex mvirt
20591 @opindex mno-virt
20592 Use (do not use) the MIPS Virtualization (VZ) instructions.
20594 @item -mxpa
20595 @itemx -mno-xpa
20596 @opindex mxpa
20597 @opindex mno-xpa
20598 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20600 @item -mlong64
20601 @opindex mlong64
20602 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20603 an explanation of the default and the way that the pointer size is
20604 determined.
20606 @item -mlong32
20607 @opindex mlong32
20608 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20610 The default size of @code{int}s, @code{long}s and pointers depends on
20611 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20612 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20613 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20614 or the same size as integer registers, whichever is smaller.
20616 @item -msym32
20617 @itemx -mno-sym32
20618 @opindex msym32
20619 @opindex mno-sym32
20620 Assume (do not assume) that all symbols have 32-bit values, regardless
20621 of the selected ABI@.  This option is useful in combination with
20622 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20623 to generate shorter and faster references to symbolic addresses.
20625 @item -G @var{num}
20626 @opindex G
20627 Put definitions of externally-visible data in a small data section
20628 if that data is no bigger than @var{num} bytes.  GCC can then generate
20629 more efficient accesses to the data; see @option{-mgpopt} for details.
20631 The default @option{-G} option depends on the configuration.
20633 @item -mlocal-sdata
20634 @itemx -mno-local-sdata
20635 @opindex mlocal-sdata
20636 @opindex mno-local-sdata
20637 Extend (do not extend) the @option{-G} behavior to local data too,
20638 such as to static variables in C@.  @option{-mlocal-sdata} is the
20639 default for all configurations.
20641 If the linker complains that an application is using too much small data,
20642 you might want to try rebuilding the less performance-critical parts with
20643 @option{-mno-local-sdata}.  You might also want to build large
20644 libraries with @option{-mno-local-sdata}, so that the libraries leave
20645 more room for the main program.
20647 @item -mextern-sdata
20648 @itemx -mno-extern-sdata
20649 @opindex mextern-sdata
20650 @opindex mno-extern-sdata
20651 Assume (do not assume) that externally-defined data is in
20652 a small data section if the size of that data is within the @option{-G} limit.
20653 @option{-mextern-sdata} is the default for all configurations.
20655 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20656 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20657 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20658 is placed in a small data section.  If @var{Var} is defined by another
20659 module, you must either compile that module with a high-enough
20660 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20661 definition.  If @var{Var} is common, you must link the application
20662 with a high-enough @option{-G} setting.
20664 The easiest way of satisfying these restrictions is to compile
20665 and link every module with the same @option{-G} option.  However,
20666 you may wish to build a library that supports several different
20667 small data limits.  You can do this by compiling the library with
20668 the highest supported @option{-G} setting and additionally using
20669 @option{-mno-extern-sdata} to stop the library from making assumptions
20670 about externally-defined data.
20672 @item -mgpopt
20673 @itemx -mno-gpopt
20674 @opindex mgpopt
20675 @opindex mno-gpopt
20676 Use (do not use) GP-relative accesses for symbols that are known to be
20677 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20678 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20679 configurations.
20681 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20682 might not hold the value of @code{_gp}.  For example, if the code is
20683 part of a library that might be used in a boot monitor, programs that
20684 call boot monitor routines pass an unknown value in @code{$gp}.
20685 (In such situations, the boot monitor itself is usually compiled
20686 with @option{-G0}.)
20688 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20689 @option{-mno-extern-sdata}.
20691 @item -membedded-data
20692 @itemx -mno-embedded-data
20693 @opindex membedded-data
20694 @opindex mno-embedded-data
20695 Allocate variables to the read-only data section first if possible, then
20696 next in the small data section if possible, otherwise in data.  This gives
20697 slightly slower code than the default, but reduces the amount of RAM required
20698 when executing, and thus may be preferred for some embedded systems.
20700 @item -muninit-const-in-rodata
20701 @itemx -mno-uninit-const-in-rodata
20702 @opindex muninit-const-in-rodata
20703 @opindex mno-uninit-const-in-rodata
20704 Put uninitialized @code{const} variables in the read-only data section.
20705 This option is only meaningful in conjunction with @option{-membedded-data}.
20707 @item -mcode-readable=@var{setting}
20708 @opindex mcode-readable
20709 Specify whether GCC may generate code that reads from executable sections.
20710 There are three possible settings:
20712 @table @gcctabopt
20713 @item -mcode-readable=yes
20714 Instructions may freely access executable sections.  This is the
20715 default setting.
20717 @item -mcode-readable=pcrel
20718 MIPS16 PC-relative load instructions can access executable sections,
20719 but other instructions must not do so.  This option is useful on 4KSc
20720 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20721 It is also useful on processors that can be configured to have a dual
20722 instruction/data SRAM interface and that, like the M4K, automatically
20723 redirect PC-relative loads to the instruction RAM.
20725 @item -mcode-readable=no
20726 Instructions must not access executable sections.  This option can be
20727 useful on targets that are configured to have a dual instruction/data
20728 SRAM interface but that (unlike the M4K) do not automatically redirect
20729 PC-relative loads to the instruction RAM.
20730 @end table
20732 @item -msplit-addresses
20733 @itemx -mno-split-addresses
20734 @opindex msplit-addresses
20735 @opindex mno-split-addresses
20736 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20737 relocation operators.  This option has been superseded by
20738 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20740 @item -mexplicit-relocs
20741 @itemx -mno-explicit-relocs
20742 @opindex mexplicit-relocs
20743 @opindex mno-explicit-relocs
20744 Use (do not use) assembler relocation operators when dealing with symbolic
20745 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20746 is to use assembler macros instead.
20748 @option{-mexplicit-relocs} is the default if GCC was configured
20749 to use an assembler that supports relocation operators.
20751 @item -mcheck-zero-division
20752 @itemx -mno-check-zero-division
20753 @opindex mcheck-zero-division
20754 @opindex mno-check-zero-division
20755 Trap (do not trap) on integer division by zero.
20757 The default is @option{-mcheck-zero-division}.
20759 @item -mdivide-traps
20760 @itemx -mdivide-breaks
20761 @opindex mdivide-traps
20762 @opindex mdivide-breaks
20763 MIPS systems check for division by zero by generating either a
20764 conditional trap or a break instruction.  Using traps results in
20765 smaller code, but is only supported on MIPS II and later.  Also, some
20766 versions of the Linux kernel have a bug that prevents trap from
20767 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20768 allow conditional traps on architectures that support them and
20769 @option{-mdivide-breaks} to force the use of breaks.
20771 The default is usually @option{-mdivide-traps}, but this can be
20772 overridden at configure time using @option{--with-divide=breaks}.
20773 Divide-by-zero checks can be completely disabled using
20774 @option{-mno-check-zero-division}.
20776 @item -mload-store-pairs
20777 @itemx -mno-load-store-pairs
20778 @opindex mload-store-pairs
20779 @opindex mno-load-store-pairs
20780 Enable (disable) an optimization that pairs consecutive load or store
20781 instructions to enable load/store bonding.  This option is enabled by
20782 default but only takes effect when the selected architecture is known
20783 to support bonding.
20785 @item -mmemcpy
20786 @itemx -mno-memcpy
20787 @opindex mmemcpy
20788 @opindex mno-memcpy
20789 Force (do not force) the use of @code{memcpy} for non-trivial block
20790 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20791 most constant-sized copies.
20793 @item -mlong-calls
20794 @itemx -mno-long-calls
20795 @opindex mlong-calls
20796 @opindex mno-long-calls
20797 Disable (do not disable) use of the @code{jal} instruction.  Calling
20798 functions using @code{jal} is more efficient but requires the caller
20799 and callee to be in the same 256 megabyte segment.
20801 This option has no effect on abicalls code.  The default is
20802 @option{-mno-long-calls}.
20804 @item -mmad
20805 @itemx -mno-mad
20806 @opindex mmad
20807 @opindex mno-mad
20808 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20809 instructions, as provided by the R4650 ISA@.
20811 @item -mimadd
20812 @itemx -mno-imadd
20813 @opindex mimadd
20814 @opindex mno-imadd
20815 Enable (disable) use of the @code{madd} and @code{msub} integer
20816 instructions.  The default is @option{-mimadd} on architectures
20817 that support @code{madd} and @code{msub} except for the 74k 
20818 architecture where it was found to generate slower code.
20820 @item -mfused-madd
20821 @itemx -mno-fused-madd
20822 @opindex mfused-madd
20823 @opindex mno-fused-madd
20824 Enable (disable) use of the floating-point multiply-accumulate
20825 instructions, when they are available.  The default is
20826 @option{-mfused-madd}.
20828 On the R8000 CPU when multiply-accumulate instructions are used,
20829 the intermediate product is calculated to infinite precision
20830 and is not subject to the FCSR Flush to Zero bit.  This may be
20831 undesirable in some circumstances.  On other processors the result
20832 is numerically identical to the equivalent computation using
20833 separate multiply, add, subtract and negate instructions.
20835 @item -nocpp
20836 @opindex nocpp
20837 Tell the MIPS assembler to not run its preprocessor over user
20838 assembler files (with a @samp{.s} suffix) when assembling them.
20840 @item -mfix-24k
20841 @itemx -mno-fix-24k
20842 @opindex mfix-24k
20843 @opindex mno-fix-24k
20844 Work around the 24K E48 (lost data on stores during refill) errata.
20845 The workarounds are implemented by the assembler rather than by GCC@.
20847 @item -mfix-r4000
20848 @itemx -mno-fix-r4000
20849 @opindex mfix-r4000
20850 @opindex mno-fix-r4000
20851 Work around certain R4000 CPU errata:
20852 @itemize @minus
20853 @item
20854 A double-word or a variable shift may give an incorrect result if executed
20855 immediately after starting an integer division.
20856 @item
20857 A double-word or a variable shift may give an incorrect result if executed
20858 while an integer multiplication is in progress.
20859 @item
20860 An integer division may give an incorrect result if started in a delay slot
20861 of a taken branch or a jump.
20862 @end itemize
20864 @item -mfix-r4400
20865 @itemx -mno-fix-r4400
20866 @opindex mfix-r4400
20867 @opindex mno-fix-r4400
20868 Work around certain R4400 CPU errata:
20869 @itemize @minus
20870 @item
20871 A double-word or a variable shift may give an incorrect result if executed
20872 immediately after starting an integer division.
20873 @end itemize
20875 @item -mfix-r10000
20876 @itemx -mno-fix-r10000
20877 @opindex mfix-r10000
20878 @opindex mno-fix-r10000
20879 Work around certain R10000 errata:
20880 @itemize @minus
20881 @item
20882 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20883 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20884 @end itemize
20886 This option can only be used if the target architecture supports
20887 branch-likely instructions.  @option{-mfix-r10000} is the default when
20888 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20889 otherwise.
20891 @item -mfix-rm7000
20892 @itemx -mno-fix-rm7000
20893 @opindex mfix-rm7000
20894 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20895 workarounds are implemented by the assembler rather than by GCC@.
20897 @item -mfix-vr4120
20898 @itemx -mno-fix-vr4120
20899 @opindex mfix-vr4120
20900 Work around certain VR4120 errata:
20901 @itemize @minus
20902 @item
20903 @code{dmultu} does not always produce the correct result.
20904 @item
20905 @code{div} and @code{ddiv} do not always produce the correct result if one
20906 of the operands is negative.
20907 @end itemize
20908 The workarounds for the division errata rely on special functions in
20909 @file{libgcc.a}.  At present, these functions are only provided by
20910 the @code{mips64vr*-elf} configurations.
20912 Other VR4120 errata require a NOP to be inserted between certain pairs of
20913 instructions.  These errata are handled by the assembler, not by GCC itself.
20915 @item -mfix-vr4130
20916 @opindex mfix-vr4130
20917 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20918 workarounds are implemented by the assembler rather than by GCC,
20919 although GCC avoids using @code{mflo} and @code{mfhi} if the
20920 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20921 instructions are available instead.
20923 @item -mfix-sb1
20924 @itemx -mno-fix-sb1
20925 @opindex mfix-sb1
20926 Work around certain SB-1 CPU core errata.
20927 (This flag currently works around the SB-1 revision 2
20928 ``F1'' and ``F2'' floating-point errata.)
20930 @item -mr10k-cache-barrier=@var{setting}
20931 @opindex mr10k-cache-barrier
20932 Specify whether GCC should insert cache barriers to avoid the
20933 side-effects of speculation on R10K processors.
20935 In common with many processors, the R10K tries to predict the outcome
20936 of a conditional branch and speculatively executes instructions from
20937 the ``taken'' branch.  It later aborts these instructions if the
20938 predicted outcome is wrong.  However, on the R10K, even aborted
20939 instructions can have side effects.
20941 This problem only affects kernel stores and, depending on the system,
20942 kernel loads.  As an example, a speculatively-executed store may load
20943 the target memory into cache and mark the cache line as dirty, even if
20944 the store itself is later aborted.  If a DMA operation writes to the
20945 same area of memory before the ``dirty'' line is flushed, the cached
20946 data overwrites the DMA-ed data.  See the R10K processor manual
20947 for a full description, including other potential problems.
20949 One workaround is to insert cache barrier instructions before every memory
20950 access that might be speculatively executed and that might have side
20951 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20952 controls GCC's implementation of this workaround.  It assumes that
20953 aborted accesses to any byte in the following regions does not have
20954 side effects:
20956 @enumerate
20957 @item
20958 the memory occupied by the current function's stack frame;
20960 @item
20961 the memory occupied by an incoming stack argument;
20963 @item
20964 the memory occupied by an object with a link-time-constant address.
20965 @end enumerate
20967 It is the kernel's responsibility to ensure that speculative
20968 accesses to these regions are indeed safe.
20970 If the input program contains a function declaration such as:
20972 @smallexample
20973 void foo (void);
20974 @end smallexample
20976 then the implementation of @code{foo} must allow @code{j foo} and
20977 @code{jal foo} to be executed speculatively.  GCC honors this
20978 restriction for functions it compiles itself.  It expects non-GCC
20979 functions (such as hand-written assembly code) to do the same.
20981 The option has three forms:
20983 @table @gcctabopt
20984 @item -mr10k-cache-barrier=load-store
20985 Insert a cache barrier before a load or store that might be
20986 speculatively executed and that might have side effects even
20987 if aborted.
20989 @item -mr10k-cache-barrier=store
20990 Insert a cache barrier before a store that might be speculatively
20991 executed and that might have side effects even if aborted.
20993 @item -mr10k-cache-barrier=none
20994 Disable the insertion of cache barriers.  This is the default setting.
20995 @end table
20997 @item -mflush-func=@var{func}
20998 @itemx -mno-flush-func
20999 @opindex mflush-func
21000 Specifies the function to call to flush the I and D caches, or to not
21001 call any such function.  If called, the function must take the same
21002 arguments as the common @code{_flush_func}, that is, the address of the
21003 memory range for which the cache is being flushed, the size of the
21004 memory range, and the number 3 (to flush both caches).  The default
21005 depends on the target GCC was configured for, but commonly is either
21006 @code{_flush_func} or @code{__cpu_flush}.
21008 @item mbranch-cost=@var{num}
21009 @opindex mbranch-cost
21010 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21011 This cost is only a heuristic and is not guaranteed to produce
21012 consistent results across releases.  A zero cost redundantly selects
21013 the default, which is based on the @option{-mtune} setting.
21015 @item -mbranch-likely
21016 @itemx -mno-branch-likely
21017 @opindex mbranch-likely
21018 @opindex mno-branch-likely
21019 Enable or disable use of Branch Likely instructions, regardless of the
21020 default for the selected architecture.  By default, Branch Likely
21021 instructions may be generated if they are supported by the selected
21022 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21023 and processors that implement those architectures; for those, Branch
21024 Likely instructions are not be generated by default because the MIPS32
21025 and MIPS64 architectures specifically deprecate their use.
21027 @item -mcompact-branches=never
21028 @itemx -mcompact-branches=optimal
21029 @itemx -mcompact-branches=always
21030 @opindex mcompact-branches=never
21031 @opindex mcompact-branches=optimal
21032 @opindex mcompact-branches=always
21033 These options control which form of branches will be generated.  The
21034 default is @option{-mcompact-branches=optimal}.
21036 The @option{-mcompact-branches=never} option ensures that compact branch
21037 instructions will never be generated.
21039 The @option{-mcompact-branches=always} option ensures that a compact
21040 branch instruction will be generated if available.  If a compact branch
21041 instruction is not available, a delay slot form of the branch will be
21042 used instead.
21044 This option is supported from MIPS Release 6 onwards.
21046 The @option{-mcompact-branches=optimal} option will cause a delay slot
21047 branch to be used if one is available in the current ISA and the delay
21048 slot is successfully filled.  If the delay slot is not filled, a compact
21049 branch will be chosen if one is available.
21051 @item -mfp-exceptions
21052 @itemx -mno-fp-exceptions
21053 @opindex mfp-exceptions
21054 Specifies whether FP exceptions are enabled.  This affects how
21055 FP instructions are scheduled for some processors.
21056 The default is that FP exceptions are
21057 enabled.
21059 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21060 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21061 FP pipe.
21063 @item -mvr4130-align
21064 @itemx -mno-vr4130-align
21065 @opindex mvr4130-align
21066 The VR4130 pipeline is two-way superscalar, but can only issue two
21067 instructions together if the first one is 8-byte aligned.  When this
21068 option is enabled, GCC aligns pairs of instructions that it
21069 thinks should execute in parallel.
21071 This option only has an effect when optimizing for the VR4130.
21072 It normally makes code faster, but at the expense of making it bigger.
21073 It is enabled by default at optimization level @option{-O3}.
21075 @item -msynci
21076 @itemx -mno-synci
21077 @opindex msynci
21078 Enable (disable) generation of @code{synci} instructions on
21079 architectures that support it.  The @code{synci} instructions (if
21080 enabled) are generated when @code{__builtin___clear_cache} is
21081 compiled.
21083 This option defaults to @option{-mno-synci}, but the default can be
21084 overridden by configuring GCC with @option{--with-synci}.
21086 When compiling code for single processor systems, it is generally safe
21087 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21088 does not invalidate the instruction caches on all cores and may lead
21089 to undefined behavior.
21091 @item -mrelax-pic-calls
21092 @itemx -mno-relax-pic-calls
21093 @opindex mrelax-pic-calls
21094 Try to turn PIC calls that are normally dispatched via register
21095 @code{$25} into direct calls.  This is only possible if the linker can
21096 resolve the destination at link time and if the destination is within
21097 range for a direct call.
21099 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21100 an assembler and a linker that support the @code{.reloc} assembly
21101 directive and @option{-mexplicit-relocs} is in effect.  With
21102 @option{-mno-explicit-relocs}, this optimization can be performed by the
21103 assembler and the linker alone without help from the compiler.
21105 @item -mmcount-ra-address
21106 @itemx -mno-mcount-ra-address
21107 @opindex mmcount-ra-address
21108 @opindex mno-mcount-ra-address
21109 Emit (do not emit) code that allows @code{_mcount} to modify the
21110 calling function's return address.  When enabled, this option extends
21111 the usual @code{_mcount} interface with a new @var{ra-address}
21112 parameter, which has type @code{intptr_t *} and is passed in register
21113 @code{$12}.  @code{_mcount} can then modify the return address by
21114 doing both of the following:
21115 @itemize
21116 @item
21117 Returning the new address in register @code{$31}.
21118 @item
21119 Storing the new address in @code{*@var{ra-address}},
21120 if @var{ra-address} is nonnull.
21121 @end itemize
21123 The default is @option{-mno-mcount-ra-address}.
21125 @item -mframe-header-opt
21126 @itemx -mno-frame-header-opt
21127 @opindex mframe-header-opt
21128 Enable (disable) frame header optimization in the o32 ABI.  When using the
21129 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21130 function to write out register arguments.  When enabled, this optimization
21131 will suppress the allocation of the frame header if it can be determined that
21132 it is unused.
21134 This optimization is off by default at all optimization levels.
21136 @item -mlxc1-sxc1
21137 @itemx -mno-lxc1-sxc1
21138 @opindex mlxc1-sxc1
21139 When applicable, enable (disable) the generation of @code{lwxc1},
21140 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21142 @item -mmadd4
21143 @itemx -mno-madd4
21144 @opindex mmadd4
21145 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21146 @code{madd.d} and related instructions.  Enabled by default.
21148 @end table
21150 @node MMIX Options
21151 @subsection MMIX Options
21152 @cindex MMIX Options
21154 These options are defined for the MMIX:
21156 @table @gcctabopt
21157 @item -mlibfuncs
21158 @itemx -mno-libfuncs
21159 @opindex mlibfuncs
21160 @opindex mno-libfuncs
21161 Specify that intrinsic library functions are being compiled, passing all
21162 values in registers, no matter the size.
21164 @item -mepsilon
21165 @itemx -mno-epsilon
21166 @opindex mepsilon
21167 @opindex mno-epsilon
21168 Generate floating-point comparison instructions that compare with respect
21169 to the @code{rE} epsilon register.
21171 @item -mabi=mmixware
21172 @itemx -mabi=gnu
21173 @opindex mabi=mmixware
21174 @opindex mabi=gnu
21175 Generate code that passes function parameters and return values that (in
21176 the called function) are seen as registers @code{$0} and up, as opposed to
21177 the GNU ABI which uses global registers @code{$231} and up.
21179 @item -mzero-extend
21180 @itemx -mno-zero-extend
21181 @opindex mzero-extend
21182 @opindex mno-zero-extend
21183 When reading data from memory in sizes shorter than 64 bits, use (do not
21184 use) zero-extending load instructions by default, rather than
21185 sign-extending ones.
21187 @item -mknuthdiv
21188 @itemx -mno-knuthdiv
21189 @opindex mknuthdiv
21190 @opindex mno-knuthdiv
21191 Make the result of a division yielding a remainder have the same sign as
21192 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21193 remainder follows the sign of the dividend.  Both methods are
21194 arithmetically valid, the latter being almost exclusively used.
21196 @item -mtoplevel-symbols
21197 @itemx -mno-toplevel-symbols
21198 @opindex mtoplevel-symbols
21199 @opindex mno-toplevel-symbols
21200 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21201 code can be used with the @code{PREFIX} assembly directive.
21203 @item -melf
21204 @opindex melf
21205 Generate an executable in the ELF format, rather than the default
21206 @samp{mmo} format used by the @command{mmix} simulator.
21208 @item -mbranch-predict
21209 @itemx -mno-branch-predict
21210 @opindex mbranch-predict
21211 @opindex mno-branch-predict
21212 Use (do not use) the probable-branch instructions, when static branch
21213 prediction indicates a probable branch.
21215 @item -mbase-addresses
21216 @itemx -mno-base-addresses
21217 @opindex mbase-addresses
21218 @opindex mno-base-addresses
21219 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21220 base address automatically generates a request (handled by the assembler
21221 and the linker) for a constant to be set up in a global register.  The
21222 register is used for one or more base address requests within the range 0
21223 to 255 from the value held in the register.  The generally leads to short
21224 and fast code, but the number of different data items that can be
21225 addressed is limited.  This means that a program that uses lots of static
21226 data may require @option{-mno-base-addresses}.
21228 @item -msingle-exit
21229 @itemx -mno-single-exit
21230 @opindex msingle-exit
21231 @opindex mno-single-exit
21232 Force (do not force) generated code to have a single exit point in each
21233 function.
21234 @end table
21236 @node MN10300 Options
21237 @subsection MN10300 Options
21238 @cindex MN10300 options
21240 These @option{-m} options are defined for Matsushita MN10300 architectures:
21242 @table @gcctabopt
21243 @item -mmult-bug
21244 @opindex mmult-bug
21245 Generate code to avoid bugs in the multiply instructions for the MN10300
21246 processors.  This is the default.
21248 @item -mno-mult-bug
21249 @opindex mno-mult-bug
21250 Do not generate code to avoid bugs in the multiply instructions for the
21251 MN10300 processors.
21253 @item -mam33
21254 @opindex mam33
21255 Generate code using features specific to the AM33 processor.
21257 @item -mno-am33
21258 @opindex mno-am33
21259 Do not generate code using features specific to the AM33 processor.  This
21260 is the default.
21262 @item -mam33-2
21263 @opindex mam33-2
21264 Generate code using features specific to the AM33/2.0 processor.
21266 @item -mam34
21267 @opindex mam34
21268 Generate code using features specific to the AM34 processor.
21270 @item -mtune=@var{cpu-type}
21271 @opindex mtune
21272 Use the timing characteristics of the indicated CPU type when
21273 scheduling instructions.  This does not change the targeted processor
21274 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21275 @samp{am33-2} or @samp{am34}.
21277 @item -mreturn-pointer-on-d0
21278 @opindex mreturn-pointer-on-d0
21279 When generating a function that returns a pointer, return the pointer
21280 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21281 only in @code{a0}, and attempts to call such functions without a prototype
21282 result in errors.  Note that this option is on by default; use
21283 @option{-mno-return-pointer-on-d0} to disable it.
21285 @item -mno-crt0
21286 @opindex mno-crt0
21287 Do not link in the C run-time initialization object file.
21289 @item -mrelax
21290 @opindex mrelax
21291 Indicate to the linker that it should perform a relaxation optimization pass
21292 to shorten branches, calls and absolute memory addresses.  This option only
21293 has an effect when used on the command line for the final link step.
21295 This option makes symbolic debugging impossible.
21297 @item -mliw
21298 @opindex mliw
21299 Allow the compiler to generate @emph{Long Instruction Word}
21300 instructions if the target is the @samp{AM33} or later.  This is the
21301 default.  This option defines the preprocessor macro @code{__LIW__}.
21303 @item -mnoliw
21304 @opindex mnoliw
21305 Do not allow the compiler to generate @emph{Long Instruction Word}
21306 instructions.  This option defines the preprocessor macro
21307 @code{__NO_LIW__}.
21309 @item -msetlb
21310 @opindex msetlb
21311 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21312 instructions if the target is the @samp{AM33} or later.  This is the
21313 default.  This option defines the preprocessor macro @code{__SETLB__}.
21315 @item -mnosetlb
21316 @opindex mnosetlb
21317 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21318 instructions.  This option defines the preprocessor macro
21319 @code{__NO_SETLB__}.
21321 @end table
21323 @node Moxie Options
21324 @subsection Moxie Options
21325 @cindex Moxie Options
21327 @table @gcctabopt
21329 @item -meb
21330 @opindex meb
21331 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21332 configurations.
21334 @item -mel
21335 @opindex mel
21336 Generate little-endian code.
21338 @item -mmul.x
21339 @opindex mmul.x
21340 Generate mul.x and umul.x instructions.  This is the default for
21341 @samp{moxiebox-*-*} configurations.
21343 @item -mno-crt0
21344 @opindex mno-crt0
21345 Do not link in the C run-time initialization object file.
21347 @end table
21349 @node MSP430 Options
21350 @subsection MSP430 Options
21351 @cindex MSP430 Options
21353 These options are defined for the MSP430:
21355 @table @gcctabopt
21357 @item -masm-hex
21358 @opindex masm-hex
21359 Force assembly output to always use hex constants.  Normally such
21360 constants are signed decimals, but this option is available for
21361 testsuite and/or aesthetic purposes.
21363 @item -mmcu=
21364 @opindex mmcu=
21365 Select the MCU to target.  This is used to create a C preprocessor
21366 symbol based upon the MCU name, converted to upper case and pre- and
21367 post-fixed with @samp{__}.  This in turn is used by the
21368 @file{msp430.h} header file to select an MCU-specific supplementary
21369 header file.
21371 The option also sets the ISA to use.  If the MCU name is one that is
21372 known to only support the 430 ISA then that is selected, otherwise the
21373 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21374 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21375 name selects the 430X ISA.
21377 In addition an MCU-specific linker script is added to the linker
21378 command line.  The script's name is the name of the MCU with
21379 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21380 command line defines the C preprocessor symbol @code{__XXX__} and
21381 cause the linker to search for a script called @file{xxx.ld}.
21383 This option is also passed on to the assembler.
21385 @item -mwarn-mcu
21386 @itemx -mno-warn-mcu
21387 @opindex mwarn-mcu
21388 @opindex mno-warn-mcu
21389 This option enables or disables warnings about conflicts between the
21390 MCU name specified by the @option{-mmcu} option and the ISA set by the
21391 @option{-mcpu} option and/or the hardware multiply support set by the
21392 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21393 MCU names.  This option is on by default.
21395 @item -mcpu=
21396 @opindex mcpu=
21397 Specifies the ISA to use.  Accepted values are @samp{msp430},
21398 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21399 @option{-mmcu=} option should be used to select the ISA.
21401 @item -msim
21402 @opindex msim
21403 Link to the simulator runtime libraries and linker script.  Overrides
21404 any scripts that would be selected by the @option{-mmcu=} option.
21406 @item -mlarge
21407 @opindex mlarge
21408 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21410 @item -msmall
21411 @opindex msmall
21412 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21414 @item -mrelax
21415 @opindex mrelax
21416 This option is passed to the assembler and linker, and allows the
21417 linker to perform certain optimizations that cannot be done until
21418 the final link.
21420 @item mhwmult=
21421 @opindex mhwmult=
21422 Describes the type of hardware multiply supported by the target.
21423 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21424 for the original 16-bit-only multiply supported by early MCUs.
21425 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21426 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21427 A value of @samp{auto} can also be given.  This tells GCC to deduce
21428 the hardware multiply support based upon the MCU name provided by the
21429 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21430 the MCU name is not recognized then no hardware multiply support is
21431 assumed.  @code{auto} is the default setting.
21433 Hardware multiplies are normally performed by calling a library
21434 routine.  This saves space in the generated code.  When compiling at
21435 @option{-O3} or higher however the hardware multiplier is invoked
21436 inline.  This makes for bigger, but faster code.
21438 The hardware multiply routines disable interrupts whilst running and
21439 restore the previous interrupt state when they finish.  This makes
21440 them safe to use inside interrupt handlers as well as in normal code.
21442 @item -minrt
21443 @opindex minrt
21444 Enable the use of a minimum runtime environment - no static
21445 initializers or constructors.  This is intended for memory-constrained
21446 devices.  The compiler includes special symbols in some objects
21447 that tell the linker and runtime which code fragments are required.
21449 @item -mcode-region=
21450 @itemx -mdata-region=
21451 @opindex mcode-region
21452 @opindex mdata-region
21453 These options tell the compiler where to place functions and data that
21454 do not have one of the @code{lower}, @code{upper}, @code{either} or
21455 @code{section} attributes.  Possible values are @code{lower},
21456 @code{upper}, @code{either} or @code{any}.  The first three behave
21457 like the corresponding attribute.  The fourth possible value -
21458 @code{any} - is the default.  It leaves placement entirely up to the
21459 linker script and how it assigns the standard sections
21460 (@code{.text}, @code{.data}, etc) to the memory regions.
21462 @item -msilicon-errata=
21463 @opindex msilicon-errata
21464 This option passes on a request to assembler to enable the fixes for
21465 the named silicon errata.
21467 @item -msilicon-errata-warn=
21468 @opindex msilicon-errata-warn
21469 This option passes on a request to the assembler to enable warning
21470 messages when a silicon errata might need to be applied.
21472 @end table
21474 @node NDS32 Options
21475 @subsection NDS32 Options
21476 @cindex NDS32 Options
21478 These options are defined for NDS32 implementations:
21480 @table @gcctabopt
21482 @item -mbig-endian
21483 @opindex mbig-endian
21484 Generate code in big-endian mode.
21486 @item -mlittle-endian
21487 @opindex mlittle-endian
21488 Generate code in little-endian mode.
21490 @item -mreduced-regs
21491 @opindex mreduced-regs
21492 Use reduced-set registers for register allocation.
21494 @item -mfull-regs
21495 @opindex mfull-regs
21496 Use full-set registers for register allocation.
21498 @item -mcmov
21499 @opindex mcmov
21500 Generate conditional move instructions.
21502 @item -mno-cmov
21503 @opindex mno-cmov
21504 Do not generate conditional move instructions.
21506 @item -mext-perf
21507 @opindex mperf-ext
21508 Generate performance extension instructions.
21510 @item -mno-ext-perf
21511 @opindex mno-perf-ext
21512 Do not generate performance extension instructions.
21514 @item -mext-perf2
21515 @opindex mperf-ext
21516 Generate performance extension 2 instructions.
21518 @item -mno-ext-perf2
21519 @opindex mno-perf-ext
21520 Do not generate performance extension 2 instructions.
21522 @item -mext-string
21523 @opindex mperf-ext
21524 Generate string extension instructions.
21526 @item -mno-ext-string
21527 @opindex mno-perf-ext
21528 Do not generate string extension instructions.
21530 @item -mv3push
21531 @opindex mv3push
21532 Generate v3 push25/pop25 instructions.
21534 @item -mno-v3push
21535 @opindex mno-v3push
21536 Do not generate v3 push25/pop25 instructions.
21538 @item -m16-bit
21539 @opindex m16-bit
21540 Generate 16-bit instructions.
21542 @item -mno-16-bit
21543 @opindex mno-16-bit
21544 Do not generate 16-bit instructions.
21546 @item -misr-vector-size=@var{num}
21547 @opindex misr-vector-size
21548 Specify the size of each interrupt vector, which must be 4 or 16.
21550 @item -mcache-block-size=@var{num}
21551 @opindex mcache-block-size
21552 Specify the size of each cache block,
21553 which must be a power of 2 between 4 and 512.
21555 @item -march=@var{arch}
21556 @opindex march
21557 Specify the name of the target architecture.
21559 @item -mcmodel=@var{code-model}
21560 @opindex mcmodel
21561 Set the code model to one of
21562 @table @asis
21563 @item @samp{small}
21564 All the data and read-only data segments must be within 512KB addressing space.
21565 The text segment must be within 16MB addressing space.
21566 @item @samp{medium}
21567 The data segment must be within 512KB while the read-only data segment can be
21568 within 4GB addressing space.  The text segment should be still within 16MB
21569 addressing space.
21570 @item @samp{large}
21571 All the text and data segments can be within 4GB addressing space.
21572 @end table
21574 @item -mctor-dtor
21575 @opindex mctor-dtor
21576 Enable constructor/destructor feature.
21578 @item -mrelax
21579 @opindex mrelax
21580 Guide linker to relax instructions.
21582 @end table
21584 @node Nios II Options
21585 @subsection Nios II Options
21586 @cindex Nios II options
21587 @cindex Altera Nios II options
21589 These are the options defined for the Altera Nios II processor.
21591 @table @gcctabopt
21593 @item -G @var{num}
21594 @opindex G
21595 @cindex smaller data references
21596 Put global and static objects less than or equal to @var{num} bytes
21597 into the small data or BSS sections instead of the normal data or BSS
21598 sections.  The default value of @var{num} is 8.
21600 @item -mgpopt=@var{option}
21601 @itemx -mgpopt
21602 @itemx -mno-gpopt
21603 @opindex mgpopt
21604 @opindex mno-gpopt
21605 Generate (do not generate) GP-relative accesses.  The following 
21606 @var{option} names are recognized:
21608 @table @samp
21610 @item none
21611 Do not generate GP-relative accesses.
21613 @item local
21614 Generate GP-relative accesses for small data objects that are not 
21615 external, weak, or uninitialized common symbols.  
21616 Also use GP-relative addressing for objects that
21617 have been explicitly placed in a small data section via a @code{section}
21618 attribute.
21620 @item global
21621 As for @samp{local}, but also generate GP-relative accesses for
21622 small data objects that are external, weak, or common.  If you use this option,
21623 you must ensure that all parts of your program (including libraries) are
21624 compiled with the same @option{-G} setting.
21626 @item data
21627 Generate GP-relative accesses for all data objects in the program.  If you
21628 use this option, the entire data and BSS segments
21629 of your program must fit in 64K of memory and you must use an appropriate
21630 linker script to allocate them within the addressable range of the
21631 global pointer.
21633 @item all
21634 Generate GP-relative addresses for function pointers as well as data
21635 pointers.  If you use this option, the entire text, data, and BSS segments
21636 of your program must fit in 64K of memory and you must use an appropriate
21637 linker script to allocate them within the addressable range of the
21638 global pointer.
21640 @end table
21642 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21643 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21645 The default is @option{-mgpopt} except when @option{-fpic} or
21646 @option{-fPIC} is specified to generate position-independent code.
21647 Note that the Nios II ABI does not permit GP-relative accesses from
21648 shared libraries.
21650 You may need to specify @option{-mno-gpopt} explicitly when building
21651 programs that include large amounts of small data, including large
21652 GOT data sections.  In this case, the 16-bit offset for GP-relative
21653 addressing may not be large enough to allow access to the entire 
21654 small data section.
21656 @item -mgprel-sec=@var{regexp}
21657 @opindex mgprel-sec
21658 This option specifies additional section names that can be accessed via
21659 GP-relative addressing.  It is most useful in conjunction with 
21660 @code{section} attributes on variable declarations 
21661 (@pxref{Common Variable Attributes}) and a custom linker script.  
21662 The @var{regexp} is a POSIX Extended Regular Expression.
21664 This option does not affect the behavior of the @option{-G} option, and 
21665 and the specified sections are in addition to the standard @code{.sdata} 
21666 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21668 @item -mr0rel-sec=@var{regexp}
21669 @opindex mr0rel-sec
21670 This option specifies names of sections that can be accessed via a 
21671 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21672 of the 32-bit address space.  It is most useful in conjunction with 
21673 @code{section} attributes on variable declarations 
21674 (@pxref{Common Variable Attributes}) and a custom linker script.  
21675 The @var{regexp} is a POSIX Extended Regular Expression.
21677 In contrast to the use of GP-relative addressing for small data, 
21678 zero-based addressing is never generated by default and there are no 
21679 conventional section names used in standard linker scripts for sections
21680 in the low or high areas of memory.
21682 @item -mel
21683 @itemx -meb
21684 @opindex mel
21685 @opindex meb
21686 Generate little-endian (default) or big-endian (experimental) code,
21687 respectively.
21689 @item -march=@var{arch}
21690 @opindex march
21691 This specifies the name of the target Nios II architecture.  GCC uses this
21692 name to determine what kind of instructions it can emit when generating
21693 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21695 The preprocessor macro @code{__nios2_arch__} is available to programs,
21696 with value 1 or 2, indicating the targeted ISA level.
21698 @item -mbypass-cache
21699 @itemx -mno-bypass-cache
21700 @opindex mno-bypass-cache
21701 @opindex mbypass-cache
21702 Force all load and store instructions to always bypass cache by 
21703 using I/O variants of the instructions. The default is not to
21704 bypass the cache.
21706 @item -mno-cache-volatile 
21707 @itemx -mcache-volatile       
21708 @opindex mcache-volatile 
21709 @opindex mno-cache-volatile
21710 Volatile memory access bypass the cache using the I/O variants of 
21711 the load and store instructions. The default is not to bypass the cache.
21713 @item -mno-fast-sw-div
21714 @itemx -mfast-sw-div
21715 @opindex mno-fast-sw-div
21716 @opindex mfast-sw-div
21717 Do not use table-based fast divide for small numbers. The default 
21718 is to use the fast divide at @option{-O3} and above.
21720 @item -mno-hw-mul
21721 @itemx -mhw-mul
21722 @itemx -mno-hw-mulx
21723 @itemx -mhw-mulx
21724 @itemx -mno-hw-div
21725 @itemx -mhw-div
21726 @opindex mno-hw-mul
21727 @opindex mhw-mul
21728 @opindex mno-hw-mulx
21729 @opindex mhw-mulx
21730 @opindex mno-hw-div
21731 @opindex mhw-div
21732 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21733 instructions by the compiler. The default is to emit @code{mul}
21734 and not emit @code{div} and @code{mulx}.
21736 @item -mbmx
21737 @itemx -mno-bmx
21738 @itemx -mcdx
21739 @itemx -mno-cdx
21740 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21741 CDX (code density) instructions.  Enabling these instructions also
21742 requires @option{-march=r2}.  Since these instructions are optional
21743 extensions to the R2 architecture, the default is not to emit them.
21745 @item -mcustom-@var{insn}=@var{N}
21746 @itemx -mno-custom-@var{insn}
21747 @opindex mcustom-@var{insn}
21748 @opindex mno-custom-@var{insn}
21749 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21750 custom instruction with encoding @var{N} when generating code that uses 
21751 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21752 instruction 253 for single-precision floating-point add operations instead
21753 of the default behavior of using a library call.
21755 The following values of @var{insn} are supported.  Except as otherwise
21756 noted, floating-point operations are expected to be implemented with
21757 normal IEEE 754 semantics and correspond directly to the C operators or the
21758 equivalent GCC built-in functions (@pxref{Other Builtins}).
21760 Single-precision floating point:
21761 @table @asis
21763 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21764 Binary arithmetic operations.
21766 @item @samp{fnegs}
21767 Unary negation.
21769 @item @samp{fabss}
21770 Unary absolute value.
21772 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21773 Comparison operations.
21775 @item @samp{fmins}, @samp{fmaxs}
21776 Floating-point minimum and maximum.  These instructions are only
21777 generated if @option{-ffinite-math-only} is specified.
21779 @item @samp{fsqrts}
21780 Unary square root operation.
21782 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21783 Floating-point trigonometric and exponential functions.  These instructions
21784 are only generated if @option{-funsafe-math-optimizations} is also specified.
21786 @end table
21788 Double-precision floating point:
21789 @table @asis
21791 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21792 Binary arithmetic operations.
21794 @item @samp{fnegd}
21795 Unary negation.
21797 @item @samp{fabsd}
21798 Unary absolute value.
21800 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21801 Comparison operations.
21803 @item @samp{fmind}, @samp{fmaxd}
21804 Double-precision minimum and maximum.  These instructions are only
21805 generated if @option{-ffinite-math-only} is specified.
21807 @item @samp{fsqrtd}
21808 Unary square root operation.
21810 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21811 Double-precision trigonometric and exponential functions.  These instructions
21812 are only generated if @option{-funsafe-math-optimizations} is also specified.
21814 @end table
21816 Conversions:
21817 @table @asis
21818 @item @samp{fextsd}
21819 Conversion from single precision to double precision.
21821 @item @samp{ftruncds}
21822 Conversion from double precision to single precision.
21824 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21825 Conversion from floating point to signed or unsigned integer types, with
21826 truncation towards zero.
21828 @item @samp{round}
21829 Conversion from single-precision floating point to signed integer,
21830 rounding to the nearest integer and ties away from zero.
21831 This corresponds to the @code{__builtin_lroundf} function when
21832 @option{-fno-math-errno} is used.
21834 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21835 Conversion from signed or unsigned integer types to floating-point types.
21837 @end table
21839 In addition, all of the following transfer instructions for internal
21840 registers X and Y must be provided to use any of the double-precision
21841 floating-point instructions.  Custom instructions taking two
21842 double-precision source operands expect the first operand in the
21843 64-bit register X.  The other operand (or only operand of a unary
21844 operation) is given to the custom arithmetic instruction with the
21845 least significant half in source register @var{src1} and the most
21846 significant half in @var{src2}.  A custom instruction that returns a
21847 double-precision result returns the most significant 32 bits in the
21848 destination register and the other half in 32-bit register Y.  
21849 GCC automatically generates the necessary code sequences to write
21850 register X and/or read register Y when double-precision floating-point
21851 instructions are used.
21853 @table @asis
21855 @item @samp{fwrx}
21856 Write @var{src1} into the least significant half of X and @var{src2} into
21857 the most significant half of X.
21859 @item @samp{fwry}
21860 Write @var{src1} into Y.
21862 @item @samp{frdxhi}, @samp{frdxlo}
21863 Read the most or least (respectively) significant half of X and store it in
21864 @var{dest}.
21866 @item @samp{frdy}
21867 Read the value of Y and store it into @var{dest}.
21868 @end table
21870 Note that you can gain more local control over generation of Nios II custom
21871 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21872 and @code{target("no-custom-@var{insn}")} function attributes
21873 (@pxref{Function Attributes})
21874 or pragmas (@pxref{Function Specific Option Pragmas}).
21876 @item -mcustom-fpu-cfg=@var{name}
21877 @opindex mcustom-fpu-cfg
21879 This option enables a predefined, named set of custom instruction encodings
21880 (see @option{-mcustom-@var{insn}} above).  
21881 Currently, the following sets are defined:
21883 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21884 @gccoptlist{-mcustom-fmuls=252 @gol
21885 -mcustom-fadds=253 @gol
21886 -mcustom-fsubs=254 @gol
21887 -fsingle-precision-constant}
21889 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21890 @gccoptlist{-mcustom-fmuls=252 @gol
21891 -mcustom-fadds=253 @gol
21892 -mcustom-fsubs=254 @gol
21893 -mcustom-fdivs=255 @gol
21894 -fsingle-precision-constant}
21896 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21897 @gccoptlist{-mcustom-floatus=243 @gol
21898 -mcustom-fixsi=244 @gol
21899 -mcustom-floatis=245 @gol
21900 -mcustom-fcmpgts=246 @gol
21901 -mcustom-fcmples=249 @gol
21902 -mcustom-fcmpeqs=250 @gol
21903 -mcustom-fcmpnes=251 @gol
21904 -mcustom-fmuls=252 @gol
21905 -mcustom-fadds=253 @gol
21906 -mcustom-fsubs=254 @gol
21907 -mcustom-fdivs=255 @gol
21908 -fsingle-precision-constant}
21910 Custom instruction assignments given by individual
21911 @option{-mcustom-@var{insn}=} options override those given by
21912 @option{-mcustom-fpu-cfg=}, regardless of the
21913 order of the options on the command line.
21915 Note that you can gain more local control over selection of a FPU
21916 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21917 function attribute (@pxref{Function Attributes})
21918 or pragma (@pxref{Function Specific Option Pragmas}).
21920 @end table
21922 These additional @samp{-m} options are available for the Altera Nios II
21923 ELF (bare-metal) target:
21925 @table @gcctabopt
21927 @item -mhal
21928 @opindex mhal
21929 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21930 startup and termination code, and is typically used in conjunction with
21931 @option{-msys-crt0=} to specify the location of the alternate startup code
21932 provided by the HAL BSP.
21934 @item -msmallc
21935 @opindex msmallc
21936 Link with a limited version of the C library, @option{-lsmallc}, rather than
21937 Newlib.
21939 @item -msys-crt0=@var{startfile}
21940 @opindex msys-crt0
21941 @var{startfile} is the file name of the startfile (crt0) to use 
21942 when linking.  This option is only useful in conjunction with @option{-mhal}.
21944 @item -msys-lib=@var{systemlib}
21945 @opindex msys-lib
21946 @var{systemlib} is the library name of the library that provides
21947 low-level system calls required by the C library,
21948 e.g. @code{read} and @code{write}.
21949 This option is typically used to link with a library provided by a HAL BSP.
21951 @end table
21953 @node Nvidia PTX Options
21954 @subsection Nvidia PTX Options
21955 @cindex Nvidia PTX options
21956 @cindex nvptx options
21958 These options are defined for Nvidia PTX:
21960 @table @gcctabopt
21962 @item -m32
21963 @itemx -m64
21964 @opindex m32
21965 @opindex m64
21966 Generate code for 32-bit or 64-bit ABI.
21968 @item -mmainkernel
21969 @opindex mmainkernel
21970 Link in code for a __main kernel.  This is for stand-alone instead of
21971 offloading execution.
21973 @item -moptimize
21974 @opindex moptimize
21975 Apply partitioned execution optimizations.  This is the default when any
21976 level of optimization is selected.
21978 @item -msoft-stack
21979 @opindex msoft-stack
21980 Generate code that does not use @code{.local} memory
21981 directly for stack storage. Instead, a per-warp stack pointer is
21982 maintained explicitly. This enables variable-length stack allocation (with
21983 variable-length arrays or @code{alloca}), and when global memory is used for
21984 underlying storage, makes it possible to access automatic variables from other
21985 threads, or with atomic instructions. This code generation variant is used
21986 for OpenMP offloading, but the option is exposed on its own for the purpose
21987 of testing the compiler; to generate code suitable for linking into programs
21988 using OpenMP offloading, use option @option{-mgomp}.
21990 @item -muniform-simt
21991 @opindex muniform-simt
21992 Switch to code generation variant that allows to execute all threads in each
21993 warp, while maintaining memory state and side effects as if only one thread
21994 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21995 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21996 current lane index equals the master lane index), and the register being
21997 assigned is copied via a shuffle instruction from the master lane.  Outside of
21998 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21999 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22000 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22001 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22002 with current lane index to compute the master lane index.
22004 @item -mgomp
22005 @opindex mgomp
22006 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22007 @option{-muniform-simt} options, and selects corresponding multilib variant.
22009 @end table
22011 @node PDP-11 Options
22012 @subsection PDP-11 Options
22013 @cindex PDP-11 Options
22015 These options are defined for the PDP-11:
22017 @table @gcctabopt
22018 @item -mfpu
22019 @opindex mfpu
22020 Use hardware FPP floating point.  This is the default.  (FIS floating
22021 point on the PDP-11/40 is not supported.)
22023 @item -msoft-float
22024 @opindex msoft-float
22025 Do not use hardware floating point.
22027 @item -mac0
22028 @opindex mac0
22029 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22031 @item -mno-ac0
22032 @opindex mno-ac0
22033 Return floating-point results in memory.  This is the default.
22035 @item -m40
22036 @opindex m40
22037 Generate code for a PDP-11/40.
22039 @item -m45
22040 @opindex m45
22041 Generate code for a PDP-11/45.  This is the default.
22043 @item -m10
22044 @opindex m10
22045 Generate code for a PDP-11/10.
22047 @item -mbcopy-builtin
22048 @opindex mbcopy-builtin
22049 Use inline @code{movmemhi} patterns for copying memory.  This is the
22050 default.
22052 @item -mbcopy
22053 @opindex mbcopy
22054 Do not use inline @code{movmemhi} patterns for copying memory.
22056 @item -mint16
22057 @itemx -mno-int32
22058 @opindex mint16
22059 @opindex mno-int32
22060 Use 16-bit @code{int}.  This is the default.
22062 @item -mint32
22063 @itemx -mno-int16
22064 @opindex mint32
22065 @opindex mno-int16
22066 Use 32-bit @code{int}.
22068 @item -mfloat64
22069 @itemx -mno-float32
22070 @opindex mfloat64
22071 @opindex mno-float32
22072 Use 64-bit @code{float}.  This is the default.
22074 @item -mfloat32
22075 @itemx -mno-float64
22076 @opindex mfloat32
22077 @opindex mno-float64
22078 Use 32-bit @code{float}.
22080 @item -mabshi
22081 @opindex mabshi
22082 Use @code{abshi2} pattern.  This is the default.
22084 @item -mno-abshi
22085 @opindex mno-abshi
22086 Do not use @code{abshi2} pattern.
22088 @item -mbranch-expensive
22089 @opindex mbranch-expensive
22090 Pretend that branches are expensive.  This is for experimenting with
22091 code generation only.
22093 @item -mbranch-cheap
22094 @opindex mbranch-cheap
22095 Do not pretend that branches are expensive.  This is the default.
22097 @item -munix-asm
22098 @opindex munix-asm
22099 Use Unix assembler syntax.  This is the default when configured for
22100 @samp{pdp11-*-bsd}.
22102 @item -mdec-asm
22103 @opindex mdec-asm
22104 Use DEC assembler syntax.  This is the default when configured for any
22105 PDP-11 target other than @samp{pdp11-*-bsd}.
22106 @end table
22108 @node picoChip Options
22109 @subsection picoChip Options
22110 @cindex picoChip options
22112 These @samp{-m} options are defined for picoChip implementations:
22114 @table @gcctabopt
22116 @item -mae=@var{ae_type}
22117 @opindex mcpu
22118 Set the instruction set, register set, and instruction scheduling
22119 parameters for array element type @var{ae_type}.  Supported values
22120 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22122 @option{-mae=ANY} selects a completely generic AE type.  Code
22123 generated with this option runs on any of the other AE types.  The
22124 code is not as efficient as it would be if compiled for a specific
22125 AE type, and some types of operation (e.g., multiplication) do not
22126 work properly on all types of AE.
22128 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22129 for compiled code, and is the default.
22131 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22132 option may suffer from poor performance of byte (char) manipulation,
22133 since the DSP AE does not provide hardware support for byte load/stores.
22135 @item -msymbol-as-address
22136 Enable the compiler to directly use a symbol name as an address in a
22137 load/store instruction, without first loading it into a
22138 register.  Typically, the use of this option generates larger
22139 programs, which run faster than when the option isn't used.  However, the
22140 results vary from program to program, so it is left as a user option,
22141 rather than being permanently enabled.
22143 @item -mno-inefficient-warnings
22144 Disables warnings about the generation of inefficient code.  These
22145 warnings can be generated, for example, when compiling code that
22146 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22147 no hardware support for byte-level memory operations, so all byte
22148 load/stores must be synthesized from word load/store operations.  This is
22149 inefficient and a warning is generated to indicate
22150 that you should rewrite the code to avoid byte operations, or to target
22151 an AE type that has the necessary hardware support.  This option disables
22152 these warnings.
22154 @end table
22156 @node PowerPC Options
22157 @subsection PowerPC Options
22158 @cindex PowerPC options
22160 These are listed under @xref{RS/6000 and PowerPC Options}.
22162 @node PowerPC SPE Options
22163 @subsection PowerPC SPE Options
22164 @cindex PowerPC SPE options
22166 These @samp{-m} options are defined for PowerPC SPE:
22167 @table @gcctabopt
22168 @item -mmfcrf
22169 @itemx -mno-mfcrf
22170 @itemx -mpopcntb
22171 @itemx -mno-popcntb
22172 @opindex mmfcrf
22173 @opindex mno-mfcrf
22174 @opindex mpopcntb
22175 @opindex mno-popcntb
22176 You use these options to specify which instructions are available on the
22177 processor you are using.  The default value of these options is
22178 determined when configuring GCC@.  Specifying the
22179 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22180 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22181 rather than the options listed above.
22183 The @option{-mmfcrf} option allows GCC to generate the move from
22184 condition register field instruction implemented on the POWER4
22185 processor and other processors that support the PowerPC V2.01
22186 architecture.
22187 The @option{-mpopcntb} option allows GCC to generate the popcount and
22188 double-precision FP reciprocal estimate instruction implemented on the
22189 POWER5 processor and other processors that support the PowerPC V2.02
22190 architecture.
22192 @item -mcpu=@var{cpu_type}
22193 @opindex mcpu
22194 Set architecture type, register usage, and
22195 instruction scheduling parameters for machine type @var{cpu_type}.
22196 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22197 and @samp{native}.
22199 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22200 endian), with an appropriate, generic processor model assumed for
22201 scheduling purposes.
22203 Specifying @samp{native} as cpu type detects and selects the
22204 architecture option that corresponds to the host processor of the
22205 system performing the compilation.
22206 @option{-mcpu=native} has no effect if GCC does not recognize the
22207 processor.
22209 The other options specify a specific processor.  Code generated under
22210 those options runs best on that processor, and may not run at all on
22211 others.
22213 The @option{-mcpu} options automatically enable or disable the
22214 following options:
22216 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22217 -mpopcntb -mpopcntd @gol
22218 -msingle-float -mdouble-float @gol
22219 -mfloat128}
22221 The particular options set for any particular CPU varies between
22222 compiler versions, depending on what setting seems to produce optimal
22223 code for that CPU; it doesn't necessarily reflect the actual hardware's
22224 capabilities.  If you wish to set an individual option to a particular
22225 value, you may specify it after the @option{-mcpu} option, like
22226 @option{-mcpu=8548}.
22228 @item -mtune=@var{cpu_type}
22229 @opindex mtune
22230 Set the instruction scheduling parameters for machine type
22231 @var{cpu_type}, but do not set the architecture type or register usage,
22232 as @option{-mcpu=@var{cpu_type}} does.  The same
22233 values for @var{cpu_type} are used for @option{-mtune} as for
22234 @option{-mcpu}.  If both are specified, the code generated uses the
22235 architecture and registers set by @option{-mcpu}, but the
22236 scheduling parameters set by @option{-mtune}.
22238 @item -msecure-plt
22239 @opindex msecure-plt
22240 Generate code that allows @command{ld} and @command{ld.so}
22241 to build executables and shared
22242 libraries with non-executable @code{.plt} and @code{.got} sections.
22243 This is a PowerPC
22244 32-bit SYSV ABI option.
22246 @item -mbss-plt
22247 @opindex mbss-plt
22248 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22249 fills in, and
22250 requires @code{.plt} and @code{.got}
22251 sections that are both writable and executable.
22252 This is a PowerPC 32-bit SYSV ABI option.
22254 @item -misel
22255 @itemx -mno-isel
22256 @opindex misel
22257 @opindex mno-isel
22258 This switch enables or disables the generation of ISEL instructions.
22260 @item -misel=@var{yes/no}
22261 This switch has been deprecated.  Use @option{-misel} and
22262 @option{-mno-isel} instead.
22264 @item -mspe
22265 @itemx -mno-spe
22266 @opindex mspe
22267 @opindex mno-spe
22268 This switch enables or disables the generation of SPE simd
22269 instructions.
22271 @item -mspe=@var{yes/no}
22272 This option has been deprecated.  Use @option{-mspe} and
22273 @option{-mno-spe} instead.
22275 @item -mfloat128
22276 @itemx -mno-float128
22277 @opindex mfloat128
22278 @opindex mno-float128
22279 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22280 and use either software emulation for IEEE 128-bit floating point or
22281 hardware instructions.
22283 @item -mfloat-gprs=@var{yes/single/double/no}
22284 @itemx -mfloat-gprs
22285 @opindex mfloat-gprs
22286 This switch enables or disables the generation of floating-point
22287 operations on the general-purpose registers for architectures that
22288 support it.
22290 The argument @samp{yes} or @samp{single} enables the use of
22291 single-precision floating-point operations.
22293 The argument @samp{double} enables the use of single and
22294 double-precision floating-point operations.
22296 The argument @samp{no} disables floating-point operations on the
22297 general-purpose registers.
22299 This option is currently only available on the MPC854x.
22301 @item -mfull-toc
22302 @itemx -mno-fp-in-toc
22303 @itemx -mno-sum-in-toc
22304 @itemx -mminimal-toc
22305 @opindex mfull-toc
22306 @opindex mno-fp-in-toc
22307 @opindex mno-sum-in-toc
22308 @opindex mminimal-toc
22309 Modify generation of the TOC (Table Of Contents), which is created for
22310 every executable file.  The @option{-mfull-toc} option is selected by
22311 default.  In that case, GCC allocates at least one TOC entry for
22312 each unique non-automatic variable reference in your program.  GCC
22313 also places floating-point constants in the TOC@.  However, only
22314 16,384 entries are available in the TOC@.
22316 If you receive a linker error message that saying you have overflowed
22317 the available TOC space, you can reduce the amount of TOC space used
22318 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22319 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22320 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22321 generate code to calculate the sum of an address and a constant at
22322 run time instead of putting that sum into the TOC@.  You may specify one
22323 or both of these options.  Each causes GCC to produce very slightly
22324 slower and larger code at the expense of conserving TOC space.
22326 If you still run out of space in the TOC even when you specify both of
22327 these options, specify @option{-mminimal-toc} instead.  This option causes
22328 GCC to make only one TOC entry for every file.  When you specify this
22329 option, GCC produces code that is slower and larger but which
22330 uses extremely little TOC space.  You may wish to use this option
22331 only on files that contain less frequently-executed code.
22333 @item -maix32
22334 @opindex maix32
22335 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22337 @item -mxl-compat
22338 @itemx -mno-xl-compat
22339 @opindex mxl-compat
22340 @opindex mno-xl-compat
22341 Produce code that conforms more closely to IBM XL compiler semantics
22342 when using AIX-compatible ABI@.  Pass floating-point arguments to
22343 prototyped functions beyond the register save area (RSA) on the stack
22344 in addition to argument FPRs.  Do not assume that most significant
22345 double in 128-bit long double value is properly rounded when comparing
22346 values and converting to double.  Use XL symbol names for long double
22347 support routines.
22349 The AIX calling convention was extended but not initially documented to
22350 handle an obscure K&R C case of calling a function that takes the
22351 address of its arguments with fewer arguments than declared.  IBM XL
22352 compilers access floating-point arguments that do not fit in the
22353 RSA from the stack when a subroutine is compiled without
22354 optimization.  Because always storing floating-point arguments on the
22355 stack is inefficient and rarely needed, this option is not enabled by
22356 default and only is necessary when calling subroutines compiled by IBM
22357 XL compilers without optimization.
22359 @item -malign-natural
22360 @itemx -malign-power
22361 @opindex malign-natural
22362 @opindex malign-power
22363 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22364 @option{-malign-natural} overrides the ABI-defined alignment of larger
22365 types, such as floating-point doubles, on their natural size-based boundary.
22366 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22367 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22369 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22370 is not supported.
22372 @item -msoft-float
22373 @itemx -mhard-float
22374 @opindex msoft-float
22375 @opindex mhard-float
22376 Generate code that does not use (uses) the floating-point register set.
22377 Software floating-point emulation is provided if you use the
22378 @option{-msoft-float} option, and pass the option to GCC when linking.
22380 @item -msingle-float
22381 @itemx -mdouble-float
22382 @opindex msingle-float
22383 @opindex mdouble-float
22384 Generate code for single- or double-precision floating-point operations.
22385 @option{-mdouble-float} implies @option{-msingle-float}.
22387 @item -mmultiple
22388 @itemx -mno-multiple
22389 @opindex mmultiple
22390 @opindex mno-multiple
22391 Generate code that uses (does not use) the load multiple word
22392 instructions and the store multiple word instructions.  These
22393 instructions are generated by default on POWER systems, and not
22394 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22395 PowerPC systems, since those instructions do not work when the
22396 processor is in little-endian mode.  The exceptions are PPC740 and
22397 PPC750 which permit these instructions in little-endian mode.
22399 @item -mupdate
22400 @itemx -mno-update
22401 @opindex mupdate
22402 @opindex mno-update
22403 Generate code that uses (does not use) the load or store instructions
22404 that update the base register to the address of the calculated memory
22405 location.  These instructions are generated by default.  If you use
22406 @option{-mno-update}, there is a small window between the time that the
22407 stack pointer is updated and the address of the previous frame is
22408 stored, which means code that walks the stack frame across interrupts or
22409 signals may get corrupted data.
22411 @item -mavoid-indexed-addresses
22412 @itemx -mno-avoid-indexed-addresses
22413 @opindex mavoid-indexed-addresses
22414 @opindex mno-avoid-indexed-addresses
22415 Generate code that tries to avoid (not avoid) the use of indexed load
22416 or store instructions. These instructions can incur a performance
22417 penalty on Power6 processors in certain situations, such as when
22418 stepping through large arrays that cross a 16M boundary.  This option
22419 is enabled by default when targeting Power6 and disabled otherwise.
22421 @item -mfused-madd
22422 @itemx -mno-fused-madd
22423 @opindex mfused-madd
22424 @opindex mno-fused-madd
22425 Generate code that uses (does not use) the floating-point multiply and
22426 accumulate instructions.  These instructions are generated by default
22427 if hardware floating point is used.  The machine-dependent
22428 @option{-mfused-madd} option is now mapped to the machine-independent
22429 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22430 mapped to @option{-ffp-contract=off}.
22432 @item -mno-strict-align
22433 @itemx -mstrict-align
22434 @opindex mno-strict-align
22435 @opindex mstrict-align
22436 On System V.4 and embedded PowerPC systems do not (do) assume that
22437 unaligned memory references are handled by the system.
22439 @item -mrelocatable
22440 @itemx -mno-relocatable
22441 @opindex mrelocatable
22442 @opindex mno-relocatable
22443 Generate code that allows (does not allow) a static executable to be
22444 relocated to a different address at run time.  A simple embedded
22445 PowerPC system loader should relocate the entire contents of
22446 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22447 a table of 32-bit addresses generated by this option.  For this to
22448 work, all objects linked together must be compiled with
22449 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22450 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22452 @item -mrelocatable-lib
22453 @itemx -mno-relocatable-lib
22454 @opindex mrelocatable-lib
22455 @opindex mno-relocatable-lib
22456 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22457 @code{.fixup} section to allow static executables to be relocated at
22458 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22459 alignment of @option{-mrelocatable}.  Objects compiled with
22460 @option{-mrelocatable-lib} may be linked with objects compiled with
22461 any combination of the @option{-mrelocatable} options.
22463 @item -mno-toc
22464 @itemx -mtoc
22465 @opindex mno-toc
22466 @opindex mtoc
22467 On System V.4 and embedded PowerPC systems do not (do) assume that
22468 register 2 contains a pointer to a global area pointing to the addresses
22469 used in the program.
22471 @item -mlittle
22472 @itemx -mlittle-endian
22473 @opindex mlittle
22474 @opindex mlittle-endian
22475 On System V.4 and embedded PowerPC systems compile code for the
22476 processor in little-endian mode.  The @option{-mlittle-endian} option is
22477 the same as @option{-mlittle}.
22479 @item -mbig
22480 @itemx -mbig-endian
22481 @opindex mbig
22482 @opindex mbig-endian
22483 On System V.4 and embedded PowerPC systems compile code for the
22484 processor in big-endian mode.  The @option{-mbig-endian} option is
22485 the same as @option{-mbig}.
22487 @item -mdynamic-no-pic
22488 @opindex mdynamic-no-pic
22489 On Darwin and Mac OS X systems, compile code so that it is not
22490 relocatable, but that its external references are relocatable.  The
22491 resulting code is suitable for applications, but not shared
22492 libraries.
22494 @item -msingle-pic-base
22495 @opindex msingle-pic-base
22496 Treat the register used for PIC addressing as read-only, rather than
22497 loading it in the prologue for each function.  The runtime system is
22498 responsible for initializing this register with an appropriate value
22499 before execution begins.
22501 @item -mprioritize-restricted-insns=@var{priority}
22502 @opindex mprioritize-restricted-insns
22503 This option controls the priority that is assigned to
22504 dispatch-slot restricted instructions during the second scheduling
22505 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22506 or @samp{2} to assign no, highest, or second-highest (respectively)
22507 priority to dispatch-slot restricted
22508 instructions.
22510 @item -msched-costly-dep=@var{dependence_type}
22511 @opindex msched-costly-dep
22512 This option controls which dependences are considered costly
22513 by the target during instruction scheduling.  The argument
22514 @var{dependence_type} takes one of the following values:
22516 @table @asis
22517 @item @samp{no}
22518 No dependence is costly.
22520 @item @samp{all}
22521 All dependences are costly.
22523 @item @samp{true_store_to_load}
22524 A true dependence from store to load is costly.
22526 @item @samp{store_to_load}
22527 Any dependence from store to load is costly.
22529 @item @var{number}
22530 Any dependence for which the latency is greater than or equal to
22531 @var{number} is costly.
22532 @end table
22534 @item -minsert-sched-nops=@var{scheme}
22535 @opindex minsert-sched-nops
22536 This option controls which NOP insertion scheme is used during
22537 the second scheduling pass.  The argument @var{scheme} takes one of the
22538 following values:
22540 @table @asis
22541 @item @samp{no}
22542 Don't insert NOPs.
22544 @item @samp{pad}
22545 Pad with NOPs any dispatch group that has vacant issue slots,
22546 according to the scheduler's grouping.
22548 @item @samp{regroup_exact}
22549 Insert NOPs to force costly dependent insns into
22550 separate groups.  Insert exactly as many NOPs as needed to force an insn
22551 to a new group, according to the estimated processor grouping.
22553 @item @var{number}
22554 Insert NOPs to force costly dependent insns into
22555 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22556 @end table
22558 @item -mcall-sysv
22559 @opindex mcall-sysv
22560 On System V.4 and embedded PowerPC systems compile code using calling
22561 conventions that adhere to the March 1995 draft of the System V
22562 Application Binary Interface, PowerPC processor supplement.  This is the
22563 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22565 @item -mcall-sysv-eabi
22566 @itemx -mcall-eabi
22567 @opindex mcall-sysv-eabi
22568 @opindex mcall-eabi
22569 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22571 @item -mcall-sysv-noeabi
22572 @opindex mcall-sysv-noeabi
22573 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22575 @item -mcall-aixdesc
22576 @opindex m
22577 On System V.4 and embedded PowerPC systems compile code for the AIX
22578 operating system.
22580 @item -mcall-linux
22581 @opindex mcall-linux
22582 On System V.4 and embedded PowerPC systems compile code for the
22583 Linux-based GNU system.
22585 @item -mcall-freebsd
22586 @opindex mcall-freebsd
22587 On System V.4 and embedded PowerPC systems compile code for the
22588 FreeBSD operating system.
22590 @item -mcall-netbsd
22591 @opindex mcall-netbsd
22592 On System V.4 and embedded PowerPC systems compile code for the
22593 NetBSD operating system.
22595 @item -mcall-openbsd
22596 @opindex mcall-netbsd
22597 On System V.4 and embedded PowerPC systems compile code for the
22598 OpenBSD operating system.
22600 @item -maix-struct-return
22601 @opindex maix-struct-return
22602 Return all structures in memory (as specified by the AIX ABI)@.
22604 @item -msvr4-struct-return
22605 @opindex msvr4-struct-return
22606 Return structures smaller than 8 bytes in registers (as specified by the
22607 SVR4 ABI)@.
22609 @item -mabi=@var{abi-type}
22610 @opindex mabi
22611 Extend the current ABI with a particular extension, or remove such extension.
22612 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22613 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22614 @samp{elfv1}, @samp{elfv2}@.
22616 @item -mabi=spe
22617 @opindex mabi=spe
22618 Extend the current ABI with SPE ABI extensions.  This does not change
22619 the default ABI, instead it adds the SPE ABI extensions to the current
22620 ABI@.
22622 @item -mabi=no-spe
22623 @opindex mabi=no-spe
22624 Disable Book-E SPE ABI extensions for the current ABI@.
22626 @item -mabi=ibmlongdouble
22627 @opindex mabi=ibmlongdouble
22628 Change the current ABI to use IBM extended-precision long double.
22629 This is not likely to work if your system defaults to using IEEE
22630 extended-precision long double.  If you change the long double type
22631 from IEEE extended-precision, the compiler will issue a warning unless
22632 you use the @option{-Wno-psabi} option.
22634 @item -mabi=ieeelongdouble
22635 @opindex mabi=ieeelongdouble
22636 Change the current ABI to use IEEE extended-precision long double.
22637 This is not likely to work if your system defaults to using IBM
22638 extended-precision long double.  If you change the long double type
22639 from IBM extended-precision, the compiler will issue a warning unless
22640 you use the @option{-Wno-psabi} option.
22642 @item -mabi=elfv1
22643 @opindex mabi=elfv1
22644 Change the current ABI to use the ELFv1 ABI.
22645 This is the default ABI for big-endian PowerPC 64-bit Linux.
22646 Overriding the default ABI requires special system support and is
22647 likely to fail in spectacular ways.
22649 @item -mabi=elfv2
22650 @opindex mabi=elfv2
22651 Change the current ABI to use the ELFv2 ABI.
22652 This is the default ABI for little-endian PowerPC 64-bit Linux.
22653 Overriding the default ABI requires special system support and is
22654 likely to fail in spectacular ways.
22656 @item -mgnu-attribute
22657 @itemx -mno-gnu-attribute
22658 @opindex mgnu-attribute
22659 @opindex mno-gnu-attribute
22660 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22661 .gnu.attributes section that specify ABI variations in function
22662 parameters or return values.
22664 @item -mprototype
22665 @itemx -mno-prototype
22666 @opindex mprototype
22667 @opindex mno-prototype
22668 On System V.4 and embedded PowerPC systems assume that all calls to
22669 variable argument functions are properly prototyped.  Otherwise, the
22670 compiler must insert an instruction before every non-prototyped call to
22671 set or clear bit 6 of the condition code register (@code{CR}) to
22672 indicate whether floating-point values are passed in the floating-point
22673 registers in case the function takes variable arguments.  With
22674 @option{-mprototype}, only calls to prototyped variable argument functions
22675 set or clear the bit.
22677 @item -msim
22678 @opindex msim
22679 On embedded PowerPC systems, assume that the startup module is called
22680 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22681 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22682 configurations.
22684 @item -mmvme
22685 @opindex mmvme
22686 On embedded PowerPC systems, assume that the startup module is called
22687 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22688 @file{libc.a}.
22690 @item -mads
22691 @opindex mads
22692 On embedded PowerPC systems, assume that the startup module is called
22693 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22694 @file{libc.a}.
22696 @item -myellowknife
22697 @opindex myellowknife
22698 On embedded PowerPC systems, assume that the startup module is called
22699 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22700 @file{libc.a}.
22702 @item -mvxworks
22703 @opindex mvxworks
22704 On System V.4 and embedded PowerPC systems, specify that you are
22705 compiling for a VxWorks system.
22707 @item -memb
22708 @opindex memb
22709 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22710 header to indicate that @samp{eabi} extended relocations are used.
22712 @item -meabi
22713 @itemx -mno-eabi
22714 @opindex meabi
22715 @opindex mno-eabi
22716 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22717 Embedded Applications Binary Interface (EABI), which is a set of
22718 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22719 means that the stack is aligned to an 8-byte boundary, a function
22720 @code{__eabi} is called from @code{main} to set up the EABI
22721 environment, and the @option{-msdata} option can use both @code{r2} and
22722 @code{r13} to point to two separate small data areas.  Selecting
22723 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22724 no EABI initialization function is called from @code{main}, and the
22725 @option{-msdata} option only uses @code{r13} to point to a single
22726 small data area.  The @option{-meabi} option is on by default if you
22727 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22729 @item -msdata=eabi
22730 @opindex msdata=eabi
22731 On System V.4 and embedded PowerPC systems, put small initialized
22732 @code{const} global and static data in the @code{.sdata2} section, which
22733 is pointed to by register @code{r2}.  Put small initialized
22734 non-@code{const} global and static data in the @code{.sdata} section,
22735 which is pointed to by register @code{r13}.  Put small uninitialized
22736 global and static data in the @code{.sbss} section, which is adjacent to
22737 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22738 incompatible with the @option{-mrelocatable} option.  The
22739 @option{-msdata=eabi} option also sets the @option{-memb} option.
22741 @item -msdata=sysv
22742 @opindex msdata=sysv
22743 On System V.4 and embedded PowerPC systems, put small global and static
22744 data in the @code{.sdata} section, which is pointed to by register
22745 @code{r13}.  Put small uninitialized global and static data in the
22746 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22747 The @option{-msdata=sysv} option is incompatible with the
22748 @option{-mrelocatable} option.
22750 @item -msdata=default
22751 @itemx -msdata
22752 @opindex msdata=default
22753 @opindex msdata
22754 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22755 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22756 same as @option{-msdata=sysv}.
22758 @item -msdata=data
22759 @opindex msdata=data
22760 On System V.4 and embedded PowerPC systems, put small global
22761 data in the @code{.sdata} section.  Put small uninitialized global
22762 data in the @code{.sbss} section.  Do not use register @code{r13}
22763 to address small data however.  This is the default behavior unless
22764 other @option{-msdata} options are used.
22766 @item -msdata=none
22767 @itemx -mno-sdata
22768 @opindex msdata=none
22769 @opindex mno-sdata
22770 On embedded PowerPC systems, put all initialized global and static data
22771 in the @code{.data} section, and all uninitialized data in the
22772 @code{.bss} section.
22774 @item -mblock-move-inline-limit=@var{num}
22775 @opindex mblock-move-inline-limit
22776 Inline all block moves (such as calls to @code{memcpy} or structure
22777 copies) less than or equal to @var{num} bytes.  The minimum value for
22778 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22779 targets.  The default value is target-specific.
22781 @item -G @var{num}
22782 @opindex G
22783 @cindex smaller data references (PowerPC)
22784 @cindex .sdata/.sdata2 references (PowerPC)
22785 On embedded PowerPC systems, put global and static items less than or
22786 equal to @var{num} bytes into the small data or BSS sections instead of
22787 the normal data or BSS section.  By default, @var{num} is 8.  The
22788 @option{-G @var{num}} switch is also passed to the linker.
22789 All modules should be compiled with the same @option{-G @var{num}} value.
22791 @item -mregnames
22792 @itemx -mno-regnames
22793 @opindex mregnames
22794 @opindex mno-regnames
22795 On System V.4 and embedded PowerPC systems do (do not) emit register
22796 names in the assembly language output using symbolic forms.
22798 @item -mlongcall
22799 @itemx -mno-longcall
22800 @opindex mlongcall
22801 @opindex mno-longcall
22802 By default assume that all calls are far away so that a longer and more
22803 expensive calling sequence is required.  This is required for calls
22804 farther than 32 megabytes (33,554,432 bytes) from the current location.
22805 A short call is generated if the compiler knows
22806 the call cannot be that far away.  This setting can be overridden by
22807 the @code{shortcall} function attribute, or by @code{#pragma
22808 longcall(0)}.
22810 Some linkers are capable of detecting out-of-range calls and generating
22811 glue code on the fly.  On these systems, long calls are unnecessary and
22812 generate slower code.  As of this writing, the AIX linker can do this,
22813 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22814 to the GNU linker for 32-bit PowerPC systems as well.
22816 In the future, GCC may ignore all longcall specifications
22817 when the linker is known to generate glue.
22819 @item -mtls-markers
22820 @itemx -mno-tls-markers
22821 @opindex mtls-markers
22822 @opindex mno-tls-markers
22823 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22824 specifying the function argument.  The relocation allows the linker to
22825 reliably associate function call with argument setup instructions for
22826 TLS optimization, which in turn allows GCC to better schedule the
22827 sequence.
22829 @item -mrecip
22830 @itemx -mno-recip
22831 @opindex mrecip
22832 This option enables use of the reciprocal estimate and
22833 reciprocal square root estimate instructions with additional
22834 Newton-Raphson steps to increase precision instead of doing a divide or
22835 square root and divide for floating-point arguments.  You should use
22836 the @option{-ffast-math} option when using @option{-mrecip} (or at
22837 least @option{-funsafe-math-optimizations},
22838 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22839 @option{-fno-trapping-math}).  Note that while the throughput of the
22840 sequence is generally higher than the throughput of the non-reciprocal
22841 instruction, the precision of the sequence can be decreased by up to 2
22842 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22843 roots.
22845 @item -mrecip=@var{opt}
22846 @opindex mrecip=opt
22847 This option controls which reciprocal estimate instructions
22848 may be used.  @var{opt} is a comma-separated list of options, which may
22849 be preceded by a @code{!} to invert the option:
22851 @table @samp
22853 @item all
22854 Enable all estimate instructions.
22856 @item default
22857 Enable the default instructions, equivalent to @option{-mrecip}.
22859 @item none
22860 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22862 @item div
22863 Enable the reciprocal approximation instructions for both
22864 single and double precision.
22866 @item divf
22867 Enable the single-precision reciprocal approximation instructions.
22869 @item divd
22870 Enable the double-precision reciprocal approximation instructions.
22872 @item rsqrt
22873 Enable the reciprocal square root approximation instructions for both
22874 single and double precision.
22876 @item rsqrtf
22877 Enable the single-precision reciprocal square root approximation instructions.
22879 @item rsqrtd
22880 Enable the double-precision reciprocal square root approximation instructions.
22882 @end table
22884 So, for example, @option{-mrecip=all,!rsqrtd} enables
22885 all of the reciprocal estimate instructions, except for the
22886 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22887 which handle the double-precision reciprocal square root calculations.
22889 @item -mrecip-precision
22890 @itemx -mno-recip-precision
22891 @opindex mrecip-precision
22892 Assume (do not assume) that the reciprocal estimate instructions
22893 provide higher-precision estimates than is mandated by the PowerPC
22894 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22895 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22896 The double-precision square root estimate instructions are not generated by
22897 default on low-precision machines, since they do not provide an
22898 estimate that converges after three steps.
22900 @item -mpointers-to-nested-functions
22901 @itemx -mno-pointers-to-nested-functions
22902 @opindex mpointers-to-nested-functions
22903 Generate (do not generate) code to load up the static chain register
22904 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22905 systems where a function pointer points to a 3-word descriptor giving
22906 the function address, TOC value to be loaded in register @code{r2}, and
22907 static chain value to be loaded in register @code{r11}.  The
22908 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22909 call through pointers to nested functions or pointers
22910 to functions compiled in other languages that use the static chain if
22911 you use @option{-mno-pointers-to-nested-functions}.
22913 @item -msave-toc-indirect
22914 @itemx -mno-save-toc-indirect
22915 @opindex msave-toc-indirect
22916 Generate (do not generate) code to save the TOC value in the reserved
22917 stack location in the function prologue if the function calls through
22918 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22919 saved in the prologue, it is saved just before the call through the
22920 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22922 @item -mcompat-align-parm
22923 @itemx -mno-compat-align-parm
22924 @opindex mcompat-align-parm
22925 Generate (do not generate) code to pass structure parameters with a
22926 maximum alignment of 64 bits, for compatibility with older versions
22927 of GCC.
22929 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22930 structure parameter on a 128-bit boundary when that structure contained
22931 a member requiring 128-bit alignment.  This is corrected in more
22932 recent versions of GCC.  This option may be used to generate code
22933 that is compatible with functions compiled with older versions of
22934 GCC.
22936 The @option{-mno-compat-align-parm} option is the default.
22938 @item -mstack-protector-guard=@var{guard}
22939 @itemx -mstack-protector-guard-reg=@var{reg}
22940 @itemx -mstack-protector-guard-offset=@var{offset}
22941 @itemx -mstack-protector-guard-symbol=@var{symbol}
22942 @opindex mstack-protector-guard
22943 @opindex mstack-protector-guard-reg
22944 @opindex mstack-protector-guard-offset
22945 @opindex mstack-protector-guard-symbol
22946 Generate stack protection code using canary at @var{guard}.  Supported
22947 locations are @samp{global} for global canary or @samp{tls} for per-thread
22948 canary in the TLS block (the default with GNU libc version 2.4 or later).
22950 With the latter choice the options
22951 @option{-mstack-protector-guard-reg=@var{reg}} and
22952 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22953 which register to use as base register for reading the canary, and from what
22954 offset from that base register. The default for those is as specified in the
22955 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22956 the offset with a symbol reference to a canary in the TLS block.
22957 @end table
22960 @node RISC-V Options
22961 @subsection RISC-V Options
22962 @cindex RISC-V Options
22964 These command-line options are defined for RISC-V targets:
22966 @table @gcctabopt
22967 @item -mbranch-cost=@var{n}
22968 @opindex mbranch-cost
22969 Set the cost of branches to roughly @var{n} instructions.
22971 @item -mplt
22972 @itemx -mno-plt
22973 @opindex plt
22974 When generating PIC code, do or don't allow the use of PLTs. Ignored for
22975 non-PIC.  The default is @option{-mplt}.
22977 @item -mabi=@var{ABI-string}
22978 @opindex mabi
22979 Specify integer and floating-point calling convention.  @var{ABI-string}
22980 contains two parts: the size of integer types and the registers used for
22981 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
22982 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
22983 32-bit), and that floating-point values up to 64 bits wide are passed in F
22984 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
22985 allows the compiler to generate code that uses the F and D extensions but only
22986 allows floating-point values up to 32 bits long to be passed in registers; or
22987 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
22988 passed in registers.
22990 The default for this argument is system dependent, users who want a specific
22991 calling convention should specify one explicitly.  The valid calling
22992 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
22993 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
22994 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
22995 invalid because the ABI requires 64-bit values be passed in F registers, but F
22996 registers are only 32 bits wide.
22998 @item -mfdiv
22999 @itemx -mno-fdiv
23000 @opindex mfdiv
23001 Do or don't use hardware floating-point divide and square root instructions.
23002 This requires the F or D extensions for floating-point registers.  The default
23003 is to use them if the specified architecture has these instructions.
23005 @item -mdiv
23006 @itemx -mno-div
23007 @opindex mdiv
23008 Do or don't use hardware instructions for integer division.  This requires the
23009 M extension.  The default is to use them if the specified architecture has
23010 these instructions.
23012 @item -march=@var{ISA-string}
23013 @opindex march
23014 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23015 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23017 @item -mtune=@var{processor-string}
23018 @opindex mtune
23019 Optimize the output for the given processor, specified by microarchitecture
23020 name.
23022 @item -mpreferred-stack-boundary=@var{num}
23023 @opindex mpreferred-stack-boundary
23024 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23025 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23026 the default is 4 (16 bytes or 128-bits).
23028 @strong{Warning:} If you use this switch, then you must build all modules with
23029 the same value, including any libraries.  This includes the system libraries
23030 and startup modules.
23032 @item -msmall-data-limit=@var{n}
23033 @opindex msmall-data-limit
23034 Put global and static data smaller than @var{n} bytes into a special section
23035 (on some targets).
23037 @item -msave-restore
23038 @itemx -mno-save-restore
23039 @opindex msave-restore
23040 Do or don't use smaller but slower prologue and epilogue code that uses
23041 library function calls.  The default is to use fast inline prologues and
23042 epilogues.
23044 @item -mstrict-align
23045 @itemx -mno-strict-align
23046 @opindex mstrict-align
23047 Do not or do generate unaligned memory accesses.  The default is set depending
23048 on whether the processor we are optimizing for supports fast unaligned access
23049 or not.
23051 @item -mcmodel=medlow
23052 @opindex mcmodel=medlow
23053 Generate code for the medium-low code model. The program and its statically
23054 defined symbols must lie within a single 2 GiB address range and must lie
23055 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23056 statically or dynamically linked. This is the default code model.
23058 @item -mcmodel=medany
23059 @opindex mcmodel=medany
23060 Generate code for the medium-any code model. The program and its statically
23061 defined symbols must be within any single 2 GiB address range. Programs can be
23062 statically or dynamically linked.
23064 @item -mexplicit-relocs
23065 @itemx -mno-exlicit-relocs
23066 Use or do not use assembler relocation operators when dealing with symbolic
23067 addresses.  The alternative is to use assembler macros instead, which may
23068 limit optimization.
23070 @end table
23072 @node RL78 Options
23073 @subsection RL78 Options
23074 @cindex RL78 Options
23076 @table @gcctabopt
23078 @item -msim
23079 @opindex msim
23080 Links in additional target libraries to support operation within a
23081 simulator.
23083 @item -mmul=none
23084 @itemx -mmul=g10
23085 @itemx -mmul=g13
23086 @itemx -mmul=g14
23087 @itemx -mmul=rl78
23088 @opindex mmul
23089 Specifies the type of hardware multiplication and division support to
23090 be used.  The simplest is @code{none}, which uses software for both
23091 multiplication and division.  This is the default.  The @code{g13}
23092 value is for the hardware multiply/divide peripheral found on the
23093 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23094 the multiplication and division instructions supported by the RL78/G14
23095 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23096 the value @code{mg10} is an alias for @code{none}.
23098 In addition a C preprocessor macro is defined, based upon the setting
23099 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23100 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23102 @item -mcpu=g10
23103 @itemx -mcpu=g13
23104 @itemx -mcpu=g14
23105 @itemx -mcpu=rl78
23106 @opindex mcpu
23107 Specifies the RL78 core to target.  The default is the G14 core, also
23108 known as an S3 core or just RL78.  The G13 or S2 core does not have
23109 multiply or divide instructions, instead it uses a hardware peripheral
23110 for these operations.  The G10 or S1 core does not have register
23111 banks, so it uses a different calling convention.
23113 If this option is set it also selects the type of hardware multiply
23114 support to use, unless this is overridden by an explicit
23115 @option{-mmul=none} option on the command line.  Thus specifying
23116 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23117 peripheral and specifying @option{-mcpu=g10} disables the use of
23118 hardware multiplications altogether.
23120 Note, although the RL78/G14 core is the default target, specifying
23121 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23122 change the behavior of the toolchain since it also enables G14
23123 hardware multiply support.  If these options are not specified on the
23124 command line then software multiplication routines will be used even
23125 though the code targets the RL78 core.  This is for backwards
23126 compatibility with older toolchains which did not have hardware
23127 multiply and divide support.
23129 In addition a C preprocessor macro is defined, based upon the setting
23130 of this option.  Possible values are: @code{__RL78_G10__},
23131 @code{__RL78_G13__} or @code{__RL78_G14__}.
23133 @item -mg10
23134 @itemx -mg13
23135 @itemx -mg14
23136 @itemx -mrl78
23137 @opindex mg10
23138 @opindex mg13
23139 @opindex mg14
23140 @opindex mrl78
23141 These are aliases for the corresponding @option{-mcpu=} option.  They
23142 are provided for backwards compatibility.
23144 @item -mallregs
23145 @opindex mallregs
23146 Allow the compiler to use all of the available registers.  By default
23147 registers @code{r24..r31} are reserved for use in interrupt handlers.
23148 With this option enabled these registers can be used in ordinary
23149 functions as well.
23151 @item -m64bit-doubles
23152 @itemx -m32bit-doubles
23153 @opindex m64bit-doubles
23154 @opindex m32bit-doubles
23155 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23156 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23157 @option{-m32bit-doubles}.
23159 @item -msave-mduc-in-interrupts
23160 @itemx -mno-save-mduc-in-interrupts
23161 @opindex msave-mduc-in-interrupts
23162 @opindex mno-save-mduc-in-interrupts
23163 Specifies that interrupt handler functions should preserve the
23164 MDUC registers.  This is only necessary if normal code might use
23165 the MDUC registers, for example because it performs multiplication
23166 and division operations.  The default is to ignore the MDUC registers
23167 as this makes the interrupt handlers faster.  The target option -mg13
23168 needs to be passed for this to work as this feature is only available
23169 on the G13 target (S2 core).  The MDUC registers will only be saved
23170 if the interrupt handler performs a multiplication or division
23171 operation or it calls another function.
23173 @end table
23175 @node RS/6000 and PowerPC Options
23176 @subsection IBM RS/6000 and PowerPC Options
23177 @cindex RS/6000 and PowerPC Options
23178 @cindex IBM RS/6000 and PowerPC Options
23180 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23181 @table @gcctabopt
23182 @item -mpowerpc-gpopt
23183 @itemx -mno-powerpc-gpopt
23184 @itemx -mpowerpc-gfxopt
23185 @itemx -mno-powerpc-gfxopt
23186 @need 800
23187 @itemx -mpowerpc64
23188 @itemx -mno-powerpc64
23189 @itemx -mmfcrf
23190 @itemx -mno-mfcrf
23191 @itemx -mpopcntb
23192 @itemx -mno-popcntb
23193 @itemx -mpopcntd
23194 @itemx -mno-popcntd
23195 @itemx -mfprnd
23196 @itemx -mno-fprnd
23197 @need 800
23198 @itemx -mcmpb
23199 @itemx -mno-cmpb
23200 @itemx -mmfpgpr
23201 @itemx -mno-mfpgpr
23202 @itemx -mhard-dfp
23203 @itemx -mno-hard-dfp
23204 @opindex mpowerpc-gpopt
23205 @opindex mno-powerpc-gpopt
23206 @opindex mpowerpc-gfxopt
23207 @opindex mno-powerpc-gfxopt
23208 @opindex mpowerpc64
23209 @opindex mno-powerpc64
23210 @opindex mmfcrf
23211 @opindex mno-mfcrf
23212 @opindex mpopcntb
23213 @opindex mno-popcntb
23214 @opindex mpopcntd
23215 @opindex mno-popcntd
23216 @opindex mfprnd
23217 @opindex mno-fprnd
23218 @opindex mcmpb
23219 @opindex mno-cmpb
23220 @opindex mmfpgpr
23221 @opindex mno-mfpgpr
23222 @opindex mhard-dfp
23223 @opindex mno-hard-dfp
23224 You use these options to specify which instructions are available on the
23225 processor you are using.  The default value of these options is
23226 determined when configuring GCC@.  Specifying the
23227 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23228 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23229 rather than the options listed above.
23231 Specifying @option{-mpowerpc-gpopt} allows
23232 GCC to use the optional PowerPC architecture instructions in the
23233 General Purpose group, including floating-point square root.  Specifying
23234 @option{-mpowerpc-gfxopt} allows GCC to
23235 use the optional PowerPC architecture instructions in the Graphics
23236 group, including floating-point select.
23238 The @option{-mmfcrf} option allows GCC to generate the move from
23239 condition register field instruction implemented on the POWER4
23240 processor and other processors that support the PowerPC V2.01
23241 architecture.
23242 The @option{-mpopcntb} option allows GCC to generate the popcount and
23243 double-precision FP reciprocal estimate instruction implemented on the
23244 POWER5 processor and other processors that support the PowerPC V2.02
23245 architecture.
23246 The @option{-mpopcntd} option allows GCC to generate the popcount
23247 instruction implemented on the POWER7 processor and other processors
23248 that support the PowerPC V2.06 architecture.
23249 The @option{-mfprnd} option allows GCC to generate the FP round to
23250 integer instructions implemented on the POWER5+ processor and other
23251 processors that support the PowerPC V2.03 architecture.
23252 The @option{-mcmpb} option allows GCC to generate the compare bytes
23253 instruction implemented on the POWER6 processor and other processors
23254 that support the PowerPC V2.05 architecture.
23255 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23256 general-purpose register instructions implemented on the POWER6X
23257 processor and other processors that support the extended PowerPC V2.05
23258 architecture.
23259 The @option{-mhard-dfp} option allows GCC to generate the decimal
23260 floating-point instructions implemented on some POWER processors.
23262 The @option{-mpowerpc64} option allows GCC to generate the additional
23263 64-bit instructions that are found in the full PowerPC64 architecture
23264 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23265 @option{-mno-powerpc64}.
23267 @item -mcpu=@var{cpu_type}
23268 @opindex mcpu
23269 Set architecture type, register usage, and
23270 instruction scheduling parameters for machine type @var{cpu_type}.
23271 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23272 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23273 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23274 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23275 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23276 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23277 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23278 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23279 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23280 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23281 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23282 @samp{rs64}, and @samp{native}.
23284 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23285 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23286 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23287 architecture machine types, with an appropriate, generic processor
23288 model assumed for scheduling purposes.
23290 Specifying @samp{native} as cpu type detects and selects the
23291 architecture option that corresponds to the host processor of the
23292 system performing the compilation.
23293 @option{-mcpu=native} has no effect if GCC does not recognize the
23294 processor.
23296 The other options specify a specific processor.  Code generated under
23297 those options runs best on that processor, and may not run at all on
23298 others.
23300 The @option{-mcpu} options automatically enable or disable the
23301 following options:
23303 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23304 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23305 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
23306 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23307 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
23308 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23310 The particular options set for any particular CPU varies between
23311 compiler versions, depending on what setting seems to produce optimal
23312 code for that CPU; it doesn't necessarily reflect the actual hardware's
23313 capabilities.  If you wish to set an individual option to a particular
23314 value, you may specify it after the @option{-mcpu} option, like
23315 @option{-mcpu=970 -mno-altivec}.
23317 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23318 not enabled or disabled by the @option{-mcpu} option at present because
23319 AIX does not have full support for these options.  You may still
23320 enable or disable them individually if you're sure it'll work in your
23321 environment.
23323 @item -mtune=@var{cpu_type}
23324 @opindex mtune
23325 Set the instruction scheduling parameters for machine type
23326 @var{cpu_type}, but do not set the architecture type or register usage,
23327 as @option{-mcpu=@var{cpu_type}} does.  The same
23328 values for @var{cpu_type} are used for @option{-mtune} as for
23329 @option{-mcpu}.  If both are specified, the code generated uses the
23330 architecture and registers set by @option{-mcpu}, but the
23331 scheduling parameters set by @option{-mtune}.
23333 @item -mcmodel=small
23334 @opindex mcmodel=small
23335 Generate PowerPC64 code for the small model: The TOC is limited to
23336 64k.
23338 @item -mcmodel=medium
23339 @opindex mcmodel=medium
23340 Generate PowerPC64 code for the medium model: The TOC and other static
23341 data may be up to a total of 4G in size.  This is the default for 64-bit
23342 Linux.
23344 @item -mcmodel=large
23345 @opindex mcmodel=large
23346 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23347 in size.  Other data and code is only limited by the 64-bit address
23348 space.
23350 @item -maltivec
23351 @itemx -mno-altivec
23352 @opindex maltivec
23353 @opindex mno-altivec
23354 Generate code that uses (does not use) AltiVec instructions, and also
23355 enable the use of built-in functions that allow more direct access to
23356 the AltiVec instruction set.  You may also need to set
23357 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23358 enhancements.
23360 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23361 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23362 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23363 match array element order corresponding to the endianness of the
23364 target.  That is, element zero identifies the leftmost element in a
23365 vector register when targeting a big-endian platform, and identifies
23366 the rightmost element in a vector register when targeting a
23367 little-endian platform.
23369 @item -maltivec=be
23370 @opindex maltivec=be
23371 Generate AltiVec instructions using big-endian element order,
23372 regardless of whether the target is big- or little-endian.  This is
23373 the default when targeting a big-endian platform.  Using this option
23374 is currently deprecated.  Support for this feature will be removed in
23375 GCC 9.
23377 The element order is used to interpret element numbers in AltiVec
23378 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23379 @code{vec_insert}.  By default, these match array element order
23380 corresponding to the endianness for the target.
23382 @item -maltivec=le
23383 @opindex maltivec=le
23384 Generate AltiVec instructions using little-endian element order,
23385 regardless of whether the target is big- or little-endian.  This is
23386 the default when targeting a little-endian platform.  This option is
23387 currently ignored when targeting a big-endian platform.
23389 The element order is used to interpret element numbers in AltiVec
23390 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23391 @code{vec_insert}.  By default, these match array element order
23392 corresponding to the endianness for the target.
23394 @item -mvrsave
23395 @itemx -mno-vrsave
23396 @opindex mvrsave
23397 @opindex mno-vrsave
23398 Generate VRSAVE instructions when generating AltiVec code.
23400 @item -msecure-plt
23401 @opindex msecure-plt
23402 Generate code that allows @command{ld} and @command{ld.so}
23403 to build executables and shared
23404 libraries with non-executable @code{.plt} and @code{.got} sections.
23405 This is a PowerPC
23406 32-bit SYSV ABI option.
23408 @item -mbss-plt
23409 @opindex mbss-plt
23410 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23411 fills in, and
23412 requires @code{.plt} and @code{.got}
23413 sections that are both writable and executable.
23414 This is a PowerPC 32-bit SYSV ABI option.
23416 @item -misel
23417 @itemx -mno-isel
23418 @opindex misel
23419 @opindex mno-isel
23420 This switch enables or disables the generation of ISEL instructions.
23422 @item -misel=@var{yes/no}
23423 This switch has been deprecated.  Use @option{-misel} and
23424 @option{-mno-isel} instead.
23426 @item -mpaired
23427 @itemx -mno-paired
23428 @opindex mpaired
23429 @opindex mno-paired
23430 This switch enables or disables the generation of PAIRED simd
23431 instructions.
23433 @item -mvsx
23434 @itemx -mno-vsx
23435 @opindex mvsx
23436 @opindex mno-vsx
23437 Generate code that uses (does not use) vector/scalar (VSX)
23438 instructions, and also enable the use of built-in functions that allow
23439 more direct access to the VSX instruction set.
23441 @item -mcrypto
23442 @itemx -mno-crypto
23443 @opindex mcrypto
23444 @opindex mno-crypto
23445 Enable the use (disable) of the built-in functions that allow direct
23446 access to the cryptographic instructions that were added in version
23447 2.07 of the PowerPC ISA.
23449 @item -mdirect-move
23450 @itemx -mno-direct-move
23451 @opindex mdirect-move
23452 @opindex mno-direct-move
23453 Generate code that uses (does not use) the instructions to move data
23454 between the general purpose registers and the vector/scalar (VSX)
23455 registers that were added in version 2.07 of the PowerPC ISA.
23457 @item -mhtm
23458 @itemx -mno-htm
23459 @opindex mhtm
23460 @opindex mno-htm
23461 Enable (disable) the use of the built-in functions that allow direct
23462 access to the Hardware Transactional Memory (HTM) instructions that
23463 were added in version 2.07 of the PowerPC ISA.
23465 @item -mpower8-fusion
23466 @itemx -mno-power8-fusion
23467 @opindex mpower8-fusion
23468 @opindex mno-power8-fusion
23469 Generate code that keeps (does not keeps) some integer operations
23470 adjacent so that the instructions can be fused together on power8 and
23471 later processors.
23473 @item -mpower8-vector
23474 @itemx -mno-power8-vector
23475 @opindex mpower8-vector
23476 @opindex mno-power8-vector
23477 Generate code that uses (does not use) the vector and scalar
23478 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23479 enable the use of built-in functions that allow more direct access to
23480 the vector instructions.
23482 @item -mquad-memory
23483 @itemx -mno-quad-memory
23484 @opindex mquad-memory
23485 @opindex mno-quad-memory
23486 Generate code that uses (does not use) the non-atomic quad word memory
23487 instructions.  The @option{-mquad-memory} option requires use of
23488 64-bit mode.
23490 @item -mquad-memory-atomic
23491 @itemx -mno-quad-memory-atomic
23492 @opindex mquad-memory-atomic
23493 @opindex mno-quad-memory-atomic
23494 Generate code that uses (does not use) the atomic quad word memory
23495 instructions.  The @option{-mquad-memory-atomic} option requires use of
23496 64-bit mode.
23498 @item -mfloat128
23499 @itemx -mno-float128
23500 @opindex mfloat128
23501 @opindex mno-float128
23502 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23503 and use either software emulation for IEEE 128-bit floating point or
23504 hardware instructions.
23506 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23507 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23508 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23509 floating point support only works on PowerPC Linux systems.
23511 The default for @option{-mfloat128} is enabled on PowerPC Linux
23512 systems using the VSX instruction set, and disabled on other systems.
23514 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23515 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23516 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23517 floating point instructions.  Otherwise, if you do not specify to
23518 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23519 system, IEEE 128-bit floating point will be done with software
23520 emulation.
23522 @item -mfloat128-hardware
23523 @itemx -mno-float128-hardware
23524 @opindex mfloat128-hardware
23525 @opindex mno-float128-hardware
23526 Enable/disable using ISA 3.0 hardware instructions to support the
23527 @var{__float128} data type.
23529 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23530 Linux systems using the ISA 3.0 instruction set, and disabled on other
23531 systems.
23533 @item -m32
23534 @itemx -m64
23535 @opindex m32
23536 @opindex m64
23537 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23538 targets (including GNU/Linux).  The 32-bit environment sets int, long
23539 and pointer to 32 bits and generates code that runs on any PowerPC
23540 variant.  The 64-bit environment sets int to 32 bits and long and
23541 pointer to 64 bits, and generates code for PowerPC64, as for
23542 @option{-mpowerpc64}.
23544 @item -mfull-toc
23545 @itemx -mno-fp-in-toc
23546 @itemx -mno-sum-in-toc
23547 @itemx -mminimal-toc
23548 @opindex mfull-toc
23549 @opindex mno-fp-in-toc
23550 @opindex mno-sum-in-toc
23551 @opindex mminimal-toc
23552 Modify generation of the TOC (Table Of Contents), which is created for
23553 every executable file.  The @option{-mfull-toc} option is selected by
23554 default.  In that case, GCC allocates at least one TOC entry for
23555 each unique non-automatic variable reference in your program.  GCC
23556 also places floating-point constants in the TOC@.  However, only
23557 16,384 entries are available in the TOC@.
23559 If you receive a linker error message that saying you have overflowed
23560 the available TOC space, you can reduce the amount of TOC space used
23561 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23562 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23563 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23564 generate code to calculate the sum of an address and a constant at
23565 run time instead of putting that sum into the TOC@.  You may specify one
23566 or both of these options.  Each causes GCC to produce very slightly
23567 slower and larger code at the expense of conserving TOC space.
23569 If you still run out of space in the TOC even when you specify both of
23570 these options, specify @option{-mminimal-toc} instead.  This option causes
23571 GCC to make only one TOC entry for every file.  When you specify this
23572 option, GCC produces code that is slower and larger but which
23573 uses extremely little TOC space.  You may wish to use this option
23574 only on files that contain less frequently-executed code.
23576 @item -maix64
23577 @itemx -maix32
23578 @opindex maix64
23579 @opindex maix32
23580 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23581 @code{long} type, and the infrastructure needed to support them.
23582 Specifying @option{-maix64} implies @option{-mpowerpc64},
23583 while @option{-maix32} disables the 64-bit ABI and
23584 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23586 @item -mxl-compat
23587 @itemx -mno-xl-compat
23588 @opindex mxl-compat
23589 @opindex mno-xl-compat
23590 Produce code that conforms more closely to IBM XL compiler semantics
23591 when using AIX-compatible ABI@.  Pass floating-point arguments to
23592 prototyped functions beyond the register save area (RSA) on the stack
23593 in addition to argument FPRs.  Do not assume that most significant
23594 double in 128-bit long double value is properly rounded when comparing
23595 values and converting to double.  Use XL symbol names for long double
23596 support routines.
23598 The AIX calling convention was extended but not initially documented to
23599 handle an obscure K&R C case of calling a function that takes the
23600 address of its arguments with fewer arguments than declared.  IBM XL
23601 compilers access floating-point arguments that do not fit in the
23602 RSA from the stack when a subroutine is compiled without
23603 optimization.  Because always storing floating-point arguments on the
23604 stack is inefficient and rarely needed, this option is not enabled by
23605 default and only is necessary when calling subroutines compiled by IBM
23606 XL compilers without optimization.
23608 @item -mpe
23609 @opindex mpe
23610 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23611 application written to use message passing with special startup code to
23612 enable the application to run.  The system must have PE installed in the
23613 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23614 must be overridden with the @option{-specs=} option to specify the
23615 appropriate directory location.  The Parallel Environment does not
23616 support threads, so the @option{-mpe} option and the @option{-pthread}
23617 option are incompatible.
23619 @item -malign-natural
23620 @itemx -malign-power
23621 @opindex malign-natural
23622 @opindex malign-power
23623 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23624 @option{-malign-natural} overrides the ABI-defined alignment of larger
23625 types, such as floating-point doubles, on their natural size-based boundary.
23626 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23627 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23629 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23630 is not supported.
23632 @item -msoft-float
23633 @itemx -mhard-float
23634 @opindex msoft-float
23635 @opindex mhard-float
23636 Generate code that does not use (uses) the floating-point register set.
23637 Software floating-point emulation is provided if you use the
23638 @option{-msoft-float} option, and pass the option to GCC when linking.
23640 @item -msingle-float
23641 @itemx -mdouble-float
23642 @opindex msingle-float
23643 @opindex mdouble-float
23644 Generate code for single- or double-precision floating-point operations.
23645 @option{-mdouble-float} implies @option{-msingle-float}.
23647 @item -msimple-fpu
23648 @opindex msimple-fpu
23649 Do not generate @code{sqrt} and @code{div} instructions for hardware
23650 floating-point unit.
23652 @item -mfpu=@var{name}
23653 @opindex mfpu
23654 Specify type of floating-point unit.  Valid values for @var{name} are
23655 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
23656 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
23657 @samp{sp_full} (equivalent to @option{-msingle-float}),
23658 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
23660 @item -mxilinx-fpu
23661 @opindex mxilinx-fpu
23662 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
23664 @item -mmultiple
23665 @itemx -mno-multiple
23666 @opindex mmultiple
23667 @opindex mno-multiple
23668 Generate code that uses (does not use) the load multiple word
23669 instructions and the store multiple word instructions.  These
23670 instructions are generated by default on POWER systems, and not
23671 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23672 PowerPC systems, since those instructions do not work when the
23673 processor is in little-endian mode.  The exceptions are PPC740 and
23674 PPC750 which permit these instructions in little-endian mode.
23676 @item -mupdate
23677 @itemx -mno-update
23678 @opindex mupdate
23679 @opindex mno-update
23680 Generate code that uses (does not use) the load or store instructions
23681 that update the base register to the address of the calculated memory
23682 location.  These instructions are generated by default.  If you use
23683 @option{-mno-update}, there is a small window between the time that the
23684 stack pointer is updated and the address of the previous frame is
23685 stored, which means code that walks the stack frame across interrupts or
23686 signals may get corrupted data.
23688 @item -mavoid-indexed-addresses
23689 @itemx -mno-avoid-indexed-addresses
23690 @opindex mavoid-indexed-addresses
23691 @opindex mno-avoid-indexed-addresses
23692 Generate code that tries to avoid (not avoid) the use of indexed load
23693 or store instructions. These instructions can incur a performance
23694 penalty on Power6 processors in certain situations, such as when
23695 stepping through large arrays that cross a 16M boundary.  This option
23696 is enabled by default when targeting Power6 and disabled otherwise.
23698 @item -mfused-madd
23699 @itemx -mno-fused-madd
23700 @opindex mfused-madd
23701 @opindex mno-fused-madd
23702 Generate code that uses (does not use) the floating-point multiply and
23703 accumulate instructions.  These instructions are generated by default
23704 if hardware floating point is used.  The machine-dependent
23705 @option{-mfused-madd} option is now mapped to the machine-independent
23706 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23707 mapped to @option{-ffp-contract=off}.
23709 @item -mmulhw
23710 @itemx -mno-mulhw
23711 @opindex mmulhw
23712 @opindex mno-mulhw
23713 Generate code that uses (does not use) the half-word multiply and
23714 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23715 These instructions are generated by default when targeting those
23716 processors.
23718 @item -mdlmzb
23719 @itemx -mno-dlmzb
23720 @opindex mdlmzb
23721 @opindex mno-dlmzb
23722 Generate code that uses (does not use) the string-search @samp{dlmzb}
23723 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23724 generated by default when targeting those processors.
23726 @item -mno-bit-align
23727 @itemx -mbit-align
23728 @opindex mno-bit-align
23729 @opindex mbit-align
23730 On System V.4 and embedded PowerPC systems do not (do) force structures
23731 and unions that contain bit-fields to be aligned to the base type of the
23732 bit-field.
23734 For example, by default a structure containing nothing but 8
23735 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23736 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23737 the structure is aligned to a 1-byte boundary and is 1 byte in
23738 size.
23740 @item -mno-strict-align
23741 @itemx -mstrict-align
23742 @opindex mno-strict-align
23743 @opindex mstrict-align
23744 On System V.4 and embedded PowerPC systems do not (do) assume that
23745 unaligned memory references are handled by the system.
23747 @item -mrelocatable
23748 @itemx -mno-relocatable
23749 @opindex mrelocatable
23750 @opindex mno-relocatable
23751 Generate code that allows (does not allow) a static executable to be
23752 relocated to a different address at run time.  A simple embedded
23753 PowerPC system loader should relocate the entire contents of
23754 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23755 a table of 32-bit addresses generated by this option.  For this to
23756 work, all objects linked together must be compiled with
23757 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23758 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23760 @item -mrelocatable-lib
23761 @itemx -mno-relocatable-lib
23762 @opindex mrelocatable-lib
23763 @opindex mno-relocatable-lib
23764 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23765 @code{.fixup} section to allow static executables to be relocated at
23766 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23767 alignment of @option{-mrelocatable}.  Objects compiled with
23768 @option{-mrelocatable-lib} may be linked with objects compiled with
23769 any combination of the @option{-mrelocatable} options.
23771 @item -mno-toc
23772 @itemx -mtoc
23773 @opindex mno-toc
23774 @opindex mtoc
23775 On System V.4 and embedded PowerPC systems do not (do) assume that
23776 register 2 contains a pointer to a global area pointing to the addresses
23777 used in the program.
23779 @item -mlittle
23780 @itemx -mlittle-endian
23781 @opindex mlittle
23782 @opindex mlittle-endian
23783 On System V.4 and embedded PowerPC systems compile code for the
23784 processor in little-endian mode.  The @option{-mlittle-endian} option is
23785 the same as @option{-mlittle}.
23787 @item -mbig
23788 @itemx -mbig-endian
23789 @opindex mbig
23790 @opindex mbig-endian
23791 On System V.4 and embedded PowerPC systems compile code for the
23792 processor in big-endian mode.  The @option{-mbig-endian} option is
23793 the same as @option{-mbig}.
23795 @item -mdynamic-no-pic
23796 @opindex mdynamic-no-pic
23797 On Darwin and Mac OS X systems, compile code so that it is not
23798 relocatable, but that its external references are relocatable.  The
23799 resulting code is suitable for applications, but not shared
23800 libraries.
23802 @item -msingle-pic-base
23803 @opindex msingle-pic-base
23804 Treat the register used for PIC addressing as read-only, rather than
23805 loading it in the prologue for each function.  The runtime system is
23806 responsible for initializing this register with an appropriate value
23807 before execution begins.
23809 @item -mprioritize-restricted-insns=@var{priority}
23810 @opindex mprioritize-restricted-insns
23811 This option controls the priority that is assigned to
23812 dispatch-slot restricted instructions during the second scheduling
23813 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23814 or @samp{2} to assign no, highest, or second-highest (respectively) 
23815 priority to dispatch-slot restricted
23816 instructions.
23818 @item -msched-costly-dep=@var{dependence_type}
23819 @opindex msched-costly-dep
23820 This option controls which dependences are considered costly
23821 by the target during instruction scheduling.  The argument
23822 @var{dependence_type} takes one of the following values:
23824 @table @asis
23825 @item @samp{no}
23826 No dependence is costly.
23828 @item @samp{all}
23829 All dependences are costly.
23831 @item @samp{true_store_to_load}
23832 A true dependence from store to load is costly.
23834 @item @samp{store_to_load}
23835 Any dependence from store to load is costly.
23837 @item @var{number}
23838 Any dependence for which the latency is greater than or equal to 
23839 @var{number} is costly.
23840 @end table
23842 @item -minsert-sched-nops=@var{scheme}
23843 @opindex minsert-sched-nops
23844 This option controls which NOP insertion scheme is used during
23845 the second scheduling pass.  The argument @var{scheme} takes one of the
23846 following values:
23848 @table @asis
23849 @item @samp{no}
23850 Don't insert NOPs.
23852 @item @samp{pad}
23853 Pad with NOPs any dispatch group that has vacant issue slots,
23854 according to the scheduler's grouping.
23856 @item @samp{regroup_exact}
23857 Insert NOPs to force costly dependent insns into
23858 separate groups.  Insert exactly as many NOPs as needed to force an insn
23859 to a new group, according to the estimated processor grouping.
23861 @item @var{number}
23862 Insert NOPs to force costly dependent insns into
23863 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23864 @end table
23866 @item -mcall-sysv
23867 @opindex mcall-sysv
23868 On System V.4 and embedded PowerPC systems compile code using calling
23869 conventions that adhere to the March 1995 draft of the System V
23870 Application Binary Interface, PowerPC processor supplement.  This is the
23871 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23873 @item -mcall-sysv-eabi
23874 @itemx -mcall-eabi
23875 @opindex mcall-sysv-eabi
23876 @opindex mcall-eabi
23877 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23879 @item -mcall-sysv-noeabi
23880 @opindex mcall-sysv-noeabi
23881 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23883 @item -mcall-aixdesc
23884 @opindex m
23885 On System V.4 and embedded PowerPC systems compile code for the AIX
23886 operating system.
23888 @item -mcall-linux
23889 @opindex mcall-linux
23890 On System V.4 and embedded PowerPC systems compile code for the
23891 Linux-based GNU system.
23893 @item -mcall-freebsd
23894 @opindex mcall-freebsd
23895 On System V.4 and embedded PowerPC systems compile code for the
23896 FreeBSD operating system.
23898 @item -mcall-netbsd
23899 @opindex mcall-netbsd
23900 On System V.4 and embedded PowerPC systems compile code for the
23901 NetBSD operating system.
23903 @item -mcall-openbsd
23904 @opindex mcall-netbsd
23905 On System V.4 and embedded PowerPC systems compile code for the
23906 OpenBSD operating system.
23908 @item -maix-struct-return
23909 @opindex maix-struct-return
23910 Return all structures in memory (as specified by the AIX ABI)@.
23912 @item -msvr4-struct-return
23913 @opindex msvr4-struct-return
23914 Return structures smaller than 8 bytes in registers (as specified by the
23915 SVR4 ABI)@.
23917 @item -mabi=@var{abi-type}
23918 @opindex mabi
23919 Extend the current ABI with a particular extension, or remove such extension.
23920 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23921 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23922 @samp{elfv1}, @samp{elfv2}@.
23924 @item -mabi=spe
23925 @opindex mabi=spe
23926 Extend the current ABI with SPE ABI extensions.  This does not change
23927 the default ABI, instead it adds the SPE ABI extensions to the current
23928 ABI@.
23930 @item -mabi=no-spe
23931 @opindex mabi=no-spe
23932 Disable Book-E SPE ABI extensions for the current ABI@.
23934 @item -mabi=ibmlongdouble
23935 @opindex mabi=ibmlongdouble
23936 Change the current ABI to use IBM extended-precision long double.
23937 This is not likely to work if your system defaults to using IEEE
23938 extended-precision long double.  If you change the long double type
23939 from IEEE extended-precision, the compiler will issue a warning unless
23940 you use the @option{-Wno-psabi} option.
23942 @item -mabi=ieeelongdouble
23943 @opindex mabi=ieeelongdouble
23944 Change the current ABI to use IEEE extended-precision long double.
23945 This is not likely to work if your system defaults to using IBM
23946 extended-precision long double.  If you change the long double type
23947 from IBM extended-precision, the compiler will issue a warning unless
23948 you use the @option{-Wno-psabi} option.
23950 @item -mabi=elfv1
23951 @opindex mabi=elfv1
23952 Change the current ABI to use the ELFv1 ABI.
23953 This is the default ABI for big-endian PowerPC 64-bit Linux.
23954 Overriding the default ABI requires special system support and is
23955 likely to fail in spectacular ways.
23957 @item -mabi=elfv2
23958 @opindex mabi=elfv2
23959 Change the current ABI to use the ELFv2 ABI.
23960 This is the default ABI for little-endian PowerPC 64-bit Linux.
23961 Overriding the default ABI requires special system support and is
23962 likely to fail in spectacular ways.
23964 @item -mgnu-attribute
23965 @itemx -mno-gnu-attribute
23966 @opindex mgnu-attribute
23967 @opindex mno-gnu-attribute
23968 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23969 .gnu.attributes section that specify ABI variations in function
23970 parameters or return values.
23972 @item -mprototype
23973 @itemx -mno-prototype
23974 @opindex mprototype
23975 @opindex mno-prototype
23976 On System V.4 and embedded PowerPC systems assume that all calls to
23977 variable argument functions are properly prototyped.  Otherwise, the
23978 compiler must insert an instruction before every non-prototyped call to
23979 set or clear bit 6 of the condition code register (@code{CR}) to
23980 indicate whether floating-point values are passed in the floating-point
23981 registers in case the function takes variable arguments.  With
23982 @option{-mprototype}, only calls to prototyped variable argument functions
23983 set or clear the bit.
23985 @item -msim
23986 @opindex msim
23987 On embedded PowerPC systems, assume that the startup module is called
23988 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23989 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23990 configurations.
23992 @item -mmvme
23993 @opindex mmvme
23994 On embedded PowerPC systems, assume that the startup module is called
23995 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23996 @file{libc.a}.
23998 @item -mads
23999 @opindex mads
24000 On embedded PowerPC systems, assume that the startup module is called
24001 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24002 @file{libc.a}.
24004 @item -myellowknife
24005 @opindex myellowknife
24006 On embedded PowerPC systems, assume that the startup module is called
24007 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24008 @file{libc.a}.
24010 @item -mvxworks
24011 @opindex mvxworks
24012 On System V.4 and embedded PowerPC systems, specify that you are
24013 compiling for a VxWorks system.
24015 @item -memb
24016 @opindex memb
24017 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24018 header to indicate that @samp{eabi} extended relocations are used.
24020 @item -meabi
24021 @itemx -mno-eabi
24022 @opindex meabi
24023 @opindex mno-eabi
24024 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24025 Embedded Applications Binary Interface (EABI), which is a set of
24026 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24027 means that the stack is aligned to an 8-byte boundary, a function
24028 @code{__eabi} is called from @code{main} to set up the EABI
24029 environment, and the @option{-msdata} option can use both @code{r2} and
24030 @code{r13} to point to two separate small data areas.  Selecting
24031 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24032 no EABI initialization function is called from @code{main}, and the
24033 @option{-msdata} option only uses @code{r13} to point to a single
24034 small data area.  The @option{-meabi} option is on by default if you
24035 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24037 @item -msdata=eabi
24038 @opindex msdata=eabi
24039 On System V.4 and embedded PowerPC systems, put small initialized
24040 @code{const} global and static data in the @code{.sdata2} section, which
24041 is pointed to by register @code{r2}.  Put small initialized
24042 non-@code{const} global and static data in the @code{.sdata} section,
24043 which is pointed to by register @code{r13}.  Put small uninitialized
24044 global and static data in the @code{.sbss} section, which is adjacent to
24045 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24046 incompatible with the @option{-mrelocatable} option.  The
24047 @option{-msdata=eabi} option also sets the @option{-memb} option.
24049 @item -msdata=sysv
24050 @opindex msdata=sysv
24051 On System V.4 and embedded PowerPC systems, put small global and static
24052 data in the @code{.sdata} section, which is pointed to by register
24053 @code{r13}.  Put small uninitialized global and static data in the
24054 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24055 The @option{-msdata=sysv} option is incompatible with the
24056 @option{-mrelocatable} option.
24058 @item -msdata=default
24059 @itemx -msdata
24060 @opindex msdata=default
24061 @opindex msdata
24062 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24063 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24064 same as @option{-msdata=sysv}.
24066 @item -msdata=data
24067 @opindex msdata=data
24068 On System V.4 and embedded PowerPC systems, put small global
24069 data in the @code{.sdata} section.  Put small uninitialized global
24070 data in the @code{.sbss} section.  Do not use register @code{r13}
24071 to address small data however.  This is the default behavior unless
24072 other @option{-msdata} options are used.
24074 @item -msdata=none
24075 @itemx -mno-sdata
24076 @opindex msdata=none
24077 @opindex mno-sdata
24078 On embedded PowerPC systems, put all initialized global and static data
24079 in the @code{.data} section, and all uninitialized data in the
24080 @code{.bss} section.
24082 @item -mblock-move-inline-limit=@var{num}
24083 @opindex mblock-move-inline-limit
24084 Inline all block moves (such as calls to @code{memcpy} or structure
24085 copies) less than or equal to @var{num} bytes.  The minimum value for
24086 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24087 targets.  The default value is target-specific.
24089 @item -G @var{num}
24090 @opindex G
24091 @cindex smaller data references (PowerPC)
24092 @cindex .sdata/.sdata2 references (PowerPC)
24093 On embedded PowerPC systems, put global and static items less than or
24094 equal to @var{num} bytes into the small data or BSS sections instead of
24095 the normal data or BSS section.  By default, @var{num} is 8.  The
24096 @option{-G @var{num}} switch is also passed to the linker.
24097 All modules should be compiled with the same @option{-G @var{num}} value.
24099 @item -mregnames
24100 @itemx -mno-regnames
24101 @opindex mregnames
24102 @opindex mno-regnames
24103 On System V.4 and embedded PowerPC systems do (do not) emit register
24104 names in the assembly language output using symbolic forms.
24106 @item -mlongcall
24107 @itemx -mno-longcall
24108 @opindex mlongcall
24109 @opindex mno-longcall
24110 By default assume that all calls are far away so that a longer and more
24111 expensive calling sequence is required.  This is required for calls
24112 farther than 32 megabytes (33,554,432 bytes) from the current location.
24113 A short call is generated if the compiler knows
24114 the call cannot be that far away.  This setting can be overridden by
24115 the @code{shortcall} function attribute, or by @code{#pragma
24116 longcall(0)}.
24118 Some linkers are capable of detecting out-of-range calls and generating
24119 glue code on the fly.  On these systems, long calls are unnecessary and
24120 generate slower code.  As of this writing, the AIX linker can do this,
24121 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24122 to the GNU linker for 32-bit PowerPC systems as well.
24124 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24125 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24126 addresses represent the callee and the branch island.  The
24127 Darwin/PPC linker prefers the first address and generates a @code{bl
24128 callee} if the PPC @code{bl} instruction reaches the callee directly;
24129 otherwise, the linker generates @code{bl L42} to call the branch
24130 island.  The branch island is appended to the body of the
24131 calling function; it computes the full 32-bit address of the callee
24132 and jumps to it.
24134 On Mach-O (Darwin) systems, this option directs the compiler emit to
24135 the glue for every direct call, and the Darwin linker decides whether
24136 to use or discard it.
24138 In the future, GCC may ignore all longcall specifications
24139 when the linker is known to generate glue.
24141 @item -mtls-markers
24142 @itemx -mno-tls-markers
24143 @opindex mtls-markers
24144 @opindex mno-tls-markers
24145 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24146 specifying the function argument.  The relocation allows the linker to
24147 reliably associate function call with argument setup instructions for
24148 TLS optimization, which in turn allows GCC to better schedule the
24149 sequence.
24151 @item -mrecip
24152 @itemx -mno-recip
24153 @opindex mrecip
24154 This option enables use of the reciprocal estimate and
24155 reciprocal square root estimate instructions with additional
24156 Newton-Raphson steps to increase precision instead of doing a divide or
24157 square root and divide for floating-point arguments.  You should use
24158 the @option{-ffast-math} option when using @option{-mrecip} (or at
24159 least @option{-funsafe-math-optimizations},
24160 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24161 @option{-fno-trapping-math}).  Note that while the throughput of the
24162 sequence is generally higher than the throughput of the non-reciprocal
24163 instruction, the precision of the sequence can be decreased by up to 2
24164 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24165 roots.
24167 @item -mrecip=@var{opt}
24168 @opindex mrecip=opt
24169 This option controls which reciprocal estimate instructions
24170 may be used.  @var{opt} is a comma-separated list of options, which may
24171 be preceded by a @code{!} to invert the option:
24173 @table @samp
24175 @item all
24176 Enable all estimate instructions.
24178 @item default 
24179 Enable the default instructions, equivalent to @option{-mrecip}.
24181 @item none 
24182 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24184 @item div 
24185 Enable the reciprocal approximation instructions for both 
24186 single and double precision.
24188 @item divf 
24189 Enable the single-precision reciprocal approximation instructions.
24191 @item divd 
24192 Enable the double-precision reciprocal approximation instructions.
24194 @item rsqrt 
24195 Enable the reciprocal square root approximation instructions for both
24196 single and double precision.
24198 @item rsqrtf 
24199 Enable the single-precision reciprocal square root approximation instructions.
24201 @item rsqrtd 
24202 Enable the double-precision reciprocal square root approximation instructions.
24204 @end table
24206 So, for example, @option{-mrecip=all,!rsqrtd} enables
24207 all of the reciprocal estimate instructions, except for the
24208 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24209 which handle the double-precision reciprocal square root calculations.
24211 @item -mrecip-precision
24212 @itemx -mno-recip-precision
24213 @opindex mrecip-precision
24214 Assume (do not assume) that the reciprocal estimate instructions
24215 provide higher-precision estimates than is mandated by the PowerPC
24216 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24217 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24218 The double-precision square root estimate instructions are not generated by
24219 default on low-precision machines, since they do not provide an
24220 estimate that converges after three steps.
24222 @item -mveclibabi=@var{type}
24223 @opindex mveclibabi
24224 Specifies the ABI type to use for vectorizing intrinsics using an
24225 external library.  The only type supported at present is @samp{mass},
24226 which specifies to use IBM's Mathematical Acceleration Subsystem
24227 (MASS) libraries for vectorizing intrinsics using external libraries.
24228 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24229 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24230 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24231 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24232 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24233 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24234 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24235 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24236 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24237 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24238 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24239 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24240 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24241 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24242 for power7.  Both @option{-ftree-vectorize} and
24243 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24244 libraries must be specified at link time.
24246 @item -mfriz
24247 @itemx -mno-friz
24248 @opindex mfriz
24249 Generate (do not generate) the @code{friz} instruction when the
24250 @option{-funsafe-math-optimizations} option is used to optimize
24251 rounding of floating-point values to 64-bit integer and back to floating
24252 point.  The @code{friz} instruction does not return the same value if
24253 the floating-point number is too large to fit in an integer.
24255 @item -mpointers-to-nested-functions
24256 @itemx -mno-pointers-to-nested-functions
24257 @opindex mpointers-to-nested-functions
24258 Generate (do not generate) code to load up the static chain register
24259 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24260 systems where a function pointer points to a 3-word descriptor giving
24261 the function address, TOC value to be loaded in register @code{r2}, and
24262 static chain value to be loaded in register @code{r11}.  The
24263 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24264 call through pointers to nested functions or pointers
24265 to functions compiled in other languages that use the static chain if
24266 you use @option{-mno-pointers-to-nested-functions}.
24268 @item -msave-toc-indirect
24269 @itemx -mno-save-toc-indirect
24270 @opindex msave-toc-indirect
24271 Generate (do not generate) code to save the TOC value in the reserved
24272 stack location in the function prologue if the function calls through
24273 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24274 saved in the prologue, it is saved just before the call through the
24275 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24277 @item -mcompat-align-parm
24278 @itemx -mno-compat-align-parm
24279 @opindex mcompat-align-parm
24280 Generate (do not generate) code to pass structure parameters with a
24281 maximum alignment of 64 bits, for compatibility with older versions
24282 of GCC.
24284 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24285 structure parameter on a 128-bit boundary when that structure contained
24286 a member requiring 128-bit alignment.  This is corrected in more
24287 recent versions of GCC.  This option may be used to generate code
24288 that is compatible with functions compiled with older versions of
24289 GCC.
24291 The @option{-mno-compat-align-parm} option is the default.
24293 @item -mstack-protector-guard=@var{guard}
24294 @itemx -mstack-protector-guard-reg=@var{reg}
24295 @itemx -mstack-protector-guard-offset=@var{offset}
24296 @itemx -mstack-protector-guard-symbol=@var{symbol}
24297 @opindex mstack-protector-guard
24298 @opindex mstack-protector-guard-reg
24299 @opindex mstack-protector-guard-offset
24300 @opindex mstack-protector-guard-symbol
24301 Generate stack protection code using canary at @var{guard}.  Supported
24302 locations are @samp{global} for global canary or @samp{tls} for per-thread
24303 canary in the TLS block (the default with GNU libc version 2.4 or later).
24305 With the latter choice the options
24306 @option{-mstack-protector-guard-reg=@var{reg}} and
24307 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24308 which register to use as base register for reading the canary, and from what
24309 offset from that base register. The default for those is as specified in the
24310 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24311 the offset with a symbol reference to a canary in the TLS block.
24312 @end table
24314 @node RX Options
24315 @subsection RX Options
24316 @cindex RX Options
24318 These command-line options are defined for RX targets:
24320 @table @gcctabopt
24321 @item -m64bit-doubles
24322 @itemx -m32bit-doubles
24323 @opindex m64bit-doubles
24324 @opindex m32bit-doubles
24325 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24326 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24327 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24328 works on 32-bit values, which is why the default is
24329 @option{-m32bit-doubles}.
24331 @item -fpu
24332 @itemx -nofpu
24333 @opindex fpu
24334 @opindex nofpu
24335 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24336 floating-point hardware.  The default is enabled for the RX600
24337 series and disabled for the RX200 series.
24339 Floating-point instructions are only generated for 32-bit floating-point 
24340 values, however, so the FPU hardware is not used for doubles if the
24341 @option{-m64bit-doubles} option is used.
24343 @emph{Note} If the @option{-fpu} option is enabled then
24344 @option{-funsafe-math-optimizations} is also enabled automatically.
24345 This is because the RX FPU instructions are themselves unsafe.
24347 @item -mcpu=@var{name}
24348 @opindex mcpu
24349 Selects the type of RX CPU to be targeted.  Currently three types are
24350 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24351 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24353 The only difference between @samp{RX600} and @samp{RX610} is that the
24354 @samp{RX610} does not support the @code{MVTIPL} instruction.
24356 The @samp{RX200} series does not have a hardware floating-point unit
24357 and so @option{-nofpu} is enabled by default when this type is
24358 selected.
24360 @item -mbig-endian-data
24361 @itemx -mlittle-endian-data
24362 @opindex mbig-endian-data
24363 @opindex mlittle-endian-data
24364 Store data (but not code) in the big-endian format.  The default is
24365 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24366 format.
24368 @item -msmall-data-limit=@var{N}
24369 @opindex msmall-data-limit
24370 Specifies the maximum size in bytes of global and static variables
24371 which can be placed into the small data area.  Using the small data
24372 area can lead to smaller and faster code, but the size of area is
24373 limited and it is up to the programmer to ensure that the area does
24374 not overflow.  Also when the small data area is used one of the RX's
24375 registers (usually @code{r13}) is reserved for use pointing to this
24376 area, so it is no longer available for use by the compiler.  This
24377 could result in slower and/or larger code if variables are pushed onto
24378 the stack instead of being held in this register.
24380 Note, common variables (variables that have not been initialized) and
24381 constants are not placed into the small data area as they are assigned
24382 to other sections in the output executable.
24384 The default value is zero, which disables this feature.  Note, this
24385 feature is not enabled by default with higher optimization levels
24386 (@option{-O2} etc) because of the potentially detrimental effects of
24387 reserving a register.  It is up to the programmer to experiment and
24388 discover whether this feature is of benefit to their program.  See the
24389 description of the @option{-mpid} option for a description of how the
24390 actual register to hold the small data area pointer is chosen.
24392 @item -msim
24393 @itemx -mno-sim
24394 @opindex msim
24395 @opindex mno-sim
24396 Use the simulator runtime.  The default is to use the libgloss
24397 board-specific runtime.
24399 @item -mas100-syntax
24400 @itemx -mno-as100-syntax
24401 @opindex mas100-syntax
24402 @opindex mno-as100-syntax
24403 When generating assembler output use a syntax that is compatible with
24404 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24405 assembler, but it has some restrictions so it is not generated by default.
24407 @item -mmax-constant-size=@var{N}
24408 @opindex mmax-constant-size
24409 Specifies the maximum size, in bytes, of a constant that can be used as
24410 an operand in a RX instruction.  Although the RX instruction set does
24411 allow constants of up to 4 bytes in length to be used in instructions,
24412 a longer value equates to a longer instruction.  Thus in some
24413 circumstances it can be beneficial to restrict the size of constants
24414 that are used in instructions.  Constants that are too big are instead
24415 placed into a constant pool and referenced via register indirection.
24417 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24418 or 4 means that constants of any size are allowed.
24420 @item -mrelax
24421 @opindex mrelax
24422 Enable linker relaxation.  Linker relaxation is a process whereby the
24423 linker attempts to reduce the size of a program by finding shorter
24424 versions of various instructions.  Disabled by default.
24426 @item -mint-register=@var{N}
24427 @opindex mint-register
24428 Specify the number of registers to reserve for fast interrupt handler
24429 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24430 means that register @code{r13} is reserved for the exclusive use
24431 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24432 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24433 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24434 A value of 0, the default, does not reserve any registers.
24436 @item -msave-acc-in-interrupts
24437 @opindex msave-acc-in-interrupts
24438 Specifies that interrupt handler functions should preserve the
24439 accumulator register.  This is only necessary if normal code might use
24440 the accumulator register, for example because it performs 64-bit
24441 multiplications.  The default is to ignore the accumulator as this
24442 makes the interrupt handlers faster.
24444 @item -mpid
24445 @itemx -mno-pid
24446 @opindex mpid
24447 @opindex mno-pid
24448 Enables the generation of position independent data.  When enabled any
24449 access to constant data is done via an offset from a base address
24450 held in a register.  This allows the location of constant data to be
24451 determined at run time without requiring the executable to be
24452 relocated, which is a benefit to embedded applications with tight
24453 memory constraints.  Data that can be modified is not affected by this
24454 option.
24456 Note, using this feature reserves a register, usually @code{r13}, for
24457 the constant data base address.  This can result in slower and/or
24458 larger code, especially in complicated functions.
24460 The actual register chosen to hold the constant data base address
24461 depends upon whether the @option{-msmall-data-limit} and/or the
24462 @option{-mint-register} command-line options are enabled.  Starting
24463 with register @code{r13} and proceeding downwards, registers are
24464 allocated first to satisfy the requirements of @option{-mint-register},
24465 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24466 is possible for the small data area register to be @code{r8} if both
24467 @option{-mint-register=4} and @option{-mpid} are specified on the
24468 command line.
24470 By default this feature is not enabled.  The default can be restored
24471 via the @option{-mno-pid} command-line option.
24473 @item -mno-warn-multiple-fast-interrupts
24474 @itemx -mwarn-multiple-fast-interrupts
24475 @opindex mno-warn-multiple-fast-interrupts
24476 @opindex mwarn-multiple-fast-interrupts
24477 Prevents GCC from issuing a warning message if it finds more than one
24478 fast interrupt handler when it is compiling a file.  The default is to
24479 issue a warning for each extra fast interrupt handler found, as the RX
24480 only supports one such interrupt.
24482 @item -mallow-string-insns
24483 @itemx -mno-allow-string-insns
24484 @opindex mallow-string-insns
24485 @opindex mno-allow-string-insns
24486 Enables or disables the use of the string manipulation instructions
24487 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24488 @code{SWHILE} and also the @code{RMPA} instruction.  These
24489 instructions may prefetch data, which is not safe to do if accessing
24490 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24491 for more information).
24493 The default is to allow these instructions, but it is not possible for
24494 GCC to reliably detect all circumstances where a string instruction
24495 might be used to access an I/O register, so their use cannot be
24496 disabled automatically.  Instead it is reliant upon the programmer to
24497 use the @option{-mno-allow-string-insns} option if their program
24498 accesses I/O space.
24500 When the instructions are enabled GCC defines the C preprocessor
24501 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24502 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24504 @item -mjsr
24505 @itemx -mno-jsr
24506 @opindex mjsr
24507 @opindex mno-jsr
24508 Use only (or not only) @code{JSR} instructions to access functions.
24509 This option can be used when code size exceeds the range of @code{BSR}
24510 instructions.  Note that @option{-mno-jsr} does not mean to not use
24511 @code{JSR} but instead means that any type of branch may be used.
24512 @end table
24514 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24515 has special significance to the RX port when used with the
24516 @code{interrupt} function attribute.  This attribute indicates a
24517 function intended to process fast interrupts.  GCC ensures
24518 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24519 and/or @code{r13} and only provided that the normal use of the
24520 corresponding registers have been restricted via the
24521 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24522 options.
24524 @node S/390 and zSeries Options
24525 @subsection S/390 and zSeries Options
24526 @cindex S/390 and zSeries Options
24528 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24530 @table @gcctabopt
24531 @item -mhard-float
24532 @itemx -msoft-float
24533 @opindex mhard-float
24534 @opindex msoft-float
24535 Use (do not use) the hardware floating-point instructions and registers
24536 for floating-point operations.  When @option{-msoft-float} is specified,
24537 functions in @file{libgcc.a} are used to perform floating-point
24538 operations.  When @option{-mhard-float} is specified, the compiler
24539 generates IEEE floating-point instructions.  This is the default.
24541 @item -mhard-dfp
24542 @itemx -mno-hard-dfp
24543 @opindex mhard-dfp
24544 @opindex mno-hard-dfp
24545 Use (do not use) the hardware decimal-floating-point instructions for
24546 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24547 specified, functions in @file{libgcc.a} are used to perform
24548 decimal-floating-point operations.  When @option{-mhard-dfp} is
24549 specified, the compiler generates decimal-floating-point hardware
24550 instructions.  This is the default for @option{-march=z9-ec} or higher.
24552 @item -mlong-double-64
24553 @itemx -mlong-double-128
24554 @opindex mlong-double-64
24555 @opindex mlong-double-128
24556 These switches control the size of @code{long double} type. A size
24557 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24558 type. This is the default.
24560 @item -mbackchain
24561 @itemx -mno-backchain
24562 @opindex mbackchain
24563 @opindex mno-backchain
24564 Store (do not store) the address of the caller's frame as backchain pointer
24565 into the callee's stack frame.
24566 A backchain may be needed to allow debugging using tools that do not understand
24567 DWARF call frame information.
24568 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24569 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24570 the backchain is placed into the topmost word of the 96/160 byte register
24571 save area.
24573 In general, code compiled with @option{-mbackchain} is call-compatible with
24574 code compiled with @option{-mmo-backchain}; however, use of the backchain
24575 for debugging purposes usually requires that the whole binary is built with
24576 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24577 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24578 to build a linux kernel use @option{-msoft-float}.
24580 The default is to not maintain the backchain.
24582 @item -mpacked-stack
24583 @itemx -mno-packed-stack
24584 @opindex mpacked-stack
24585 @opindex mno-packed-stack
24586 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24587 specified, the compiler uses the all fields of the 96/160 byte register save
24588 area only for their default purpose; unused fields still take up stack space.
24589 When @option{-mpacked-stack} is specified, register save slots are densely
24590 packed at the top of the register save area; unused space is reused for other
24591 purposes, allowing for more efficient use of the available stack space.
24592 However, when @option{-mbackchain} is also in effect, the topmost word of
24593 the save area is always used to store the backchain, and the return address
24594 register is always saved two words below the backchain.
24596 As long as the stack frame backchain is not used, code generated with
24597 @option{-mpacked-stack} is call-compatible with code generated with
24598 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24599 S/390 or zSeries generated code that uses the stack frame backchain at run
24600 time, not just for debugging purposes.  Such code is not call-compatible
24601 with code compiled with @option{-mpacked-stack}.  Also, note that the
24602 combination of @option{-mbackchain},
24603 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24604 to build a linux kernel use @option{-msoft-float}.
24606 The default is to not use the packed stack layout.
24608 @item -msmall-exec
24609 @itemx -mno-small-exec
24610 @opindex msmall-exec
24611 @opindex mno-small-exec
24612 Generate (or do not generate) code using the @code{bras} instruction
24613 to do subroutine calls.
24614 This only works reliably if the total executable size does not
24615 exceed 64k.  The default is to use the @code{basr} instruction instead,
24616 which does not have this limitation.
24618 @item -m64
24619 @itemx -m31
24620 @opindex m64
24621 @opindex m31
24622 When @option{-m31} is specified, generate code compliant to the
24623 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24624 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24625 particular to generate 64-bit instructions.  For the @samp{s390}
24626 targets, the default is @option{-m31}, while the @samp{s390x}
24627 targets default to @option{-m64}.
24629 @item -mzarch
24630 @itemx -mesa
24631 @opindex mzarch
24632 @opindex mesa
24633 When @option{-mzarch} is specified, generate code using the
24634 instructions available on z/Architecture.
24635 When @option{-mesa} is specified, generate code using the
24636 instructions available on ESA/390.  Note that @option{-mesa} is
24637 not possible with @option{-m64}.
24638 When generating code compliant to the GNU/Linux for S/390 ABI,
24639 the default is @option{-mesa}.  When generating code compliant
24640 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24642 @item -mhtm
24643 @itemx -mno-htm
24644 @opindex mhtm
24645 @opindex mno-htm
24646 The @option{-mhtm} option enables a set of builtins making use of
24647 instructions available with the transactional execution facility
24648 introduced with the IBM zEnterprise EC12 machine generation
24649 @ref{S/390 System z Built-in Functions}.
24650 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24652 @item -mvx
24653 @itemx -mno-vx
24654 @opindex mvx
24655 @opindex mno-vx
24656 When @option{-mvx} is specified, generate code using the instructions
24657 available with the vector extension facility introduced with the IBM
24658 z13 machine generation.
24659 This option changes the ABI for some vector type values with regard to
24660 alignment and calling conventions.  In case vector type values are
24661 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24662 command will be added to mark the resulting binary with the ABI used.
24663 @option{-mvx} is enabled by default when using @option{-march=z13}.
24665 @item -mzvector
24666 @itemx -mno-zvector
24667 @opindex mzvector
24668 @opindex mno-zvector
24669 The @option{-mzvector} option enables vector language extensions and
24670 builtins using instructions available with the vector extension
24671 facility introduced with the IBM z13 machine generation.
24672 This option adds support for @samp{vector} to be used as a keyword to
24673 define vector type variables and arguments.  @samp{vector} is only
24674 available when GNU extensions are enabled.  It will not be expanded
24675 when requesting strict standard compliance e.g. with @option{-std=c99}.
24676 In addition to the GCC low-level builtins @option{-mzvector} enables
24677 a set of builtins added for compatibility with AltiVec-style
24678 implementations like Power and Cell.  In order to make use of these
24679 builtins the header file @file{vecintrin.h} needs to be included.
24680 @option{-mzvector} is disabled by default.
24682 @item -mmvcle
24683 @itemx -mno-mvcle
24684 @opindex mmvcle
24685 @opindex mno-mvcle
24686 Generate (or do not generate) code using the @code{mvcle} instruction
24687 to perform block moves.  When @option{-mno-mvcle} is specified,
24688 use a @code{mvc} loop instead.  This is the default unless optimizing for
24689 size.
24691 @item -mdebug
24692 @itemx -mno-debug
24693 @opindex mdebug
24694 @opindex mno-debug
24695 Print (or do not print) additional debug information when compiling.
24696 The default is to not print debug information.
24698 @item -march=@var{cpu-type}
24699 @opindex march
24700 Generate code that runs on @var{cpu-type}, which is the name of a
24701 system representing a certain processor type.  Possible values for
24702 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24703 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24704 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24705 @samp{native}.
24707 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24708 @samp{g6} are deprecated and will be removed with future releases.
24710 Specifying @samp{native} as cpu type can be used to select the best
24711 architecture option for the host processor.
24712 @option{-march=native} has no effect if GCC does not recognize the
24713 processor.
24715 @item -mtune=@var{cpu-type}
24716 @opindex mtune
24717 Tune to @var{cpu-type} everything applicable about the generated code,
24718 except for the ABI and the set of available instructions.
24719 The list of @var{cpu-type} values is the same as for @option{-march}.
24720 The default is the value used for @option{-march}.
24722 @item -mtpf-trace
24723 @itemx -mno-tpf-trace
24724 @opindex mtpf-trace
24725 @opindex mno-tpf-trace
24726 Generate code that adds (does not add) in TPF OS specific branches to trace
24727 routines in the operating system.  This option is off by default, even
24728 when compiling for the TPF OS@.
24730 @item -mfused-madd
24731 @itemx -mno-fused-madd
24732 @opindex mfused-madd
24733 @opindex mno-fused-madd
24734 Generate code that uses (does not use) the floating-point multiply and
24735 accumulate instructions.  These instructions are generated by default if
24736 hardware floating point is used.
24738 @item -mwarn-framesize=@var{framesize}
24739 @opindex mwarn-framesize
24740 Emit a warning if the current function exceeds the given frame size.  Because
24741 this is a compile-time check it doesn't need to be a real problem when the program
24742 runs.  It is intended to identify functions that most probably cause
24743 a stack overflow.  It is useful to be used in an environment with limited stack
24744 size e.g.@: the linux kernel.
24746 @item -mwarn-dynamicstack
24747 @opindex mwarn-dynamicstack
24748 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24749 arrays.  This is generally a bad idea with a limited stack size.
24751 @item -mstack-guard=@var{stack-guard}
24752 @itemx -mstack-size=@var{stack-size}
24753 @opindex mstack-guard
24754 @opindex mstack-size
24755 If these options are provided the S/390 back end emits additional instructions in
24756 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24757 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24758 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24759 the frame size of the compiled function is chosen.
24760 These options are intended to be used to help debugging stack overflow problems.
24761 The additionally emitted code causes only little overhead and hence can also be
24762 used in production-like systems without greater performance degradation.  The given
24763 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24764 @var{stack-guard} without exceeding 64k.
24765 In order to be efficient the extra code makes the assumption that the stack starts
24766 at an address aligned to the value given by @var{stack-size}.
24767 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24769 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24770 @opindex mhotpatch
24771 If the hotpatch option is enabled, a ``hot-patching'' function
24772 prologue is generated for all functions in the compilation unit.
24773 The funtion label is prepended with the given number of two-byte
24774 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24775 the label, 2 * @var{post-halfwords} bytes are appended, using the
24776 largest NOP like instructions the architecture allows (maximum
24777 1000000).
24779 If both arguments are zero, hotpatching is disabled.
24781 This option can be overridden for individual functions with the
24782 @code{hotpatch} attribute.
24783 @end table
24785 @node Score Options
24786 @subsection Score Options
24787 @cindex Score Options
24789 These options are defined for Score implementations:
24791 @table @gcctabopt
24792 @item -meb
24793 @opindex meb
24794 Compile code for big-endian mode.  This is the default.
24796 @item -mel
24797 @opindex mel
24798 Compile code for little-endian mode.
24800 @item -mnhwloop
24801 @opindex mnhwloop
24802 Disable generation of @code{bcnz} instructions.
24804 @item -muls
24805 @opindex muls
24806 Enable generation of unaligned load and store instructions.
24808 @item -mmac
24809 @opindex mmac
24810 Enable the use of multiply-accumulate instructions. Disabled by default.
24812 @item -mscore5
24813 @opindex mscore5
24814 Specify the SCORE5 as the target architecture.
24816 @item -mscore5u
24817 @opindex mscore5u
24818 Specify the SCORE5U of the target architecture.
24820 @item -mscore7
24821 @opindex mscore7
24822 Specify the SCORE7 as the target architecture. This is the default.
24824 @item -mscore7d
24825 @opindex mscore7d
24826 Specify the SCORE7D as the target architecture.
24827 @end table
24829 @node SH Options
24830 @subsection SH Options
24832 These @samp{-m} options are defined for the SH implementations:
24834 @table @gcctabopt
24835 @item -m1
24836 @opindex m1
24837 Generate code for the SH1.
24839 @item -m2
24840 @opindex m2
24841 Generate code for the SH2.
24843 @item -m2e
24844 Generate code for the SH2e.
24846 @item -m2a-nofpu
24847 @opindex m2a-nofpu
24848 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24849 that the floating-point unit is not used.
24851 @item -m2a-single-only
24852 @opindex m2a-single-only
24853 Generate code for the SH2a-FPU, in such a way that no double-precision
24854 floating-point operations are used.
24856 @item -m2a-single
24857 @opindex m2a-single
24858 Generate code for the SH2a-FPU assuming the floating-point unit is in
24859 single-precision mode by default.
24861 @item -m2a
24862 @opindex m2a
24863 Generate code for the SH2a-FPU assuming the floating-point unit is in
24864 double-precision mode by default.
24866 @item -m3
24867 @opindex m3
24868 Generate code for the SH3.
24870 @item -m3e
24871 @opindex m3e
24872 Generate code for the SH3e.
24874 @item -m4-nofpu
24875 @opindex m4-nofpu
24876 Generate code for the SH4 without a floating-point unit.
24878 @item -m4-single-only
24879 @opindex m4-single-only
24880 Generate code for the SH4 with a floating-point unit that only
24881 supports single-precision arithmetic.
24883 @item -m4-single
24884 @opindex m4-single
24885 Generate code for the SH4 assuming the floating-point unit is in
24886 single-precision mode by default.
24888 @item -m4
24889 @opindex m4
24890 Generate code for the SH4.
24892 @item -m4-100
24893 @opindex m4-100
24894 Generate code for SH4-100.
24896 @item -m4-100-nofpu
24897 @opindex m4-100-nofpu
24898 Generate code for SH4-100 in such a way that the
24899 floating-point unit is not used.
24901 @item -m4-100-single
24902 @opindex m4-100-single
24903 Generate code for SH4-100 assuming the floating-point unit is in
24904 single-precision mode by default.
24906 @item -m4-100-single-only
24907 @opindex m4-100-single-only
24908 Generate code for SH4-100 in such a way that no double-precision
24909 floating-point operations are used.
24911 @item -m4-200
24912 @opindex m4-200
24913 Generate code for SH4-200.
24915 @item -m4-200-nofpu
24916 @opindex m4-200-nofpu
24917 Generate code for SH4-200 without in such a way that the
24918 floating-point unit is not used.
24920 @item -m4-200-single
24921 @opindex m4-200-single
24922 Generate code for SH4-200 assuming the floating-point unit is in
24923 single-precision mode by default.
24925 @item -m4-200-single-only
24926 @opindex m4-200-single-only
24927 Generate code for SH4-200 in such a way that no double-precision
24928 floating-point operations are used.
24930 @item -m4-300
24931 @opindex m4-300
24932 Generate code for SH4-300.
24934 @item -m4-300-nofpu
24935 @opindex m4-300-nofpu
24936 Generate code for SH4-300 without in such a way that the
24937 floating-point unit is not used.
24939 @item -m4-300-single
24940 @opindex m4-300-single
24941 Generate code for SH4-300 in such a way that no double-precision
24942 floating-point operations are used.
24944 @item -m4-300-single-only
24945 @opindex m4-300-single-only
24946 Generate code for SH4-300 in such a way that no double-precision
24947 floating-point operations are used.
24949 @item -m4-340
24950 @opindex m4-340
24951 Generate code for SH4-340 (no MMU, no FPU).
24953 @item -m4-500
24954 @opindex m4-500
24955 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24956 assembler.
24958 @item -m4a-nofpu
24959 @opindex m4a-nofpu
24960 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
24961 floating-point unit is not used.
24963 @item -m4a-single-only
24964 @opindex m4a-single-only
24965 Generate code for the SH4a, in such a way that no double-precision
24966 floating-point operations are used.
24968 @item -m4a-single
24969 @opindex m4a-single
24970 Generate code for the SH4a assuming the floating-point unit is in
24971 single-precision mode by default.
24973 @item -m4a
24974 @opindex m4a
24975 Generate code for the SH4a.
24977 @item -m4al
24978 @opindex m4al
24979 Same as @option{-m4a-nofpu}, except that it implicitly passes
24980 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
24981 instructions at the moment.
24983 @item -mb
24984 @opindex mb
24985 Compile code for the processor in big-endian mode.
24987 @item -ml
24988 @opindex ml
24989 Compile code for the processor in little-endian mode.
24991 @item -mdalign
24992 @opindex mdalign
24993 Align doubles at 64-bit boundaries.  Note that this changes the calling
24994 conventions, and thus some functions from the standard C library do
24995 not work unless you recompile it first with @option{-mdalign}.
24997 @item -mrelax
24998 @opindex mrelax
24999 Shorten some address references at link time, when possible; uses the
25000 linker option @option{-relax}.
25002 @item -mbigtable
25003 @opindex mbigtable
25004 Use 32-bit offsets in @code{switch} tables.  The default is to use
25005 16-bit offsets.
25007 @item -mbitops
25008 @opindex mbitops
25009 Enable the use of bit manipulation instructions on SH2A.
25011 @item -mfmovd
25012 @opindex mfmovd
25013 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25014 alignment constraints.
25016 @item -mrenesas
25017 @opindex mrenesas
25018 Comply with the calling conventions defined by Renesas.
25020 @item -mno-renesas
25021 @opindex mno-renesas
25022 Comply with the calling conventions defined for GCC before the Renesas
25023 conventions were available.  This option is the default for all
25024 targets of the SH toolchain.
25026 @item -mnomacsave
25027 @opindex mnomacsave
25028 Mark the @code{MAC} register as call-clobbered, even if
25029 @option{-mrenesas} is given.
25031 @item -mieee
25032 @itemx -mno-ieee
25033 @opindex mieee
25034 @opindex mno-ieee
25035 Control the IEEE compliance of floating-point comparisons, which affects the
25036 handling of cases where the result of a comparison is unordered.  By default
25037 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25038 enabled @option{-mno-ieee} is implicitly set, which results in faster
25039 floating-point greater-equal and less-equal comparisons.  The implicit settings
25040 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25042 @item -minline-ic_invalidate
25043 @opindex minline-ic_invalidate
25044 Inline code to invalidate instruction cache entries after setting up
25045 nested function trampolines.
25046 This option has no effect if @option{-musermode} is in effect and the selected
25047 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25048 instruction.
25049 If the selected code generation option does not allow the use of the @code{icbi}
25050 instruction, and @option{-musermode} is not in effect, the inlined code
25051 manipulates the instruction cache address array directly with an associative
25052 write.  This not only requires privileged mode at run time, but it also
25053 fails if the cache line had been mapped via the TLB and has become unmapped.
25055 @item -misize
25056 @opindex misize
25057 Dump instruction size and location in the assembly code.
25059 @item -mpadstruct
25060 @opindex mpadstruct
25061 This option is deprecated.  It pads structures to multiple of 4 bytes,
25062 which is incompatible with the SH ABI@.
25064 @item -matomic-model=@var{model}
25065 @opindex matomic-model=@var{model}
25066 Sets the model of atomic operations and additional parameters as a comma
25067 separated list.  For details on the atomic built-in functions see
25068 @ref{__atomic Builtins}.  The following models and parameters are supported:
25070 @table @samp
25072 @item none
25073 Disable compiler generated atomic sequences and emit library calls for atomic
25074 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25076 @item soft-gusa
25077 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25078 built-in functions.  The generated atomic sequences require additional support
25079 from the interrupt/exception handling code of the system and are only suitable
25080 for SH3* and SH4* single-core systems.  This option is enabled by default when
25081 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25082 this option also partially utilizes the hardware atomic instructions
25083 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25084 @samp{strict} is specified.  
25086 @item soft-tcb
25087 Generate software atomic sequences that use a variable in the thread control
25088 block.  This is a variation of the gUSA sequences which can also be used on
25089 SH1* and SH2* targets.  The generated atomic sequences require additional
25090 support from the interrupt/exception handling code of the system and are only
25091 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25092 parameter has to be specified as well.
25094 @item soft-imask
25095 Generate software atomic sequences that temporarily disable interrupts by
25096 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25097 in privileged mode and is only suitable for single-core systems.  Additional
25098 support from the interrupt/exception handling code of the system is not
25099 required.  This model is enabled by default when the target is
25100 @code{sh*-*-linux*} and SH1* or SH2*.
25102 @item hard-llcs
25103 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25104 instructions only.  This is only available on SH4A and is suitable for
25105 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25106 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25107 Code compiled with this option is also compatible with other software
25108 atomic model interrupt/exception handling systems if executed on an SH4A
25109 system.  Additional support from the interrupt/exception handling code of the
25110 system is not required for this model.
25112 @item gbr-offset=
25113 This parameter specifies the offset in bytes of the variable in the thread
25114 control block structure that should be used by the generated atomic sequences
25115 when the @samp{soft-tcb} model has been selected.  For other models this
25116 parameter is ignored.  The specified value must be an integer multiple of four
25117 and in the range 0-1020.
25119 @item strict
25120 This parameter prevents mixed usage of multiple atomic models, even if they
25121 are compatible, and makes the compiler generate atomic sequences of the
25122 specified model only.
25124 @end table
25126 @item -mtas
25127 @opindex mtas
25128 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25129 Notice that depending on the particular hardware and software configuration
25130 this can degrade overall performance due to the operand cache line flushes
25131 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25132 processors the @code{tas.b} instruction must be used with caution since it
25133 can result in data corruption for certain cache configurations.
25135 @item -mprefergot
25136 @opindex mprefergot
25137 When generating position-independent code, emit function calls using
25138 the Global Offset Table instead of the Procedure Linkage Table.
25140 @item -musermode
25141 @itemx -mno-usermode
25142 @opindex musermode
25143 @opindex mno-usermode
25144 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25145 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25146 inlined code would not work in user mode.  @option{-musermode} is the default
25147 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25148 @option{-musermode} has no effect, since there is no user mode.
25150 @item -multcost=@var{number}
25151 @opindex multcost=@var{number}
25152 Set the cost to assume for a multiply insn.
25154 @item -mdiv=@var{strategy}
25155 @opindex mdiv=@var{strategy}
25156 Set the division strategy to be used for integer division operations.
25157 @var{strategy} can be one of: 
25159 @table @samp
25161 @item call-div1
25162 Calls a library function that uses the single-step division instruction
25163 @code{div1} to perform the operation.  Division by zero calculates an
25164 unspecified result and does not trap.  This is the default except for SH4,
25165 SH2A and SHcompact.
25167 @item call-fp
25168 Calls a library function that performs the operation in double precision
25169 floating point.  Division by zero causes a floating-point exception.  This is
25170 the default for SHcompact with FPU.  Specifying this for targets that do not
25171 have a double precision FPU defaults to @code{call-div1}.
25173 @item call-table
25174 Calls a library function that uses a lookup table for small divisors and
25175 the @code{div1} instruction with case distinction for larger divisors.  Division
25176 by zero calculates an unspecified result and does not trap.  This is the default
25177 for SH4.  Specifying this for targets that do not have dynamic shift
25178 instructions defaults to @code{call-div1}.
25180 @end table
25182 When a division strategy has not been specified the default strategy is
25183 selected based on the current target.  For SH2A the default strategy is to
25184 use the @code{divs} and @code{divu} instructions instead of library function
25185 calls.
25187 @item -maccumulate-outgoing-args
25188 @opindex maccumulate-outgoing-args
25189 Reserve space once for outgoing arguments in the function prologue rather
25190 than around each call.  Generally beneficial for performance and size.  Also
25191 needed for unwinding to avoid changing the stack frame around conditional code.
25193 @item -mdivsi3_libfunc=@var{name}
25194 @opindex mdivsi3_libfunc=@var{name}
25195 Set the name of the library function used for 32-bit signed division to
25196 @var{name}.
25197 This only affects the name used in the @samp{call} division strategies, and
25198 the compiler still expects the same sets of input/output/clobbered registers as
25199 if this option were not present.
25201 @item -mfixed-range=@var{register-range}
25202 @opindex mfixed-range
25203 Generate code treating the given register range as fixed registers.
25204 A fixed register is one that the register allocator can not use.  This is
25205 useful when compiling kernel code.  A register range is specified as
25206 two registers separated by a dash.  Multiple register ranges can be
25207 specified separated by a comma.
25209 @item -mbranch-cost=@var{num}
25210 @opindex mbranch-cost=@var{num}
25211 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25212 make the compiler try to generate more branch-free code if possible.  
25213 If not specified the value is selected depending on the processor type that
25214 is being compiled for.
25216 @item -mzdcbranch
25217 @itemx -mno-zdcbranch
25218 @opindex mzdcbranch
25219 @opindex mno-zdcbranch
25220 Assume (do not assume) that zero displacement conditional branch instructions
25221 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25222 compiler prefers zero displacement branch code sequences.  This is
25223 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25224 disabled by specifying @option{-mno-zdcbranch}.
25226 @item -mcbranch-force-delay-slot
25227 @opindex mcbranch-force-delay-slot
25228 Force the usage of delay slots for conditional branches, which stuffs the delay
25229 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25230 this option is disabled.  It can be enabled to work around hardware bugs as
25231 found in the original SH7055.
25233 @item -mfused-madd
25234 @itemx -mno-fused-madd
25235 @opindex mfused-madd
25236 @opindex mno-fused-madd
25237 Generate code that uses (does not use) the floating-point multiply and
25238 accumulate instructions.  These instructions are generated by default
25239 if hardware floating point is used.  The machine-dependent
25240 @option{-mfused-madd} option is now mapped to the machine-independent
25241 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25242 mapped to @option{-ffp-contract=off}.
25244 @item -mfsca
25245 @itemx -mno-fsca
25246 @opindex mfsca
25247 @opindex mno-fsca
25248 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25249 and cosine approximations.  The option @option{-mfsca} must be used in
25250 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25251 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25252 approximations even if @option{-funsafe-math-optimizations} is in effect.
25254 @item -mfsrra
25255 @itemx -mno-fsrra
25256 @opindex mfsrra
25257 @opindex mno-fsrra
25258 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25259 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25260 in combination with @option{-funsafe-math-optimizations} and
25261 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25262 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25263 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25264 in effect.
25266 @item -mpretend-cmove
25267 @opindex mpretend-cmove
25268 Prefer zero-displacement conditional branches for conditional move instruction
25269 patterns.  This can result in faster code on the SH4 processor.
25271 @item -mfdpic
25272 @opindex fdpic
25273 Generate code using the FDPIC ABI.
25275 @end table
25277 @node Solaris 2 Options
25278 @subsection Solaris 2 Options
25279 @cindex Solaris 2 options
25281 These @samp{-m} options are supported on Solaris 2:
25283 @table @gcctabopt
25284 @item -mclear-hwcap
25285 @opindex mclear-hwcap
25286 @option{-mclear-hwcap} tells the compiler to remove the hardware
25287 capabilities generated by the Solaris assembler.  This is only necessary
25288 when object files use ISA extensions not supported by the current
25289 machine, but check at runtime whether or not to use them.
25291 @item -mimpure-text
25292 @opindex mimpure-text
25293 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25294 the compiler to not pass @option{-z text} to the linker when linking a
25295 shared object.  Using this option, you can link position-dependent
25296 code into a shared object.
25298 @option{-mimpure-text} suppresses the ``relocations remain against
25299 allocatable but non-writable sections'' linker error message.
25300 However, the necessary relocations trigger copy-on-write, and the
25301 shared object is not actually shared across processes.  Instead of
25302 using @option{-mimpure-text}, you should compile all source code with
25303 @option{-fpic} or @option{-fPIC}.
25305 @end table
25307 These switches are supported in addition to the above on Solaris 2:
25309 @table @gcctabopt
25310 @item -pthreads
25311 @opindex pthreads
25312 This is a synonym for @option{-pthread}.
25313 @end table
25315 @node SPARC Options
25316 @subsection SPARC Options
25317 @cindex SPARC options
25319 These @samp{-m} options are supported on the SPARC:
25321 @table @gcctabopt
25322 @item -mno-app-regs
25323 @itemx -mapp-regs
25324 @opindex mno-app-regs
25325 @opindex mapp-regs
25326 Specify @option{-mapp-regs} to generate output using the global registers
25327 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25328 global register 1, each global register 2 through 4 is then treated as an
25329 allocable register that is clobbered by function calls.  This is the default.
25331 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25332 specify @option{-mno-app-regs}.  You should compile libraries and system
25333 software with this option.
25335 @item -mflat
25336 @itemx -mno-flat
25337 @opindex mflat
25338 @opindex mno-flat
25339 With @option{-mflat}, the compiler does not generate save/restore instructions
25340 and uses a ``flat'' or single register window model.  This model is compatible
25341 with the regular register window model.  The local registers and the input
25342 registers (0--5) are still treated as ``call-saved'' registers and are
25343 saved on the stack as needed.
25345 With @option{-mno-flat} (the default), the compiler generates save/restore
25346 instructions (except for leaf functions).  This is the normal operating mode.
25348 @item -mfpu
25349 @itemx -mhard-float
25350 @opindex mfpu
25351 @opindex mhard-float
25352 Generate output containing floating-point instructions.  This is the
25353 default.
25355 @item -mno-fpu
25356 @itemx -msoft-float
25357 @opindex mno-fpu
25358 @opindex msoft-float
25359 Generate output containing library calls for floating point.
25360 @strong{Warning:} the requisite libraries are not available for all SPARC
25361 targets.  Normally the facilities of the machine's usual C compiler are
25362 used, but this cannot be done directly in cross-compilation.  You must make
25363 your own arrangements to provide suitable library functions for
25364 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25365 @samp{sparclite-*-*} do provide software floating-point support.
25367 @option{-msoft-float} changes the calling convention in the output file;
25368 therefore, it is only useful if you compile @emph{all} of a program with
25369 this option.  In particular, you need to compile @file{libgcc.a}, the
25370 library that comes with GCC, with @option{-msoft-float} in order for
25371 this to work.
25373 @item -mhard-quad-float
25374 @opindex mhard-quad-float
25375 Generate output containing quad-word (long double) floating-point
25376 instructions.
25378 @item -msoft-quad-float
25379 @opindex msoft-quad-float
25380 Generate output containing library calls for quad-word (long double)
25381 floating-point instructions.  The functions called are those specified
25382 in the SPARC ABI@.  This is the default.
25384 As of this writing, there are no SPARC implementations that have hardware
25385 support for the quad-word floating-point instructions.  They all invoke
25386 a trap handler for one of these instructions, and then the trap handler
25387 emulates the effect of the instruction.  Because of the trap handler overhead,
25388 this is much slower than calling the ABI library routines.  Thus the
25389 @option{-msoft-quad-float} option is the default.
25391 @item -mno-unaligned-doubles
25392 @itemx -munaligned-doubles
25393 @opindex mno-unaligned-doubles
25394 @opindex munaligned-doubles
25395 Assume that doubles have 8-byte alignment.  This is the default.
25397 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25398 alignment only if they are contained in another type, or if they have an
25399 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25400 Specifying this option avoids some rare compatibility problems with code
25401 generated by other compilers.  It is not the default because it results
25402 in a performance loss, especially for floating-point code.
25404 @item -muser-mode
25405 @itemx -mno-user-mode
25406 @opindex muser-mode
25407 @opindex mno-user-mode
25408 Do not generate code that can only run in supervisor mode.  This is relevant
25409 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25410 is the default.
25412 @item -mfaster-structs
25413 @itemx -mno-faster-structs
25414 @opindex mfaster-structs
25415 @opindex mno-faster-structs
25416 With @option{-mfaster-structs}, the compiler assumes that structures
25417 should have 8-byte alignment.  This enables the use of pairs of
25418 @code{ldd} and @code{std} instructions for copies in structure
25419 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25420 However, the use of this changed alignment directly violates the SPARC
25421 ABI@.  Thus, it's intended only for use on targets where the developer
25422 acknowledges that their resulting code is not directly in line with
25423 the rules of the ABI@.
25425 @item -mstd-struct-return
25426 @itemx -mno-std-struct-return
25427 @opindex mstd-struct-return
25428 @opindex mno-std-struct-return
25429 With @option{-mstd-struct-return}, the compiler generates checking code
25430 in functions returning structures or unions to detect size mismatches
25431 between the two sides of function calls, as per the 32-bit ABI@.
25433 The default is @option{-mno-std-struct-return}.  This option has no effect
25434 in 64-bit mode.
25436 @item -mlra
25437 @itemx -mno-lra
25438 @opindex mlra
25439 @opindex mno-lra
25440 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25441 so @option{-mno-lra} needs to be passed to get old Reload.
25443 @item -mcpu=@var{cpu_type}
25444 @opindex mcpu
25445 Set the instruction set, register set, and instruction scheduling parameters
25446 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25447 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25448 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25449 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25450 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25451 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25453 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25454 which selects the best architecture option for the host processor.
25455 @option{-mcpu=native} has no effect if GCC does not recognize
25456 the processor.
25458 Default instruction scheduling parameters are used for values that select
25459 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25460 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25462 Here is a list of each supported architecture and their supported
25463 implementations.
25465 @table @asis
25466 @item v7
25467 cypress, leon3v7
25469 @item v8
25470 supersparc, hypersparc, leon, leon3
25472 @item sparclite
25473 f930, f934, sparclite86x
25475 @item sparclet
25476 tsc701
25478 @item v9
25479 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25480 niagara7, m8
25481 @end table
25483 By default (unless configured otherwise), GCC generates code for the V7
25484 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25485 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25486 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25487 SPARCStation 1, 2, IPX etc.
25489 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25490 architecture.  The only difference from V7 code is that the compiler emits
25491 the integer multiply and integer divide instructions which exist in SPARC-V8
25492 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25493 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25494 2000 series.
25496 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25497 the SPARC architecture.  This adds the integer multiply, integer divide step
25498 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25499 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25500 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25501 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25502 MB86934 chip, which is the more recent SPARClite with FPU@.
25504 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25505 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25506 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25507 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25508 optimizes it for the TEMIC SPARClet chip.
25510 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25511 architecture.  This adds 64-bit integer and floating-point move instructions,
25512 3 additional floating-point condition code registers and conditional move
25513 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25514 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25515 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25516 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25517 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25518 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25519 additionally optimizes it for Sun UltraSPARC T2 chips. With
25520 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25521 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25522 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25523 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25524 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25525 additionally optimizes it for Oracle M8 chips.
25527 @item -mtune=@var{cpu_type}
25528 @opindex mtune
25529 Set the instruction scheduling parameters for machine type
25530 @var{cpu_type}, but do not set the instruction set or register set that the
25531 option @option{-mcpu=@var{cpu_type}} does.
25533 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25534 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25535 that select a particular CPU implementation.  Those are
25536 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25537 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25538 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25539 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25540 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25541 and GNU/Linux toolchains, @samp{native} can also be used.
25543 @item -mv8plus
25544 @itemx -mno-v8plus
25545 @opindex mv8plus
25546 @opindex mno-v8plus
25547 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25548 difference from the V8 ABI is that the global and out registers are
25549 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25550 mode for all SPARC-V9 processors.
25552 @item -mvis
25553 @itemx -mno-vis
25554 @opindex mvis
25555 @opindex mno-vis
25556 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25557 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25559 @item -mvis2
25560 @itemx -mno-vis2
25561 @opindex mvis2
25562 @opindex mno-vis2
25563 With @option{-mvis2}, GCC generates code that takes advantage of
25564 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25565 default is @option{-mvis2} when targeting a cpu that supports such
25566 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25567 also sets @option{-mvis}.
25569 @item -mvis3
25570 @itemx -mno-vis3
25571 @opindex mvis3
25572 @opindex mno-vis3
25573 With @option{-mvis3}, GCC generates code that takes advantage of
25574 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25575 default is @option{-mvis3} when targeting a cpu that supports such
25576 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25577 also sets @option{-mvis2} and @option{-mvis}.
25579 @item -mvis4
25580 @itemx -mno-vis4
25581 @opindex mvis4
25582 @opindex mno-vis4
25583 With @option{-mvis4}, GCC generates code that takes advantage of
25584 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25585 default is @option{-mvis4} when targeting a cpu that supports such
25586 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25587 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25589 @item -mvis4b
25590 @itemx -mno-vis4b
25591 @opindex mvis4b
25592 @opindex mno-vis4b
25593 With @option{-mvis4b}, GCC generates code that takes advantage of
25594 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25595 the additional VIS instructions introduced in the Oracle SPARC
25596 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25597 cpu that supports such instructions, such as m8 and later.  Setting
25598 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25599 @option{-mvis2} and @option{-mvis}.
25601 @item -mcbcond
25602 @itemx -mno-cbcond
25603 @opindex mcbcond
25604 @opindex mno-cbcond
25605 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25606 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25607 when targeting a CPU that supports such instructions, such as Niagara-4 and
25608 later.
25610 @item -mfmaf
25611 @itemx -mno-fmaf
25612 @opindex mfmaf
25613 @opindex mno-fmaf
25614 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25615 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25616 when targeting a CPU that supports such instructions, such as Niagara-3 and
25617 later.
25619 @item -mfsmuld
25620 @itemx -mno-fsmuld
25621 @opindex mfsmuld
25622 @opindex mno-fsmuld
25623 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25624 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25625 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25626 or V9 with FPU except @option{-mcpu=leon}.
25628 @item -mpopc
25629 @itemx -mno-popc
25630 @opindex mpopc
25631 @opindex mno-popc
25632 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25633 Population Count instruction.  The default is @option{-mpopc}
25634 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25635 later.
25637 @item -msubxc
25638 @itemx -mno-subxc
25639 @opindex msubxc
25640 @opindex mno-subxc
25641 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25642 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25643 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25644 later.
25646 @item -mfix-at697f
25647 @opindex mfix-at697f
25648 Enable the documented workaround for the single erratum of the Atmel AT697F
25649 processor (which corresponds to erratum #13 of the AT697E processor).
25651 @item -mfix-ut699
25652 @opindex mfix-ut699
25653 Enable the documented workarounds for the floating-point errata and the data
25654 cache nullify errata of the UT699 processor.
25656 @item -mfix-ut700
25657 @opindex mfix-ut700
25658 Enable the documented workaround for the back-to-back store errata of
25659 the UT699E/UT700 processor.
25661 @item -mfix-gr712rc
25662 @opindex mfix-gr712rc
25663 Enable the documented workaround for the back-to-back store errata of
25664 the GR712RC processor.
25665 @end table
25667 These @samp{-m} options are supported in addition to the above
25668 on SPARC-V9 processors in 64-bit environments:
25670 @table @gcctabopt
25671 @item -m32
25672 @itemx -m64
25673 @opindex m32
25674 @opindex m64
25675 Generate code for a 32-bit or 64-bit environment.
25676 The 32-bit environment sets int, long and pointer to 32 bits.
25677 The 64-bit environment sets int to 32 bits and long and pointer
25678 to 64 bits.
25680 @item -mcmodel=@var{which}
25681 @opindex mcmodel
25682 Set the code model to one of
25684 @table @samp
25685 @item medlow
25686 The Medium/Low code model: 64-bit addresses, programs
25687 must be linked in the low 32 bits of memory.  Programs can be statically
25688 or dynamically linked.
25690 @item medmid
25691 The Medium/Middle code model: 64-bit addresses, programs
25692 must be linked in the low 44 bits of memory, the text and data segments must
25693 be less than 2GB in size and the data segment must be located within 2GB of
25694 the text segment.
25696 @item medany
25697 The Medium/Anywhere code model: 64-bit addresses, programs
25698 may be linked anywhere in memory, the text and data segments must be less
25699 than 2GB in size and the data segment must be located within 2GB of the
25700 text segment.
25702 @item embmedany
25703 The Medium/Anywhere code model for embedded systems:
25704 64-bit addresses, the text and data segments must be less than 2GB in
25705 size, both starting anywhere in memory (determined at link time).  The
25706 global register %g4 points to the base of the data segment.  Programs
25707 are statically linked and PIC is not supported.
25708 @end table
25710 @item -mmemory-model=@var{mem-model}
25711 @opindex mmemory-model
25712 Set the memory model in force on the processor to one of
25714 @table @samp
25715 @item default
25716 The default memory model for the processor and operating system.
25718 @item rmo
25719 Relaxed Memory Order
25721 @item pso
25722 Partial Store Order
25724 @item tso
25725 Total Store Order
25727 @item sc
25728 Sequential Consistency
25729 @end table
25731 These memory models are formally defined in Appendix D of the SPARC-V9
25732 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25734 @item -mstack-bias
25735 @itemx -mno-stack-bias
25736 @opindex mstack-bias
25737 @opindex mno-stack-bias
25738 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25739 frame pointer if present, are offset by @minus{}2047 which must be added back
25740 when making stack frame references.  This is the default in 64-bit mode.
25741 Otherwise, assume no such offset is present.
25742 @end table
25744 @node SPU Options
25745 @subsection SPU Options
25746 @cindex SPU options
25748 These @samp{-m} options are supported on the SPU:
25750 @table @gcctabopt
25751 @item -mwarn-reloc
25752 @itemx -merror-reloc
25753 @opindex mwarn-reloc
25754 @opindex merror-reloc
25756 The loader for SPU does not handle dynamic relocations.  By default, GCC
25757 gives an error when it generates code that requires a dynamic
25758 relocation.  @option{-mno-error-reloc} disables the error,
25759 @option{-mwarn-reloc} generates a warning instead.
25761 @item -msafe-dma
25762 @itemx -munsafe-dma
25763 @opindex msafe-dma
25764 @opindex munsafe-dma
25766 Instructions that initiate or test completion of DMA must not be
25767 reordered with respect to loads and stores of the memory that is being
25768 accessed.
25769 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25770 memory accesses, but that can lead to inefficient code in places where the
25771 memory is known to not change.  Rather than mark the memory as volatile,
25772 you can use @option{-msafe-dma} to tell the compiler to treat
25773 the DMA instructions as potentially affecting all memory.  
25775 @item -mbranch-hints
25776 @opindex mbranch-hints
25778 By default, GCC generates a branch hint instruction to avoid
25779 pipeline stalls for always-taken or probably-taken branches.  A hint
25780 is not generated closer than 8 instructions away from its branch.
25781 There is little reason to disable them, except for debugging purposes,
25782 or to make an object a little bit smaller.
25784 @item -msmall-mem
25785 @itemx -mlarge-mem
25786 @opindex msmall-mem
25787 @opindex mlarge-mem
25789 By default, GCC generates code assuming that addresses are never larger
25790 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25791 a full 32-bit address.
25793 @item -mstdmain
25794 @opindex mstdmain
25796 By default, GCC links against startup code that assumes the SPU-style
25797 main function interface (which has an unconventional parameter list).
25798 With @option{-mstdmain}, GCC links your program against startup
25799 code that assumes a C99-style interface to @code{main}, including a
25800 local copy of @code{argv} strings.
25802 @item -mfixed-range=@var{register-range}
25803 @opindex mfixed-range
25804 Generate code treating the given register range as fixed registers.
25805 A fixed register is one that the register allocator cannot use.  This is
25806 useful when compiling kernel code.  A register range is specified as
25807 two registers separated by a dash.  Multiple register ranges can be
25808 specified separated by a comma.
25810 @item -mea32
25811 @itemx -mea64
25812 @opindex mea32
25813 @opindex mea64
25814 Compile code assuming that pointers to the PPU address space accessed
25815 via the @code{__ea} named address space qualifier are either 32 or 64
25816 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25817 all object code in an executable must be compiled with the same setting.
25819 @item -maddress-space-conversion
25820 @itemx -mno-address-space-conversion
25821 @opindex maddress-space-conversion
25822 @opindex mno-address-space-conversion
25823 Allow/disallow treating the @code{__ea} address space as superset
25824 of the generic address space.  This enables explicit type casts
25825 between @code{__ea} and generic pointer as well as implicit
25826 conversions of generic pointers to @code{__ea} pointers.  The
25827 default is to allow address space pointer conversions.
25829 @item -mcache-size=@var{cache-size}
25830 @opindex mcache-size
25831 This option controls the version of libgcc that the compiler links to an
25832 executable and selects a software-managed cache for accessing variables
25833 in the @code{__ea} address space with a particular cache size.  Possible
25834 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25835 and @samp{128}.  The default cache size is 64KB.
25837 @item -matomic-updates
25838 @itemx -mno-atomic-updates
25839 @opindex matomic-updates
25840 @opindex mno-atomic-updates
25841 This option controls the version of libgcc that the compiler links to an
25842 executable and selects whether atomic updates to the software-managed
25843 cache of PPU-side variables are used.  If you use atomic updates, changes
25844 to a PPU variable from SPU code using the @code{__ea} named address space
25845 qualifier do not interfere with changes to other PPU variables residing
25846 in the same cache line from PPU code.  If you do not use atomic updates,
25847 such interference may occur; however, writing back cache lines is
25848 more efficient.  The default behavior is to use atomic updates.
25850 @item -mdual-nops
25851 @itemx -mdual-nops=@var{n}
25852 @opindex mdual-nops
25853 By default, GCC inserts NOPs to increase dual issue when it expects
25854 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25855 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25856 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25858 @item -mhint-max-nops=@var{n}
25859 @opindex mhint-max-nops
25860 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25861 be at least 8 instructions away from the branch it is affecting.  GCC
25862 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25863 generate the branch hint.
25865 @item -mhint-max-distance=@var{n}
25866 @opindex mhint-max-distance
25867 The encoding of the branch hint instruction limits the hint to be within
25868 256 instructions of the branch it is affecting.  By default, GCC makes
25869 sure it is within 125.
25871 @item -msafe-hints
25872 @opindex msafe-hints
25873 Work around a hardware bug that causes the SPU to stall indefinitely.
25874 By default, GCC inserts the @code{hbrp} instruction to make sure
25875 this stall won't happen.
25877 @end table
25879 @node System V Options
25880 @subsection Options for System V
25882 These additional options are available on System V Release 4 for
25883 compatibility with other compilers on those systems:
25885 @table @gcctabopt
25886 @item -G
25887 @opindex G
25888 Create a shared object.
25889 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25891 @item -Qy
25892 @opindex Qy
25893 Identify the versions of each tool used by the compiler, in a
25894 @code{.ident} assembler directive in the output.
25896 @item -Qn
25897 @opindex Qn
25898 Refrain from adding @code{.ident} directives to the output file (this is
25899 the default).
25901 @item -YP,@var{dirs}
25902 @opindex YP
25903 Search the directories @var{dirs}, and no others, for libraries
25904 specified with @option{-l}.
25906 @item -Ym,@var{dir}
25907 @opindex Ym
25908 Look in the directory @var{dir} to find the M4 preprocessor.
25909 The assembler uses this option.
25910 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25911 @c the generic assembler that comes with Solaris takes just -Ym.
25912 @end table
25914 @node TILE-Gx Options
25915 @subsection TILE-Gx Options
25916 @cindex TILE-Gx options
25918 These @samp{-m} options are supported on the TILE-Gx:
25920 @table @gcctabopt
25921 @item -mcmodel=small
25922 @opindex mcmodel=small
25923 Generate code for the small model.  The distance for direct calls is
25924 limited to 500M in either direction.  PC-relative addresses are 32
25925 bits.  Absolute addresses support the full address range.
25927 @item -mcmodel=large
25928 @opindex mcmodel=large
25929 Generate code for the large model.  There is no limitation on call
25930 distance, pc-relative addresses, or absolute addresses.
25932 @item -mcpu=@var{name}
25933 @opindex mcpu
25934 Selects the type of CPU to be targeted.  Currently the only supported
25935 type is @samp{tilegx}.
25937 @item -m32
25938 @itemx -m64
25939 @opindex m32
25940 @opindex m64
25941 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25942 environment sets int, long, and pointer to 32 bits.  The 64-bit
25943 environment sets int to 32 bits and long and pointer to 64 bits.
25945 @item -mbig-endian
25946 @itemx -mlittle-endian
25947 @opindex mbig-endian
25948 @opindex mlittle-endian
25949 Generate code in big/little endian mode, respectively.
25950 @end table
25952 @node TILEPro Options
25953 @subsection TILEPro Options
25954 @cindex TILEPro options
25956 These @samp{-m} options are supported on the TILEPro:
25958 @table @gcctabopt
25959 @item -mcpu=@var{name}
25960 @opindex mcpu
25961 Selects the type of CPU to be targeted.  Currently the only supported
25962 type is @samp{tilepro}.
25964 @item -m32
25965 @opindex m32
25966 Generate code for a 32-bit environment, which sets int, long, and
25967 pointer to 32 bits.  This is the only supported behavior so the flag
25968 is essentially ignored.
25969 @end table
25971 @node V850 Options
25972 @subsection V850 Options
25973 @cindex V850 Options
25975 These @samp{-m} options are defined for V850 implementations:
25977 @table @gcctabopt
25978 @item -mlong-calls
25979 @itemx -mno-long-calls
25980 @opindex mlong-calls
25981 @opindex mno-long-calls
25982 Treat all calls as being far away (near).  If calls are assumed to be
25983 far away, the compiler always loads the function's address into a
25984 register, and calls indirect through the pointer.
25986 @item -mno-ep
25987 @itemx -mep
25988 @opindex mno-ep
25989 @opindex mep
25990 Do not optimize (do optimize) basic blocks that use the same index
25991 pointer 4 or more times to copy pointer into the @code{ep} register, and
25992 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
25993 option is on by default if you optimize.
25995 @item -mno-prolog-function
25996 @itemx -mprolog-function
25997 @opindex mno-prolog-function
25998 @opindex mprolog-function
25999 Do not use (do use) external functions to save and restore registers
26000 at the prologue and epilogue of a function.  The external functions
26001 are slower, but use less code space if more than one function saves
26002 the same number of registers.  The @option{-mprolog-function} option
26003 is on by default if you optimize.
26005 @item -mspace
26006 @opindex mspace
26007 Try to make the code as small as possible.  At present, this just turns
26008 on the @option{-mep} and @option{-mprolog-function} options.
26010 @item -mtda=@var{n}
26011 @opindex mtda
26012 Put static or global variables whose size is @var{n} bytes or less into
26013 the tiny data area that register @code{ep} points to.  The tiny data
26014 area can hold up to 256 bytes in total (128 bytes for byte references).
26016 @item -msda=@var{n}
26017 @opindex msda
26018 Put static or global variables whose size is @var{n} bytes or less into
26019 the small data area that register @code{gp} points to.  The small data
26020 area can hold up to 64 kilobytes.
26022 @item -mzda=@var{n}
26023 @opindex mzda
26024 Put static or global variables whose size is @var{n} bytes or less into
26025 the first 32 kilobytes of memory.
26027 @item -mv850
26028 @opindex mv850
26029 Specify that the target processor is the V850.
26031 @item -mv850e3v5
26032 @opindex mv850e3v5
26033 Specify that the target processor is the V850E3V5.  The preprocessor
26034 constant @code{__v850e3v5__} is defined if this option is used.
26036 @item -mv850e2v4
26037 @opindex mv850e2v4
26038 Specify that the target processor is the V850E3V5.  This is an alias for
26039 the @option{-mv850e3v5} option.
26041 @item -mv850e2v3
26042 @opindex mv850e2v3
26043 Specify that the target processor is the V850E2V3.  The preprocessor
26044 constant @code{__v850e2v3__} is defined if this option is used.
26046 @item -mv850e2
26047 @opindex mv850e2
26048 Specify that the target processor is the V850E2.  The preprocessor
26049 constant @code{__v850e2__} is defined if this option is used.
26051 @item -mv850e1
26052 @opindex mv850e1
26053 Specify that the target processor is the V850E1.  The preprocessor
26054 constants @code{__v850e1__} and @code{__v850e__} are defined if
26055 this option is used.
26057 @item -mv850es
26058 @opindex mv850es
26059 Specify that the target processor is the V850ES.  This is an alias for
26060 the @option{-mv850e1} option.
26062 @item -mv850e
26063 @opindex mv850e
26064 Specify that the target processor is the V850E@.  The preprocessor
26065 constant @code{__v850e__} is defined if this option is used.
26067 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26068 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26069 are defined then a default target processor is chosen and the
26070 relevant @samp{__v850*__} preprocessor constant is defined.
26072 The preprocessor constants @code{__v850} and @code{__v851__} are always
26073 defined, regardless of which processor variant is the target.
26075 @item -mdisable-callt
26076 @itemx -mno-disable-callt
26077 @opindex mdisable-callt
26078 @opindex mno-disable-callt
26079 This option suppresses generation of the @code{CALLT} instruction for the
26080 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26081 architecture.
26083 This option is enabled by default when the RH850 ABI is
26084 in use (see @option{-mrh850-abi}), and disabled by default when the
26085 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26086 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26088 @item -mrelax
26089 @itemx -mno-relax
26090 @opindex mrelax
26091 @opindex mno-relax
26092 Pass on (or do not pass on) the @option{-mrelax} command-line option
26093 to the assembler.
26095 @item -mlong-jumps
26096 @itemx -mno-long-jumps
26097 @opindex mlong-jumps
26098 @opindex mno-long-jumps
26099 Disable (or re-enable) the generation of PC-relative jump instructions.
26101 @item -msoft-float
26102 @itemx -mhard-float
26103 @opindex msoft-float
26104 @opindex mhard-float
26105 Disable (or re-enable) the generation of hardware floating point
26106 instructions.  This option is only significant when the target
26107 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26108 instructions are being generated then the C preprocessor symbol
26109 @code{__FPU_OK__} is defined, otherwise the symbol
26110 @code{__NO_FPU__} is defined.
26112 @item -mloop
26113 @opindex mloop
26114 Enables the use of the e3v5 LOOP instruction.  The use of this
26115 instruction is not enabled by default when the e3v5 architecture is
26116 selected because its use is still experimental.
26118 @item -mrh850-abi
26119 @itemx -mghs
26120 @opindex mrh850-abi
26121 @opindex mghs
26122 Enables support for the RH850 version of the V850 ABI.  This is the
26123 default.  With this version of the ABI the following rules apply:
26125 @itemize
26126 @item
26127 Integer sized structures and unions are returned via a memory pointer
26128 rather than a register.
26130 @item
26131 Large structures and unions (more than 8 bytes in size) are passed by
26132 value.
26134 @item
26135 Functions are aligned to 16-bit boundaries.
26137 @item
26138 The @option{-m8byte-align} command-line option is supported.
26140 @item
26141 The @option{-mdisable-callt} command-line option is enabled by
26142 default.  The @option{-mno-disable-callt} command-line option is not
26143 supported.
26144 @end itemize
26146 When this version of the ABI is enabled the C preprocessor symbol
26147 @code{__V850_RH850_ABI__} is defined.
26149 @item -mgcc-abi
26150 @opindex mgcc-abi
26151 Enables support for the old GCC version of the V850 ABI.  With this
26152 version of the ABI the following rules apply:
26154 @itemize
26155 @item
26156 Integer sized structures and unions are returned in register @code{r10}.
26158 @item
26159 Large structures and unions (more than 8 bytes in size) are passed by
26160 reference.
26162 @item
26163 Functions are aligned to 32-bit boundaries, unless optimizing for
26164 size.
26166 @item
26167 The @option{-m8byte-align} command-line option is not supported.
26169 @item
26170 The @option{-mdisable-callt} command-line option is supported but not
26171 enabled by default.
26172 @end itemize
26174 When this version of the ABI is enabled the C preprocessor symbol
26175 @code{__V850_GCC_ABI__} is defined.
26177 @item -m8byte-align
26178 @itemx -mno-8byte-align
26179 @opindex m8byte-align
26180 @opindex mno-8byte-align
26181 Enables support for @code{double} and @code{long long} types to be
26182 aligned on 8-byte boundaries.  The default is to restrict the
26183 alignment of all objects to at most 4-bytes.  When
26184 @option{-m8byte-align} is in effect the C preprocessor symbol
26185 @code{__V850_8BYTE_ALIGN__} is defined.
26187 @item -mbig-switch
26188 @opindex mbig-switch
26189 Generate code suitable for big switch tables.  Use this option only if
26190 the assembler/linker complain about out of range branches within a switch
26191 table.
26193 @item -mapp-regs
26194 @opindex mapp-regs
26195 This option causes r2 and r5 to be used in the code generated by
26196 the compiler.  This setting is the default.
26198 @item -mno-app-regs
26199 @opindex mno-app-regs
26200 This option causes r2 and r5 to be treated as fixed registers.
26202 @end table
26204 @node VAX Options
26205 @subsection VAX Options
26206 @cindex VAX options
26208 These @samp{-m} options are defined for the VAX:
26210 @table @gcctabopt
26211 @item -munix
26212 @opindex munix
26213 Do not output certain jump instructions (@code{aobleq} and so on)
26214 that the Unix assembler for the VAX cannot handle across long
26215 ranges.
26217 @item -mgnu
26218 @opindex mgnu
26219 Do output those jump instructions, on the assumption that the
26220 GNU assembler is being used.
26222 @item -mg
26223 @opindex mg
26224 Output code for G-format floating-point numbers instead of D-format.
26225 @end table
26227 @node Visium Options
26228 @subsection Visium Options
26229 @cindex Visium options
26231 @table @gcctabopt
26233 @item -mdebug
26234 @opindex mdebug
26235 A program which performs file I/O and is destined to run on an MCM target
26236 should be linked with this option.  It causes the libraries libc.a and
26237 libdebug.a to be linked.  The program should be run on the target under
26238 the control of the GDB remote debugging stub.
26240 @item -msim
26241 @opindex msim
26242 A program which performs file I/O and is destined to run on the simulator
26243 should be linked with option.  This causes libraries libc.a and libsim.a to
26244 be linked.
26246 @item -mfpu
26247 @itemx -mhard-float
26248 @opindex mfpu
26249 @opindex mhard-float
26250 Generate code containing floating-point instructions.  This is the
26251 default.
26253 @item -mno-fpu
26254 @itemx -msoft-float
26255 @opindex mno-fpu
26256 @opindex msoft-float
26257 Generate code containing library calls for floating-point.
26259 @option{-msoft-float} changes the calling convention in the output file;
26260 therefore, it is only useful if you compile @emph{all} of a program with
26261 this option.  In particular, you need to compile @file{libgcc.a}, the
26262 library that comes with GCC, with @option{-msoft-float} in order for
26263 this to work.
26265 @item -mcpu=@var{cpu_type}
26266 @opindex mcpu
26267 Set the instruction set, register set, and instruction scheduling parameters
26268 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26269 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26271 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26273 By default (unless configured otherwise), GCC generates code for the GR5
26274 variant of the Visium architecture.  
26276 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26277 architecture.  The only difference from GR5 code is that the compiler will
26278 generate block move instructions.
26280 @item -mtune=@var{cpu_type}
26281 @opindex mtune
26282 Set the instruction scheduling parameters for machine type @var{cpu_type},
26283 but do not set the instruction set or register set that the option
26284 @option{-mcpu=@var{cpu_type}} would.
26286 @item -msv-mode
26287 @opindex msv-mode
26288 Generate code for the supervisor mode, where there are no restrictions on
26289 the access to general registers.  This is the default.
26291 @item -muser-mode
26292 @opindex muser-mode
26293 Generate code for the user mode, where the access to some general registers
26294 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26295 mode; on the GR6, only registers r29 to r31 are affected.
26296 @end table
26298 @node VMS Options
26299 @subsection VMS Options
26301 These @samp{-m} options are defined for the VMS implementations:
26303 @table @gcctabopt
26304 @item -mvms-return-codes
26305 @opindex mvms-return-codes
26306 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26307 condition (e.g.@ error) codes.
26309 @item -mdebug-main=@var{prefix}
26310 @opindex mdebug-main=@var{prefix}
26311 Flag the first routine whose name starts with @var{prefix} as the main
26312 routine for the debugger.
26314 @item -mmalloc64
26315 @opindex mmalloc64
26316 Default to 64-bit memory allocation routines.
26318 @item -mpointer-size=@var{size}
26319 @opindex mpointer-size=@var{size}
26320 Set the default size of pointers. Possible options for @var{size} are
26321 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26322 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26323 The later option disables @code{pragma pointer_size}.
26324 @end table
26326 @node VxWorks Options
26327 @subsection VxWorks Options
26328 @cindex VxWorks Options
26330 The options in this section are defined for all VxWorks targets.
26331 Options specific to the target hardware are listed with the other
26332 options for that target.
26334 @table @gcctabopt
26335 @item -mrtp
26336 @opindex mrtp
26337 GCC can generate code for both VxWorks kernels and real time processes
26338 (RTPs).  This option switches from the former to the latter.  It also
26339 defines the preprocessor macro @code{__RTP__}.
26341 @item -non-static
26342 @opindex non-static
26343 Link an RTP executable against shared libraries rather than static
26344 libraries.  The options @option{-static} and @option{-shared} can
26345 also be used for RTPs (@pxref{Link Options}); @option{-static}
26346 is the default.
26348 @item -Bstatic
26349 @itemx -Bdynamic
26350 @opindex Bstatic
26351 @opindex Bdynamic
26352 These options are passed down to the linker.  They are defined for
26353 compatibility with Diab.
26355 @item -Xbind-lazy
26356 @opindex Xbind-lazy
26357 Enable lazy binding of function calls.  This option is equivalent to
26358 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26360 @item -Xbind-now
26361 @opindex Xbind-now
26362 Disable lazy binding of function calls.  This option is the default and
26363 is defined for compatibility with Diab.
26364 @end table
26366 @node x86 Options
26367 @subsection x86 Options
26368 @cindex x86 Options
26370 These @samp{-m} options are defined for the x86 family of computers.
26372 @table @gcctabopt
26374 @item -march=@var{cpu-type}
26375 @opindex march
26376 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26377 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26378 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26379 to generate code that may not run at all on processors other than the one
26380 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26381 @option{-mtune=@var{cpu-type}}.
26383 The choices for @var{cpu-type} are:
26385 @table @samp
26386 @item native
26387 This selects the CPU to generate code for at compilation time by determining
26388 the processor type of the compiling machine.  Using @option{-march=native}
26389 enables all instruction subsets supported by the local machine (hence
26390 the result might not run on different machines).  Using @option{-mtune=native}
26391 produces code optimized for the local machine under the constraints
26392 of the selected instruction set.  
26394 @item i386
26395 Original Intel i386 CPU@.
26397 @item i486
26398 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26400 @item i586
26401 @itemx pentium
26402 Intel Pentium CPU with no MMX support.
26404 @item lakemont
26405 Intel Lakemont MCU, based on Intel Pentium CPU.
26407 @item pentium-mmx
26408 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26410 @item pentiumpro
26411 Intel Pentium Pro CPU@.
26413 @item i686
26414 When used with @option{-march}, the Pentium Pro
26415 instruction set is used, so the code runs on all i686 family chips.
26416 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26418 @item pentium2
26419 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26420 support.
26422 @item pentium3
26423 @itemx pentium3m
26424 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26425 set support.
26427 @item pentium-m
26428 Intel Pentium M; low-power version of Intel Pentium III CPU
26429 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26431 @item pentium4
26432 @itemx pentium4m
26433 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26435 @item prescott
26436 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26437 set support.
26439 @item nocona
26440 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26441 SSE2 and SSE3 instruction set support.
26443 @item core2
26444 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26445 instruction set support.
26447 @item nehalem
26448 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26449 SSE4.1, SSE4.2 and POPCNT instruction set support.
26451 @item westmere
26452 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26453 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26455 @item sandybridge
26456 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26457 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26459 @item ivybridge
26460 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26461 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26462 instruction set support.
26464 @item haswell
26465 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26466 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26467 BMI, BMI2 and F16C instruction set support.
26469 @item broadwell
26470 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26471 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26472 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26474 @item skylake
26475 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26476 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26477 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26478 XSAVES instruction set support.
26480 @item bonnell
26481 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26482 instruction set support.
26484 @item silvermont
26485 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26486 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26488 @item knl
26489 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26490 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26491 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26492 AVX512CD instruction set support.
26494 @item knm
26495 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26496 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26497 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26498 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26500 @item skylake-avx512
26501 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26502 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26503 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26504 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26506 @item cannonlake
26507 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26508 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26509 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26510 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26511 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
26513 @item Icelake
26514 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26515 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26516 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26517 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26518 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26519 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26521 @item k6
26522 AMD K6 CPU with MMX instruction set support.
26524 @item k6-2
26525 @itemx k6-3
26526 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26528 @item athlon
26529 @itemx athlon-tbird
26530 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26531 support.
26533 @item athlon-4
26534 @itemx athlon-xp
26535 @itemx athlon-mp
26536 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26537 instruction set support.
26539 @item k8
26540 @itemx opteron
26541 @itemx athlon64
26542 @itemx athlon-fx
26543 Processors based on the AMD K8 core with x86-64 instruction set support,
26544 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26545 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26546 instruction set extensions.)
26548 @item k8-sse3
26549 @itemx opteron-sse3
26550 @itemx athlon64-sse3
26551 Improved versions of AMD K8 cores with SSE3 instruction set support.
26553 @item amdfam10
26554 @itemx barcelona
26555 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26556 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26557 instruction set extensions.)
26559 @item bdver1
26560 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26561 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26562 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26563 @item bdver2
26564 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26565 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26566 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26567 extensions.)
26568 @item bdver3
26569 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26570 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26571 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26572 64-bit instruction set extensions.
26573 @item bdver4
26574 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26575 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26576 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26577 SSE4.2, ABM and 64-bit instruction set extensions.
26579 @item znver1
26580 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26581 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26582 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26583 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26584 instruction set extensions.
26586 @item btver1
26587 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26588 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26589 instruction set extensions.)
26591 @item btver2
26592 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26593 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26594 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26596 @item winchip-c6
26597 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26598 set support.
26600 @item winchip2
26601 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26602 instruction set support.
26604 @item c3
26605 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26606 (No scheduling is implemented for this chip.)
26608 @item c3-2
26609 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26610 (No scheduling is implemented for this chip.)
26612 @item c7
26613 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26614 (No scheduling is implemented for this chip.)
26616 @item samuel-2
26617 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26618 (No scheduling is implemented for this chip.)
26620 @item nehemiah
26621 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26622 (No scheduling is implemented for this chip.)
26624 @item esther
26625 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26626 (No scheduling is implemented for this chip.)
26628 @item eden-x2
26629 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26630 (No scheduling is implemented for this chip.)
26632 @item eden-x4
26633 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26634 AVX and AVX2 instruction set support.
26635 (No scheduling is implemented for this chip.)
26637 @item nano
26638 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26639 instruction set support.
26640 (No scheduling is implemented for this chip.)
26642 @item nano-1000
26643 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26644 instruction set support.
26645 (No scheduling is implemented for this chip.)
26647 @item nano-2000
26648 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26649 instruction set support.
26650 (No scheduling is implemented for this chip.)
26652 @item nano-3000
26653 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26654 instruction set support.
26655 (No scheduling is implemented for this chip.)
26657 @item nano-x2
26658 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26659 instruction set support.
26660 (No scheduling is implemented for this chip.)
26662 @item nano-x4
26663 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26664 instruction set support.
26665 (No scheduling is implemented for this chip.)
26667 @item geode
26668 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26669 @end table
26671 @item -mtune=@var{cpu-type}
26672 @opindex mtune
26673 Tune to @var{cpu-type} everything applicable about the generated code, except
26674 for the ABI and the set of available instructions.  
26675 While picking a specific @var{cpu-type} schedules things appropriately
26676 for that particular chip, the compiler does not generate any code that
26677 cannot run on the default machine type unless you use a
26678 @option{-march=@var{cpu-type}} option.
26679 For example, if GCC is configured for i686-pc-linux-gnu
26680 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26681 but still runs on i686 machines.
26683 The choices for @var{cpu-type} are the same as for @option{-march}.
26684 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26686 @table @samp
26687 @item generic
26688 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26689 If you know the CPU on which your code will run, then you should use
26690 the corresponding @option{-mtune} or @option{-march} option instead of
26691 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26692 of your application will have, then you should use this option.
26694 As new processors are deployed in the marketplace, the behavior of this
26695 option will change.  Therefore, if you upgrade to a newer version of
26696 GCC, code generation controlled by this option will change to reflect
26697 the processors
26698 that are most common at the time that version of GCC is released.
26700 There is no @option{-march=generic} option because @option{-march}
26701 indicates the instruction set the compiler can use, and there is no
26702 generic instruction set applicable to all processors.  In contrast,
26703 @option{-mtune} indicates the processor (or, in this case, collection of
26704 processors) for which the code is optimized.
26706 @item intel
26707 Produce code optimized for the most current Intel processors, which are
26708 Haswell and Silvermont for this version of GCC.  If you know the CPU
26709 on which your code will run, then you should use the corresponding
26710 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26711 But, if you want your application performs better on both Haswell and
26712 Silvermont, then you should use this option.
26714 As new Intel processors are deployed in the marketplace, the behavior of
26715 this option will change.  Therefore, if you upgrade to a newer version of
26716 GCC, code generation controlled by this option will change to reflect
26717 the most current Intel processors at the time that version of GCC is
26718 released.
26720 There is no @option{-march=intel} option because @option{-march} indicates
26721 the instruction set the compiler can use, and there is no common
26722 instruction set applicable to all processors.  In contrast,
26723 @option{-mtune} indicates the processor (or, in this case, collection of
26724 processors) for which the code is optimized.
26725 @end table
26727 @item -mcpu=@var{cpu-type}
26728 @opindex mcpu
26729 A deprecated synonym for @option{-mtune}.
26731 @item -mfpmath=@var{unit}
26732 @opindex mfpmath
26733 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26734 for @var{unit} are:
26736 @table @samp
26737 @item 387
26738 Use the standard 387 floating-point coprocessor present on the majority of chips and
26739 emulated otherwise.  Code compiled with this option runs almost everywhere.
26740 The temporary results are computed in 80-bit precision instead of the precision
26741 specified by the type, resulting in slightly different results compared to most
26742 of other chips.  See @option{-ffloat-store} for more detailed description.
26744 This is the default choice for non-Darwin x86-32 targets.
26746 @item sse
26747 Use scalar floating-point instructions present in the SSE instruction set.
26748 This instruction set is supported by Pentium III and newer chips,
26749 and in the AMD line
26750 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26751 instruction set supports only single-precision arithmetic, thus the double and
26752 extended-precision arithmetic are still done using 387.  A later version, present
26753 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26754 arithmetic too.
26756 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26757 or @option{-msse2} switches to enable SSE extensions and make this option
26758 effective.  For the x86-64 compiler, these extensions are enabled by default.
26760 The resulting code should be considerably faster in the majority of cases and avoid
26761 the numerical instability problems of 387 code, but may break some existing
26762 code that expects temporaries to be 80 bits.
26764 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26765 and the default choice for x86-32 targets with the SSE2 instruction set
26766 when @option{-ffast-math} is enabled.
26768 @item sse,387
26769 @itemx sse+387
26770 @itemx both
26771 Attempt to utilize both instruction sets at once.  This effectively doubles the
26772 amount of available registers, and on chips with separate execution units for
26773 387 and SSE the execution resources too.  Use this option with care, as it is
26774 still experimental, because the GCC register allocator does not model separate
26775 functional units well, resulting in unstable performance.
26776 @end table
26778 @item -masm=@var{dialect}
26779 @opindex masm=@var{dialect}
26780 Output assembly instructions using selected @var{dialect}.  Also affects
26781 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26782 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26783 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26784 not support @samp{intel}.
26786 @item -mieee-fp
26787 @itemx -mno-ieee-fp
26788 @opindex mieee-fp
26789 @opindex mno-ieee-fp
26790 Control whether or not the compiler uses IEEE floating-point
26791 comparisons.  These correctly handle the case where the result of a
26792 comparison is unordered.
26794 @item -m80387
26795 @itemx -mhard-float
26796 @opindex 80387
26797 @opindex mhard-float
26798 Generate output containing 80387 instructions for floating point.
26800 @item -mno-80387
26801 @itemx -msoft-float
26802 @opindex no-80387
26803 @opindex msoft-float
26804 Generate output containing library calls for floating point.
26806 @strong{Warning:} the requisite libraries are not part of GCC@.
26807 Normally the facilities of the machine's usual C compiler are used, but
26808 this cannot be done directly in cross-compilation.  You must make your
26809 own arrangements to provide suitable library functions for
26810 cross-compilation.
26812 On machines where a function returns floating-point results in the 80387
26813 register stack, some floating-point opcodes may be emitted even if
26814 @option{-msoft-float} is used.
26816 @item -mno-fp-ret-in-387
26817 @opindex mno-fp-ret-in-387
26818 Do not use the FPU registers for return values of functions.
26820 The usual calling convention has functions return values of types
26821 @code{float} and @code{double} in an FPU register, even if there
26822 is no FPU@.  The idea is that the operating system should emulate
26823 an FPU@.
26825 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26826 in ordinary CPU registers instead.
26828 @item -mno-fancy-math-387
26829 @opindex mno-fancy-math-387
26830 Some 387 emulators do not support the @code{sin}, @code{cos} and
26831 @code{sqrt} instructions for the 387.  Specify this option to avoid
26832 generating those instructions.  This option is the default on
26833 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26834 indicates that the target CPU always has an FPU and so the
26835 instruction does not need emulation.  These
26836 instructions are not generated unless you also use the
26837 @option{-funsafe-math-optimizations} switch.
26839 @item -malign-double
26840 @itemx -mno-align-double
26841 @opindex malign-double
26842 @opindex mno-align-double
26843 Control whether GCC aligns @code{double}, @code{long double}, and
26844 @code{long long} variables on a two-word boundary or a one-word
26845 boundary.  Aligning @code{double} variables on a two-word boundary
26846 produces code that runs somewhat faster on a Pentium at the
26847 expense of more memory.
26849 On x86-64, @option{-malign-double} is enabled by default.
26851 @strong{Warning:} if you use the @option{-malign-double} switch,
26852 structures containing the above types are aligned differently than
26853 the published application binary interface specifications for the x86-32
26854 and are not binary compatible with structures in code compiled
26855 without that switch.
26857 @item -m96bit-long-double
26858 @itemx -m128bit-long-double
26859 @opindex m96bit-long-double
26860 @opindex m128bit-long-double
26861 These switches control the size of @code{long double} type.  The x86-32
26862 application binary interface specifies the size to be 96 bits,
26863 so @option{-m96bit-long-double} is the default in 32-bit mode.
26865 Modern architectures (Pentium and newer) prefer @code{long double}
26866 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26867 conforming to the ABI, this is not possible.  So specifying
26868 @option{-m128bit-long-double} aligns @code{long double}
26869 to a 16-byte boundary by padding the @code{long double} with an additional
26870 32-bit zero.
26872 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26873 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26875 Notice that neither of these options enable any extra precision over the x87
26876 standard of 80 bits for a @code{long double}.
26878 @strong{Warning:} if you override the default value for your target ABI, this
26879 changes the size of 
26880 structures and arrays containing @code{long double} variables,
26881 as well as modifying the function calling convention for functions taking
26882 @code{long double}.  Hence they are not binary-compatible
26883 with code compiled without that switch.
26885 @item -mlong-double-64
26886 @itemx -mlong-double-80
26887 @itemx -mlong-double-128
26888 @opindex mlong-double-64
26889 @opindex mlong-double-80
26890 @opindex mlong-double-128
26891 These switches control the size of @code{long double} type. A size
26892 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26893 type. This is the default for 32-bit Bionic C library.  A size
26894 of 128 bits makes the @code{long double} type equivalent to the
26895 @code{__float128} type. This is the default for 64-bit Bionic C library.
26897 @strong{Warning:} if you override the default value for your target ABI, this
26898 changes the size of
26899 structures and arrays containing @code{long double} variables,
26900 as well as modifying the function calling convention for functions taking
26901 @code{long double}.  Hence they are not binary-compatible
26902 with code compiled without that switch.
26904 @item -malign-data=@var{type}
26905 @opindex malign-data
26906 Control how GCC aligns variables.  Supported values for @var{type} are
26907 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26908 and earlier, @samp{abi} uses alignment value as specified by the
26909 psABI, and @samp{cacheline} uses increased alignment value to match
26910 the cache line size.  @samp{compat} is the default.
26912 @item -mlarge-data-threshold=@var{threshold}
26913 @opindex mlarge-data-threshold
26914 When @option{-mcmodel=medium} is specified, data objects larger than
26915 @var{threshold} are placed in the large data section.  This value must be the
26916 same across all objects linked into the binary, and defaults to 65535.
26918 @item -mrtd
26919 @opindex mrtd
26920 Use a different function-calling convention, in which functions that
26921 take a fixed number of arguments return with the @code{ret @var{num}}
26922 instruction, which pops their arguments while returning.  This saves one
26923 instruction in the caller since there is no need to pop the arguments
26924 there.
26926 You can specify that an individual function is called with this calling
26927 sequence with the function attribute @code{stdcall}.  You can also
26928 override the @option{-mrtd} option by using the function attribute
26929 @code{cdecl}.  @xref{Function Attributes}.
26931 @strong{Warning:} this calling convention is incompatible with the one
26932 normally used on Unix, so you cannot use it if you need to call
26933 libraries compiled with the Unix compiler.
26935 Also, you must provide function prototypes for all functions that
26936 take variable numbers of arguments (including @code{printf});
26937 otherwise incorrect code is generated for calls to those
26938 functions.
26940 In addition, seriously incorrect code results if you call a
26941 function with too many arguments.  (Normally, extra arguments are
26942 harmlessly ignored.)
26944 @item -mregparm=@var{num}
26945 @opindex mregparm
26946 Control how many registers are used to pass integer arguments.  By
26947 default, no registers are used to pass arguments, and at most 3
26948 registers can be used.  You can control this behavior for a specific
26949 function by using the function attribute @code{regparm}.
26950 @xref{Function Attributes}.
26952 @strong{Warning:} if you use this switch, and
26953 @var{num} is nonzero, then you must build all modules with the same
26954 value, including any libraries.  This includes the system libraries and
26955 startup modules.
26957 @item -msseregparm
26958 @opindex msseregparm
26959 Use SSE register passing conventions for float and double arguments
26960 and return values.  You can control this behavior for a specific
26961 function by using the function attribute @code{sseregparm}.
26962 @xref{Function Attributes}.
26964 @strong{Warning:} if you use this switch then you must build all
26965 modules with the same value, including any libraries.  This includes
26966 the system libraries and startup modules.
26968 @item -mvect8-ret-in-mem
26969 @opindex mvect8-ret-in-mem
26970 Return 8-byte vectors in memory instead of MMX registers.  This is the
26971 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
26972 Studio compilers until version 12.  Later compiler versions (starting
26973 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
26974 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
26975 you need to remain compatible with existing code produced by those
26976 previous compiler versions or older versions of GCC@.
26978 @item -mpc32
26979 @itemx -mpc64
26980 @itemx -mpc80
26981 @opindex mpc32
26982 @opindex mpc64
26983 @opindex mpc80
26985 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
26986 is specified, the significands of results of floating-point operations are
26987 rounded to 24 bits (single precision); @option{-mpc64} rounds the
26988 significands of results of floating-point operations to 53 bits (double
26989 precision) and @option{-mpc80} rounds the significands of results of
26990 floating-point operations to 64 bits (extended double precision), which is
26991 the default.  When this option is used, floating-point operations in higher
26992 precisions are not available to the programmer without setting the FPU
26993 control word explicitly.
26995 Setting the rounding of floating-point operations to less than the default
26996 80 bits can speed some programs by 2% or more.  Note that some mathematical
26997 libraries assume that extended-precision (80-bit) floating-point operations
26998 are enabled by default; routines in such libraries could suffer significant
26999 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27000 when this option is used to set the precision to less than extended precision.
27002 @item -mstackrealign
27003 @opindex mstackrealign
27004 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27005 option generates an alternate prologue and epilogue that realigns the
27006 run-time stack if necessary.  This supports mixing legacy codes that keep
27007 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27008 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27009 applicable to individual functions.
27011 @item -mpreferred-stack-boundary=@var{num}
27012 @opindex mpreferred-stack-boundary
27013 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27014 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27015 the default is 4 (16 bytes or 128 bits).
27017 @strong{Warning:} When generating code for the x86-64 architecture with
27018 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27019 used to keep the stack boundary aligned to 8 byte boundary.  Since
27020 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27021 intended to be used in controlled environment where stack space is
27022 important limitation.  This option leads to wrong code when functions
27023 compiled with 16 byte stack alignment (such as functions from a standard
27024 library) are called with misaligned stack.  In this case, SSE
27025 instructions may lead to misaligned memory access traps.  In addition,
27026 variable arguments are handled incorrectly for 16 byte aligned
27027 objects (including x87 long double and __int128), leading to wrong
27028 results.  You must build all modules with
27029 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27030 includes the system libraries and startup modules.
27032 @item -mincoming-stack-boundary=@var{num}
27033 @opindex mincoming-stack-boundary
27034 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27035 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27036 the one specified by @option{-mpreferred-stack-boundary} is used.
27038 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27039 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27040 suffer significant run time performance penalties.  On Pentium III, the
27041 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27042 properly if it is not 16-byte aligned.
27044 To ensure proper alignment of this values on the stack, the stack boundary
27045 must be as aligned as that required by any value stored on the stack.
27046 Further, every function must be generated such that it keeps the stack
27047 aligned.  Thus calling a function compiled with a higher preferred
27048 stack boundary from a function compiled with a lower preferred stack
27049 boundary most likely misaligns the stack.  It is recommended that
27050 libraries that use callbacks always use the default setting.
27052 This extra alignment does consume extra stack space, and generally
27053 increases code size.  Code that is sensitive to stack space usage, such
27054 as embedded systems and operating system kernels, may want to reduce the
27055 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27057 @need 200
27058 @item -mmmx
27059 @opindex mmmx
27060 @need 200
27061 @itemx -msse
27062 @opindex msse
27063 @need 200
27064 @itemx -msse2
27065 @opindex msse2
27066 @need 200
27067 @itemx -msse3
27068 @opindex msse3
27069 @need 200
27070 @itemx -mssse3
27071 @opindex mssse3
27072 @need 200
27073 @itemx -msse4
27074 @opindex msse4
27075 @need 200
27076 @itemx -msse4a
27077 @opindex msse4a
27078 @need 200
27079 @itemx -msse4.1
27080 @opindex msse4.1
27081 @need 200
27082 @itemx -msse4.2
27083 @opindex msse4.2
27084 @need 200
27085 @itemx -mavx
27086 @opindex mavx
27087 @need 200
27088 @itemx -mavx2
27089 @opindex mavx2
27090 @need 200
27091 @itemx -mavx512f
27092 @opindex mavx512f
27093 @need 200
27094 @itemx -mavx512pf
27095 @opindex mavx512pf
27096 @need 200
27097 @itemx -mavx512er
27098 @opindex mavx512er
27099 @need 200
27100 @itemx -mavx512cd
27101 @opindex mavx512cd
27102 @need 200
27103 @itemx -mavx512vl
27104 @opindex mavx512vl
27105 @need 200
27106 @itemx -mavx512bw
27107 @opindex mavx512bw
27108 @need 200
27109 @itemx -mavx512dq
27110 @opindex mavx512dq
27111 @need 200
27112 @itemx -mavx512ifma
27113 @opindex mavx512ifma
27114 @need 200
27115 @itemx -mavx512vbmi
27116 @opindex mavx512vbmi
27117 @need 200
27118 @itemx -msha
27119 @opindex msha
27120 @need 200
27121 @itemx -maes
27122 @opindex maes
27123 @need 200
27124 @itemx -mpclmul
27125 @opindex mpclmul
27126 @need 200
27127 @itemx -mclfushopt
27128 @opindex mclfushopt
27129 @need 200
27130 @itemx -mfsgsbase
27131 @opindex mfsgsbase
27132 @need 200
27133 @itemx -mrdrnd
27134 @opindex mrdrnd
27135 @need 200
27136 @itemx -mf16c
27137 @opindex mf16c
27138 @need 200
27139 @itemx -mfma
27140 @opindex mfma
27141 @need 200
27142 @itemx -mfma4
27143 @opindex mfma4
27144 @need 200
27145 @itemx -mprefetchwt1
27146 @opindex mprefetchwt1
27147 @need 200
27148 @itemx -mxop
27149 @opindex mxop
27150 @need 200
27151 @itemx -mlwp
27152 @opindex mlwp
27153 @need 200
27154 @itemx -m3dnow
27155 @opindex m3dnow
27156 @need 200
27157 @itemx -m3dnowa
27158 @opindex m3dnowa
27159 @need 200
27160 @itemx -mpopcnt
27161 @opindex mpopcnt
27162 @need 200
27163 @itemx -mabm
27164 @opindex mabm
27165 @need 200
27166 @itemx -mbmi
27167 @opindex mbmi
27168 @need 200
27169 @itemx -mbmi2
27170 @need 200
27171 @itemx -mlzcnt
27172 @opindex mlzcnt
27173 @need 200
27174 @itemx -mfxsr
27175 @opindex mfxsr
27176 @need 200
27177 @itemx -mxsave
27178 @opindex mxsave
27179 @need 200
27180 @itemx -mxsaveopt
27181 @opindex mxsaveopt
27182 @need 200
27183 @itemx -mxsavec
27184 @opindex mxsavec
27185 @need 200
27186 @itemx -mxsaves
27187 @opindex mxsaves
27188 @need 200
27189 @itemx -mrtm
27190 @opindex mrtm
27191 @need 200
27192 @itemx -mtbm
27193 @opindex mtbm
27194 @need 200
27195 @itemx -mmpx
27196 @opindex mmpx
27197 @need 200
27198 @itemx -mmwaitx
27199 @opindex mmwaitx
27200 @need 200
27201 @itemx -mclzero
27202 @opindex mclzero
27203 @need 200
27204 @itemx -mpku
27205 @opindex mpku
27206 @need 200
27207 @itemx -mcet
27208 @opindex mcet
27209 @need 200
27210 @itemx -mavx512vbmi2
27211 @opindex mavx512vbmi2
27212 @need 200
27213 @itemx -mgfni
27214 @opindex mgfni
27215 @need 200
27216 @itemx -mvaes
27217 @opindex mvaes
27218 @need 200
27219 @itemx -mvpclmulqdq
27220 @opindex mvpclmulqdq
27221 @need 200
27222 @itemx -mavx512bitalg
27223 @opindex mavx512bitalg
27224 @need 200
27225 @itemx -mavx512vpopcntdq
27226 @opindex mavx512vpopcntdq
27227 These switches enable the use of instructions in the MMX, SSE,
27228 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27229 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27230 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
27231 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27232 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
27233 extended instruction sets.
27234 Each has a corresponding @option{-mno-} option to disable use of these
27235 instructions.
27237 These extensions are also available as built-in functions: see
27238 @ref{x86 Built-in Functions}, for details of the functions enabled and
27239 disabled by these switches.
27241 To generate SSE/SSE2 instructions automatically from floating-point
27242 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27244 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27245 generates new AVX instructions or AVX equivalence for all SSEx instructions
27246 when needed.
27248 These options enable GCC to use these extended instructions in
27249 generated code, even without @option{-mfpmath=sse}.  Applications that
27250 perform run-time CPU detection must compile separate files for each
27251 supported architecture, using the appropriate flags.  In particular,
27252 the file containing the CPU detection code should be compiled without
27253 these options.
27255 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
27256 options.  The @option{-mibt} option enables indirect branch tracking support
27257 and the @option{-mshstk} option enables shadow stack support from
27258 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
27259 a number of built-in functions for fine-grained control in a CET-based
27260 application.  See @xref{x86 Built-in Functions}, for more information.
27262 @item -mdump-tune-features
27263 @opindex mdump-tune-features
27264 This option instructs GCC to dump the names of the x86 performance 
27265 tuning features and default settings. The names can be used in 
27266 @option{-mtune-ctrl=@var{feature-list}}.
27268 @item -mtune-ctrl=@var{feature-list}
27269 @opindex mtune-ctrl=@var{feature-list}
27270 This option is used to do fine grain control of x86 code generation features.
27271 @var{feature-list} is a comma separated list of @var{feature} names. See also
27272 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27273 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27274 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27275 developers. Using it may lead to code paths not covered by testing and can
27276 potentially result in compiler ICEs or runtime errors.
27278 @item -mno-default
27279 @opindex mno-default
27280 This option instructs GCC to turn off all tunable features. See also 
27281 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27283 @item -mcld
27284 @opindex mcld
27285 This option instructs GCC to emit a @code{cld} instruction in the prologue
27286 of functions that use string instructions.  String instructions depend on
27287 the DF flag to select between autoincrement or autodecrement mode.  While the
27288 ABI specifies the DF flag to be cleared on function entry, some operating
27289 systems violate this specification by not clearing the DF flag in their
27290 exception dispatchers.  The exception handler can be invoked with the DF flag
27291 set, which leads to wrong direction mode when string instructions are used.
27292 This option can be enabled by default on 32-bit x86 targets by configuring
27293 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27294 instructions can be suppressed with the @option{-mno-cld} compiler option
27295 in this case.
27297 @item -mvzeroupper
27298 @opindex mvzeroupper
27299 This option instructs GCC to emit a @code{vzeroupper} instruction
27300 before a transfer of control flow out of the function to minimize
27301 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27302 intrinsics.
27304 @item -mprefer-avx128
27305 @opindex mprefer-avx128
27306 This option instructs GCC to use 128-bit AVX instructions instead of
27307 256-bit AVX instructions in the auto-vectorizer.
27309 @item -mprefer-vector-width=@var{opt}
27310 @opindex mprefer-vector-width
27311 This option instructs GCC to use @var{opt}-bit vector width in instructions
27312 instead of default on the selected platform.
27314 @table @samp
27315 @item none
27316 No extra limitations applied to GCC other than defined by the selected platform.
27318 @item 128
27319 Prefer 128-bit vector width for instructions.
27321 @item 256
27322 Prefer 256-bit vector width for instructions.
27324 @item 512
27325 Prefer 512-bit vector width for instructions.
27326 @end table
27328 @item -mcx16
27329 @opindex mcx16
27330 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27331 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27332 objects.  This is useful for atomic updates of data structures exceeding one
27333 machine word in size.  The compiler uses this instruction to implement
27334 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27335 128-bit integers, a library call is always used.
27337 @item -msahf
27338 @opindex msahf
27339 This option enables generation of @code{SAHF} instructions in 64-bit code.
27340 Early Intel Pentium 4 CPUs with Intel 64 support,
27341 prior to the introduction of Pentium 4 G1 step in December 2005,
27342 lacked the @code{LAHF} and @code{SAHF} instructions
27343 which are supported by AMD64.
27344 These are load and store instructions, respectively, for certain status flags.
27345 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27346 @code{drem}, and @code{remainder} built-in functions;
27347 see @ref{Other Builtins} for details.
27349 @item -mmovbe
27350 @opindex mmovbe
27351 This option enables use of the @code{movbe} instruction to implement
27352 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27354 @item -mibt
27355 @opindex mibt
27356 This option tells the compiler to use indirect branch tracking support
27357 (for indirect calls and jumps) from x86 Control-flow Enforcement
27358 Technology (CET).  The option has effect only if the
27359 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
27360 is specified. The option @option{-mibt} is on by default when the
27361 @code{-mcet} option is specified.
27363 @item -mshstk
27364 @opindex mshstk
27365 This option tells the compiler to use shadow stack support (return
27366 address tracking) from x86 Control-flow Enforcement Technology (CET).
27367 The option has effect only if the @option{-fcf-protection=full} or
27368 @option{-fcf-protection=return} option is specified.  The option
27369 @option{-mshstk} is on by default when the @option{-mcet} option is
27370 specified.
27372 @item -mcrc32
27373 @opindex mcrc32
27374 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27375 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27376 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27378 @item -mrecip
27379 @opindex mrecip
27380 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27381 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27382 with an additional Newton-Raphson step
27383 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27384 (and their vectorized
27385 variants) for single-precision floating-point arguments.  These instructions
27386 are generated only when @option{-funsafe-math-optimizations} is enabled
27387 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27388 Note that while the throughput of the sequence is higher than the throughput
27389 of the non-reciprocal instruction, the precision of the sequence can be
27390 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27392 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27393 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27394 combination), and doesn't need @option{-mrecip}.
27396 Also note that GCC emits the above sequence with additional Newton-Raphson step
27397 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27398 already with @option{-ffast-math} (or the above option combination), and
27399 doesn't need @option{-mrecip}.
27401 @item -mrecip=@var{opt}
27402 @opindex mrecip=opt
27403 This option controls which reciprocal estimate instructions
27404 may be used.  @var{opt} is a comma-separated list of options, which may
27405 be preceded by a @samp{!} to invert the option:
27407 @table @samp
27408 @item all
27409 Enable all estimate instructions.
27411 @item default
27412 Enable the default instructions, equivalent to @option{-mrecip}.
27414 @item none
27415 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27417 @item div
27418 Enable the approximation for scalar division.
27420 @item vec-div
27421 Enable the approximation for vectorized division.
27423 @item sqrt
27424 Enable the approximation for scalar square root.
27426 @item vec-sqrt
27427 Enable the approximation for vectorized square root.
27428 @end table
27430 So, for example, @option{-mrecip=all,!sqrt} enables
27431 all of the reciprocal approximations, except for square root.
27433 @item -mveclibabi=@var{type}
27434 @opindex mveclibabi
27435 Specifies the ABI type to use for vectorizing intrinsics using an
27436 external library.  Supported values for @var{type} are @samp{svml} 
27437 for the Intel short
27438 vector math library and @samp{acml} for the AMD math core library.
27439 To use this option, both @option{-ftree-vectorize} and
27440 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27441 ABI-compatible library must be specified at link time.
27443 GCC currently emits calls to @code{vmldExp2},
27444 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27445 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27446 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27447 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27448 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27449 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27450 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27451 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27452 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27453 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27454 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27455 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27456 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27457 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27458 when @option{-mveclibabi=acml} is used.  
27460 @item -mabi=@var{name}
27461 @opindex mabi
27462 Generate code for the specified calling convention.  Permissible values
27463 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27464 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27465 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27466 You can control this behavior for specific functions by
27467 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27468 @xref{Function Attributes}.
27470 @item -mforce-indirect-call
27471 @opindex mforce-indirect-call
27472 Force all calls to functions to be indirect. This is useful
27473 when using Intel Processor Trace where it generates more precise timing
27474 information for function calls.
27476 @item -mcall-ms2sysv-xlogues
27477 @opindex mcall-ms2sysv-xlogues
27478 @opindex mno-call-ms2sysv-xlogues
27479 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27480 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27481 default, the code for saving and restoring these registers is emitted inline,
27482 resulting in fairly lengthy prologues and epilogues.  Using
27483 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27484 use stubs in the static portion of libgcc to perform these saves and restores,
27485 thus reducing function size at the cost of a few extra instructions.
27487 @item -mtls-dialect=@var{type}
27488 @opindex mtls-dialect
27489 Generate code to access thread-local storage using the @samp{gnu} or
27490 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27491 @samp{gnu2} is more efficient, but it may add compile- and run-time
27492 requirements that cannot be satisfied on all systems.
27494 @item -mpush-args
27495 @itemx -mno-push-args
27496 @opindex mpush-args
27497 @opindex mno-push-args
27498 Use PUSH operations to store outgoing parameters.  This method is shorter
27499 and usually equally fast as method using SUB/MOV operations and is enabled
27500 by default.  In some cases disabling it may improve performance because of
27501 improved scheduling and reduced dependencies.
27503 @item -maccumulate-outgoing-args
27504 @opindex maccumulate-outgoing-args
27505 If enabled, the maximum amount of space required for outgoing arguments is
27506 computed in the function prologue.  This is faster on most modern CPUs
27507 because of reduced dependencies, improved scheduling and reduced stack usage
27508 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27509 increase in code size.  This switch implies @option{-mno-push-args}.
27511 @item -mthreads
27512 @opindex mthreads
27513 Support thread-safe exception handling on MinGW.  Programs that rely
27514 on thread-safe exception handling must compile and link all code with the
27515 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27516 @option{-D_MT}; when linking, it links in a special thread helper library
27517 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27519 @item -mms-bitfields
27520 @itemx -mno-ms-bitfields
27521 @opindex mms-bitfields
27522 @opindex mno-ms-bitfields
27524 Enable/disable bit-field layout compatible with the native Microsoft
27525 Windows compiler.  
27527 If @code{packed} is used on a structure, or if bit-fields are used,
27528 it may be that the Microsoft ABI lays out the structure differently
27529 than the way GCC normally does.  Particularly when moving packed
27530 data between functions compiled with GCC and the native Microsoft compiler
27531 (either via function call or as data in a file), it may be necessary to access
27532 either format.
27534 This option is enabled by default for Microsoft Windows
27535 targets.  This behavior can also be controlled locally by use of variable
27536 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27537 and @ref{x86 Type Attributes}.
27539 The Microsoft structure layout algorithm is fairly simple with the exception
27540 of the bit-field packing.  
27541 The padding and alignment of members of structures and whether a bit-field 
27542 can straddle a storage-unit boundary are determine by these rules:
27544 @enumerate
27545 @item Structure members are stored sequentially in the order in which they are
27546 declared: the first member has the lowest memory address and the last member
27547 the highest.
27549 @item Every data object has an alignment requirement.  The alignment requirement
27550 for all data except structures, unions, and arrays is either the size of the
27551 object or the current packing size (specified with either the
27552 @code{aligned} attribute or the @code{pack} pragma),
27553 whichever is less.  For structures, unions, and arrays,
27554 the alignment requirement is the largest alignment requirement of its members.
27555 Every object is allocated an offset so that:
27557 @smallexample
27558 offset % alignment_requirement == 0
27559 @end smallexample
27561 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27562 unit if the integral types are the same size and if the next bit-field fits
27563 into the current allocation unit without crossing the boundary imposed by the
27564 common alignment requirements of the bit-fields.
27565 @end enumerate
27567 MSVC interprets zero-length bit-fields in the following ways:
27569 @enumerate
27570 @item If a zero-length bit-field is inserted between two bit-fields that
27571 are normally coalesced, the bit-fields are not coalesced.
27573 For example:
27575 @smallexample
27576 struct
27577  @{
27578    unsigned long bf_1 : 12;
27579    unsigned long : 0;
27580    unsigned long bf_2 : 12;
27581  @} t1;
27582 @end smallexample
27584 @noindent
27585 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27586 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27588 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27589 alignment of the zero-length bit-field is greater than the member that follows it,
27590 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27592 For example:
27594 @smallexample
27595 struct
27596  @{
27597    char foo : 4;
27598    short : 0;
27599    char bar;
27600  @} t2;
27602 struct
27603  @{
27604    char foo : 4;
27605    short : 0;
27606    double bar;
27607  @} t3;
27608 @end smallexample
27610 @noindent
27611 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27612 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27613 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27614 of the structure.
27616 Taking this into account, it is important to note the following:
27618 @enumerate
27619 @item If a zero-length bit-field follows a normal bit-field, the type of the
27620 zero-length bit-field may affect the alignment of the structure as whole. For
27621 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27622 normal bit-field, and is of type short.
27624 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27625 still affect the alignment of the structure:
27627 @smallexample
27628 struct
27629  @{
27630    char foo : 6;
27631    long : 0;
27632  @} t4;
27633 @end smallexample
27635 @noindent
27636 Here, @code{t4} takes up 4 bytes.
27637 @end enumerate
27639 @item Zero-length bit-fields following non-bit-field members are ignored:
27641 @smallexample
27642 struct
27643  @{
27644    char foo;
27645    long : 0;
27646    char bar;
27647  @} t5;
27648 @end smallexample
27650 @noindent
27651 Here, @code{t5} takes up 2 bytes.
27652 @end enumerate
27655 @item -mno-align-stringops
27656 @opindex mno-align-stringops
27657 Do not align the destination of inlined string operations.  This switch reduces
27658 code size and improves performance in case the destination is already aligned,
27659 but GCC doesn't know about it.
27661 @item -minline-all-stringops
27662 @opindex minline-all-stringops
27663 By default GCC inlines string operations only when the destination is 
27664 known to be aligned to least a 4-byte boundary.  
27665 This enables more inlining and increases code
27666 size, but may improve performance of code that depends on fast
27667 @code{memcpy}, @code{strlen},
27668 and @code{memset} for short lengths.
27670 @item -minline-stringops-dynamically
27671 @opindex minline-stringops-dynamically
27672 For string operations of unknown size, use run-time checks with
27673 inline code for small blocks and a library call for large blocks.
27675 @item -mstringop-strategy=@var{alg}
27676 @opindex mstringop-strategy=@var{alg}
27677 Override the internal decision heuristic for the particular algorithm to use
27678 for inlining string operations.  The allowed values for @var{alg} are:
27680 @table @samp
27681 @item rep_byte
27682 @itemx rep_4byte
27683 @itemx rep_8byte
27684 Expand using i386 @code{rep} prefix of the specified size.
27686 @item byte_loop
27687 @itemx loop
27688 @itemx unrolled_loop
27689 Expand into an inline loop.
27691 @item libcall
27692 Always use a library call.
27693 @end table
27695 @item -mmemcpy-strategy=@var{strategy}
27696 @opindex mmemcpy-strategy=@var{strategy}
27697 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27698 should be inlined and what inline algorithm to use when the expected size
27699 of the copy operation is known. @var{strategy} 
27700 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27701 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27702 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27703 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27704 in the list must be specified in increasing order.  The minimal byte size for 
27705 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27706 preceding range.
27708 @item -mmemset-strategy=@var{strategy}
27709 @opindex mmemset-strategy=@var{strategy}
27710 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27711 @code{__builtin_memset} expansion.
27713 @item -momit-leaf-frame-pointer
27714 @opindex momit-leaf-frame-pointer
27715 Don't keep the frame pointer in a register for leaf functions.  This
27716 avoids the instructions to save, set up, and restore frame pointers and
27717 makes an extra register available in leaf functions.  The option
27718 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27719 which might make debugging harder.
27721 @item -mtls-direct-seg-refs
27722 @itemx -mno-tls-direct-seg-refs
27723 @opindex mtls-direct-seg-refs
27724 Controls whether TLS variables may be accessed with offsets from the
27725 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27726 or whether the thread base pointer must be added.  Whether or not this
27727 is valid depends on the operating system, and whether it maps the
27728 segment to cover the entire TLS area.
27730 For systems that use the GNU C Library, the default is on.
27732 @item -msse2avx
27733 @itemx -mno-sse2avx
27734 @opindex msse2avx
27735 Specify that the assembler should encode SSE instructions with VEX
27736 prefix.  The option @option{-mavx} turns this on by default.
27738 @item -mfentry
27739 @itemx -mno-fentry
27740 @opindex mfentry
27741 If profiling is active (@option{-pg}), put the profiling
27742 counter call before the prologue.
27743 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27744 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27746 @item -mrecord-mcount
27747 @itemx -mno-record-mcount
27748 @opindex mrecord-mcount
27749 If profiling is active (@option{-pg}), generate a __mcount_loc section
27750 that contains pointers to each profiling call. This is useful for
27751 automatically patching and out calls.
27753 @item -mnop-mcount
27754 @itemx -mno-nop-mcount
27755 @opindex mnop-mcount
27756 If profiling is active (@option{-pg}), generate the calls to
27757 the profiling functions as NOPs. This is useful when they
27758 should be patched in later dynamically. This is likely only
27759 useful together with @option{-mrecord-mcount}.
27761 @item -mskip-rax-setup
27762 @itemx -mno-skip-rax-setup
27763 @opindex mskip-rax-setup
27764 When generating code for the x86-64 architecture with SSE extensions
27765 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27766 register when there are no variable arguments passed in vector registers.
27768 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27769 saving vector registers on stack when passing variable arguments, the
27770 impacts of this option are callees may waste some stack space,
27771 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27772 those issues, regardless the RAX register value.
27774 @item -m8bit-idiv
27775 @itemx -mno-8bit-idiv
27776 @opindex m8bit-idiv
27777 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27778 much faster than 32-bit/64-bit integer divide.  This option generates a
27779 run-time check.  If both dividend and divisor are within range of 0
27780 to 255, 8-bit unsigned integer divide is used instead of
27781 32-bit/64-bit integer divide.
27783 @item -mavx256-split-unaligned-load
27784 @itemx -mavx256-split-unaligned-store
27785 @opindex mavx256-split-unaligned-load
27786 @opindex mavx256-split-unaligned-store
27787 Split 32-byte AVX unaligned load and store.
27789 @item -mstack-protector-guard=@var{guard}
27790 @itemx -mstack-protector-guard-reg=@var{reg}
27791 @itemx -mstack-protector-guard-offset=@var{offset}
27792 @opindex mstack-protector-guard
27793 @opindex mstack-protector-guard-reg
27794 @opindex mstack-protector-guard-offset
27795 Generate stack protection code using canary at @var{guard}.  Supported
27796 locations are @samp{global} for global canary or @samp{tls} for per-thread
27797 canary in the TLS block (the default).  This option has effect only when
27798 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27800 With the latter choice the options
27801 @option{-mstack-protector-guard-reg=@var{reg}} and
27802 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27803 which segment register (@code{%fs} or @code{%gs}) to use as base register
27804 for reading the canary, and from what offset from that base register.
27805 The default for those is as specified in the relevant ABI.
27807 @item -mmitigate-rop
27808 @opindex mmitigate-rop
27809 Try to avoid generating code sequences that contain unintended return
27810 opcodes, to mitigate against certain forms of attack. At the moment,
27811 this option is limited in what it can do and should not be relied
27812 on to provide serious protection.
27814 @item -mgeneral-regs-only
27815 @opindex mgeneral-regs-only
27816 Generate code that uses only the general-purpose registers.  This
27817 prevents the compiler from using floating-point, vector, mask and bound
27818 registers.
27820 @item -mindirect-branch=@var{choice}
27821 @opindex -mindirect-branch
27822 Convert indirect call and jump with @var{choice}.  The default is
27823 @samp{keep}, which keeps indirect call and jump unmodified.
27824 @samp{thunk} converts indirect call and jump to call and return thunk.
27825 @samp{thunk-inline} converts indirect call and jump to inlined call
27826 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27827 to external call and return thunk provided in a separate object file.
27828 You can control this behavior for a specific function by using the
27829 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27831 Note that @option{-mcmodel=large} is incompatible with
27832 @option{-mindirect-branch=thunk} nor
27833 @option{-mindirect-branch=thunk-extern} since the thunk function may
27834 not be reachable in large code model.
27836 @item -mfunction-return=@var{choice}
27837 @opindex -mfunction-return
27838 Convert function return with @var{choice}.  The default is @samp{keep},
27839 which keeps function return unmodified.  @samp{thunk} converts function
27840 return to call and return thunk.  @samp{thunk-inline} converts function
27841 return to inlined call and return thunk.  @samp{thunk-extern} converts
27842 function return to external call and return thunk provided in a separate
27843 object file.  You can control this behavior for a specific function by
27844 using the function attribute @code{function_return}.
27845 @xref{Function Attributes}.
27847 Note that @option{-mcmodel=large} is incompatible with
27848 @option{-mfunction-return=thunk} nor
27849 @option{-mfunction-return=thunk-extern} since the thunk function may
27850 not be reachable in large code model.
27853 @item -mindirect-branch-register
27854 @opindex -mindirect-branch-register
27855 Force indirect call and jump via register.
27857 @end table
27859 These @samp{-m} switches are supported in addition to the above
27860 on x86-64 processors in 64-bit environments.
27862 @table @gcctabopt
27863 @item -m32
27864 @itemx -m64
27865 @itemx -mx32
27866 @itemx -m16
27867 @itemx -miamcu
27868 @opindex m32
27869 @opindex m64
27870 @opindex mx32
27871 @opindex m16
27872 @opindex miamcu
27873 Generate code for a 16-bit, 32-bit or 64-bit environment.
27874 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27875 to 32 bits, and
27876 generates code that runs on any i386 system.
27878 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27879 types to 64 bits, and generates code for the x86-64 architecture.
27880 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27881 and @option{-mdynamic-no-pic} options.
27883 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27884 to 32 bits, and
27885 generates code for the x86-64 architecture.
27887 The @option{-m16} option is the same as @option{-m32}, except for that
27888 it outputs the @code{.code16gcc} assembly directive at the beginning of
27889 the assembly output so that the binary can run in 16-bit mode.
27891 The @option{-miamcu} option generates code which conforms to Intel MCU
27892 psABI.  It requires the @option{-m32} option to be turned on.
27894 @item -mno-red-zone
27895 @opindex mno-red-zone
27896 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27897 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27898 stack pointer that is not modified by signal or interrupt handlers
27899 and therefore can be used for temporary data without adjusting the stack
27900 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27902 @item -mcmodel=small
27903 @opindex mcmodel=small
27904 Generate code for the small code model: the program and its symbols must
27905 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27906 Programs can be statically or dynamically linked.  This is the default
27907 code model.
27909 @item -mcmodel=kernel
27910 @opindex mcmodel=kernel
27911 Generate code for the kernel code model.  The kernel runs in the
27912 negative 2 GB of the address space.
27913 This model has to be used for Linux kernel code.
27915 @item -mcmodel=medium
27916 @opindex mcmodel=medium
27917 Generate code for the medium model: the program is linked in the lower 2
27918 GB of the address space.  Small symbols are also placed there.  Symbols
27919 with sizes larger than @option{-mlarge-data-threshold} are put into
27920 large data or BSS sections and can be located above 2GB.  Programs can
27921 be statically or dynamically linked.
27923 @item -mcmodel=large
27924 @opindex mcmodel=large
27925 Generate code for the large model.  This model makes no assumptions
27926 about addresses and sizes of sections.
27928 @item -maddress-mode=long
27929 @opindex maddress-mode=long
27930 Generate code for long address mode.  This is only supported for 64-bit
27931 and x32 environments.  It is the default address mode for 64-bit
27932 environments.
27934 @item -maddress-mode=short
27935 @opindex maddress-mode=short
27936 Generate code for short address mode.  This is only supported for 32-bit
27937 and x32 environments.  It is the default address mode for 32-bit and
27938 x32 environments.
27939 @end table
27941 @node x86 Windows Options
27942 @subsection x86 Windows Options
27943 @cindex x86 Windows Options
27944 @cindex Windows Options for x86
27946 These additional options are available for Microsoft Windows targets:
27948 @table @gcctabopt
27949 @item -mconsole
27950 @opindex mconsole
27951 This option
27952 specifies that a console application is to be generated, by
27953 instructing the linker to set the PE header subsystem type
27954 required for console applications.
27955 This option is available for Cygwin and MinGW targets and is
27956 enabled by default on those targets.
27958 @item -mdll
27959 @opindex mdll
27960 This option is available for Cygwin and MinGW targets.  It
27961 specifies that a DLL---a dynamic link library---is to be
27962 generated, enabling the selection of the required runtime
27963 startup object and entry point.
27965 @item -mnop-fun-dllimport
27966 @opindex mnop-fun-dllimport
27967 This option is available for Cygwin and MinGW targets.  It
27968 specifies that the @code{dllimport} attribute should be ignored.
27970 @item -mthread
27971 @opindex mthread
27972 This option is available for MinGW targets. It specifies
27973 that MinGW-specific thread support is to be used.
27975 @item -municode
27976 @opindex municode
27977 This option is available for MinGW-w64 targets.  It causes
27978 the @code{UNICODE} preprocessor macro to be predefined, and
27979 chooses Unicode-capable runtime startup code.
27981 @item -mwin32
27982 @opindex mwin32
27983 This option is available for Cygwin and MinGW targets.  It
27984 specifies that the typical Microsoft Windows predefined macros are to
27985 be set in the pre-processor, but does not influence the choice
27986 of runtime library/startup code.
27988 @item -mwindows
27989 @opindex mwindows
27990 This option is available for Cygwin and MinGW targets.  It
27991 specifies that a GUI application is to be generated by
27992 instructing the linker to set the PE header subsystem type
27993 appropriately.
27995 @item -fno-set-stack-executable
27996 @opindex fno-set-stack-executable
27997 This option is available for MinGW targets. It specifies that
27998 the executable flag for the stack used by nested functions isn't
27999 set. This is necessary for binaries running in kernel mode of
28000 Microsoft Windows, as there the User32 API, which is used to set executable
28001 privileges, isn't available.
28003 @item -fwritable-relocated-rdata
28004 @opindex fno-writable-relocated-rdata
28005 This option is available for MinGW and Cygwin targets.  It specifies
28006 that relocated-data in read-only section is put into the @code{.data}
28007 section.  This is a necessary for older runtimes not supporting
28008 modification of @code{.rdata} sections for pseudo-relocation.
28010 @item -mpe-aligned-commons
28011 @opindex mpe-aligned-commons
28012 This option is available for Cygwin and MinGW targets.  It
28013 specifies that the GNU extension to the PE file format that
28014 permits the correct alignment of COMMON variables should be
28015 used when generating code.  It is enabled by default if
28016 GCC detects that the target assembler found during configuration
28017 supports the feature.
28018 @end table
28020 See also under @ref{x86 Options} for standard options.
28022 @node Xstormy16 Options
28023 @subsection Xstormy16 Options
28024 @cindex Xstormy16 Options
28026 These options are defined for Xstormy16:
28028 @table @gcctabopt
28029 @item -msim
28030 @opindex msim
28031 Choose startup files and linker script suitable for the simulator.
28032 @end table
28034 @node Xtensa Options
28035 @subsection Xtensa Options
28036 @cindex Xtensa Options
28038 These options are supported for Xtensa targets:
28040 @table @gcctabopt
28041 @item -mconst16
28042 @itemx -mno-const16
28043 @opindex mconst16
28044 @opindex mno-const16
28045 Enable or disable use of @code{CONST16} instructions for loading
28046 constant values.  The @code{CONST16} instruction is currently not a
28047 standard option from Tensilica.  When enabled, @code{CONST16}
28048 instructions are always used in place of the standard @code{L32R}
28049 instructions.  The use of @code{CONST16} is enabled by default only if
28050 the @code{L32R} instruction is not available.
28052 @item -mfused-madd
28053 @itemx -mno-fused-madd
28054 @opindex mfused-madd
28055 @opindex mno-fused-madd
28056 Enable or disable use of fused multiply/add and multiply/subtract
28057 instructions in the floating-point option.  This has no effect if the
28058 floating-point option is not also enabled.  Disabling fused multiply/add
28059 and multiply/subtract instructions forces the compiler to use separate
28060 instructions for the multiply and add/subtract operations.  This may be
28061 desirable in some cases where strict IEEE 754-compliant results are
28062 required: the fused multiply add/subtract instructions do not round the
28063 intermediate result, thereby producing results with @emph{more} bits of
28064 precision than specified by the IEEE standard.  Disabling fused multiply
28065 add/subtract instructions also ensures that the program output is not
28066 sensitive to the compiler's ability to combine multiply and add/subtract
28067 operations.
28069 @item -mserialize-volatile
28070 @itemx -mno-serialize-volatile
28071 @opindex mserialize-volatile
28072 @opindex mno-serialize-volatile
28073 When this option is enabled, GCC inserts @code{MEMW} instructions before
28074 @code{volatile} memory references to guarantee sequential consistency.
28075 The default is @option{-mserialize-volatile}.  Use
28076 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28078 @item -mforce-no-pic
28079 @opindex mforce-no-pic
28080 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28081 position-independent code (PIC), this option disables PIC for compiling
28082 kernel code.
28084 @item -mtext-section-literals
28085 @itemx -mno-text-section-literals
28086 @opindex mtext-section-literals
28087 @opindex mno-text-section-literals
28088 These options control the treatment of literal pools.  The default is
28089 @option{-mno-text-section-literals}, which places literals in a separate
28090 section in the output file.  This allows the literal pool to be placed
28091 in a data RAM/ROM, and it also allows the linker to combine literal
28092 pools from separate object files to remove redundant literals and
28093 improve code size.  With @option{-mtext-section-literals}, the literals
28094 are interspersed in the text section in order to keep them as close as
28095 possible to their references.  This may be necessary for large assembly
28096 files.  Literals for each function are placed right before that function.
28098 @item -mauto-litpools
28099 @itemx -mno-auto-litpools
28100 @opindex mauto-litpools
28101 @opindex mno-auto-litpools
28102 These options control the treatment of literal pools.  The default is
28103 @option{-mno-auto-litpools}, which places literals in a separate
28104 section in the output file unless @option{-mtext-section-literals} is
28105 used.  With @option{-mauto-litpools} the literals are interspersed in
28106 the text section by the assembler.  Compiler does not produce explicit
28107 @code{.literal} directives and loads literals into registers with
28108 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28109 do relaxation and place literals as necessary.  This option allows
28110 assembler to create several literal pools per function and assemble
28111 very big functions, which may not be possible with
28112 @option{-mtext-section-literals}.
28114 @item -mtarget-align
28115 @itemx -mno-target-align
28116 @opindex mtarget-align
28117 @opindex mno-target-align
28118 When this option is enabled, GCC instructs the assembler to
28119 automatically align instructions to reduce branch penalties at the
28120 expense of some code density.  The assembler attempts to widen density
28121 instructions to align branch targets and the instructions following call
28122 instructions.  If there are not enough preceding safe density
28123 instructions to align a target, no widening is performed.  The
28124 default is @option{-mtarget-align}.  These options do not affect the
28125 treatment of auto-aligned instructions like @code{LOOP}, which the
28126 assembler always aligns, either by widening density instructions or
28127 by inserting NOP instructions.
28129 @item -mlongcalls
28130 @itemx -mno-longcalls
28131 @opindex mlongcalls
28132 @opindex mno-longcalls
28133 When this option is enabled, GCC instructs the assembler to translate
28134 direct calls to indirect calls unless it can determine that the target
28135 of a direct call is in the range allowed by the call instruction.  This
28136 translation typically occurs for calls to functions in other source
28137 files.  Specifically, the assembler translates a direct @code{CALL}
28138 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28139 The default is @option{-mno-longcalls}.  This option should be used in
28140 programs where the call target can potentially be out of range.  This
28141 option is implemented in the assembler, not the compiler, so the
28142 assembly code generated by GCC still shows direct call
28143 instructions---look at the disassembled object code to see the actual
28144 instructions.  Note that the assembler uses an indirect call for
28145 every cross-file call, not just those that really are out of range.
28146 @end table
28148 @node zSeries Options
28149 @subsection zSeries Options
28150 @cindex zSeries options
28152 These are listed under @xref{S/390 and zSeries Options}.
28155 @c man end
28157 @node Spec Files
28158 @section Specifying Subprocesses and the Switches to Pass to Them
28159 @cindex Spec Files
28161 @command{gcc} is a driver program.  It performs its job by invoking a
28162 sequence of other programs to do the work of compiling, assembling and
28163 linking.  GCC interprets its command-line parameters and uses these to
28164 deduce which programs it should invoke, and which command-line options
28165 it ought to place on their command lines.  This behavior is controlled
28166 by @dfn{spec strings}.  In most cases there is one spec string for each
28167 program that GCC can invoke, but a few programs have multiple spec
28168 strings to control their behavior.  The spec strings built into GCC can
28169 be overridden by using the @option{-specs=} command-line switch to specify
28170 a spec file.
28172 @dfn{Spec files} are plain-text files that are used to construct spec
28173 strings.  They consist of a sequence of directives separated by blank
28174 lines.  The type of directive is determined by the first non-whitespace
28175 character on the line, which can be one of the following:
28177 @table @code
28178 @item %@var{command}
28179 Issues a @var{command} to the spec file processor.  The commands that can
28180 appear here are:
28182 @table @code
28183 @item %include <@var{file}>
28184 @cindex @code{%include}
28185 Search for @var{file} and insert its text at the current point in the
28186 specs file.
28188 @item %include_noerr <@var{file}>
28189 @cindex @code{%include_noerr}
28190 Just like @samp{%include}, but do not generate an error message if the include
28191 file cannot be found.
28193 @item %rename @var{old_name} @var{new_name}
28194 @cindex @code{%rename}
28195 Rename the spec string @var{old_name} to @var{new_name}.
28197 @end table
28199 @item *[@var{spec_name}]:
28200 This tells the compiler to create, override or delete the named spec
28201 string.  All lines after this directive up to the next directive or
28202 blank line are considered to be the text for the spec string.  If this
28203 results in an empty string then the spec is deleted.  (Or, if the
28204 spec did not exist, then nothing happens.)  Otherwise, if the spec
28205 does not currently exist a new spec is created.  If the spec does
28206 exist then its contents are overridden by the text of this
28207 directive, unless the first character of that text is the @samp{+}
28208 character, in which case the text is appended to the spec.
28210 @item [@var{suffix}]:
28211 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28212 and up to the next directive or blank line are considered to make up the
28213 spec string for the indicated suffix.  When the compiler encounters an
28214 input file with the named suffix, it processes the spec string in
28215 order to work out how to compile that file.  For example:
28217 @smallexample
28218 .ZZ:
28219 z-compile -input %i
28220 @end smallexample
28222 This says that any input file whose name ends in @samp{.ZZ} should be
28223 passed to the program @samp{z-compile}, which should be invoked with the
28224 command-line switch @option{-input} and with the result of performing the
28225 @samp{%i} substitution.  (See below.)
28227 As an alternative to providing a spec string, the text following a
28228 suffix directive can be one of the following:
28230 @table @code
28231 @item @@@var{language}
28232 This says that the suffix is an alias for a known @var{language}.  This is
28233 similar to using the @option{-x} command-line switch to GCC to specify a
28234 language explicitly.  For example:
28236 @smallexample
28237 .ZZ:
28238 @@c++
28239 @end smallexample
28241 Says that .ZZ files are, in fact, C++ source files.
28243 @item #@var{name}
28244 This causes an error messages saying:
28246 @smallexample
28247 @var{name} compiler not installed on this system.
28248 @end smallexample
28249 @end table
28251 GCC already has an extensive list of suffixes built into it.
28252 This directive adds an entry to the end of the list of suffixes, but
28253 since the list is searched from the end backwards, it is effectively
28254 possible to override earlier entries using this technique.
28256 @end table
28258 GCC has the following spec strings built into it.  Spec files can
28259 override these strings or create their own.  Note that individual
28260 targets can also add their own spec strings to this list.
28262 @smallexample
28263 asm          Options to pass to the assembler
28264 asm_final    Options to pass to the assembler post-processor
28265 cpp          Options to pass to the C preprocessor
28266 cc1          Options to pass to the C compiler
28267 cc1plus      Options to pass to the C++ compiler
28268 endfile      Object files to include at the end of the link
28269 link         Options to pass to the linker
28270 lib          Libraries to include on the command line to the linker
28271 libgcc       Decides which GCC support library to pass to the linker
28272 linker       Sets the name of the linker
28273 predefines   Defines to be passed to the C preprocessor
28274 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28275              by default
28276 startfile    Object files to include at the start of the link
28277 @end smallexample
28279 Here is a small example of a spec file:
28281 @smallexample
28282 %rename lib                 old_lib
28284 *lib:
28285 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28286 @end smallexample
28288 This example renames the spec called @samp{lib} to @samp{old_lib} and
28289 then overrides the previous definition of @samp{lib} with a new one.
28290 The new definition adds in some extra command-line options before
28291 including the text of the old definition.
28293 @dfn{Spec strings} are a list of command-line options to be passed to their
28294 corresponding program.  In addition, the spec strings can contain
28295 @samp{%}-prefixed sequences to substitute variable text or to
28296 conditionally insert text into the command line.  Using these constructs
28297 it is possible to generate quite complex command lines.
28299 Here is a table of all defined @samp{%}-sequences for spec
28300 strings.  Note that spaces are not generated automatically around the
28301 results of expanding these sequences.  Therefore you can concatenate them
28302 together or combine them with constant text in a single argument.
28304 @table @code
28305 @item %%
28306 Substitute one @samp{%} into the program name or argument.
28308 @item %i
28309 Substitute the name of the input file being processed.
28311 @item %b
28312 Substitute the basename of the input file being processed.
28313 This is the substring up to (and not including) the last period
28314 and not including the directory.
28316 @item %B
28317 This is the same as @samp{%b}, but include the file suffix (text after
28318 the last period).
28320 @item %d
28321 Marks the argument containing or following the @samp{%d} as a
28322 temporary file name, so that that file is deleted if GCC exits
28323 successfully.  Unlike @samp{%g}, this contributes no text to the
28324 argument.
28326 @item %g@var{suffix}
28327 Substitute a file name that has suffix @var{suffix} and is chosen
28328 once per compilation, and mark the argument in the same way as
28329 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28330 name is now chosen in a way that is hard to predict even when previously
28331 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28332 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28333 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28334 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28335 was simply substituted with a file name chosen once per compilation,
28336 without regard to any appended suffix (which was therefore treated
28337 just like ordinary text), making such attacks more likely to succeed.
28339 @item %u@var{suffix}
28340 Like @samp{%g}, but generates a new temporary file name
28341 each time it appears instead of once per compilation.
28343 @item %U@var{suffix}
28344 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28345 new one if there is no such last file name.  In the absence of any
28346 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28347 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28348 involves the generation of two distinct file names, one
28349 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28350 simply substituted with a file name chosen for the previous @samp{%u},
28351 without regard to any appended suffix.
28353 @item %j@var{suffix}
28354 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28355 writable, and if @option{-save-temps} is not used; 
28356 otherwise, substitute the name
28357 of a temporary file, just like @samp{%u}.  This temporary file is not
28358 meant for communication between processes, but rather as a junk
28359 disposal mechanism.
28361 @item %|@var{suffix}
28362 @itemx %m@var{suffix}
28363 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28364 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28365 all.  These are the two most common ways to instruct a program that it
28366 should read from standard input or write to standard output.  If you
28367 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28368 construct: see for example @file{f/lang-specs.h}.
28370 @item %.@var{SUFFIX}
28371 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28372 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28373 terminated by the next space or %.
28375 @item %w
28376 Marks the argument containing or following the @samp{%w} as the
28377 designated output file of this compilation.  This puts the argument
28378 into the sequence of arguments that @samp{%o} substitutes.
28380 @item %o
28381 Substitutes the names of all the output files, with spaces
28382 automatically placed around them.  You should write spaces
28383 around the @samp{%o} as well or the results are undefined.
28384 @samp{%o} is for use in the specs for running the linker.
28385 Input files whose names have no recognized suffix are not compiled
28386 at all, but they are included among the output files, so they are
28387 linked.
28389 @item %O
28390 Substitutes the suffix for object files.  Note that this is
28391 handled specially when it immediately follows @samp{%g, %u, or %U},
28392 because of the need for those to form complete file names.  The
28393 handling is such that @samp{%O} is treated exactly as if it had already
28394 been substituted, except that @samp{%g, %u, and %U} do not currently
28395 support additional @var{suffix} characters following @samp{%O} as they do
28396 following, for example, @samp{.o}.
28398 @item %p
28399 Substitutes the standard macro predefinitions for the
28400 current target machine.  Use this when running @command{cpp}.
28402 @item %P
28403 Like @samp{%p}, but puts @samp{__} before and after the name of each
28404 predefined macro, except for macros that start with @samp{__} or with
28405 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28408 @item %I
28409 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28410 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28411 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28412 and @option{-imultilib} as necessary.
28414 @item %s
28415 Current argument is the name of a library or startup file of some sort.
28416 Search for that file in a standard list of directories and substitute
28417 the full name found.  The current working directory is included in the
28418 list of directories scanned.
28420 @item %T
28421 Current argument is the name of a linker script.  Search for that file
28422 in the current list of directories to scan for libraries. If the file
28423 is located insert a @option{--script} option into the command line
28424 followed by the full path name found.  If the file is not found then
28425 generate an error message.  Note: the current working directory is not
28426 searched.
28428 @item %e@var{str}
28429 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28430 Use this when inconsistent options are detected.
28432 @item %(@var{name})
28433 Substitute the contents of spec string @var{name} at this point.
28435 @item %x@{@var{option}@}
28436 Accumulate an option for @samp{%X}.
28438 @item %X
28439 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28440 spec string.
28442 @item %Y
28443 Output the accumulated assembler options specified by @option{-Wa}.
28445 @item %Z
28446 Output the accumulated preprocessor options specified by @option{-Wp}.
28448 @item %a
28449 Process the @code{asm} spec.  This is used to compute the
28450 switches to be passed to the assembler.
28452 @item %A
28453 Process the @code{asm_final} spec.  This is a spec string for
28454 passing switches to an assembler post-processor, if such a program is
28455 needed.
28457 @item %l
28458 Process the @code{link} spec.  This is the spec for computing the
28459 command line passed to the linker.  Typically it makes use of the
28460 @samp{%L %G %S %D and %E} sequences.
28462 @item %D
28463 Dump out a @option{-L} option for each directory that GCC believes might
28464 contain startup files.  If the target supports multilibs then the
28465 current multilib directory is prepended to each of these paths.
28467 @item %L
28468 Process the @code{lib} spec.  This is a spec string for deciding which
28469 libraries are included on the command line to the linker.
28471 @item %G
28472 Process the @code{libgcc} spec.  This is a spec string for deciding
28473 which GCC support library is included on the command line to the linker.
28475 @item %S
28476 Process the @code{startfile} spec.  This is a spec for deciding which
28477 object files are the first ones passed to the linker.  Typically
28478 this might be a file named @file{crt0.o}.
28480 @item %E
28481 Process the @code{endfile} spec.  This is a spec string that specifies
28482 the last object files that are passed to the linker.
28484 @item %C
28485 Process the @code{cpp} spec.  This is used to construct the arguments
28486 to be passed to the C preprocessor.
28488 @item %1
28489 Process the @code{cc1} spec.  This is used to construct the options to be
28490 passed to the actual C compiler (@command{cc1}).
28492 @item %2
28493 Process the @code{cc1plus} spec.  This is used to construct the options to be
28494 passed to the actual C++ compiler (@command{cc1plus}).
28496 @item %*
28497 Substitute the variable part of a matched option.  See below.
28498 Note that each comma in the substituted string is replaced by
28499 a single space.
28501 @item %<S
28502 Remove all occurrences of @code{-S} from the command line.  Note---this
28503 command is position dependent.  @samp{%} commands in the spec string
28504 before this one see @code{-S}, @samp{%} commands in the spec string
28505 after this one do not.
28507 @item %:@var{function}(@var{args})
28508 Call the named function @var{function}, passing it @var{args}.
28509 @var{args} is first processed as a nested spec string, then split
28510 into an argument vector in the usual fashion.  The function returns
28511 a string which is processed as if it had appeared literally as part
28512 of the current spec.
28514 The following built-in spec functions are provided:
28516 @table @code
28517 @item @code{getenv}
28518 The @code{getenv} spec function takes two arguments: an environment
28519 variable name and a string.  If the environment variable is not
28520 defined, a fatal error is issued.  Otherwise, the return value is the
28521 value of the environment variable concatenated with the string.  For
28522 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28524 @smallexample
28525 %:getenv(TOPDIR /include)
28526 @end smallexample
28528 expands to @file{/path/to/top/include}.
28530 @item @code{if-exists}
28531 The @code{if-exists} spec function takes one argument, an absolute
28532 pathname to a file.  If the file exists, @code{if-exists} returns the
28533 pathname.  Here is a small example of its usage:
28535 @smallexample
28536 *startfile:
28537 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28538 @end smallexample
28540 @item @code{if-exists-else}
28541 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28542 spec function, except that it takes two arguments.  The first argument is
28543 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28544 returns the pathname.  If it does not exist, it returns the second argument.
28545 This way, @code{if-exists-else} can be used to select one file or another,
28546 based on the existence of the first.  Here is a small example of its usage:
28548 @smallexample
28549 *startfile:
28550 crt0%O%s %:if-exists(crti%O%s) \
28551 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28552 @end smallexample
28554 @item @code{replace-outfile}
28555 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28556 first argument in the outfiles array and replaces it with the second argument.  Here
28557 is a small example of its usage:
28559 @smallexample
28560 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28561 @end smallexample
28563 @item @code{remove-outfile}
28564 The @code{remove-outfile} spec function takes one argument.  It looks for the
28565 first argument in the outfiles array and removes it.  Here is a small example
28566 its usage:
28568 @smallexample
28569 %:remove-outfile(-lm)
28570 @end smallexample
28572 @item @code{pass-through-libs}
28573 The @code{pass-through-libs} spec function takes any number of arguments.  It
28574 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28575 assumes are the names of linker input library archive files) and returns a
28576 result containing all the found arguments each prepended by
28577 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28578 intended to be passed to the LTO linker plugin.
28580 @smallexample
28581 %:pass-through-libs(%G %L %G)
28582 @end smallexample
28584 @item @code{print-asm-header}
28585 The @code{print-asm-header} function takes no arguments and simply
28586 prints a banner like:
28588 @smallexample
28589 Assembler options
28590 =================
28592 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28593 @end smallexample
28595 It is used to separate compiler options from assembler options
28596 in the @option{--target-help} output.
28597 @end table
28599 @item %@{S@}
28600 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28601 If that switch is not specified, this substitutes nothing.  Note that
28602 the leading dash is omitted when specifying this option, and it is
28603 automatically inserted if the substitution is performed.  Thus the spec
28604 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28605 and outputs the command-line option @option{-foo}.
28607 @item %W@{S@}
28608 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28609 deleted on failure.
28611 @item %@{S*@}
28612 Substitutes all the switches specified to GCC whose names start
28613 with @code{-S}, but which also take an argument.  This is used for
28614 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28615 GCC considers @option{-o foo} as being
28616 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28617 text, including the space.  Thus two arguments are generated.
28619 @item %@{S*&T*@}
28620 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28621 (the order of @code{S} and @code{T} in the spec is not significant).
28622 There can be any number of ampersand-separated variables; for each the
28623 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28625 @item %@{S:X@}
28626 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28628 @item %@{!S:X@}
28629 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28631 @item %@{S*:X@}
28632 Substitutes @code{X} if one or more switches whose names start with
28633 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28634 once, no matter how many such switches appeared.  However, if @code{%*}
28635 appears somewhere in @code{X}, then @code{X} is substituted once
28636 for each matching switch, with the @code{%*} replaced by the part of
28637 that switch matching the @code{*}.
28639 If @code{%*} appears as the last part of a spec sequence then a space
28640 is added after the end of the last substitution.  If there is more
28641 text in the sequence, however, then a space is not generated.  This
28642 allows the @code{%*} substitution to be used as part of a larger
28643 string.  For example, a spec string like this:
28645 @smallexample
28646 %@{mcu=*:--script=%*/memory.ld@}
28647 @end smallexample
28649 @noindent
28650 when matching an option like @option{-mcu=newchip} produces:
28652 @smallexample
28653 --script=newchip/memory.ld
28654 @end smallexample
28656 @item %@{.S:X@}
28657 Substitutes @code{X}, if processing a file with suffix @code{S}.
28659 @item %@{!.S:X@}
28660 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28662 @item %@{,S:X@}
28663 Substitutes @code{X}, if processing a file for language @code{S}.
28665 @item %@{!,S:X@}
28666 Substitutes @code{X}, if not processing a file for language @code{S}.
28668 @item %@{S|P:X@}
28669 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28670 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28671 @code{*} sequences as well, although they have a stronger binding than
28672 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28673 alternatives must be starred, and only the first matching alternative
28674 is substituted.
28676 For example, a spec string like this:
28678 @smallexample
28679 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28680 @end smallexample
28682 @noindent
28683 outputs the following command-line options from the following input
28684 command-line options:
28686 @smallexample
28687 fred.c        -foo -baz
28688 jim.d         -bar -boggle
28689 -d fred.c     -foo -baz -boggle
28690 -d jim.d      -bar -baz -boggle
28691 @end smallexample
28693 @item %@{S:X; T:Y; :D@}
28695 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28696 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28697 be as many clauses as you need.  This may be combined with @code{.},
28698 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28701 @end table
28703 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28704 or similar construct can use a backslash to ignore the special meaning
28705 of the character following it, thus allowing literal matching of a
28706 character that is otherwise specially treated.  For example,
28707 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28708 @option{-std=iso9899:1999} option is given.
28710 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28711 construct may contain other nested @samp{%} constructs or spaces, or
28712 even newlines.  They are processed as usual, as described above.
28713 Trailing white space in @code{X} is ignored.  White space may also
28714 appear anywhere on the left side of the colon in these constructs,
28715 except between @code{.} or @code{*} and the corresponding word.
28717 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28718 handled specifically in these constructs.  If another value of
28719 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28720 @option{-W} switch is found later in the command line, the earlier
28721 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28722 just one letter, which passes all matching options.
28724 The character @samp{|} at the beginning of the predicate text is used to
28725 indicate that a command should be piped to the following command, but
28726 only if @option{-pipe} is specified.
28728 It is built into GCC which switches take arguments and which do not.
28729 (You might think it would be useful to generalize this to allow each
28730 compiler's spec to say which switches take arguments.  But this cannot
28731 be done in a consistent fashion.  GCC cannot even decide which input
28732 files have been specified without knowing which switches take arguments,
28733 and it must know which input files to compile in order to tell which
28734 compilers to run).
28736 GCC also knows implicitly that arguments starting in @option{-l} are to be
28737 treated as compiler output files, and passed to the linker in their
28738 proper position among the other output files.
28740 @node Environment Variables
28741 @section Environment Variables Affecting GCC
28742 @cindex environment variables
28744 @c man begin ENVIRONMENT
28745 This section describes several environment variables that affect how GCC
28746 operates.  Some of them work by specifying directories or prefixes to use
28747 when searching for various kinds of files.  Some are used to specify other
28748 aspects of the compilation environment.
28750 Note that you can also specify places to search using options such as
28751 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28752 take precedence over places specified using environment variables, which
28753 in turn take precedence over those specified by the configuration of GCC@.
28754 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28755 GNU Compiler Collection (GCC) Internals}.
28757 @table @env
28758 @item LANG
28759 @itemx LC_CTYPE
28760 @c @itemx LC_COLLATE
28761 @itemx LC_MESSAGES
28762 @c @itemx LC_MONETARY
28763 @c @itemx LC_NUMERIC
28764 @c @itemx LC_TIME
28765 @itemx LC_ALL
28766 @findex LANG
28767 @findex LC_CTYPE
28768 @c @findex LC_COLLATE
28769 @findex LC_MESSAGES
28770 @c @findex LC_MONETARY
28771 @c @findex LC_NUMERIC
28772 @c @findex LC_TIME
28773 @findex LC_ALL
28774 @cindex locale
28775 These environment variables control the way that GCC uses
28776 localization information which allows GCC to work with different
28777 national conventions.  GCC inspects the locale categories
28778 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28779 so.  These locale categories can be set to any value supported by your
28780 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28781 Kingdom encoded in UTF-8.
28783 The @env{LC_CTYPE} environment variable specifies character
28784 classification.  GCC uses it to determine the character boundaries in
28785 a string; this is needed for some multibyte encodings that contain quote
28786 and escape characters that are otherwise interpreted as a string
28787 end or escape.
28789 The @env{LC_MESSAGES} environment variable specifies the language to
28790 use in diagnostic messages.
28792 If the @env{LC_ALL} environment variable is set, it overrides the value
28793 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28794 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28795 environment variable.  If none of these variables are set, GCC
28796 defaults to traditional C English behavior.
28798 @item TMPDIR
28799 @findex TMPDIR
28800 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28801 files.  GCC uses temporary files to hold the output of one stage of
28802 compilation which is to be used as input to the next stage: for example,
28803 the output of the preprocessor, which is the input to the compiler
28804 proper.
28806 @item GCC_COMPARE_DEBUG
28807 @findex GCC_COMPARE_DEBUG
28808 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28809 @option{-fcompare-debug} to the compiler driver.  See the documentation
28810 of this option for more details.
28812 @item GCC_EXEC_PREFIX
28813 @findex GCC_EXEC_PREFIX
28814 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28815 names of the subprograms executed by the compiler.  No slash is added
28816 when this prefix is combined with the name of a subprogram, but you can
28817 specify a prefix that ends with a slash if you wish.
28819 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28820 an appropriate prefix to use based on the pathname it is invoked with.
28822 If GCC cannot find the subprogram using the specified prefix, it
28823 tries looking in the usual places for the subprogram.
28825 The default value of @env{GCC_EXEC_PREFIX} is
28826 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28827 the installed compiler. In many cases @var{prefix} is the value
28828 of @code{prefix} when you ran the @file{configure} script.
28830 Other prefixes specified with @option{-B} take precedence over this prefix.
28832 This prefix is also used for finding files such as @file{crt0.o} that are
28833 used for linking.
28835 In addition, the prefix is used in an unusual way in finding the
28836 directories to search for header files.  For each of the standard
28837 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28838 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28839 replacing that beginning with the specified prefix to produce an
28840 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28841 @file{foo/bar} just before it searches the standard directory 
28842 @file{/usr/local/lib/bar}.
28843 If a standard directory begins with the configured
28844 @var{prefix} then the value of @var{prefix} is replaced by
28845 @env{GCC_EXEC_PREFIX} when looking for header files.
28847 @item COMPILER_PATH
28848 @findex COMPILER_PATH
28849 The value of @env{COMPILER_PATH} is a colon-separated list of
28850 directories, much like @env{PATH}.  GCC tries the directories thus
28851 specified when searching for subprograms, if it cannot find the
28852 subprograms using @env{GCC_EXEC_PREFIX}.
28854 @item LIBRARY_PATH
28855 @findex LIBRARY_PATH
28856 The value of @env{LIBRARY_PATH} is a colon-separated list of
28857 directories, much like @env{PATH}.  When configured as a native compiler,
28858 GCC tries the directories thus specified when searching for special
28859 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28860 using GCC also uses these directories when searching for ordinary
28861 libraries for the @option{-l} option (but directories specified with
28862 @option{-L} come first).
28864 @item LANG
28865 @findex LANG
28866 @cindex locale definition
28867 This variable is used to pass locale information to the compiler.  One way in
28868 which this information is used is to determine the character set to be used
28869 when character literals, string literals and comments are parsed in C and C++.
28870 When the compiler is configured to allow multibyte characters,
28871 the following values for @env{LANG} are recognized:
28873 @table @samp
28874 @item C-JIS
28875 Recognize JIS characters.
28876 @item C-SJIS
28877 Recognize SJIS characters.
28878 @item C-EUCJP
28879 Recognize EUCJP characters.
28880 @end table
28882 If @env{LANG} is not defined, or if it has some other value, then the
28883 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28884 recognize and translate multibyte characters.
28885 @end table
28887 @noindent
28888 Some additional environment variables affect the behavior of the
28889 preprocessor.
28891 @include cppenv.texi
28893 @c man end
28895 @node Precompiled Headers
28896 @section Using Precompiled Headers
28897 @cindex precompiled headers
28898 @cindex speed of compilation
28900 Often large projects have many header files that are included in every
28901 source file.  The time the compiler takes to process these header files
28902 over and over again can account for nearly all of the time required to
28903 build the project.  To make builds faster, GCC allows you to
28904 @dfn{precompile} a header file.
28906 To create a precompiled header file, simply compile it as you would any
28907 other file, if necessary using the @option{-x} option to make the driver
28908 treat it as a C or C++ header file.  You may want to use a
28909 tool like @command{make} to keep the precompiled header up-to-date when
28910 the headers it contains change.
28912 A precompiled header file is searched for when @code{#include} is
28913 seen in the compilation.  As it searches for the included file
28914 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28915 compiler looks for a precompiled header in each directory just before it
28916 looks for the include file in that directory.  The name searched for is
28917 the name specified in the @code{#include} with @samp{.gch} appended.  If
28918 the precompiled header file cannot be used, it is ignored.
28920 For instance, if you have @code{#include "all.h"}, and you have
28921 @file{all.h.gch} in the same directory as @file{all.h}, then the
28922 precompiled header file is used if possible, and the original
28923 header is used otherwise.
28925 Alternatively, you might decide to put the precompiled header file in a
28926 directory and use @option{-I} to ensure that directory is searched
28927 before (or instead of) the directory containing the original header.
28928 Then, if you want to check that the precompiled header file is always
28929 used, you can put a file of the same name as the original header in this
28930 directory containing an @code{#error} command.
28932 This also works with @option{-include}.  So yet another way to use
28933 precompiled headers, good for projects not designed with precompiled
28934 header files in mind, is to simply take most of the header files used by
28935 a project, include them from another header file, precompile that header
28936 file, and @option{-include} the precompiled header.  If the header files
28937 have guards against multiple inclusion, they are skipped because
28938 they've already been included (in the precompiled header).
28940 If you need to precompile the same header file for different
28941 languages, targets, or compiler options, you can instead make a
28942 @emph{directory} named like @file{all.h.gch}, and put each precompiled
28943 header in the directory, perhaps using @option{-o}.  It doesn't matter
28944 what you call the files in the directory; every precompiled header in
28945 the directory is considered.  The first precompiled header
28946 encountered in the directory that is valid for this compilation is
28947 used; they're searched in no particular order.
28949 There are many other possibilities, limited only by your imagination,
28950 good sense, and the constraints of your build system.
28952 A precompiled header file can be used only when these conditions apply:
28954 @itemize
28955 @item
28956 Only one precompiled header can be used in a particular compilation.
28958 @item
28959 A precompiled header cannot be used once the first C token is seen.  You
28960 can have preprocessor directives before a precompiled header; you cannot
28961 include a precompiled header from inside another header.
28963 @item
28964 The precompiled header file must be produced for the same language as
28965 the current compilation.  You cannot use a C precompiled header for a C++
28966 compilation.
28968 @item
28969 The precompiled header file must have been produced by the same compiler
28970 binary as the current compilation is using.
28972 @item
28973 Any macros defined before the precompiled header is included must
28974 either be defined in the same way as when the precompiled header was
28975 generated, or must not affect the precompiled header, which usually
28976 means that they don't appear in the precompiled header at all.
28978 The @option{-D} option is one way to define a macro before a
28979 precompiled header is included; using a @code{#define} can also do it.
28980 There are also some options that define macros implicitly, like
28981 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
28982 defined this way.
28984 @item If debugging information is output when using the precompiled
28985 header, using @option{-g} or similar, the same kind of debugging information
28986 must have been output when building the precompiled header.  However,
28987 a precompiled header built using @option{-g} can be used in a compilation
28988 when no debugging information is being output.
28990 @item The same @option{-m} options must generally be used when building
28991 and using the precompiled header.  @xref{Submodel Options},
28992 for any cases where this rule is relaxed.
28994 @item Each of the following options must be the same when building and using
28995 the precompiled header:
28997 @gccoptlist{-fexceptions}
28999 @item
29000 Some other command-line options starting with @option{-f},
29001 @option{-p}, or @option{-O} must be defined in the same way as when
29002 the precompiled header was generated.  At present, it's not clear
29003 which options are safe to change and which are not; the safest choice
29004 is to use exactly the same options when generating and using the
29005 precompiled header.  The following are known to be safe:
29007 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29008 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29009 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29010 -pedantic-errors}
29012 @end itemize
29014 For all of these except the last, the compiler automatically
29015 ignores the precompiled header if the conditions aren't met.  If you
29016 find an option combination that doesn't work and doesn't cause the
29017 precompiled header to be ignored, please consider filing a bug report,
29018 see @ref{Bugs}.
29020 If you do use differing options when generating and using the
29021 precompiled header, the actual behavior is a mixture of the
29022 behavior for the options.  For instance, if you use @option{-g} to
29023 generate the precompiled header but not when using it, you may or may
29024 not get debugging information for routines in the precompiled header.