Remove unused variable
[official-gcc.git] / gcc / doc / invoke.texi
blobc6025382dbb8349ed5cec63c559276a4776254f1
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gstatement-frontiers  -gno-statement-frontiers @gol
350 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
351 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
352 -fno-eliminate-unused-debug-types @gol
353 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
354 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
355 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
356 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
357 -fvar-tracking  -fvar-tracking-assignments}
359 @item Optimization Options
360 @xref{Optimize Options,,Options that Control Optimization}.
361 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
362 -falign-jumps[=@var{n}] @gol
363 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
364 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
365 -fauto-inc-dec  -fbranch-probabilities @gol
366 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
367 -fbtr-bb-exclusive  -fcaller-saves @gol
368 -fcombine-stack-adjustments  -fconserve-stack @gol
369 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
370 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
371 -fcx-limited-range @gol
372 -fdata-sections  -fdce  -fdelayed-branch @gol
373 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
374 -fdevirtualize-at-ltrans  -fdse @gol
375 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
376 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
377 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
378 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
379 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
380 -fif-conversion2  -findirect-inlining @gol
381 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
382 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
383 -fipa-bit-cp -fipa-vrp @gol
384 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
385 -fira-algorithm=@var{algorithm} @gol
386 -fira-region=@var{region}  -fira-hoist-pressure @gol
387 -fira-loop-pressure  -fno-ira-share-save-slots @gol
388 -fno-ira-share-spill-slots @gol
389 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
390 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
391 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
392 -floop-block  -floop-interchange  -floop-strip-mine @gol
393 -floop-unroll-and-jam  -floop-nest-optimize @gol
394 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
395 -flto-partition=@var{alg}  -fmerge-all-constants @gol
396 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
397 -fmove-loop-invariants  -fno-branch-count-reg @gol
398 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
399 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
400 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
401 -fno-sched-spec  -fno-signed-zeros @gol
402 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
403 -fomit-frame-pointer  -foptimize-sibling-calls @gol
404 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
405 -fprefetch-loop-arrays @gol
406 -fprofile-correction @gol
407 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
408 -fprofile-reorder-functions @gol
409 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
410 -freorder-blocks-algorithm=@var{algorithm} @gol
411 -freorder-blocks-and-partition  -freorder-functions @gol
412 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
413 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
414 -fsched-spec-load  -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
419 -fschedule-fusion @gol
420 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
421 -fselective-scheduling  -fselective-scheduling2 @gol
422 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
424 -fsignaling-nans @gol
425 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
426 -fsplit-paths @gol
427 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
428 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
429 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
431 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
432 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
433 -ftree-loop-if-convert  -ftree-loop-im @gol
434 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
438 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
439 -ftree-switch-conversion  -ftree-tail-merge @gol
440 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
441 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
442 -funsafe-math-optimizations  -funswitch-loops @gol
443 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
444 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
448 @item Program Instrumentation Options
449 @xref{Instrumentation Options,,Program Instrumentation Options}.
450 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
451 -fprofile-abs-path @gol
452 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
453 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
454 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
455 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
456 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
457 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
458 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
459 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
460 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
461 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
462 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
463 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
464 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
465 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
466 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
467 -fstack-protector-explicit  -fstack-check @gol
468 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
469 -fno-stack-limit  -fsplit-stack @gol
470 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
471 -fvtv-counts  -fvtv-debug @gol
472 -finstrument-functions @gol
473 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
474 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
476 @item Preprocessor Options
477 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
478 @gccoptlist{-A@var{question}=@var{answer} @gol
479 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
480 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
481 -dD  -dI  -dM  -dN  -dU @gol
482 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
483 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
484 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
485 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
486 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
487 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
488 -H  -imacros @var{file}  -include @var{file} @gol
489 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
490 -no-integrated-cpp  -P  -pthread  -remap @gol
491 -traditional  -traditional-cpp  -trigraphs @gol
492 -U@var{macro}  -undef  @gol
493 -Wp,@var{option}  -Xpreprocessor @var{option}}
495 @item Assembler Options
496 @xref{Assembler Options,,Passing Options to the Assembler}.
497 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
499 @item Linker Options
500 @xref{Link Options,,Options for Linking}.
501 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
502 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
503 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
504 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
505 -static-libmpx  -static-libmpxwrappers @gol
506 -shared  -shared-libgcc  -symbolic @gol
507 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
508 -u @var{symbol}  -z @var{keyword}}
510 @item Directory Options
511 @xref{Directory Options,,Options for Directory Search}.
512 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
513 -idirafter @var{dir} @gol
514 -imacros @var{file}  -imultilib @var{dir} @gol
515 -iplugindir=@var{dir}  -iprefix @var{file} @gol
516 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
517 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
518 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
519 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
521 @item Code Generation Options
522 @xref{Code Gen Options,,Options for Code Generation Conventions}.
523 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
524 -ffixed-@var{reg}  -fexceptions @gol
525 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
526 -fasynchronous-unwind-tables @gol
527 -fno-gnu-unique @gol
528 -finhibit-size-directive  -fno-common  -fno-ident @gol
529 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
530 -fno-jump-tables @gol
531 -frecord-gcc-switches @gol
532 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
533 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
534 -fleading-underscore  -ftls-model=@var{model} @gol
535 -fstack-reuse=@var{reuse_level} @gol
536 -ftrampolines  -ftrapv  -fwrapv @gol
537 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
538 -fstrict-volatile-bitfields  -fsync-libcalls}
540 @item Developer Options
541 @xref{Developer Options,,GCC Developer Options}.
542 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
543 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
544 -fdbg-cnt=@var{counter-value-list} @gol
545 -fdisable-ipa-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass_name} @gol
547 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
548 -fdisable-tree-@var{pass_name} @gol
549 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
550 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
551 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
552 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
553 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
554 -fdump-lang-all @gol
555 -fdump-lang-@var{switch} @gol
556 -fdump-lang-@var{switch}-@var{options} @gol
557 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
558 -fdump-passes @gol
559 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
560 -fdump-statistics @gol
561 -fdump-tree-all @gol
562 -fdump-tree-@var{switch} @gol
563 -fdump-tree-@var{switch}-@var{options} @gol
564 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
565 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
566 -fenable-@var{kind}-@var{pass} @gol
567 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
568 -fira-verbose=@var{n} @gol
569 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
570 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
571 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
572 -fprofile-report @gol
573 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
574 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
575 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
576 -fvar-tracking-assignments-toggle  -gtoggle @gol
577 -print-file-name=@var{library}  -print-libgcc-file-name @gol
578 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
579 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
580 -print-sysroot  -print-sysroot-headers-suffix @gol
581 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
583 @item Machine-Dependent Options
584 @xref{Submodel Options,,Machine-Dependent Options}.
585 @c This list is ordered alphanumerically by subsection name.
586 @c Try and put the significant identifier (CPU or system) first,
587 @c so users have a clue at guessing where the ones they want will be.
589 @emph{AArch64 Options}
590 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
591 -mgeneral-regs-only @gol
592 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
593 -mstrict-align @gol
594 -momit-leaf-frame-pointer @gol
595 -mtls-dialect=desc  -mtls-dialect=traditional @gol
596 -mtls-size=@var{size} @gol
597 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
598 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
599 -mpc-relative-literal-loads @gol
600 -msign-return-address=@var{scope} @gol
601 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
602 -moverride=@var{string}  -mverbose-cost-dump}
604 @emph{Adapteva Epiphany Options}
605 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
606 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
607 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
608 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
609 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
610 -msplit-vecmove-early  -m1reg-@var{reg}}
612 @emph{ARC Options}
613 @gccoptlist{-mbarrel-shifter @gol
614 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
615 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
616 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
617 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
618 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
619 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
620 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
621 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
622 -mvolatile-cache  -mtp-regno=@var{regno} @gol
623 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
624 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
625 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
626 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
627 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
628 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
629 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
630 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
632 @emph{ARM Options}
633 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
634 -mabi=@var{name} @gol
635 -mapcs-stack-check  -mno-apcs-stack-check @gol
636 -mapcs-reentrant  -mno-apcs-reentrant @gol
637 -msched-prolog  -mno-sched-prolog @gol
638 -mlittle-endian  -mbig-endian @gol
639 -mbe8 -mbe32 @gol
640 -mfloat-abi=@var{name} @gol
641 -mfp16-format=@var{name}
642 -mthumb-interwork  -mno-thumb-interwork @gol
643 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
644 -mtune=@var{name}  -mprint-tune-info @gol
645 -mstructure-size-boundary=@var{n} @gol
646 -mabort-on-noreturn @gol
647 -mlong-calls  -mno-long-calls @gol
648 -msingle-pic-base  -mno-single-pic-base @gol
649 -mpic-register=@var{reg} @gol
650 -mnop-fun-dllimport @gol
651 -mpoke-function-name @gol
652 -mthumb  -marm  -mflip-thumb @gol
653 -mtpcs-frame  -mtpcs-leaf-frame @gol
654 -mcaller-super-interworking  -mcallee-super-interworking @gol
655 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
656 -mword-relocations @gol
657 -mfix-cortex-m3-ldrd @gol
658 -munaligned-access @gol
659 -mneon-for-64bits @gol
660 -mslow-flash-data @gol
661 -masm-syntax-unified @gol
662 -mrestrict-it @gol
663 -mverbose-cost-dump @gol
664 -mpure-code @gol
665 -mcmse}
667 @emph{AVR Options}
668 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
669 -mbranch-cost=@var{cost} @gol
670 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
671 -mn_flash=@var{size}  -mno-interrupts @gol
672 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
673 -mshort-calls  -nodevicelib @gol
674 -Waddr-space-convert  -Wmisspelled-isr}
676 @emph{Blackfin Options}
677 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
678 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
679 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
680 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
681 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
682 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
683 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
684 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
685 -micplb}
687 @emph{C6X Options}
688 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
689 -msim  -msdata=@var{sdata-type}}
691 @emph{CRIS Options}
692 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
693 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
694 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
695 -mstack-align  -mdata-align  -mconst-align @gol
696 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
697 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
698 -mmul-bug-workaround  -mno-mul-bug-workaround}
700 @emph{CR16 Options}
701 @gccoptlist{-mmac @gol
702 -mcr16cplus  -mcr16c @gol
703 -msim  -mint32  -mbit-ops
704 -mdata-model=@var{model}}
706 @emph{Darwin Options}
707 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
708 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
709 -client_name  -compatibility_version  -current_version @gol
710 -dead_strip @gol
711 -dependency-file  -dylib_file  -dylinker_install_name @gol
712 -dynamic  -dynamiclib  -exported_symbols_list @gol
713 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
714 -force_flat_namespace  -headerpad_max_install_names @gol
715 -iframework @gol
716 -image_base  -init  -install_name  -keep_private_externs @gol
717 -multi_module  -multiply_defined  -multiply_defined_unused @gol
718 -noall_load   -no_dead_strip_inits_and_terms @gol
719 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
720 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
721 -private_bundle  -read_only_relocs  -sectalign @gol
722 -sectobjectsymbols  -whyload  -seg1addr @gol
723 -sectcreate  -sectobjectsymbols  -sectorder @gol
724 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
725 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
726 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
727 -single_module  -static  -sub_library  -sub_umbrella @gol
728 -twolevel_namespace  -umbrella  -undefined @gol
729 -unexported_symbols_list  -weak_reference_mismatches @gol
730 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
731 -mkernel  -mone-byte-bool}
733 @emph{DEC Alpha Options}
734 @gccoptlist{-mno-fp-regs  -msoft-float @gol
735 -mieee  -mieee-with-inexact  -mieee-conformant @gol
736 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
737 -mtrap-precision=@var{mode}  -mbuild-constants @gol
738 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
739 -mbwx  -mmax  -mfix  -mcix @gol
740 -mfloat-vax  -mfloat-ieee @gol
741 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
742 -msmall-text  -mlarge-text @gol
743 -mmemory-latency=@var{time}}
745 @emph{FR30 Options}
746 @gccoptlist{-msmall-model  -mno-lsim}
748 @emph{FT32 Options}
749 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
751 @emph{FRV Options}
752 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
753 -mhard-float  -msoft-float @gol
754 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
755 -mdouble  -mno-double @gol
756 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
757 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
758 -mlinked-fp  -mlong-calls  -malign-labels @gol
759 -mlibrary-pic  -macc-4  -macc-8 @gol
760 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
761 -moptimize-membar  -mno-optimize-membar @gol
762 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
763 -mvliw-branch  -mno-vliw-branch @gol
764 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
765 -mno-nested-cond-exec  -mtomcat-stats @gol
766 -mTLS  -mtls @gol
767 -mcpu=@var{cpu}}
769 @emph{GNU/Linux Options}
770 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
771 -tno-android-cc  -tno-android-ld}
773 @emph{H8/300 Options}
774 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
776 @emph{HPPA Options}
777 @gccoptlist{-march=@var{architecture-type} @gol
778 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
779 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
780 -mfixed-range=@var{register-range} @gol
781 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
782 -mlong-load-store  -mno-disable-fpregs @gol
783 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
784 -mno-jump-in-delay  -mno-long-load-store @gol
785 -mno-portable-runtime  -mno-soft-float @gol
786 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
787 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
788 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
789 -munix=@var{unix-std}  -nolibdld  -static  -threads}
791 @emph{IA-64 Options}
792 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
793 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
794 -mconstant-gp  -mauto-pic  -mfused-madd @gol
795 -minline-float-divide-min-latency @gol
796 -minline-float-divide-max-throughput @gol
797 -mno-inline-float-divide @gol
798 -minline-int-divide-min-latency @gol
799 -minline-int-divide-max-throughput  @gol
800 -mno-inline-int-divide @gol
801 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
802 -mno-inline-sqrt @gol
803 -mdwarf2-asm  -mearly-stop-bits @gol
804 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
805 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
806 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
807 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
808 -msched-spec-ldc  -msched-spec-control-ldc @gol
809 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
810 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
811 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
812 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
814 @emph{LM32 Options}
815 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
816 -msign-extend-enabled  -muser-enabled}
818 @emph{M32R/D Options}
819 @gccoptlist{-m32r2  -m32rx  -m32r @gol
820 -mdebug @gol
821 -malign-loops  -mno-align-loops @gol
822 -missue-rate=@var{number} @gol
823 -mbranch-cost=@var{number} @gol
824 -mmodel=@var{code-size-model-type} @gol
825 -msdata=@var{sdata-type} @gol
826 -mno-flush-func  -mflush-func=@var{name} @gol
827 -mno-flush-trap  -mflush-trap=@var{number} @gol
828 -G @var{num}}
830 @emph{M32C Options}
831 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
833 @emph{M680x0 Options}
834 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
835 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
836 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
837 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
838 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
839 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
840 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
841 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
842 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
844 @emph{MCore Options}
845 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
846 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
847 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
848 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
849 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
851 @emph{MeP Options}
852 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
853 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
854 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
855 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
856 -mtiny=@var{n}}
858 @emph{MicroBlaze Options}
859 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
860 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
861 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
862 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
863 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
865 @emph{MIPS Options}
866 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
867 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
868 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
869 -mips16  -mno-mips16  -mflip-mips16 @gol
870 -minterlink-compressed  -mno-interlink-compressed @gol
871 -minterlink-mips16  -mno-interlink-mips16 @gol
872 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
873 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
874 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
875 -mno-float  -msingle-float  -mdouble-float @gol
876 -modd-spreg  -mno-odd-spreg @gol
877 -mabs=@var{mode}  -mnan=@var{encoding} @gol
878 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
879 -mmcu  -mmno-mcu @gol
880 -meva  -mno-eva @gol
881 -mvirt  -mno-virt @gol
882 -mxpa  -mno-xpa @gol
883 -mmicromips  -mno-micromips @gol
884 -mmsa  -mno-msa @gol
885 -mfpu=@var{fpu-type} @gol
886 -msmartmips  -mno-smartmips @gol
887 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
888 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
889 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
890 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
891 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
892 -membedded-data  -mno-embedded-data @gol
893 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
894 -mcode-readable=@var{setting} @gol
895 -msplit-addresses  -mno-split-addresses @gol
896 -mexplicit-relocs  -mno-explicit-relocs @gol
897 -mcheck-zero-division  -mno-check-zero-division @gol
898 -mdivide-traps  -mdivide-breaks @gol
899 -mload-store-pairs  -mno-load-store-pairs @gol
900 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
901 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
902 -mfix-24k  -mno-fix-24k @gol
903 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
904 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
905 -mfix-vr4120  -mno-fix-vr4120 @gol
906 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
907 -mflush-func=@var{func}  -mno-flush-func @gol
908 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
909 -mcompact-branches=@var{policy} @gol
910 -mfp-exceptions  -mno-fp-exceptions @gol
911 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
912 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
913 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
914 -mframe-header-opt  -mno-frame-header-opt}
916 @emph{MMIX Options}
917 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
918 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
919 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
920 -mno-base-addresses  -msingle-exit  -mno-single-exit}
922 @emph{MN10300 Options}
923 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
924 -mno-am33  -mam33  -mam33-2  -mam34 @gol
925 -mtune=@var{cpu-type} @gol
926 -mreturn-pointer-on-d0 @gol
927 -mno-crt0  -mrelax  -mliw  -msetlb}
929 @emph{Moxie Options}
930 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
932 @emph{MSP430 Options}
933 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
934 -mwarn-mcu @gol
935 -mcode-region=  -mdata-region= @gol
936 -msilicon-errata=  -msilicon-errata-warn= @gol
937 -mhwmult=  -minrt}
939 @emph{NDS32 Options}
940 @gccoptlist{-mbig-endian  -mlittle-endian @gol
941 -mreduced-regs  -mfull-regs @gol
942 -mcmov  -mno-cmov @gol
943 -mperf-ext  -mno-perf-ext @gol
944 -mv3push  -mno-v3push @gol
945 -m16bit  -mno-16bit @gol
946 -misr-vector-size=@var{num} @gol
947 -mcache-block-size=@var{num} @gol
948 -march=@var{arch} @gol
949 -mcmodel=@var{code-model} @gol
950 -mctor-dtor  -mrelax}
952 @emph{Nios II Options}
953 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
954 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
955 -mel  -meb @gol
956 -mno-bypass-cache  -mbypass-cache @gol
957 -mno-cache-volatile  -mcache-volatile @gol
958 -mno-fast-sw-div  -mfast-sw-div @gol
959 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
960 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
961 -mcustom-fpu-cfg=@var{name} @gol
962 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
963 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
965 @emph{Nvidia PTX Options}
966 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
968 @emph{PDP-11 Options}
969 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
970 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
971 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
972 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
973 -mbranch-expensive  -mbranch-cheap @gol
974 -munix-asm  -mdec-asm}
976 @emph{picoChip Options}
977 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
978 -msymbol-as-address  -mno-inefficient-warnings}
980 @emph{PowerPC Options}
981 See RS/6000 and PowerPC Options.
983 @emph{RISC-V Options}
984 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
985 -mplt  -mno-plt @gol
986 -mabi=@var{ABI-string} @gol
987 -mfdiv  -mno-fdiv @gol
988 -mdiv  -mno-div @gol
989 -march=@var{ISA-string} @gol
990 -mtune=@var{processor-string} @gol
991 -msmall-data-limit=@var{N-bytes} @gol
992 -msave-restore  -mno-save-restore @gol
993 -mstrict-align -mno-strict-align @gol
994 -mcmodel=medlow -mcmodel=medany @gol
995 -mexplicit-relocs  -mno-explicit-relocs @gol}
997 @emph{RL78 Options}
998 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
999 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1000 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1002 @emph{RS/6000 and PowerPC Options}
1003 @gccoptlist{-mcpu=@var{cpu-type} @gol
1004 -mtune=@var{cpu-type} @gol
1005 -mcmodel=@var{code-model} @gol
1006 -mpowerpc64 @gol
1007 -maltivec  -mno-altivec @gol
1008 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1009 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1010 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1011 -mfprnd  -mno-fprnd @gol
1012 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1013 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1014 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1015 -malign-power  -malign-natural @gol
1016 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1017 -msingle-float  -mdouble-float  -msimple-fpu @gol
1018 -mstring  -mno-string  -mupdate  -mno-update @gol
1019 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1020 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1021 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1022 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1023 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1024 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1025 -mprioritize-restricted-insns=@var{priority} @gol
1026 -msched-costly-dep=@var{dependence_type} @gol
1027 -minsert-sched-nops=@var{scheme} @gol
1028 -mcall-sysv  -mcall-netbsd @gol
1029 -maix-struct-return  -msvr4-struct-return @gol
1030 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1031 -mblock-move-inline-limit=@var{num} @gol
1032 -misel  -mno-isel @gol
1033 -misel=yes  -misel=no @gol
1034 -mspe  -mno-spe @gol
1035 -mspe=yes  -mspe=no @gol
1036 -mpaired @gol
1037 -mvrsave  -mno-vrsave @gol
1038 -mmulhw  -mno-mulhw @gol
1039 -mdlmzb  -mno-dlmzb @gol
1040 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1041 -mprototype  -mno-prototype @gol
1042 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1043 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1044 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1045 -mno-recip-precision @gol
1046 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1047 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1048 -msave-toc-indirect  -mno-save-toc-indirect @gol
1049 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1050 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1051 -mquad-memory  -mno-quad-memory @gol
1052 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1053 -mcompat-align-parm  -mno-compat-align-parm @gol
1054 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1055 -mgnu-attribute  -mno-gnu-attribute @gol
1056 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1057 -mstack-protector-guard-offset=@var{offset}}
1059 @emph{RX Options}
1060 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1061 -mcpu=@gol
1062 -mbig-endian-data  -mlittle-endian-data @gol
1063 -msmall-data @gol
1064 -msim  -mno-sim@gol
1065 -mas100-syntax  -mno-as100-syntax@gol
1066 -mrelax@gol
1067 -mmax-constant-size=@gol
1068 -mint-register=@gol
1069 -mpid@gol
1070 -mallow-string-insns  -mno-allow-string-insns@gol
1071 -mjsr@gol
1072 -mno-warn-multiple-fast-interrupts@gol
1073 -msave-acc-in-interrupts}
1075 @emph{S/390 and zSeries Options}
1076 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1077 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1078 -mlong-double-64  -mlong-double-128 @gol
1079 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1080 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1081 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1082 -mhtm  -mvx  -mzvector @gol
1083 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1084 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1085 -mhotpatch=@var{halfwords},@var{halfwords}}
1087 @emph{Score Options}
1088 @gccoptlist{-meb  -mel @gol
1089 -mnhwloop @gol
1090 -muls @gol
1091 -mmac @gol
1092 -mscore5  -mscore5u  -mscore7  -mscore7d}
1094 @emph{SH Options}
1095 @gccoptlist{-m1  -m2  -m2e @gol
1096 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1097 -m3  -m3e @gol
1098 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1099 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1100 -mb  -ml  -mdalign  -mrelax @gol
1101 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1102 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1103 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1104 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1105 -maccumulate-outgoing-args @gol
1106 -matomic-model=@var{atomic-model} @gol
1107 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1108 -mcbranch-force-delay-slot @gol
1109 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1110 -mpretend-cmove  -mtas}
1112 @emph{Solaris 2 Options}
1113 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1114 -pthreads}
1116 @emph{SPARC Options}
1117 @gccoptlist{-mcpu=@var{cpu-type} @gol
1118 -mtune=@var{cpu-type} @gol
1119 -mcmodel=@var{code-model} @gol
1120 -mmemory-model=@var{mem-model} @gol
1121 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1122 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1123 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1124 -mhard-quad-float  -msoft-quad-float @gol
1125 -mstack-bias  -mno-stack-bias @gol
1126 -mstd-struct-return  -mno-std-struct-return @gol
1127 -munaligned-doubles  -mno-unaligned-doubles @gol
1128 -muser-mode  -mno-user-mode @gol
1129 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1130 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1131 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1132 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1133 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1134 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1135 -mlra  -mno-lra}
1137 @emph{SPU Options}
1138 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1139 -msafe-dma  -munsafe-dma @gol
1140 -mbranch-hints @gol
1141 -msmall-mem  -mlarge-mem  -mstdmain @gol
1142 -mfixed-range=@var{register-range} @gol
1143 -mea32  -mea64 @gol
1144 -maddress-space-conversion  -mno-address-space-conversion @gol
1145 -mcache-size=@var{cache-size} @gol
1146 -matomic-updates  -mno-atomic-updates}
1148 @emph{System V Options}
1149 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1151 @emph{TILE-Gx Options}
1152 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1153 -mcmodel=@var{code-model}}
1155 @emph{TILEPro Options}
1156 @gccoptlist{-mcpu=@var{cpu}  -m32}
1158 @emph{V850 Options}
1159 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1160 -mprolog-function  -mno-prolog-function  -mspace @gol
1161 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1162 -mapp-regs  -mno-app-regs @gol
1163 -mdisable-callt  -mno-disable-callt @gol
1164 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1165 -mv850e  -mv850  -mv850e3v5 @gol
1166 -mloop @gol
1167 -mrelax @gol
1168 -mlong-jumps @gol
1169 -msoft-float @gol
1170 -mhard-float @gol
1171 -mgcc-abi @gol
1172 -mrh850-abi @gol
1173 -mbig-switch}
1175 @emph{VAX Options}
1176 @gccoptlist{-mg  -mgnu  -munix}
1178 @emph{Visium Options}
1179 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1180 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1182 @emph{VMS Options}
1183 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1184 -mpointer-size=@var{size}}
1186 @emph{VxWorks Options}
1187 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1188 -Xbind-lazy  -Xbind-now}
1190 @emph{x86 Options}
1191 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1192 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1193 -mfpmath=@var{unit} @gol
1194 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1195 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1196 -mno-wide-multiply  -mrtd  -malign-double @gol
1197 -mpreferred-stack-boundary=@var{num} @gol
1198 -mincoming-stack-boundary=@var{num} @gol
1199 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1200 -mrecip  -mrecip=@var{opt} @gol
1201 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1202 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1203 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1204 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1205 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1206 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1207 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1208 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1209 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1210 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1211 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1212 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1213 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1214 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1215 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1216 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1217 -mregparm=@var{num}  -msseregparm @gol
1218 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1219 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1220 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1221 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1222 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1223 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1224 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1225 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1226 -mstack-protector-guard-reg=@var{reg} @gol
1227 -mstack-protector-guard-offset=@var{offset} @gol
1228 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1229 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1231 @emph{x86 Windows Options}
1232 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1233 -mnop-fun-dllimport  -mthread @gol
1234 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1236 @emph{Xstormy16 Options}
1237 @gccoptlist{-msim}
1239 @emph{Xtensa Options}
1240 @gccoptlist{-mconst16  -mno-const16 @gol
1241 -mfused-madd  -mno-fused-madd @gol
1242 -mforce-no-pic @gol
1243 -mserialize-volatile  -mno-serialize-volatile @gol
1244 -mtext-section-literals  -mno-text-section-literals @gol
1245 -mauto-litpools  -mno-auto-litpools @gol
1246 -mtarget-align  -mno-target-align @gol
1247 -mlongcalls  -mno-longcalls}
1249 @emph{zSeries Options}
1250 See S/390 and zSeries Options.
1251 @end table
1254 @node Overall Options
1255 @section Options Controlling the Kind of Output
1257 Compilation can involve up to four stages: preprocessing, compilation
1258 proper, assembly and linking, always in that order.  GCC is capable of
1259 preprocessing and compiling several files either into several
1260 assembler input files, or into one assembler input file; then each
1261 assembler input file produces an object file, and linking combines all
1262 the object files (those newly compiled, and those specified as input)
1263 into an executable file.
1265 @cindex file name suffix
1266 For any given input file, the file name suffix determines what kind of
1267 compilation is done:
1269 @table @gcctabopt
1270 @item @var{file}.c
1271 C source code that must be preprocessed.
1273 @item @var{file}.i
1274 C source code that should not be preprocessed.
1276 @item @var{file}.ii
1277 C++ source code that should not be preprocessed.
1279 @item @var{file}.m
1280 Objective-C source code.  Note that you must link with the @file{libobjc}
1281 library to make an Objective-C program work.
1283 @item @var{file}.mi
1284 Objective-C source code that should not be preprocessed.
1286 @item @var{file}.mm
1287 @itemx @var{file}.M
1288 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1289 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1290 to a literal capital M@.
1292 @item @var{file}.mii
1293 Objective-C++ source code that should not be preprocessed.
1295 @item @var{file}.h
1296 C, C++, Objective-C or Objective-C++ header file to be turned into a
1297 precompiled header (default), or C, C++ header file to be turned into an
1298 Ada spec (via the @option{-fdump-ada-spec} switch).
1300 @item @var{file}.cc
1301 @itemx @var{file}.cp
1302 @itemx @var{file}.cxx
1303 @itemx @var{file}.cpp
1304 @itemx @var{file}.CPP
1305 @itemx @var{file}.c++
1306 @itemx @var{file}.C
1307 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1308 the last two letters must both be literally @samp{x}.  Likewise,
1309 @samp{.C} refers to a literal capital C@.
1311 @item @var{file}.mm
1312 @itemx @var{file}.M
1313 Objective-C++ source code that must be preprocessed.
1315 @item @var{file}.mii
1316 Objective-C++ source code that should not be preprocessed.
1318 @item @var{file}.hh
1319 @itemx @var{file}.H
1320 @itemx @var{file}.hp
1321 @itemx @var{file}.hxx
1322 @itemx @var{file}.hpp
1323 @itemx @var{file}.HPP
1324 @itemx @var{file}.h++
1325 @itemx @var{file}.tcc
1326 C++ header file to be turned into a precompiled header or Ada spec.
1328 @item @var{file}.f
1329 @itemx @var{file}.for
1330 @itemx @var{file}.ftn
1331 Fixed form Fortran source code that should not be preprocessed.
1333 @item @var{file}.F
1334 @itemx @var{file}.FOR
1335 @itemx @var{file}.fpp
1336 @itemx @var{file}.FPP
1337 @itemx @var{file}.FTN
1338 Fixed form Fortran source code that must be preprocessed (with the traditional
1339 preprocessor).
1341 @item @var{file}.f90
1342 @itemx @var{file}.f95
1343 @itemx @var{file}.f03
1344 @itemx @var{file}.f08
1345 Free form Fortran source code that should not be preprocessed.
1347 @item @var{file}.F90
1348 @itemx @var{file}.F95
1349 @itemx @var{file}.F03
1350 @itemx @var{file}.F08
1351 Free form Fortran source code that must be preprocessed (with the
1352 traditional preprocessor).
1354 @item @var{file}.go
1355 Go source code.
1357 @item @var{file}.brig
1358 BRIG files (binary representation of HSAIL).
1360 @item @var{file}.ads
1361 Ada source code file that contains a library unit declaration (a
1362 declaration of a package, subprogram, or generic, or a generic
1363 instantiation), or a library unit renaming declaration (a package,
1364 generic, or subprogram renaming declaration).  Such files are also
1365 called @dfn{specs}.
1367 @item @var{file}.adb
1368 Ada source code file containing a library unit body (a subprogram or
1369 package body).  Such files are also called @dfn{bodies}.
1371 @c GCC also knows about some suffixes for languages not yet included:
1372 @c Pascal:
1373 @c @var{file}.p
1374 @c @var{file}.pas
1375 @c Ratfor:
1376 @c @var{file}.r
1378 @item @var{file}.s
1379 Assembler code.
1381 @item @var{file}.S
1382 @itemx @var{file}.sx
1383 Assembler code that must be preprocessed.
1385 @item @var{other}
1386 An object file to be fed straight into linking.
1387 Any file name with no recognized suffix is treated this way.
1388 @end table
1390 @opindex x
1391 You can specify the input language explicitly with the @option{-x} option:
1393 @table @gcctabopt
1394 @item -x @var{language}
1395 Specify explicitly the @var{language} for the following input files
1396 (rather than letting the compiler choose a default based on the file
1397 name suffix).  This option applies to all following input files until
1398 the next @option{-x} option.  Possible values for @var{language} are:
1399 @smallexample
1400 c  c-header  cpp-output
1401 c++  c++-header  c++-cpp-output
1402 objective-c  objective-c-header  objective-c-cpp-output
1403 objective-c++ objective-c++-header objective-c++-cpp-output
1404 assembler  assembler-with-cpp
1406 f77  f77-cpp-input f95  f95-cpp-input
1408 brig
1409 @end smallexample
1411 @item -x none
1412 Turn off any specification of a language, so that subsequent files are
1413 handled according to their file name suffixes (as they are if @option{-x}
1414 has not been used at all).
1415 @end table
1417 If you only want some of the stages of compilation, you can use
1418 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1419 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1420 @command{gcc} is to stop.  Note that some combinations (for example,
1421 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1423 @table @gcctabopt
1424 @item -c
1425 @opindex c
1426 Compile or assemble the source files, but do not link.  The linking
1427 stage simply is not done.  The ultimate output is in the form of an
1428 object file for each source file.
1430 By default, the object file name for a source file is made by replacing
1431 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1433 Unrecognized input files, not requiring compilation or assembly, are
1434 ignored.
1436 @item -S
1437 @opindex S
1438 Stop after the stage of compilation proper; do not assemble.  The output
1439 is in the form of an assembler code file for each non-assembler input
1440 file specified.
1442 By default, the assembler file name for a source file is made by
1443 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1445 Input files that don't require compilation are ignored.
1447 @item -E
1448 @opindex E
1449 Stop after the preprocessing stage; do not run the compiler proper.  The
1450 output is in the form of preprocessed source code, which is sent to the
1451 standard output.
1453 Input files that don't require preprocessing are ignored.
1455 @cindex output file option
1456 @item -o @var{file}
1457 @opindex o
1458 Place output in file @var{file}.  This applies to whatever
1459 sort of output is being produced, whether it be an executable file,
1460 an object file, an assembler file or preprocessed C code.
1462 If @option{-o} is not specified, the default is to put an executable
1463 file in @file{a.out}, the object file for
1464 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1465 assembler file in @file{@var{source}.s}, a precompiled header file in
1466 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1467 standard output.
1469 @item -v
1470 @opindex v
1471 Print (on standard error output) the commands executed to run the stages
1472 of compilation.  Also print the version number of the compiler driver
1473 program and of the preprocessor and the compiler proper.
1475 @item -###
1476 @opindex ###
1477 Like @option{-v} except the commands are not executed and arguments
1478 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1479 This is useful for shell scripts to capture the driver-generated command lines.
1481 @item --help
1482 @opindex help
1483 Print (on the standard output) a description of the command-line options
1484 understood by @command{gcc}.  If the @option{-v} option is also specified
1485 then @option{--help} is also passed on to the various processes
1486 invoked by @command{gcc}, so that they can display the command-line options
1487 they accept.  If the @option{-Wextra} option has also been specified
1488 (prior to the @option{--help} option), then command-line options that
1489 have no documentation associated with them are also displayed.
1491 @item --target-help
1492 @opindex target-help
1493 Print (on the standard output) a description of target-specific command-line
1494 options for each tool.  For some targets extra target-specific
1495 information may also be printed.
1497 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1498 Print (on the standard output) a description of the command-line
1499 options understood by the compiler that fit into all specified classes
1500 and qualifiers.  These are the supported classes:
1502 @table @asis
1503 @item @samp{optimizers}
1504 Display all of the optimization options supported by the
1505 compiler.
1507 @item @samp{warnings}
1508 Display all of the options controlling warning messages
1509 produced by the compiler.
1511 @item @samp{target}
1512 Display target-specific options.  Unlike the
1513 @option{--target-help} option however, target-specific options of the
1514 linker and assembler are not displayed.  This is because those
1515 tools do not currently support the extended @option{--help=} syntax.
1517 @item @samp{params}
1518 Display the values recognized by the @option{--param}
1519 option.
1521 @item @var{language}
1522 Display the options supported for @var{language}, where
1523 @var{language} is the name of one of the languages supported in this
1524 version of GCC@.
1526 @item @samp{common}
1527 Display the options that are common to all languages.
1528 @end table
1530 These are the supported qualifiers:
1532 @table @asis
1533 @item @samp{undocumented}
1534 Display only those options that are undocumented.
1536 @item @samp{joined}
1537 Display options taking an argument that appears after an equal
1538 sign in the same continuous piece of text, such as:
1539 @samp{--help=target}.
1541 @item @samp{separate}
1542 Display options taking an argument that appears as a separate word
1543 following the original option, such as: @samp{-o output-file}.
1544 @end table
1546 Thus for example to display all the undocumented target-specific
1547 switches supported by the compiler, use:
1549 @smallexample
1550 --help=target,undocumented
1551 @end smallexample
1553 The sense of a qualifier can be inverted by prefixing it with the
1554 @samp{^} character, so for example to display all binary warning
1555 options (i.e., ones that are either on or off and that do not take an
1556 argument) that have a description, use:
1558 @smallexample
1559 --help=warnings,^joined,^undocumented
1560 @end smallexample
1562 The argument to @option{--help=} should not consist solely of inverted
1563 qualifiers.
1565 Combining several classes is possible, although this usually
1566 restricts the output so much that there is nothing to display.  One
1567 case where it does work, however, is when one of the classes is
1568 @var{target}.  For example, to display all the target-specific
1569 optimization options, use:
1571 @smallexample
1572 --help=target,optimizers
1573 @end smallexample
1575 The @option{--help=} option can be repeated on the command line.  Each
1576 successive use displays its requested class of options, skipping
1577 those that have already been displayed.
1579 If the @option{-Q} option appears on the command line before the
1580 @option{--help=} option, then the descriptive text displayed by
1581 @option{--help=} is changed.  Instead of describing the displayed
1582 options, an indication is given as to whether the option is enabled,
1583 disabled or set to a specific value (assuming that the compiler
1584 knows this at the point where the @option{--help=} option is used).
1586 Here is a truncated example from the ARM port of @command{gcc}:
1588 @smallexample
1589   % gcc -Q -mabi=2 --help=target -c
1590   The following options are target specific:
1591   -mabi=                                2
1592   -mabort-on-noreturn                   [disabled]
1593   -mapcs                                [disabled]
1594 @end smallexample
1596 The output is sensitive to the effects of previous command-line
1597 options, so for example it is possible to find out which optimizations
1598 are enabled at @option{-O2} by using:
1600 @smallexample
1601 -Q -O2 --help=optimizers
1602 @end smallexample
1604 Alternatively you can discover which binary optimizations are enabled
1605 by @option{-O3} by using:
1607 @smallexample
1608 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1609 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1610 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1611 @end smallexample
1613 @item --version
1614 @opindex version
1615 Display the version number and copyrights of the invoked GCC@.
1617 @item -pass-exit-codes
1618 @opindex pass-exit-codes
1619 Normally the @command{gcc} program exits with the code of 1 if any
1620 phase of the compiler returns a non-success return code.  If you specify
1621 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1622 the numerically highest error produced by any phase returning an error
1623 indication.  The C, C++, and Fortran front ends return 4 if an internal
1624 compiler error is encountered.
1626 @item -pipe
1627 @opindex pipe
1628 Use pipes rather than temporary files for communication between the
1629 various stages of compilation.  This fails to work on some systems where
1630 the assembler is unable to read from a pipe; but the GNU assembler has
1631 no trouble.
1633 @item -specs=@var{file}
1634 @opindex specs
1635 Process @var{file} after the compiler reads in the standard @file{specs}
1636 file, in order to override the defaults which the @command{gcc} driver
1637 program uses when determining what switches to pass to @command{cc1},
1638 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1639 @option{-specs=@var{file}} can be specified on the command line, and they
1640 are processed in order, from left to right.  @xref{Spec Files}, for
1641 information about the format of the @var{file}.
1643 @item -wrapper
1644 @opindex wrapper
1645 Invoke all subcommands under a wrapper program.  The name of the
1646 wrapper program and its parameters are passed as a comma separated
1647 list.
1649 @smallexample
1650 gcc -c t.c -wrapper gdb,--args
1651 @end smallexample
1653 @noindent
1654 This invokes all subprograms of @command{gcc} under
1655 @samp{gdb --args}, thus the invocation of @command{cc1} is
1656 @samp{gdb --args cc1 @dots{}}.
1658 @item -fplugin=@var{name}.so
1659 @opindex fplugin
1660 Load the plugin code in file @var{name}.so, assumed to be a
1661 shared object to be dlopen'd by the compiler.  The base name of
1662 the shared object file is used to identify the plugin for the
1663 purposes of argument parsing (See
1664 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1665 Each plugin should define the callback functions specified in the
1666 Plugins API.
1668 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1669 @opindex fplugin-arg
1670 Define an argument called @var{key} with a value of @var{value}
1671 for the plugin called @var{name}.
1673 @item -fdump-ada-spec@r{[}-slim@r{]}
1674 @opindex fdump-ada-spec
1675 For C and C++ source and include files, generate corresponding Ada specs.
1676 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1677 GNAT User's Guide}, which provides detailed documentation on this feature.
1679 @item -fada-spec-parent=@var{unit}
1680 @opindex fada-spec-parent
1681 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1682 Ada specs as child units of parent @var{unit}.
1684 @item -fdump-go-spec=@var{file}
1685 @opindex fdump-go-spec
1686 For input files in any language, generate corresponding Go
1687 declarations in @var{file}.  This generates Go @code{const},
1688 @code{type}, @code{var}, and @code{func} declarations which may be a
1689 useful way to start writing a Go interface to code written in some
1690 other language.
1692 @include @value{srcdir}/../libiberty/at-file.texi
1693 @end table
1695 @node Invoking G++
1696 @section Compiling C++ Programs
1698 @cindex suffixes for C++ source
1699 @cindex C++ source file suffixes
1700 C++ source files conventionally use one of the suffixes @samp{.C},
1701 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1702 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1703 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1704 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1705 files with these names and compiles them as C++ programs even if you
1706 call the compiler the same way as for compiling C programs (usually
1707 with the name @command{gcc}).
1709 @findex g++
1710 @findex c++
1711 However, the use of @command{gcc} does not add the C++ library.
1712 @command{g++} is a program that calls GCC and automatically specifies linking
1713 against the C++ library.  It treats @samp{.c},
1714 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1715 files unless @option{-x} is used.  This program is also useful when
1716 precompiling a C header file with a @samp{.h} extension for use in C++
1717 compilations.  On many systems, @command{g++} is also installed with
1718 the name @command{c++}.
1720 @cindex invoking @command{g++}
1721 When you compile C++ programs, you may specify many of the same
1722 command-line options that you use for compiling programs in any
1723 language; or command-line options meaningful for C and related
1724 languages; or options that are meaningful only for C++ programs.
1725 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1726 explanations of options for languages related to C@.
1727 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1728 explanations of options that are meaningful only for C++ programs.
1730 @node C Dialect Options
1731 @section Options Controlling C Dialect
1732 @cindex dialect options
1733 @cindex language dialect options
1734 @cindex options, dialect
1736 The following options control the dialect of C (or languages derived
1737 from C, such as C++, Objective-C and Objective-C++) that the compiler
1738 accepts:
1740 @table @gcctabopt
1741 @cindex ANSI support
1742 @cindex ISO support
1743 @item -ansi
1744 @opindex ansi
1745 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1746 equivalent to @option{-std=c++98}.
1748 This turns off certain features of GCC that are incompatible with ISO
1749 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1750 such as the @code{asm} and @code{typeof} keywords, and
1751 predefined macros such as @code{unix} and @code{vax} that identify the
1752 type of system you are using.  It also enables the undesirable and
1753 rarely used ISO trigraph feature.  For the C compiler,
1754 it disables recognition of C++ style @samp{//} comments as well as
1755 the @code{inline} keyword.
1757 The alternate keywords @code{__asm__}, @code{__extension__},
1758 @code{__inline__} and @code{__typeof__} continue to work despite
1759 @option{-ansi}.  You would not want to use them in an ISO C program, of
1760 course, but it is useful to put them in header files that might be included
1761 in compilations done with @option{-ansi}.  Alternate predefined macros
1762 such as @code{__unix__} and @code{__vax__} are also available, with or
1763 without @option{-ansi}.
1765 The @option{-ansi} option does not cause non-ISO programs to be
1766 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1767 addition to @option{-ansi}.  @xref{Warning Options}.
1769 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1770 option is used.  Some header files may notice this macro and refrain
1771 from declaring certain functions or defining certain macros that the
1772 ISO standard doesn't call for; this is to avoid interfering with any
1773 programs that might use these names for other things.
1775 Functions that are normally built in but do not have semantics
1776 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1777 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1778 built-in functions provided by GCC}, for details of the functions
1779 affected.
1781 @item -std=
1782 @opindex std
1783 Determine the language standard. @xref{Standards,,Language Standards
1784 Supported by GCC}, for details of these standard versions.  This option
1785 is currently only supported when compiling C or C++.
1787 The compiler can accept several base standards, such as @samp{c90} or
1788 @samp{c++98}, and GNU dialects of those standards, such as
1789 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1790 compiler accepts all programs following that standard plus those
1791 using GNU extensions that do not contradict it.  For example,
1792 @option{-std=c90} turns off certain features of GCC that are
1793 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1794 keywords, but not other GNU extensions that do not have a meaning in
1795 ISO C90, such as omitting the middle term of a @code{?:}
1796 expression. On the other hand, when a GNU dialect of a standard is
1797 specified, all features supported by the compiler are enabled, even when
1798 those features change the meaning of the base standard.  As a result, some
1799 strict-conforming programs may be rejected.  The particular standard
1800 is used by @option{-Wpedantic} to identify which features are GNU
1801 extensions given that version of the standard. For example
1802 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1803 comments, while @option{-std=gnu99 -Wpedantic} does not.
1805 A value for this option must be provided; possible values are
1807 @table @samp
1808 @item c90
1809 @itemx c89
1810 @itemx iso9899:1990
1811 Support all ISO C90 programs (certain GNU extensions that conflict
1812 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1814 @item iso9899:199409
1815 ISO C90 as modified in amendment 1.
1817 @item c99
1818 @itemx c9x
1819 @itemx iso9899:1999
1820 @itemx iso9899:199x
1821 ISO C99.  This standard is substantially completely supported, modulo
1822 bugs and floating-point issues
1823 (mainly but not entirely relating to optional C99 features from
1824 Annexes F and G).  See
1825 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1826 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1828 @item c11
1829 @itemx c1x
1830 @itemx iso9899:2011
1831 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1832 substantially completely supported, modulo bugs, floating-point issues
1833 (mainly but not entirely relating to optional C11 features from
1834 Annexes F and G) and the optional Annexes K (Bounds-checking
1835 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1837 @item c17
1838 @itemx c18
1839 @itemx iso9899:2017
1840 @itemx iso9899:2018
1841 ISO C17, the 2017 revision of the ISO C standard (expected to be
1842 published in 2018).  This standard is
1843 same as C11 except for corrections of defects (all of which are also
1844 applied with @option{-std=c11}) and a new value of
1845 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1847 @item gnu90
1848 @itemx gnu89
1849 GNU dialect of ISO C90 (including some C99 features).
1851 @item gnu99
1852 @itemx gnu9x
1853 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1855 @item gnu11
1856 @itemx gnu1x
1857 GNU dialect of ISO C11.
1858 The name @samp{gnu1x} is deprecated.
1860 @item gnu17
1861 @itemx gnu18
1862 GNU dialect of ISO C17.  This is the default for C code.
1864 @item c++98
1865 @itemx c++03
1866 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1867 additional defect reports. Same as @option{-ansi} for C++ code.
1869 @item gnu++98
1870 @itemx gnu++03
1871 GNU dialect of @option{-std=c++98}.
1873 @item c++11
1874 @itemx c++0x
1875 The 2011 ISO C++ standard plus amendments.
1876 The name @samp{c++0x} is deprecated.
1878 @item gnu++11
1879 @itemx gnu++0x
1880 GNU dialect of @option{-std=c++11}.
1881 The name @samp{gnu++0x} is deprecated.
1883 @item c++14
1884 @itemx c++1y
1885 The 2014 ISO C++ standard plus amendments.
1886 The name @samp{c++1y} is deprecated.
1888 @item gnu++14
1889 @itemx gnu++1y
1890 GNU dialect of @option{-std=c++14}.
1891 This is the default for C++ code.
1892 The name @samp{gnu++1y} is deprecated.
1894 @item c++17
1895 @itemx c++1z
1896 The 2017 ISO C++ standard plus amendments.
1897 The name @samp{c++1z} is deprecated.
1899 @item gnu++17
1900 @itemx gnu++1z
1901 GNU dialect of @option{-std=c++17}.
1902 The name @samp{gnu++1z} is deprecated.
1904 @item c++2a
1905 The next revision of the ISO C++ standard, tentatively planned for
1906 2020.  Support is highly experimental, and will almost certainly
1907 change in incompatible ways in future releases.
1909 @item gnu++2a
1910 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1911 and will almost certainly change in incompatible ways in future
1912 releases.
1913 @end table
1915 @item -fgnu89-inline
1916 @opindex fgnu89-inline
1917 The option @option{-fgnu89-inline} tells GCC to use the traditional
1918 GNU semantics for @code{inline} functions when in C99 mode.
1919 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1920 Using this option is roughly equivalent to adding the
1921 @code{gnu_inline} function attribute to all inline functions
1922 (@pxref{Function Attributes}).
1924 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1925 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1926 specifies the default behavior).
1927 This option is not supported in @option{-std=c90} or
1928 @option{-std=gnu90} mode.
1930 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1931 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1932 in effect for @code{inline} functions.  @xref{Common Predefined
1933 Macros,,,cpp,The C Preprocessor}.
1935 @item -fpermitted-flt-eval-methods=@var{style}
1936 @opindex fpermitted-flt-eval-methods
1937 @opindex fpermitted-flt-eval-methods=c11
1938 @opindex fpermitted-flt-eval-methods=ts-18661-3
1939 ISO/IEC TS 18661-3 defines new permissible values for
1940 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1941 a semantic type that is an interchange or extended format should be
1942 evaluated to the precision and range of that type.  These new values are
1943 a superset of those permitted under C99/C11, which does not specify the
1944 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1945 conforming to C11 may not have been written expecting the possibility of
1946 the new values.
1948 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1949 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1950 or the extended set of values specified in ISO/IEC TS 18661-3.
1952 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1954 The default when in a standards compliant mode (@option{-std=c11} or similar)
1955 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1956 dialect (@option{-std=gnu11} or similar) is
1957 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1959 @item -aux-info @var{filename}
1960 @opindex aux-info
1961 Output to the given filename prototyped declarations for all functions
1962 declared and/or defined in a translation unit, including those in header
1963 files.  This option is silently ignored in any language other than C@.
1965 Besides declarations, the file indicates, in comments, the origin of
1966 each declaration (source file and line), whether the declaration was
1967 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1968 @samp{O} for old, respectively, in the first character after the line
1969 number and the colon), and whether it came from a declaration or a
1970 definition (@samp{C} or @samp{F}, respectively, in the following
1971 character).  In the case of function definitions, a K&R-style list of
1972 arguments followed by their declarations is also provided, inside
1973 comments, after the declaration.
1975 @item -fallow-parameterless-variadic-functions
1976 @opindex fallow-parameterless-variadic-functions
1977 Accept variadic functions without named parameters.
1979 Although it is possible to define such a function, this is not very
1980 useful as it is not possible to read the arguments.  This is only
1981 supported for C as this construct is allowed by C++.
1983 @item -fno-asm
1984 @opindex fno-asm
1985 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1986 keyword, so that code can use these words as identifiers.  You can use
1987 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1988 instead.  @option{-ansi} implies @option{-fno-asm}.
1990 In C++, this switch only affects the @code{typeof} keyword, since
1991 @code{asm} and @code{inline} are standard keywords.  You may want to
1992 use the @option{-fno-gnu-keywords} flag instead, which has the same
1993 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1994 switch only affects the @code{asm} and @code{typeof} keywords, since
1995 @code{inline} is a standard keyword in ISO C99.
1997 @item -fno-builtin
1998 @itemx -fno-builtin-@var{function}
1999 @opindex fno-builtin
2000 @cindex built-in functions
2001 Don't recognize built-in functions that do not begin with
2002 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2003 functions provided by GCC}, for details of the functions affected,
2004 including those which are not built-in functions when @option{-ansi} or
2005 @option{-std} options for strict ISO C conformance are used because they
2006 do not have an ISO standard meaning.
2008 GCC normally generates special code to handle certain built-in functions
2009 more efficiently; for instance, calls to @code{alloca} may become single
2010 instructions which adjust the stack directly, and calls to @code{memcpy}
2011 may become inline copy loops.  The resulting code is often both smaller
2012 and faster, but since the function calls no longer appear as such, you
2013 cannot set a breakpoint on those calls, nor can you change the behavior
2014 of the functions by linking with a different library.  In addition,
2015 when a function is recognized as a built-in function, GCC may use
2016 information about that function to warn about problems with calls to
2017 that function, or to generate more efficient code, even if the
2018 resulting code still contains calls to that function.  For example,
2019 warnings are given with @option{-Wformat} for bad calls to
2020 @code{printf} when @code{printf} is built in and @code{strlen} is
2021 known not to modify global memory.
2023 With the @option{-fno-builtin-@var{function}} option
2024 only the built-in function @var{function} is
2025 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2026 function is named that is not built-in in this version of GCC, this
2027 option is ignored.  There is no corresponding
2028 @option{-fbuiltin-@var{function}} option; if you wish to enable
2029 built-in functions selectively when using @option{-fno-builtin} or
2030 @option{-ffreestanding}, you may define macros such as:
2032 @smallexample
2033 #define abs(n)          __builtin_abs ((n))
2034 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2035 @end smallexample
2037 @item -fgimple
2038 @opindex fgimple
2040 Enable parsing of function definitions marked with @code{__GIMPLE}.
2041 This is an experimental feature that allows unit testing of GIMPLE
2042 passes.
2044 @item -fhosted
2045 @opindex fhosted
2046 @cindex hosted environment
2048 Assert that compilation targets a hosted environment.  This implies
2049 @option{-fbuiltin}.  A hosted environment is one in which the
2050 entire standard library is available, and in which @code{main} has a return
2051 type of @code{int}.  Examples are nearly everything except a kernel.
2052 This is equivalent to @option{-fno-freestanding}.
2054 @item -ffreestanding
2055 @opindex ffreestanding
2056 @cindex hosted environment
2058 Assert that compilation targets a freestanding environment.  This
2059 implies @option{-fno-builtin}.  A freestanding environment
2060 is one in which the standard library may not exist, and program startup may
2061 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2062 This is equivalent to @option{-fno-hosted}.
2064 @xref{Standards,,Language Standards Supported by GCC}, for details of
2065 freestanding and hosted environments.
2067 @item -fopenacc
2068 @opindex fopenacc
2069 @cindex OpenACC accelerator programming
2070 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2071 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2072 compiler generates accelerated code according to the OpenACC Application
2073 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2074 implies @option{-pthread}, and thus is only supported on targets that
2075 have support for @option{-pthread}.
2077 @item -fopenacc-dim=@var{geom}
2078 @opindex fopenacc-dim
2079 @cindex OpenACC accelerator programming
2080 Specify default compute dimensions for parallel offload regions that do
2081 not explicitly specify.  The @var{geom} value is a triple of
2082 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2083 can be omitted, to use a target-specific default value.
2085 @item -fopenmp
2086 @opindex fopenmp
2087 @cindex OpenMP parallel
2088 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2089 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2090 compiler generates parallel code according to the OpenMP Application
2091 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2092 implies @option{-pthread}, and thus is only supported on targets that
2093 have support for @option{-pthread}. @option{-fopenmp} implies
2094 @option{-fopenmp-simd}.
2096 @item -fopenmp-simd
2097 @opindex fopenmp-simd
2098 @cindex OpenMP SIMD
2099 @cindex SIMD
2100 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2101 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2102 are ignored.
2104 @item -fgnu-tm
2105 @opindex fgnu-tm
2106 When the option @option{-fgnu-tm} is specified, the compiler
2107 generates code for the Linux variant of Intel's current Transactional
2108 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2109 an experimental feature whose interface may change in future versions
2110 of GCC, as the official specification changes.  Please note that not
2111 all architectures are supported for this feature.
2113 For more information on GCC's support for transactional memory,
2114 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2115 Transactional Memory Library}.
2117 Note that the transactional memory feature is not supported with
2118 non-call exceptions (@option{-fnon-call-exceptions}).
2120 @item -fms-extensions
2121 @opindex fms-extensions
2122 Accept some non-standard constructs used in Microsoft header files.
2124 In C++ code, this allows member names in structures to be similar
2125 to previous types declarations.
2127 @smallexample
2128 typedef int UOW;
2129 struct ABC @{
2130   UOW UOW;
2132 @end smallexample
2134 Some cases of unnamed fields in structures and unions are only
2135 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2136 fields within structs/unions}, for details.
2138 Note that this option is off for all targets but x86 
2139 targets using ms-abi.
2141 @item -fplan9-extensions
2142 @opindex fplan9-extensions
2143 Accept some non-standard constructs used in Plan 9 code.
2145 This enables @option{-fms-extensions}, permits passing pointers to
2146 structures with anonymous fields to functions that expect pointers to
2147 elements of the type of the field, and permits referring to anonymous
2148 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2149 struct/union fields within structs/unions}, for details.  This is only
2150 supported for C, not C++.
2152 @item -fcond-mismatch
2153 @opindex fcond-mismatch
2154 Allow conditional expressions with mismatched types in the second and
2155 third arguments.  The value of such an expression is void.  This option
2156 is not supported for C++.
2158 @item -flax-vector-conversions
2159 @opindex flax-vector-conversions
2160 Allow implicit conversions between vectors with differing numbers of
2161 elements and/or incompatible element types.  This option should not be
2162 used for new code.
2164 @item -funsigned-char
2165 @opindex funsigned-char
2166 Let the type @code{char} be unsigned, like @code{unsigned char}.
2168 Each kind of machine has a default for what @code{char} should
2169 be.  It is either like @code{unsigned char} by default or like
2170 @code{signed char} by default.
2172 Ideally, a portable program should always use @code{signed char} or
2173 @code{unsigned char} when it depends on the signedness of an object.
2174 But many programs have been written to use plain @code{char} and
2175 expect it to be signed, or expect it to be unsigned, depending on the
2176 machines they were written for.  This option, and its inverse, let you
2177 make such a program work with the opposite default.
2179 The type @code{char} is always a distinct type from each of
2180 @code{signed char} or @code{unsigned char}, even though its behavior
2181 is always just like one of those two.
2183 @item -fsigned-char
2184 @opindex fsigned-char
2185 Let the type @code{char} be signed, like @code{signed char}.
2187 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2188 the negative form of @option{-funsigned-char}.  Likewise, the option
2189 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2191 @item -fsigned-bitfields
2192 @itemx -funsigned-bitfields
2193 @itemx -fno-signed-bitfields
2194 @itemx -fno-unsigned-bitfields
2195 @opindex fsigned-bitfields
2196 @opindex funsigned-bitfields
2197 @opindex fno-signed-bitfields
2198 @opindex fno-unsigned-bitfields
2199 These options control whether a bit-field is signed or unsigned, when the
2200 declaration does not use either @code{signed} or @code{unsigned}.  By
2201 default, such a bit-field is signed, because this is consistent: the
2202 basic integer types such as @code{int} are signed types.
2204 @item -fsso-struct=@var{endianness}
2205 @opindex fsso-struct
2206 Set the default scalar storage order of structures and unions to the
2207 specified endianness.  The accepted values are @samp{big-endian},
2208 @samp{little-endian} and @samp{native} for the native endianness of
2209 the target (the default).  This option is not supported for C++.
2211 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2212 code that is not binary compatible with code generated without it if the
2213 specified endianness is not the native endianness of the target.
2214 @end table
2216 @node C++ Dialect Options
2217 @section Options Controlling C++ Dialect
2219 @cindex compiler options, C++
2220 @cindex C++ options, command-line
2221 @cindex options, C++
2222 This section describes the command-line options that are only meaningful
2223 for C++ programs.  You can also use most of the GNU compiler options
2224 regardless of what language your program is in.  For example, you
2225 might compile a file @file{firstClass.C} like this:
2227 @smallexample
2228 g++ -g -fstrict-enums -O -c firstClass.C
2229 @end smallexample
2231 @noindent
2232 In this example, only @option{-fstrict-enums} is an option meant
2233 only for C++ programs; you can use the other options with any
2234 language supported by GCC@.
2236 Some options for compiling C programs, such as @option{-std}, are also
2237 relevant for C++ programs.
2238 @xref{C Dialect Options,,Options Controlling C Dialect}.
2240 Here is a list of options that are @emph{only} for compiling C++ programs:
2242 @table @gcctabopt
2244 @item -fabi-version=@var{n}
2245 @opindex fabi-version
2246 Use version @var{n} of the C++ ABI@.  The default is version 0.
2248 Version 0 refers to the version conforming most closely to
2249 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2250 will change in different versions of G++ as ABI bugs are fixed.
2252 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2254 Version 2 is the version of the C++ ABI that first appeared in G++
2255 3.4, and was the default through G++ 4.9.
2257 Version 3 corrects an error in mangling a constant address as a
2258 template argument.
2260 Version 4, which first appeared in G++ 4.5, implements a standard
2261 mangling for vector types.
2263 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2264 attribute const/volatile on function pointer types, decltype of a
2265 plain decl, and use of a function parameter in the declaration of
2266 another parameter.
2268 Version 6, which first appeared in G++ 4.7, corrects the promotion
2269 behavior of C++11 scoped enums and the mangling of template argument
2270 packs, const/static_cast, prefix ++ and --, and a class scope function
2271 used as a template argument.
2273 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2274 builtin type and corrects the mangling of lambdas in default argument
2275 scope.
2277 Version 8, which first appeared in G++ 4.9, corrects the substitution
2278 behavior of function types with function-cv-qualifiers.
2280 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2281 @code{nullptr_t}.
2283 Version 10, which first appeared in G++ 6.1, adds mangling of
2284 attributes that affect type identity, such as ia32 calling convention
2285 attributes (e.g. @samp{stdcall}).
2287 Version 11, which first appeared in G++ 7, corrects the mangling of
2288 sizeof... expressions and operator names.  For multiple entities with
2289 the same name within a function, that are declared in different scopes,
2290 the mangling now changes starting with the twelfth occurrence.  It also
2291 implies @option{-fnew-inheriting-ctors}.
2293 See also @option{-Wabi}.
2295 @item -fabi-compat-version=@var{n}
2296 @opindex fabi-compat-version
2297 On targets that support strong aliases, G++
2298 works around mangling changes by creating an alias with the correct
2299 mangled name when defining a symbol with an incorrect mangled name.
2300 This switch specifies which ABI version to use for the alias.
2302 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2303 compatibility).  If another ABI version is explicitly selected, this
2304 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2305 use @option{-fabi-compat-version=2}.
2307 If this option is not provided but @option{-Wabi=@var{n}} is, that
2308 version is used for compatibility aliases.  If this option is provided
2309 along with @option{-Wabi} (without the version), the version from this
2310 option is used for the warning.
2312 @item -fno-access-control
2313 @opindex fno-access-control
2314 Turn off all access checking.  This switch is mainly useful for working
2315 around bugs in the access control code.
2317 @item -faligned-new
2318 @opindex faligned-new
2319 Enable support for C++17 @code{new} of types that require more
2320 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2321 numeric argument such as @code{-faligned-new=32} can be used to
2322 specify how much alignment (in bytes) is provided by that function,
2323 but few users will need to override the default of
2324 @code{alignof(std::max_align_t)}.
2326 This flag is enabled by default for @option{-std=c++17}.
2328 @item -fcheck-new
2329 @opindex fcheck-new
2330 Check that the pointer returned by @code{operator new} is non-null
2331 before attempting to modify the storage allocated.  This check is
2332 normally unnecessary because the C++ standard specifies that
2333 @code{operator new} only returns @code{0} if it is declared
2334 @code{throw()}, in which case the compiler always checks the
2335 return value even without this option.  In all other cases, when
2336 @code{operator new} has a non-empty exception specification, memory
2337 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2338 @samp{new (nothrow)}.
2340 @item -fconcepts
2341 @opindex fconcepts
2342 Enable support for the C++ Extensions for Concepts Technical
2343 Specification, ISO 19217 (2015), which allows code like
2345 @smallexample
2346 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2347 template <Addable T> T add (T a, T b) @{ return a + b; @}
2348 @end smallexample
2350 @item -fconstexpr-depth=@var{n}
2351 @opindex fconstexpr-depth
2352 Set the maximum nested evaluation depth for C++11 constexpr functions
2353 to @var{n}.  A limit is needed to detect endless recursion during
2354 constant expression evaluation.  The minimum specified by the standard
2355 is 512.
2357 @item -fconstexpr-loop-limit=@var{n}
2358 @opindex fconstexpr-loop-limit
2359 Set the maximum number of iterations for a loop in C++14 constexpr functions
2360 to @var{n}.  A limit is needed to detect infinite loops during
2361 constant expression evaluation.  The default is 262144 (1<<18).
2363 @item -fdeduce-init-list
2364 @opindex fdeduce-init-list
2365 Enable deduction of a template type parameter as
2366 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2368 @smallexample
2369 template <class T> auto forward(T t) -> decltype (realfn (t))
2371   return realfn (t);
2374 void f()
2376   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2378 @end smallexample
2380 This deduction was implemented as a possible extension to the
2381 originally proposed semantics for the C++11 standard, but was not part
2382 of the final standard, so it is disabled by default.  This option is
2383 deprecated, and may be removed in a future version of G++.
2385 @item -ffriend-injection
2386 @opindex ffriend-injection
2387 Inject friend functions into the enclosing namespace, so that they are
2388 visible outside the scope of the class in which they are declared.
2389 Friend functions were documented to work this way in the old Annotated
2390 C++ Reference Manual.  
2391 However, in ISO C++ a friend function that is not declared
2392 in an enclosing scope can only be found using argument dependent
2393 lookup.  GCC defaults to the standard behavior.
2395 This option is for compatibility, and may be removed in a future
2396 release of G++.
2398 @item -fno-elide-constructors
2399 @opindex fno-elide-constructors
2400 The C++ standard allows an implementation to omit creating a temporary
2401 that is only used to initialize another object of the same type.
2402 Specifying this option disables that optimization, and forces G++ to
2403 call the copy constructor in all cases.  This option also causes G++
2404 to call trivial member functions which otherwise would be expanded inline.
2406 In C++17, the compiler is required to omit these temporaries, but this
2407 option still affects trivial member functions.
2409 @item -fno-enforce-eh-specs
2410 @opindex fno-enforce-eh-specs
2411 Don't generate code to check for violation of exception specifications
2412 at run time.  This option violates the C++ standard, but may be useful
2413 for reducing code size in production builds, much like defining
2414 @code{NDEBUG}.  This does not give user code permission to throw
2415 exceptions in violation of the exception specifications; the compiler
2416 still optimizes based on the specifications, so throwing an
2417 unexpected exception results in undefined behavior at run time.
2419 @item -fextern-tls-init
2420 @itemx -fno-extern-tls-init
2421 @opindex fextern-tls-init
2422 @opindex fno-extern-tls-init
2423 The C++11 and OpenMP standards allow @code{thread_local} and
2424 @code{threadprivate} variables to have dynamic (runtime)
2425 initialization.  To support this, any use of such a variable goes
2426 through a wrapper function that performs any necessary initialization.
2427 When the use and definition of the variable are in the same
2428 translation unit, this overhead can be optimized away, but when the
2429 use is in a different translation unit there is significant overhead
2430 even if the variable doesn't actually need dynamic initialization.  If
2431 the programmer can be sure that no use of the variable in a
2432 non-defining TU needs to trigger dynamic initialization (either
2433 because the variable is statically initialized, or a use of the
2434 variable in the defining TU will be executed before any uses in
2435 another TU), they can avoid this overhead with the
2436 @option{-fno-extern-tls-init} option.
2438 On targets that support symbol aliases, the default is
2439 @option{-fextern-tls-init}.  On targets that do not support symbol
2440 aliases, the default is @option{-fno-extern-tls-init}.
2442 @item -ffor-scope
2443 @itemx -fno-for-scope
2444 @opindex ffor-scope
2445 @opindex fno-for-scope
2446 If @option{-ffor-scope} is specified, the scope of variables declared in
2447 a @i{for-init-statement} is limited to the @code{for} loop itself,
2448 as specified by the C++ standard.
2449 If @option{-fno-for-scope} is specified, the scope of variables declared in
2450 a @i{for-init-statement} extends to the end of the enclosing scope,
2451 as was the case in old versions of G++, and other (traditional)
2452 implementations of C++.
2454 If neither flag is given, the default is to follow the standard,
2455 but to allow and give a warning for old-style code that would
2456 otherwise be invalid, or have different behavior.
2458 @item -fno-gnu-keywords
2459 @opindex fno-gnu-keywords
2460 Do not recognize @code{typeof} as a keyword, so that code can use this
2461 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2462 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2463 @option{-std=c++98}, @option{-std=c++11}, etc.
2465 @item -fno-implicit-templates
2466 @opindex fno-implicit-templates
2467 Never emit code for non-inline templates that are instantiated
2468 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2469 @xref{Template Instantiation}, for more information.
2471 @item -fno-implicit-inline-templates
2472 @opindex fno-implicit-inline-templates
2473 Don't emit code for implicit instantiations of inline templates, either.
2474 The default is to handle inlines differently so that compiles with and
2475 without optimization need the same set of explicit instantiations.
2477 @item -fno-implement-inlines
2478 @opindex fno-implement-inlines
2479 To save space, do not emit out-of-line copies of inline functions
2480 controlled by @code{#pragma implementation}.  This causes linker
2481 errors if these functions are not inlined everywhere they are called.
2483 @item -fms-extensions
2484 @opindex fms-extensions
2485 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2486 int and getting a pointer to member function via non-standard syntax.
2488 @item -fnew-inheriting-ctors
2489 @opindex fnew-inheriting-ctors
2490 Enable the P0136 adjustment to the semantics of C++11 constructor
2491 inheritance.  This is part of C++17 but also considered to be a Defect
2492 Report against C++11 and C++14.  This flag is enabled by default
2493 unless @option{-fabi-version=10} or lower is specified.
2495 @item -fnew-ttp-matching
2496 @opindex fnew-ttp-matching
2497 Enable the P0522 resolution to Core issue 150, template template
2498 parameters and default arguments: this allows a template with default
2499 template arguments as an argument for a template template parameter
2500 with fewer template parameters.  This flag is enabled by default for
2501 @option{-std=c++17}.
2503 @item -fno-nonansi-builtins
2504 @opindex fno-nonansi-builtins
2505 Disable built-in declarations of functions that are not mandated by
2506 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2507 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2509 @item -fnothrow-opt
2510 @opindex fnothrow-opt
2511 Treat a @code{throw()} exception specification as if it were a
2512 @code{noexcept} specification to reduce or eliminate the text size
2513 overhead relative to a function with no exception specification.  If
2514 the function has local variables of types with non-trivial
2515 destructors, the exception specification actually makes the
2516 function smaller because the EH cleanups for those variables can be
2517 optimized away.  The semantic effect is that an exception thrown out of
2518 a function with such an exception specification results in a call
2519 to @code{terminate} rather than @code{unexpected}.
2521 @item -fno-operator-names
2522 @opindex fno-operator-names
2523 Do not treat the operator name keywords @code{and}, @code{bitand},
2524 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2525 synonyms as keywords.
2527 @item -fno-optional-diags
2528 @opindex fno-optional-diags
2529 Disable diagnostics that the standard says a compiler does not need to
2530 issue.  Currently, the only such diagnostic issued by G++ is the one for
2531 a name having multiple meanings within a class.
2533 @item -fpermissive
2534 @opindex fpermissive
2535 Downgrade some diagnostics about nonconformant code from errors to
2536 warnings.  Thus, using @option{-fpermissive} allows some
2537 nonconforming code to compile.
2539 @item -fno-pretty-templates
2540 @opindex fno-pretty-templates
2541 When an error message refers to a specialization of a function
2542 template, the compiler normally prints the signature of the
2543 template followed by the template arguments and any typedefs or
2544 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2545 rather than @code{void f(int)}) so that it's clear which template is
2546 involved.  When an error message refers to a specialization of a class
2547 template, the compiler omits any template arguments that match
2548 the default template arguments for that template.  If either of these
2549 behaviors make it harder to understand the error message rather than
2550 easier, you can use @option{-fno-pretty-templates} to disable them.
2552 @item -frepo
2553 @opindex frepo
2554 Enable automatic template instantiation at link time.  This option also
2555 implies @option{-fno-implicit-templates}.  @xref{Template
2556 Instantiation}, for more information.
2558 @item -fno-rtti
2559 @opindex fno-rtti
2560 Disable generation of information about every class with virtual
2561 functions for use by the C++ run-time type identification features
2562 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2563 of the language, you can save some space by using this flag.  Note that
2564 exception handling uses the same information, but G++ generates it as
2565 needed. The @code{dynamic_cast} operator can still be used for casts that
2566 do not require run-time type information, i.e.@: casts to @code{void *} or to
2567 unambiguous base classes.
2569 @item -fsized-deallocation
2570 @opindex fsized-deallocation
2571 Enable the built-in global declarations
2572 @smallexample
2573 void operator delete (void *, std::size_t) noexcept;
2574 void operator delete[] (void *, std::size_t) noexcept;
2575 @end smallexample
2576 as introduced in C++14.  This is useful for user-defined replacement
2577 deallocation functions that, for example, use the size of the object
2578 to make deallocation faster.  Enabled by default under
2579 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2580 warns about places that might want to add a definition.
2582 @item -fstrict-enums
2583 @opindex fstrict-enums
2584 Allow the compiler to optimize using the assumption that a value of
2585 enumerated type can only be one of the values of the enumeration (as
2586 defined in the C++ standard; basically, a value that can be
2587 represented in the minimum number of bits needed to represent all the
2588 enumerators).  This assumption may not be valid if the program uses a
2589 cast to convert an arbitrary integer value to the enumerated type.
2591 @item -fstrong-eval-order
2592 @opindex fstrong-eval-order
2593 Evaluate member access, array subscripting, and shift expressions in
2594 left-to-right order, and evaluate assignment in right-to-left order,
2595 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2596 @option{-fstrong-eval-order=some} enables just the ordering of member
2597 access and shift expressions, and is the default without
2598 @option{-std=c++17}.
2600 @item -ftemplate-backtrace-limit=@var{n}
2601 @opindex ftemplate-backtrace-limit
2602 Set the maximum number of template instantiation notes for a single
2603 warning or error to @var{n}.  The default value is 10.
2605 @item -ftemplate-depth=@var{n}
2606 @opindex ftemplate-depth
2607 Set the maximum instantiation depth for template classes to @var{n}.
2608 A limit on the template instantiation depth is needed to detect
2609 endless recursions during template class instantiation.  ANSI/ISO C++
2610 conforming programs must not rely on a maximum depth greater than 17
2611 (changed to 1024 in C++11).  The default value is 900, as the compiler
2612 can run out of stack space before hitting 1024 in some situations.
2614 @item -fno-threadsafe-statics
2615 @opindex fno-threadsafe-statics
2616 Do not emit the extra code to use the routines specified in the C++
2617 ABI for thread-safe initialization of local statics.  You can use this
2618 option to reduce code size slightly in code that doesn't need to be
2619 thread-safe.
2621 @item -fuse-cxa-atexit
2622 @opindex fuse-cxa-atexit
2623 Register destructors for objects with static storage duration with the
2624 @code{__cxa_atexit} function rather than the @code{atexit} function.
2625 This option is required for fully standards-compliant handling of static
2626 destructors, but only works if your C library supports
2627 @code{__cxa_atexit}.
2629 @item -fno-use-cxa-get-exception-ptr
2630 @opindex fno-use-cxa-get-exception-ptr
2631 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2632 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2633 if the runtime routine is not available.
2635 @item -fvisibility-inlines-hidden
2636 @opindex fvisibility-inlines-hidden
2637 This switch declares that the user does not attempt to compare
2638 pointers to inline functions or methods where the addresses of the two functions
2639 are taken in different shared objects.
2641 The effect of this is that GCC may, effectively, mark inline methods with
2642 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2643 appear in the export table of a DSO and do not require a PLT indirection
2644 when used within the DSO@.  Enabling this option can have a dramatic effect
2645 on load and link times of a DSO as it massively reduces the size of the
2646 dynamic export table when the library makes heavy use of templates.
2648 The behavior of this switch is not quite the same as marking the
2649 methods as hidden directly, because it does not affect static variables
2650 local to the function or cause the compiler to deduce that
2651 the function is defined in only one shared object.
2653 You may mark a method as having a visibility explicitly to negate the
2654 effect of the switch for that method.  For example, if you do want to
2655 compare pointers to a particular inline method, you might mark it as
2656 having default visibility.  Marking the enclosing class with explicit
2657 visibility has no effect.
2659 Explicitly instantiated inline methods are unaffected by this option
2660 as their linkage might otherwise cross a shared library boundary.
2661 @xref{Template Instantiation}.
2663 @item -fvisibility-ms-compat
2664 @opindex fvisibility-ms-compat
2665 This flag attempts to use visibility settings to make GCC's C++
2666 linkage model compatible with that of Microsoft Visual Studio.
2668 The flag makes these changes to GCC's linkage model:
2670 @enumerate
2671 @item
2672 It sets the default visibility to @code{hidden}, like
2673 @option{-fvisibility=hidden}.
2675 @item
2676 Types, but not their members, are not hidden by default.
2678 @item
2679 The One Definition Rule is relaxed for types without explicit
2680 visibility specifications that are defined in more than one
2681 shared object: those declarations are permitted if they are
2682 permitted when this option is not used.
2683 @end enumerate
2685 In new code it is better to use @option{-fvisibility=hidden} and
2686 export those classes that are intended to be externally visible.
2687 Unfortunately it is possible for code to rely, perhaps accidentally,
2688 on the Visual Studio behavior.
2690 Among the consequences of these changes are that static data members
2691 of the same type with the same name but defined in different shared
2692 objects are different, so changing one does not change the other;
2693 and that pointers to function members defined in different shared
2694 objects may not compare equal.  When this flag is given, it is a
2695 violation of the ODR to define types with the same name differently.
2697 @item -fno-weak
2698 @opindex fno-weak
2699 Do not use weak symbol support, even if it is provided by the linker.
2700 By default, G++ uses weak symbols if they are available.  This
2701 option exists only for testing, and should not be used by end-users;
2702 it results in inferior code and has no benefits.  This option may
2703 be removed in a future release of G++.
2705 @item -nostdinc++
2706 @opindex nostdinc++
2707 Do not search for header files in the standard directories specific to
2708 C++, but do still search the other standard directories.  (This option
2709 is used when building the C++ library.)
2710 @end table
2712 In addition, these optimization, warning, and code generation options
2713 have meanings only for C++ programs:
2715 @table @gcctabopt
2716 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2717 @opindex Wabi
2718 @opindex Wno-abi
2719 Warn when G++ it generates code that is probably not compatible with
2720 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2721 ABI with each major release, normally @option{-Wabi} will warn only if
2722 there is a check added later in a release series for an ABI issue
2723 discovered since the initial release.  @option{-Wabi} will warn about
2724 more things if an older ABI version is selected (with
2725 @option{-fabi-version=@var{n}}).
2727 @option{-Wabi} can also be used with an explicit version number to
2728 warn about compatibility with a particular @option{-fabi-version}
2729 level, e.g. @option{-Wabi=2} to warn about changes relative to
2730 @option{-fabi-version=2}.
2732 If an explicit version number is provided and
2733 @option{-fabi-compat-version} is not specified, the version number
2734 from this option is used for compatibility aliases.  If no explicit
2735 version number is provided with this option, but
2736 @option{-fabi-compat-version} is specified, that version number is
2737 used for ABI warnings.
2739 Although an effort has been made to warn about
2740 all such cases, there are probably some cases that are not warned about,
2741 even though G++ is generating incompatible code.  There may also be
2742 cases where warnings are emitted even though the code that is generated
2743 is compatible.
2745 You should rewrite your code to avoid these warnings if you are
2746 concerned about the fact that code generated by G++ may not be binary
2747 compatible with code generated by other compilers.
2749 Known incompatibilities in @option{-fabi-version=2} (which was the
2750 default from GCC 3.4 to 4.9) include:
2752 @itemize @bullet
2754 @item
2755 A template with a non-type template parameter of reference type was
2756 mangled incorrectly:
2757 @smallexample
2758 extern int N;
2759 template <int &> struct S @{@};
2760 void n (S<N>) @{2@}
2761 @end smallexample
2763 This was fixed in @option{-fabi-version=3}.
2765 @item
2766 SIMD vector types declared using @code{__attribute ((vector_size))} were
2767 mangled in a non-standard way that does not allow for overloading of
2768 functions taking vectors of different sizes.
2770 The mangling was changed in @option{-fabi-version=4}.
2772 @item
2773 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2774 qualifiers, and @code{decltype} of a plain declaration was folded away.
2776 These mangling issues were fixed in @option{-fabi-version=5}.
2778 @item
2779 Scoped enumerators passed as arguments to a variadic function are
2780 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2781 On most targets this does not actually affect the parameter passing
2782 ABI, as there is no way to pass an argument smaller than @code{int}.
2784 Also, the ABI changed the mangling of template argument packs,
2785 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2786 a class scope function used as a template argument.
2788 These issues were corrected in @option{-fabi-version=6}.
2790 @item
2791 Lambdas in default argument scope were mangled incorrectly, and the
2792 ABI changed the mangling of @code{nullptr_t}.
2794 These issues were corrected in @option{-fabi-version=7}.
2796 @item
2797 When mangling a function type with function-cv-qualifiers, the
2798 un-qualified function type was incorrectly treated as a substitution
2799 candidate.
2801 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2803 @item
2804 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2805 unaligned accesses.  Note that this did not affect the ABI of a
2806 function with a @code{nullptr_t} parameter, as parameters have a
2807 minimum alignment.
2809 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2811 @item
2812 Target-specific attributes that affect the identity of a type, such as
2813 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2814 did not affect the mangled name, leading to name collisions when
2815 function pointers were used as template arguments.
2817 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2819 @end itemize
2821 It also warns about psABI-related changes.  The known psABI changes at this
2822 point include:
2824 @itemize @bullet
2826 @item
2827 For SysV/x86-64, unions with @code{long double} members are 
2828 passed in memory as specified in psABI.  For example:
2830 @smallexample
2831 union U @{
2832   long double ld;
2833   int i;
2835 @end smallexample
2837 @noindent
2838 @code{union U} is always passed in memory.
2840 @end itemize
2842 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2843 @opindex Wabi-tag
2844 @opindex -Wabi-tag
2845 Warn when a type with an ABI tag is used in a context that does not
2846 have that ABI tag.  See @ref{C++ Attributes} for more information
2847 about ABI tags.
2849 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2850 @opindex Wctor-dtor-privacy
2851 @opindex Wno-ctor-dtor-privacy
2852 Warn when a class seems unusable because all the constructors or
2853 destructors in that class are private, and it has neither friends nor
2854 public static member functions.  Also warn if there are no non-private
2855 methods, and there's at least one private member function that isn't
2856 a constructor or destructor.
2858 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2859 @opindex Wdelete-non-virtual-dtor
2860 @opindex Wno-delete-non-virtual-dtor
2861 Warn when @code{delete} is used to destroy an instance of a class that
2862 has virtual functions and non-virtual destructor. It is unsafe to delete
2863 an instance of a derived class through a pointer to a base class if the
2864 base class does not have a virtual destructor.  This warning is enabled
2865 by @option{-Wall}.
2867 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2868 @opindex Wliteral-suffix
2869 @opindex Wno-literal-suffix
2870 Warn when a string or character literal is followed by a ud-suffix which does
2871 not begin with an underscore.  As a conforming extension, GCC treats such
2872 suffixes as separate preprocessing tokens in order to maintain backwards
2873 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2874 For example:
2876 @smallexample
2877 #define __STDC_FORMAT_MACROS
2878 #include <inttypes.h>
2879 #include <stdio.h>
2881 int main() @{
2882   int64_t i64 = 123;
2883   printf("My int64: %" PRId64"\n", i64);
2885 @end smallexample
2887 In this case, @code{PRId64} is treated as a separate preprocessing token.
2889 Additionally, warn when a user-defined literal operator is declared with
2890 a literal suffix identifier that doesn't begin with an underscore. Literal
2891 suffix identifiers that don't begin with an underscore are reserved for
2892 future standardization.
2894 This warning is enabled by default.
2896 @item -Wlto-type-mismatch
2897 @opindex Wlto-type-mismatch
2898 @opindex Wno-lto-type-mismatch
2900 During the link-time optimization warn about type mismatches in
2901 global declarations from different compilation units.
2902 Requires @option{-flto} to be enabled.  Enabled by default.
2904 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2905 @opindex Wnarrowing
2906 @opindex Wno-narrowing
2907 For C++11 and later standards, narrowing conversions are diagnosed by default,
2908 as required by the standard.  A narrowing conversion from a constant produces
2909 an error, and a narrowing conversion from a non-constant produces a warning,
2910 but @option{-Wno-narrowing} suppresses the diagnostic.
2911 Note that this does not affect the meaning of well-formed code;
2912 narrowing conversions are still considered ill-formed in SFINAE contexts.
2914 With @option{-Wnarrowing} in C++98, warn when a narrowing
2915 conversion prohibited by C++11 occurs within
2916 @samp{@{ @}}, e.g.
2918 @smallexample
2919 int i = @{ 2.2 @}; // error: narrowing from double to int
2920 @end smallexample
2922 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2924 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2925 @opindex Wnoexcept
2926 @opindex Wno-noexcept
2927 Warn when a noexcept-expression evaluates to false because of a call
2928 to a function that does not have a non-throwing exception
2929 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2930 the compiler to never throw an exception.
2932 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2933 @opindex Wnoexcept-type
2934 @opindex Wno-noexcept-type
2935 Warn if the C++17 feature making @code{noexcept} part of a function
2936 type changes the mangled name of a symbol relative to C++14.  Enabled
2937 by @option{-Wabi} and @option{-Wc++17-compat}.
2939 As an example:
2941 @smallexample
2942 template <class T> void f(T t) @{ t(); @};
2943 void g() noexcept;
2944 void h() @{ f(g); @} 
2945 @end smallexample
2947 @noindent
2948 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2949 C++17 it calls @code{f<void(*)()noexcept>}.
2951 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2952 @opindex Wclass-memaccess
2953 Warn when the destination of a call to a raw memory function such as
2954 @code{memset} or @code{memcpy} is an object of class type writing into which
2955 might bypass the class non-trivial or deleted constructor or copy assignment,
2956 violate const-correctness or encapsulation, or corrupt the virtual table.
2957 Modifying the representation of such objects may violate invariants maintained
2958 by member functions of the class.  For example, the call to @code{memset}
2959 below is undefined because it modifies a non-trivial class object and is,
2960 therefore, diagnosed.  The safe way to either initialize or clear the storage
2961 of objects of such types is by using the appropriate constructor or assignment
2962 operator, if one is available.
2963 @smallexample
2964 std::string str = "abc";
2965 memset (&str, 0, 3);
2966 @end smallexample
2967 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2969 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2970 @opindex Wnon-virtual-dtor
2971 @opindex Wno-non-virtual-dtor
2972 Warn when a class has virtual functions and an accessible non-virtual
2973 destructor itself or in an accessible polymorphic base class, in which
2974 case it is possible but unsafe to delete an instance of a derived
2975 class through a pointer to the class itself or base class.  This
2976 warning is automatically enabled if @option{-Weffc++} is specified.
2978 @item -Wregister @r{(C++ and Objective-C++ only)}
2979 @opindex Wregister
2980 @opindex Wno-register
2981 Warn on uses of the @code{register} storage class specifier, except
2982 when it is part of the GNU @ref{Explicit Register Variables} extension.
2983 The use of the @code{register} keyword as storage class specifier has
2984 been deprecated in C++11 and removed in C++17.
2985 Enabled by default with @option{-std=c++17}.
2987 @item -Wreorder @r{(C++ and Objective-C++ only)}
2988 @opindex Wreorder
2989 @opindex Wno-reorder
2990 @cindex reordering, warning
2991 @cindex warning for reordering of member initializers
2992 Warn when the order of member initializers given in the code does not
2993 match the order in which they must be executed.  For instance:
2995 @smallexample
2996 struct A @{
2997   int i;
2998   int j;
2999   A(): j (0), i (1) @{ @}
3001 @end smallexample
3003 @noindent
3004 The compiler rearranges the member initializers for @code{i}
3005 and @code{j} to match the declaration order of the members, emitting
3006 a warning to that effect.  This warning is enabled by @option{-Wall}.
3008 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3009 @opindex fext-numeric-literals
3010 @opindex fno-ext-numeric-literals
3011 Accept imaginary, fixed-point, or machine-defined
3012 literal number suffixes as GNU extensions.
3013 When this option is turned off these suffixes are treated
3014 as C++11 user-defined literal numeric suffixes.
3015 This is on by default for all pre-C++11 dialects and all GNU dialects:
3016 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3017 @option{-std=gnu++14}.
3018 This option is off by default
3019 for ISO C++11 onwards (@option{-std=c++11}, ...).
3020 @end table
3022 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3024 @table @gcctabopt
3025 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3026 @opindex Weffc++
3027 @opindex Wno-effc++
3028 Warn about violations of the following style guidelines from Scott Meyers'
3029 @cite{Effective C++} series of books:
3031 @itemize @bullet
3032 @item
3033 Define a copy constructor and an assignment operator for classes
3034 with dynamically-allocated memory.
3036 @item
3037 Prefer initialization to assignment in constructors.
3039 @item
3040 Have @code{operator=} return a reference to @code{*this}.
3042 @item
3043 Don't try to return a reference when you must return an object.
3045 @item
3046 Distinguish between prefix and postfix forms of increment and
3047 decrement operators.
3049 @item
3050 Never overload @code{&&}, @code{||}, or @code{,}.
3052 @end itemize
3054 This option also enables @option{-Wnon-virtual-dtor}, which is also
3055 one of the effective C++ recommendations.  However, the check is
3056 extended to warn about the lack of virtual destructor in accessible
3057 non-polymorphic bases classes too.
3059 When selecting this option, be aware that the standard library
3060 headers do not obey all of these guidelines; use @samp{grep -v}
3061 to filter out those warnings.
3063 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3064 @opindex Wstrict-null-sentinel
3065 @opindex Wno-strict-null-sentinel
3066 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3067 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3068 to @code{__null}.  Although it is a null pointer constant rather than a
3069 null pointer, it is guaranteed to be of the same size as a pointer.
3070 But this use is not portable across different compilers.
3072 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3073 @opindex Wno-non-template-friend
3074 @opindex Wnon-template-friend
3075 Disable warnings when non-template friend functions are declared
3076 within a template.  In very old versions of GCC that predate implementation
3077 of the ISO standard, declarations such as 
3078 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3079 could be interpreted as a particular specialization of a template
3080 function; the warning exists to diagnose compatibility problems, 
3081 and is enabled by default.
3083 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3084 @opindex Wold-style-cast
3085 @opindex Wno-old-style-cast
3086 Warn if an old-style (C-style) cast to a non-void type is used within
3087 a C++ program.  The new-style casts (@code{dynamic_cast},
3088 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3089 less vulnerable to unintended effects and much easier to search for.
3091 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3092 @opindex Woverloaded-virtual
3093 @opindex Wno-overloaded-virtual
3094 @cindex overloaded virtual function, warning
3095 @cindex warning for overloaded virtual function
3096 Warn when a function declaration hides virtual functions from a
3097 base class.  For example, in:
3099 @smallexample
3100 struct A @{
3101   virtual void f();
3104 struct B: public A @{
3105   void f(int);
3107 @end smallexample
3109 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3110 like:
3112 @smallexample
3113 B* b;
3114 b->f();
3115 @end smallexample
3117 @noindent
3118 fails to compile.
3120 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3121 @opindex Wno-pmf-conversions
3122 @opindex Wpmf-conversions
3123 Disable the diagnostic for converting a bound pointer to member function
3124 to a plain pointer.
3126 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3127 @opindex Wsign-promo
3128 @opindex Wno-sign-promo
3129 Warn when overload resolution chooses a promotion from unsigned or
3130 enumerated type to a signed type, over a conversion to an unsigned type of
3131 the same size.  Previous versions of G++ tried to preserve
3132 unsignedness, but the standard mandates the current behavior.
3134 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3135 @opindex Wtemplates
3136 Warn when a primary template declaration is encountered.  Some coding
3137 rules disallow templates, and this may be used to enforce that rule.
3138 The warning is inactive inside a system header file, such as the STL, so
3139 one can still use the STL.  One may also instantiate or specialize
3140 templates.
3142 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3143 @opindex Wmultiple-inheritance
3144 Warn when a class is defined with multiple direct base classes.  Some
3145 coding rules disallow multiple inheritance, and this may be used to
3146 enforce that rule.  The warning is inactive inside a system header file,
3147 such as the STL, so one can still use the STL.  One may also define
3148 classes that indirectly use multiple inheritance.
3150 @item -Wvirtual-inheritance
3151 @opindex Wvirtual-inheritance
3152 Warn when a class is defined with a virtual direct base class.  Some
3153 coding rules disallow multiple inheritance, and this may be used to
3154 enforce that rule.  The warning is inactive inside a system header file,
3155 such as the STL, so one can still use the STL.  One may also define
3156 classes that indirectly use virtual inheritance.
3158 @item -Wnamespaces
3159 @opindex Wnamespaces
3160 Warn when a namespace definition is opened.  Some coding rules disallow
3161 namespaces, and this may be used to enforce that rule.  The warning is
3162 inactive inside a system header file, such as the STL, so one can still
3163 use the STL.  One may also use using directives and qualified names.
3165 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3166 @opindex Wterminate
3167 @opindex Wno-terminate
3168 Disable the warning about a throw-expression that will immediately
3169 result in a call to @code{terminate}.
3170 @end table
3172 @node Objective-C and Objective-C++ Dialect Options
3173 @section Options Controlling Objective-C and Objective-C++ Dialects
3175 @cindex compiler options, Objective-C and Objective-C++
3176 @cindex Objective-C and Objective-C++ options, command-line
3177 @cindex options, Objective-C and Objective-C++
3178 (NOTE: This manual does not describe the Objective-C and Objective-C++
3179 languages themselves.  @xref{Standards,,Language Standards
3180 Supported by GCC}, for references.)
3182 This section describes the command-line options that are only meaningful
3183 for Objective-C and Objective-C++ programs.  You can also use most of
3184 the language-independent GNU compiler options.
3185 For example, you might compile a file @file{some_class.m} like this:
3187 @smallexample
3188 gcc -g -fgnu-runtime -O -c some_class.m
3189 @end smallexample
3191 @noindent
3192 In this example, @option{-fgnu-runtime} is an option meant only for
3193 Objective-C and Objective-C++ programs; you can use the other options with
3194 any language supported by GCC@.
3196 Note that since Objective-C is an extension of the C language, Objective-C
3197 compilations may also use options specific to the C front-end (e.g.,
3198 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3199 C++-specific options (e.g., @option{-Wabi}).
3201 Here is a list of options that are @emph{only} for compiling Objective-C
3202 and Objective-C++ programs:
3204 @table @gcctabopt
3205 @item -fconstant-string-class=@var{class-name}
3206 @opindex fconstant-string-class
3207 Use @var{class-name} as the name of the class to instantiate for each
3208 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3209 class name is @code{NXConstantString} if the GNU runtime is being used, and
3210 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3211 @option{-fconstant-cfstrings} option, if also present, overrides the
3212 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3213 to be laid out as constant CoreFoundation strings.
3215 @item -fgnu-runtime
3216 @opindex fgnu-runtime
3217 Generate object code compatible with the standard GNU Objective-C
3218 runtime.  This is the default for most types of systems.
3220 @item -fnext-runtime
3221 @opindex fnext-runtime
3222 Generate output compatible with the NeXT runtime.  This is the default
3223 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3224 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3225 used.
3227 @item -fno-nil-receivers
3228 @opindex fno-nil-receivers
3229 Assume that all Objective-C message dispatches (@code{[receiver
3230 message:arg]}) in this translation unit ensure that the receiver is
3231 not @code{nil}.  This allows for more efficient entry points in the
3232 runtime to be used.  This option is only available in conjunction with
3233 the NeXT runtime and ABI version 0 or 1.
3235 @item -fobjc-abi-version=@var{n}
3236 @opindex fobjc-abi-version
3237 Use version @var{n} of the Objective-C ABI for the selected runtime.
3238 This option is currently supported only for the NeXT runtime.  In that
3239 case, Version 0 is the traditional (32-bit) ABI without support for
3240 properties and other Objective-C 2.0 additions.  Version 1 is the
3241 traditional (32-bit) ABI with support for properties and other
3242 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3243 nothing is specified, the default is Version 0 on 32-bit target
3244 machines, and Version 2 on 64-bit target machines.
3246 @item -fobjc-call-cxx-cdtors
3247 @opindex fobjc-call-cxx-cdtors
3248 For each Objective-C class, check if any of its instance variables is a
3249 C++ object with a non-trivial default constructor.  If so, synthesize a
3250 special @code{- (id) .cxx_construct} instance method which runs
3251 non-trivial default constructors on any such instance variables, in order,
3252 and then return @code{self}.  Similarly, check if any instance variable
3253 is a C++ object with a non-trivial destructor, and if so, synthesize a
3254 special @code{- (void) .cxx_destruct} method which runs
3255 all such default destructors, in reverse order.
3257 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3258 methods thusly generated only operate on instance variables
3259 declared in the current Objective-C class, and not those inherited
3260 from superclasses.  It is the responsibility of the Objective-C
3261 runtime to invoke all such methods in an object's inheritance
3262 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3263 by the runtime immediately after a new object instance is allocated;
3264 the @code{- (void) .cxx_destruct} methods are invoked immediately
3265 before the runtime deallocates an object instance.
3267 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3268 support for invoking the @code{- (id) .cxx_construct} and
3269 @code{- (void) .cxx_destruct} methods.
3271 @item -fobjc-direct-dispatch
3272 @opindex fobjc-direct-dispatch
3273 Allow fast jumps to the message dispatcher.  On Darwin this is
3274 accomplished via the comm page.
3276 @item -fobjc-exceptions
3277 @opindex fobjc-exceptions
3278 Enable syntactic support for structured exception handling in
3279 Objective-C, similar to what is offered by C++.  This option
3280 is required to use the Objective-C keywords @code{@@try},
3281 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3282 @code{@@synchronized}.  This option is available with both the GNU
3283 runtime and the NeXT runtime (but not available in conjunction with
3284 the NeXT runtime on Mac OS X 10.2 and earlier).
3286 @item -fobjc-gc
3287 @opindex fobjc-gc
3288 Enable garbage collection (GC) in Objective-C and Objective-C++
3289 programs.  This option is only available with the NeXT runtime; the
3290 GNU runtime has a different garbage collection implementation that
3291 does not require special compiler flags.
3293 @item -fobjc-nilcheck
3294 @opindex fobjc-nilcheck
3295 For the NeXT runtime with version 2 of the ABI, check for a nil
3296 receiver in method invocations before doing the actual method call.
3297 This is the default and can be disabled using
3298 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3299 checked for nil in this way no matter what this flag is set to.
3300 Currently this flag does nothing when the GNU runtime, or an older
3301 version of the NeXT runtime ABI, is used.
3303 @item -fobjc-std=objc1
3304 @opindex fobjc-std
3305 Conform to the language syntax of Objective-C 1.0, the language
3306 recognized by GCC 4.0.  This only affects the Objective-C additions to
3307 the C/C++ language; it does not affect conformance to C/C++ standards,
3308 which is controlled by the separate C/C++ dialect option flags.  When
3309 this option is used with the Objective-C or Objective-C++ compiler,
3310 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3311 This is useful if you need to make sure that your Objective-C code can
3312 be compiled with older versions of GCC@.
3314 @item -freplace-objc-classes
3315 @opindex freplace-objc-classes
3316 Emit a special marker instructing @command{ld(1)} not to statically link in
3317 the resulting object file, and allow @command{dyld(1)} to load it in at
3318 run time instead.  This is used in conjunction with the Fix-and-Continue
3319 debugging mode, where the object file in question may be recompiled and
3320 dynamically reloaded in the course of program execution, without the need
3321 to restart the program itself.  Currently, Fix-and-Continue functionality
3322 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3323 and later.
3325 @item -fzero-link
3326 @opindex fzero-link
3327 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3328 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3329 compile time) with static class references that get initialized at load time,
3330 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3331 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3332 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3333 for individual class implementations to be modified during program execution.
3334 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3335 regardless of command-line options.
3337 @item -fno-local-ivars
3338 @opindex fno-local-ivars
3339 @opindex flocal-ivars
3340 By default instance variables in Objective-C can be accessed as if
3341 they were local variables from within the methods of the class they're
3342 declared in.  This can lead to shadowing between instance variables
3343 and other variables declared either locally inside a class method or
3344 globally with the same name.  Specifying the @option{-fno-local-ivars}
3345 flag disables this behavior thus avoiding variable shadowing issues.
3347 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3348 @opindex fivar-visibility
3349 Set the default instance variable visibility to the specified option
3350 so that instance variables declared outside the scope of any access
3351 modifier directives default to the specified visibility.
3353 @item -gen-decls
3354 @opindex gen-decls
3355 Dump interface declarations for all classes seen in the source file to a
3356 file named @file{@var{sourcename}.decl}.
3358 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3359 @opindex Wassign-intercept
3360 @opindex Wno-assign-intercept
3361 Warn whenever an Objective-C assignment is being intercepted by the
3362 garbage collector.
3364 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3365 @opindex Wno-protocol
3366 @opindex Wprotocol
3367 If a class is declared to implement a protocol, a warning is issued for
3368 every method in the protocol that is not implemented by the class.  The
3369 default behavior is to issue a warning for every method not explicitly
3370 implemented in the class, even if a method implementation is inherited
3371 from the superclass.  If you use the @option{-Wno-protocol} option, then
3372 methods inherited from the superclass are considered to be implemented,
3373 and no warning is issued for them.
3375 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3376 @opindex Wselector
3377 @opindex Wno-selector
3378 Warn if multiple methods of different types for the same selector are
3379 found during compilation.  The check is performed on the list of methods
3380 in the final stage of compilation.  Additionally, a check is performed
3381 for each selector appearing in a @code{@@selector(@dots{})}
3382 expression, and a corresponding method for that selector has been found
3383 during compilation.  Because these checks scan the method table only at
3384 the end of compilation, these warnings are not produced if the final
3385 stage of compilation is not reached, for example because an error is
3386 found during compilation, or because the @option{-fsyntax-only} option is
3387 being used.
3389 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3390 @opindex Wstrict-selector-match
3391 @opindex Wno-strict-selector-match
3392 Warn if multiple methods with differing argument and/or return types are
3393 found for a given selector when attempting to send a message using this
3394 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3395 is off (which is the default behavior), the compiler omits such warnings
3396 if any differences found are confined to types that share the same size
3397 and alignment.
3399 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3400 @opindex Wundeclared-selector
3401 @opindex Wno-undeclared-selector
3402 Warn if a @code{@@selector(@dots{})} expression referring to an
3403 undeclared selector is found.  A selector is considered undeclared if no
3404 method with that name has been declared before the
3405 @code{@@selector(@dots{})} expression, either explicitly in an
3406 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3407 an @code{@@implementation} section.  This option always performs its
3408 checks as soon as a @code{@@selector(@dots{})} expression is found,
3409 while @option{-Wselector} only performs its checks in the final stage of
3410 compilation.  This also enforces the coding style convention
3411 that methods and selectors must be declared before being used.
3413 @item -print-objc-runtime-info
3414 @opindex print-objc-runtime-info
3415 Generate C header describing the largest structure that is passed by
3416 value, if any.
3418 @end table
3420 @node Diagnostic Message Formatting Options
3421 @section Options to Control Diagnostic Messages Formatting
3422 @cindex options to control diagnostics formatting
3423 @cindex diagnostic messages
3424 @cindex message formatting
3426 Traditionally, diagnostic messages have been formatted irrespective of
3427 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3428 options described below
3429 to control the formatting algorithm for diagnostic messages, 
3430 e.g.@: how many characters per line, how often source location
3431 information should be reported.  Note that some language front ends may not
3432 honor these options.
3434 @table @gcctabopt
3435 @item -fmessage-length=@var{n}
3436 @opindex fmessage-length
3437 Try to format error messages so that they fit on lines of about
3438 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3439 done; each error message appears on a single line.  This is the
3440 default for all front ends.
3442 @item -fdiagnostics-show-location=once
3443 @opindex fdiagnostics-show-location
3444 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3445 reporter to emit source location information @emph{once}; that is, in
3446 case the message is too long to fit on a single physical line and has to
3447 be wrapped, the source location won't be emitted (as prefix) again,
3448 over and over, in subsequent continuation lines.  This is the default
3449 behavior.
3451 @item -fdiagnostics-show-location=every-line
3452 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3453 messages reporter to emit the same source location information (as
3454 prefix) for physical lines that result from the process of breaking
3455 a message which is too long to fit on a single line.
3457 @item -fdiagnostics-color[=@var{WHEN}]
3458 @itemx -fno-diagnostics-color
3459 @opindex fdiagnostics-color
3460 @cindex highlight, color
3461 @vindex GCC_COLORS @r{environment variable}
3462 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3463 or @samp{auto}.  The default depends on how the compiler has been configured,
3464 it can be any of the above @var{WHEN} options or also @samp{never}
3465 if @env{GCC_COLORS} environment variable isn't present in the environment,
3466 and @samp{auto} otherwise.
3467 @samp{auto} means to use color only when the standard error is a terminal.
3468 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3469 aliases for @option{-fdiagnostics-color=always} and
3470 @option{-fdiagnostics-color=never}, respectively.
3472 The colors are defined by the environment variable @env{GCC_COLORS}.
3473 Its value is a colon-separated list of capabilities and Select Graphic
3474 Rendition (SGR) substrings. SGR commands are interpreted by the
3475 terminal or terminal emulator.  (See the section in the documentation
3476 of your text terminal for permitted values and their meanings as
3477 character attributes.)  These substring values are integers in decimal
3478 representation and can be concatenated with semicolons.
3479 Common values to concatenate include
3480 @samp{1} for bold,
3481 @samp{4} for underline,
3482 @samp{5} for blink,
3483 @samp{7} for inverse,
3484 @samp{39} for default foreground color,
3485 @samp{30} to @samp{37} for foreground colors,
3486 @samp{90} to @samp{97} for 16-color mode foreground colors,
3487 @samp{38;5;0} to @samp{38;5;255}
3488 for 88-color and 256-color modes foreground colors,
3489 @samp{49} for default background color,
3490 @samp{40} to @samp{47} for background colors,
3491 @samp{100} to @samp{107} for 16-color mode background colors,
3492 and @samp{48;5;0} to @samp{48;5;255}
3493 for 88-color and 256-color modes background colors.
3495 The default @env{GCC_COLORS} is
3496 @smallexample
3497 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3498 quote=01:fixit-insert=32:fixit-delete=31:\
3499 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3500 type-diff=01;32
3501 @end smallexample
3502 @noindent
3503 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3504 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3505 @samp{01} is bold, and @samp{31} is red.
3506 Setting @env{GCC_COLORS} to the empty string disables colors.
3507 Supported capabilities are as follows.
3509 @table @code
3510 @item error=
3511 @vindex error GCC_COLORS @r{capability}
3512 SGR substring for error: markers.
3514 @item warning=
3515 @vindex warning GCC_COLORS @r{capability}
3516 SGR substring for warning: markers.
3518 @item note=
3519 @vindex note GCC_COLORS @r{capability}
3520 SGR substring for note: markers.
3522 @item range1=
3523 @vindex range1 GCC_COLORS @r{capability}
3524 SGR substring for first additional range.
3526 @item range2=
3527 @vindex range2 GCC_COLORS @r{capability}
3528 SGR substring for second additional range.
3530 @item locus=
3531 @vindex locus GCC_COLORS @r{capability}
3532 SGR substring for location information, @samp{file:line} or
3533 @samp{file:line:column} etc.
3535 @item quote=
3536 @vindex quote GCC_COLORS @r{capability}
3537 SGR substring for information printed within quotes.
3539 @item fixit-insert=
3540 @vindex fixit-insert GCC_COLORS @r{capability}
3541 SGR substring for fix-it hints suggesting text to
3542 be inserted or replaced.
3544 @item fixit-delete=
3545 @vindex fixit-delete GCC_COLORS @r{capability}
3546 SGR substring for fix-it hints suggesting text to
3547 be deleted.
3549 @item diff-filename=
3550 @vindex diff-filename GCC_COLORS @r{capability}
3551 SGR substring for filename headers within generated patches.
3553 @item diff-hunk=
3554 @vindex diff-hunk GCC_COLORS @r{capability}
3555 SGR substring for the starts of hunks within generated patches.
3557 @item diff-delete=
3558 @vindex diff-delete GCC_COLORS @r{capability}
3559 SGR substring for deleted lines within generated patches.
3561 @item diff-insert=
3562 @vindex diff-insert GCC_COLORS @r{capability}
3563 SGR substring for inserted lines within generated patches.
3565 @item type-diff=
3566 @vindex type-diff GCC_COLORS @r{capability}
3567 SGR substring for highlighting mismatching types within template
3568 arguments in the C++ frontend.
3569 @end table
3571 @item -fno-diagnostics-show-option
3572 @opindex fno-diagnostics-show-option
3573 @opindex fdiagnostics-show-option
3574 By default, each diagnostic emitted includes text indicating the
3575 command-line option that directly controls the diagnostic (if such an
3576 option is known to the diagnostic machinery).  Specifying the
3577 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3579 @item -fno-diagnostics-show-caret
3580 @opindex fno-diagnostics-show-caret
3581 @opindex fdiagnostics-show-caret
3582 By default, each diagnostic emitted includes the original source line
3583 and a caret @samp{^} indicating the column.  This option suppresses this
3584 information.  The source line is truncated to @var{n} characters, if
3585 the @option{-fmessage-length=n} option is given.  When the output is done
3586 to the terminal, the width is limited to the width given by the
3587 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3589 @item -fdiagnostics-parseable-fixits
3590 @opindex fdiagnostics-parseable-fixits
3591 Emit fix-it hints in a machine-parseable format, suitable for consumption
3592 by IDEs.  For each fix-it, a line will be printed after the relevant
3593 diagnostic, starting with the string ``fix-it:''.  For example:
3595 @smallexample
3596 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3597 @end smallexample
3599 The location is expressed as a half-open range, expressed as a count of
3600 bytes, starting at byte 1 for the initial column.  In the above example,
3601 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3602 given string:
3604 @smallexample
3605 00000000011111111112222222222
3606 12345678901234567890123456789
3607   gtk_widget_showall (dlg);
3608   ^^^^^^^^^^^^^^^^^^
3609   gtk_widget_show_all
3610 @end smallexample
3612 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3613 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3614 (e.g. vertical tab as ``\013'').
3616 An empty replacement string indicates that the given range is to be removed.
3617 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3618 be inserted at the given position.
3620 @item -fdiagnostics-generate-patch
3621 @opindex fdiagnostics-generate-patch
3622 Print fix-it hints to stderr in unified diff format, after any diagnostics
3623 are printed.  For example:
3625 @smallexample
3626 --- test.c
3627 +++ test.c
3628 @@ -42,5 +42,5 @@
3630  void show_cb(GtkDialog *dlg)
3631  @{
3632 -  gtk_widget_showall(dlg);
3633 +  gtk_widget_show_all(dlg);
3634  @}
3636 @end smallexample
3638 The diff may or may not be colorized, following the same rules
3639 as for diagnostics (see @option{-fdiagnostics-color}).
3641 @item -fdiagnostics-show-template-tree
3642 @opindex fdiagnostics-show-template-tree
3644 In the C++ frontend, when printing diagnostics showing mismatching
3645 template types, such as:
3647 @smallexample
3648   could not convert 'std::map<int, std::vector<double> >()'
3649     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3650 @end smallexample
3652 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3653 tree-like structure showing the common and differing parts of the types,
3654 such as:
3656 @smallexample
3657   map<
3658     [...],
3659     vector<
3660       [double != float]>>
3661 @end smallexample
3663 The parts that differ are highlighted with color (``double'' and
3664 ``float'' in this case).
3666 @item -fno-elide-type
3667 @opindex fno-elide-type
3668 @opindex felide-type
3669 By default when the C++ frontend prints diagnostics showing mismatching
3670 template types, common parts of the types are printed as ``[...]'' to
3671 simplify the error message.  For example:
3673 @smallexample
3674   could not convert 'std::map<int, std::vector<double> >()'
3675     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3676 @end smallexample
3678 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3679 This flag also affects the output of the
3680 @option{-fdiagnostics-show-template-tree} flag.
3682 @item -fno-show-column
3683 @opindex fno-show-column
3684 Do not print column numbers in diagnostics.  This may be necessary if
3685 diagnostics are being scanned by a program that does not understand the
3686 column numbers, such as @command{dejagnu}.
3688 @end table
3690 @node Warning Options
3691 @section Options to Request or Suppress Warnings
3692 @cindex options to control warnings
3693 @cindex warning messages
3694 @cindex messages, warning
3695 @cindex suppressing warnings
3697 Warnings are diagnostic messages that report constructions that
3698 are not inherently erroneous but that are risky or suggest there
3699 may have been an error.
3701 The following language-independent options do not enable specific
3702 warnings but control the kinds of diagnostics produced by GCC@.
3704 @table @gcctabopt
3705 @cindex syntax checking
3706 @item -fsyntax-only
3707 @opindex fsyntax-only
3708 Check the code for syntax errors, but don't do anything beyond that.
3710 @item -fmax-errors=@var{n}
3711 @opindex fmax-errors
3712 Limits the maximum number of error messages to @var{n}, at which point
3713 GCC bails out rather than attempting to continue processing the source
3714 code.  If @var{n} is 0 (the default), there is no limit on the number
3715 of error messages produced.  If @option{-Wfatal-errors} is also
3716 specified, then @option{-Wfatal-errors} takes precedence over this
3717 option.
3719 @item -w
3720 @opindex w
3721 Inhibit all warning messages.
3723 @item -Werror
3724 @opindex Werror
3725 @opindex Wno-error
3726 Make all warnings into errors.
3728 @item -Werror=
3729 @opindex Werror=
3730 @opindex Wno-error=
3731 Make the specified warning into an error.  The specifier for a warning
3732 is appended; for example @option{-Werror=switch} turns the warnings
3733 controlled by @option{-Wswitch} into errors.  This switch takes a
3734 negative form, to be used to negate @option{-Werror} for specific
3735 warnings; for example @option{-Wno-error=switch} makes
3736 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3737 is in effect.
3739 The warning message for each controllable warning includes the
3740 option that controls the warning.  That option can then be used with
3741 @option{-Werror=} and @option{-Wno-error=} as described above.
3742 (Printing of the option in the warning message can be disabled using the
3743 @option{-fno-diagnostics-show-option} flag.)
3745 Note that specifying @option{-Werror=}@var{foo} automatically implies
3746 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3747 imply anything.
3749 @item -Wfatal-errors
3750 @opindex Wfatal-errors
3751 @opindex Wno-fatal-errors
3752 This option causes the compiler to abort compilation on the first error
3753 occurred rather than trying to keep going and printing further error
3754 messages.
3756 @end table
3758 You can request many specific warnings with options beginning with
3759 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3760 implicit declarations.  Each of these specific warning options also
3761 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3762 example, @option{-Wno-implicit}.  This manual lists only one of the
3763 two forms, whichever is not the default.  For further
3764 language-specific options also refer to @ref{C++ Dialect Options} and
3765 @ref{Objective-C and Objective-C++ Dialect Options}.
3767 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3768 options, such as @option{-Wunused}, which may turn on further options,
3769 such as @option{-Wunused-value}. The combined effect of positive and
3770 negative forms is that more specific options have priority over less
3771 specific ones, independently of their position in the command-line. For
3772 options of the same specificity, the last one takes effect. Options
3773 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3774 as if they appeared at the end of the command-line.
3776 When an unrecognized warning option is requested (e.g.,
3777 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3778 that the option is not recognized.  However, if the @option{-Wno-} form
3779 is used, the behavior is slightly different: no diagnostic is
3780 produced for @option{-Wno-unknown-warning} unless other diagnostics
3781 are being produced.  This allows the use of new @option{-Wno-} options
3782 with old compilers, but if something goes wrong, the compiler
3783 warns that an unrecognized option is present.
3785 @table @gcctabopt
3786 @item -Wpedantic
3787 @itemx -pedantic
3788 @opindex pedantic
3789 @opindex Wpedantic
3790 Issue all the warnings demanded by strict ISO C and ISO C++;
3791 reject all programs that use forbidden extensions, and some other
3792 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3793 version of the ISO C standard specified by any @option{-std} option used.
3795 Valid ISO C and ISO C++ programs should compile properly with or without
3796 this option (though a rare few require @option{-ansi} or a
3797 @option{-std} option specifying the required version of ISO C)@.  However,
3798 without this option, certain GNU extensions and traditional C and C++
3799 features are supported as well.  With this option, they are rejected.
3801 @option{-Wpedantic} does not cause warning messages for use of the
3802 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3803 warnings are also disabled in the expression that follows
3804 @code{__extension__}.  However, only system header files should use
3805 these escape routes; application programs should avoid them.
3806 @xref{Alternate Keywords}.
3808 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3809 C conformance.  They soon find that it does not do quite what they want:
3810 it finds some non-ISO practices, but not all---only those for which
3811 ISO C @emph{requires} a diagnostic, and some others for which
3812 diagnostics have been added.
3814 A feature to report any failure to conform to ISO C might be useful in
3815 some instances, but would require considerable additional work and would
3816 be quite different from @option{-Wpedantic}.  We don't have plans to
3817 support such a feature in the near future.
3819 Where the standard specified with @option{-std} represents a GNU
3820 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3821 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3822 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3823 where they are required by the base standard.  (It does not make sense
3824 for such warnings to be given only for features not in the specified GNU
3825 C dialect, since by definition the GNU dialects of C include all
3826 features the compiler supports with the given option, and there would be
3827 nothing to warn about.)
3829 @item -pedantic-errors
3830 @opindex pedantic-errors
3831 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3832 requires a diagnostic, in some cases where there is undefined behavior
3833 at compile-time and in some other cases that do not prevent compilation
3834 of programs that are valid according to the standard. This is not
3835 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3836 by this option and not enabled by the latter and vice versa.
3838 @item -Wall
3839 @opindex Wall
3840 @opindex Wno-all
3841 This enables all the warnings about constructions that some users
3842 consider questionable, and that are easy to avoid (or modify to
3843 prevent the warning), even in conjunction with macros.  This also
3844 enables some language-specific warnings described in @ref{C++ Dialect
3845 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3847 @option{-Wall} turns on the following warning flags:
3849 @gccoptlist{-Waddress   @gol
3850 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3851 -Wbool-compare  @gol
3852 -Wbool-operation  @gol
3853 -Wc++11-compat  -Wc++14-compat  @gol
3854 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3855 -Wchar-subscripts  @gol
3856 -Wcomment  @gol
3857 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3858 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3859 -Wformat   @gol
3860 -Wint-in-bool-context  @gol
3861 -Wimplicit @r{(C and Objective-C only)} @gol
3862 -Wimplicit-int @r{(C and Objective-C only)} @gol
3863 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3864 -Winit-self @r{(only for C++)} @gol
3865 -Wlogical-not-parentheses @gol
3866 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3867 -Wmaybe-uninitialized @gol
3868 -Wmemset-elt-size @gol
3869 -Wmemset-transposed-args @gol
3870 -Wmisleading-indentation @r{(only for C/C++)} @gol
3871 -Wmissing-braces @r{(only for C/ObjC)} @gol
3872 -Wmultistatement-macros  @gol
3873 -Wnarrowing @r{(only for C++)}  @gol
3874 -Wnonnull  @gol
3875 -Wnonnull-compare  @gol
3876 -Wopenmp-simd @gol
3877 -Wparentheses  @gol
3878 -Wpointer-sign  @gol
3879 -Wreorder   @gol
3880 -Wrestrict   @gol
3881 -Wreturn-type  @gol
3882 -Wsequence-point  @gol
3883 -Wsign-compare @r{(only in C++)}  @gol
3884 -Wsizeof-pointer-div @gol
3885 -Wsizeof-pointer-memaccess @gol
3886 -Wstrict-aliasing  @gol
3887 -Wstrict-overflow=1  @gol
3888 -Wswitch  @gol
3889 -Wtautological-compare  @gol
3890 -Wtrigraphs  @gol
3891 -Wuninitialized  @gol
3892 -Wunknown-pragmas  @gol
3893 -Wunused-function  @gol
3894 -Wunused-label     @gol
3895 -Wunused-value     @gol
3896 -Wunused-variable  @gol
3897 -Wvolatile-register-var @gol
3900 Note that some warning flags are not implied by @option{-Wall}.  Some of
3901 them warn about constructions that users generally do not consider
3902 questionable, but which occasionally you might wish to check for;
3903 others warn about constructions that are necessary or hard to avoid in
3904 some cases, and there is no simple way to modify the code to suppress
3905 the warning. Some of them are enabled by @option{-Wextra} but many of
3906 them must be enabled individually.
3908 @item -Wextra
3909 @opindex W
3910 @opindex Wextra
3911 @opindex Wno-extra
3912 This enables some extra warning flags that are not enabled by
3913 @option{-Wall}. (This option used to be called @option{-W}.  The older
3914 name is still supported, but the newer name is more descriptive.)
3916 @gccoptlist{-Wclobbered  @gol
3917 -Wcast-function-type  @gol
3918 -Wempty-body  @gol
3919 -Wignored-qualifiers @gol
3920 -Wimplicit-fallthrough=3 @gol
3921 -Wmissing-field-initializers  @gol
3922 -Wmissing-parameter-type @r{(C only)}  @gol
3923 -Wold-style-declaration @r{(C only)}  @gol
3924 -Woverride-init  @gol
3925 -Wsign-compare @r{(C only)} @gol
3926 -Wtype-limits  @gol
3927 -Wuninitialized  @gol
3928 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3929 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3930 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3933 The option @option{-Wextra} also prints warning messages for the
3934 following cases:
3936 @itemize @bullet
3938 @item
3939 A pointer is compared against integer zero with @code{<}, @code{<=},
3940 @code{>}, or @code{>=}.
3942 @item
3943 (C++ only) An enumerator and a non-enumerator both appear in a
3944 conditional expression.
3946 @item
3947 (C++ only) Ambiguous virtual bases.
3949 @item
3950 (C++ only) Subscripting an array that has been declared @code{register}.
3952 @item
3953 (C++ only) Taking the address of a variable that has been declared
3954 @code{register}.
3956 @item
3957 (C++ only) A base class is not initialized in the copy constructor
3958 of a derived class.
3960 @end itemize
3962 @item -Wchar-subscripts
3963 @opindex Wchar-subscripts
3964 @opindex Wno-char-subscripts
3965 Warn if an array subscript has type @code{char}.  This is a common cause
3966 of error, as programmers often forget that this type is signed on some
3967 machines.
3968 This warning is enabled by @option{-Wall}.
3970 @item -Wchkp
3971 @opindex Wchkp
3972 Warn about an invalid memory access that is found by Pointer Bounds Checker
3973 (@option{-fcheck-pointer-bounds}).
3975 @item -Wno-coverage-mismatch
3976 @opindex Wno-coverage-mismatch
3977 Warn if feedback profiles do not match when using the
3978 @option{-fprofile-use} option.
3979 If a source file is changed between compiling with @option{-fprofile-gen} and
3980 with @option{-fprofile-use}, the files with the profile feedback can fail
3981 to match the source file and GCC cannot use the profile feedback
3982 information.  By default, this warning is enabled and is treated as an
3983 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3984 warning or @option{-Wno-error=coverage-mismatch} can be used to
3985 disable the error.  Disabling the error for this warning can result in
3986 poorly optimized code and is useful only in the
3987 case of very minor changes such as bug fixes to an existing code-base.
3988 Completely disabling the warning is not recommended.
3990 @item -Wno-cpp
3991 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3993 Suppress warning messages emitted by @code{#warning} directives.
3995 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3996 @opindex Wdouble-promotion
3997 @opindex Wno-double-promotion
3998 Give a warning when a value of type @code{float} is implicitly
3999 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4000 floating-point unit implement @code{float} in hardware, but emulate
4001 @code{double} in software.  On such a machine, doing computations
4002 using @code{double} values is much more expensive because of the
4003 overhead required for software emulation.
4005 It is easy to accidentally do computations with @code{double} because
4006 floating-point literals are implicitly of type @code{double}.  For
4007 example, in:
4008 @smallexample
4009 @group
4010 float area(float radius)
4012    return 3.14159 * radius * radius;
4014 @end group
4015 @end smallexample
4016 the compiler performs the entire computation with @code{double}
4017 because the floating-point literal is a @code{double}.
4019 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4020 @opindex Wduplicate-decl-specifier
4021 @opindex Wno-duplicate-decl-specifier
4022 Warn if a declaration has duplicate @code{const}, @code{volatile},
4023 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4024 @option{-Wall}.
4026 @item -Wformat
4027 @itemx -Wformat=@var{n}
4028 @opindex Wformat
4029 @opindex Wno-format
4030 @opindex ffreestanding
4031 @opindex fno-builtin
4032 @opindex Wformat=
4033 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4034 the arguments supplied have types appropriate to the format string
4035 specified, and that the conversions specified in the format string make
4036 sense.  This includes standard functions, and others specified by format
4037 attributes (@pxref{Function Attributes}), in the @code{printf},
4038 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4039 not in the C standard) families (or other target-specific families).
4040 Which functions are checked without format attributes having been
4041 specified depends on the standard version selected, and such checks of
4042 functions without the attribute specified are disabled by
4043 @option{-ffreestanding} or @option{-fno-builtin}.
4045 The formats are checked against the format features supported by GNU
4046 libc version 2.2.  These include all ISO C90 and C99 features, as well
4047 as features from the Single Unix Specification and some BSD and GNU
4048 extensions.  Other library implementations may not support all these
4049 features; GCC does not support warning about features that go beyond a
4050 particular library's limitations.  However, if @option{-Wpedantic} is used
4051 with @option{-Wformat}, warnings are given about format features not
4052 in the selected standard version (but not for @code{strfmon} formats,
4053 since those are not in any version of the C standard).  @xref{C Dialect
4054 Options,,Options Controlling C Dialect}.
4056 @table @gcctabopt
4057 @item -Wformat=1
4058 @itemx -Wformat
4059 @opindex Wformat
4060 @opindex Wformat=1
4061 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4062 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4063 @option{-Wformat} also checks for null format arguments for several
4064 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4065 aspects of this level of format checking can be disabled by the
4066 options: @option{-Wno-format-contains-nul},
4067 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4068 @option{-Wformat} is enabled by @option{-Wall}.
4070 @item -Wno-format-contains-nul
4071 @opindex Wno-format-contains-nul
4072 @opindex Wformat-contains-nul
4073 If @option{-Wformat} is specified, do not warn about format strings that
4074 contain NUL bytes.
4076 @item -Wno-format-extra-args
4077 @opindex Wno-format-extra-args
4078 @opindex Wformat-extra-args
4079 If @option{-Wformat} is specified, do not warn about excess arguments to a
4080 @code{printf} or @code{scanf} format function.  The C standard specifies
4081 that such arguments are ignored.
4083 Where the unused arguments lie between used arguments that are
4084 specified with @samp{$} operand number specifications, normally
4085 warnings are still given, since the implementation could not know what
4086 type to pass to @code{va_arg} to skip the unused arguments.  However,
4087 in the case of @code{scanf} formats, this option suppresses the
4088 warning if the unused arguments are all pointers, since the Single
4089 Unix Specification says that such unused arguments are allowed.
4091 @item -Wformat-overflow
4092 @itemx -Wformat-overflow=@var{level}
4093 @opindex Wformat-overflow
4094 @opindex Wno-format-overflow
4095 Warn about calls to formatted input/output functions such as @code{sprintf}
4096 and @code{vsprintf} that might overflow the destination buffer.  When the
4097 exact number of bytes written by a format directive cannot be determined
4098 at compile-time it is estimated based on heuristics that depend on the
4099 @var{level} argument and on optimization.  While enabling optimization
4100 will in most cases improve the accuracy of the warning, it may also
4101 result in false positives.
4103 @table @gcctabopt
4104 @item -Wformat-overflow
4105 @item -Wformat-overflow=1
4106 @opindex Wformat-overflow
4107 @opindex Wno-format-overflow
4108 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4109 employs a conservative approach that warns only about calls that most
4110 likely overflow the buffer.  At this level, numeric arguments to format
4111 directives with unknown values are assumed to have the value of one, and
4112 strings of unknown length to be empty.  Numeric arguments that are known
4113 to be bounded to a subrange of their type, or string arguments whose output
4114 is bounded either by their directive's precision or by a finite set of
4115 string literals, are assumed to take on the value within the range that
4116 results in the most bytes on output.  For example, the call to @code{sprintf}
4117 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4118 the terminating NUL character (@code{'\0'}) appended by the function
4119 to the destination buffer will be written past its end.  Increasing
4120 the size of the buffer by a single byte is sufficient to avoid the
4121 warning, though it may not be sufficient to avoid the overflow.
4123 @smallexample
4124 void f (int a, int b)
4126   char buf [12];
4127   sprintf (buf, "a = %i, b = %i\n", a, b);
4129 @end smallexample
4131 @item -Wformat-overflow=2
4132 Level @var{2} warns also about calls that might overflow the destination
4133 buffer given an argument of sufficient length or magnitude.  At level
4134 @var{2}, unknown numeric arguments are assumed to have the minimum
4135 representable value for signed types with a precision greater than 1, and
4136 the maximum representable value otherwise.  Unknown string arguments whose
4137 length cannot be assumed to be bounded either by the directive's precision,
4138 or by a finite set of string literals they may evaluate to, or the character
4139 array they may point to, are assumed to be 1 character long.
4141 At level @var{2}, the call in the example above is again diagnosed, but
4142 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4143 @code{%i} directive will write some of its digits beyond the end of
4144 the destination buffer.  To make the call safe regardless of the values
4145 of the two variables, the size of the destination buffer must be increased
4146 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4147 an informational note following the warning.
4149 An alternative to increasing the size of the destination buffer is to
4150 constrain the range of formatted values.  The maximum length of string
4151 arguments can be bounded by specifying the precision in the format
4152 directive.  When numeric arguments of format directives can be assumed
4153 to be bounded by less than the precision of their type, choosing
4154 an appropriate length modifier to the format specifier will reduce
4155 the required buffer size.  For example, if @var{a} and @var{b} in the
4156 example above can be assumed to be within the precision of
4157 the @code{short int} type then using either the @code{%hi} format
4158 directive or casting the argument to @code{short} reduces the maximum
4159 required size of the buffer to 24 bytes.
4161 @smallexample
4162 void f (int a, int b)
4164   char buf [23];
4165   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4167 @end smallexample
4168 @end table
4170 @item -Wno-format-zero-length
4171 @opindex Wno-format-zero-length
4172 @opindex Wformat-zero-length
4173 If @option{-Wformat} is specified, do not warn about zero-length formats.
4174 The C standard specifies that zero-length formats are allowed.
4177 @item -Wformat=2
4178 @opindex Wformat=2
4179 Enable @option{-Wformat} plus additional format checks.  Currently
4180 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4181 -Wformat-y2k}.
4183 @item -Wformat-nonliteral
4184 @opindex Wformat-nonliteral
4185 @opindex Wno-format-nonliteral
4186 If @option{-Wformat} is specified, also warn if the format string is not a
4187 string literal and so cannot be checked, unless the format function
4188 takes its format arguments as a @code{va_list}.
4190 @item -Wformat-security
4191 @opindex Wformat-security
4192 @opindex Wno-format-security
4193 If @option{-Wformat} is specified, also warn about uses of format
4194 functions that represent possible security problems.  At present, this
4195 warns about calls to @code{printf} and @code{scanf} functions where the
4196 format string is not a string literal and there are no format arguments,
4197 as in @code{printf (foo);}.  This may be a security hole if the format
4198 string came from untrusted input and contains @samp{%n}.  (This is
4199 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4200 in future warnings may be added to @option{-Wformat-security} that are not
4201 included in @option{-Wformat-nonliteral}.)
4203 @item -Wformat-signedness
4204 @opindex Wformat-signedness
4205 @opindex Wno-format-signedness
4206 If @option{-Wformat} is specified, also warn if the format string
4207 requires an unsigned argument and the argument is signed and vice versa.
4209 @item -Wformat-truncation
4210 @itemx -Wformat-truncation=@var{level}
4211 @opindex Wformat-truncation
4212 @opindex Wno-format-truncation
4213 Warn about calls to formatted input/output functions such as @code{snprintf}
4214 and @code{vsnprintf} that might result in output truncation.  When the exact
4215 number of bytes written by a format directive cannot be determined at
4216 compile-time it is estimated based on heuristics that depend on
4217 the @var{level} argument and on optimization.  While enabling optimization
4218 will in most cases improve the accuracy of the warning, it may also result
4219 in false positives.  Except as noted otherwise, the option uses the same
4220 logic @option{-Wformat-overflow}.
4222 @table @gcctabopt
4223 @item -Wformat-truncation
4224 @item -Wformat-truncation=1
4225 @opindex Wformat-truncation
4226 @opindex Wno-format-overflow
4227 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4228 employs a conservative approach that warns only about calls to bounded
4229 functions whose return value is unused and that will most likely result
4230 in output truncation.
4232 @item -Wformat-truncation=2
4233 Level @var{2} warns also about calls to bounded functions whose return
4234 value is used and that might result in truncation given an argument of
4235 sufficient length or magnitude.
4236 @end table
4238 @item -Wformat-y2k
4239 @opindex Wformat-y2k
4240 @opindex Wno-format-y2k
4241 If @option{-Wformat} is specified, also warn about @code{strftime}
4242 formats that may yield only a two-digit year.
4243 @end table
4245 @item -Wnonnull
4246 @opindex Wnonnull
4247 @opindex Wno-nonnull
4248 Warn about passing a null pointer for arguments marked as
4249 requiring a non-null value by the @code{nonnull} function attribute.
4251 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4252 can be disabled with the @option{-Wno-nonnull} option.
4254 @item -Wnonnull-compare
4255 @opindex Wnonnull-compare
4256 @opindex Wno-nonnull-compare
4257 Warn when comparing an argument marked with the @code{nonnull}
4258 function attribute against null inside the function.
4260 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4261 can be disabled with the @option{-Wno-nonnull-compare} option.
4263 @item -Wnull-dereference
4264 @opindex Wnull-dereference
4265 @opindex Wno-null-dereference
4266 Warn if the compiler detects paths that trigger erroneous or
4267 undefined behavior due to dereferencing a null pointer.  This option
4268 is only active when @option{-fdelete-null-pointer-checks} is active,
4269 which is enabled by optimizations in most targets.  The precision of
4270 the warnings depends on the optimization options used.
4272 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4273 @opindex Winit-self
4274 @opindex Wno-init-self
4275 Warn about uninitialized variables that are initialized with themselves.
4276 Note this option can only be used with the @option{-Wuninitialized} option.
4278 For example, GCC warns about @code{i} being uninitialized in the
4279 following snippet only when @option{-Winit-self} has been specified:
4280 @smallexample
4281 @group
4282 int f()
4284   int i = i;
4285   return i;
4287 @end group
4288 @end smallexample
4290 This warning is enabled by @option{-Wall} in C++.
4292 @item -Wimplicit-int @r{(C and Objective-C only)}
4293 @opindex Wimplicit-int
4294 @opindex Wno-implicit-int
4295 Warn when a declaration does not specify a type.
4296 This warning is enabled by @option{-Wall}.
4298 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4299 @opindex Wimplicit-function-declaration
4300 @opindex Wno-implicit-function-declaration
4301 Give a warning whenever a function is used before being declared. In
4302 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4303 enabled by default and it is made into an error by
4304 @option{-pedantic-errors}. This warning is also enabled by
4305 @option{-Wall}.
4307 @item -Wimplicit @r{(C and Objective-C only)}
4308 @opindex Wimplicit
4309 @opindex Wno-implicit
4310 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4311 This warning is enabled by @option{-Wall}.
4313 @item -Wimplicit-fallthrough
4314 @opindex Wimplicit-fallthrough
4315 @opindex Wno-implicit-fallthrough
4316 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4317 and @option{-Wno-implicit-fallthrough} is the same as
4318 @option{-Wimplicit-fallthrough=0}.
4320 @item -Wimplicit-fallthrough=@var{n}
4321 @opindex Wimplicit-fallthrough=
4322 Warn when a switch case falls through.  For example:
4324 @smallexample
4325 @group
4326 switch (cond)
4327   @{
4328   case 1:
4329     a = 1;
4330     break;
4331   case 2:
4332     a = 2;
4333   case 3:
4334     a = 3;
4335     break;
4336   @}
4337 @end group
4338 @end smallexample
4340 This warning does not warn when the last statement of a case cannot
4341 fall through, e.g. when there is a return statement or a call to function
4342 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4343 also takes into account control flow statements, such as ifs, and only
4344 warns when appropriate.  E.g.@:
4346 @smallexample
4347 @group
4348 switch (cond)
4349   @{
4350   case 1:
4351     if (i > 3) @{
4352       bar (5);
4353       break;
4354     @} else if (i < 1) @{
4355       bar (0);
4356     @} else
4357       return;
4358   default:
4359     @dots{}
4360   @}
4361 @end group
4362 @end smallexample
4364 Since there are occasions where a switch case fall through is desirable,
4365 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4366 to be used along with a null statement to suppress this warning that
4367 would normally occur:
4369 @smallexample
4370 @group
4371 switch (cond)
4372   @{
4373   case 1:
4374     bar (0);
4375     __attribute__ ((fallthrough));
4376   default:
4377     @dots{}
4378   @}
4379 @end group
4380 @end smallexample
4382 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4383 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4384 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4385 Instead of these attributes, it is also possible to add a fallthrough comment
4386 to silence the warning.  The whole body of the C or C++ style comment should
4387 match the given regular expressions listed below.  The option argument @var{n}
4388 specifies what kind of comments are accepted:
4390 @itemize @bullet
4392 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4394 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4395 expression, any comment is used as fallthrough comment.
4397 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4398 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4400 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4401 following regular expressions:
4403 @itemize @bullet
4405 @item @code{-fallthrough}
4407 @item @code{@@fallthrough@@}
4409 @item @code{lint -fallthrough[ \t]*}
4411 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4413 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4415 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4417 @end itemize
4419 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4420 following regular expressions:
4422 @itemize @bullet
4424 @item @code{-fallthrough}
4426 @item @code{@@fallthrough@@}
4428 @item @code{lint -fallthrough[ \t]*}
4430 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4432 @end itemize
4434 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4435 fallthrough comments, only attributes disable the warning.
4437 @end itemize
4439 The comment needs to be followed after optional whitespace and other comments
4440 by @code{case} or @code{default} keywords or by a user label that precedes some
4441 @code{case} or @code{default} label.
4443 @smallexample
4444 @group
4445 switch (cond)
4446   @{
4447   case 1:
4448     bar (0);
4449     /* FALLTHRU */
4450   default:
4451     @dots{}
4452   @}
4453 @end group
4454 @end smallexample
4456 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4458 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4459 @opindex Wif-not-aligned
4460 @opindex Wno-if-not-aligned
4461 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4462 should be issued.  This is is enabled by default.
4463 Use @option{-Wno-if-not-aligned} to disable it.
4465 @item -Wignored-qualifiers @r{(C and C++ only)}
4466 @opindex Wignored-qualifiers
4467 @opindex Wno-ignored-qualifiers
4468 Warn if the return type of a function has a type qualifier
4469 such as @code{const}.  For ISO C such a type qualifier has no effect,
4470 since the value returned by a function is not an lvalue.
4471 For C++, the warning is only emitted for scalar types or @code{void}.
4472 ISO C prohibits qualified @code{void} return types on function
4473 definitions, so such return types always receive a warning
4474 even without this option.
4476 This warning is also enabled by @option{-Wextra}.
4478 @item -Wignored-attributes @r{(C and C++ only)}
4479 @opindex Wignored-attributes
4480 @opindex Wno-ignored-attributes
4481 Warn when an attribute is ignored.  This is different from the
4482 @option{-Wattributes} option in that it warns whenever the compiler decides
4483 to drop an attribute, not that the attribute is either unknown, used in a
4484 wrong place, etc.  This warning is enabled by default.
4486 @item -Wmain
4487 @opindex Wmain
4488 @opindex Wno-main
4489 Warn if the type of @code{main} is suspicious.  @code{main} should be
4490 a function with external linkage, returning int, taking either zero
4491 arguments, two, or three arguments of appropriate types.  This warning
4492 is enabled by default in C++ and is enabled by either @option{-Wall}
4493 or @option{-Wpedantic}.
4495 @item -Wmisleading-indentation @r{(C and C++ only)}
4496 @opindex Wmisleading-indentation
4497 @opindex Wno-misleading-indentation
4498 Warn when the indentation of the code does not reflect the block structure.
4499 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4500 @code{for} clauses with a guarded statement that does not use braces,
4501 followed by an unguarded statement with the same indentation.
4503 In the following example, the call to ``bar'' is misleadingly indented as
4504 if it were guarded by the ``if'' conditional.
4506 @smallexample
4507   if (some_condition ())
4508     foo ();
4509     bar ();  /* Gotcha: this is not guarded by the "if".  */
4510 @end smallexample
4512 In the case of mixed tabs and spaces, the warning uses the
4513 @option{-ftabstop=} option to determine if the statements line up
4514 (defaulting to 8).
4516 The warning is not issued for code involving multiline preprocessor logic
4517 such as the following example.
4519 @smallexample
4520   if (flagA)
4521     foo (0);
4522 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4523   if (flagB)
4524 #endif
4525     foo (1);
4526 @end smallexample
4528 The warning is not issued after a @code{#line} directive, since this
4529 typically indicates autogenerated code, and no assumptions can be made
4530 about the layout of the file that the directive references.
4532 This warning is enabled by @option{-Wall} in C and C++.
4534 @item -Wmissing-braces
4535 @opindex Wmissing-braces
4536 @opindex Wno-missing-braces
4537 Warn if an aggregate or union initializer is not fully bracketed.  In
4538 the following example, the initializer for @code{a} is not fully
4539 bracketed, but that for @code{b} is fully bracketed.  This warning is
4540 enabled by @option{-Wall} in C.
4542 @smallexample
4543 int a[2][2] = @{ 0, 1, 2, 3 @};
4544 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4545 @end smallexample
4547 This warning is enabled by @option{-Wall}.
4549 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4550 @opindex Wmissing-include-dirs
4551 @opindex Wno-missing-include-dirs
4552 Warn if a user-supplied include directory does not exist.
4554 @item -Wmultistatement-macros
4555 @opindex Wmultistatement-macros
4556 @opindex Wno-multistatement-macros
4557 Warn about unsafe multiple statement macros that appear to be guarded
4558 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4559 @code{while}, in which only the first statement is actually guarded after
4560 the macro is expanded.
4562 For example:
4564 @smallexample
4565 #define DOIT x++; y++
4566 if (c)
4567   DOIT;
4568 @end smallexample
4570 will increment @code{y} unconditionally, not just when @code{c} holds.
4571 The can usually be fixed by wrapping the macro in a do-while loop:
4572 @smallexample
4573 #define DOIT do @{ x++; y++; @} while (0)
4574 if (c)
4575   DOIT;
4576 @end smallexample
4578 This warning is enabled by @option{-Wall} in C and C++.
4580 @item -Wparentheses
4581 @opindex Wparentheses
4582 @opindex Wno-parentheses
4583 Warn if parentheses are omitted in certain contexts, such
4584 as when there is an assignment in a context where a truth value
4585 is expected, or when operators are nested whose precedence people
4586 often get confused about.
4588 Also warn if a comparison like @code{x<=y<=z} appears; this is
4589 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4590 interpretation from that of ordinary mathematical notation.
4592 Also warn for dangerous uses of the GNU extension to
4593 @code{?:} with omitted middle operand. When the condition
4594 in the @code{?}: operator is a boolean expression, the omitted value is
4595 always 1.  Often programmers expect it to be a value computed
4596 inside the conditional expression instead.
4598 For C++ this also warns for some cases of unnecessary parentheses in
4599 declarations, which can indicate an attempt at a function call instead
4600 of a declaration:
4601 @smallexample
4603   // Declares a local variable called mymutex.
4604   std::unique_lock<std::mutex> (mymutex);
4605   // User meant std::unique_lock<std::mutex> lock (mymutex);
4607 @end smallexample
4609 This warning is enabled by @option{-Wall}.
4611 @item -Wsequence-point
4612 @opindex Wsequence-point
4613 @opindex Wno-sequence-point
4614 Warn about code that may have undefined semantics because of violations
4615 of sequence point rules in the C and C++ standards.
4617 The C and C++ standards define the order in which expressions in a C/C++
4618 program are evaluated in terms of @dfn{sequence points}, which represent
4619 a partial ordering between the execution of parts of the program: those
4620 executed before the sequence point, and those executed after it.  These
4621 occur after the evaluation of a full expression (one which is not part
4622 of a larger expression), after the evaluation of the first operand of a
4623 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4624 function is called (but after the evaluation of its arguments and the
4625 expression denoting the called function), and in certain other places.
4626 Other than as expressed by the sequence point rules, the order of
4627 evaluation of subexpressions of an expression is not specified.  All
4628 these rules describe only a partial order rather than a total order,
4629 since, for example, if two functions are called within one expression
4630 with no sequence point between them, the order in which the functions
4631 are called is not specified.  However, the standards committee have
4632 ruled that function calls do not overlap.
4634 It is not specified when between sequence points modifications to the
4635 values of objects take effect.  Programs whose behavior depends on this
4636 have undefined behavior; the C and C++ standards specify that ``Between
4637 the previous and next sequence point an object shall have its stored
4638 value modified at most once by the evaluation of an expression.
4639 Furthermore, the prior value shall be read only to determine the value
4640 to be stored.''.  If a program breaks these rules, the results on any
4641 particular implementation are entirely unpredictable.
4643 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4644 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4645 diagnosed by this option, and it may give an occasional false positive
4646 result, but in general it has been found fairly effective at detecting
4647 this sort of problem in programs.
4649 The C++17 standard will define the order of evaluation of operands in
4650 more cases: in particular it requires that the right-hand side of an
4651 assignment be evaluated before the left-hand side, so the above
4652 examples are no longer undefined.  But this warning will still warn
4653 about them, to help people avoid writing code that is undefined in C
4654 and earlier revisions of C++.
4656 The standard is worded confusingly, therefore there is some debate
4657 over the precise meaning of the sequence point rules in subtle cases.
4658 Links to discussions of the problem, including proposed formal
4659 definitions, may be found on the GCC readings page, at
4660 @uref{http://gcc.gnu.org/@/readings.html}.
4662 This warning is enabled by @option{-Wall} for C and C++.
4664 @item -Wno-return-local-addr
4665 @opindex Wno-return-local-addr
4666 @opindex Wreturn-local-addr
4667 Do not warn about returning a pointer (or in C++, a reference) to a
4668 variable that goes out of scope after the function returns.
4670 @item -Wreturn-type
4671 @opindex Wreturn-type
4672 @opindex Wno-return-type
4673 Warn whenever a function is defined with a return type that defaults
4674 to @code{int}.  Also warn about any @code{return} statement with no
4675 return value in a function whose return type is not @code{void}
4676 (falling off the end of the function body is considered returning
4677 without a value).
4679 For C only, warn about a @code{return} statement with an expression in a
4680 function whose return type is @code{void}, unless the expression type is
4681 also @code{void}.  As a GNU extension, the latter case is accepted
4682 without a warning unless @option{-Wpedantic} is used.
4684 For C++, a function without return type always produces a diagnostic
4685 message, even when @option{-Wno-return-type} is specified.  The only
4686 exceptions are @code{main} and functions defined in system headers.
4688 This warning is enabled by @option{-Wall}.
4690 @item -Wshift-count-negative
4691 @opindex Wshift-count-negative
4692 @opindex Wno-shift-count-negative
4693 Warn if shift count is negative. This warning is enabled by default.
4695 @item -Wshift-count-overflow
4696 @opindex Wshift-count-overflow
4697 @opindex Wno-shift-count-overflow
4698 Warn if shift count >= width of type. This warning is enabled by default.
4700 @item -Wshift-negative-value
4701 @opindex Wshift-negative-value
4702 @opindex Wno-shift-negative-value
4703 Warn if left shifting a negative value.  This warning is enabled by
4704 @option{-Wextra} in C99 and C++11 modes (and newer).
4706 @item -Wshift-overflow
4707 @itemx -Wshift-overflow=@var{n}
4708 @opindex Wshift-overflow
4709 @opindex Wno-shift-overflow
4710 Warn about left shift overflows.  This warning is enabled by
4711 default in C99 and C++11 modes (and newer).
4713 @table @gcctabopt
4714 @item -Wshift-overflow=1
4715 This is the warning level of @option{-Wshift-overflow} and is enabled
4716 by default in C99 and C++11 modes (and newer).  This warning level does
4717 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4718 an overflow is still rejected in contexts where an integer constant expression
4719 is required.)
4721 @item -Wshift-overflow=2
4722 This warning level also warns about left-shifting 1 into the sign bit,
4723 unless C++14 mode is active.
4724 @end table
4726 @item -Wswitch
4727 @opindex Wswitch
4728 @opindex Wno-switch
4729 Warn whenever a @code{switch} statement has an index of enumerated type
4730 and lacks a @code{case} for one or more of the named codes of that
4731 enumeration.  (The presence of a @code{default} label prevents this
4732 warning.)  @code{case} labels outside the enumeration range also
4733 provoke warnings when this option is used (even if there is a
4734 @code{default} label).
4735 This warning is enabled by @option{-Wall}.
4737 @item -Wswitch-default
4738 @opindex Wswitch-default
4739 @opindex Wno-switch-default
4740 Warn whenever a @code{switch} statement does not have a @code{default}
4741 case.
4743 @item -Wswitch-enum
4744 @opindex Wswitch-enum
4745 @opindex Wno-switch-enum
4746 Warn whenever a @code{switch} statement has an index of enumerated type
4747 and lacks a @code{case} for one or more of the named codes of that
4748 enumeration.  @code{case} labels outside the enumeration range also
4749 provoke warnings when this option is used.  The only difference
4750 between @option{-Wswitch} and this option is that this option gives a
4751 warning about an omitted enumeration code even if there is a
4752 @code{default} label.
4754 @item -Wswitch-bool
4755 @opindex Wswitch-bool
4756 @opindex Wno-switch-bool
4757 Warn whenever a @code{switch} statement has an index of boolean type
4758 and the case values are outside the range of a boolean type.
4759 It is possible to suppress this warning by casting the controlling
4760 expression to a type other than @code{bool}.  For example:
4761 @smallexample
4762 @group
4763 switch ((int) (a == 4))
4764   @{
4765   @dots{}
4766   @}
4767 @end group
4768 @end smallexample
4769 This warning is enabled by default for C and C++ programs.
4771 @item -Wswitch-unreachable
4772 @opindex Wswitch-unreachable
4773 @opindex Wno-switch-unreachable
4774 Warn whenever a @code{switch} statement contains statements between the
4775 controlling expression and the first case label, which will never be
4776 executed.  For example:
4777 @smallexample
4778 @group
4779 switch (cond)
4780   @{
4781    i = 15;
4782   @dots{}
4783    case 5:
4784   @dots{}
4785   @}
4786 @end group
4787 @end smallexample
4788 @option{-Wswitch-unreachable} does not warn if the statement between the
4789 controlling expression and the first case label is just a declaration:
4790 @smallexample
4791 @group
4792 switch (cond)
4793   @{
4794    int i;
4795   @dots{}
4796    case 5:
4797    i = 5;
4798   @dots{}
4799   @}
4800 @end group
4801 @end smallexample
4802 This warning is enabled by default for C and C++ programs.
4804 @item -Wsync-nand @r{(C and C++ only)}
4805 @opindex Wsync-nand
4806 @opindex Wno-sync-nand
4807 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4808 built-in functions are used.  These functions changed semantics in GCC 4.4.
4810 @item -Wunused-but-set-parameter
4811 @opindex Wunused-but-set-parameter
4812 @opindex Wno-unused-but-set-parameter
4813 Warn whenever a function parameter is assigned to, but otherwise unused
4814 (aside from its declaration).
4816 To suppress this warning use the @code{unused} attribute
4817 (@pxref{Variable Attributes}).
4819 This warning is also enabled by @option{-Wunused} together with
4820 @option{-Wextra}.
4822 @item -Wunused-but-set-variable
4823 @opindex Wunused-but-set-variable
4824 @opindex Wno-unused-but-set-variable
4825 Warn whenever a local variable is assigned to, but otherwise unused
4826 (aside from its declaration).
4827 This warning is enabled by @option{-Wall}.
4829 To suppress this warning use the @code{unused} attribute
4830 (@pxref{Variable Attributes}).
4832 This warning is also enabled by @option{-Wunused}, which is enabled
4833 by @option{-Wall}.
4835 @item -Wunused-function
4836 @opindex Wunused-function
4837 @opindex Wno-unused-function
4838 Warn whenever a static function is declared but not defined or a
4839 non-inline static function is unused.
4840 This warning is enabled by @option{-Wall}.
4842 @item -Wunused-label
4843 @opindex Wunused-label
4844 @opindex Wno-unused-label
4845 Warn whenever a label is declared but not used.
4846 This warning is enabled by @option{-Wall}.
4848 To suppress this warning use the @code{unused} attribute
4849 (@pxref{Variable Attributes}).
4851 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4852 @opindex Wunused-local-typedefs
4853 Warn when a typedef locally defined in a function is not used.
4854 This warning is enabled by @option{-Wall}.
4856 @item -Wunused-parameter
4857 @opindex Wunused-parameter
4858 @opindex Wno-unused-parameter
4859 Warn whenever a function parameter is unused aside from its declaration.
4861 To suppress this warning use the @code{unused} attribute
4862 (@pxref{Variable Attributes}).
4864 @item -Wno-unused-result
4865 @opindex Wunused-result
4866 @opindex Wno-unused-result
4867 Do not warn if a caller of a function marked with attribute
4868 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4869 its return value. The default is @option{-Wunused-result}.
4871 @item -Wunused-variable
4872 @opindex Wunused-variable
4873 @opindex Wno-unused-variable
4874 Warn whenever a local or static variable is unused aside from its
4875 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4876 but not for C++. This warning is enabled by @option{-Wall}.
4878 To suppress this warning use the @code{unused} attribute
4879 (@pxref{Variable Attributes}).
4881 @item -Wunused-const-variable
4882 @itemx -Wunused-const-variable=@var{n}
4883 @opindex Wunused-const-variable
4884 @opindex Wno-unused-const-variable
4885 Warn whenever a constant static variable is unused aside from its declaration.
4886 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4887 for C, but not for C++. In C this declares variable storage, but in C++ this
4888 is not an error since const variables take the place of @code{#define}s.
4890 To suppress this warning use the @code{unused} attribute
4891 (@pxref{Variable Attributes}).
4893 @table @gcctabopt
4894 @item -Wunused-const-variable=1
4895 This is the warning level that is enabled by @option{-Wunused-variable} for
4896 C.  It warns only about unused static const variables defined in the main
4897 compilation unit, but not about static const variables declared in any
4898 header included.
4900 @item -Wunused-const-variable=2
4901 This warning level also warns for unused constant static variables in
4902 headers (excluding system headers).  This is the warning level of
4903 @option{-Wunused-const-variable} and must be explicitly requested since
4904 in C++ this isn't an error and in C it might be harder to clean up all
4905 headers included.
4906 @end table
4908 @item -Wunused-value
4909 @opindex Wunused-value
4910 @opindex Wno-unused-value
4911 Warn whenever a statement computes a result that is explicitly not
4912 used. To suppress this warning cast the unused expression to
4913 @code{void}. This includes an expression-statement or the left-hand
4914 side of a comma expression that contains no side effects. For example,
4915 an expression such as @code{x[i,j]} causes a warning, while
4916 @code{x[(void)i,j]} does not.
4918 This warning is enabled by @option{-Wall}.
4920 @item -Wunused
4921 @opindex Wunused
4922 @opindex Wno-unused
4923 All the above @option{-Wunused} options combined.
4925 In order to get a warning about an unused function parameter, you must
4926 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4927 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4929 @item -Wuninitialized
4930 @opindex Wuninitialized
4931 @opindex Wno-uninitialized
4932 Warn if an automatic variable is used without first being initialized
4933 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4934 warn if a non-static reference or non-static @code{const} member
4935 appears in a class without constructors.
4937 If you want to warn about code that uses the uninitialized value of the
4938 variable in its own initializer, use the @option{-Winit-self} option.
4940 These warnings occur for individual uninitialized or clobbered
4941 elements of structure, union or array variables as well as for
4942 variables that are uninitialized or clobbered as a whole.  They do
4943 not occur for variables or elements declared @code{volatile}.  Because
4944 these warnings depend on optimization, the exact variables or elements
4945 for which there are warnings depends on the precise optimization
4946 options and version of GCC used.
4948 Note that there may be no warning about a variable that is used only
4949 to compute a value that itself is never used, because such
4950 computations may be deleted by data flow analysis before the warnings
4951 are printed.
4953 @item -Winvalid-memory-model
4954 @opindex Winvalid-memory-model
4955 @opindex Wno-invalid-memory-model
4956 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4957 and the C11 atomic generic functions with a memory consistency argument
4958 that is either invalid for the operation or outside the range of values
4959 of the @code{memory_order} enumeration.  For example, since the
4960 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4961 defined for the relaxed, release, and sequentially consistent memory
4962 orders the following code is diagnosed:
4964 @smallexample
4965 void store (int *i)
4967   __atomic_store_n (i, 0, memory_order_consume);
4969 @end smallexample
4971 @option{-Winvalid-memory-model} is enabled by default.
4973 @item -Wmaybe-uninitialized
4974 @opindex Wmaybe-uninitialized
4975 @opindex Wno-maybe-uninitialized
4976 For an automatic (i.e.@ local) variable, if there exists a path from the
4977 function entry to a use of the variable that is initialized, but there exist
4978 some other paths for which the variable is not initialized, the compiler
4979 emits a warning if it cannot prove the uninitialized paths are not
4980 executed at run time.
4982 These warnings are only possible in optimizing compilation, because otherwise
4983 GCC does not keep track of the state of variables.
4985 These warnings are made optional because GCC may not be able to determine when
4986 the code is correct in spite of appearing to have an error.  Here is one
4987 example of how this can happen:
4989 @smallexample
4990 @group
4992   int x;
4993   switch (y)
4994     @{
4995     case 1: x = 1;
4996       break;
4997     case 2: x = 4;
4998       break;
4999     case 3: x = 5;
5000     @}
5001   foo (x);
5003 @end group
5004 @end smallexample
5006 @noindent
5007 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5008 always initialized, but GCC doesn't know this. To suppress the
5009 warning, you need to provide a default case with assert(0) or
5010 similar code.
5012 @cindex @code{longjmp} warnings
5013 This option also warns when a non-volatile automatic variable might be
5014 changed by a call to @code{longjmp}.
5015 The compiler sees only the calls to @code{setjmp}.  It cannot know
5016 where @code{longjmp} will be called; in fact, a signal handler could
5017 call it at any point in the code.  As a result, you may get a warning
5018 even when there is in fact no problem because @code{longjmp} cannot
5019 in fact be called at the place that would cause a problem.
5021 Some spurious warnings can be avoided if you declare all the functions
5022 you use that never return as @code{noreturn}.  @xref{Function
5023 Attributes}.
5025 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5027 @item -Wunknown-pragmas
5028 @opindex Wunknown-pragmas
5029 @opindex Wno-unknown-pragmas
5030 @cindex warning for unknown pragmas
5031 @cindex unknown pragmas, warning
5032 @cindex pragmas, warning of unknown
5033 Warn when a @code{#pragma} directive is encountered that is not understood by 
5034 GCC@.  If this command-line option is used, warnings are even issued
5035 for unknown pragmas in system header files.  This is not the case if
5036 the warnings are only enabled by the @option{-Wall} command-line option.
5038 @item -Wno-pragmas
5039 @opindex Wno-pragmas
5040 @opindex Wpragmas
5041 Do not warn about misuses of pragmas, such as incorrect parameters,
5042 invalid syntax, or conflicts between pragmas.  See also
5043 @option{-Wunknown-pragmas}.
5045 @item -Wstrict-aliasing
5046 @opindex Wstrict-aliasing
5047 @opindex Wno-strict-aliasing
5048 This option is only active when @option{-fstrict-aliasing} is active.
5049 It warns about code that might break the strict aliasing rules that the
5050 compiler is using for optimization.  The warning does not catch all
5051 cases, but does attempt to catch the more common pitfalls.  It is
5052 included in @option{-Wall}.
5053 It is equivalent to @option{-Wstrict-aliasing=3}
5055 @item -Wstrict-aliasing=n
5056 @opindex Wstrict-aliasing=n
5057 This option is only active when @option{-fstrict-aliasing} is active.
5058 It warns about code that might break the strict aliasing rules that the
5059 compiler is using for optimization.
5060 Higher levels correspond to higher accuracy (fewer false positives).
5061 Higher levels also correspond to more effort, similar to the way @option{-O} 
5062 works.
5063 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5065 Level 1: Most aggressive, quick, least accurate.
5066 Possibly useful when higher levels
5067 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5068 false negatives.  However, it has many false positives.
5069 Warns for all pointer conversions between possibly incompatible types,
5070 even if never dereferenced.  Runs in the front end only.
5072 Level 2: Aggressive, quick, not too precise.
5073 May still have many false positives (not as many as level 1 though),
5074 and few false negatives (but possibly more than level 1).
5075 Unlike level 1, it only warns when an address is taken.  Warns about
5076 incomplete types.  Runs in the front end only.
5078 Level 3 (default for @option{-Wstrict-aliasing}):
5079 Should have very few false positives and few false
5080 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5081 Takes care of the common pun+dereference pattern in the front end:
5082 @code{*(int*)&some_float}.
5083 If optimization is enabled, it also runs in the back end, where it deals
5084 with multiple statement cases using flow-sensitive points-to information.
5085 Only warns when the converted pointer is dereferenced.
5086 Does not warn about incomplete types.
5088 @item -Wstrict-overflow
5089 @itemx -Wstrict-overflow=@var{n}
5090 @opindex Wstrict-overflow
5091 @opindex Wno-strict-overflow
5092 This option is only active when signed overflow is undefined.
5093 It warns about cases where the compiler optimizes based on the
5094 assumption that signed overflow does not occur.  Note that it does not
5095 warn about all cases where the code might overflow: it only warns
5096 about cases where the compiler implements some optimization.  Thus
5097 this warning depends on the optimization level.
5099 An optimization that assumes that signed overflow does not occur is
5100 perfectly safe if the values of the variables involved are such that
5101 overflow never does, in fact, occur.  Therefore this warning can
5102 easily give a false positive: a warning about code that is not
5103 actually a problem.  To help focus on important issues, several
5104 warning levels are defined.  No warnings are issued for the use of
5105 undefined signed overflow when estimating how many iterations a loop
5106 requires, in particular when determining whether a loop will be
5107 executed at all.
5109 @table @gcctabopt
5110 @item -Wstrict-overflow=1
5111 Warn about cases that are both questionable and easy to avoid.  For
5112 example the compiler simplifies
5113 @code{x + 1 > x} to @code{1}.  This level of
5114 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5115 are not, and must be explicitly requested.
5117 @item -Wstrict-overflow=2
5118 Also warn about other cases where a comparison is simplified to a
5119 constant.  For example: @code{abs (x) >= 0}.  This can only be
5120 simplified when signed integer overflow is undefined, because
5121 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5122 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5123 @option{-Wstrict-overflow=2}.
5125 @item -Wstrict-overflow=3
5126 Also warn about other cases where a comparison is simplified.  For
5127 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5129 @item -Wstrict-overflow=4
5130 Also warn about other simplifications not covered by the above cases.
5131 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5133 @item -Wstrict-overflow=5
5134 Also warn about cases where the compiler reduces the magnitude of a
5135 constant involved in a comparison.  For example: @code{x + 2 > y} is
5136 simplified to @code{x + 1 >= y}.  This is reported only at the
5137 highest warning level because this simplification applies to many
5138 comparisons, so this warning level gives a very large number of
5139 false positives.
5140 @end table
5142 @item -Wstringop-overflow
5143 @itemx -Wstringop-overflow=@var{type}
5144 @opindex Wstringop-overflow
5145 @opindex Wno-stringop-overflow
5146 Warn for calls to string manipulation functions such as @code{memcpy} and
5147 @code{strcpy} that are determined to overflow the destination buffer.  The
5148 optional argument is one greater than the type of Object Size Checking to
5149 perform to determine the size of the destination.  @xref{Object Size Checking}.
5150 The argument is meaningful only for functions that operate on character arrays
5151 but not for raw memory functions like @code{memcpy} which always make use
5152 of Object Size type-0.  The option also warns for calls that specify a size
5153 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5154 The option produces the best results with optimization enabled but can detect
5155 a small subset of simple buffer overflows even without optimization in
5156 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5157 correspond to the standard functions.  In any case, the option warns about
5158 just a subset of buffer overflows detected by the corresponding overflow
5159 checking built-ins.  For example, the option will issue a warning for
5160 the @code{strcpy} call below because it copies at least 5 characters
5161 (the string @code{"blue"} including the terminating NUL) into the buffer
5162 of size 4.
5164 @smallexample
5165 enum Color @{ blue, purple, yellow @};
5166 const char* f (enum Color clr)
5168   static char buf [4];
5169   const char *str;
5170   switch (clr)
5171     @{
5172       case blue: str = "blue"; break;
5173       case purple: str = "purple"; break;
5174       case yellow: str = "yellow"; break;
5175     @}
5177   return strcpy (buf, str);   // warning here
5179 @end smallexample
5181 Option @option{-Wstringop-overflow=2} is enabled by default.
5183 @table @gcctabopt
5184 @item -Wstringop-overflow
5185 @item -Wstringop-overflow=1
5186 @opindex Wstringop-overflow
5187 @opindex Wno-stringop-overflow
5188 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5189 to determine the sizes of destination objects.  This is the default setting
5190 of the option.  At this setting the option will not warn for writes past
5191 the end of subobjects of larger objects accessed by pointers unless the
5192 size of the largest surrounding object is known.  When the destination may
5193 be one of several objects it is assumed to be the largest one of them.  On
5194 Linux systems, when optimization is enabled at this setting the option warns
5195 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5196 a non-zero value.
5198 @item -Wstringop-overflow=2
5199 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5200 to determine the sizes of destination objects.  At this setting the option
5201 will warn about overflows when writing to members of the largest complete
5202 objects whose exact size is known.  It will, however, not warn for excessive
5203 writes to the same members of unknown objects referenced by pointers since
5204 they may point to arrays containing unknown numbers of elements.
5206 @item -Wstringop-overflow=3
5207 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5208 to determine the sizes of destination objects.  At this setting the option
5209 warns about overflowing the smallest object or data member.  This is the
5210 most restrictive setting of the option that may result in warnings for safe
5211 code.
5213 @item -Wstringop-overflow=4
5214 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5215 to determine the sizes of destination objects.  At this setting the option
5216 will warn about overflowing any data members, and when the destination is
5217 one of several objects it uses the size of the largest of them to decide
5218 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5219 setting of the option may result in warnings for benign code.
5220 @end table
5222 @item -Wstringop-truncation
5223 @opindex Wstringop-truncation
5224 @opindex Wno-stringop-truncation
5225 Warn for calls to bounded string manipulation functions such as @code{strncat},
5226 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5227 or leave the destination unchanged.
5229 In the following example, the call to @code{strncat} specifies a bound that
5230 is less than the length of the source string.  As a result, the copy of
5231 the source will be truncated and so the call is diagnosed.  To avoid the
5232 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5234 @smallexample
5235 void append (char *buf, size_t bufsize)
5237   strncat (buf, ".txt", 3);
5239 @end smallexample
5241 As another example, the following call to @code{strncpy} results in copying
5242 to @code{d} just the characters preceding the terminating NUL, without
5243 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5244 necessarily a NUL-terminated string is a common mistake, and so the call
5245 is diagnosed.  To avoid the warning when the result is not expected to be
5246 NUL-terminated, call @code{memcpy} instead.
5248 @smallexample
5249 void copy (char *d, const char *s)
5251   strncpy (d, s, strlen (s));
5253 @end smallexample
5255 In the following example, the call to @code{strncpy} specifies the size
5256 of the destination buffer as the bound.  If the length of the source
5257 string is equal to or greater than this size the result of the copy will
5258 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5259 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5260 element of the buffer to @code{NUL}.
5262 @smallexample
5263 void copy (const char *s)
5265   char buf[80];
5266   strncpy (buf, s, sizeof buf);
5267   @dots{}
5269 @end smallexample
5271 In situations where a character array is intended to store a sequence
5272 of bytes with no terminating @code{NUL} such an array may be annotated
5273 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5274 however, are not suitable arguments to functions that expect
5275 @code{NUL}-terminated strings.  To help detect accidental misuses of
5276 such arrays GCC issues warnings unless it can prove that the use is
5277 safe.  @xref{Common Variable Attributes}.
5279 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5280 @opindex Wsuggest-attribute=
5281 @opindex Wno-suggest-attribute=
5282 Warn for cases where adding an attribute may be beneficial. The
5283 attributes currently supported are listed below.
5285 @table @gcctabopt
5286 @item -Wsuggest-attribute=pure
5287 @itemx -Wsuggest-attribute=const
5288 @itemx -Wsuggest-attribute=noreturn
5289 @itemx -Wsuggest-attribute=malloc
5290 @opindex Wsuggest-attribute=pure
5291 @opindex Wno-suggest-attribute=pure
5292 @opindex Wsuggest-attribute=const
5293 @opindex Wno-suggest-attribute=const
5294 @opindex Wsuggest-attribute=noreturn
5295 @opindex Wno-suggest-attribute=noreturn
5296 @opindex Wsuggest-attribute=malloc
5297 @opindex Wno-suggest-attribute=malloc
5299 Warn about functions that might be candidates for attributes
5300 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5301 only warns for functions visible in other compilation units or (in the case of
5302 @code{pure} and @code{const}) if it cannot prove that the function returns
5303 normally. A function returns normally if it doesn't contain an infinite loop or
5304 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5305 requires option @option{-fipa-pure-const}, which is enabled by default at
5306 @option{-O} and higher.  Higher optimization levels improve the accuracy
5307 of the analysis.
5309 @item -Wsuggest-attribute=format
5310 @itemx -Wmissing-format-attribute
5311 @opindex Wsuggest-attribute=format
5312 @opindex Wmissing-format-attribute
5313 @opindex Wno-suggest-attribute=format
5314 @opindex Wno-missing-format-attribute
5315 @opindex Wformat
5316 @opindex Wno-format
5318 Warn about function pointers that might be candidates for @code{format}
5319 attributes.  Note these are only possible candidates, not absolute ones.
5320 GCC guesses that function pointers with @code{format} attributes that
5321 are used in assignment, initialization, parameter passing or return
5322 statements should have a corresponding @code{format} attribute in the
5323 resulting type.  I.e.@: the left-hand side of the assignment or
5324 initialization, the type of the parameter variable, or the return type
5325 of the containing function respectively should also have a @code{format}
5326 attribute to avoid the warning.
5328 GCC also warns about function definitions that might be
5329 candidates for @code{format} attributes.  Again, these are only
5330 possible candidates.  GCC guesses that @code{format} attributes
5331 might be appropriate for any function that calls a function like
5332 @code{vprintf} or @code{vscanf}, but this might not always be the
5333 case, and some functions for which @code{format} attributes are
5334 appropriate may not be detected.
5336 @item -Wsuggest-attribute=cold
5337 @opindex Wsuggest-attribute=cold
5338 @opindex Wno-suggest-attribute=cold
5340 Warn about functions that might be candidates for @code{cold} attribute.  This
5341 is based on static detection and generally will only warn about functions which
5342 always leads to a call to another @code{cold} function such as wrappers of
5343 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5344 @end table
5346 @item -Wsuggest-final-types
5347 @opindex Wno-suggest-final-types
5348 @opindex Wsuggest-final-types
5349 Warn about types with virtual methods where code quality would be improved
5350 if the type were declared with the C++11 @code{final} specifier, 
5351 or, if possible,
5352 declared in an anonymous namespace. This allows GCC to more aggressively
5353 devirtualize the polymorphic calls. This warning is more effective with link
5354 time optimization, where the information about the class hierarchy graph is
5355 more complete.
5357 @item -Wsuggest-final-methods
5358 @opindex Wno-suggest-final-methods
5359 @opindex Wsuggest-final-methods
5360 Warn about virtual methods where code quality would be improved if the method
5361 were declared with the C++11 @code{final} specifier, 
5362 or, if possible, its type were
5363 declared in an anonymous namespace or with the @code{final} specifier.
5364 This warning is
5365 more effective with link-time optimization, where the information about the
5366 class hierarchy graph is more complete. It is recommended to first consider
5367 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5368 annotations.
5370 @item -Wsuggest-override
5371 Warn about overriding virtual functions that are not marked with the override
5372 keyword.
5374 @item -Walloc-zero
5375 @opindex Wno-alloc-zero
5376 @opindex Walloc-zero
5377 Warn about calls to allocation functions decorated with attribute
5378 @code{alloc_size} that specify zero bytes, including those to the built-in
5379 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5380 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5381 when called with a zero size differs among implementations (and in the case
5382 of @code{realloc} has been deprecated) relying on it may result in subtle
5383 portability bugs and should be avoided.
5385 @item -Walloc-size-larger-than=@var{n}
5386 Warn about calls to functions decorated with attribute @code{alloc_size}
5387 that attempt to allocate objects larger than the specified number of bytes,
5388 or where the result of the size computation in an integer type with infinite
5389 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5390 may end in one of the standard suffixes designating a multiple of bytes
5391 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5392 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5393 @xref{Function Attributes}.
5395 @item -Walloca
5396 @opindex Wno-alloca
5397 @opindex Walloca
5398 This option warns on all uses of @code{alloca} in the source.
5400 @item -Walloca-larger-than=@var{n}
5401 This option warns on calls to @code{alloca} that are not bounded by a
5402 controlling predicate limiting its argument of integer type to at most
5403 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5404 Arguments of non-integer types are considered unbounded even if they
5405 appear to be constrained to the expected range.
5407 For example, a bounded case of @code{alloca} could be:
5409 @smallexample
5410 void func (size_t n)
5412   void *p;
5413   if (n <= 1000)
5414     p = alloca (n);
5415   else
5416     p = malloc (n);
5417   f (p);
5419 @end smallexample
5421 In the above example, passing @code{-Walloca-larger-than=1000} would not
5422 issue a warning because the call to @code{alloca} is known to be at most
5423 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5424 the compiler would emit a warning.
5426 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5427 controlling predicate constraining its integer argument.  For example:
5429 @smallexample
5430 void func ()
5432   void *p = alloca (n);
5433   f (p);
5435 @end smallexample
5437 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5438 a warning, but this time because of the lack of bounds checking.
5440 Note, that even seemingly correct code involving signed integers could
5441 cause a warning:
5443 @smallexample
5444 void func (signed int n)
5446   if (n < 500)
5447     @{
5448       p = alloca (n);
5449       f (p);
5450     @}
5452 @end smallexample
5454 In the above example, @var{n} could be negative, causing a larger than
5455 expected argument to be implicitly cast into the @code{alloca} call.
5457 This option also warns when @code{alloca} is used in a loop.
5459 This warning is not enabled by @option{-Wall}, and is only active when
5460 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5462 See also @option{-Wvla-larger-than=@var{n}}.
5464 @item -Warray-bounds
5465 @itemx -Warray-bounds=@var{n}
5466 @opindex Wno-array-bounds
5467 @opindex Warray-bounds
5468 This option is only active when @option{-ftree-vrp} is active
5469 (default for @option{-O2} and above). It warns about subscripts to arrays
5470 that are always out of bounds. This warning is enabled by @option{-Wall}.
5472 @table @gcctabopt
5473 @item -Warray-bounds=1
5474 This is the warning level of @option{-Warray-bounds} and is enabled
5475 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5477 @item -Warray-bounds=2
5478 This warning level also warns about out of bounds access for
5479 arrays at the end of a struct and for arrays accessed through
5480 pointers. This warning level may give a larger number of
5481 false positives and is deactivated by default.
5482 @end table
5484 @item -Wattribute-alias
5485 Warn about declarations using the @code{alias} and similar attributes whose
5486 target is incompatible with the type of the alias.  @xref{Function Attributes,
5487 ,Declaring Attributes of Functions}.
5489 @item -Wbool-compare
5490 @opindex Wno-bool-compare
5491 @opindex Wbool-compare
5492 Warn about boolean expression compared with an integer value different from
5493 @code{true}/@code{false}.  For instance, the following comparison is
5494 always false:
5495 @smallexample
5496 int n = 5;
5497 @dots{}
5498 if ((n > 1) == 2) @{ @dots{} @}
5499 @end smallexample
5500 This warning is enabled by @option{-Wall}.
5502 @item -Wbool-operation
5503 @opindex Wno-bool-operation
5504 @opindex Wbool-operation
5505 Warn about suspicious operations on expressions of a boolean type.  For
5506 instance, bitwise negation of a boolean is very likely a bug in the program.
5507 For C, this warning also warns about incrementing or decrementing a boolean,
5508 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5509 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5511 This warning is enabled by @option{-Wall}.
5513 @item -Wduplicated-branches
5514 @opindex Wno-duplicated-branches
5515 @opindex Wduplicated-branches
5516 Warn when an if-else has identical branches.  This warning detects cases like
5517 @smallexample
5518 if (p != NULL)
5519   return 0;
5520 else
5521   return 0;
5522 @end smallexample
5523 It doesn't warn when both branches contain just a null statement.  This warning
5524 also warn for conditional operators:
5525 @smallexample
5526   int i = x ? *p : *p;
5527 @end smallexample
5529 @item -Wduplicated-cond
5530 @opindex Wno-duplicated-cond
5531 @opindex Wduplicated-cond
5532 Warn about duplicated conditions in an if-else-if chain.  For instance,
5533 warn for the following code:
5534 @smallexample
5535 if (p->q != NULL) @{ @dots{} @}
5536 else if (p->q != NULL) @{ @dots{} @}
5537 @end smallexample
5539 @item -Wframe-address
5540 @opindex Wno-frame-address
5541 @opindex Wframe-address
5542 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5543 is called with an argument greater than 0.  Such calls may return indeterminate
5544 values or crash the program.  The warning is included in @option{-Wall}.
5546 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5547 @opindex Wno-discarded-qualifiers
5548 @opindex Wdiscarded-qualifiers
5549 Do not warn if type qualifiers on pointers are being discarded.
5550 Typically, the compiler warns if a @code{const char *} variable is
5551 passed to a function that takes a @code{char *} parameter.  This option
5552 can be used to suppress such a warning.
5554 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5555 @opindex Wno-discarded-array-qualifiers
5556 @opindex Wdiscarded-array-qualifiers
5557 Do not warn if type qualifiers on arrays which are pointer targets
5558 are being discarded. Typically, the compiler warns if a
5559 @code{const int (*)[]} variable is passed to a function that
5560 takes a @code{int (*)[]} parameter.  This option can be used to
5561 suppress such a warning.
5563 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5564 @opindex Wno-incompatible-pointer-types
5565 @opindex Wincompatible-pointer-types
5566 Do not warn when there is a conversion between pointers that have incompatible
5567 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5568 which warns for pointer argument passing or assignment with different
5569 signedness.
5571 @item -Wno-int-conversion @r{(C and Objective-C only)}
5572 @opindex Wno-int-conversion
5573 @opindex Wint-conversion
5574 Do not warn about incompatible integer to pointer and pointer to integer
5575 conversions.  This warning is about implicit conversions; for explicit
5576 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5577 @option{-Wno-pointer-to-int-cast} may be used.
5579 @item -Wno-div-by-zero
5580 @opindex Wno-div-by-zero
5581 @opindex Wdiv-by-zero
5582 Do not warn about compile-time integer division by zero.  Floating-point
5583 division by zero is not warned about, as it can be a legitimate way of
5584 obtaining infinities and NaNs.
5586 @item -Wsystem-headers
5587 @opindex Wsystem-headers
5588 @opindex Wno-system-headers
5589 @cindex warnings from system headers
5590 @cindex system headers, warnings from
5591 Print warning messages for constructs found in system header files.
5592 Warnings from system headers are normally suppressed, on the assumption
5593 that they usually do not indicate real problems and would only make the
5594 compiler output harder to read.  Using this command-line option tells
5595 GCC to emit warnings from system headers as if they occurred in user
5596 code.  However, note that using @option{-Wall} in conjunction with this
5597 option does @emph{not} warn about unknown pragmas in system
5598 headers---for that, @option{-Wunknown-pragmas} must also be used.
5600 @item -Wtautological-compare
5601 @opindex Wtautological-compare
5602 @opindex Wno-tautological-compare
5603 Warn if a self-comparison always evaluates to true or false.  This
5604 warning detects various mistakes such as:
5605 @smallexample
5606 int i = 1;
5607 @dots{}
5608 if (i > i) @{ @dots{} @}
5609 @end smallexample
5611 This warning also warns about bitwise comparisons that always evaluate
5612 to true or false, for instance:
5613 @smallexample
5614 if ((a & 16) == 10) @{ @dots{} @}
5615 @end smallexample
5616 will always be false.
5618 This warning is enabled by @option{-Wall}.
5620 @item -Wtrampolines
5621 @opindex Wtrampolines
5622 @opindex Wno-trampolines
5623 Warn about trampolines generated for pointers to nested functions.
5624 A trampoline is a small piece of data or code that is created at run
5625 time on the stack when the address of a nested function is taken, and is
5626 used to call the nested function indirectly.  For some targets, it is
5627 made up of data only and thus requires no special treatment.  But, for
5628 most targets, it is made up of code and thus requires the stack to be
5629 made executable in order for the program to work properly.
5631 @item -Wfloat-equal
5632 @opindex Wfloat-equal
5633 @opindex Wno-float-equal
5634 Warn if floating-point values are used in equality comparisons.
5636 The idea behind this is that sometimes it is convenient (for the
5637 programmer) to consider floating-point values as approximations to
5638 infinitely precise real numbers.  If you are doing this, then you need
5639 to compute (by analyzing the code, or in some other way) the maximum or
5640 likely maximum error that the computation introduces, and allow for it
5641 when performing comparisons (and when producing output, but that's a
5642 different problem).  In particular, instead of testing for equality, you
5643 should check to see whether the two values have ranges that overlap; and
5644 this is done with the relational operators, so equality comparisons are
5645 probably mistaken.
5647 @item -Wtraditional @r{(C and Objective-C only)}
5648 @opindex Wtraditional
5649 @opindex Wno-traditional
5650 Warn about certain constructs that behave differently in traditional and
5651 ISO C@.  Also warn about ISO C constructs that have no traditional C
5652 equivalent, and/or problematic constructs that should be avoided.
5654 @itemize @bullet
5655 @item
5656 Macro parameters that appear within string literals in the macro body.
5657 In traditional C macro replacement takes place within string literals,
5658 but in ISO C it does not.
5660 @item
5661 In traditional C, some preprocessor directives did not exist.
5662 Traditional preprocessors only considered a line to be a directive
5663 if the @samp{#} appeared in column 1 on the line.  Therefore
5664 @option{-Wtraditional} warns about directives that traditional C
5665 understands but ignores because the @samp{#} does not appear as the
5666 first character on the line.  It also suggests you hide directives like
5667 @code{#pragma} not understood by traditional C by indenting them.  Some
5668 traditional implementations do not recognize @code{#elif}, so this option
5669 suggests avoiding it altogether.
5671 @item
5672 A function-like macro that appears without arguments.
5674 @item
5675 The unary plus operator.
5677 @item
5678 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5679 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5680 constants.)  Note, these suffixes appear in macros defined in the system
5681 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5682 Use of these macros in user code might normally lead to spurious
5683 warnings, however GCC's integrated preprocessor has enough context to
5684 avoid warning in these cases.
5686 @item
5687 A function declared external in one block and then used after the end of
5688 the block.
5690 @item
5691 A @code{switch} statement has an operand of type @code{long}.
5693 @item
5694 A non-@code{static} function declaration follows a @code{static} one.
5695 This construct is not accepted by some traditional C compilers.
5697 @item
5698 The ISO type of an integer constant has a different width or
5699 signedness from its traditional type.  This warning is only issued if
5700 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5701 typically represent bit patterns, are not warned about.
5703 @item
5704 Usage of ISO string concatenation is detected.
5706 @item
5707 Initialization of automatic aggregates.
5709 @item
5710 Identifier conflicts with labels.  Traditional C lacks a separate
5711 namespace for labels.
5713 @item
5714 Initialization of unions.  If the initializer is zero, the warning is
5715 omitted.  This is done under the assumption that the zero initializer in
5716 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5717 initializer warnings and relies on default initialization to zero in the
5718 traditional C case.
5720 @item
5721 Conversions by prototypes between fixed/floating-point values and vice
5722 versa.  The absence of these prototypes when compiling with traditional
5723 C causes serious problems.  This is a subset of the possible
5724 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5726 @item
5727 Use of ISO C style function definitions.  This warning intentionally is
5728 @emph{not} issued for prototype declarations or variadic functions
5729 because these ISO C features appear in your code when using
5730 libiberty's traditional C compatibility macros, @code{PARAMS} and
5731 @code{VPARAMS}.  This warning is also bypassed for nested functions
5732 because that feature is already a GCC extension and thus not relevant to
5733 traditional C compatibility.
5734 @end itemize
5736 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5737 @opindex Wtraditional-conversion
5738 @opindex Wno-traditional-conversion
5739 Warn if a prototype causes a type conversion that is different from what
5740 would happen to the same argument in the absence of a prototype.  This
5741 includes conversions of fixed point to floating and vice versa, and
5742 conversions changing the width or signedness of a fixed-point argument
5743 except when the same as the default promotion.
5745 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5746 @opindex Wdeclaration-after-statement
5747 @opindex Wno-declaration-after-statement
5748 Warn when a declaration is found after a statement in a block.  This
5749 construct, known from C++, was introduced with ISO C99 and is by default
5750 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5752 @item -Wshadow
5753 @opindex Wshadow
5754 @opindex Wno-shadow
5755 Warn whenever a local variable or type declaration shadows another
5756 variable, parameter, type, class member (in C++), or instance variable
5757 (in Objective-C) or whenever a built-in function is shadowed. Note
5758 that in C++, the compiler warns if a local variable shadows an
5759 explicit typedef, but not if it shadows a struct/class/enum.
5760 Same as @option{-Wshadow=global}.
5762 @item -Wno-shadow-ivar @r{(Objective-C only)}
5763 @opindex Wno-shadow-ivar
5764 @opindex Wshadow-ivar
5765 Do not warn whenever a local variable shadows an instance variable in an
5766 Objective-C method.
5768 @item -Wshadow=global
5769 @opindex Wshadow=local
5770 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5772 @item -Wshadow=local
5773 @opindex Wshadow=local
5774 Warn when a local variable shadows another local variable or parameter.
5775 This warning is enabled by @option{-Wshadow=global}.
5777 @item -Wshadow=compatible-local
5778 @opindex Wshadow=compatible-local
5779 Warn when a local variable shadows another local variable or parameter
5780 whose type is compatible with that of the shadowing variable. In C++,
5781 type compatibility here means the type of the shadowing variable can be
5782 converted to that of the shadowed variable. The creation of this flag
5783 (in addition to @option{-Wshadow=local}) is based on the idea that when
5784 a local variable shadows another one of incompatible type, it is most
5785 likely intentional, not a bug or typo, as shown in the following example:
5787 @smallexample
5788 @group
5789 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5791   for (int i = 0; i < N; ++i)
5792   @{
5793     ...
5794   @}
5795   ...
5797 @end group
5798 @end smallexample
5800 Since the two variable @code{i} in the example above have incompatible types,
5801 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5802 Because their types are incompatible, if a programmer accidentally uses one
5803 in place of the other, type checking will catch that and emit an error or
5804 warning. So not warning (about shadowing) in this case will not lead to
5805 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5806 possibly reduce the number of warnings triggered by intentional shadowing.
5808 This warning is enabled by @option{-Wshadow=local}.
5810 @item -Wlarger-than=@var{len}
5811 @opindex Wlarger-than=@var{len}
5812 @opindex Wlarger-than-@var{len}
5813 Warn whenever an object of larger than @var{len} bytes is defined.
5815 @item -Wframe-larger-than=@var{len}
5816 @opindex Wframe-larger-than
5817 Warn if the size of a function frame is larger than @var{len} bytes.
5818 The computation done to determine the stack frame size is approximate
5819 and not conservative.
5820 The actual requirements may be somewhat greater than @var{len}
5821 even if you do not get a warning.  In addition, any space allocated
5822 via @code{alloca}, variable-length arrays, or related constructs
5823 is not included by the compiler when determining
5824 whether or not to issue a warning.
5826 @item -Wno-free-nonheap-object
5827 @opindex Wno-free-nonheap-object
5828 @opindex Wfree-nonheap-object
5829 Do not warn when attempting to free an object that was not allocated
5830 on the heap.
5832 @item -Wstack-usage=@var{len}
5833 @opindex Wstack-usage
5834 Warn if the stack usage of a function might be larger than @var{len} bytes.
5835 The computation done to determine the stack usage is conservative.
5836 Any space allocated via @code{alloca}, variable-length arrays, or related
5837 constructs is included by the compiler when determining whether or not to
5838 issue a warning.
5840 The message is in keeping with the output of @option{-fstack-usage}.
5842 @itemize
5843 @item
5844 If the stack usage is fully static but exceeds the specified amount, it's:
5846 @smallexample
5847   warning: stack usage is 1120 bytes
5848 @end smallexample
5849 @item
5850 If the stack usage is (partly) dynamic but bounded, it's:
5852 @smallexample
5853   warning: stack usage might be 1648 bytes
5854 @end smallexample
5855 @item
5856 If the stack usage is (partly) dynamic and not bounded, it's:
5858 @smallexample
5859   warning: stack usage might be unbounded
5860 @end smallexample
5861 @end itemize
5863 @item -Wunsafe-loop-optimizations
5864 @opindex Wunsafe-loop-optimizations
5865 @opindex Wno-unsafe-loop-optimizations
5866 Warn if the loop cannot be optimized because the compiler cannot
5867 assume anything on the bounds of the loop indices.  With
5868 @option{-funsafe-loop-optimizations} warn if the compiler makes
5869 such assumptions.
5871 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5872 @opindex Wno-pedantic-ms-format
5873 @opindex Wpedantic-ms-format
5874 When used in combination with @option{-Wformat}
5875 and @option{-pedantic} without GNU extensions, this option
5876 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5877 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5878 which depend on the MS runtime.
5880 @item -Waligned-new
5881 @opindex Waligned-new
5882 @opindex Wno-aligned-new
5883 Warn about a new-expression of a type that requires greater alignment
5884 than the @code{alignof(std::max_align_t)} but uses an allocation
5885 function without an explicit alignment parameter. This option is
5886 enabled by @option{-Wall}.
5888 Normally this only warns about global allocation functions, but
5889 @option{-Waligned-new=all} also warns about class member allocation
5890 functions.
5892 @item -Wplacement-new
5893 @itemx -Wplacement-new=@var{n}
5894 @opindex Wplacement-new
5895 @opindex Wno-placement-new
5896 Warn about placement new expressions with undefined behavior, such as
5897 constructing an object in a buffer that is smaller than the type of
5898 the object.  For example, the placement new expression below is diagnosed
5899 because it attempts to construct an array of 64 integers in a buffer only
5900 64 bytes large.
5901 @smallexample
5902 char buf [64];
5903 new (buf) int[64];
5904 @end smallexample
5905 This warning is enabled by default.
5907 @table @gcctabopt
5908 @item -Wplacement-new=1
5909 This is the default warning level of @option{-Wplacement-new}.  At this
5910 level the warning is not issued for some strictly undefined constructs that
5911 GCC allows as extensions for compatibility with legacy code.  For example,
5912 the following @code{new} expression is not diagnosed at this level even
5913 though it has undefined behavior according to the C++ standard because
5914 it writes past the end of the one-element array.
5915 @smallexample
5916 struct S @{ int n, a[1]; @};
5917 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5918 new (s->a)int [32]();
5919 @end smallexample
5921 @item -Wplacement-new=2
5922 At this level, in addition to diagnosing all the same constructs as at level
5923 1, a diagnostic is also issued for placement new expressions that construct
5924 an object in the last member of structure whose type is an array of a single
5925 element and whose size is less than the size of the object being constructed.
5926 While the previous example would be diagnosed, the following construct makes
5927 use of the flexible member array extension to avoid the warning at level 2.
5928 @smallexample
5929 struct S @{ int n, a[]; @};
5930 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5931 new (s->a)int [32]();
5932 @end smallexample
5934 @end table
5936 @item -Wpointer-arith
5937 @opindex Wpointer-arith
5938 @opindex Wno-pointer-arith
5939 Warn about anything that depends on the ``size of'' a function type or
5940 of @code{void}.  GNU C assigns these types a size of 1, for
5941 convenience in calculations with @code{void *} pointers and pointers
5942 to functions.  In C++, warn also when an arithmetic operation involves
5943 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5945 @item -Wpointer-compare
5946 @opindex Wpointer-compare
5947 @opindex Wno-pointer-compare
5948 Warn if a pointer is compared with a zero character constant.  This usually
5949 means that the pointer was meant to be dereferenced.  For example:
5951 @smallexample
5952 const char *p = foo ();
5953 if (p == '\0')
5954   return 42;
5955 @end smallexample
5957 Note that the code above is invalid in C++11.
5959 This warning is enabled by default.
5961 @item -Wtype-limits
5962 @opindex Wtype-limits
5963 @opindex Wno-type-limits
5964 Warn if a comparison is always true or always false due to the limited
5965 range of the data type, but do not warn for constant expressions.  For
5966 example, warn if an unsigned variable is compared against zero with
5967 @code{<} or @code{>=}.  This warning is also enabled by
5968 @option{-Wextra}.
5970 @include cppwarnopts.texi
5972 @item -Wbad-function-cast @r{(C and Objective-C only)}
5973 @opindex Wbad-function-cast
5974 @opindex Wno-bad-function-cast
5975 Warn when a function call is cast to a non-matching type.
5976 For example, warn if a call to a function returning an integer type 
5977 is cast to a pointer type.
5979 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5980 @opindex Wc90-c99-compat
5981 @opindex Wno-c90-c99-compat
5982 Warn about features not present in ISO C90, but present in ISO C99.
5983 For instance, warn about use of variable length arrays, @code{long long}
5984 type, @code{bool} type, compound literals, designated initializers, and so
5985 on.  This option is independent of the standards mode.  Warnings are disabled
5986 in the expression that follows @code{__extension__}.
5988 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5989 @opindex Wc99-c11-compat
5990 @opindex Wno-c99-c11-compat
5991 Warn about features not present in ISO C99, but present in ISO C11.
5992 For instance, warn about use of anonymous structures and unions,
5993 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5994 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5995 and so on.  This option is independent of the standards mode.  Warnings are
5996 disabled in the expression that follows @code{__extension__}.
5998 @item -Wc++-compat @r{(C and Objective-C only)}
5999 @opindex Wc++-compat
6000 Warn about ISO C constructs that are outside of the common subset of
6001 ISO C and ISO C++, e.g.@: request for implicit conversion from
6002 @code{void *} to a pointer to non-@code{void} type.
6004 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6005 @opindex Wc++11-compat
6006 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6007 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6008 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6009 enabled by @option{-Wall}.
6011 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6012 @opindex Wc++14-compat
6013 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6014 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6016 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6017 @opindex Wc++17-compat
6018 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6019 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6021 @item -Wcast-qual
6022 @opindex Wcast-qual
6023 @opindex Wno-cast-qual
6024 Warn whenever a pointer is cast so as to remove a type qualifier from
6025 the target type.  For example, warn if a @code{const char *} is cast
6026 to an ordinary @code{char *}.
6028 Also warn when making a cast that introduces a type qualifier in an
6029 unsafe way.  For example, casting @code{char **} to @code{const char **}
6030 is unsafe, as in this example:
6032 @smallexample
6033   /* p is char ** value.  */
6034   const char **q = (const char **) p;
6035   /* Assignment of readonly string to const char * is OK.  */
6036   *q = "string";
6037   /* Now char** pointer points to read-only memory.  */
6038   **p = 'b';
6039 @end smallexample
6041 @item -Wcast-align
6042 @opindex Wcast-align
6043 @opindex Wno-cast-align
6044 Warn whenever a pointer is cast such that the required alignment of the
6045 target is increased.  For example, warn if a @code{char *} is cast to
6046 an @code{int *} on machines where integers can only be accessed at
6047 two- or four-byte boundaries.
6049 @item -Wcast-align=strict
6050 @opindex Wcast-align=strict
6051 Warn whenever a pointer is cast such that the required alignment of the
6052 target is increased.  For example, warn if a @code{char *} is cast to
6053 an @code{int *} regardless of the target machine.
6055 @item -Wcast-function-type
6056 @opindex Wcast-function-type
6057 @opindex Wno-cast-function-type
6058 Warn when a function pointer is cast to an incompatible function pointer.
6059 In a cast involving function types with a variable argument list only
6060 the types of initial arguments that are provided are considered.
6061 Any parameter of pointer-type matches any other pointer-type.  Any benign
6062 differences in integral types are ignored, like @code{int} vs. @code{long}
6063 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6064 type @code{void (*) (void)} is special and matches everything, which can
6065 be used to suppress this warning.
6066 In a cast involving pointer to member types this warning warns whenever
6067 the type cast is changing the pointer to member type.
6068 This warning is enabled by @option{-Wextra}.
6070 @item -Wwrite-strings
6071 @opindex Wwrite-strings
6072 @opindex Wno-write-strings
6073 When compiling C, give string constants the type @code{const
6074 char[@var{length}]} so that copying the address of one into a
6075 non-@code{const} @code{char *} pointer produces a warning.  These
6076 warnings help you find at compile time code that can try to write
6077 into a string constant, but only if you have been very careful about
6078 using @code{const} in declarations and prototypes.  Otherwise, it is
6079 just a nuisance. This is why we did not make @option{-Wall} request
6080 these warnings.
6082 When compiling C++, warn about the deprecated conversion from string
6083 literals to @code{char *}.  This warning is enabled by default for C++
6084 programs.
6086 @item -Wcatch-value
6087 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6088 @opindex Wcatch-value
6089 @opindex Wno-catch-value
6090 Warn about catch handlers that do not catch via reference.
6091 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6092 warn about polymorphic class types that are caught by value.
6093 With @option{-Wcatch-value=2} warn about all class types that are caught
6094 by value. With @option{-Wcatch-value=3} warn about all types that are
6095 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6097 @item -Wclobbered
6098 @opindex Wclobbered
6099 @opindex Wno-clobbered
6100 Warn for variables that might be changed by @code{longjmp} or
6101 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6103 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6104 @opindex Wconditionally-supported
6105 @opindex Wno-conditionally-supported
6106 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6108 @item -Wconversion
6109 @opindex Wconversion
6110 @opindex Wno-conversion
6111 Warn for implicit conversions that may alter a value. This includes
6112 conversions between real and integer, like @code{abs (x)} when
6113 @code{x} is @code{double}; conversions between signed and unsigned,
6114 like @code{unsigned ui = -1}; and conversions to smaller types, like
6115 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6116 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6117 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6118 conversions between signed and unsigned integers can be disabled by
6119 using @option{-Wno-sign-conversion}.
6121 For C++, also warn for confusing overload resolution for user-defined
6122 conversions; and conversions that never use a type conversion
6123 operator: conversions to @code{void}, the same type, a base class or a
6124 reference to them. Warnings about conversions between signed and
6125 unsigned integers are disabled by default in C++ unless
6126 @option{-Wsign-conversion} is explicitly enabled.
6128 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6129 @opindex Wconversion-null
6130 @opindex Wno-conversion-null
6131 Do not warn for conversions between @code{NULL} and non-pointer
6132 types. @option{-Wconversion-null} is enabled by default.
6134 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6135 @opindex Wzero-as-null-pointer-constant
6136 @opindex Wno-zero-as-null-pointer-constant
6137 Warn when a literal @samp{0} is used as null pointer constant.  This can
6138 be useful to facilitate the conversion to @code{nullptr} in C++11.
6140 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6141 @opindex Wsubobject-linkage
6142 @opindex Wno-subobject-linkage
6143 Warn if a class type has a base or a field whose type uses the anonymous
6144 namespace or depends on a type with no linkage.  If a type A depends on
6145 a type B with no or internal linkage, defining it in multiple
6146 translation units would be an ODR violation because the meaning of B
6147 is different in each translation unit.  If A only appears in a single
6148 translation unit, the best way to silence the warning is to give it
6149 internal linkage by putting it in an anonymous namespace as well.  The
6150 compiler doesn't give this warning for types defined in the main .C
6151 file, as those are unlikely to have multiple definitions.
6152 @option{-Wsubobject-linkage} is enabled by default.
6154 @item -Wdangling-else
6155 @opindex Wdangling-else
6156 @opindex Wno-dangling-else
6157 Warn about constructions where there may be confusion to which
6158 @code{if} statement an @code{else} branch belongs.  Here is an example of
6159 such a case:
6161 @smallexample
6162 @group
6164   if (a)
6165     if (b)
6166       foo ();
6167   else
6168     bar ();
6170 @end group
6171 @end smallexample
6173 In C/C++, every @code{else} branch belongs to the innermost possible
6174 @code{if} statement, which in this example is @code{if (b)}.  This is
6175 often not what the programmer expected, as illustrated in the above
6176 example by indentation the programmer chose.  When there is the
6177 potential for this confusion, GCC issues a warning when this flag
6178 is specified.  To eliminate the warning, add explicit braces around
6179 the innermost @code{if} statement so there is no way the @code{else}
6180 can belong to the enclosing @code{if}.  The resulting code
6181 looks like this:
6183 @smallexample
6184 @group
6186   if (a)
6187     @{
6188       if (b)
6189         foo ();
6190       else
6191         bar ();
6192     @}
6194 @end group
6195 @end smallexample
6197 This warning is enabled by @option{-Wparentheses}.
6199 @item -Wdate-time
6200 @opindex Wdate-time
6201 @opindex Wno-date-time
6202 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6203 are encountered as they might prevent bit-wise-identical reproducible
6204 compilations.
6206 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6207 @opindex Wdelete-incomplete
6208 @opindex Wno-delete-incomplete
6209 Warn when deleting a pointer to incomplete type, which may cause
6210 undefined behavior at runtime.  This warning is enabled by default.
6212 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6213 @opindex Wuseless-cast
6214 @opindex Wno-useless-cast
6215 Warn when an expression is casted to its own type.
6217 @item -Wempty-body
6218 @opindex Wempty-body
6219 @opindex Wno-empty-body
6220 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6221 while} statement.  This warning is also enabled by @option{-Wextra}.
6223 @item -Wenum-compare
6224 @opindex Wenum-compare
6225 @opindex Wno-enum-compare
6226 Warn about a comparison between values of different enumerated types.
6227 In C++ enumerated type mismatches in conditional expressions are also
6228 diagnosed and the warning is enabled by default.  In C this warning is 
6229 enabled by @option{-Wall}.
6231 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6232 @opindex Wextra-semi
6233 @opindex Wno-extra-semi
6234 Warn about redundant semicolon after in-class function definition.
6236 @item -Wjump-misses-init @r{(C, Objective-C only)}
6237 @opindex Wjump-misses-init
6238 @opindex Wno-jump-misses-init
6239 Warn if a @code{goto} statement or a @code{switch} statement jumps
6240 forward across the initialization of a variable, or jumps backward to a
6241 label after the variable has been initialized.  This only warns about
6242 variables that are initialized when they are declared.  This warning is
6243 only supported for C and Objective-C; in C++ this sort of branch is an
6244 error in any case.
6246 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6247 can be disabled with the @option{-Wno-jump-misses-init} option.
6249 @item -Wsign-compare
6250 @opindex Wsign-compare
6251 @opindex Wno-sign-compare
6252 @cindex warning for comparison of signed and unsigned values
6253 @cindex comparison of signed and unsigned values, warning
6254 @cindex signed and unsigned values, comparison warning
6255 Warn when a comparison between signed and unsigned values could produce
6256 an incorrect result when the signed value is converted to unsigned.
6257 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6258 also enabled by @option{-Wextra}.
6260 @item -Wsign-conversion
6261 @opindex Wsign-conversion
6262 @opindex Wno-sign-conversion
6263 Warn for implicit conversions that may change the sign of an integer
6264 value, like assigning a signed integer expression to an unsigned
6265 integer variable. An explicit cast silences the warning. In C, this
6266 option is enabled also by @option{-Wconversion}.
6268 @item -Wfloat-conversion
6269 @opindex Wfloat-conversion
6270 @opindex Wno-float-conversion
6271 Warn for implicit conversions that reduce the precision of a real value.
6272 This includes conversions from real to integer, and from higher precision
6273 real to lower precision real values.  This option is also enabled by
6274 @option{-Wconversion}.
6276 @item -Wno-scalar-storage-order
6277 @opindex -Wno-scalar-storage-order
6278 @opindex -Wscalar-storage-order
6279 Do not warn on suspicious constructs involving reverse scalar storage order.
6281 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6282 @opindex Wsized-deallocation
6283 @opindex Wno-sized-deallocation
6284 Warn about a definition of an unsized deallocation function
6285 @smallexample
6286 void operator delete (void *) noexcept;
6287 void operator delete[] (void *) noexcept;
6288 @end smallexample
6289 without a definition of the corresponding sized deallocation function
6290 @smallexample
6291 void operator delete (void *, std::size_t) noexcept;
6292 void operator delete[] (void *, std::size_t) noexcept;
6293 @end smallexample
6294 or vice versa.  Enabled by @option{-Wextra} along with
6295 @option{-fsized-deallocation}.
6297 @item -Wsizeof-pointer-div
6298 @opindex Wsizeof-pointer-div
6299 @opindex Wno-sizeof-pointer-div
6300 Warn for suspicious divisions of two sizeof expressions that divide
6301 the pointer size by the element size, which is the usual way to compute
6302 the array size but won't work out correctly with pointers.  This warning
6303 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6304 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6306 @item -Wsizeof-pointer-memaccess
6307 @opindex Wsizeof-pointer-memaccess
6308 @opindex Wno-sizeof-pointer-memaccess
6309 Warn for suspicious length parameters to certain string and memory built-in
6310 functions if the argument uses @code{sizeof}.  This warning triggers for
6311 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6312 an array, but a pointer, and suggests a possible fix, or about
6313 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6314 also warns about calls to bounded string copy functions like @code{strncat}
6315 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6316 the source array.  For example, in the following function the call to
6317 @code{strncat} specifies the size of the source string as the bound.  That
6318 is almost certainly a mistake and so the call is diagnosed.
6319 @smallexample
6320 void make_file (const char *name)
6322   char path[PATH_MAX];
6323   strncpy (path, name, sizeof path - 1);
6324   strncat (path, ".text", sizeof ".text");
6325   @dots{}
6327 @end smallexample
6329 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6331 @item -Wsizeof-array-argument
6332 @opindex Wsizeof-array-argument
6333 @opindex Wno-sizeof-array-argument
6334 Warn when the @code{sizeof} operator is applied to a parameter that is
6335 declared as an array in a function definition.  This warning is enabled by
6336 default for C and C++ programs.
6338 @item -Wmemset-elt-size
6339 @opindex Wmemset-elt-size
6340 @opindex Wno-memset-elt-size
6341 Warn for suspicious calls to the @code{memset} built-in function, if the
6342 first argument references an array, and the third argument is a number
6343 equal to the number of elements, but not equal to the size of the array
6344 in memory.  This indicates that the user has omitted a multiplication by
6345 the element size.  This warning is enabled by @option{-Wall}.
6347 @item -Wmemset-transposed-args
6348 @opindex Wmemset-transposed-args
6349 @opindex Wno-memset-transposed-args
6350 Warn for suspicious calls to the @code{memset} built-in function, if the
6351 second argument is not zero and the third argument is zero.  This warns e.g.@
6352 about @code{memset (buf, sizeof buf, 0)} where most probably
6353 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6354 is only emitted if the third argument is literal zero.  If it is some
6355 expression that is folded to zero, a cast of zero to some type, etc., 
6356 it is far less likely that the user has mistakenly exchanged the arguments 
6357 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6359 @item -Waddress
6360 @opindex Waddress
6361 @opindex Wno-address
6362 Warn about suspicious uses of memory addresses. These include using
6363 the address of a function in a conditional expression, such as
6364 @code{void func(void); if (func)}, and comparisons against the memory
6365 address of a string literal, such as @code{if (x == "abc")}.  Such
6366 uses typically indicate a programmer error: the address of a function
6367 always evaluates to true, so their use in a conditional usually
6368 indicate that the programmer forgot the parentheses in a function
6369 call; and comparisons against string literals result in unspecified
6370 behavior and are not portable in C, so they usually indicate that the
6371 programmer intended to use @code{strcmp}.  This warning is enabled by
6372 @option{-Wall}.
6374 @item -Wlogical-op
6375 @opindex Wlogical-op
6376 @opindex Wno-logical-op
6377 Warn about suspicious uses of logical operators in expressions.
6378 This includes using logical operators in contexts where a
6379 bit-wise operator is likely to be expected.  Also warns when
6380 the operands of a logical operator are the same:
6381 @smallexample
6382 extern int a;
6383 if (a < 0 && a < 0) @{ @dots{} @}
6384 @end smallexample
6386 @item -Wlogical-not-parentheses
6387 @opindex Wlogical-not-parentheses
6388 @opindex Wno-logical-not-parentheses
6389 Warn about logical not used on the left hand side operand of a comparison.
6390 This option does not warn if the right operand is considered to be a boolean
6391 expression.  Its purpose is to detect suspicious code like the following:
6392 @smallexample
6393 int a;
6394 @dots{}
6395 if (!a > 1) @{ @dots{} @}
6396 @end smallexample
6398 It is possible to suppress the warning by wrapping the LHS into
6399 parentheses:
6400 @smallexample
6401 if ((!a) > 1) @{ @dots{} @}
6402 @end smallexample
6404 This warning is enabled by @option{-Wall}.
6406 @item -Waggregate-return
6407 @opindex Waggregate-return
6408 @opindex Wno-aggregate-return
6409 Warn if any functions that return structures or unions are defined or
6410 called.  (In languages where you can return an array, this also elicits
6411 a warning.)
6413 @item -Wno-aggressive-loop-optimizations
6414 @opindex Wno-aggressive-loop-optimizations
6415 @opindex Waggressive-loop-optimizations
6416 Warn if in a loop with constant number of iterations the compiler detects
6417 undefined behavior in some statement during one or more of the iterations.
6419 @item -Wno-attributes
6420 @opindex Wno-attributes
6421 @opindex Wattributes
6422 Do not warn if an unexpected @code{__attribute__} is used, such as
6423 unrecognized attributes, function attributes applied to variables,
6424 etc.  This does not stop errors for incorrect use of supported
6425 attributes.
6427 @item -Wno-builtin-declaration-mismatch
6428 @opindex Wno-builtin-declaration-mismatch
6429 @opindex Wbuiltin-declaration-mismatch
6430 Warn if a built-in function is declared with the wrong signature or 
6431 as non-function.
6432 This warning is enabled by default.
6434 @item -Wno-builtin-macro-redefined
6435 @opindex Wno-builtin-macro-redefined
6436 @opindex Wbuiltin-macro-redefined
6437 Do not warn if certain built-in macros are redefined.  This suppresses
6438 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6439 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6441 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6442 @opindex Wstrict-prototypes
6443 @opindex Wno-strict-prototypes
6444 Warn if a function is declared or defined without specifying the
6445 argument types.  (An old-style function definition is permitted without
6446 a warning if preceded by a declaration that specifies the argument
6447 types.)
6449 @item -Wold-style-declaration @r{(C and Objective-C only)}
6450 @opindex Wold-style-declaration
6451 @opindex Wno-old-style-declaration
6452 Warn for obsolescent usages, according to the C Standard, in a
6453 declaration. For example, warn if storage-class specifiers like
6454 @code{static} are not the first things in a declaration.  This warning
6455 is also enabled by @option{-Wextra}.
6457 @item -Wold-style-definition @r{(C and Objective-C only)}
6458 @opindex Wold-style-definition
6459 @opindex Wno-old-style-definition
6460 Warn if an old-style function definition is used.  A warning is given
6461 even if there is a previous prototype.
6463 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6464 @opindex Wmissing-parameter-type
6465 @opindex Wno-missing-parameter-type
6466 A function parameter is declared without a type specifier in K&R-style
6467 functions:
6469 @smallexample
6470 void foo(bar) @{ @}
6471 @end smallexample
6473 This warning is also enabled by @option{-Wextra}.
6475 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6476 @opindex Wmissing-prototypes
6477 @opindex Wno-missing-prototypes
6478 Warn if a global function is defined without a previous prototype
6479 declaration.  This warning is issued even if the definition itself
6480 provides a prototype.  Use this option to detect global functions
6481 that do not have a matching prototype declaration in a header file.
6482 This option is not valid for C++ because all function declarations
6483 provide prototypes and a non-matching declaration declares an
6484 overload rather than conflict with an earlier declaration.
6485 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6487 @item -Wmissing-declarations
6488 @opindex Wmissing-declarations
6489 @opindex Wno-missing-declarations
6490 Warn if a global function is defined without a previous declaration.
6491 Do so even if the definition itself provides a prototype.
6492 Use this option to detect global functions that are not declared in
6493 header files.  In C, no warnings are issued for functions with previous
6494 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6495 missing prototypes.  In C++, no warnings are issued for function templates,
6496 or for inline functions, or for functions in anonymous namespaces.
6498 @item -Wmissing-field-initializers
6499 @opindex Wmissing-field-initializers
6500 @opindex Wno-missing-field-initializers
6501 @opindex W
6502 @opindex Wextra
6503 @opindex Wno-extra
6504 Warn if a structure's initializer has some fields missing.  For
6505 example, the following code causes such a warning, because
6506 @code{x.h} is implicitly zero:
6508 @smallexample
6509 struct s @{ int f, g, h; @};
6510 struct s x = @{ 3, 4 @};
6511 @end smallexample
6513 This option does not warn about designated initializers, so the following
6514 modification does not trigger a warning:
6516 @smallexample
6517 struct s @{ int f, g, h; @};
6518 struct s x = @{ .f = 3, .g = 4 @};
6519 @end smallexample
6521 In C this option does not warn about the universal zero initializer
6522 @samp{@{ 0 @}}:
6524 @smallexample
6525 struct s @{ int f, g, h; @};
6526 struct s x = @{ 0 @};
6527 @end smallexample
6529 Likewise, in C++ this option does not warn about the empty @{ @}
6530 initializer, for example:
6532 @smallexample
6533 struct s @{ int f, g, h; @};
6534 s x = @{ @};
6535 @end smallexample
6537 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6538 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6540 @item -Wno-multichar
6541 @opindex Wno-multichar
6542 @opindex Wmultichar
6543 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6544 Usually they indicate a typo in the user's code, as they have
6545 implementation-defined values, and should not be used in portable code.
6547 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6548 @opindex Wnormalized=
6549 @opindex Wnormalized
6550 @opindex Wno-normalized
6551 @cindex NFC
6552 @cindex NFKC
6553 @cindex character set, input normalization
6554 In ISO C and ISO C++, two identifiers are different if they are
6555 different sequences of characters.  However, sometimes when characters
6556 outside the basic ASCII character set are used, you can have two
6557 different character sequences that look the same.  To avoid confusion,
6558 the ISO 10646 standard sets out some @dfn{normalization rules} which
6559 when applied ensure that two sequences that look the same are turned into
6560 the same sequence.  GCC can warn you if you are using identifiers that
6561 have not been normalized; this option controls that warning.
6563 There are four levels of warning supported by GCC@.  The default is
6564 @option{-Wnormalized=nfc}, which warns about any identifier that is
6565 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6566 recommended form for most uses.  It is equivalent to
6567 @option{-Wnormalized}.
6569 Unfortunately, there are some characters allowed in identifiers by
6570 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6571 identifiers.  That is, there's no way to use these symbols in portable
6572 ISO C or C++ and have all your identifiers in NFC@.
6573 @option{-Wnormalized=id} suppresses the warning for these characters.
6574 It is hoped that future versions of the standards involved will correct
6575 this, which is why this option is not the default.
6577 You can switch the warning off for all characters by writing
6578 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6579 only do this if you are using some other normalization scheme (like
6580 ``D''), because otherwise you can easily create bugs that are
6581 literally impossible to see.
6583 Some characters in ISO 10646 have distinct meanings but look identical
6584 in some fonts or display methodologies, especially once formatting has
6585 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6586 LETTER N'', displays just like a regular @code{n} that has been
6587 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6588 normalization scheme to convert all these into a standard form as
6589 well, and GCC warns if your code is not in NFKC if you use
6590 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6591 about every identifier that contains the letter O because it might be
6592 confused with the digit 0, and so is not the default, but may be
6593 useful as a local coding convention if the programming environment 
6594 cannot be fixed to display these characters distinctly.
6596 @item -Wno-deprecated
6597 @opindex Wno-deprecated
6598 @opindex Wdeprecated
6599 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6601 @item -Wno-deprecated-declarations
6602 @opindex Wno-deprecated-declarations
6603 @opindex Wdeprecated-declarations
6604 Do not warn about uses of functions (@pxref{Function Attributes}),
6605 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6606 Attributes}) marked as deprecated by using the @code{deprecated}
6607 attribute.
6609 @item -Wno-overflow
6610 @opindex Wno-overflow
6611 @opindex Woverflow
6612 Do not warn about compile-time overflow in constant expressions.
6614 @item -Wno-odr
6615 @opindex Wno-odr
6616 @opindex Wodr
6617 Warn about One Definition Rule violations during link-time optimization.
6618 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6620 @item -Wopenmp-simd
6621 @opindex Wopenm-simd
6622 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6623 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6624 option can be used to relax the cost model.
6626 @item -Woverride-init @r{(C and Objective-C only)}
6627 @opindex Woverride-init
6628 @opindex Wno-override-init
6629 @opindex W
6630 @opindex Wextra
6631 @opindex Wno-extra
6632 Warn if an initialized field without side effects is overridden when
6633 using designated initializers (@pxref{Designated Inits, , Designated
6634 Initializers}).
6636 This warning is included in @option{-Wextra}.  To get other
6637 @option{-Wextra} warnings without this one, use @option{-Wextra
6638 -Wno-override-init}.
6640 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6641 @opindex Woverride-init-side-effects
6642 @opindex Wno-override-init-side-effects
6643 Warn if an initialized field with side effects is overridden when
6644 using designated initializers (@pxref{Designated Inits, , Designated
6645 Initializers}).  This warning is enabled by default.
6647 @item -Wpacked
6648 @opindex Wpacked
6649 @opindex Wno-packed
6650 Warn if a structure is given the packed attribute, but the packed
6651 attribute has no effect on the layout or size of the structure.
6652 Such structures may be mis-aligned for little benefit.  For
6653 instance, in this code, the variable @code{f.x} in @code{struct bar}
6654 is misaligned even though @code{struct bar} does not itself
6655 have the packed attribute:
6657 @smallexample
6658 @group
6659 struct foo @{
6660   int x;
6661   char a, b, c, d;
6662 @} __attribute__((packed));
6663 struct bar @{
6664   char z;
6665   struct foo f;
6667 @end group
6668 @end smallexample
6670 @item -Wpacked-bitfield-compat
6671 @opindex Wpacked-bitfield-compat
6672 @opindex Wno-packed-bitfield-compat
6673 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6674 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6675 the change can lead to differences in the structure layout.  GCC
6676 informs you when the offset of such a field has changed in GCC 4.4.
6677 For example there is no longer a 4-bit padding between field @code{a}
6678 and @code{b} in this structure:
6680 @smallexample
6681 struct foo
6683   char a:4;
6684   char b:8;
6685 @} __attribute__ ((packed));
6686 @end smallexample
6688 This warning is enabled by default.  Use
6689 @option{-Wno-packed-bitfield-compat} to disable this warning.
6691 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6692 @opindex Wpacked-not-aligned
6693 @opindex Wno-packed-not-aligned
6694 Warn if a structure field with explicitly specified alignment in a
6695 packed struct or union is misaligned.  For example, a warning will
6696 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6697 'struct S' is less than 8}, in this code:
6699 @smallexample
6700 @group
6701 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6702 struct __attribute__ ((packed)) S @{
6703   struct S8 s8;
6705 @end group
6706 @end smallexample
6708 This warning is enabled by @option{-Wall}.
6710 @item -Wpadded
6711 @opindex Wpadded
6712 @opindex Wno-padded
6713 Warn if padding is included in a structure, either to align an element
6714 of the structure or to align the whole structure.  Sometimes when this
6715 happens it is possible to rearrange the fields of the structure to
6716 reduce the padding and so make the structure smaller.
6718 @item -Wredundant-decls
6719 @opindex Wredundant-decls
6720 @opindex Wno-redundant-decls
6721 Warn if anything is declared more than once in the same scope, even in
6722 cases where multiple declaration is valid and changes nothing.
6724 @item -Wno-restrict
6725 @opindex Wrestrict
6726 @opindex Wno-restrict
6727 Warn when an object referenced by a @code{restrict}-qualified parameter
6728 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6729 argument, or when copies between such objects overlap.  For example,
6730 the call to the @code{strcpy} function below attempts to truncate the string
6731 by replacing its initial characters with the last four.  However, because
6732 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6733 the call is diagnosed.
6735 @smallexample
6736 struct foo
6738   char a[] = "abcd1234";
6739   strcpy (a, a + 4);
6741 @end smallexample
6742 The @option{-Wrestrict} is included in @option{-Wall}.
6744 @item -Wnested-externs @r{(C and Objective-C only)}
6745 @opindex Wnested-externs
6746 @opindex Wno-nested-externs
6747 Warn if an @code{extern} declaration is encountered within a function.
6749 @item -Wno-inherited-variadic-ctor
6750 @opindex Winherited-variadic-ctor
6751 @opindex Wno-inherited-variadic-ctor
6752 Suppress warnings about use of C++11 inheriting constructors when the
6753 base class inherited from has a C variadic constructor; the warning is
6754 on by default because the ellipsis is not inherited.
6756 @item -Winline
6757 @opindex Winline
6758 @opindex Wno-inline
6759 Warn if a function that is declared as inline cannot be inlined.
6760 Even with this option, the compiler does not warn about failures to
6761 inline functions declared in system headers.
6763 The compiler uses a variety of heuristics to determine whether or not
6764 to inline a function.  For example, the compiler takes into account
6765 the size of the function being inlined and the amount of inlining
6766 that has already been done in the current function.  Therefore,
6767 seemingly insignificant changes in the source program can cause the
6768 warnings produced by @option{-Winline} to appear or disappear.
6770 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6771 @opindex Wno-invalid-offsetof
6772 @opindex Winvalid-offsetof
6773 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6774 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6775 to a non-standard-layout type is undefined.  In existing C++ implementations,
6776 however, @code{offsetof} typically gives meaningful results.
6777 This flag is for users who are aware that they are
6778 writing nonportable code and who have deliberately chosen to ignore the
6779 warning about it.
6781 The restrictions on @code{offsetof} may be relaxed in a future version
6782 of the C++ standard.
6784 @item -Wint-in-bool-context
6785 @opindex Wint-in-bool-context
6786 @opindex Wno-int-in-bool-context
6787 Warn for suspicious use of integer values where boolean values are expected,
6788 such as conditional expressions (?:) using non-boolean integer constants in
6789 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6790 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6791 for all kinds of multiplications regardless of the data type.
6792 This warning is enabled by @option{-Wall}.
6794 @item -Wno-int-to-pointer-cast
6795 @opindex Wno-int-to-pointer-cast
6796 @opindex Wint-to-pointer-cast
6797 Suppress warnings from casts to pointer type of an integer of a
6798 different size. In C++, casting to a pointer type of smaller size is
6799 an error. @option{Wint-to-pointer-cast} is enabled by default.
6802 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6803 @opindex Wno-pointer-to-int-cast
6804 @opindex Wpointer-to-int-cast
6805 Suppress warnings from casts from a pointer to an integer type of a
6806 different size.
6808 @item -Winvalid-pch
6809 @opindex Winvalid-pch
6810 @opindex Wno-invalid-pch
6811 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6812 the search path but cannot be used.
6814 @item -Wlong-long
6815 @opindex Wlong-long
6816 @opindex Wno-long-long
6817 Warn if @code{long long} type is used.  This is enabled by either
6818 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6819 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6821 @item -Wvariadic-macros
6822 @opindex Wvariadic-macros
6823 @opindex Wno-variadic-macros
6824 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6825 alternate syntax is used in ISO C99 mode.  This is enabled by either
6826 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6827 messages, use @option{-Wno-variadic-macros}.
6829 @item -Wvarargs
6830 @opindex Wvarargs
6831 @opindex Wno-varargs
6832 Warn upon questionable usage of the macros used to handle variable
6833 arguments like @code{va_start}.  This is default.  To inhibit the
6834 warning messages, use @option{-Wno-varargs}.
6836 @item -Wvector-operation-performance
6837 @opindex Wvector-operation-performance
6838 @opindex Wno-vector-operation-performance
6839 Warn if vector operation is not implemented via SIMD capabilities of the
6840 architecture.  Mainly useful for the performance tuning.
6841 Vector operation can be implemented @code{piecewise}, which means that the
6842 scalar operation is performed on every vector element; 
6843 @code{in parallel}, which means that the vector operation is implemented
6844 using scalars of wider type, which normally is more performance efficient;
6845 and @code{as a single scalar}, which means that vector fits into a
6846 scalar type.
6848 @item -Wno-virtual-move-assign
6849 @opindex Wvirtual-move-assign
6850 @opindex Wno-virtual-move-assign
6851 Suppress warnings about inheriting from a virtual base with a
6852 non-trivial C++11 move assignment operator.  This is dangerous because
6853 if the virtual base is reachable along more than one path, it is
6854 moved multiple times, which can mean both objects end up in the
6855 moved-from state.  If the move assignment operator is written to avoid
6856 moving from a moved-from object, this warning can be disabled.
6858 @item -Wvla
6859 @opindex Wvla
6860 @opindex Wno-vla
6861 Warn if a variable-length array is used in the code.
6862 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6863 the variable-length array.
6865 @item -Wvla-larger-than=@var{n}
6866 If this option is used, the compiler will warn on uses of
6867 variable-length arrays where the size is either unbounded, or bounded
6868 by an argument that can be larger than @var{n} bytes.  This is similar
6869 to how @option{-Walloca-larger-than=@var{n}} works, but with
6870 variable-length arrays.
6872 Note that GCC may optimize small variable-length arrays of a known
6873 value into plain arrays, so this warning may not get triggered for
6874 such arrays.
6876 This warning is not enabled by @option{-Wall}, and is only active when
6877 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6879 See also @option{-Walloca-larger-than=@var{n}}.
6881 @item -Wvolatile-register-var
6882 @opindex Wvolatile-register-var
6883 @opindex Wno-volatile-register-var
6884 Warn if a register variable is declared volatile.  The volatile
6885 modifier does not inhibit all optimizations that may eliminate reads
6886 and/or writes to register variables.  This warning is enabled by
6887 @option{-Wall}.
6889 @item -Wdisabled-optimization
6890 @opindex Wdisabled-optimization
6891 @opindex Wno-disabled-optimization
6892 Warn if a requested optimization pass is disabled.  This warning does
6893 not generally indicate that there is anything wrong with your code; it
6894 merely indicates that GCC's optimizers are unable to handle the code
6895 effectively.  Often, the problem is that your code is too big or too
6896 complex; GCC refuses to optimize programs when the optimization
6897 itself is likely to take inordinate amounts of time.
6899 @item -Wpointer-sign @r{(C and Objective-C only)}
6900 @opindex Wpointer-sign
6901 @opindex Wno-pointer-sign
6902 Warn for pointer argument passing or assignment with different signedness.
6903 This option is only supported for C and Objective-C@.  It is implied by
6904 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6905 @option{-Wno-pointer-sign}.
6907 @item -Wstack-protector
6908 @opindex Wstack-protector
6909 @opindex Wno-stack-protector
6910 This option is only active when @option{-fstack-protector} is active.  It
6911 warns about functions that are not protected against stack smashing.
6913 @item -Woverlength-strings
6914 @opindex Woverlength-strings
6915 @opindex Wno-overlength-strings
6916 Warn about string constants that are longer than the ``minimum
6917 maximum'' length specified in the C standard.  Modern compilers
6918 generally allow string constants that are much longer than the
6919 standard's minimum limit, but very portable programs should avoid
6920 using longer strings.
6922 The limit applies @emph{after} string constant concatenation, and does
6923 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6924 C99, it was raised to 4095.  C++98 does not specify a normative
6925 minimum maximum, so we do not diagnose overlength strings in C++@.
6927 This option is implied by @option{-Wpedantic}, and can be disabled with
6928 @option{-Wno-overlength-strings}.
6930 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6931 @opindex Wunsuffixed-float-constants
6933 Issue a warning for any floating constant that does not have
6934 a suffix.  When used together with @option{-Wsystem-headers} it
6935 warns about such constants in system header files.  This can be useful
6936 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6937 from the decimal floating-point extension to C99.
6939 @item -Wno-designated-init @r{(C and Objective-C only)}
6940 Suppress warnings when a positional initializer is used to initialize
6941 a structure that has been marked with the @code{designated_init}
6942 attribute.
6944 @item -Whsa
6945 Issue a warning when HSAIL cannot be emitted for the compiled function or
6946 OpenMP construct.
6948 @end table
6950 @node Debugging Options
6951 @section Options for Debugging Your Program
6952 @cindex options, debugging
6953 @cindex debugging information options
6955 To tell GCC to emit extra information for use by a debugger, in almost 
6956 all cases you need only to add @option{-g} to your other options.
6958 GCC allows you to use @option{-g} with
6959 @option{-O}.  The shortcuts taken by optimized code may occasionally
6960 be surprising: some variables you declared may not exist
6961 at all; flow of control may briefly move where you did not expect it;
6962 some statements may not be executed because they compute constant
6963 results or their values are already at hand; some statements may
6964 execute in different places because they have been moved out of loops.
6965 Nevertheless it is possible to debug optimized output.  This makes
6966 it reasonable to use the optimizer for programs that might have bugs.
6968 If you are not using some other optimization option, consider
6969 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6970 With no @option{-O} option at all, some compiler passes that collect
6971 information useful for debugging do not run at all, so that
6972 @option{-Og} may result in a better debugging experience.
6974 @table @gcctabopt
6975 @item -g
6976 @opindex g
6977 Produce debugging information in the operating system's native format
6978 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6979 information.
6981 On most systems that use stabs format, @option{-g} enables use of extra
6982 debugging information that only GDB can use; this extra information
6983 makes debugging work better in GDB but probably makes other debuggers
6984 crash or
6985 refuse to read the program.  If you want to control for certain whether
6986 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6987 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6989 @item -ggdb
6990 @opindex ggdb
6991 Produce debugging information for use by GDB@.  This means to use the
6992 most expressive format available (DWARF, stabs, or the native format
6993 if neither of those are supported), including GDB extensions if at all
6994 possible.
6996 @item -gdwarf
6997 @itemx -gdwarf-@var{version}
6998 @opindex gdwarf
6999 Produce debugging information in DWARF format (if that is supported).
7000 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7001 for most targets is 4.  DWARF Version 5 is only experimental.
7003 Note that with DWARF Version 2, some ports require and always
7004 use some non-conflicting DWARF 3 extensions in the unwind tables.
7006 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7007 for maximum benefit.
7009 GCC no longer supports DWARF Version 1, which is substantially
7010 different than Version 2 and later.  For historical reasons, some
7011 other DWARF-related options such as
7012 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7013 in their names, but apply to all currently-supported versions of DWARF.
7015 @item -gstabs
7016 @opindex gstabs
7017 Produce debugging information in stabs format (if that is supported),
7018 without GDB extensions.  This is the format used by DBX on most BSD
7019 systems.  On MIPS, Alpha and System V Release 4 systems this option
7020 produces stabs debugging output that is not understood by DBX@.
7021 On System V Release 4 systems this option requires the GNU assembler.
7023 @item -gstabs+
7024 @opindex gstabs+
7025 Produce debugging information in stabs format (if that is supported),
7026 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7027 use of these extensions is likely to make other debuggers crash or
7028 refuse to read the program.
7030 @item -gxcoff
7031 @opindex gxcoff
7032 Produce debugging information in XCOFF format (if that is supported).
7033 This is the format used by the DBX debugger on IBM RS/6000 systems.
7035 @item -gxcoff+
7036 @opindex gxcoff+
7037 Produce debugging information in XCOFF format (if that is supported),
7038 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7039 use of these extensions is likely to make other debuggers crash or
7040 refuse to read the program, and may cause assemblers other than the GNU
7041 assembler (GAS) to fail with an error.
7043 @item -gvms
7044 @opindex gvms
7045 Produce debugging information in Alpha/VMS debug format (if that is
7046 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7048 @item -g@var{level}
7049 @itemx -ggdb@var{level}
7050 @itemx -gstabs@var{level}
7051 @itemx -gxcoff@var{level}
7052 @itemx -gvms@var{level}
7053 Request debugging information and also use @var{level} to specify how
7054 much information.  The default level is 2.
7056 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7057 @option{-g}.
7059 Level 1 produces minimal information, enough for making backtraces in
7060 parts of the program that you don't plan to debug.  This includes
7061 descriptions of functions and external variables, and line number
7062 tables, but no information about local variables.
7064 Level 3 includes extra information, such as all the macro definitions
7065 present in the program.  Some debuggers support macro expansion when
7066 you use @option{-g3}.
7068 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7069 confusion with @option{-gdwarf-@var{level}}.
7070 Instead use an additional @option{-g@var{level}} option to change the
7071 debug level for DWARF.
7073 @item -feliminate-unused-debug-symbols
7074 @opindex feliminate-unused-debug-symbols
7075 Produce debugging information in stabs format (if that is supported),
7076 for only symbols that are actually used.
7078 @item -femit-class-debug-always
7079 @opindex femit-class-debug-always
7080 Instead of emitting debugging information for a C++ class in only one
7081 object file, emit it in all object files using the class.  This option
7082 should be used only with debuggers that are unable to handle the way GCC
7083 normally emits debugging information for classes because using this
7084 option increases the size of debugging information by as much as a
7085 factor of two.
7087 @item -fno-merge-debug-strings
7088 @opindex fmerge-debug-strings
7089 @opindex fno-merge-debug-strings
7090 Direct the linker to not merge together strings in the debugging
7091 information that are identical in different object files.  Merging is
7092 not supported by all assemblers or linkers.  Merging decreases the size
7093 of the debug information in the output file at the cost of increasing
7094 link processing time.  Merging is enabled by default.
7096 @item -fdebug-prefix-map=@var{old}=@var{new}
7097 @opindex fdebug-prefix-map
7098 When compiling files in directory @file{@var{old}}, record debugging
7099 information describing them as in @file{@var{new}} instead.  This can be
7100 used to replace a build-time path with an install-time path in the debug info.
7101 It can also be used to change an absolute path to a relative path by using
7102 @file{.} for @var{new}.  This can give more reproducible builds, which are
7103 location independent, but may require an extra command to tell GDB where to
7104 find the source files.
7106 @item -fvar-tracking
7107 @opindex fvar-tracking
7108 Run variable tracking pass.  It computes where variables are stored at each
7109 position in code.  Better debugging information is then generated
7110 (if the debugging information format supports this information).
7112 It is enabled by default when compiling with optimization (@option{-Os},
7113 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7114 the debug info format supports it.
7116 @item -fvar-tracking-assignments
7117 @opindex fvar-tracking-assignments
7118 @opindex fno-var-tracking-assignments
7119 Annotate assignments to user variables early in the compilation and
7120 attempt to carry the annotations over throughout the compilation all the
7121 way to the end, in an attempt to improve debug information while
7122 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7124 It can be enabled even if var-tracking is disabled, in which case
7125 annotations are created and maintained, but discarded at the end.
7126 By default, this flag is enabled together with @option{-fvar-tracking},
7127 except when selective scheduling is enabled.
7129 @item -gsplit-dwarf
7130 @opindex gsplit-dwarf
7131 Separate as much DWARF debugging information as possible into a
7132 separate output file with the extension @file{.dwo}.  This option allows
7133 the build system to avoid linking files with debug information.  To
7134 be useful, this option requires a debugger capable of reading @file{.dwo}
7135 files.
7137 @item -gpubnames
7138 @opindex gpubnames
7139 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7141 @item -ggnu-pubnames
7142 @opindex ggnu-pubnames
7143 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7144 suitable for conversion into a GDB@ index.  This option is only useful
7145 with a linker that can produce GDB@ index version 7.
7147 @item -fdebug-types-section
7148 @opindex fdebug-types-section
7149 @opindex fno-debug-types-section
7150 When using DWARF Version 4 or higher, type DIEs can be put into
7151 their own @code{.debug_types} section instead of making them part of the
7152 @code{.debug_info} section.  It is more efficient to put them in a separate
7153 comdat sections since the linker can then remove duplicates.
7154 But not all DWARF consumers support @code{.debug_types} sections yet
7155 and on some objects @code{.debug_types} produces larger instead of smaller
7156 debugging information.
7158 @item -grecord-gcc-switches
7159 @item -gno-record-gcc-switches
7160 @opindex grecord-gcc-switches
7161 @opindex gno-record-gcc-switches
7162 This switch causes the command-line options used to invoke the
7163 compiler that may affect code generation to be appended to the
7164 DW_AT_producer attribute in DWARF debugging information.  The options
7165 are concatenated with spaces separating them from each other and from
7166 the compiler version.  
7167 It is enabled by default.
7168 See also @option{-frecord-gcc-switches} for another
7169 way of storing compiler options into the object file.  
7171 @item -gstrict-dwarf
7172 @opindex gstrict-dwarf
7173 Disallow using extensions of later DWARF standard version than selected
7174 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7175 DWARF extensions from later standard versions is allowed.
7177 @item -gno-strict-dwarf
7178 @opindex gno-strict-dwarf
7179 Allow using extensions of later DWARF standard version than selected with
7180 @option{-gdwarf-@var{version}}.
7182 @item -gcolumn-info
7183 @item -gno-column-info
7184 @opindex gcolumn-info
7185 @opindex gno-column-info
7186 Emit location column information into DWARF debugging information, rather
7187 than just file and line.
7188 This option is enabled by default.
7190 @item -gstatement-frontiers
7191 @item -gno-statement-frontiers
7192 @opindex gstatement-frontiers
7193 @opindex gno-statement-frontiers
7194 This option causes GCC to create markers in the internal representation
7195 at the beginning of statements, and to keep them roughly in place
7196 throughout compilation, using them to guide the output of @code{is_stmt}
7197 markers in the line number table.  This is enabled by default when
7198 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7199 @dots{}), and outputting DWARF 2 debug information at the normal level.
7201 @item -gz@r{[}=@var{type}@r{]}
7202 @opindex gz
7203 Produce compressed debug sections in DWARF format, if that is supported.
7204 If @var{type} is not given, the default type depends on the capabilities
7205 of the assembler and linker used.  @var{type} may be one of
7206 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7207 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7208 compression in traditional GNU format).  If the linker doesn't support
7209 writing compressed debug sections, the option is rejected.  Otherwise,
7210 if the assembler does not support them, @option{-gz} is silently ignored
7211 when producing object files.
7213 @item -femit-struct-debug-baseonly
7214 @opindex femit-struct-debug-baseonly
7215 Emit debug information for struct-like types
7216 only when the base name of the compilation source file
7217 matches the base name of file in which the struct is defined.
7219 This option substantially reduces the size of debugging information,
7220 but at significant potential loss in type information to the debugger.
7221 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7222 See @option{-femit-struct-debug-detailed} for more detailed control.
7224 This option works only with DWARF debug output.
7226 @item -femit-struct-debug-reduced
7227 @opindex femit-struct-debug-reduced
7228 Emit debug information for struct-like types
7229 only when the base name of the compilation source file
7230 matches the base name of file in which the type is defined,
7231 unless the struct is a template or defined in a system header.
7233 This option significantly reduces the size of debugging information,
7234 with some potential loss in type information to the debugger.
7235 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7236 See @option{-femit-struct-debug-detailed} for more detailed control.
7238 This option works only with DWARF debug output.
7240 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7241 @opindex femit-struct-debug-detailed
7242 Specify the struct-like types
7243 for which the compiler generates debug information.
7244 The intent is to reduce duplicate struct debug information
7245 between different object files within the same program.
7247 This option is a detailed version of
7248 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7249 which serves for most needs.
7251 A specification has the syntax@*
7252 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7254 The optional first word limits the specification to
7255 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7256 A struct type is used directly when it is the type of a variable, member.
7257 Indirect uses arise through pointers to structs.
7258 That is, when use of an incomplete struct is valid, the use is indirect.
7259 An example is
7260 @samp{struct one direct; struct two * indirect;}.
7262 The optional second word limits the specification to
7263 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7264 Generic structs are a bit complicated to explain.
7265 For C++, these are non-explicit specializations of template classes,
7266 or non-template classes within the above.
7267 Other programming languages have generics,
7268 but @option{-femit-struct-debug-detailed} does not yet implement them.
7270 The third word specifies the source files for those
7271 structs for which the compiler should emit debug information.
7272 The values @samp{none} and @samp{any} have the normal meaning.
7273 The value @samp{base} means that
7274 the base of name of the file in which the type declaration appears
7275 must match the base of the name of the main compilation file.
7276 In practice, this means that when compiling @file{foo.c}, debug information
7277 is generated for types declared in that file and @file{foo.h},
7278 but not other header files.
7279 The value @samp{sys} means those types satisfying @samp{base}
7280 or declared in system or compiler headers.
7282 You may need to experiment to determine the best settings for your application.
7284 The default is @option{-femit-struct-debug-detailed=all}.
7286 This option works only with DWARF debug output.
7288 @item -fno-dwarf2-cfi-asm
7289 @opindex fdwarf2-cfi-asm
7290 @opindex fno-dwarf2-cfi-asm
7291 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7292 instead of using GAS @code{.cfi_*} directives.
7294 @item -fno-eliminate-unused-debug-types
7295 @opindex feliminate-unused-debug-types
7296 @opindex fno-eliminate-unused-debug-types
7297 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7298 output for types that are nowhere used in the source file being compiled.
7299 Sometimes it is useful to have GCC emit debugging
7300 information for all types declared in a compilation
7301 unit, regardless of whether or not they are actually used
7302 in that compilation unit, for example 
7303 if, in the debugger, you want to cast a value to a type that is
7304 not actually used in your program (but is declared).  More often,
7305 however, this results in a significant amount of wasted space.
7306 @end table
7308 @node Optimize Options
7309 @section Options That Control Optimization
7310 @cindex optimize options
7311 @cindex options, optimization
7313 These options control various sorts of optimizations.
7315 Without any optimization option, the compiler's goal is to reduce the
7316 cost of compilation and to make debugging produce the expected
7317 results.  Statements are independent: if you stop the program with a
7318 breakpoint between statements, you can then assign a new value to any
7319 variable or change the program counter to any other statement in the
7320 function and get exactly the results you expect from the source
7321 code.
7323 Turning on optimization flags makes the compiler attempt to improve
7324 the performance and/or code size at the expense of compilation time
7325 and possibly the ability to debug the program.
7327 The compiler performs optimization based on the knowledge it has of the
7328 program.  Compiling multiple files at once to a single output file mode allows
7329 the compiler to use information gained from all of the files when compiling
7330 each of them.
7332 Not all optimizations are controlled directly by a flag.  Only
7333 optimizations that have a flag are listed in this section.
7335 Most optimizations are only enabled if an @option{-O} level is set on
7336 the command line.  Otherwise they are disabled, even if individual
7337 optimization flags are specified.
7339 Depending on the target and how GCC was configured, a slightly different
7340 set of optimizations may be enabled at each @option{-O} level than
7341 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7342 to find out the exact set of optimizations that are enabled at each level.
7343 @xref{Overall Options}, for examples.
7345 @table @gcctabopt
7346 @item -O
7347 @itemx -O1
7348 @opindex O
7349 @opindex O1
7350 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7351 more memory for a large function.
7353 With @option{-O}, the compiler tries to reduce code size and execution
7354 time, without performing any optimizations that take a great deal of
7355 compilation time.
7357 @option{-O} turns on the following optimization flags:
7358 @gccoptlist{
7359 -fauto-inc-dec @gol
7360 -fbranch-count-reg @gol
7361 -fcombine-stack-adjustments @gol
7362 -fcompare-elim @gol
7363 -fcprop-registers @gol
7364 -fdce @gol
7365 -fdefer-pop @gol
7366 -fdelayed-branch @gol
7367 -fdse @gol
7368 -fforward-propagate @gol
7369 -fguess-branch-probability @gol
7370 -fif-conversion2 @gol
7371 -fif-conversion @gol
7372 -finline-functions-called-once @gol
7373 -fipa-pure-const @gol
7374 -fipa-profile @gol
7375 -fipa-reference @gol
7376 -fmerge-constants @gol
7377 -fmove-loop-invariants @gol
7378 -fomit-frame-pointer @gol
7379 -freorder-blocks @gol
7380 -fshrink-wrap @gol
7381 -fshrink-wrap-separate @gol
7382 -fsplit-wide-types @gol
7383 -fssa-backprop @gol
7384 -fssa-phiopt @gol
7385 -ftree-bit-ccp @gol
7386 -ftree-ccp @gol
7387 -ftree-ch @gol
7388 -ftree-coalesce-vars @gol
7389 -ftree-copy-prop @gol
7390 -ftree-dce @gol
7391 -ftree-dominator-opts @gol
7392 -ftree-dse @gol
7393 -ftree-forwprop @gol
7394 -ftree-fre @gol
7395 -ftree-phiprop @gol
7396 -ftree-sink @gol
7397 -ftree-slsr @gol
7398 -ftree-sra @gol
7399 -ftree-pta @gol
7400 -ftree-ter @gol
7401 -funit-at-a-time}
7403 @item -O2
7404 @opindex O2
7405 Optimize even more.  GCC performs nearly all supported optimizations
7406 that do not involve a space-speed tradeoff.
7407 As compared to @option{-O}, this option increases both compilation time
7408 and the performance of the generated code.
7410 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7411 also turns on the following optimization flags:
7412 @gccoptlist{-fthread-jumps @gol
7413 -falign-functions  -falign-jumps @gol
7414 -falign-loops  -falign-labels @gol
7415 -fcaller-saves @gol
7416 -fcrossjumping @gol
7417 -fcse-follow-jumps  -fcse-skip-blocks @gol
7418 -fdelete-null-pointer-checks @gol
7419 -fdevirtualize -fdevirtualize-speculatively @gol
7420 -fexpensive-optimizations @gol
7421 -fgcse  -fgcse-lm  @gol
7422 -fhoist-adjacent-loads @gol
7423 -finline-small-functions @gol
7424 -findirect-inlining @gol
7425 -fipa-cp @gol
7426 -fipa-bit-cp @gol
7427 -fipa-vrp @gol
7428 -fipa-sra @gol
7429 -fipa-icf @gol
7430 -fisolate-erroneous-paths-dereference @gol
7431 -flra-remat @gol
7432 -foptimize-sibling-calls @gol
7433 -foptimize-strlen @gol
7434 -fpartial-inlining @gol
7435 -fpeephole2 @gol
7436 -freorder-blocks-algorithm=stc @gol
7437 -freorder-blocks-and-partition -freorder-functions @gol
7438 -frerun-cse-after-loop  @gol
7439 -fsched-interblock  -fsched-spec @gol
7440 -fschedule-insns  -fschedule-insns2 @gol
7441 -fstore-merging @gol
7442 -fstrict-aliasing @gol
7443 -ftree-builtin-call-dce @gol
7444 -ftree-switch-conversion -ftree-tail-merge @gol
7445 -fcode-hoisting @gol
7446 -ftree-pre @gol
7447 -ftree-vrp @gol
7448 -fipa-ra}
7450 Please note the warning under @option{-fgcse} about
7451 invoking @option{-O2} on programs that use computed gotos.
7453 @item -O3
7454 @opindex O3
7455 Optimize yet more.  @option{-O3} turns on all optimizations specified
7456 by @option{-O2} and also turns on the following optimization flags:
7457 @gccoptlist{-finline-functions @gol
7458 -funswitch-loops @gol
7459 -fpredictive-commoning @gol
7460 -fgcse-after-reload @gol
7461 -ftree-loop-vectorize @gol
7462 -ftree-loop-distribution @gol
7463 -ftree-loop-distribute-patterns @gol
7464 -floop-interchange @gol
7465 -fsplit-paths @gol
7466 -ftree-slp-vectorize @gol
7467 -fvect-cost-model @gol
7468 -ftree-partial-pre @gol
7469 -fpeel-loops @gol
7470 -fipa-cp-clone}
7472 @item -O0
7473 @opindex O0
7474 Reduce compilation time and make debugging produce the expected
7475 results.  This is the default.
7477 @item -Os
7478 @opindex Os
7479 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7480 do not typically increase code size.  It also performs further
7481 optimizations designed to reduce code size.
7483 @option{-Os} disables the following optimization flags:
7484 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7485 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7486 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7488 @item -Ofast
7489 @opindex Ofast
7490 Disregard strict standards compliance.  @option{-Ofast} enables all
7491 @option{-O3} optimizations.  It also enables optimizations that are not
7492 valid for all standard-compliant programs.
7493 It turns on @option{-ffast-math} and the Fortran-specific
7494 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7495 specified, and @option{-fno-protect-parens}.
7497 @item -Og
7498 @opindex Og
7499 Optimize debugging experience.  @option{-Og} enables optimizations
7500 that do not interfere with debugging. It should be the optimization
7501 level of choice for the standard edit-compile-debug cycle, offering
7502 a reasonable level of optimization while maintaining fast compilation
7503 and a good debugging experience.
7504 @end table
7506 If you use multiple @option{-O} options, with or without level numbers,
7507 the last such option is the one that is effective.
7509 Options of the form @option{-f@var{flag}} specify machine-independent
7510 flags.  Most flags have both positive and negative forms; the negative
7511 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7512 below, only one of the forms is listed---the one you typically 
7513 use.  You can figure out the other form by either removing @samp{no-}
7514 or adding it.
7516 The following options control specific optimizations.  They are either
7517 activated by @option{-O} options or are related to ones that are.  You
7518 can use the following flags in the rare cases when ``fine-tuning'' of
7519 optimizations to be performed is desired.
7521 @table @gcctabopt
7522 @item -fno-defer-pop
7523 @opindex fno-defer-pop
7524 Always pop the arguments to each function call as soon as that function
7525 returns.  For machines that must pop arguments after a function call,
7526 the compiler normally lets arguments accumulate on the stack for several
7527 function calls and pops them all at once.
7529 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7531 @item -fforward-propagate
7532 @opindex fforward-propagate
7533 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7534 instructions and checks if the result can be simplified.  If loop unrolling
7535 is active, two passes are performed and the second is scheduled after
7536 loop unrolling.
7538 This option is enabled by default at optimization levels @option{-O},
7539 @option{-O2}, @option{-O3}, @option{-Os}.
7541 @item -ffp-contract=@var{style}
7542 @opindex ffp-contract
7543 @option{-ffp-contract=off} disables floating-point expression contraction.
7544 @option{-ffp-contract=fast} enables floating-point expression contraction
7545 such as forming of fused multiply-add operations if the target has
7546 native support for them.
7547 @option{-ffp-contract=on} enables floating-point expression contraction
7548 if allowed by the language standard.  This is currently not implemented
7549 and treated equal to @option{-ffp-contract=off}.
7551 The default is @option{-ffp-contract=fast}.
7553 @item -fomit-frame-pointer
7554 @opindex fomit-frame-pointer
7555 Omit the frame pointer in functions that don't need one.  This avoids the
7556 instructions to save, set up and restore the frame pointer; on many targets
7557 it also makes an extra register available.
7559 On some targets this flag has no effect because the standard calling sequence
7560 always uses a frame pointer, so it cannot be omitted.
7562 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7563 is used in all functions.  Several targets always omit the frame pointer in
7564 leaf functions.
7566 Enabled by default at @option{-O} and higher.
7568 @item -foptimize-sibling-calls
7569 @opindex foptimize-sibling-calls
7570 Optimize sibling and tail recursive calls.
7572 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7574 @item -foptimize-strlen
7575 @opindex foptimize-strlen
7576 Optimize various standard C string functions (e.g. @code{strlen},
7577 @code{strchr} or @code{strcpy}) and
7578 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7580 Enabled at levels @option{-O2}, @option{-O3}.
7582 @item -fno-inline
7583 @opindex fno-inline
7584 Do not expand any functions inline apart from those marked with
7585 the @code{always_inline} attribute.  This is the default when not
7586 optimizing.
7588 Single functions can be exempted from inlining by marking them
7589 with the @code{noinline} attribute.
7591 @item -finline-small-functions
7592 @opindex finline-small-functions
7593 Integrate functions into their callers when their body is smaller than expected
7594 function call code (so overall size of program gets smaller).  The compiler
7595 heuristically decides which functions are simple enough to be worth integrating
7596 in this way.  This inlining applies to all functions, even those not declared
7597 inline.
7599 Enabled at level @option{-O2}.
7601 @item -findirect-inlining
7602 @opindex findirect-inlining
7603 Inline also indirect calls that are discovered to be known at compile
7604 time thanks to previous inlining.  This option has any effect only
7605 when inlining itself is turned on by the @option{-finline-functions}
7606 or @option{-finline-small-functions} options.
7608 Enabled at level @option{-O2}.
7610 @item -finline-functions
7611 @opindex finline-functions
7612 Consider all functions for inlining, even if they are not declared inline.
7613 The compiler heuristically decides which functions are worth integrating
7614 in this way.
7616 If all calls to a given function are integrated, and the function is
7617 declared @code{static}, then the function is normally not output as
7618 assembler code in its own right.
7620 Enabled at level @option{-O3}.
7622 @item -finline-functions-called-once
7623 @opindex finline-functions-called-once
7624 Consider all @code{static} functions called once for inlining into their
7625 caller even if they are not marked @code{inline}.  If a call to a given
7626 function is integrated, then the function is not output as assembler code
7627 in its own right.
7629 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7631 @item -fearly-inlining
7632 @opindex fearly-inlining
7633 Inline functions marked by @code{always_inline} and functions whose body seems
7634 smaller than the function call overhead early before doing
7635 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7636 makes profiling significantly cheaper and usually inlining faster on programs
7637 having large chains of nested wrapper functions.
7639 Enabled by default.
7641 @item -fipa-sra
7642 @opindex fipa-sra
7643 Perform interprocedural scalar replacement of aggregates, removal of
7644 unused parameters and replacement of parameters passed by reference
7645 by parameters passed by value.
7647 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7649 @item -finline-limit=@var{n}
7650 @opindex finline-limit
7651 By default, GCC limits the size of functions that can be inlined.  This flag
7652 allows coarse control of this limit.  @var{n} is the size of functions that
7653 can be inlined in number of pseudo instructions.
7655 Inlining is actually controlled by a number of parameters, which may be
7656 specified individually by using @option{--param @var{name}=@var{value}}.
7657 The @option{-finline-limit=@var{n}} option sets some of these parameters
7658 as follows:
7660 @table @gcctabopt
7661 @item max-inline-insns-single
7662 is set to @var{n}/2.
7663 @item max-inline-insns-auto
7664 is set to @var{n}/2.
7665 @end table
7667 See below for a documentation of the individual
7668 parameters controlling inlining and for the defaults of these parameters.
7670 @emph{Note:} there may be no value to @option{-finline-limit} that results
7671 in default behavior.
7673 @emph{Note:} pseudo instruction represents, in this particular context, an
7674 abstract measurement of function's size.  In no way does it represent a count
7675 of assembly instructions and as such its exact meaning might change from one
7676 release to an another.
7678 @item -fno-keep-inline-dllexport
7679 @opindex fno-keep-inline-dllexport
7680 This is a more fine-grained version of @option{-fkeep-inline-functions},
7681 which applies only to functions that are declared using the @code{dllexport}
7682 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7683 Functions}.
7685 @item -fkeep-inline-functions
7686 @opindex fkeep-inline-functions
7687 In C, emit @code{static} functions that are declared @code{inline}
7688 into the object file, even if the function has been inlined into all
7689 of its callers.  This switch does not affect functions using the
7690 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7691 inline functions into the object file.
7693 @item -fkeep-static-functions
7694 @opindex fkeep-static-functions
7695 Emit @code{static} functions into the object file, even if the function
7696 is never used.
7698 @item -fkeep-static-consts
7699 @opindex fkeep-static-consts
7700 Emit variables declared @code{static const} when optimization isn't turned
7701 on, even if the variables aren't referenced.
7703 GCC enables this option by default.  If you want to force the compiler to
7704 check if a variable is referenced, regardless of whether or not
7705 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7707 @item -fmerge-constants
7708 @opindex fmerge-constants
7709 Attempt to merge identical constants (string constants and floating-point
7710 constants) across compilation units.
7712 This option is the default for optimized compilation if the assembler and
7713 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7714 behavior.
7716 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7718 @item -fmerge-all-constants
7719 @opindex fmerge-all-constants
7720 Attempt to merge identical constants and identical variables.
7722 This option implies @option{-fmerge-constants}.  In addition to
7723 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7724 arrays or initialized constant variables with integral or floating-point
7725 types.  Languages like C or C++ require each variable, including multiple
7726 instances of the same variable in recursive calls, to have distinct locations,
7727 so using this option results in non-conforming
7728 behavior.
7730 @item -fmodulo-sched
7731 @opindex fmodulo-sched
7732 Perform swing modulo scheduling immediately before the first scheduling
7733 pass.  This pass looks at innermost loops and reorders their
7734 instructions by overlapping different iterations.
7736 @item -fmodulo-sched-allow-regmoves
7737 @opindex fmodulo-sched-allow-regmoves
7738 Perform more aggressive SMS-based modulo scheduling with register moves
7739 allowed.  By setting this flag certain anti-dependences edges are
7740 deleted, which triggers the generation of reg-moves based on the
7741 life-range analysis.  This option is effective only with
7742 @option{-fmodulo-sched} enabled.
7744 @item -fno-branch-count-reg
7745 @opindex fno-branch-count-reg
7746 Avoid running a pass scanning for opportunities to use ``decrement and
7747 branch'' instructions on a count register instead of generating sequences
7748 of instructions that decrement a register, compare it against zero, and
7749 then branch based upon the result.  This option is only meaningful on
7750 architectures that support such instructions, which include x86, PowerPC,
7751 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7752 doesn't remove the decrement and branch instructions from the generated
7753 instruction stream introduced by other optimization passes.
7755 Enabled by default at @option{-O1} and higher.
7757 The default is @option{-fbranch-count-reg}.
7759 @item -fno-function-cse
7760 @opindex fno-function-cse
7761 Do not put function addresses in registers; make each instruction that
7762 calls a constant function contain the function's address explicitly.
7764 This option results in less efficient code, but some strange hacks
7765 that alter the assembler output may be confused by the optimizations
7766 performed when this option is not used.
7768 The default is @option{-ffunction-cse}
7770 @item -fno-zero-initialized-in-bss
7771 @opindex fno-zero-initialized-in-bss
7772 If the target supports a BSS section, GCC by default puts variables that
7773 are initialized to zero into BSS@.  This can save space in the resulting
7774 code.
7776 This option turns off this behavior because some programs explicitly
7777 rely on variables going to the data section---e.g., so that the
7778 resulting executable can find the beginning of that section and/or make
7779 assumptions based on that.
7781 The default is @option{-fzero-initialized-in-bss}.
7783 @item -fthread-jumps
7784 @opindex fthread-jumps
7785 Perform optimizations that check to see if a jump branches to a
7786 location where another comparison subsumed by the first is found.  If
7787 so, the first branch is redirected to either the destination of the
7788 second branch or a point immediately following it, depending on whether
7789 the condition is known to be true or false.
7791 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7793 @item -fsplit-wide-types
7794 @opindex fsplit-wide-types
7795 When using a type that occupies multiple registers, such as @code{long
7796 long} on a 32-bit system, split the registers apart and allocate them
7797 independently.  This normally generates better code for those types,
7798 but may make debugging more difficult.
7800 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7801 @option{-Os}.
7803 @item -fcse-follow-jumps
7804 @opindex fcse-follow-jumps
7805 In common subexpression elimination (CSE), scan through jump instructions
7806 when the target of the jump is not reached by any other path.  For
7807 example, when CSE encounters an @code{if} statement with an
7808 @code{else} clause, CSE follows the jump when the condition
7809 tested is false.
7811 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7813 @item -fcse-skip-blocks
7814 @opindex fcse-skip-blocks
7815 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7816 follow jumps that conditionally skip over blocks.  When CSE
7817 encounters a simple @code{if} statement with no else clause,
7818 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7819 body of the @code{if}.
7821 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7823 @item -frerun-cse-after-loop
7824 @opindex frerun-cse-after-loop
7825 Re-run common subexpression elimination after loop optimizations are
7826 performed.
7828 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7830 @item -fgcse
7831 @opindex fgcse
7832 Perform a global common subexpression elimination pass.
7833 This pass also performs global constant and copy propagation.
7835 @emph{Note:} When compiling a program using computed gotos, a GCC
7836 extension, you may get better run-time performance if you disable
7837 the global common subexpression elimination pass by adding
7838 @option{-fno-gcse} to the command line.
7840 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7842 @item -fgcse-lm
7843 @opindex fgcse-lm
7844 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7845 attempts to move loads that are only killed by stores into themselves.  This
7846 allows a loop containing a load/store sequence to be changed to a load outside
7847 the loop, and a copy/store within the loop.
7849 Enabled by default when @option{-fgcse} is enabled.
7851 @item -fgcse-sm
7852 @opindex fgcse-sm
7853 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7854 global common subexpression elimination.  This pass attempts to move
7855 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7856 loops containing a load/store sequence can be changed to a load before
7857 the loop and a store after the loop.
7859 Not enabled at any optimization level.
7861 @item -fgcse-las
7862 @opindex fgcse-las
7863 When @option{-fgcse-las} is enabled, the global common subexpression
7864 elimination pass eliminates redundant loads that come after stores to the
7865 same memory location (both partial and full redundancies).
7867 Not enabled at any optimization level.
7869 @item -fgcse-after-reload
7870 @opindex fgcse-after-reload
7871 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7872 pass is performed after reload.  The purpose of this pass is to clean up
7873 redundant spilling.
7875 @item -faggressive-loop-optimizations
7876 @opindex faggressive-loop-optimizations
7877 This option tells the loop optimizer to use language constraints to
7878 derive bounds for the number of iterations of a loop.  This assumes that
7879 loop code does not invoke undefined behavior by for example causing signed
7880 integer overflows or out-of-bound array accesses.  The bounds for the
7881 number of iterations of a loop are used to guide loop unrolling and peeling
7882 and loop exit test optimizations.
7883 This option is enabled by default.
7885 @item -funconstrained-commons
7886 @opindex funconstrained-commons
7887 This option tells the compiler that variables declared in common blocks
7888 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7889 prevents certain optimizations that depend on knowing the array bounds.
7891 @item -fcrossjumping
7892 @opindex fcrossjumping
7893 Perform cross-jumping transformation.
7894 This transformation unifies equivalent code and saves code size.  The
7895 resulting code may or may not perform better than without cross-jumping.
7897 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7899 @item -fauto-inc-dec
7900 @opindex fauto-inc-dec
7901 Combine increments or decrements of addresses with memory accesses.
7902 This pass is always skipped on architectures that do not have
7903 instructions to support this.  Enabled by default at @option{-O} and
7904 higher on architectures that support this.
7906 @item -fdce
7907 @opindex fdce
7908 Perform dead code elimination (DCE) on RTL@.
7909 Enabled by default at @option{-O} and higher.
7911 @item -fdse
7912 @opindex fdse
7913 Perform dead store elimination (DSE) on RTL@.
7914 Enabled by default at @option{-O} and higher.
7916 @item -fif-conversion
7917 @opindex fif-conversion
7918 Attempt to transform conditional jumps into branch-less equivalents.  This
7919 includes use of conditional moves, min, max, set flags and abs instructions, and
7920 some tricks doable by standard arithmetics.  The use of conditional execution
7921 on chips where it is available is controlled by @option{-fif-conversion2}.
7923 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7925 @item -fif-conversion2
7926 @opindex fif-conversion2
7927 Use conditional execution (where available) to transform conditional jumps into
7928 branch-less equivalents.
7930 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7932 @item -fdeclone-ctor-dtor
7933 @opindex fdeclone-ctor-dtor
7934 The C++ ABI requires multiple entry points for constructors and
7935 destructors: one for a base subobject, one for a complete object, and
7936 one for a virtual destructor that calls operator delete afterwards.
7937 For a hierarchy with virtual bases, the base and complete variants are
7938 clones, which means two copies of the function.  With this option, the
7939 base and complete variants are changed to be thunks that call a common
7940 implementation.
7942 Enabled by @option{-Os}.
7944 @item -fdelete-null-pointer-checks
7945 @opindex fdelete-null-pointer-checks
7946 Assume that programs cannot safely dereference null pointers, and that
7947 no code or data element resides at address zero.
7948 This option enables simple constant
7949 folding optimizations at all optimization levels.  In addition, other
7950 optimization passes in GCC use this flag to control global dataflow
7951 analyses that eliminate useless checks for null pointers; these assume
7952 that a memory access to address zero always results in a trap, so
7953 that if a pointer is checked after it has already been dereferenced,
7954 it cannot be null.
7956 Note however that in some environments this assumption is not true.
7957 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7958 for programs that depend on that behavior.
7960 This option is enabled by default on most targets.  On Nios II ELF, it
7961 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7963 Passes that use the dataflow information
7964 are enabled independently at different optimization levels.
7966 @item -fdevirtualize
7967 @opindex fdevirtualize
7968 Attempt to convert calls to virtual functions to direct calls.  This
7969 is done both within a procedure and interprocedurally as part of
7970 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7971 propagation (@option{-fipa-cp}).
7972 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7974 @item -fdevirtualize-speculatively
7975 @opindex fdevirtualize-speculatively
7976 Attempt to convert calls to virtual functions to speculative direct calls.
7977 Based on the analysis of the type inheritance graph, determine for a given call
7978 the set of likely targets. If the set is small, preferably of size 1, change
7979 the call into a conditional deciding between direct and indirect calls.  The
7980 speculative calls enable more optimizations, such as inlining.  When they seem
7981 useless after further optimization, they are converted back into original form.
7983 @item -fdevirtualize-at-ltrans
7984 @opindex fdevirtualize-at-ltrans
7985 Stream extra information needed for aggressive devirtualization when running
7986 the link-time optimizer in local transformation mode.  
7987 This option enables more devirtualization but
7988 significantly increases the size of streamed data. For this reason it is
7989 disabled by default.
7991 @item -fexpensive-optimizations
7992 @opindex fexpensive-optimizations
7993 Perform a number of minor optimizations that are relatively expensive.
7995 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7997 @item -free
7998 @opindex free
7999 Attempt to remove redundant extension instructions.  This is especially
8000 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8001 registers after writing to their lower 32-bit half.
8003 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8004 @option{-O3}, @option{-Os}.
8006 @item -fno-lifetime-dse
8007 @opindex fno-lifetime-dse
8008 In C++ the value of an object is only affected by changes within its
8009 lifetime: when the constructor begins, the object has an indeterminate
8010 value, and any changes during the lifetime of the object are dead when
8011 the object is destroyed.  Normally dead store elimination will take
8012 advantage of this; if your code relies on the value of the object
8013 storage persisting beyond the lifetime of the object, you can use this
8014 flag to disable this optimization.  To preserve stores before the
8015 constructor starts (e.g. because your operator new clears the object
8016 storage) but still treat the object as dead after the destructor you,
8017 can use @option{-flifetime-dse=1}.  The default behavior can be
8018 explicitly selected with @option{-flifetime-dse=2}.
8019 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8021 @item -flive-range-shrinkage
8022 @opindex flive-range-shrinkage
8023 Attempt to decrease register pressure through register live range
8024 shrinkage.  This is helpful for fast processors with small or moderate
8025 size register sets.
8027 @item -fira-algorithm=@var{algorithm}
8028 @opindex fira-algorithm
8029 Use the specified coloring algorithm for the integrated register
8030 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8031 specifies Chow's priority coloring, or @samp{CB}, which specifies
8032 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8033 for all architectures, but for those targets that do support it, it is
8034 the default because it generates better code.
8036 @item -fira-region=@var{region}
8037 @opindex fira-region
8038 Use specified regions for the integrated register allocator.  The
8039 @var{region} argument should be one of the following:
8041 @table @samp
8043 @item all
8044 Use all loops as register allocation regions.
8045 This can give the best results for machines with a small and/or
8046 irregular register set.
8048 @item mixed
8049 Use all loops except for loops with small register pressure 
8050 as the regions.  This value usually gives
8051 the best results in most cases and for most architectures,
8052 and is enabled by default when compiling with optimization for speed
8053 (@option{-O}, @option{-O2}, @dots{}).
8055 @item one
8056 Use all functions as a single region.  
8057 This typically results in the smallest code size, and is enabled by default for
8058 @option{-Os} or @option{-O0}.
8060 @end table
8062 @item -fira-hoist-pressure
8063 @opindex fira-hoist-pressure
8064 Use IRA to evaluate register pressure in the code hoisting pass for
8065 decisions to hoist expressions.  This option usually results in smaller
8066 code, but it can slow the compiler down.
8068 This option is enabled at level @option{-Os} for all targets.
8070 @item -fira-loop-pressure
8071 @opindex fira-loop-pressure
8072 Use IRA to evaluate register pressure in loops for decisions to move
8073 loop invariants.  This option usually results in generation
8074 of faster and smaller code on machines with large register files (>= 32
8075 registers), but it can slow the compiler down.
8077 This option is enabled at level @option{-O3} for some targets.
8079 @item -fno-ira-share-save-slots
8080 @opindex fno-ira-share-save-slots
8081 Disable sharing of stack slots used for saving call-used hard
8082 registers living through a call.  Each hard register gets a
8083 separate stack slot, and as a result function stack frames are
8084 larger.
8086 @item -fno-ira-share-spill-slots
8087 @opindex fno-ira-share-spill-slots
8088 Disable sharing of stack slots allocated for pseudo-registers.  Each
8089 pseudo-register that does not get a hard register gets a separate
8090 stack slot, and as a result function stack frames are larger.
8092 @item -flra-remat
8093 @opindex flra-remat
8094 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8095 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8096 values if it is profitable.
8098 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8100 @item -fdelayed-branch
8101 @opindex fdelayed-branch
8102 If supported for the target machine, attempt to reorder instructions
8103 to exploit instruction slots available after delayed branch
8104 instructions.
8106 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8108 @item -fschedule-insns
8109 @opindex fschedule-insns
8110 If supported for the target machine, attempt to reorder instructions to
8111 eliminate execution stalls due to required data being unavailable.  This
8112 helps machines that have slow floating point or memory load instructions
8113 by allowing other instructions to be issued until the result of the load
8114 or floating-point instruction is required.
8116 Enabled at levels @option{-O2}, @option{-O3}.
8118 @item -fschedule-insns2
8119 @opindex fschedule-insns2
8120 Similar to @option{-fschedule-insns}, but requests an additional pass of
8121 instruction scheduling after register allocation has been done.  This is
8122 especially useful on machines with a relatively small number of
8123 registers and where memory load instructions take more than one cycle.
8125 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8127 @item -fno-sched-interblock
8128 @opindex fno-sched-interblock
8129 Don't schedule instructions across basic blocks.  This is normally
8130 enabled by default when scheduling before register allocation, i.e.@:
8131 with @option{-fschedule-insns} or at @option{-O2} or higher.
8133 @item -fno-sched-spec
8134 @opindex fno-sched-spec
8135 Don't allow speculative motion of non-load instructions.  This is normally
8136 enabled by default when scheduling before register allocation, i.e.@:
8137 with @option{-fschedule-insns} or at @option{-O2} or higher.
8139 @item -fsched-pressure
8140 @opindex fsched-pressure
8141 Enable register pressure sensitive insn scheduling before register
8142 allocation.  This only makes sense when scheduling before register
8143 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8144 @option{-O2} or higher.  Usage of this option can improve the
8145 generated code and decrease its size by preventing register pressure
8146 increase above the number of available hard registers and subsequent
8147 spills in register allocation.
8149 @item -fsched-spec-load
8150 @opindex fsched-spec-load
8151 Allow speculative motion of some load instructions.  This only makes
8152 sense when scheduling before register allocation, i.e.@: with
8153 @option{-fschedule-insns} or at @option{-O2} or higher.
8155 @item -fsched-spec-load-dangerous
8156 @opindex fsched-spec-load-dangerous
8157 Allow speculative motion of more load instructions.  This only makes
8158 sense when scheduling before register allocation, i.e.@: with
8159 @option{-fschedule-insns} or at @option{-O2} or higher.
8161 @item -fsched-stalled-insns
8162 @itemx -fsched-stalled-insns=@var{n}
8163 @opindex fsched-stalled-insns
8164 Define how many insns (if any) can be moved prematurely from the queue
8165 of stalled insns into the ready list during the second scheduling pass.
8166 @option{-fno-sched-stalled-insns} means that no insns are moved
8167 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8168 on how many queued insns can be moved prematurely.
8169 @option{-fsched-stalled-insns} without a value is equivalent to
8170 @option{-fsched-stalled-insns=1}.
8172 @item -fsched-stalled-insns-dep
8173 @itemx -fsched-stalled-insns-dep=@var{n}
8174 @opindex fsched-stalled-insns-dep
8175 Define how many insn groups (cycles) are examined for a dependency
8176 on a stalled insn that is a candidate for premature removal from the queue
8177 of stalled insns.  This has an effect only during the second scheduling pass,
8178 and only if @option{-fsched-stalled-insns} is used.
8179 @option{-fno-sched-stalled-insns-dep} is equivalent to
8180 @option{-fsched-stalled-insns-dep=0}.
8181 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8182 @option{-fsched-stalled-insns-dep=1}.
8184 @item -fsched2-use-superblocks
8185 @opindex fsched2-use-superblocks
8186 When scheduling after register allocation, use superblock scheduling.
8187 This allows motion across basic block boundaries,
8188 resulting in faster schedules.  This option is experimental, as not all machine
8189 descriptions used by GCC model the CPU closely enough to avoid unreliable
8190 results from the algorithm.
8192 This only makes sense when scheduling after register allocation, i.e.@: with
8193 @option{-fschedule-insns2} or at @option{-O2} or higher.
8195 @item -fsched-group-heuristic
8196 @opindex fsched-group-heuristic
8197 Enable the group heuristic in the scheduler.  This heuristic favors
8198 the instruction that belongs to a schedule group.  This is enabled
8199 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8200 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8202 @item -fsched-critical-path-heuristic
8203 @opindex fsched-critical-path-heuristic
8204 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8205 instructions on the critical path.  This is enabled by default when
8206 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8207 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8209 @item -fsched-spec-insn-heuristic
8210 @opindex fsched-spec-insn-heuristic
8211 Enable the speculative instruction heuristic in the scheduler.  This
8212 heuristic favors speculative instructions with greater dependency weakness.
8213 This is enabled by default when scheduling is enabled, i.e.@:
8214 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8215 or at @option{-O2} or higher.
8217 @item -fsched-rank-heuristic
8218 @opindex fsched-rank-heuristic
8219 Enable the rank heuristic in the scheduler.  This heuristic favors
8220 the instruction belonging to a basic block with greater size or frequency.
8221 This is enabled by default when scheduling is enabled, i.e.@:
8222 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8223 at @option{-O2} or higher.
8225 @item -fsched-last-insn-heuristic
8226 @opindex fsched-last-insn-heuristic
8227 Enable the last-instruction heuristic in the scheduler.  This heuristic
8228 favors the instruction that is less dependent on the last instruction
8229 scheduled.  This is enabled by default when scheduling is enabled,
8230 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8231 at @option{-O2} or higher.
8233 @item -fsched-dep-count-heuristic
8234 @opindex fsched-dep-count-heuristic
8235 Enable the dependent-count heuristic in the scheduler.  This heuristic
8236 favors the instruction that has more instructions depending on it.
8237 This is enabled by default when scheduling is enabled, i.e.@:
8238 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8239 at @option{-O2} or higher.
8241 @item -freschedule-modulo-scheduled-loops
8242 @opindex freschedule-modulo-scheduled-loops
8243 Modulo scheduling is performed before traditional scheduling.  If a loop
8244 is modulo scheduled, later scheduling passes may change its schedule.  
8245 Use this option to control that behavior.
8247 @item -fselective-scheduling
8248 @opindex fselective-scheduling
8249 Schedule instructions using selective scheduling algorithm.  Selective
8250 scheduling runs instead of the first scheduler pass.
8252 @item -fselective-scheduling2
8253 @opindex fselective-scheduling2
8254 Schedule instructions using selective scheduling algorithm.  Selective
8255 scheduling runs instead of the second scheduler pass.
8257 @item -fsel-sched-pipelining
8258 @opindex fsel-sched-pipelining
8259 Enable software pipelining of innermost loops during selective scheduling.
8260 This option has no effect unless one of @option{-fselective-scheduling} or
8261 @option{-fselective-scheduling2} is turned on.
8263 @item -fsel-sched-pipelining-outer-loops
8264 @opindex fsel-sched-pipelining-outer-loops
8265 When pipelining loops during selective scheduling, also pipeline outer loops.
8266 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8268 @item -fsemantic-interposition
8269 @opindex fsemantic-interposition
8270 Some object formats, like ELF, allow interposing of symbols by the 
8271 dynamic linker.
8272 This means that for symbols exported from the DSO, the compiler cannot perform
8273 interprocedural propagation, inlining and other optimizations in anticipation
8274 that the function or variable in question may change. While this feature is
8275 useful, for example, to rewrite memory allocation functions by a debugging
8276 implementation, it is expensive in the terms of code quality.
8277 With @option{-fno-semantic-interposition} the compiler assumes that 
8278 if interposition happens for functions the overwriting function will have 
8279 precisely the same semantics (and side effects). 
8280 Similarly if interposition happens
8281 for variables, the constructor of the variable will be the same. The flag
8282 has no effect for functions explicitly declared inline 
8283 (where it is never allowed for interposition to change semantics) 
8284 and for symbols explicitly declared weak.
8286 @item -fshrink-wrap
8287 @opindex fshrink-wrap
8288 Emit function prologues only before parts of the function that need it,
8289 rather than at the top of the function.  This flag is enabled by default at
8290 @option{-O} and higher.
8292 @item -fshrink-wrap-separate
8293 @opindex fshrink-wrap-separate
8294 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8295 those parts are only executed when needed.
8296 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8297 is also turned on and the target supports this.
8299 @item -fcaller-saves
8300 @opindex fcaller-saves
8301 Enable allocation of values to registers that are clobbered by
8302 function calls, by emitting extra instructions to save and restore the
8303 registers around such calls.  Such allocation is done only when it
8304 seems to result in better code.
8306 This option is always enabled by default on certain machines, usually
8307 those which have no call-preserved registers to use instead.
8309 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8311 @item -fcombine-stack-adjustments
8312 @opindex fcombine-stack-adjustments
8313 Tracks stack adjustments (pushes and pops) and stack memory references
8314 and then tries to find ways to combine them.
8316 Enabled by default at @option{-O1} and higher.
8318 @item -fipa-ra
8319 @opindex fipa-ra
8320 Use caller save registers for allocation if those registers are not used by
8321 any called function.  In that case it is not necessary to save and restore
8322 them around calls.  This is only possible if called functions are part of
8323 same compilation unit as current function and they are compiled before it.
8325 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8326 is disabled if generated code will be instrumented for profiling
8327 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8328 exactly (this happens on targets that do not expose prologues
8329 and epilogues in RTL).
8331 @item -fconserve-stack
8332 @opindex fconserve-stack
8333 Attempt to minimize stack usage.  The compiler attempts to use less
8334 stack space, even if that makes the program slower.  This option
8335 implies setting the @option{large-stack-frame} parameter to 100
8336 and the @option{large-stack-frame-growth} parameter to 400.
8338 @item -ftree-reassoc
8339 @opindex ftree-reassoc
8340 Perform reassociation on trees.  This flag is enabled by default
8341 at @option{-O} and higher.
8343 @item -fcode-hoisting
8344 @opindex fcode-hoisting
8345 Perform code hoisting.  Code hoisting tries to move the
8346 evaluation of expressions executed on all paths to the function exit
8347 as early as possible.  This is especially useful as a code size
8348 optimization, but it often helps for code speed as well.
8349 This flag is enabled by default at @option{-O2} and higher.
8351 @item -ftree-pre
8352 @opindex ftree-pre
8353 Perform partial redundancy elimination (PRE) on trees.  This flag is
8354 enabled by default at @option{-O2} and @option{-O3}.
8356 @item -ftree-partial-pre
8357 @opindex ftree-partial-pre
8358 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8359 enabled by default at @option{-O3}.
8361 @item -ftree-forwprop
8362 @opindex ftree-forwprop
8363 Perform forward propagation on trees.  This flag is enabled by default
8364 at @option{-O} and higher.
8366 @item -ftree-fre
8367 @opindex ftree-fre
8368 Perform full redundancy elimination (FRE) on trees.  The difference
8369 between FRE and PRE is that FRE only considers expressions
8370 that are computed on all paths leading to the redundant computation.
8371 This analysis is faster than PRE, though it exposes fewer redundancies.
8372 This flag is enabled by default at @option{-O} and higher.
8374 @item -ftree-phiprop
8375 @opindex ftree-phiprop
8376 Perform hoisting of loads from conditional pointers on trees.  This
8377 pass is enabled by default at @option{-O} and higher.
8379 @item -fhoist-adjacent-loads
8380 @opindex fhoist-adjacent-loads
8381 Speculatively hoist loads from both branches of an if-then-else if the
8382 loads are from adjacent locations in the same structure and the target
8383 architecture has a conditional move instruction.  This flag is enabled
8384 by default at @option{-O2} and higher.
8386 @item -ftree-copy-prop
8387 @opindex ftree-copy-prop
8388 Perform copy propagation on trees.  This pass eliminates unnecessary
8389 copy operations.  This flag is enabled by default at @option{-O} and
8390 higher.
8392 @item -fipa-pure-const
8393 @opindex fipa-pure-const
8394 Discover which functions are pure or constant.
8395 Enabled by default at @option{-O} and higher.
8397 @item -fipa-reference
8398 @opindex fipa-reference
8399 Discover which static variables do not escape the
8400 compilation unit.
8401 Enabled by default at @option{-O} and higher.
8403 @item -fipa-pta
8404 @opindex fipa-pta
8405 Perform interprocedural pointer analysis and interprocedural modification
8406 and reference analysis.  This option can cause excessive memory and
8407 compile-time usage on large compilation units.  It is not enabled by
8408 default at any optimization level.
8410 @item -fipa-profile
8411 @opindex fipa-profile
8412 Perform interprocedural profile propagation.  The functions called only from
8413 cold functions are marked as cold. Also functions executed once (such as
8414 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8415 functions and loop less parts of functions executed once are then optimized for
8416 size.
8417 Enabled by default at @option{-O} and higher.
8419 @item -fipa-cp
8420 @opindex fipa-cp
8421 Perform interprocedural constant propagation.
8422 This optimization analyzes the program to determine when values passed
8423 to functions are constants and then optimizes accordingly.
8424 This optimization can substantially increase performance
8425 if the application has constants passed to functions.
8426 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8428 @item -fipa-cp-clone
8429 @opindex fipa-cp-clone
8430 Perform function cloning to make interprocedural constant propagation stronger.
8431 When enabled, interprocedural constant propagation performs function cloning
8432 when externally visible function can be called with constant arguments.
8433 Because this optimization can create multiple copies of functions,
8434 it may significantly increase code size
8435 (see @option{--param ipcp-unit-growth=@var{value}}).
8436 This flag is enabled by default at @option{-O3}.
8438 @item -fipa-bit-cp
8439 @opindex -fipa-bit-cp
8440 When enabled, perform interprocedural bitwise constant
8441 propagation. This flag is enabled by default at @option{-O2}. It
8442 requires that @option{-fipa-cp} is enabled.
8444 @item -fipa-vrp
8445 @opindex -fipa-vrp
8446 When enabled, perform interprocedural propagation of value
8447 ranges. This flag is enabled by default at @option{-O2}. It requires
8448 that @option{-fipa-cp} is enabled.
8450 @item -fipa-icf
8451 @opindex fipa-icf
8452 Perform Identical Code Folding for functions and read-only variables.
8453 The optimization reduces code size and may disturb unwind stacks by replacing
8454 a function by equivalent one with a different name. The optimization works
8455 more effectively with link-time optimization enabled.
8457 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8458 works on different levels and thus the optimizations are not same - there are
8459 equivalences that are found only by GCC and equivalences found only by Gold.
8461 This flag is enabled by default at @option{-O2} and @option{-Os}.
8463 @item -fisolate-erroneous-paths-dereference
8464 @opindex fisolate-erroneous-paths-dereference
8465 Detect paths that trigger erroneous or undefined behavior due to
8466 dereferencing a null pointer.  Isolate those paths from the main control
8467 flow and turn the statement with erroneous or undefined behavior into a trap.
8468 This flag is enabled by default at @option{-O2} and higher and depends on
8469 @option{-fdelete-null-pointer-checks} also being enabled.
8471 @item -fisolate-erroneous-paths-attribute
8472 @opindex fisolate-erroneous-paths-attribute
8473 Detect paths that trigger erroneous or undefined behavior due a null value
8474 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8475 attribute.  Isolate those paths from the main control flow and turn the
8476 statement with erroneous or undefined behavior into a trap.  This is not
8477 currently enabled, but may be enabled by @option{-O2} in the future.
8479 @item -ftree-sink
8480 @opindex ftree-sink
8481 Perform forward store motion on trees.  This flag is
8482 enabled by default at @option{-O} and higher.
8484 @item -ftree-bit-ccp
8485 @opindex ftree-bit-ccp
8486 Perform sparse conditional bit constant propagation on trees and propagate
8487 pointer alignment information.
8488 This pass only operates on local scalar variables and is enabled by default
8489 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8491 @item -ftree-ccp
8492 @opindex ftree-ccp
8493 Perform sparse conditional constant propagation (CCP) on trees.  This
8494 pass only operates on local scalar variables and is enabled by default
8495 at @option{-O} and higher.
8497 @item -fssa-backprop
8498 @opindex fssa-backprop
8499 Propagate information about uses of a value up the definition chain
8500 in order to simplify the definitions.  For example, this pass strips
8501 sign operations if the sign of a value never matters.  The flag is
8502 enabled by default at @option{-O} and higher.
8504 @item -fssa-phiopt
8505 @opindex fssa-phiopt
8506 Perform pattern matching on SSA PHI nodes to optimize conditional
8507 code.  This pass is enabled by default at @option{-O} and higher.
8509 @item -ftree-switch-conversion
8510 @opindex ftree-switch-conversion
8511 Perform conversion of simple initializations in a switch to
8512 initializations from a scalar array.  This flag is enabled by default
8513 at @option{-O2} and higher.
8515 @item -ftree-tail-merge
8516 @opindex ftree-tail-merge
8517 Look for identical code sequences.  When found, replace one with a jump to the
8518 other.  This optimization is known as tail merging or cross jumping.  This flag
8519 is enabled by default at @option{-O2} and higher.  The compilation time
8520 in this pass can
8521 be limited using @option{max-tail-merge-comparisons} parameter and
8522 @option{max-tail-merge-iterations} parameter.
8524 @item -ftree-dce
8525 @opindex ftree-dce
8526 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8527 default at @option{-O} and higher.
8529 @item -ftree-builtin-call-dce
8530 @opindex ftree-builtin-call-dce
8531 Perform conditional dead code elimination (DCE) for calls to built-in functions
8532 that may set @code{errno} but are otherwise side-effect free.  This flag is
8533 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8534 specified.
8536 @item -ftree-dominator-opts
8537 @opindex ftree-dominator-opts
8538 Perform a variety of simple scalar cleanups (constant/copy
8539 propagation, redundancy elimination, range propagation and expression
8540 simplification) based on a dominator tree traversal.  This also
8541 performs jump threading (to reduce jumps to jumps). This flag is
8542 enabled by default at @option{-O} and higher.
8544 @item -ftree-dse
8545 @opindex ftree-dse
8546 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8547 a memory location that is later overwritten by another store without
8548 any intervening loads.  In this case the earlier store can be deleted.  This
8549 flag is enabled by default at @option{-O} and higher.
8551 @item -ftree-ch
8552 @opindex ftree-ch
8553 Perform loop header copying on trees.  This is beneficial since it increases
8554 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8555 is enabled by default at @option{-O} and higher.  It is not enabled
8556 for @option{-Os}, since it usually increases code size.
8558 @item -ftree-loop-optimize
8559 @opindex ftree-loop-optimize
8560 Perform loop optimizations on trees.  This flag is enabled by default
8561 at @option{-O} and higher.
8563 @item -ftree-loop-linear
8564 @itemx -floop-strip-mine
8565 @itemx -floop-block
8566 @opindex ftree-loop-linear
8567 @opindex floop-strip-mine
8568 @opindex floop-block
8569 Perform loop nest optimizations.  Same as
8570 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8571 to be configured with @option{--with-isl} to enable the Graphite loop
8572 transformation infrastructure.
8574 @item -fgraphite-identity
8575 @opindex fgraphite-identity
8576 Enable the identity transformation for graphite.  For every SCoP we generate
8577 the polyhedral representation and transform it back to gimple.  Using
8578 @option{-fgraphite-identity} we can check the costs or benefits of the
8579 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8580 are also performed by the code generator isl, like index splitting and
8581 dead code elimination in loops.
8583 @item -floop-nest-optimize
8584 @opindex floop-nest-optimize
8585 Enable the isl based loop nest optimizer.  This is a generic loop nest
8586 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8587 structure optimized for data-locality and parallelism.  This option
8588 is experimental.
8590 @item -floop-parallelize-all
8591 @opindex floop-parallelize-all
8592 Use the Graphite data dependence analysis to identify loops that can
8593 be parallelized.  Parallelize all the loops that can be analyzed to
8594 not contain loop carried dependences without checking that it is
8595 profitable to parallelize the loops.
8597 @item -ftree-coalesce-vars
8598 @opindex ftree-coalesce-vars
8599 While transforming the program out of the SSA representation, attempt to
8600 reduce copying by coalescing versions of different user-defined
8601 variables, instead of just compiler temporaries.  This may severely
8602 limit the ability to debug an optimized program compiled with
8603 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8604 prevents SSA coalescing of user variables.  This option is enabled by
8605 default if optimization is enabled, and it does very little otherwise.
8607 @item -ftree-loop-if-convert
8608 @opindex ftree-loop-if-convert
8609 Attempt to transform conditional jumps in the innermost loops to
8610 branch-less equivalents.  The intent is to remove control-flow from
8611 the innermost loops in order to improve the ability of the
8612 vectorization pass to handle these loops.  This is enabled by default
8613 if vectorization is enabled.
8615 @item -ftree-loop-distribution
8616 @opindex ftree-loop-distribution
8617 Perform loop distribution.  This flag can improve cache performance on
8618 big loop bodies and allow further loop optimizations, like
8619 parallelization or vectorization, to take place.  For example, the loop
8620 @smallexample
8621 DO I = 1, N
8622   A(I) = B(I) + C
8623   D(I) = E(I) * F
8624 ENDDO
8625 @end smallexample
8626 is transformed to
8627 @smallexample
8628 DO I = 1, N
8629    A(I) = B(I) + C
8630 ENDDO
8631 DO I = 1, N
8632    D(I) = E(I) * F
8633 ENDDO
8634 @end smallexample
8636 @item -ftree-loop-distribute-patterns
8637 @opindex ftree-loop-distribute-patterns
8638 Perform loop distribution of patterns that can be code generated with
8639 calls to a library.  This flag is enabled by default at @option{-O3}.
8641 This pass distributes the initialization loops and generates a call to
8642 memset zero.  For example, the loop
8643 @smallexample
8644 DO I = 1, N
8645   A(I) = 0
8646   B(I) = A(I) + I
8647 ENDDO
8648 @end smallexample
8649 is transformed to
8650 @smallexample
8651 DO I = 1, N
8652    A(I) = 0
8653 ENDDO
8654 DO I = 1, N
8655    B(I) = A(I) + I
8656 ENDDO
8657 @end smallexample
8658 and the initialization loop is transformed into a call to memset zero.
8660 @item -floop-interchange
8661 @opindex floop-interchange
8662 Perform loop interchange outside of graphite.  This flag can improve cache
8663 performance on loop nest and allow further loop optimizations, like
8664 vectorization, to take place.  For example, the loop
8665 @smallexample
8666 for (int i = 0; i < N; i++)
8667   for (int j = 0; j < N; j++)
8668     for (int k = 0; k < N; k++)
8669       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8670 @end smallexample
8671 is transformed to
8672 @smallexample
8673 for (int i = 0; i < N; i++)
8674   for (int k = 0; k < N; k++)
8675     for (int j = 0; j < N; j++)
8676       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8677 @end smallexample
8679 @item -ftree-loop-im
8680 @opindex ftree-loop-im
8681 Perform loop invariant motion on trees.  This pass moves only invariants that
8682 are hard to handle at RTL level (function calls, operations that expand to
8683 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8684 operands of conditions that are invariant out of the loop, so that we can use
8685 just trivial invariantness analysis in loop unswitching.  The pass also includes
8686 store motion.
8688 @item -ftree-loop-ivcanon
8689 @opindex ftree-loop-ivcanon
8690 Create a canonical counter for number of iterations in loops for which
8691 determining number of iterations requires complicated analysis.  Later
8692 optimizations then may determine the number easily.  Useful especially
8693 in connection with unrolling.
8695 @item -fivopts
8696 @opindex fivopts
8697 Perform induction variable optimizations (strength reduction, induction
8698 variable merging and induction variable elimination) on trees.
8700 @item -ftree-parallelize-loops=n
8701 @opindex ftree-parallelize-loops
8702 Parallelize loops, i.e., split their iteration space to run in n threads.
8703 This is only possible for loops whose iterations are independent
8704 and can be arbitrarily reordered.  The optimization is only
8705 profitable on multiprocessor machines, for loops that are CPU-intensive,
8706 rather than constrained e.g.@: by memory bandwidth.  This option
8707 implies @option{-pthread}, and thus is only supported on targets
8708 that have support for @option{-pthread}.
8710 @item -ftree-pta
8711 @opindex ftree-pta
8712 Perform function-local points-to analysis on trees.  This flag is
8713 enabled by default at @option{-O} and higher.
8715 @item -ftree-sra
8716 @opindex ftree-sra
8717 Perform scalar replacement of aggregates.  This pass replaces structure
8718 references with scalars to prevent committing structures to memory too
8719 early.  This flag is enabled by default at @option{-O} and higher.
8721 @item -fstore-merging
8722 @opindex fstore-merging
8723 Perform merging of narrow stores to consecutive memory addresses.  This pass
8724 merges contiguous stores of immediate values narrower than a word into fewer
8725 wider stores to reduce the number of instructions.  This is enabled by default
8726 at @option{-O2} and higher as well as @option{-Os}.
8728 @item -ftree-ter
8729 @opindex ftree-ter
8730 Perform temporary expression replacement during the SSA->normal phase.  Single
8731 use/single def temporaries are replaced at their use location with their
8732 defining expression.  This results in non-GIMPLE code, but gives the expanders
8733 much more complex trees to work on resulting in better RTL generation.  This is
8734 enabled by default at @option{-O} and higher.
8736 @item -ftree-slsr
8737 @opindex ftree-slsr
8738 Perform straight-line strength reduction on trees.  This recognizes related
8739 expressions involving multiplications and replaces them by less expensive
8740 calculations when possible.  This is enabled by default at @option{-O} and
8741 higher.
8743 @item -ftree-vectorize
8744 @opindex ftree-vectorize
8745 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8746 and @option{-ftree-slp-vectorize} if not explicitly specified.
8748 @item -ftree-loop-vectorize
8749 @opindex ftree-loop-vectorize
8750 Perform loop vectorization on trees. This flag is enabled by default at
8751 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8753 @item -ftree-slp-vectorize
8754 @opindex ftree-slp-vectorize
8755 Perform basic block vectorization on trees. This flag is enabled by default at
8756 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8758 @item -fvect-cost-model=@var{model}
8759 @opindex fvect-cost-model
8760 Alter the cost model used for vectorization.  The @var{model} argument
8761 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8762 With the @samp{unlimited} model the vectorized code-path is assumed
8763 to be profitable while with the @samp{dynamic} model a runtime check
8764 guards the vectorized code-path to enable it only for iteration
8765 counts that will likely execute faster than when executing the original
8766 scalar loop.  The @samp{cheap} model disables vectorization of
8767 loops where doing so would be cost prohibitive for example due to
8768 required runtime checks for data dependence or alignment but otherwise
8769 is equal to the @samp{dynamic} model.
8770 The default cost model depends on other optimization flags and is
8771 either @samp{dynamic} or @samp{cheap}.
8773 @item -fsimd-cost-model=@var{model}
8774 @opindex fsimd-cost-model
8775 Alter the cost model used for vectorization of loops marked with the OpenMP
8776 or Cilk Plus simd directive.  The @var{model} argument should be one of
8777 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8778 have the same meaning as described in @option{-fvect-cost-model} and by
8779 default a cost model defined with @option{-fvect-cost-model} is used.
8781 @item -ftree-vrp
8782 @opindex ftree-vrp
8783 Perform Value Range Propagation on trees.  This is similar to the
8784 constant propagation pass, but instead of values, ranges of values are
8785 propagated.  This allows the optimizers to remove unnecessary range
8786 checks like array bound checks and null pointer checks.  This is
8787 enabled by default at @option{-O2} and higher.  Null pointer check
8788 elimination is only done if @option{-fdelete-null-pointer-checks} is
8789 enabled.
8791 @item -fsplit-paths
8792 @opindex fsplit-paths
8793 Split paths leading to loop backedges.  This can improve dead code
8794 elimination and common subexpression elimination.  This is enabled by
8795 default at @option{-O2} and above.
8797 @item -fsplit-ivs-in-unroller
8798 @opindex fsplit-ivs-in-unroller
8799 Enables expression of values of induction variables in later iterations
8800 of the unrolled loop using the value in the first iteration.  This breaks
8801 long dependency chains, thus improving efficiency of the scheduling passes.
8803 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8804 same effect.  However, that is not reliable in cases where the loop body
8805 is more complicated than a single basic block.  It also does not work at all
8806 on some architectures due to restrictions in the CSE pass.
8808 This optimization is enabled by default.
8810 @item -fvariable-expansion-in-unroller
8811 @opindex fvariable-expansion-in-unroller
8812 With this option, the compiler creates multiple copies of some
8813 local variables when unrolling a loop, which can result in superior code.
8815 @item -fpartial-inlining
8816 @opindex fpartial-inlining
8817 Inline parts of functions.  This option has any effect only
8818 when inlining itself is turned on by the @option{-finline-functions}
8819 or @option{-finline-small-functions} options.
8821 Enabled at level @option{-O2}.
8823 @item -fpredictive-commoning
8824 @opindex fpredictive-commoning
8825 Perform predictive commoning optimization, i.e., reusing computations
8826 (especially memory loads and stores) performed in previous
8827 iterations of loops.
8829 This option is enabled at level @option{-O3}.
8831 @item -fprefetch-loop-arrays
8832 @opindex fprefetch-loop-arrays
8833 If supported by the target machine, generate instructions to prefetch
8834 memory to improve the performance of loops that access large arrays.
8836 This option may generate better or worse code; results are highly
8837 dependent on the structure of loops within the source code.
8839 Disabled at level @option{-Os}.
8841 @item -fno-printf-return-value
8842 @opindex fno-printf-return-value
8843 Do not substitute constants for known return value of formatted output
8844 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8845 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8846 transformation allows GCC to optimize or even eliminate branches based
8847 on the known return value of these functions called with arguments that
8848 are either constant, or whose values are known to be in a range that
8849 makes determining the exact return value possible.  For example, when
8850 @option{-fprintf-return-value} is in effect, both the branch and the
8851 body of the @code{if} statement (but not the call to @code{snprint})
8852 can be optimized away when @code{i} is a 32-bit or smaller integer
8853 because the return value is guaranteed to be at most 8.
8855 @smallexample
8856 char buf[9];
8857 if (snprintf (buf, "%08x", i) >= sizeof buf)
8858   @dots{}
8859 @end smallexample
8861 The @option{-fprintf-return-value} option relies on other optimizations
8862 and yields best results with @option{-O2}.  It works in tandem with the
8863 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8864 The @option{-fprintf-return-value} option is enabled by default.
8866 @item -fno-peephole
8867 @itemx -fno-peephole2
8868 @opindex fno-peephole
8869 @opindex fno-peephole2
8870 Disable any machine-specific peephole optimizations.  The difference
8871 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8872 are implemented in the compiler; some targets use one, some use the
8873 other, a few use both.
8875 @option{-fpeephole} is enabled by default.
8876 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8878 @item -fno-guess-branch-probability
8879 @opindex fno-guess-branch-probability
8880 Do not guess branch probabilities using heuristics.
8882 GCC uses heuristics to guess branch probabilities if they are
8883 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8884 heuristics are based on the control flow graph.  If some branch probabilities
8885 are specified by @code{__builtin_expect}, then the heuristics are
8886 used to guess branch probabilities for the rest of the control flow graph,
8887 taking the @code{__builtin_expect} info into account.  The interactions
8888 between the heuristics and @code{__builtin_expect} can be complex, and in
8889 some cases, it may be useful to disable the heuristics so that the effects
8890 of @code{__builtin_expect} are easier to understand.
8892 The default is @option{-fguess-branch-probability} at levels
8893 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8895 @item -freorder-blocks
8896 @opindex freorder-blocks
8897 Reorder basic blocks in the compiled function in order to reduce number of
8898 taken branches and improve code locality.
8900 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8902 @item -freorder-blocks-algorithm=@var{algorithm}
8903 @opindex freorder-blocks-algorithm
8904 Use the specified algorithm for basic block reordering.  The
8905 @var{algorithm} argument can be @samp{simple}, which does not increase
8906 code size (except sometimes due to secondary effects like alignment),
8907 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8908 put all often executed code together, minimizing the number of branches
8909 executed by making extra copies of code.
8911 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8912 @samp{stc} at levels @option{-O2}, @option{-O3}.
8914 @item -freorder-blocks-and-partition
8915 @opindex freorder-blocks-and-partition
8916 In addition to reordering basic blocks in the compiled function, in order
8917 to reduce number of taken branches, partitions hot and cold basic blocks
8918 into separate sections of the assembly and @file{.o} files, to improve
8919 paging and cache locality performance.
8921 This optimization is automatically turned off in the presence of
8922 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8923 section attribute and on any architecture that does not support named
8924 sections.  When @option{-fsplit-stack} is used this option is not
8925 enabled by default (to avoid linker errors), but may be enabled
8926 explicitly (if using a working linker).
8928 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8930 @item -freorder-functions
8931 @opindex freorder-functions
8932 Reorder functions in the object file in order to
8933 improve code locality.  This is implemented by using special
8934 subsections @code{.text.hot} for most frequently executed functions and
8935 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8936 the linker so object file format must support named sections and linker must
8937 place them in a reasonable way.
8939 Also profile feedback must be available to make this option effective.  See
8940 @option{-fprofile-arcs} for details.
8942 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8944 @item -fstrict-aliasing
8945 @opindex fstrict-aliasing
8946 Allow the compiler to assume the strictest aliasing rules applicable to
8947 the language being compiled.  For C (and C++), this activates
8948 optimizations based on the type of expressions.  In particular, an
8949 object of one type is assumed never to reside at the same address as an
8950 object of a different type, unless the types are almost the same.  For
8951 example, an @code{unsigned int} can alias an @code{int}, but not a
8952 @code{void*} or a @code{double}.  A character type may alias any other
8953 type.
8955 @anchor{Type-punning}Pay special attention to code like this:
8956 @smallexample
8957 union a_union @{
8958   int i;
8959   double d;
8962 int f() @{
8963   union a_union t;
8964   t.d = 3.0;
8965   return t.i;
8967 @end smallexample
8968 The practice of reading from a different union member than the one most
8969 recently written to (called ``type-punning'') is common.  Even with
8970 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8971 is accessed through the union type.  So, the code above works as
8972 expected.  @xref{Structures unions enumerations and bit-fields
8973 implementation}.  However, this code might not:
8974 @smallexample
8975 int f() @{
8976   union a_union t;
8977   int* ip;
8978   t.d = 3.0;
8979   ip = &t.i;
8980   return *ip;
8982 @end smallexample
8984 Similarly, access by taking the address, casting the resulting pointer
8985 and dereferencing the result has undefined behavior, even if the cast
8986 uses a union type, e.g.:
8987 @smallexample
8988 int f() @{
8989   double d = 3.0;
8990   return ((union a_union *) &d)->i;
8992 @end smallexample
8994 The @option{-fstrict-aliasing} option is enabled at levels
8995 @option{-O2}, @option{-O3}, @option{-Os}.
8997 @item -falign-functions
8998 @itemx -falign-functions=@var{n}
8999 @opindex falign-functions
9000 Align the start of functions to the next power-of-two greater than
9001 @var{n}, skipping up to @var{n} bytes.  For instance,
9002 @option{-falign-functions=32} aligns functions to the next 32-byte
9003 boundary, but @option{-falign-functions=24} aligns to the next
9004 32-byte boundary only if this can be done by skipping 23 bytes or less.
9006 @option{-fno-align-functions} and @option{-falign-functions=1} are
9007 equivalent and mean that functions are not aligned.
9009 Some assemblers only support this flag when @var{n} is a power of two;
9010 in that case, it is rounded up.
9012 If @var{n} is not specified or is zero, use a machine-dependent default.
9014 Enabled at levels @option{-O2}, @option{-O3}.
9016 @item -flimit-function-alignment
9017 If this option is enabled, the compiler tries to avoid unnecessarily
9018 overaligning functions. It attempts to instruct the assembler to align
9019 by the amount specified by @option{-falign-functions}, but not to
9020 skip more bytes than the size of the function.
9022 @item -falign-labels
9023 @itemx -falign-labels=@var{n}
9024 @opindex falign-labels
9025 Align all branch targets to a power-of-two boundary, skipping up to
9026 @var{n} bytes like @option{-falign-functions}.  This option can easily
9027 make code slower, because it must insert dummy operations for when the
9028 branch target is reached in the usual flow of the code.
9030 @option{-fno-align-labels} and @option{-falign-labels=1} are
9031 equivalent and mean that labels are not aligned.
9033 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9034 are greater than this value, then their values are used instead.
9036 If @var{n} is not specified or is zero, use a machine-dependent default
9037 which is very likely to be @samp{1}, meaning no alignment.
9039 Enabled at levels @option{-O2}, @option{-O3}.
9041 @item -falign-loops
9042 @itemx -falign-loops=@var{n}
9043 @opindex falign-loops
9044 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9045 like @option{-falign-functions}.  If the loops are
9046 executed many times, this makes up for any execution of the dummy
9047 operations.
9049 @option{-fno-align-loops} and @option{-falign-loops=1} are
9050 equivalent and mean that loops are not aligned.
9052 If @var{n} is not specified or is zero, use a machine-dependent default.
9054 Enabled at levels @option{-O2}, @option{-O3}.
9056 @item -falign-jumps
9057 @itemx -falign-jumps=@var{n}
9058 @opindex falign-jumps
9059 Align branch targets to a power-of-two boundary, for branch targets
9060 where the targets can only be reached by jumping, skipping up to @var{n}
9061 bytes like @option{-falign-functions}.  In this case, no dummy operations
9062 need be executed.
9064 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9065 equivalent and mean that loops are not aligned.
9067 If @var{n} is not specified or is zero, use a machine-dependent default.
9069 Enabled at levels @option{-O2}, @option{-O3}.
9071 @item -funit-at-a-time
9072 @opindex funit-at-a-time
9073 This option is left for compatibility reasons. @option{-funit-at-a-time}
9074 has no effect, while @option{-fno-unit-at-a-time} implies
9075 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9077 Enabled by default.
9079 @item -fno-toplevel-reorder
9080 @opindex fno-toplevel-reorder
9081 Do not reorder top-level functions, variables, and @code{asm}
9082 statements.  Output them in the same order that they appear in the
9083 input file.  When this option is used, unreferenced static variables
9084 are not removed.  This option is intended to support existing code
9085 that relies on a particular ordering.  For new code, it is better to
9086 use attributes when possible.
9088 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9089 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9090 targets.
9092 @item -fweb
9093 @opindex fweb
9094 Constructs webs as commonly used for register allocation purposes and assign
9095 each web individual pseudo register.  This allows the register allocation pass
9096 to operate on pseudos directly, but also strengthens several other optimization
9097 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9098 however, make debugging impossible, since variables no longer stay in a
9099 ``home register''.
9101 Enabled by default with @option{-funroll-loops}.
9103 @item -fwhole-program
9104 @opindex fwhole-program
9105 Assume that the current compilation unit represents the whole program being
9106 compiled.  All public functions and variables with the exception of @code{main}
9107 and those merged by attribute @code{externally_visible} become static functions
9108 and in effect are optimized more aggressively by interprocedural optimizers.
9110 This option should not be used in combination with @option{-flto}.
9111 Instead relying on a linker plugin should provide safer and more precise
9112 information.
9114 @item -flto[=@var{n}]
9115 @opindex flto
9116 This option runs the standard link-time optimizer.  When invoked
9117 with source code, it generates GIMPLE (one of GCC's internal
9118 representations) and writes it to special ELF sections in the object
9119 file.  When the object files are linked together, all the function
9120 bodies are read from these ELF sections and instantiated as if they
9121 had been part of the same translation unit.
9123 To use the link-time optimizer, @option{-flto} and optimization
9124 options should be specified at compile time and during the final link.
9125 It is recommended that you compile all the files participating in the
9126 same link with the same options and also specify those options at
9127 link time.  
9128 For example:
9130 @smallexample
9131 gcc -c -O2 -flto foo.c
9132 gcc -c -O2 -flto bar.c
9133 gcc -o myprog -flto -O2 foo.o bar.o
9134 @end smallexample
9136 The first two invocations to GCC save a bytecode representation
9137 of GIMPLE into special ELF sections inside @file{foo.o} and
9138 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9139 @file{foo.o} and @file{bar.o}, merges the two files into a single
9140 internal image, and compiles the result as usual.  Since both
9141 @file{foo.o} and @file{bar.o} are merged into a single image, this
9142 causes all the interprocedural analyses and optimizations in GCC to
9143 work across the two files as if they were a single one.  This means,
9144 for example, that the inliner is able to inline functions in
9145 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9147 Another (simpler) way to enable link-time optimization is:
9149 @smallexample
9150 gcc -o myprog -flto -O2 foo.c bar.c
9151 @end smallexample
9153 The above generates bytecode for @file{foo.c} and @file{bar.c},
9154 merges them together into a single GIMPLE representation and optimizes
9155 them as usual to produce @file{myprog}.
9157 The only important thing to keep in mind is that to enable link-time
9158 optimizations you need to use the GCC driver to perform the link step.
9159 GCC then automatically performs link-time optimization if any of the
9160 objects involved were compiled with the @option{-flto} command-line option.  
9161 You generally
9162 should specify the optimization options to be used for link-time
9163 optimization though GCC tries to be clever at guessing an
9164 optimization level to use from the options used at compile time
9165 if you fail to specify one at link time.  You can always override
9166 the automatic decision to do link-time optimization
9167 by passing @option{-fno-lto} to the link command.
9169 To make whole program optimization effective, it is necessary to make
9170 certain whole program assumptions.  The compiler needs to know
9171 what functions and variables can be accessed by libraries and runtime
9172 outside of the link-time optimized unit.  When supported by the linker,
9173 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9174 to the compiler about used and externally visible symbols.  When
9175 the linker plugin is not available, @option{-fwhole-program} should be
9176 used to allow the compiler to make these assumptions, which leads
9177 to more aggressive optimization decisions.
9179 When @option{-fuse-linker-plugin} is not enabled, when a file is
9180 compiled with @option{-flto}, the generated object file is larger than
9181 a regular object file because it contains GIMPLE bytecodes and the usual
9182 final code (see @option{-ffat-lto-objects}.  This means that
9183 object files with LTO information can be linked as normal object
9184 files; if @option{-fno-lto} is passed to the linker, no
9185 interprocedural optimizations are applied.  Note that when
9186 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9187 but you cannot perform a regular, non-LTO link on them.
9189 Additionally, the optimization flags used to compile individual files
9190 are not necessarily related to those used at link time.  For instance,
9192 @smallexample
9193 gcc -c -O0 -ffat-lto-objects -flto foo.c
9194 gcc -c -O0 -ffat-lto-objects -flto bar.c
9195 gcc -o myprog -O3 foo.o bar.o
9196 @end smallexample
9198 This produces individual object files with unoptimized assembler
9199 code, but the resulting binary @file{myprog} is optimized at
9200 @option{-O3}.  If, instead, the final binary is generated with
9201 @option{-fno-lto}, then @file{myprog} is not optimized.
9203 When producing the final binary, GCC only
9204 applies link-time optimizations to those files that contain bytecode.
9205 Therefore, you can mix and match object files and libraries with
9206 GIMPLE bytecodes and final object code.  GCC automatically selects
9207 which files to optimize in LTO mode and which files to link without
9208 further processing.
9210 There are some code generation flags preserved by GCC when
9211 generating bytecodes, as they need to be used during the final link
9212 stage.  Generally options specified at link time override those
9213 specified at compile time.
9215 If you do not specify an optimization level option @option{-O} at
9216 link time, then GCC uses the highest optimization level 
9217 used when compiling the object files.
9219 Currently, the following options and their settings are taken from
9220 the first object file that explicitly specifies them: 
9221 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9222 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9223 and all the @option{-m} target flags.
9225 Certain ABI-changing flags are required to match in all compilation units,
9226 and trying to override this at link time with a conflicting value
9227 is ignored.  This includes options such as @option{-freg-struct-return}
9228 and @option{-fpcc-struct-return}. 
9230 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9231 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9232 are passed through to the link stage and merged conservatively for
9233 conflicting translation units.  Specifically
9234 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9235 precedence; and for example @option{-ffp-contract=off} takes precedence
9236 over @option{-ffp-contract=fast}.  You can override them at link time.
9238 If LTO encounters objects with C linkage declared with incompatible
9239 types in separate translation units to be linked together (undefined
9240 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9241 issued.  The behavior is still undefined at run time.  Similar
9242 diagnostics may be raised for other languages.
9244 Another feature of LTO is that it is possible to apply interprocedural
9245 optimizations on files written in different languages:
9247 @smallexample
9248 gcc -c -flto foo.c
9249 g++ -c -flto bar.cc
9250 gfortran -c -flto baz.f90
9251 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9252 @end smallexample
9254 Notice that the final link is done with @command{g++} to get the C++
9255 runtime libraries and @option{-lgfortran} is added to get the Fortran
9256 runtime libraries.  In general, when mixing languages in LTO mode, you
9257 should use the same link command options as when mixing languages in a
9258 regular (non-LTO) compilation.
9260 If object files containing GIMPLE bytecode are stored in a library archive, say
9261 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9262 are using a linker with plugin support.  To create static libraries suitable
9263 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9264 and @command{ranlib}; 
9265 to show the symbols of object files with GIMPLE bytecode, use
9266 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9267 and @command{nm} have been compiled with plugin support.  At link time, use the the
9268 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9269 the LTO optimization process:
9271 @smallexample
9272 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9273 @end smallexample
9275 With the linker plugin enabled, the linker extracts the needed
9276 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9277 to make them part of the aggregated GIMPLE image to be optimized.
9279 If you are not using a linker with plugin support and/or do not
9280 enable the linker plugin, then the objects inside @file{libfoo.a}
9281 are extracted and linked as usual, but they do not participate
9282 in the LTO optimization process.  In order to make a static library suitable
9283 for both LTO optimization and usual linkage, compile its object files with
9284 @option{-flto} @option{-ffat-lto-objects}.
9286 Link-time optimizations do not require the presence of the whole program to
9287 operate.  If the program does not require any symbols to be exported, it is
9288 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9289 the interprocedural optimizers to use more aggressive assumptions which may
9290 lead to improved optimization opportunities.
9291 Use of @option{-fwhole-program} is not needed when linker plugin is
9292 active (see @option{-fuse-linker-plugin}).
9294 The current implementation of LTO makes no
9295 attempt to generate bytecode that is portable between different
9296 types of hosts.  The bytecode files are versioned and there is a
9297 strict version check, so bytecode files generated in one version of
9298 GCC do not work with an older or newer version of GCC.
9300 Link-time optimization does not work well with generation of debugging
9301 information.  Combining @option{-flto} with
9302 @option{-g} is currently experimental and expected to produce unexpected
9303 results.
9305 If you specify the optional @var{n}, the optimization and code
9306 generation done at link time is executed in parallel using @var{n}
9307 parallel jobs by utilizing an installed @command{make} program.  The
9308 environment variable @env{MAKE} may be used to override the program
9309 used.  The default value for @var{n} is 1.
9311 You can also specify @option{-flto=jobserver} to use GNU make's
9312 job server mode to determine the number of parallel jobs. This
9313 is useful when the Makefile calling GCC is already executing in parallel.
9314 You must prepend a @samp{+} to the command recipe in the parent Makefile
9315 for this to work.  This option likely only works if @env{MAKE} is
9316 GNU make.
9318 @item -flto-partition=@var{alg}
9319 @opindex flto-partition
9320 Specify the partitioning algorithm used by the link-time optimizer.
9321 The value is either @samp{1to1} to specify a partitioning mirroring
9322 the original source files or @samp{balanced} to specify partitioning
9323 into equally sized chunks (whenever possible) or @samp{max} to create
9324 new partition for every symbol where possible.  Specifying @samp{none}
9325 as an algorithm disables partitioning and streaming completely. 
9326 The default value is @samp{balanced}. While @samp{1to1} can be used
9327 as an workaround for various code ordering issues, the @samp{max}
9328 partitioning is intended for internal testing only.
9329 The value @samp{one} specifies that exactly one partition should be
9330 used while the value @samp{none} bypasses partitioning and executes
9331 the link-time optimization step directly from the WPA phase.
9333 @item -flto-odr-type-merging
9334 @opindex flto-odr-type-merging
9335 Enable streaming of mangled types names of C++ types and their unification
9336 at link time.  This increases size of LTO object files, but enables
9337 diagnostics about One Definition Rule violations.
9339 @item -flto-compression-level=@var{n}
9340 @opindex flto-compression-level
9341 This option specifies the level of compression used for intermediate
9342 language written to LTO object files, and is only meaningful in
9343 conjunction with LTO mode (@option{-flto}).  Valid
9344 values are 0 (no compression) to 9 (maximum compression).  Values
9345 outside this range are clamped to either 0 or 9.  If the option is not
9346 given, a default balanced compression setting is used.
9348 @item -fuse-linker-plugin
9349 @opindex fuse-linker-plugin
9350 Enables the use of a linker plugin during link-time optimization.  This
9351 option relies on plugin support in the linker, which is available in gold
9352 or in GNU ld 2.21 or newer.
9354 This option enables the extraction of object files with GIMPLE bytecode out
9355 of library archives. This improves the quality of optimization by exposing
9356 more code to the link-time optimizer.  This information specifies what
9357 symbols can be accessed externally (by non-LTO object or during dynamic
9358 linking).  Resulting code quality improvements on binaries (and shared
9359 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9360 See @option{-flto} for a description of the effect of this flag and how to
9361 use it.
9363 This option is enabled by default when LTO support in GCC is enabled
9364 and GCC was configured for use with
9365 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9367 @item -ffat-lto-objects
9368 @opindex ffat-lto-objects
9369 Fat LTO objects are object files that contain both the intermediate language
9370 and the object code. This makes them usable for both LTO linking and normal
9371 linking. This option is effective only when compiling with @option{-flto}
9372 and is ignored at link time.
9374 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9375 requires the complete toolchain to be aware of LTO. It requires a linker with
9376 linker plugin support for basic functionality.  Additionally,
9377 @command{nm}, @command{ar} and @command{ranlib}
9378 need to support linker plugins to allow a full-featured build environment
9379 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9380 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9381 to these tools. With non fat LTO makefiles need to be modified to use them.
9383 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9384 support.
9386 @item -fcompare-elim
9387 @opindex fcompare-elim
9388 After register allocation and post-register allocation instruction splitting,
9389 identify arithmetic instructions that compute processor flags similar to a
9390 comparison operation based on that arithmetic.  If possible, eliminate the
9391 explicit comparison operation.
9393 This pass only applies to certain targets that cannot explicitly represent
9394 the comparison operation before register allocation is complete.
9396 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9398 @item -fcprop-registers
9399 @opindex fcprop-registers
9400 After register allocation and post-register allocation instruction splitting,
9401 perform a copy-propagation pass to try to reduce scheduling dependencies
9402 and occasionally eliminate the copy.
9404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9406 @item -fprofile-correction
9407 @opindex fprofile-correction
9408 Profiles collected using an instrumented binary for multi-threaded programs may
9409 be inconsistent due to missed counter updates. When this option is specified,
9410 GCC uses heuristics to correct or smooth out such inconsistencies. By
9411 default, GCC emits an error message when an inconsistent profile is detected.
9413 @item -fprofile-use
9414 @itemx -fprofile-use=@var{path}
9415 @opindex fprofile-use
9416 Enable profile feedback-directed optimizations, 
9417 and the following optimizations
9418 which are generally profitable only with profile feedback available:
9419 @option{-fbranch-probabilities}, @option{-fvpt},
9420 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9421 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9423 Before you can use this option, you must first generate profiling information.
9424 @xref{Instrumentation Options}, for information about the
9425 @option{-fprofile-generate} option.
9427 By default, GCC emits an error message if the feedback profiles do not
9428 match the source code.  This error can be turned into a warning by using
9429 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9430 code.
9432 If @var{path} is specified, GCC looks at the @var{path} to find
9433 the profile feedback data files. See @option{-fprofile-dir}.
9435 @item -fauto-profile
9436 @itemx -fauto-profile=@var{path}
9437 @opindex fauto-profile
9438 Enable sampling-based feedback-directed optimizations, 
9439 and the following optimizations
9440 which are generally profitable only with profile feedback available:
9441 @option{-fbranch-probabilities}, @option{-fvpt},
9442 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9443 @option{-ftree-vectorize},
9444 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9445 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9446 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9448 @var{path} is the name of a file containing AutoFDO profile information.
9449 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9451 Producing an AutoFDO profile data file requires running your program
9452 with the @command{perf} utility on a supported GNU/Linux target system.
9453 For more information, see @uref{https://perf.wiki.kernel.org/}.
9455 E.g.
9456 @smallexample
9457 perf record -e br_inst_retired:near_taken -b -o perf.data \
9458     -- your_program
9459 @end smallexample
9461 Then use the @command{create_gcov} tool to convert the raw profile data
9462 to a format that can be used by GCC.@  You must also supply the 
9463 unstripped binary for your program to this tool.  
9464 See @uref{https://github.com/google/autofdo}.
9466 E.g.
9467 @smallexample
9468 create_gcov --binary=your_program.unstripped --profile=perf.data \
9469     --gcov=profile.afdo
9470 @end smallexample
9471 @end table
9473 The following options control compiler behavior regarding floating-point 
9474 arithmetic.  These options trade off between speed and
9475 correctness.  All must be specifically enabled.
9477 @table @gcctabopt
9478 @item -ffloat-store
9479 @opindex ffloat-store
9480 Do not store floating-point variables in registers, and inhibit other
9481 options that might change whether a floating-point value is taken from a
9482 register or memory.
9484 @cindex floating-point precision
9485 This option prevents undesirable excess precision on machines such as
9486 the 68000 where the floating registers (of the 68881) keep more
9487 precision than a @code{double} is supposed to have.  Similarly for the
9488 x86 architecture.  For most programs, the excess precision does only
9489 good, but a few programs rely on the precise definition of IEEE floating
9490 point.  Use @option{-ffloat-store} for such programs, after modifying
9491 them to store all pertinent intermediate computations into variables.
9493 @item -fexcess-precision=@var{style}
9494 @opindex fexcess-precision
9495 This option allows further control over excess precision on machines
9496 where floating-point operations occur in a format with more precision or
9497 range than the IEEE standard and interchange floating-point types.  By
9498 default, @option{-fexcess-precision=fast} is in effect; this means that
9499 operations may be carried out in a wider precision than the types specified
9500 in the source if that would result in faster code, and it is unpredictable
9501 when rounding to the types specified in the source code takes place.
9502 When compiling C, if @option{-fexcess-precision=standard} is specified then
9503 excess precision follows the rules specified in ISO C99; in particular,
9504 both casts and assignments cause values to be rounded to their
9505 semantic types (whereas @option{-ffloat-store} only affects
9506 assignments).  This option is enabled by default for C if a strict
9507 conformance option such as @option{-std=c99} is used.
9508 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9509 regardless of whether a strict conformance option is used.
9511 @opindex mfpmath
9512 @option{-fexcess-precision=standard} is not implemented for languages
9513 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9514 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9515 semantics apply without excess precision, and in the latter, rounding
9516 is unpredictable.
9518 @item -ffast-math
9519 @opindex ffast-math
9520 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9521 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9522 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9523 @option{-fexcess-precision=fast}.
9525 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9527 This option is not turned on by any @option{-O} option besides
9528 @option{-Ofast} since it can result in incorrect output for programs
9529 that depend on an exact implementation of IEEE or ISO rules/specifications
9530 for math functions. It may, however, yield faster code for programs
9531 that do not require the guarantees of these specifications.
9533 @item -fno-math-errno
9534 @opindex fno-math-errno
9535 Do not set @code{errno} after calling math functions that are executed
9536 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9537 IEEE exceptions for math error handling may want to use this flag
9538 for speed while maintaining IEEE arithmetic compatibility.
9540 This option is not turned on by any @option{-O} option since
9541 it can result in incorrect output for programs that depend on
9542 an exact implementation of IEEE or ISO rules/specifications for
9543 math functions. It may, however, yield faster code for programs
9544 that do not require the guarantees of these specifications.
9546 The default is @option{-fmath-errno}.
9548 On Darwin systems, the math library never sets @code{errno}.  There is
9549 therefore no reason for the compiler to consider the possibility that
9550 it might, and @option{-fno-math-errno} is the default.
9552 @item -funsafe-math-optimizations
9553 @opindex funsafe-math-optimizations
9555 Allow optimizations for floating-point arithmetic that (a) assume
9556 that arguments and results are valid and (b) may violate IEEE or
9557 ANSI standards.  When used at link time, it may include libraries
9558 or startup files that change the default FPU control word or other
9559 similar optimizations.
9561 This option is not turned on by any @option{-O} option since
9562 it can result in incorrect output for programs that depend on
9563 an exact implementation of IEEE or ISO rules/specifications for
9564 math functions. It may, however, yield faster code for programs
9565 that do not require the guarantees of these specifications.
9566 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9567 @option{-fassociative-math} and @option{-freciprocal-math}.
9569 The default is @option{-fno-unsafe-math-optimizations}.
9571 @item -fassociative-math
9572 @opindex fassociative-math
9574 Allow re-association of operands in series of floating-point operations.
9575 This violates the ISO C and C++ language standard by possibly changing
9576 computation result.  NOTE: re-ordering may change the sign of zero as
9577 well as ignore NaNs and inhibit or create underflow or overflow (and
9578 thus cannot be used on code that relies on rounding behavior like
9579 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9580 and thus may not be used when ordered comparisons are required.
9581 This option requires that both @option{-fno-signed-zeros} and
9582 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9583 much sense with @option{-frounding-math}. For Fortran the option
9584 is automatically enabled when both @option{-fno-signed-zeros} and
9585 @option{-fno-trapping-math} are in effect.
9587 The default is @option{-fno-associative-math}.
9589 @item -freciprocal-math
9590 @opindex freciprocal-math
9592 Allow the reciprocal of a value to be used instead of dividing by
9593 the value if this enables optimizations.  For example @code{x / y}
9594 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9595 is subject to common subexpression elimination.  Note that this loses
9596 precision and increases the number of flops operating on the value.
9598 The default is @option{-fno-reciprocal-math}.
9600 @item -ffinite-math-only
9601 @opindex ffinite-math-only
9602 Allow optimizations for floating-point arithmetic that assume
9603 that arguments and results are not NaNs or +-Infs.
9605 This option is not turned on by any @option{-O} option since
9606 it can result in incorrect output for programs that depend on
9607 an exact implementation of IEEE or ISO rules/specifications for
9608 math functions. It may, however, yield faster code for programs
9609 that do not require the guarantees of these specifications.
9611 The default is @option{-fno-finite-math-only}.
9613 @item -fno-signed-zeros
9614 @opindex fno-signed-zeros
9615 Allow optimizations for floating-point arithmetic that ignore the
9616 signedness of zero.  IEEE arithmetic specifies the behavior of
9617 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9618 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9619 This option implies that the sign of a zero result isn't significant.
9621 The default is @option{-fsigned-zeros}.
9623 @item -fno-trapping-math
9624 @opindex fno-trapping-math
9625 Compile code assuming that floating-point operations cannot generate
9626 user-visible traps.  These traps include division by zero, overflow,
9627 underflow, inexact result and invalid operation.  This option requires
9628 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9629 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9631 This option should never be turned on by any @option{-O} option since
9632 it can result in incorrect output for programs that depend on
9633 an exact implementation of IEEE or ISO rules/specifications for
9634 math functions.
9636 The default is @option{-ftrapping-math}.
9638 @item -frounding-math
9639 @opindex frounding-math
9640 Disable transformations and optimizations that assume default floating-point
9641 rounding behavior.  This is round-to-zero for all floating point
9642 to integer conversions, and round-to-nearest for all other arithmetic
9643 truncations.  This option should be specified for programs that change
9644 the FP rounding mode dynamically, or that may be executed with a
9645 non-default rounding mode.  This option disables constant folding of
9646 floating-point expressions at compile time (which may be affected by
9647 rounding mode) and arithmetic transformations that are unsafe in the
9648 presence of sign-dependent rounding modes.
9650 The default is @option{-fno-rounding-math}.
9652 This option is experimental and does not currently guarantee to
9653 disable all GCC optimizations that are affected by rounding mode.
9654 Future versions of GCC may provide finer control of this setting
9655 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9656 will be used to specify the default state for @code{FENV_ACCESS}.
9658 @item -fsignaling-nans
9659 @opindex fsignaling-nans
9660 Compile code assuming that IEEE signaling NaNs may generate user-visible
9661 traps during floating-point operations.  Setting this option disables
9662 optimizations that may change the number of exceptions visible with
9663 signaling NaNs.  This option implies @option{-ftrapping-math}.
9665 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9666 be defined.
9668 The default is @option{-fno-signaling-nans}.
9670 This option is experimental and does not currently guarantee to
9671 disable all GCC optimizations that affect signaling NaN behavior.
9673 @item -fno-fp-int-builtin-inexact
9674 @opindex fno-fp-int-builtin-inexact
9675 Do not allow the built-in functions @code{ceil}, @code{floor},
9676 @code{round} and @code{trunc}, and their @code{float} and @code{long
9677 double} variants, to generate code that raises the ``inexact''
9678 floating-point exception for noninteger arguments.  ISO C99 and C11
9679 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9680 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9681 functions to do so.
9683 The default is @option{-ffp-int-builtin-inexact}, allowing the
9684 exception to be raised.  This option does nothing unless
9685 @option{-ftrapping-math} is in effect.
9687 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9688 generate a call to a library function then the ``inexact'' exception
9689 may be raised if the library implementation does not follow TS 18661.
9691 @item -fsingle-precision-constant
9692 @opindex fsingle-precision-constant
9693 Treat floating-point constants as single precision instead of
9694 implicitly converting them to double-precision constants.
9696 @item -fcx-limited-range
9697 @opindex fcx-limited-range
9698 When enabled, this option states that a range reduction step is not
9699 needed when performing complex division.  Also, there is no checking
9700 whether the result of a complex multiplication or division is @code{NaN
9701 + I*NaN}, with an attempt to rescue the situation in that case.  The
9702 default is @option{-fno-cx-limited-range}, but is enabled by
9703 @option{-ffast-math}.
9705 This option controls the default setting of the ISO C99
9706 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9707 all languages.
9709 @item -fcx-fortran-rules
9710 @opindex fcx-fortran-rules
9711 Complex multiplication and division follow Fortran rules.  Range
9712 reduction is done as part of complex division, but there is no checking
9713 whether the result of a complex multiplication or division is @code{NaN
9714 + I*NaN}, with an attempt to rescue the situation in that case.
9716 The default is @option{-fno-cx-fortran-rules}.
9718 @end table
9720 The following options control optimizations that may improve
9721 performance, but are not enabled by any @option{-O} options.  This
9722 section includes experimental options that may produce broken code.
9724 @table @gcctabopt
9725 @item -fbranch-probabilities
9726 @opindex fbranch-probabilities
9727 After running a program compiled with @option{-fprofile-arcs}
9728 (@pxref{Instrumentation Options}),
9729 you can compile it a second time using
9730 @option{-fbranch-probabilities}, to improve optimizations based on
9731 the number of times each branch was taken.  When a program
9732 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9733 counts to a file called @file{@var{sourcename}.gcda} for each source
9734 file.  The information in this data file is very dependent on the
9735 structure of the generated code, so you must use the same source code
9736 and the same optimization options for both compilations.
9738 With @option{-fbranch-probabilities}, GCC puts a
9739 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9740 These can be used to improve optimization.  Currently, they are only
9741 used in one place: in @file{reorg.c}, instead of guessing which path a
9742 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9743 exactly determine which path is taken more often.
9745 @item -fprofile-values
9746 @opindex fprofile-values
9747 If combined with @option{-fprofile-arcs}, it adds code so that some
9748 data about values of expressions in the program is gathered.
9750 With @option{-fbranch-probabilities}, it reads back the data gathered
9751 from profiling values of expressions for usage in optimizations.
9753 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9755 @item -fprofile-reorder-functions
9756 @opindex fprofile-reorder-functions
9757 Function reordering based on profile instrumentation collects
9758 first time of execution of a function and orders these functions
9759 in ascending order.
9761 Enabled with @option{-fprofile-use}.
9763 @item -fvpt
9764 @opindex fvpt
9765 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9766 to add code to gather information about values of expressions.
9768 With @option{-fbranch-probabilities}, it reads back the data gathered
9769 and actually performs the optimizations based on them.
9770 Currently the optimizations include specialization of division operations
9771 using the knowledge about the value of the denominator.
9773 @item -frename-registers
9774 @opindex frename-registers
9775 Attempt to avoid false dependencies in scheduled code by making use
9776 of registers left over after register allocation.  This optimization
9777 most benefits processors with lots of registers.  Depending on the
9778 debug information format adopted by the target, however, it can
9779 make debugging impossible, since variables no longer stay in
9780 a ``home register''.
9782 Enabled by default with @option{-funroll-loops}.
9784 @item -fschedule-fusion
9785 @opindex fschedule-fusion
9786 Performs a target dependent pass over the instruction stream to schedule
9787 instructions of same type together because target machine can execute them
9788 more efficiently if they are adjacent to each other in the instruction flow.
9790 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9792 @item -ftracer
9793 @opindex ftracer
9794 Perform tail duplication to enlarge superblock size.  This transformation
9795 simplifies the control flow of the function allowing other optimizations to do
9796 a better job.
9798 Enabled with @option{-fprofile-use}.
9800 @item -funroll-loops
9801 @opindex funroll-loops
9802 Unroll loops whose number of iterations can be determined at compile time or
9803 upon entry to the loop.  @option{-funroll-loops} implies
9804 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9805 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9806 a small constant number of iterations).  This option makes code larger, and may
9807 or may not make it run faster.
9809 Enabled with @option{-fprofile-use}.
9811 @item -funroll-all-loops
9812 @opindex funroll-all-loops
9813 Unroll all loops, even if their number of iterations is uncertain when
9814 the loop is entered.  This usually makes programs run more slowly.
9815 @option{-funroll-all-loops} implies the same options as
9816 @option{-funroll-loops}.
9818 @item -fpeel-loops
9819 @opindex fpeel-loops
9820 Peels loops for which there is enough information that they do not
9821 roll much (from profile feedback or static analysis).  It also turns on
9822 complete loop peeling (i.e.@: complete removal of loops with small constant
9823 number of iterations).
9825 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9827 @item -fmove-loop-invariants
9828 @opindex fmove-loop-invariants
9829 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9830 at level @option{-O1}
9832 @item -fsplit-loops
9833 @opindex fsplit-loops
9834 Split a loop into two if it contains a condition that's always true
9835 for one side of the iteration space and false for the other.
9837 @item -funswitch-loops
9838 @opindex funswitch-loops
9839 Move branches with loop invariant conditions out of the loop, with duplicates
9840 of the loop on both branches (modified according to result of the condition).
9842 @item -floop-unroll-and-jam
9843 @opindex floop-unroll-and-jam
9844 Apply unroll and jam transformations on feasible loops.  In a loop
9845 nest this unrolls the outer loop by some factor and fuses the resulting
9846 multiple inner loops.
9848 @item -ffunction-sections
9849 @itemx -fdata-sections
9850 @opindex ffunction-sections
9851 @opindex fdata-sections
9852 Place each function or data item into its own section in the output
9853 file if the target supports arbitrary sections.  The name of the
9854 function or the name of the data item determines the section's name
9855 in the output file.
9857 Use these options on systems where the linker can perform optimizations to
9858 improve locality of reference in the instruction space.  Most systems using the
9859 ELF object format have linkers with such optimizations.  On AIX, the linker
9860 rearranges sections (CSECTs) based on the call graph.  The performance impact
9861 varies.
9863 Together with a linker garbage collection (linker @option{--gc-sections}
9864 option) these options may lead to smaller statically-linked executables (after
9865 stripping).
9867 On ELF/DWARF systems these options do not degenerate the quality of the debug
9868 information.  There could be issues with other object files/debug info formats.
9870 Only use these options when there are significant benefits from doing so.  When
9871 you specify these options, the assembler and linker create larger object and
9872 executable files and are also slower.  These options affect code generation.
9873 They prevent optimizations by the compiler and assembler using relative
9874 locations inside a translation unit since the locations are unknown until
9875 link time.  An example of such an optimization is relaxing calls to short call
9876 instructions.
9878 @item -fbranch-target-load-optimize
9879 @opindex fbranch-target-load-optimize
9880 Perform branch target register load optimization before prologue / epilogue
9881 threading.
9882 The use of target registers can typically be exposed only during reload,
9883 thus hoisting loads out of loops and doing inter-block scheduling needs
9884 a separate optimization pass.
9886 @item -fbranch-target-load-optimize2
9887 @opindex fbranch-target-load-optimize2
9888 Perform branch target register load optimization after prologue / epilogue
9889 threading.
9891 @item -fbtr-bb-exclusive
9892 @opindex fbtr-bb-exclusive
9893 When performing branch target register load optimization, don't reuse
9894 branch target registers within any basic block.
9896 @item -fstdarg-opt
9897 @opindex fstdarg-opt
9898 Optimize the prologue of variadic argument functions with respect to usage of
9899 those arguments.
9901 @item -fsection-anchors
9902 @opindex fsection-anchors
9903 Try to reduce the number of symbolic address calculations by using
9904 shared ``anchor'' symbols to address nearby objects.  This transformation
9905 can help to reduce the number of GOT entries and GOT accesses on some
9906 targets.
9908 For example, the implementation of the following function @code{foo}:
9910 @smallexample
9911 static int a, b, c;
9912 int foo (void) @{ return a + b + c; @}
9913 @end smallexample
9915 @noindent
9916 usually calculates the addresses of all three variables, but if you
9917 compile it with @option{-fsection-anchors}, it accesses the variables
9918 from a common anchor point instead.  The effect is similar to the
9919 following pseudocode (which isn't valid C):
9921 @smallexample
9922 int foo (void)
9924   register int *xr = &x;
9925   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9927 @end smallexample
9929 Not all targets support this option.
9931 @item --param @var{name}=@var{value}
9932 @opindex param
9933 In some places, GCC uses various constants to control the amount of
9934 optimization that is done.  For example, GCC does not inline functions
9935 that contain more than a certain number of instructions.  You can
9936 control some of these constants on the command line using the
9937 @option{--param} option.
9939 The names of specific parameters, and the meaning of the values, are
9940 tied to the internals of the compiler, and are subject to change
9941 without notice in future releases.
9943 In each case, the @var{value} is an integer.  The allowable choices for
9944 @var{name} are:
9946 @table @gcctabopt
9947 @item predictable-branch-outcome
9948 When branch is predicted to be taken with probability lower than this threshold
9949 (in percent), then it is considered well predictable. The default is 10.
9951 @item max-rtl-if-conversion-insns
9952 RTL if-conversion tries to remove conditional branches around a block and
9953 replace them with conditionally executed instructions.  This parameter
9954 gives the maximum number of instructions in a block which should be
9955 considered for if-conversion.  The default is 10, though the compiler will
9956 also use other heuristics to decide whether if-conversion is likely to be
9957 profitable.
9959 @item max-rtl-if-conversion-predictable-cost
9960 @item max-rtl-if-conversion-unpredictable-cost
9961 RTL if-conversion will try to remove conditional branches around a block
9962 and replace them with conditionally executed instructions.  These parameters
9963 give the maximum permissible cost for the sequence that would be generated
9964 by if-conversion depending on whether the branch is statically determined
9965 to be predictable or not.  The units for this parameter are the same as
9966 those for the GCC internal seq_cost metric.  The compiler will try to
9967 provide a reasonable default for this parameter using the BRANCH_COST
9968 target macro.
9970 @item max-crossjump-edges
9971 The maximum number of incoming edges to consider for cross-jumping.
9972 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9973 the number of edges incoming to each block.  Increasing values mean
9974 more aggressive optimization, making the compilation time increase with
9975 probably small improvement in executable size.
9977 @item min-crossjump-insns
9978 The minimum number of instructions that must be matched at the end
9979 of two blocks before cross-jumping is performed on them.  This
9980 value is ignored in the case where all instructions in the block being
9981 cross-jumped from are matched.  The default value is 5.
9983 @item max-grow-copy-bb-insns
9984 The maximum code size expansion factor when copying basic blocks
9985 instead of jumping.  The expansion is relative to a jump instruction.
9986 The default value is 8.
9988 @item max-goto-duplication-insns
9989 The maximum number of instructions to duplicate to a block that jumps
9990 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9991 passes, GCC factors computed gotos early in the compilation process,
9992 and unfactors them as late as possible.  Only computed jumps at the
9993 end of a basic blocks with no more than max-goto-duplication-insns are
9994 unfactored.  The default value is 8.
9996 @item max-delay-slot-insn-search
9997 The maximum number of instructions to consider when looking for an
9998 instruction to fill a delay slot.  If more than this arbitrary number of
9999 instructions are searched, the time savings from filling the delay slot
10000 are minimal, so stop searching.  Increasing values mean more
10001 aggressive optimization, making the compilation time increase with probably
10002 small improvement in execution time.
10004 @item max-delay-slot-live-search
10005 When trying to fill delay slots, the maximum number of instructions to
10006 consider when searching for a block with valid live register
10007 information.  Increasing this arbitrarily chosen value means more
10008 aggressive optimization, increasing the compilation time.  This parameter
10009 should be removed when the delay slot code is rewritten to maintain the
10010 control-flow graph.
10012 @item max-gcse-memory
10013 The approximate maximum amount of memory that can be allocated in
10014 order to perform the global common subexpression elimination
10015 optimization.  If more memory than specified is required, the
10016 optimization is not done.
10018 @item max-gcse-insertion-ratio
10019 If the ratio of expression insertions to deletions is larger than this value
10020 for any expression, then RTL PRE inserts or removes the expression and thus
10021 leaves partially redundant computations in the instruction stream.  The default value is 20.
10023 @item max-pending-list-length
10024 The maximum number of pending dependencies scheduling allows
10025 before flushing the current state and starting over.  Large functions
10026 with few branches or calls can create excessively large lists which
10027 needlessly consume memory and resources.
10029 @item max-modulo-backtrack-attempts
10030 The maximum number of backtrack attempts the scheduler should make
10031 when modulo scheduling a loop.  Larger values can exponentially increase
10032 compilation time.
10034 @item max-inline-insns-single
10035 Several parameters control the tree inliner used in GCC@.
10036 This number sets the maximum number of instructions (counted in GCC's
10037 internal representation) in a single function that the tree inliner
10038 considers for inlining.  This only affects functions declared
10039 inline and methods implemented in a class declaration (C++).
10040 The default value is 400.
10042 @item max-inline-insns-auto
10043 When you use @option{-finline-functions} (included in @option{-O3}),
10044 a lot of functions that would otherwise not be considered for inlining
10045 by the compiler are investigated.  To those functions, a different
10046 (more restrictive) limit compared to functions declared inline can
10047 be applied.
10048 The default value is 40.
10050 @item inline-min-speedup
10051 When estimated performance improvement of caller + callee runtime exceeds this
10052 threshold (in percent), the function can be inlined regardless of the limit on
10053 @option{--param max-inline-insns-single} and @option{--param
10054 max-inline-insns-auto}.
10056 @item large-function-insns
10057 The limit specifying really large functions.  For functions larger than this
10058 limit after inlining, inlining is constrained by
10059 @option{--param large-function-growth}.  This parameter is useful primarily
10060 to avoid extreme compilation time caused by non-linear algorithms used by the
10061 back end.
10062 The default value is 2700.
10064 @item large-function-growth
10065 Specifies maximal growth of large function caused by inlining in percents.
10066 The default value is 100 which limits large function growth to 2.0 times
10067 the original size.
10069 @item large-unit-insns
10070 The limit specifying large translation unit.  Growth caused by inlining of
10071 units larger than this limit is limited by @option{--param inline-unit-growth}.
10072 For small units this might be too tight.
10073 For example, consider a unit consisting of function A
10074 that is inline and B that just calls A three times.  If B is small relative to
10075 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10076 large units consisting of small inlineable functions, however, the overall unit
10077 growth limit is needed to avoid exponential explosion of code size.  Thus for
10078 smaller units, the size is increased to @option{--param large-unit-insns}
10079 before applying @option{--param inline-unit-growth}.  The default is 10000.
10081 @item inline-unit-growth
10082 Specifies maximal overall growth of the compilation unit caused by inlining.
10083 The default value is 20 which limits unit growth to 1.2 times the original
10084 size. Cold functions (either marked cold via an attribute or by profile
10085 feedback) are not accounted into the unit size.
10087 @item ipcp-unit-growth
10088 Specifies maximal overall growth of the compilation unit caused by
10089 interprocedural constant propagation.  The default value is 10 which limits
10090 unit growth to 1.1 times the original size.
10092 @item large-stack-frame
10093 The limit specifying large stack frames.  While inlining the algorithm is trying
10094 to not grow past this limit too much.  The default value is 256 bytes.
10096 @item large-stack-frame-growth
10097 Specifies maximal growth of large stack frames caused by inlining in percents.
10098 The default value is 1000 which limits large stack frame growth to 11 times
10099 the original size.
10101 @item max-inline-insns-recursive
10102 @itemx max-inline-insns-recursive-auto
10103 Specifies the maximum number of instructions an out-of-line copy of a
10104 self-recursive inline
10105 function can grow into by performing recursive inlining.
10107 @option{--param max-inline-insns-recursive} applies to functions
10108 declared inline.
10109 For functions not declared inline, recursive inlining
10110 happens only when @option{-finline-functions} (included in @option{-O3}) is
10111 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10112 default value is 450.
10114 @item max-inline-recursive-depth
10115 @itemx max-inline-recursive-depth-auto
10116 Specifies the maximum recursion depth used for recursive inlining.
10118 @option{--param max-inline-recursive-depth} applies to functions
10119 declared inline.  For functions not declared inline, recursive inlining
10120 happens only when @option{-finline-functions} (included in @option{-O3}) is
10121 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10122 default value is 8.
10124 @item min-inline-recursive-probability
10125 Recursive inlining is profitable only for function having deep recursion
10126 in average and can hurt for function having little recursion depth by
10127 increasing the prologue size or complexity of function body to other
10128 optimizers.
10130 When profile feedback is available (see @option{-fprofile-generate}) the actual
10131 recursion depth can be guessed from the probability that function recurses
10132 via a given call expression.  This parameter limits inlining only to call
10133 expressions whose probability exceeds the given threshold (in percents).
10134 The default value is 10.
10136 @item early-inlining-insns
10137 Specify growth that the early inliner can make.  In effect it increases
10138 the amount of inlining for code having a large abstraction penalty.
10139 The default value is 14.
10141 @item max-early-inliner-iterations
10142 Limit of iterations of the early inliner.  This basically bounds
10143 the number of nested indirect calls the early inliner can resolve.
10144 Deeper chains are still handled by late inlining.
10146 @item comdat-sharing-probability
10147 Probability (in percent) that C++ inline function with comdat visibility
10148 are shared across multiple compilation units.  The default value is 20.
10150 @item profile-func-internal-id
10151 A parameter to control whether to use function internal id in profile
10152 database lookup. If the value is 0, the compiler uses an id that
10153 is based on function assembler name and filename, which makes old profile
10154 data more tolerant to source changes such as function reordering etc.
10155 The default value is 0.
10157 @item min-vect-loop-bound
10158 The minimum number of iterations under which loops are not vectorized
10159 when @option{-ftree-vectorize} is used.  The number of iterations after
10160 vectorization needs to be greater than the value specified by this option
10161 to allow vectorization.  The default value is 0.
10163 @item gcse-cost-distance-ratio
10164 Scaling factor in calculation of maximum distance an expression
10165 can be moved by GCSE optimizations.  This is currently supported only in the
10166 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10167 is with simple expressions, i.e., the expressions that have cost
10168 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10169 hoisting of simple expressions.  The default value is 10.
10171 @item gcse-unrestricted-cost
10172 Cost, roughly measured as the cost of a single typical machine
10173 instruction, at which GCSE optimizations do not constrain
10174 the distance an expression can travel.  This is currently
10175 supported only in the code hoisting pass.  The lesser the cost,
10176 the more aggressive code hoisting is.  Specifying 0 
10177 allows all expressions to travel unrestricted distances.
10178 The default value is 3.
10180 @item max-hoist-depth
10181 The depth of search in the dominator tree for expressions to hoist.
10182 This is used to avoid quadratic behavior in hoisting algorithm.
10183 The value of 0 does not limit on the search, but may slow down compilation
10184 of huge functions.  The default value is 30.
10186 @item max-tail-merge-comparisons
10187 The maximum amount of similar bbs to compare a bb with.  This is used to
10188 avoid quadratic behavior in tree tail merging.  The default value is 10.
10190 @item max-tail-merge-iterations
10191 The maximum amount of iterations of the pass over the function.  This is used to
10192 limit compilation time in tree tail merging.  The default value is 2.
10194 @item store-merging-allow-unaligned
10195 Allow the store merging pass to introduce unaligned stores if it is legal to
10196 do so.  The default value is 1.
10198 @item max-stores-to-merge
10199 The maximum number of stores to attempt to merge into wider stores in the store
10200 merging pass.  The minimum value is 2 and the default is 64.
10202 @item max-unrolled-insns
10203 The maximum number of instructions that a loop may have to be unrolled.
10204 If a loop is unrolled, this parameter also determines how many times
10205 the loop code is unrolled.
10207 @item max-average-unrolled-insns
10208 The maximum number of instructions biased by probabilities of their execution
10209 that a loop may have to be unrolled.  If a loop is unrolled,
10210 this parameter also determines how many times the loop code is unrolled.
10212 @item max-unroll-times
10213 The maximum number of unrollings of a single loop.
10215 @item max-peeled-insns
10216 The maximum number of instructions that a loop may have to be peeled.
10217 If a loop is peeled, this parameter also determines how many times
10218 the loop code is peeled.
10220 @item max-peel-times
10221 The maximum number of peelings of a single loop.
10223 @item max-peel-branches
10224 The maximum number of branches on the hot path through the peeled sequence.
10226 @item max-completely-peeled-insns
10227 The maximum number of insns of a completely peeled loop.
10229 @item max-completely-peel-times
10230 The maximum number of iterations of a loop to be suitable for complete peeling.
10232 @item max-completely-peel-loop-nest-depth
10233 The maximum depth of a loop nest suitable for complete peeling.
10235 @item max-unswitch-insns
10236 The maximum number of insns of an unswitched loop.
10238 @item max-unswitch-level
10239 The maximum number of branches unswitched in a single loop.
10241 @item max-loop-headers-insns
10242 The maximum number of insns in loop header duplicated by the copy loop headers
10243 pass.
10245 @item lim-expensive
10246 The minimum cost of an expensive expression in the loop invariant motion.
10248 @item iv-consider-all-candidates-bound
10249 Bound on number of candidates for induction variables, below which
10250 all candidates are considered for each use in induction variable
10251 optimizations.  If there are more candidates than this,
10252 only the most relevant ones are considered to avoid quadratic time complexity.
10254 @item iv-max-considered-uses
10255 The induction variable optimizations give up on loops that contain more
10256 induction variable uses.
10258 @item iv-always-prune-cand-set-bound
10259 If the number of candidates in the set is smaller than this value,
10260 always try to remove unnecessary ivs from the set
10261 when adding a new one.
10263 @item avg-loop-niter
10264 Average number of iterations of a loop.
10266 @item dse-max-object-size
10267 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10268 Larger values may result in larger compilation times.
10270 @item scev-max-expr-size
10271 Bound on size of expressions used in the scalar evolutions analyzer.
10272 Large expressions slow the analyzer.
10274 @item scev-max-expr-complexity
10275 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10276 Complex expressions slow the analyzer.
10278 @item max-tree-if-conversion-phi-args
10279 Maximum number of arguments in a PHI supported by TREE if conversion
10280 unless the loop is marked with simd pragma.
10282 @item vect-max-version-for-alignment-checks
10283 The maximum number of run-time checks that can be performed when
10284 doing loop versioning for alignment in the vectorizer.
10286 @item vect-max-version-for-alias-checks
10287 The maximum number of run-time checks that can be performed when
10288 doing loop versioning for alias in the vectorizer.
10290 @item vect-max-peeling-for-alignment
10291 The maximum number of loop peels to enhance access alignment
10292 for vectorizer. Value -1 means no limit.
10294 @item max-iterations-to-track
10295 The maximum number of iterations of a loop the brute-force algorithm
10296 for analysis of the number of iterations of the loop tries to evaluate.
10298 @item hot-bb-count-ws-permille
10299 A basic block profile count is considered hot if it contributes to 
10300 the given permillage (i.e. 0...1000) of the entire profiled execution.
10302 @item hot-bb-frequency-fraction
10303 Select fraction of the entry block frequency of executions of basic block in
10304 function given basic block needs to have to be considered hot.
10306 @item max-predicted-iterations
10307 The maximum number of loop iterations we predict statically.  This is useful
10308 in cases where a function contains a single loop with known bound and
10309 another loop with unknown bound.
10310 The known number of iterations is predicted correctly, while
10311 the unknown number of iterations average to roughly 10.  This means that the
10312 loop without bounds appears artificially cold relative to the other one.
10314 @item builtin-expect-probability
10315 Control the probability of the expression having the specified value. This
10316 parameter takes a percentage (i.e. 0 ... 100) as input.
10317 The default probability of 90 is obtained empirically.
10319 @item align-threshold
10321 Select fraction of the maximal frequency of executions of a basic block in
10322 a function to align the basic block.
10324 @item align-loop-iterations
10326 A loop expected to iterate at least the selected number of iterations is
10327 aligned.
10329 @item tracer-dynamic-coverage
10330 @itemx tracer-dynamic-coverage-feedback
10332 This value is used to limit superblock formation once the given percentage of
10333 executed instructions is covered.  This limits unnecessary code size
10334 expansion.
10336 The @option{tracer-dynamic-coverage-feedback} parameter
10337 is used only when profile
10338 feedback is available.  The real profiles (as opposed to statically estimated
10339 ones) are much less balanced allowing the threshold to be larger value.
10341 @item tracer-max-code-growth
10342 Stop tail duplication once code growth has reached given percentage.  This is
10343 a rather artificial limit, as most of the duplicates are eliminated later in
10344 cross jumping, so it may be set to much higher values than is the desired code
10345 growth.
10347 @item tracer-min-branch-ratio
10349 Stop reverse growth when the reverse probability of best edge is less than this
10350 threshold (in percent).
10352 @item tracer-min-branch-probability
10353 @itemx tracer-min-branch-probability-feedback
10355 Stop forward growth if the best edge has probability lower than this
10356 threshold.
10358 Similarly to @option{tracer-dynamic-coverage} two parameters are
10359 provided.  @option{tracer-min-branch-probability-feedback} is used for
10360 compilation with profile feedback and @option{tracer-min-branch-probability}
10361 compilation without.  The value for compilation with profile feedback
10362 needs to be more conservative (higher) in order to make tracer
10363 effective.
10365 @item stack-clash-protection-guard-size
10366 Specify the size of the operating system provided stack guard as
10367 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10368 Acceptable values are between 12 and 30.  Higher values may reduce the
10369 number of explicit probes, but a value larger than the operating system
10370 provided guard will leave code vulnerable to stack clash style attacks.
10372 @item stack-clash-protection-probe-interval
10373 Stack clash protection involves probing stack space as it is allocated.  This
10374 param controls the maximum distance between probes into the stack as 2 raised
10375 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10376 12.  Higher values may reduce the number of explicit probes, but a value
10377 larger than the operating system provided guard will leave code vulnerable to
10378 stack clash style attacks.
10380 @item max-cse-path-length
10382 The maximum number of basic blocks on path that CSE considers.
10383 The default is 10.
10385 @item max-cse-insns
10386 The maximum number of instructions CSE processes before flushing.
10387 The default is 1000.
10389 @item ggc-min-expand
10391 GCC uses a garbage collector to manage its own memory allocation.  This
10392 parameter specifies the minimum percentage by which the garbage
10393 collector's heap should be allowed to expand between collections.
10394 Tuning this may improve compilation speed; it has no effect on code
10395 generation.
10397 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10398 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10399 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10400 GCC is not able to calculate RAM on a particular platform, the lower
10401 bound of 30% is used.  Setting this parameter and
10402 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10403 every opportunity.  This is extremely slow, but can be useful for
10404 debugging.
10406 @item ggc-min-heapsize
10408 Minimum size of the garbage collector's heap before it begins bothering
10409 to collect garbage.  The first collection occurs after the heap expands
10410 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10411 tuning this may improve compilation speed, and has no effect on code
10412 generation.
10414 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10415 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10416 with a lower bound of 4096 (four megabytes) and an upper bound of
10417 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10418 particular platform, the lower bound is used.  Setting this parameter
10419 very large effectively disables garbage collection.  Setting this
10420 parameter and @option{ggc-min-expand} to zero causes a full collection
10421 to occur at every opportunity.
10423 @item max-reload-search-insns
10424 The maximum number of instruction reload should look backward for equivalent
10425 register.  Increasing values mean more aggressive optimization, making the
10426 compilation time increase with probably slightly better performance.
10427 The default value is 100.
10429 @item max-cselib-memory-locations
10430 The maximum number of memory locations cselib should take into account.
10431 Increasing values mean more aggressive optimization, making the compilation time
10432 increase with probably slightly better performance.  The default value is 500.
10434 @item max-sched-ready-insns
10435 The maximum number of instructions ready to be issued the scheduler should
10436 consider at any given time during the first scheduling pass.  Increasing
10437 values mean more thorough searches, making the compilation time increase
10438 with probably little benefit.  The default value is 100.
10440 @item max-sched-region-blocks
10441 The maximum number of blocks in a region to be considered for
10442 interblock scheduling.  The default value is 10.
10444 @item max-pipeline-region-blocks
10445 The maximum number of blocks in a region to be considered for
10446 pipelining in the selective scheduler.  The default value is 15.
10448 @item max-sched-region-insns
10449 The maximum number of insns in a region to be considered for
10450 interblock scheduling.  The default value is 100.
10452 @item max-pipeline-region-insns
10453 The maximum number of insns in a region to be considered for
10454 pipelining in the selective scheduler.  The default value is 200.
10456 @item min-spec-prob
10457 The minimum probability (in percents) of reaching a source block
10458 for interblock speculative scheduling.  The default value is 40.
10460 @item max-sched-extend-regions-iters
10461 The maximum number of iterations through CFG to extend regions.
10462 A value of 0 (the default) disables region extensions.
10464 @item max-sched-insn-conflict-delay
10465 The maximum conflict delay for an insn to be considered for speculative motion.
10466 The default value is 3.
10468 @item sched-spec-prob-cutoff
10469 The minimal probability of speculation success (in percents), so that
10470 speculative insns are scheduled.
10471 The default value is 40.
10473 @item sched-state-edge-prob-cutoff
10474 The minimum probability an edge must have for the scheduler to save its
10475 state across it.
10476 The default value is 10.
10478 @item sched-mem-true-dep-cost
10479 Minimal distance (in CPU cycles) between store and load targeting same
10480 memory locations.  The default value is 1.
10482 @item selsched-max-lookahead
10483 The maximum size of the lookahead window of selective scheduling.  It is a
10484 depth of search for available instructions.
10485 The default value is 50.
10487 @item selsched-max-sched-times
10488 The maximum number of times that an instruction is scheduled during
10489 selective scheduling.  This is the limit on the number of iterations
10490 through which the instruction may be pipelined.  The default value is 2.
10492 @item selsched-insns-to-rename
10493 The maximum number of best instructions in the ready list that are considered
10494 for renaming in the selective scheduler.  The default value is 2.
10496 @item sms-min-sc
10497 The minimum value of stage count that swing modulo scheduler
10498 generates.  The default value is 2.
10500 @item max-last-value-rtl
10501 The maximum size measured as number of RTLs that can be recorded in an expression
10502 in combiner for a pseudo register as last known value of that register.  The default
10503 is 10000.
10505 @item max-combine-insns
10506 The maximum number of instructions the RTL combiner tries to combine.
10507 The default value is 2 at @option{-Og} and 4 otherwise.
10509 @item integer-share-limit
10510 Small integer constants can use a shared data structure, reducing the
10511 compiler's memory usage and increasing its speed.  This sets the maximum
10512 value of a shared integer constant.  The default value is 256.
10514 @item ssp-buffer-size
10515 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10516 protection when @option{-fstack-protection} is used.
10518 @item min-size-for-stack-sharing
10519 The minimum size of variables taking part in stack slot sharing when not
10520 optimizing. The default value is 32.
10522 @item max-jump-thread-duplication-stmts
10523 Maximum number of statements allowed in a block that needs to be
10524 duplicated when threading jumps.
10526 @item max-fields-for-field-sensitive
10527 Maximum number of fields in a structure treated in
10528 a field sensitive manner during pointer analysis.  The default is zero
10529 for @option{-O0} and @option{-O1},
10530 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10532 @item prefetch-latency
10533 Estimate on average number of instructions that are executed before
10534 prefetch finishes.  The distance prefetched ahead is proportional
10535 to this constant.  Increasing this number may also lead to less
10536 streams being prefetched (see @option{simultaneous-prefetches}).
10538 @item simultaneous-prefetches
10539 Maximum number of prefetches that can run at the same time.
10541 @item l1-cache-line-size
10542 The size of cache line in L1 cache, in bytes.
10544 @item l1-cache-size
10545 The size of L1 cache, in kilobytes.
10547 @item l2-cache-size
10548 The size of L2 cache, in kilobytes.
10550 @item loop-interchange-max-num-stmts
10551 The maximum number of stmts in a loop to be interchanged.
10553 @item loop-interchange-stride-ratio
10554 The minimum ratio between stride of two loops for interchange to be profitable.
10556 @item min-insn-to-prefetch-ratio
10557 The minimum ratio between the number of instructions and the
10558 number of prefetches to enable prefetching in a loop.
10560 @item prefetch-min-insn-to-mem-ratio
10561 The minimum ratio between the number of instructions and the
10562 number of memory references to enable prefetching in a loop.
10564 @item use-canonical-types
10565 Whether the compiler should use the ``canonical'' type system.  By
10566 default, this should always be 1, which uses a more efficient internal
10567 mechanism for comparing types in C++ and Objective-C++.  However, if
10568 bugs in the canonical type system are causing compilation failures,
10569 set this value to 0 to disable canonical types.
10571 @item switch-conversion-max-branch-ratio
10572 Switch initialization conversion refuses to create arrays that are
10573 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10574 branches in the switch.
10576 @item max-partial-antic-length
10577 Maximum length of the partial antic set computed during the tree
10578 partial redundancy elimination optimization (@option{-ftree-pre}) when
10579 optimizing at @option{-O3} and above.  For some sorts of source code
10580 the enhanced partial redundancy elimination optimization can run away,
10581 consuming all of the memory available on the host machine.  This
10582 parameter sets a limit on the length of the sets that are computed,
10583 which prevents the runaway behavior.  Setting a value of 0 for
10584 this parameter allows an unlimited set length.
10586 @item sccvn-max-scc-size
10587 Maximum size of a strongly connected component (SCC) during SCCVN
10588 processing.  If this limit is hit, SCCVN processing for the whole
10589 function is not done and optimizations depending on it are
10590 disabled.  The default maximum SCC size is 10000.
10592 @item sccvn-max-alias-queries-per-access
10593 Maximum number of alias-oracle queries we perform when looking for
10594 redundancies for loads and stores.  If this limit is hit the search
10595 is aborted and the load or store is not considered redundant.  The
10596 number of queries is algorithmically limited to the number of
10597 stores on all paths from the load to the function entry.
10598 The default maximum number of queries is 1000.
10600 @item ira-max-loops-num
10601 IRA uses regional register allocation by default.  If a function
10602 contains more loops than the number given by this parameter, only at most
10603 the given number of the most frequently-executed loops form regions
10604 for regional register allocation.  The default value of the
10605 parameter is 100.
10607 @item ira-max-conflict-table-size 
10608 Although IRA uses a sophisticated algorithm to compress the conflict
10609 table, the table can still require excessive amounts of memory for
10610 huge functions.  If the conflict table for a function could be more
10611 than the size in MB given by this parameter, the register allocator
10612 instead uses a faster, simpler, and lower-quality
10613 algorithm that does not require building a pseudo-register conflict table.  
10614 The default value of the parameter is 2000.
10616 @item ira-loop-reserved-regs
10617 IRA can be used to evaluate more accurate register pressure in loops
10618 for decisions to move loop invariants (see @option{-O3}).  The number
10619 of available registers reserved for some other purposes is given
10620 by this parameter.  The default value of the parameter is 2, which is
10621 the minimal number of registers needed by typical instructions.
10622 This value is the best found from numerous experiments.
10624 @item lra-inheritance-ebb-probability-cutoff
10625 LRA tries to reuse values reloaded in registers in subsequent insns.
10626 This optimization is called inheritance.  EBB is used as a region to
10627 do this optimization.  The parameter defines a minimal fall-through
10628 edge probability in percentage used to add BB to inheritance EBB in
10629 LRA.  The default value of the parameter is 40.  The value was chosen
10630 from numerous runs of SPEC2000 on x86-64.
10632 @item loop-invariant-max-bbs-in-loop
10633 Loop invariant motion can be very expensive, both in compilation time and
10634 in amount of needed compile-time memory, with very large loops.  Loops
10635 with more basic blocks than this parameter won't have loop invariant
10636 motion optimization performed on them.  The default value of the
10637 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10639 @item loop-max-datarefs-for-datadeps
10640 Building data dependencies is expensive for very large loops.  This
10641 parameter limits the number of data references in loops that are
10642 considered for data dependence analysis.  These large loops are no
10643 handled by the optimizations using loop data dependencies.
10644 The default value is 1000.
10646 @item max-vartrack-size
10647 Sets a maximum number of hash table slots to use during variable
10648 tracking dataflow analysis of any function.  If this limit is exceeded
10649 with variable tracking at assignments enabled, analysis for that
10650 function is retried without it, after removing all debug insns from
10651 the function.  If the limit is exceeded even without debug insns, var
10652 tracking analysis is completely disabled for the function.  Setting
10653 the parameter to zero makes it unlimited.
10655 @item max-vartrack-expr-depth
10656 Sets a maximum number of recursion levels when attempting to map
10657 variable names or debug temporaries to value expressions.  This trades
10658 compilation time for more complete debug information.  If this is set too
10659 low, value expressions that are available and could be represented in
10660 debug information may end up not being used; setting this higher may
10661 enable the compiler to find more complex debug expressions, but compile
10662 time and memory use may grow.  The default is 12.
10664 @item max-debug-marker-count
10665 Sets a threshold on the number of debug markers (e.g. begin stmt
10666 markers) to avoid complexity explosion at inlining or expanding to RTL.
10667 If a function has more such gimple stmts than the set limit, such stmts
10668 will be dropped from the inlined copy of a function, and from its RTL
10669 expansion.  The default is 100000.
10671 @item min-nondebug-insn-uid
10672 Use uids starting at this parameter for nondebug insns.  The range below
10673 the parameter is reserved exclusively for debug insns created by
10674 @option{-fvar-tracking-assignments}, but debug insns may get
10675 (non-overlapping) uids above it if the reserved range is exhausted.
10677 @item ipa-sra-ptr-growth-factor
10678 IPA-SRA replaces a pointer to an aggregate with one or more new
10679 parameters only when their cumulative size is less or equal to
10680 @option{ipa-sra-ptr-growth-factor} times the size of the original
10681 pointer parameter.
10683 @item sra-max-scalarization-size-Ospeed
10684 @item sra-max-scalarization-size-Osize
10685 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10686 replace scalar parts of aggregates with uses of independent scalar
10687 variables.  These parameters control the maximum size, in storage units,
10688 of aggregate which is considered for replacement when compiling for
10689 speed
10690 (@option{sra-max-scalarization-size-Ospeed}) or size
10691 (@option{sra-max-scalarization-size-Osize}) respectively.
10693 @item tm-max-aggregate-size
10694 When making copies of thread-local variables in a transaction, this
10695 parameter specifies the size in bytes after which variables are
10696 saved with the logging functions as opposed to save/restore code
10697 sequence pairs.  This option only applies when using
10698 @option{-fgnu-tm}.
10700 @item graphite-max-nb-scop-params
10701 To avoid exponential effects in the Graphite loop transforms, the
10702 number of parameters in a Static Control Part (SCoP) is bounded.  The
10703 default value is 10 parameters, a value of zero can be used to lift
10704 the bound.  A variable whose value is unknown at compilation time and
10705 defined outside a SCoP is a parameter of the SCoP.
10707 @item loop-block-tile-size
10708 Loop blocking or strip mining transforms, enabled with
10709 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10710 loop in the loop nest by a given number of iterations.  The strip
10711 length can be changed using the @option{loop-block-tile-size}
10712 parameter.  The default value is 51 iterations.
10714 @item loop-unroll-jam-size
10715 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10716 default value is 4.
10718 @item loop-unroll-jam-depth
10719 Specify the dimension to be unrolled (counting from the most inner loop)
10720 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10722 @item ipa-cp-value-list-size
10723 IPA-CP attempts to track all possible values and types passed to a function's
10724 parameter in order to propagate them and perform devirtualization.
10725 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10726 stores per one formal parameter of a function.
10728 @item ipa-cp-eval-threshold
10729 IPA-CP calculates its own score of cloning profitability heuristics
10730 and performs those cloning opportunities with scores that exceed
10731 @option{ipa-cp-eval-threshold}.
10733 @item ipa-cp-recursion-penalty
10734 Percentage penalty the recursive functions will receive when they
10735 are evaluated for cloning.
10737 @item ipa-cp-single-call-penalty
10738 Percentage penalty functions containing a single call to another
10739 function will receive when they are evaluated for cloning.
10742 @item ipa-max-agg-items
10743 IPA-CP is also capable to propagate a number of scalar values passed
10744 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10745 number of such values per one parameter.
10747 @item ipa-cp-loop-hint-bonus
10748 When IPA-CP determines that a cloning candidate would make the number
10749 of iterations of a loop known, it adds a bonus of
10750 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10751 the candidate.
10753 @item ipa-cp-array-index-hint-bonus
10754 When IPA-CP determines that a cloning candidate would make the index of
10755 an array access known, it adds a bonus of
10756 @option{ipa-cp-array-index-hint-bonus} to the profitability
10757 score of the candidate.
10759 @item ipa-max-aa-steps
10760 During its analysis of function bodies, IPA-CP employs alias analysis
10761 in order to track values pointed to by function parameters.  In order
10762 not spend too much time analyzing huge functions, it gives up and
10763 consider all memory clobbered after examining
10764 @option{ipa-max-aa-steps} statements modifying memory.
10766 @item lto-partitions
10767 Specify desired number of partitions produced during WHOPR compilation.
10768 The number of partitions should exceed the number of CPUs used for compilation.
10769 The default value is 32.
10771 @item lto-min-partition
10772 Size of minimal partition for WHOPR (in estimated instructions).
10773 This prevents expenses of splitting very small programs into too many
10774 partitions.
10776 @item lto-max-partition
10777 Size of max partition for WHOPR (in estimated instructions).
10778 to provide an upper bound for individual size of partition.
10779 Meant to be used only with balanced partitioning.
10781 @item cxx-max-namespaces-for-diagnostic-help
10782 The maximum number of namespaces to consult for suggestions when C++
10783 name lookup fails for an identifier.  The default is 1000.
10785 @item sink-frequency-threshold
10786 The maximum relative execution frequency (in percents) of the target block
10787 relative to a statement's original block to allow statement sinking of a
10788 statement.  Larger numbers result in more aggressive statement sinking.
10789 The default value is 75.  A small positive adjustment is applied for
10790 statements with memory operands as those are even more profitable so sink.
10792 @item max-stores-to-sink
10793 The maximum number of conditional store pairs that can be sunk.  Set to 0
10794 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10795 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10797 @item allow-store-data-races
10798 Allow optimizers to introduce new data races on stores.
10799 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10800 at optimization level @option{-Ofast}.
10802 @item case-values-threshold
10803 The smallest number of different values for which it is best to use a
10804 jump-table instead of a tree of conditional branches.  If the value is
10805 0, use the default for the machine.  The default is 0.
10807 @item tree-reassoc-width
10808 Set the maximum number of instructions executed in parallel in
10809 reassociated tree. This parameter overrides target dependent
10810 heuristics used by default if has non zero value.
10812 @item sched-pressure-algorithm
10813 Choose between the two available implementations of
10814 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10815 and is the more likely to prevent instructions from being reordered.
10816 Algorithm 2 was designed to be a compromise between the relatively
10817 conservative approach taken by algorithm 1 and the rather aggressive
10818 approach taken by the default scheduler.  It relies more heavily on
10819 having a regular register file and accurate register pressure classes.
10820 See @file{haifa-sched.c} in the GCC sources for more details.
10822 The default choice depends on the target.
10824 @item max-slsr-cand-scan
10825 Set the maximum number of existing candidates that are considered when
10826 seeking a basis for a new straight-line strength reduction candidate.
10828 @item asan-globals
10829 Enable buffer overflow detection for global objects.  This kind
10830 of protection is enabled by default if you are using
10831 @option{-fsanitize=address} option.
10832 To disable global objects protection use @option{--param asan-globals=0}.
10834 @item asan-stack
10835 Enable buffer overflow detection for stack objects.  This kind of
10836 protection is enabled by default when using @option{-fsanitize=address}.
10837 To disable stack protection use @option{--param asan-stack=0} option.
10839 @item asan-instrument-reads
10840 Enable buffer overflow detection for memory reads.  This kind of
10841 protection is enabled by default when using @option{-fsanitize=address}.
10842 To disable memory reads protection use
10843 @option{--param asan-instrument-reads=0}.
10845 @item asan-instrument-writes
10846 Enable buffer overflow detection for memory writes.  This kind of
10847 protection is enabled by default when using @option{-fsanitize=address}.
10848 To disable memory writes protection use
10849 @option{--param asan-instrument-writes=0} option.
10851 @item asan-memintrin
10852 Enable detection for built-in functions.  This kind of protection
10853 is enabled by default when using @option{-fsanitize=address}.
10854 To disable built-in functions protection use
10855 @option{--param asan-memintrin=0}.
10857 @item asan-use-after-return
10858 Enable detection of use-after-return.  This kind of protection
10859 is enabled by default when using the @option{-fsanitize=address} option.
10860 To disable it use @option{--param asan-use-after-return=0}.
10862 Note: By default the check is disabled at run time.  To enable it,
10863 add @code{detect_stack_use_after_return=1} to the environment variable
10864 @env{ASAN_OPTIONS}.
10866 @item asan-instrumentation-with-call-threshold
10867 If number of memory accesses in function being instrumented
10868 is greater or equal to this number, use callbacks instead of inline checks.
10869 E.g. to disable inline code use
10870 @option{--param asan-instrumentation-with-call-threshold=0}.
10872 @item use-after-scope-direct-emission-threshold
10873 If the size of a local variable in bytes is smaller or equal to this
10874 number, directly poison (or unpoison) shadow memory instead of using
10875 run-time callbacks.  The default value is 256.
10877 @item chkp-max-ctor-size
10878 Static constructors generated by Pointer Bounds Checker may become very
10879 large and significantly increase compile time at optimization level
10880 @option{-O1} and higher.  This parameter is a maximum number of statements
10881 in a single generated constructor.  Default value is 5000.
10883 @item max-fsm-thread-path-insns
10884 Maximum number of instructions to copy when duplicating blocks on a
10885 finite state automaton jump thread path.  The default is 100.
10887 @item max-fsm-thread-length
10888 Maximum number of basic blocks on a finite state automaton jump thread
10889 path.  The default is 10.
10891 @item max-fsm-thread-paths
10892 Maximum number of new jump thread paths to create for a finite state
10893 automaton.  The default is 50.
10895 @item parloops-chunk-size
10896 Chunk size of omp schedule for loops parallelized by parloops.  The default
10897 is 0.
10899 @item parloops-schedule
10900 Schedule type of omp schedule for loops parallelized by parloops (static,
10901 dynamic, guided, auto, runtime).  The default is static.
10903 @item parloops-min-per-thread
10904 The minimum number of iterations per thread of an innermost parallelized
10905 loop for which the parallelized variant is prefered over the single threaded
10906 one.  The default is 100.  Note that for a parallelized loop nest the
10907 minimum number of iterations of the outermost loop per thread is two.
10909 @item max-ssa-name-query-depth
10910 Maximum depth of recursion when querying properties of SSA names in things
10911 like fold routines.  One level of recursion corresponds to following a
10912 use-def chain.
10914 @item hsa-gen-debug-stores
10915 Enable emission of special debug stores within HSA kernels which are
10916 then read and reported by libgomp plugin.  Generation of these stores
10917 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10918 enable it.
10920 @item max-speculative-devirt-maydefs
10921 The maximum number of may-defs we analyze when looking for a must-def
10922 specifying the dynamic type of an object that invokes a virtual call
10923 we may be able to devirtualize speculatively.
10925 @item max-vrp-switch-assertions
10926 The maximum number of assertions to add along the default edge of a switch
10927 statement during VRP.  The default is 10.
10929 @item unroll-jam-min-percent
10930 The minimum percentage of memory references that must be optimized
10931 away for the unroll-and-jam transformation to be considered profitable.
10933 @item unroll-jam-max-unroll
10934 The maximum number of times the outer loop should be unrolled by
10935 the unroll-and-jam transformation.
10936 @end table
10937 @end table
10939 @node Instrumentation Options
10940 @section Program Instrumentation Options
10941 @cindex instrumentation options
10942 @cindex program instrumentation options
10943 @cindex run-time error checking options
10944 @cindex profiling options
10945 @cindex options, program instrumentation
10946 @cindex options, run-time error checking
10947 @cindex options, profiling
10949 GCC supports a number of command-line options that control adding
10950 run-time instrumentation to the code it normally generates.  
10951 For example, one purpose of instrumentation is collect profiling
10952 statistics for use in finding program hot spots, code coverage
10953 analysis, or profile-guided optimizations.
10954 Another class of program instrumentation is adding run-time checking 
10955 to detect programming errors like invalid pointer
10956 dereferences or out-of-bounds array accesses, as well as deliberately
10957 hostile attacks such as stack smashing or C++ vtable hijacking.
10958 There is also a general hook which can be used to implement other
10959 forms of tracing or function-level instrumentation for debug or
10960 program analysis purposes.
10962 @table @gcctabopt
10963 @cindex @command{prof}
10964 @item -p
10965 @opindex p
10966 Generate extra code to write profile information suitable for the
10967 analysis program @command{prof}.  You must use this option when compiling
10968 the source files you want data about, and you must also use it when
10969 linking.
10971 @cindex @command{gprof}
10972 @item -pg
10973 @opindex pg
10974 Generate extra code to write profile information suitable for the
10975 analysis program @command{gprof}.  You must use this option when compiling
10976 the source files you want data about, and you must also use it when
10977 linking.
10979 @item -fprofile-arcs
10980 @opindex fprofile-arcs
10981 Add code so that program flow @dfn{arcs} are instrumented.  During
10982 execution the program records how many times each branch and call is
10983 executed and how many times it is taken or returns.  On targets that support
10984 constructors with priority support, profiling properly handles constructors,
10985 destructors and C++ constructors (and destructors) of classes which are used
10986 as a type of a global variable.
10988 When the compiled
10989 program exits it saves this data to a file called
10990 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10991 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10992 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10993 @var{auxname} is generated from the name of the output file, if
10994 explicitly specified and it is not the final executable, otherwise it is
10995 the basename of the source file.  In both cases any suffix is removed
10996 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10997 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10998 @xref{Cross-profiling}.
11000 @cindex @command{gcov}
11001 @item --coverage
11002 @opindex coverage
11004 This option is used to compile and link code instrumented for coverage
11005 analysis.  The option is a synonym for @option{-fprofile-arcs}
11006 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11007 linking).  See the documentation for those options for more details.
11009 @itemize
11011 @item
11012 Compile the source files with @option{-fprofile-arcs} plus optimization
11013 and code generation options.  For test coverage analysis, use the
11014 additional @option{-ftest-coverage} option.  You do not need to profile
11015 every source file in a program.
11017 @item
11018 Compile the source files additionally with @option{-fprofile-abs-path}
11019 to create absolute path names in the @file{.gcno} files.  This allows
11020 @command{gcov} to find the correct sources in projects where compilations
11021 occur with different working directories.
11023 @item
11024 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11025 (the latter implies the former).
11027 @item
11028 Run the program on a representative workload to generate the arc profile
11029 information.  This may be repeated any number of times.  You can run
11030 concurrent instances of your program, and provided that the file system
11031 supports locking, the data files will be correctly updated.  Unless
11032 a strict ISO C dialect option is in effect, @code{fork} calls are
11033 detected and correctly handled without double counting.
11035 @item
11036 For profile-directed optimizations, compile the source files again with
11037 the same optimization and code generation options plus
11038 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11039 Control Optimization}).
11041 @item
11042 For test coverage analysis, use @command{gcov} to produce human readable
11043 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11044 @command{gcov} documentation for further information.
11046 @end itemize
11048 With @option{-fprofile-arcs}, for each function of your program GCC
11049 creates a program flow graph, then finds a spanning tree for the graph.
11050 Only arcs that are not on the spanning tree have to be instrumented: the
11051 compiler adds code to count the number of times that these arcs are
11052 executed.  When an arc is the only exit or only entrance to a block, the
11053 instrumentation code can be added to the block; otherwise, a new basic
11054 block must be created to hold the instrumentation code.
11056 @need 2000
11057 @item -ftest-coverage
11058 @opindex ftest-coverage
11059 Produce a notes file that the @command{gcov} code-coverage utility
11060 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11061 show program coverage.  Each source file's note file is called
11062 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11063 above for a description of @var{auxname} and instructions on how to
11064 generate test coverage data.  Coverage data matches the source files
11065 more closely if you do not optimize.
11067 @item -fprofile-abs-path
11068 @opindex fprofile-abs-path
11069 Automatically convert relative source file names to absolute path names
11070 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11071 sources in projects where compilations occur with different working
11072 directories.
11074 @item -fprofile-dir=@var{path}
11075 @opindex fprofile-dir
11077 Set the directory to search for the profile data files in to @var{path}.
11078 This option affects only the profile data generated by
11079 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11080 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11081 and its related options.  Both absolute and relative paths can be used.
11082 By default, GCC uses the current directory as @var{path}, thus the
11083 profile data file appears in the same directory as the object file.
11085 @item -fprofile-generate
11086 @itemx -fprofile-generate=@var{path}
11087 @opindex fprofile-generate
11089 Enable options usually used for instrumenting application to produce
11090 profile useful for later recompilation with profile feedback based
11091 optimization.  You must use @option{-fprofile-generate} both when
11092 compiling and when linking your program.
11094 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11096 If @var{path} is specified, GCC looks at the @var{path} to find
11097 the profile feedback data files. See @option{-fprofile-dir}.
11099 To optimize the program based on the collected profile information, use
11100 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11102 @item -fprofile-update=@var{method}
11103 @opindex fprofile-update
11105 Alter the update method for an application instrumented for profile
11106 feedback based optimization.  The @var{method} argument should be one of
11107 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11108 The first one is useful for single-threaded applications,
11109 while the second one prevents profile corruption by emitting thread-safe code.
11111 @strong{Warning:} When an application does not properly join all threads
11112 (or creates an detached thread), a profile file can be still corrupted.
11114 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11115 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11116 automatically selects @samp{prefer-atomic} when @option{-pthread}
11117 is present in the command line.
11119 @item -fsanitize=address
11120 @opindex fsanitize=address
11121 Enable AddressSanitizer, a fast memory error detector.
11122 Memory access instructions are instrumented to detect
11123 out-of-bounds and use-after-free bugs.
11124 The option enables @option{-fsanitize-address-use-after-scope}.
11125 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11126 more details.  The run-time behavior can be influenced using the
11127 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11128 the available options are shown at startup of the instrumented program.  See
11129 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11130 for a list of supported options.
11131 The option cannot be combined with @option{-fsanitize=thread}
11132 and/or @option{-fcheck-pointer-bounds}.
11134 @item -fsanitize=kernel-address
11135 @opindex fsanitize=kernel-address
11136 Enable AddressSanitizer for Linux kernel.
11137 See @uref{https://github.com/google/kasan/wiki} for more details.
11138 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11140 @item -fsanitize=pointer-compare
11141 @opindex fsanitize=pointer-compare
11142 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11143 The option must be combined with either @option{-fsanitize=kernel-address} or
11144 @option{-fsanitize=address}
11145 The option cannot be combined with @option{-fsanitize=thread}
11146 and/or @option{-fcheck-pointer-bounds}.
11147 Note: By default the check is disabled at run time.  To enable it,
11148 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11149 @env{ASAN_OPTIONS}.
11151 @item -fsanitize=pointer-subtract
11152 @opindex fsanitize=pointer-subtract
11153 Instrument subtraction with pointer operands.
11154 The option must be combined with either @option{-fsanitize=kernel-address} or
11155 @option{-fsanitize=address}
11156 The option cannot be combined with @option{-fsanitize=thread}
11157 and/or @option{-fcheck-pointer-bounds}.
11158 Note: By default the check is disabled at run time.  To enable it,
11159 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11160 @env{ASAN_OPTIONS}.
11162 @item -fsanitize=thread
11163 @opindex fsanitize=thread
11164 Enable ThreadSanitizer, a fast data race detector.
11165 Memory access instructions are instrumented to detect
11166 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11167 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11168 environment variable; see
11169 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11170 supported options.
11171 The option cannot be combined with @option{-fsanitize=address},
11172 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11174 Note that sanitized atomic builtins cannot throw exceptions when
11175 operating on invalid memory addresses with non-call exceptions
11176 (@option{-fnon-call-exceptions}).
11178 @item -fsanitize=leak
11179 @opindex fsanitize=leak
11180 Enable LeakSanitizer, a memory leak detector.
11181 This option only matters for linking of executables and
11182 the executable is linked against a library that overrides @code{malloc}
11183 and other allocator functions.  See
11184 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11185 details.  The run-time behavior can be influenced using the
11186 @env{LSAN_OPTIONS} environment variable.
11187 The option cannot be combined with @option{-fsanitize=thread}.
11189 @item -fsanitize=undefined
11190 @opindex fsanitize=undefined
11191 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11192 Various computations are instrumented to detect undefined behavior
11193 at runtime.  Current suboptions are:
11195 @table @gcctabopt
11197 @item -fsanitize=shift
11198 @opindex fsanitize=shift
11199 This option enables checking that the result of a shift operation is
11200 not undefined.  Note that what exactly is considered undefined differs
11201 slightly between C and C++, as well as between ISO C90 and C99, etc.
11202 This option has two suboptions, @option{-fsanitize=shift-base} and
11203 @option{-fsanitize=shift-exponent}.
11205 @item -fsanitize=shift-exponent
11206 @opindex fsanitize=shift-exponent
11207 This option enables checking that the second argument of a shift operation
11208 is not negative and is smaller than the precision of the promoted first
11209 argument.
11211 @item -fsanitize=shift-base
11212 @opindex fsanitize=shift-base
11213 If the second argument of a shift operation is within range, check that the
11214 result of a shift operation is not undefined.  Note that what exactly is
11215 considered undefined differs slightly between C and C++, as well as between
11216 ISO C90 and C99, etc.
11218 @item -fsanitize=integer-divide-by-zero
11219 @opindex fsanitize=integer-divide-by-zero
11220 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11222 @item -fsanitize=unreachable
11223 @opindex fsanitize=unreachable
11224 With this option, the compiler turns the @code{__builtin_unreachable}
11225 call into a diagnostics message call instead.  When reaching the
11226 @code{__builtin_unreachable} call, the behavior is undefined.
11228 @item -fsanitize=vla-bound
11229 @opindex fsanitize=vla-bound
11230 This option instructs the compiler to check that the size of a variable
11231 length array is positive.
11233 @item -fsanitize=null
11234 @opindex fsanitize=null
11235 This option enables pointer checking.  Particularly, the application
11236 built with this option turned on will issue an error message when it
11237 tries to dereference a NULL pointer, or if a reference (possibly an
11238 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11239 on an object pointed by a NULL pointer.
11241 @item -fsanitize=return
11242 @opindex fsanitize=return
11243 This option enables return statement checking.  Programs
11244 built with this option turned on will issue an error message
11245 when the end of a non-void function is reached without actually
11246 returning a value.  This option works in C++ only.
11248 @item -fsanitize=signed-integer-overflow
11249 @opindex fsanitize=signed-integer-overflow
11250 This option enables signed integer overflow checking.  We check that
11251 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11252 does not overflow in the signed arithmetics.  Note, integer promotion
11253 rules must be taken into account.  That is, the following is not an
11254 overflow:
11255 @smallexample
11256 signed char a = SCHAR_MAX;
11257 a++;
11258 @end smallexample
11260 @item -fsanitize=bounds
11261 @opindex fsanitize=bounds
11262 This option enables instrumentation of array bounds.  Various out of bounds
11263 accesses are detected.  Flexible array members, flexible array member-like
11264 arrays, and initializers of variables with static storage are not instrumented.
11265 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11267 @item -fsanitize=bounds-strict
11268 @opindex fsanitize=bounds-strict
11269 This option enables strict instrumentation of array bounds.  Most out of bounds
11270 accesses are detected, including flexible array members and flexible array
11271 member-like arrays.  Initializers of variables with static storage are not
11272 instrumented.  The option cannot be combined
11273 with @option{-fcheck-pointer-bounds}.
11275 @item -fsanitize=alignment
11276 @opindex fsanitize=alignment
11278 This option enables checking of alignment of pointers when they are
11279 dereferenced, or when a reference is bound to insufficiently aligned target,
11280 or when a method or constructor is invoked on insufficiently aligned object.
11282 @item -fsanitize=object-size
11283 @opindex fsanitize=object-size
11284 This option enables instrumentation of memory references using the
11285 @code{__builtin_object_size} function.  Various out of bounds pointer
11286 accesses are detected.
11288 @item -fsanitize=float-divide-by-zero
11289 @opindex fsanitize=float-divide-by-zero
11290 Detect floating-point division by zero.  Unlike other similar options,
11291 @option{-fsanitize=float-divide-by-zero} is not enabled by
11292 @option{-fsanitize=undefined}, since floating-point division by zero can
11293 be a legitimate way of obtaining infinities and NaNs.
11295 @item -fsanitize=float-cast-overflow
11296 @opindex fsanitize=float-cast-overflow
11297 This option enables floating-point type to integer conversion checking.
11298 We check that the result of the conversion does not overflow.
11299 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11300 not enabled by @option{-fsanitize=undefined}.
11301 This option does not work well with @code{FE_INVALID} exceptions enabled.
11303 @item -fsanitize=nonnull-attribute
11304 @opindex fsanitize=nonnull-attribute
11306 This option enables instrumentation of calls, checking whether null values
11307 are not passed to arguments marked as requiring a non-null value by the
11308 @code{nonnull} function attribute.
11310 @item -fsanitize=returns-nonnull-attribute
11311 @opindex fsanitize=returns-nonnull-attribute
11313 This option enables instrumentation of return statements in functions
11314 marked with @code{returns_nonnull} function attribute, to detect returning
11315 of null values from such functions.
11317 @item -fsanitize=bool
11318 @opindex fsanitize=bool
11320 This option enables instrumentation of loads from bool.  If a value other
11321 than 0/1 is loaded, a run-time error is issued.
11323 @item -fsanitize=enum
11324 @opindex fsanitize=enum
11326 This option enables instrumentation of loads from an enum type.  If
11327 a value outside the range of values for the enum type is loaded,
11328 a run-time error is issued.
11330 @item -fsanitize=vptr
11331 @opindex fsanitize=vptr
11333 This option enables instrumentation of C++ member function calls, member
11334 accesses and some conversions between pointers to base and derived classes,
11335 to verify the referenced object has the correct dynamic type.
11337 @item -fsanitize=pointer-overflow
11338 @opindex fsanitize=pointer-overflow
11340 This option enables instrumentation of pointer arithmetics.  If the pointer
11341 arithmetics overflows, a run-time error is issued.
11343 @item -fsanitize=builtin
11344 @opindex fsanitize=builtin
11346 This option enables instrumentation of arguments to selected builtin
11347 functions.  If an invalid value is passed to such arguments, a run-time
11348 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11349 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11350 by this option.
11352 @end table
11354 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11355 @option{-fsanitize=undefined} gives a diagnostic message.
11356 This currently works only for the C family of languages.
11358 @item -fno-sanitize=all
11359 @opindex fno-sanitize=all
11361 This option disables all previously enabled sanitizers.
11362 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11363 together.
11365 @item -fasan-shadow-offset=@var{number}
11366 @opindex fasan-shadow-offset
11367 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11368 It is useful for experimenting with different shadow memory layouts in
11369 Kernel AddressSanitizer.
11371 @item -fsanitize-sections=@var{s1},@var{s2},...
11372 @opindex fsanitize-sections
11373 Sanitize global variables in selected user-defined sections.  @var{si} may
11374 contain wildcards.
11376 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11377 @opindex fsanitize-recover
11378 @opindex fno-sanitize-recover
11379 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11380 mentioned in comma-separated list of @var{opts}.  Enabling this option
11381 for a sanitizer component causes it to attempt to continue
11382 running the program as if no error happened.  This means multiple
11383 runtime errors can be reported in a single program run, and the exit
11384 code of the program may indicate success even when errors
11385 have been reported.  The @option{-fno-sanitize-recover=} option
11386 can be used to alter
11387 this behavior: only the first detected error is reported
11388 and program then exits with a non-zero exit code.
11390 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11391 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11392 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11393 @option{-fsanitize=bounds-strict},
11394 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11395 For these sanitizers error recovery is turned on by default,
11396 except @option{-fsanitize=address}, for which this feature is experimental.
11397 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11398 accepted, the former enables recovery for all sanitizers that support it,
11399 the latter disables recovery for all sanitizers that support it.
11401 Even if a recovery mode is turned on the compiler side, it needs to be also
11402 enabled on the runtime library side, otherwise the failures are still fatal.
11403 The runtime library defaults to @code{halt_on_error=0} for
11404 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11405 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11406 setting the @code{halt_on_error} flag in the corresponding environment variable.
11408 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11409 equivalent to specifying an @var{opts} list of:
11411 @smallexample
11412 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11413 @end smallexample
11415 @item -fsanitize-address-use-after-scope
11416 @opindex fsanitize-address-use-after-scope
11417 Enable sanitization of local variables to detect use-after-scope bugs.
11418 The option sets @option{-fstack-reuse} to @samp{none}.
11420 @item -fsanitize-undefined-trap-on-error
11421 @opindex fsanitize-undefined-trap-on-error
11422 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11423 report undefined behavior using @code{__builtin_trap} rather than
11424 a @code{libubsan} library routine.  The advantage of this is that the
11425 @code{libubsan} library is not needed and is not linked in, so this
11426 is usable even in freestanding environments.
11428 @item -fsanitize-coverage=trace-pc
11429 @opindex fsanitize-coverage=trace-pc
11430 Enable coverage-guided fuzzing code instrumentation.
11431 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11433 @item -fsanitize-coverage=trace-cmp
11434 @opindex fsanitize-coverage=trace-cmp
11435 Enable dataflow guided fuzzing code instrumentation.
11436 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11437 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11438 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11439 variable or @code{__sanitizer_cov_trace_const_cmp1},
11440 @code{__sanitizer_cov_trace_const_cmp2},
11441 @code{__sanitizer_cov_trace_const_cmp4} or
11442 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11443 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11444 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11445 @code{__sanitizer_cov_trace_switch} for switch statements.
11447 @item -fbounds-check
11448 @opindex fbounds-check
11449 For front ends that support it, generate additional code to check that
11450 indices used to access arrays are within the declared range.  This is
11451 currently only supported by the Fortran front end, where this option
11452 defaults to false.
11454 @item -fcheck-pointer-bounds
11455 @opindex fcheck-pointer-bounds
11456 @opindex fno-check-pointer-bounds
11457 @cindex Pointer Bounds Checker options
11458 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11459 is instrumented with checks of the pointer used for memory access against
11460 bounds associated with that pointer.  
11462 Currently there
11463 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11464 and @option{-mmpx} are required to enable this feature.  
11465 MPX-based instrumentation requires
11466 a runtime library to enable MPX in hardware and handle bounds
11467 violation signals.  By default when @option{-fcheck-pointer-bounds}
11468 and @option{-mmpx} options are used to link a program, the GCC driver
11469 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11470 Bounds checking on calls to dynamic libraries requires a linker
11471 with @option{-z bndplt} support; if GCC was configured with a linker
11472 without support for this option (including the Gold linker and older
11473 versions of ld), a warning is given if you link with @option{-mmpx}
11474 without also specifying @option{-static}, since the overall effectiveness
11475 of the bounds checking protection is reduced.
11476 See also @option{-static-libmpxwrappers}.
11478 MPX-based instrumentation
11479 may be used for debugging and also may be included in production code
11480 to increase program security.  Depending on usage, you may
11481 have different requirements for the runtime library.  The current version
11482 of the MPX runtime library is more oriented for use as a debugging
11483 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11484 also @option{-static-libmpx}.  The runtime library  behavior can be
11485 influenced using various @env{CHKP_RT_*} environment variables.  See
11486 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11487 for more details.
11489 Generated instrumentation may be controlled by various
11490 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11491 structure field attribute (@pxref{Type Attributes}) and
11492 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11493 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11494 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11495 Bounds Checker builtins}, for more information.
11497 @item -fchkp-check-incomplete-type
11498 @opindex fchkp-check-incomplete-type
11499 @opindex fno-chkp-check-incomplete-type
11500 Generate pointer bounds checks for variables with incomplete type.
11501 Enabled by default.
11503 @item -fchkp-narrow-bounds
11504 @opindex fchkp-narrow-bounds
11505 @opindex fno-chkp-narrow-bounds
11506 Controls bounds used by Pointer Bounds Checker for pointers to object
11507 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11508 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11509 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11511 @item -fchkp-first-field-has-own-bounds
11512 @opindex fchkp-first-field-has-own-bounds
11513 @opindex fno-chkp-first-field-has-own-bounds
11514 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11515 first field in the structure.  By default a pointer to the first field has
11516 the same bounds as a pointer to the whole structure.
11518 @item -fchkp-flexible-struct-trailing-arrays
11519 @opindex fchkp-flexible-struct-trailing-arrays
11520 @opindex fno-chkp-flexible-struct-trailing-arrays
11521 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11522 possibly flexible.  By default only array fields with zero length or that are
11523 marked with attribute bnd_variable_size are treated as flexible.
11525 @item -fchkp-narrow-to-innermost-array
11526 @opindex fchkp-narrow-to-innermost-array
11527 @opindex fno-chkp-narrow-to-innermost-array
11528 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11529 case of nested static array access.  By default this option is disabled and
11530 bounds of the outermost array are used.
11532 @item -fchkp-optimize
11533 @opindex fchkp-optimize
11534 @opindex fno-chkp-optimize
11535 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11536 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11538 @item -fchkp-use-fast-string-functions
11539 @opindex fchkp-use-fast-string-functions
11540 @opindex fno-chkp-use-fast-string-functions
11541 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11542 by Pointer Bounds Checker.  Disabled by default.
11544 @item -fchkp-use-nochk-string-functions
11545 @opindex fchkp-use-nochk-string-functions
11546 @opindex fno-chkp-use-nochk-string-functions
11547 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11548 by Pointer Bounds Checker.  Disabled by default.
11550 @item -fchkp-use-static-bounds
11551 @opindex fchkp-use-static-bounds
11552 @opindex fno-chkp-use-static-bounds
11553 Allow Pointer Bounds Checker to generate static bounds holding
11554 bounds of static variables.  Enabled by default.
11556 @item -fchkp-use-static-const-bounds
11557 @opindex fchkp-use-static-const-bounds
11558 @opindex fno-chkp-use-static-const-bounds
11559 Use statically-initialized bounds for constant bounds instead of
11560 generating them each time they are required.  By default enabled when
11561 @option{-fchkp-use-static-bounds} is enabled.
11563 @item -fchkp-treat-zero-dynamic-size-as-infinite
11564 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11565 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11566 With this option, objects with incomplete type whose
11567 dynamically-obtained size is zero are treated as having infinite size
11568 instead by Pointer Bounds
11569 Checker.  This option may be helpful if a program is linked with a library
11570 missing size information for some symbols.  Disabled by default.
11572 @item -fchkp-check-read
11573 @opindex fchkp-check-read
11574 @opindex fno-chkp-check-read
11575 Instructs Pointer Bounds Checker to generate checks for all read
11576 accesses to memory.  Enabled by default.
11578 @item -fchkp-check-write
11579 @opindex fchkp-check-write
11580 @opindex fno-chkp-check-write
11581 Instructs Pointer Bounds Checker to generate checks for all write
11582 accesses to memory.  Enabled by default.
11584 @item -fchkp-store-bounds
11585 @opindex fchkp-store-bounds
11586 @opindex fno-chkp-store-bounds
11587 Instructs Pointer Bounds Checker to generate bounds stores for
11588 pointer writes.  Enabled by default.
11590 @item -fchkp-instrument-calls
11591 @opindex fchkp-instrument-calls
11592 @opindex fno-chkp-instrument-calls
11593 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11594 Enabled by default.
11596 @item -fchkp-instrument-marked-only
11597 @opindex fchkp-instrument-marked-only
11598 @opindex fno-chkp-instrument-marked-only
11599 Instructs Pointer Bounds Checker to instrument only functions
11600 marked with the @code{bnd_instrument} attribute
11601 (@pxref{Function Attributes}).  Disabled by default.
11603 @item -fchkp-use-wrappers
11604 @opindex fchkp-use-wrappers
11605 @opindex fno-chkp-use-wrappers
11606 Allows Pointer Bounds Checker to replace calls to built-in functions
11607 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11608 is used to link a program, the GCC driver automatically links
11609 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11610 Enabled by default.
11612 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11613 @opindex fcf-protection
11614 Enable code instrumentation of control-flow transfers to increase
11615 program security by checking that target addresses of control-flow
11616 transfer instructions (such as indirect function call, function return,
11617 indirect jump) are valid.  This prevents diverting the flow of control
11618 to an unexpected target.  This is intended to protect against such
11619 threats as Return-oriented Programming (ROP), and similarly
11620 call/jmp-oriented programming (COP/JOP).
11622 The value @code{branch} tells the compiler to implement checking of
11623 validity of control-flow transfer at the point of indirect branch
11624 instructions, i.e. call/jmp instructions.  The value @code{return}
11625 implements checking of validity at the point of returning from a
11626 function.  The value @code{full} is an alias for specifying both
11627 @code{branch} and @code{return}. The value @code{none} turns off
11628 instrumentation.
11630 You can also use the @code{nocf_check} attribute to identify
11631 which functions and calls should be skipped from instrumentation
11632 (@pxref{Function Attributes}).
11634 Currently the x86 GNU/Linux target provides an implementation based
11635 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11636 for x86 is controlled by target-specific options @option{-mcet},
11637 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11639 @item -fstack-protector
11640 @opindex fstack-protector
11641 Emit extra code to check for buffer overflows, such as stack smashing
11642 attacks.  This is done by adding a guard variable to functions with
11643 vulnerable objects.  This includes functions that call @code{alloca}, and
11644 functions with buffers larger than 8 bytes.  The guards are initialized
11645 when a function is entered and then checked when the function exits.
11646 If a guard check fails, an error message is printed and the program exits.
11648 @item -fstack-protector-all
11649 @opindex fstack-protector-all
11650 Like @option{-fstack-protector} except that all functions are protected.
11652 @item -fstack-protector-strong
11653 @opindex fstack-protector-strong
11654 Like @option{-fstack-protector} but includes additional functions to
11655 be protected --- those that have local array definitions, or have
11656 references to local frame addresses.
11658 @item -fstack-protector-explicit
11659 @opindex fstack-protector-explicit
11660 Like @option{-fstack-protector} but only protects those functions which
11661 have the @code{stack_protect} attribute.
11663 @item -fstack-check
11664 @opindex fstack-check
11665 Generate code to verify that you do not go beyond the boundary of the
11666 stack.  You should specify this flag if you are running in an
11667 environment with multiple threads, but you only rarely need to specify it in
11668 a single-threaded environment since stack overflow is automatically
11669 detected on nearly all systems if there is only one stack.
11671 Note that this switch does not actually cause checking to be done; the
11672 operating system or the language runtime must do that.  The switch causes
11673 generation of code to ensure that they see the stack being extended.
11675 You can additionally specify a string parameter: @samp{no} means no
11676 checking, @samp{generic} means force the use of old-style checking,
11677 @samp{specific} means use the best checking method and is equivalent
11678 to bare @option{-fstack-check}.
11680 Old-style checking is a generic mechanism that requires no specific
11681 target support in the compiler but comes with the following drawbacks:
11683 @enumerate
11684 @item
11685 Modified allocation strategy for large objects: they are always
11686 allocated dynamically if their size exceeds a fixed threshold.  Note this
11687 may change the semantics of some code.
11689 @item
11690 Fixed limit on the size of the static frame of functions: when it is
11691 topped by a particular function, stack checking is not reliable and
11692 a warning is issued by the compiler.
11694 @item
11695 Inefficiency: because of both the modified allocation strategy and the
11696 generic implementation, code performance is hampered.
11697 @end enumerate
11699 Note that old-style stack checking is also the fallback method for
11700 @samp{specific} if no target support has been added in the compiler.
11702 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11703 and stack overflows.  @samp{specific} is an excellent choice when compiling
11704 Ada code.  It is not generally sufficient to protect against stack-clash
11705 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11707 @item -fstack-clash-protection
11708 @opindex fstack-clash-protection
11709 Generate code to prevent stack clash style attacks.  When this option is
11710 enabled, the compiler will only allocate one page of stack space at a time
11711 and each page is accessed immediately after allocation.  Thus, it prevents
11712 allocations from jumping over any stack guard page provided by the
11713 operating system.
11715 Most targets do not fully support stack clash protection.  However, on
11716 those targets @option{-fstack-clash-protection} will protect dynamic stack
11717 allocations.  @option{-fstack-clash-protection} may also provide limited
11718 protection for static stack allocations if the target supports
11719 @option{-fstack-check=specific}.
11721 @item -fstack-limit-register=@var{reg}
11722 @itemx -fstack-limit-symbol=@var{sym}
11723 @itemx -fno-stack-limit
11724 @opindex fstack-limit-register
11725 @opindex fstack-limit-symbol
11726 @opindex fno-stack-limit
11727 Generate code to ensure that the stack does not grow beyond a certain value,
11728 either the value of a register or the address of a symbol.  If a larger
11729 stack is required, a signal is raised at run time.  For most targets,
11730 the signal is raised before the stack overruns the boundary, so
11731 it is possible to catch the signal without taking special precautions.
11733 For instance, if the stack starts at absolute address @samp{0x80000000}
11734 and grows downwards, you can use the flags
11735 @option{-fstack-limit-symbol=__stack_limit} and
11736 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11737 of 128KB@.  Note that this may only work with the GNU linker.
11739 You can locally override stack limit checking by using the
11740 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11742 @item -fsplit-stack
11743 @opindex fsplit-stack
11744 Generate code to automatically split the stack before it overflows.
11745 The resulting program has a discontiguous stack which can only
11746 overflow if the program is unable to allocate any more memory.  This
11747 is most useful when running threaded programs, as it is no longer
11748 necessary to calculate a good stack size to use for each thread.  This
11749 is currently only implemented for the x86 targets running
11750 GNU/Linux.
11752 When code compiled with @option{-fsplit-stack} calls code compiled
11753 without @option{-fsplit-stack}, there may not be much stack space
11754 available for the latter code to run.  If compiling all code,
11755 including library code, with @option{-fsplit-stack} is not an option,
11756 then the linker can fix up these calls so that the code compiled
11757 without @option{-fsplit-stack} always has a large stack.  Support for
11758 this is implemented in the gold linker in GNU binutils release 2.21
11759 and later.
11761 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11762 @opindex fvtable-verify
11763 This option is only available when compiling C++ code.
11764 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11765 feature that verifies at run time, for every virtual call, that
11766 the vtable pointer through which the call is made is valid for the type of
11767 the object, and has not been corrupted or overwritten.  If an invalid vtable
11768 pointer is detected at run time, an error is reported and execution of the
11769 program is immediately halted.
11771 This option causes run-time data structures to be built at program startup,
11772 which are used for verifying the vtable pointers.  
11773 The options @samp{std} and @samp{preinit}
11774 control the timing of when these data structures are built.  In both cases the
11775 data structures are built before execution reaches @code{main}.  Using
11776 @option{-fvtable-verify=std} causes the data structures to be built after
11777 shared libraries have been loaded and initialized.
11778 @option{-fvtable-verify=preinit} causes them to be built before shared
11779 libraries have been loaded and initialized.
11781 If this option appears multiple times in the command line with different
11782 values specified, @samp{none} takes highest priority over both @samp{std} and
11783 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11785 @item -fvtv-debug
11786 @opindex fvtv-debug
11787 When used in conjunction with @option{-fvtable-verify=std} or 
11788 @option{-fvtable-verify=preinit}, causes debug versions of the 
11789 runtime functions for the vtable verification feature to be called.  
11790 This flag also causes the compiler to log information about which 
11791 vtable pointers it finds for each class.
11792 This information is written to a file named @file{vtv_set_ptr_data.log} 
11793 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11794 if that is defined or the current working directory otherwise.
11796 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11797 file, be sure to delete any existing one.
11799 @item -fvtv-counts
11800 @opindex fvtv-counts
11801 This is a debugging flag.  When used in conjunction with
11802 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11803 causes the compiler to keep track of the total number of virtual calls
11804 it encounters and the number of verifications it inserts.  It also
11805 counts the number of calls to certain run-time library functions
11806 that it inserts and logs this information for each compilation unit.
11807 The compiler writes this information to a file named
11808 @file{vtv_count_data.log} in the directory named by the environment
11809 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11810 directory otherwise.  It also counts the size of the vtable pointer sets
11811 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11812 in the same directory.
11814 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11815 files, be sure to delete any existing ones.
11817 @item -finstrument-functions
11818 @opindex finstrument-functions
11819 Generate instrumentation calls for entry and exit to functions.  Just
11820 after function entry and just before function exit, the following
11821 profiling functions are called with the address of the current
11822 function and its call site.  (On some platforms,
11823 @code{__builtin_return_address} does not work beyond the current
11824 function, so the call site information may not be available to the
11825 profiling functions otherwise.)
11827 @smallexample
11828 void __cyg_profile_func_enter (void *this_fn,
11829                                void *call_site);
11830 void __cyg_profile_func_exit  (void *this_fn,
11831                                void *call_site);
11832 @end smallexample
11834 The first argument is the address of the start of the current function,
11835 which may be looked up exactly in the symbol table.
11837 This instrumentation is also done for functions expanded inline in other
11838 functions.  The profiling calls indicate where, conceptually, the
11839 inline function is entered and exited.  This means that addressable
11840 versions of such functions must be available.  If all your uses of a
11841 function are expanded inline, this may mean an additional expansion of
11842 code size.  If you use @code{extern inline} in your C code, an
11843 addressable version of such functions must be provided.  (This is
11844 normally the case anyway, but if you get lucky and the optimizer always
11845 expands the functions inline, you might have gotten away without
11846 providing static copies.)
11848 A function may be given the attribute @code{no_instrument_function}, in
11849 which case this instrumentation is not done.  This can be used, for
11850 example, for the profiling functions listed above, high-priority
11851 interrupt routines, and any functions from which the profiling functions
11852 cannot safely be called (perhaps signal handlers, if the profiling
11853 routines generate output or allocate memory).
11855 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11856 @opindex finstrument-functions-exclude-file-list
11858 Set the list of functions that are excluded from instrumentation (see
11859 the description of @option{-finstrument-functions}).  If the file that
11860 contains a function definition matches with one of @var{file}, then
11861 that function is not instrumented.  The match is done on substrings:
11862 if the @var{file} parameter is a substring of the file name, it is
11863 considered to be a match.
11865 For example:
11867 @smallexample
11868 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11869 @end smallexample
11871 @noindent
11872 excludes any inline function defined in files whose pathnames
11873 contain @file{/bits/stl} or @file{include/sys}.
11875 If, for some reason, you want to include letter @samp{,} in one of
11876 @var{sym}, write @samp{\,}. For example,
11877 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11878 (note the single quote surrounding the option).
11880 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11881 @opindex finstrument-functions-exclude-function-list
11883 This is similar to @option{-finstrument-functions-exclude-file-list},
11884 but this option sets the list of function names to be excluded from
11885 instrumentation.  The function name to be matched is its user-visible
11886 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11887 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11888 match is done on substrings: if the @var{sym} parameter is a substring
11889 of the function name, it is considered to be a match.  For C99 and C++
11890 extended identifiers, the function name must be given in UTF-8, not
11891 using universal character names.
11893 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11894 @opindex fpatchable-function-entry
11895 Generate @var{N} NOPs right at the beginning
11896 of each function, with the function entry point before the @var{M}th NOP.
11897 If @var{M} is omitted, it defaults to @code{0} so the
11898 function entry points to the address just at the first NOP.
11899 The NOP instructions reserve extra space which can be used to patch in
11900 any desired instrumentation at run time, provided that the code segment
11901 is writable.  The amount of space is controllable indirectly via
11902 the number of NOPs; the NOP instruction used corresponds to the instruction
11903 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11904 is target-specific and may also depend on the architecture variant and/or
11905 other compilation options.
11907 For run-time identification, the starting addresses of these areas,
11908 which correspond to their respective function entries minus @var{M},
11909 are additionally collected in the @code{__patchable_function_entries}
11910 section of the resulting binary.
11912 Note that the value of @code{__attribute__ ((patchable_function_entry
11913 (N,M)))} takes precedence over command-line option
11914 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11915 the area size or to remove it completely on a single function.
11916 If @code{N=0}, no pad location is recorded.
11918 The NOP instructions are inserted at---and maybe before, depending on
11919 @var{M}---the function entry address, even before the prologue.
11921 @end table
11924 @node Preprocessor Options
11925 @section Options Controlling the Preprocessor
11926 @cindex preprocessor options
11927 @cindex options, preprocessor
11929 These options control the C preprocessor, which is run on each C source
11930 file before actual compilation.
11932 If you use the @option{-E} option, nothing is done except preprocessing.
11933 Some of these options make sense only together with @option{-E} because
11934 they cause the preprocessor output to be unsuitable for actual
11935 compilation.
11937 In addition to the options listed here, there are a number of options 
11938 to control search paths for include files documented in 
11939 @ref{Directory Options}.  
11940 Options to control preprocessor diagnostics are listed in 
11941 @ref{Warning Options}.
11943 @table @gcctabopt
11944 @include cppopts.texi
11946 @item -Wp,@var{option}
11947 @opindex Wp
11948 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11949 and pass @var{option} directly through to the preprocessor.  If
11950 @var{option} contains commas, it is split into multiple options at the
11951 commas.  However, many options are modified, translated or interpreted
11952 by the compiler driver before being passed to the preprocessor, and
11953 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11954 interface is undocumented and subject to change, so whenever possible
11955 you should avoid using @option{-Wp} and let the driver handle the
11956 options instead.
11958 @item -Xpreprocessor @var{option}
11959 @opindex Xpreprocessor
11960 Pass @var{option} as an option to the preprocessor.  You can use this to
11961 supply system-specific preprocessor options that GCC does not 
11962 recognize.
11964 If you want to pass an option that takes an argument, you must use
11965 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11967 @item -no-integrated-cpp
11968 @opindex no-integrated-cpp
11969 Perform preprocessing as a separate pass before compilation.
11970 By default, GCC performs preprocessing as an integrated part of
11971 input tokenization and parsing.
11972 If this option is provided, the appropriate language front end
11973 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11974 and Objective-C, respectively) is instead invoked twice,
11975 once for preprocessing only and once for actual compilation
11976 of the preprocessed input.
11977 This option may be useful in conjunction with the @option{-B} or
11978 @option{-wrapper} options to specify an alternate preprocessor or
11979 perform additional processing of the program source between
11980 normal preprocessing and compilation.
11982 @end table
11984 @node Assembler Options
11985 @section Passing Options to the Assembler
11987 @c prevent bad page break with this line
11988 You can pass options to the assembler.
11990 @table @gcctabopt
11991 @item -Wa,@var{option}
11992 @opindex Wa
11993 Pass @var{option} as an option to the assembler.  If @var{option}
11994 contains commas, it is split into multiple options at the commas.
11996 @item -Xassembler @var{option}
11997 @opindex Xassembler
11998 Pass @var{option} as an option to the assembler.  You can use this to
11999 supply system-specific assembler options that GCC does not
12000 recognize.
12002 If you want to pass an option that takes an argument, you must use
12003 @option{-Xassembler} twice, once for the option and once for the argument.
12005 @end table
12007 @node Link Options
12008 @section Options for Linking
12009 @cindex link options
12010 @cindex options, linking
12012 These options come into play when the compiler links object files into
12013 an executable output file.  They are meaningless if the compiler is
12014 not doing a link step.
12016 @table @gcctabopt
12017 @cindex file names
12018 @item @var{object-file-name}
12019 A file name that does not end in a special recognized suffix is
12020 considered to name an object file or library.  (Object files are
12021 distinguished from libraries by the linker according to the file
12022 contents.)  If linking is done, these object files are used as input
12023 to the linker.
12025 @item -c
12026 @itemx -S
12027 @itemx -E
12028 @opindex c
12029 @opindex S
12030 @opindex E
12031 If any of these options is used, then the linker is not run, and
12032 object file names should not be used as arguments.  @xref{Overall
12033 Options}.
12035 @item -fuse-ld=bfd
12036 @opindex fuse-ld=bfd
12037 Use the @command{bfd} linker instead of the default linker.
12039 @item -fuse-ld=gold
12040 @opindex fuse-ld=gold
12041 Use the @command{gold} linker instead of the default linker.
12043 @cindex Libraries
12044 @item -l@var{library}
12045 @itemx -l @var{library}
12046 @opindex l
12047 Search the library named @var{library} when linking.  (The second
12048 alternative with the library as a separate argument is only for
12049 POSIX compliance and is not recommended.)
12051 It makes a difference where in the command you write this option; the
12052 linker searches and processes libraries and object files in the order they
12053 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12054 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12055 to functions in @samp{z}, those functions may not be loaded.
12057 The linker searches a standard list of directories for the library,
12058 which is actually a file named @file{lib@var{library}.a}.  The linker
12059 then uses this file as if it had been specified precisely by name.
12061 The directories searched include several standard system directories
12062 plus any that you specify with @option{-L}.
12064 Normally the files found this way are library files---archive files
12065 whose members are object files.  The linker handles an archive file by
12066 scanning through it for members which define symbols that have so far
12067 been referenced but not defined.  But if the file that is found is an
12068 ordinary object file, it is linked in the usual fashion.  The only
12069 difference between using an @option{-l} option and specifying a file name
12070 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12071 and searches several directories.
12073 @item -lobjc
12074 @opindex lobjc
12075 You need this special case of the @option{-l} option in order to
12076 link an Objective-C or Objective-C++ program.
12078 @item -nostartfiles
12079 @opindex nostartfiles
12080 Do not use the standard system startup files when linking.
12081 The standard system libraries are used normally, unless @option{-nostdlib}
12082 or @option{-nodefaultlibs} is used.
12084 @item -nodefaultlibs
12085 @opindex nodefaultlibs
12086 Do not use the standard system libraries when linking.
12087 Only the libraries you specify are passed to the linker, and options
12088 specifying linkage of the system libraries, such as @option{-static-libgcc}
12089 or @option{-shared-libgcc}, are ignored.  
12090 The standard startup files are used normally, unless @option{-nostartfiles}
12091 is used.  
12093 The compiler may generate calls to @code{memcmp},
12094 @code{memset}, @code{memcpy} and @code{memmove}.
12095 These entries are usually resolved by entries in
12096 libc.  These entry points should be supplied through some other
12097 mechanism when this option is specified.
12099 @item -nostdlib
12100 @opindex nostdlib
12101 Do not use the standard system startup files or libraries when linking.
12102 No startup files and only the libraries you specify are passed to
12103 the linker, and options specifying linkage of the system libraries, such as
12104 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12106 The compiler may generate calls to @code{memcmp}, @code{memset},
12107 @code{memcpy} and @code{memmove}.
12108 These entries are usually resolved by entries in
12109 libc.  These entry points should be supplied through some other
12110 mechanism when this option is specified.
12112 @cindex @option{-lgcc}, use with @option{-nostdlib}
12113 @cindex @option{-nostdlib} and unresolved references
12114 @cindex unresolved references and @option{-nostdlib}
12115 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12116 @cindex @option{-nodefaultlibs} and unresolved references
12117 @cindex unresolved references and @option{-nodefaultlibs}
12118 One of the standard libraries bypassed by @option{-nostdlib} and
12119 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12120 which GCC uses to overcome shortcomings of particular machines, or special
12121 needs for some languages.
12122 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12123 Collection (GCC) Internals},
12124 for more discussion of @file{libgcc.a}.)
12125 In most cases, you need @file{libgcc.a} even when you want to avoid
12126 other standard libraries.  In other words, when you specify @option{-nostdlib}
12127 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12128 This ensures that you have no unresolved references to internal GCC
12129 library subroutines.
12130 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12131 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12132 GNU Compiler Collection (GCC) Internals}.)
12134 @item -pie
12135 @opindex pie
12136 Produce a dynamically linked position independent executable on targets
12137 that support it.  For predictable results, you must also specify the same
12138 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12139 or model suboptions) when you specify this linker option.
12141 @item -no-pie
12142 @opindex no-pie
12143 Don't produce a dynamically linked position independent executable.
12145 @item -static-pie
12146 @opindex static-pie
12147 Produce a static position independent executable on targets that support
12148 it.  A static position independent executable is similar to a static
12149 executable, but can be loaded at any address without a dynamic linker.
12150 For predictable results, you must also specify the same set of options
12151 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12152 suboptions) when you specify this linker option.
12154 @item -pthread
12155 @opindex pthread
12156 Link with the POSIX threads library.  This option is supported on 
12157 GNU/Linux targets, most other Unix derivatives, and also on 
12158 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12159 flags for the preprocessor, so it should be used consistently for both
12160 compilation and linking.
12162 @item -rdynamic
12163 @opindex rdynamic
12164 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12165 that support it. This instructs the linker to add all symbols, not
12166 only used ones, to the dynamic symbol table. This option is needed
12167 for some uses of @code{dlopen} or to allow obtaining backtraces
12168 from within a program.
12170 @item -s
12171 @opindex s
12172 Remove all symbol table and relocation information from the executable.
12174 @item -static
12175 @opindex static
12176 On systems that support dynamic linking, this overrides @option{-pie}
12177 and prevents linking with the shared libraries.  On other systems, this
12178 option has no effect.
12180 @item -shared
12181 @opindex shared
12182 Produce a shared object which can then be linked with other objects to
12183 form an executable.  Not all systems support this option.  For predictable
12184 results, you must also specify the same set of options used for compilation
12185 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12186 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12187 needs to build supplementary stub code for constructors to work.  On
12188 multi-libbed systems, @samp{gcc -shared} must select the correct support
12189 libraries to link against.  Failing to supply the correct flags may lead
12190 to subtle defects.  Supplying them in cases where they are not necessary
12191 is innocuous.}
12193 @item -shared-libgcc
12194 @itemx -static-libgcc
12195 @opindex shared-libgcc
12196 @opindex static-libgcc
12197 On systems that provide @file{libgcc} as a shared library, these options
12198 force the use of either the shared or static version, respectively.
12199 If no shared version of @file{libgcc} was built when the compiler was
12200 configured, these options have no effect.
12202 There are several situations in which an application should use the
12203 shared @file{libgcc} instead of the static version.  The most common
12204 of these is when the application wishes to throw and catch exceptions
12205 across different shared libraries.  In that case, each of the libraries
12206 as well as the application itself should use the shared @file{libgcc}.
12208 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12209  whenever you build a shared library or a main executable, because C++
12210  programs typically use exceptions, so this is the right thing to do.
12212 If, instead, you use the GCC driver to create shared libraries, you may
12213 find that they are not always linked with the shared @file{libgcc}.
12214 If GCC finds, at its configuration time, that you have a non-GNU linker
12215 or a GNU linker that does not support option @option{--eh-frame-hdr},
12216 it links the shared version of @file{libgcc} into shared libraries
12217 by default.  Otherwise, it takes advantage of the linker and optimizes
12218 away the linking with the shared version of @file{libgcc}, linking with
12219 the static version of libgcc by default.  This allows exceptions to
12220 propagate through such shared libraries, without incurring relocation
12221 costs at library load time.
12223 However, if a library or main executable is supposed to throw or catch
12224 exceptions, you must link it using the G++ driver, as appropriate
12225 for the languages used in the program, or using the option
12226 @option{-shared-libgcc}, such that it is linked with the shared
12227 @file{libgcc}.
12229 @item -static-libasan
12230 @opindex static-libasan
12231 When the @option{-fsanitize=address} option is used to link a program,
12232 the GCC driver automatically links against @option{libasan}.  If
12233 @file{libasan} is available as a shared library, and the @option{-static}
12234 option is not used, then this links against the shared version of
12235 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12236 driver to link @file{libasan} statically, without necessarily linking
12237 other libraries statically.
12239 @item -static-libtsan
12240 @opindex static-libtsan
12241 When the @option{-fsanitize=thread} option is used to link a program,
12242 the GCC driver automatically links against @option{libtsan}.  If
12243 @file{libtsan} is available as a shared library, and the @option{-static}
12244 option is not used, then this links against the shared version of
12245 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12246 driver to link @file{libtsan} statically, without necessarily linking
12247 other libraries statically.
12249 @item -static-liblsan
12250 @opindex static-liblsan
12251 When the @option{-fsanitize=leak} option is used to link a program,
12252 the GCC driver automatically links against @option{liblsan}.  If
12253 @file{liblsan} is available as a shared library, and the @option{-static}
12254 option is not used, then this links against the shared version of
12255 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12256 driver to link @file{liblsan} statically, without necessarily linking
12257 other libraries statically.
12259 @item -static-libubsan
12260 @opindex static-libubsan
12261 When the @option{-fsanitize=undefined} option is used to link a program,
12262 the GCC driver automatically links against @option{libubsan}.  If
12263 @file{libubsan} is available as a shared library, and the @option{-static}
12264 option is not used, then this links against the shared version of
12265 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12266 driver to link @file{libubsan} statically, without necessarily linking
12267 other libraries statically.
12269 @item -static-libmpx
12270 @opindex static-libmpx
12271 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12272 used to link a program, the GCC driver automatically links against
12273 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12274 and the @option{-static} option is not used, then this links against
12275 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12276 option directs the GCC driver to link @file{libmpx} statically,
12277 without necessarily linking other libraries statically.
12279 @item -static-libmpxwrappers
12280 @opindex static-libmpxwrappers
12281 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12282 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12283 GCC driver automatically links against @file{libmpxwrappers}.  If
12284 @file{libmpxwrappers} is available as a shared library, and the
12285 @option{-static} option is not used, then this links against the shared
12286 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12287 option directs the GCC driver to link @file{libmpxwrappers} statically,
12288 without necessarily linking other libraries statically.
12290 @item -static-libstdc++
12291 @opindex static-libstdc++
12292 When the @command{g++} program is used to link a C++ program, it
12293 normally automatically links against @option{libstdc++}.  If
12294 @file{libstdc++} is available as a shared library, and the
12295 @option{-static} option is not used, then this links against the
12296 shared version of @file{libstdc++}.  That is normally fine.  However, it
12297 is sometimes useful to freeze the version of @file{libstdc++} used by
12298 the program without going all the way to a fully static link.  The
12299 @option{-static-libstdc++} option directs the @command{g++} driver to
12300 link @file{libstdc++} statically, without necessarily linking other
12301 libraries statically.
12303 @item -symbolic
12304 @opindex symbolic
12305 Bind references to global symbols when building a shared object.  Warn
12306 about any unresolved references (unless overridden by the link editor
12307 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12308 this option.
12310 @item -T @var{script}
12311 @opindex T
12312 @cindex linker script
12313 Use @var{script} as the linker script.  This option is supported by most
12314 systems using the GNU linker.  On some targets, such as bare-board
12315 targets without an operating system, the @option{-T} option may be required
12316 when linking to avoid references to undefined symbols.
12318 @item -Xlinker @var{option}
12319 @opindex Xlinker
12320 Pass @var{option} as an option to the linker.  You can use this to
12321 supply system-specific linker options that GCC does not recognize.
12323 If you want to pass an option that takes a separate argument, you must use
12324 @option{-Xlinker} twice, once for the option and once for the argument.
12325 For example, to pass @option{-assert definitions}, you must write
12326 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12327 @option{-Xlinker "-assert definitions"}, because this passes the entire
12328 string as a single argument, which is not what the linker expects.
12330 When using the GNU linker, it is usually more convenient to pass
12331 arguments to linker options using the @option{@var{option}=@var{value}}
12332 syntax than as separate arguments.  For example, you can specify
12333 @option{-Xlinker -Map=output.map} rather than
12334 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12335 this syntax for command-line options.
12337 @item -Wl,@var{option}
12338 @opindex Wl
12339 Pass @var{option} as an option to the linker.  If @var{option} contains
12340 commas, it is split into multiple options at the commas.  You can use this
12341 syntax to pass an argument to the option.
12342 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12343 linker.  When using the GNU linker, you can also get the same effect with
12344 @option{-Wl,-Map=output.map}.
12346 @item -u @var{symbol}
12347 @opindex u
12348 Pretend the symbol @var{symbol} is undefined, to force linking of
12349 library modules to define it.  You can use @option{-u} multiple times with
12350 different symbols to force loading of additional library modules.
12352 @item -z @var{keyword}
12353 @opindex z
12354 @option{-z} is passed directly on to the linker along with the keyword
12355 @var{keyword}. See the section in the documentation of your linker for
12356 permitted values and their meanings.
12357 @end table
12359 @node Directory Options
12360 @section Options for Directory Search
12361 @cindex directory options
12362 @cindex options, directory search
12363 @cindex search path
12365 These options specify directories to search for header files, for
12366 libraries and for parts of the compiler:
12368 @table @gcctabopt
12369 @include cppdiropts.texi
12371 @item -iplugindir=@var{dir}
12372 @opindex iplugindir=
12373 Set the directory to search for plugins that are passed
12374 by @option{-fplugin=@var{name}} instead of
12375 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12376 to be used by the user, but only passed by the driver.
12378 @item -L@var{dir}
12379 @opindex L
12380 Add directory @var{dir} to the list of directories to be searched
12381 for @option{-l}.
12383 @item -B@var{prefix}
12384 @opindex B
12385 This option specifies where to find the executables, libraries,
12386 include files, and data files of the compiler itself.
12388 The compiler driver program runs one or more of the subprograms
12389 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12390 @var{prefix} as a prefix for each program it tries to run, both with and
12391 without @samp{@var{machine}/@var{version}/} for the corresponding target
12392 machine and compiler version.
12394 For each subprogram to be run, the compiler driver first tries the
12395 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12396 is not specified, the driver tries two standard prefixes, 
12397 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12398 those results in a file name that is found, the unmodified program
12399 name is searched for using the directories specified in your
12400 @env{PATH} environment variable.
12402 The compiler checks to see if the path provided by @option{-B}
12403 refers to a directory, and if necessary it adds a directory
12404 separator character at the end of the path.
12406 @option{-B} prefixes that effectively specify directory names also apply
12407 to libraries in the linker, because the compiler translates these
12408 options into @option{-L} options for the linker.  They also apply to
12409 include files in the preprocessor, because the compiler translates these
12410 options into @option{-isystem} options for the preprocessor.  In this case,
12411 the compiler appends @samp{include} to the prefix.
12413 The runtime support file @file{libgcc.a} can also be searched for using
12414 the @option{-B} prefix, if needed.  If it is not found there, the two
12415 standard prefixes above are tried, and that is all.  The file is left
12416 out of the link if it is not found by those means.
12418 Another way to specify a prefix much like the @option{-B} prefix is to use
12419 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12420 Variables}.
12422 As a special kludge, if the path provided by @option{-B} is
12423 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12424 9, then it is replaced by @file{[dir/]include}.  This is to help
12425 with boot-strapping the compiler.
12427 @item -no-canonical-prefixes
12428 @opindex no-canonical-prefixes
12429 Do not expand any symbolic links, resolve references to @samp{/../}
12430 or @samp{/./}, or make the path absolute when generating a relative
12431 prefix.
12433 @item --sysroot=@var{dir}
12434 @opindex sysroot
12435 Use @var{dir} as the logical root directory for headers and libraries.
12436 For example, if the compiler normally searches for headers in
12437 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12438 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12440 If you use both this option and the @option{-isysroot} option, then
12441 the @option{--sysroot} option applies to libraries, but the
12442 @option{-isysroot} option applies to header files.
12444 The GNU linker (beginning with version 2.16) has the necessary support
12445 for this option.  If your linker does not support this option, the
12446 header file aspect of @option{--sysroot} still works, but the
12447 library aspect does not.
12449 @item --no-sysroot-suffix
12450 @opindex no-sysroot-suffix
12451 For some targets, a suffix is added to the root directory specified
12452 with @option{--sysroot}, depending on the other options used, so that
12453 headers may for example be found in
12454 @file{@var{dir}/@var{suffix}/usr/include} instead of
12455 @file{@var{dir}/usr/include}.  This option disables the addition of
12456 such a suffix.
12458 @end table
12460 @node Code Gen Options
12461 @section Options for Code Generation Conventions
12462 @cindex code generation conventions
12463 @cindex options, code generation
12464 @cindex run-time options
12466 These machine-independent options control the interface conventions
12467 used in code generation.
12469 Most of them have both positive and negative forms; the negative form
12470 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12471 one of the forms is listed---the one that is not the default.  You
12472 can figure out the other form by either removing @samp{no-} or adding
12475 @table @gcctabopt
12476 @item -fstack-reuse=@var{reuse-level}
12477 @opindex fstack_reuse
12478 This option controls stack space reuse for user declared local/auto variables
12479 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12480 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12481 local variables and temporaries, @samp{named_vars} enables the reuse only for
12482 user defined local variables with names, and @samp{none} disables stack reuse
12483 completely. The default value is @samp{all}. The option is needed when the
12484 program extends the lifetime of a scoped local variable or a compiler generated
12485 temporary beyond the end point defined by the language.  When a lifetime of
12486 a variable ends, and if the variable lives in memory, the optimizing compiler
12487 has the freedom to reuse its stack space with other temporaries or scoped
12488 local variables whose live range does not overlap with it. Legacy code extending
12489 local lifetime is likely to break with the stack reuse optimization.
12491 For example,
12493 @smallexample
12494    int *p;
12495    @{
12496      int local1;
12498      p = &local1;
12499      local1 = 10;
12500      ....
12501    @}
12502    @{
12503       int local2;
12504       local2 = 20;
12505       ...
12506    @}
12508    if (*p == 10)  // out of scope use of local1
12509      @{
12511      @}
12512 @end smallexample
12514 Another example:
12515 @smallexample
12517    struct A
12518    @{
12519        A(int k) : i(k), j(k) @{ @}
12520        int i;
12521        int j;
12522    @};
12524    A *ap;
12526    void foo(const A& ar)
12527    @{
12528       ap = &ar;
12529    @}
12531    void bar()
12532    @{
12533       foo(A(10)); // temp object's lifetime ends when foo returns
12535       @{
12536         A a(20);
12537         ....
12538       @}
12539       ap->i+= 10;  // ap references out of scope temp whose space
12540                    // is reused with a. What is the value of ap->i?
12541    @}
12543 @end smallexample
12545 The lifetime of a compiler generated temporary is well defined by the C++
12546 standard. When a lifetime of a temporary ends, and if the temporary lives
12547 in memory, the optimizing compiler has the freedom to reuse its stack
12548 space with other temporaries or scoped local variables whose live range
12549 does not overlap with it. However some of the legacy code relies on
12550 the behavior of older compilers in which temporaries' stack space is
12551 not reused, the aggressive stack reuse can lead to runtime errors. This
12552 option is used to control the temporary stack reuse optimization.
12554 @item -ftrapv
12555 @opindex ftrapv
12556 This option generates traps for signed overflow on addition, subtraction,
12557 multiplication operations.
12558 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12559 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12560 @option{-fwrapv} being effective.  Note that only active options override, so
12561 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12562 results in @option{-ftrapv} being effective.
12564 @item -fwrapv
12565 @opindex fwrapv
12566 This option instructs the compiler to assume that signed arithmetic
12567 overflow of addition, subtraction and multiplication wraps around
12568 using twos-complement representation.  This flag enables some optimizations
12569 and disables others.
12570 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12571 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12572 @option{-fwrapv} being effective.  Note that only active options override, so
12573 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12574 results in @option{-ftrapv} being effective.
12576 @item -fexceptions
12577 @opindex fexceptions
12578 Enable exception handling.  Generates extra code needed to propagate
12579 exceptions.  For some targets, this implies GCC generates frame
12580 unwind information for all functions, which can produce significant data
12581 size overhead, although it does not affect execution.  If you do not
12582 specify this option, GCC enables it by default for languages like
12583 C++ that normally require exception handling, and disables it for
12584 languages like C that do not normally require it.  However, you may need
12585 to enable this option when compiling C code that needs to interoperate
12586 properly with exception handlers written in C++.  You may also wish to
12587 disable this option if you are compiling older C++ programs that don't
12588 use exception handling.
12590 @item -fnon-call-exceptions
12591 @opindex fnon-call-exceptions
12592 Generate code that allows trapping instructions to throw exceptions.
12593 Note that this requires platform-specific runtime support that does
12594 not exist everywhere.  Moreover, it only allows @emph{trapping}
12595 instructions to throw exceptions, i.e.@: memory references or floating-point
12596 instructions.  It does not allow exceptions to be thrown from
12597 arbitrary signal handlers such as @code{SIGALRM}.
12599 @item -fdelete-dead-exceptions
12600 @opindex fdelete-dead-exceptions
12601 Consider that instructions that may throw exceptions but don't otherwise
12602 contribute to the execution of the program can be optimized away.
12603 This option is enabled by default for the Ada front end, as permitted by
12604 the Ada language specification.
12605 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12607 @item -funwind-tables
12608 @opindex funwind-tables
12609 Similar to @option{-fexceptions}, except that it just generates any needed
12610 static data, but does not affect the generated code in any other way.
12611 You normally do not need to enable this option; instead, a language processor
12612 that needs this handling enables it on your behalf.
12614 @item -fasynchronous-unwind-tables
12615 @opindex fasynchronous-unwind-tables
12616 Generate unwind table in DWARF format, if supported by target machine.  The
12617 table is exact at each instruction boundary, so it can be used for stack
12618 unwinding from asynchronous events (such as debugger or garbage collector).
12620 @item -fno-gnu-unique
12621 @opindex fno-gnu-unique
12622 On systems with recent GNU assembler and C library, the C++ compiler
12623 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12624 of template static data members and static local variables in inline
12625 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12626 is necessary to avoid problems with a library used by two different
12627 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12628 therefore disagreeing with the other one about the binding of the
12629 symbol.  But this causes @code{dlclose} to be ignored for affected
12630 DSOs; if your program relies on reinitialization of a DSO via
12631 @code{dlclose} and @code{dlopen}, you can use
12632 @option{-fno-gnu-unique}.
12634 @item -fpcc-struct-return
12635 @opindex fpcc-struct-return
12636 Return ``short'' @code{struct} and @code{union} values in memory like
12637 longer ones, rather than in registers.  This convention is less
12638 efficient, but it has the advantage of allowing intercallability between
12639 GCC-compiled files and files compiled with other compilers, particularly
12640 the Portable C Compiler (pcc).
12642 The precise convention for returning structures in memory depends
12643 on the target configuration macros.
12645 Short structures and unions are those whose size and alignment match
12646 that of some integer type.
12648 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12649 switch is not binary compatible with code compiled with the
12650 @option{-freg-struct-return} switch.
12651 Use it to conform to a non-default application binary interface.
12653 @item -freg-struct-return
12654 @opindex freg-struct-return
12655 Return @code{struct} and @code{union} values in registers when possible.
12656 This is more efficient for small structures than
12657 @option{-fpcc-struct-return}.
12659 If you specify neither @option{-fpcc-struct-return} nor
12660 @option{-freg-struct-return}, GCC defaults to whichever convention is
12661 standard for the target.  If there is no standard convention, GCC
12662 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12663 the principal compiler.  In those cases, we can choose the standard, and
12664 we chose the more efficient register return alternative.
12666 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12667 switch is not binary compatible with code compiled with the
12668 @option{-fpcc-struct-return} switch.
12669 Use it to conform to a non-default application binary interface.
12671 @item -fshort-enums
12672 @opindex fshort-enums
12673 Allocate to an @code{enum} type only as many bytes as it needs for the
12674 declared range of possible values.  Specifically, the @code{enum} type
12675 is equivalent to the smallest integer type that has enough room.
12677 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12678 code that is not binary compatible with code generated without that switch.
12679 Use it to conform to a non-default application binary interface.
12681 @item -fshort-wchar
12682 @opindex fshort-wchar
12683 Override the underlying type for @code{wchar_t} to be @code{short
12684 unsigned int} instead of the default for the target.  This option is
12685 useful for building programs to run under WINE@.
12687 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12688 code that is not binary compatible with code generated without that switch.
12689 Use it to conform to a non-default application binary interface.
12691 @item -fno-common
12692 @opindex fno-common
12693 @cindex tentative definitions
12694 In C code, this option controls the placement of global variables 
12695 defined without an initializer, known as @dfn{tentative definitions} 
12696 in the C standard.  Tentative definitions are distinct from declarations 
12697 of a variable with the @code{extern} keyword, which do not allocate storage.
12699 Unix C compilers have traditionally allocated storage for
12700 uninitialized global variables in a common block.  This allows the
12701 linker to resolve all tentative definitions of the same variable
12702 in different compilation units to the same object, or to a non-tentative
12703 definition.  
12704 This is the behavior specified by @option{-fcommon}, and is the default for 
12705 GCC on most targets.  
12706 On the other hand, this behavior is not required by ISO
12707 C, and on some targets may carry a speed or code size penalty on
12708 variable references.
12710 The @option{-fno-common} option specifies that the compiler should instead
12711 place uninitialized global variables in the data section of the object file.
12712 This inhibits the merging of tentative definitions by the linker so
12713 you get a multiple-definition error if the same 
12714 variable is defined in more than one compilation unit.
12715 Compiling with @option{-fno-common} is useful on targets for which
12716 it provides better performance, or if you wish to verify that the
12717 program will work on other systems that always treat uninitialized
12718 variable definitions this way.
12720 @item -fno-ident
12721 @opindex fno-ident
12722 Ignore the @code{#ident} directive.
12724 @item -finhibit-size-directive
12725 @opindex finhibit-size-directive
12726 Don't output a @code{.size} assembler directive, or anything else that
12727 would cause trouble if the function is split in the middle, and the
12728 two halves are placed at locations far apart in memory.  This option is
12729 used when compiling @file{crtstuff.c}; you should not need to use it
12730 for anything else.
12732 @item -fverbose-asm
12733 @opindex fverbose-asm
12734 Put extra commentary information in the generated assembly code to
12735 make it more readable.  This option is generally only of use to those
12736 who actually need to read the generated assembly code (perhaps while
12737 debugging the compiler itself).
12739 @option{-fno-verbose-asm}, the default, causes the
12740 extra information to be omitted and is useful when comparing two assembler
12741 files.
12743 The added comments include:
12745 @itemize @bullet
12747 @item
12748 information on the compiler version and command-line options,
12750 @item
12751 the source code lines associated with the assembly instructions,
12752 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12754 @item
12755 hints on which high-level expressions correspond to
12756 the various assembly instruction operands.
12758 @end itemize
12760 For example, given this C source file:
12762 @smallexample
12763 int test (int n)
12765   int i;
12766   int total = 0;
12768   for (i = 0; i < n; i++)
12769     total += i * i;
12771   return total;
12773 @end smallexample
12775 compiling to (x86_64) assembly via @option{-S} and emitting the result
12776 direct to stdout via @option{-o} @option{-}
12778 @smallexample
12779 gcc -S test.c -fverbose-asm -Os -o -
12780 @end smallexample
12782 gives output similar to this:
12784 @smallexample
12785         .file   "test.c"
12786 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12787   [...snip...]
12788 # options passed:
12789   [...snip...]
12791         .text
12792         .globl  test
12793         .type   test, @@function
12794 test:
12795 .LFB0:
12796         .cfi_startproc
12797 # test.c:4:   int total = 0;
12798         xorl    %eax, %eax      # <retval>
12799 # test.c:6:   for (i = 0; i < n; i++)
12800         xorl    %edx, %edx      # i
12801 .L2:
12802 # test.c:6:   for (i = 0; i < n; i++)
12803         cmpl    %edi, %edx      # n, i
12804         jge     .L5     #,
12805 # test.c:7:     total += i * i;
12806         movl    %edx, %ecx      # i, tmp92
12807         imull   %edx, %ecx      # i, tmp92
12808 # test.c:6:   for (i = 0; i < n; i++)
12809         incl    %edx    # i
12810 # test.c:7:     total += i * i;
12811         addl    %ecx, %eax      # tmp92, <retval>
12812         jmp     .L2     #
12813 .L5:
12814 # test.c:10: @}
12815         ret
12816         .cfi_endproc
12817 .LFE0:
12818         .size   test, .-test
12819         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12820         .section        .note.GNU-stack,"",@@progbits
12821 @end smallexample
12823 The comments are intended for humans rather than machines and hence the
12824 precise format of the comments is subject to change.
12826 @item -frecord-gcc-switches
12827 @opindex frecord-gcc-switches
12828 This switch causes the command line used to invoke the
12829 compiler to be recorded into the object file that is being created.
12830 This switch is only implemented on some targets and the exact format
12831 of the recording is target and binary file format dependent, but it
12832 usually takes the form of a section containing ASCII text.  This
12833 switch is related to the @option{-fverbose-asm} switch, but that
12834 switch only records information in the assembler output file as
12835 comments, so it never reaches the object file.
12836 See also @option{-grecord-gcc-switches} for another
12837 way of storing compiler options into the object file.
12839 @item -fpic
12840 @opindex fpic
12841 @cindex global offset table
12842 @cindex PIC
12843 Generate position-independent code (PIC) suitable for use in a shared
12844 library, if supported for the target machine.  Such code accesses all
12845 constant addresses through a global offset table (GOT)@.  The dynamic
12846 loader resolves the GOT entries when the program starts (the dynamic
12847 loader is not part of GCC; it is part of the operating system).  If
12848 the GOT size for the linked executable exceeds a machine-specific
12849 maximum size, you get an error message from the linker indicating that
12850 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12851 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12852 on the m68k and RS/6000.  The x86 has no such limit.)
12854 Position-independent code requires special support, and therefore works
12855 only on certain machines.  For the x86, GCC supports PIC for System V
12856 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12857 position-independent.
12859 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12860 are defined to 1.
12862 @item -fPIC
12863 @opindex fPIC
12864 If supported for the target machine, emit position-independent code,
12865 suitable for dynamic linking and avoiding any limit on the size of the
12866 global offset table.  This option makes a difference on AArch64, m68k,
12867 PowerPC and SPARC@.
12869 Position-independent code requires special support, and therefore works
12870 only on certain machines.
12872 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12873 are defined to 2.
12875 @item -fpie
12876 @itemx -fPIE
12877 @opindex fpie
12878 @opindex fPIE
12879 These options are similar to @option{-fpic} and @option{-fPIC}, but
12880 generated position independent code can be only linked into executables.
12881 Usually these options are used when @option{-pie} GCC option is
12882 used during linking.
12884 @option{-fpie} and @option{-fPIE} both define the macros
12885 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12886 for @option{-fpie} and 2 for @option{-fPIE}.
12888 @item -fno-plt
12889 @opindex fno-plt
12890 Do not use the PLT for external function calls in position-independent code.
12891 Instead, load the callee address at call sites from the GOT and branch to it.
12892 This leads to more efficient code by eliminating PLT stubs and exposing
12893 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12894 PLT stubs expect the GOT pointer in a specific register, this gives more
12895 register allocation freedom to the compiler.
12896 Lazy binding requires use of the PLT; 
12897 with @option{-fno-plt} all external symbols are resolved at load time.
12899 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12900 through the PLT for specific external functions.
12902 In position-dependent code, a few targets also convert calls to
12903 functions that are marked to not use the PLT to use the GOT instead.
12905 @item -fno-jump-tables
12906 @opindex fno-jump-tables
12907 Do not use jump tables for switch statements even where it would be
12908 more efficient than other code generation strategies.  This option is
12909 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12910 building code that forms part of a dynamic linker and cannot
12911 reference the address of a jump table.  On some targets, jump tables
12912 do not require a GOT and this option is not needed.
12914 @item -ffixed-@var{reg}
12915 @opindex ffixed
12916 Treat the register named @var{reg} as a fixed register; generated code
12917 should never refer to it (except perhaps as a stack pointer, frame
12918 pointer or in some other fixed role).
12920 @var{reg} must be the name of a register.  The register names accepted
12921 are machine-specific and are defined in the @code{REGISTER_NAMES}
12922 macro in the machine description macro file.
12924 This flag does not have a negative form, because it specifies a
12925 three-way choice.
12927 @item -fcall-used-@var{reg}
12928 @opindex fcall-used
12929 Treat the register named @var{reg} as an allocable register that is
12930 clobbered by function calls.  It may be allocated for temporaries or
12931 variables that do not live across a call.  Functions compiled this way
12932 do not save and restore the register @var{reg}.
12934 It is an error to use this flag with the frame pointer or stack pointer.
12935 Use of this flag for other registers that have fixed pervasive roles in
12936 the machine's execution model produces disastrous results.
12938 This flag does not have a negative form, because it specifies a
12939 three-way choice.
12941 @item -fcall-saved-@var{reg}
12942 @opindex fcall-saved
12943 Treat the register named @var{reg} as an allocable register saved by
12944 functions.  It may be allocated even for temporaries or variables that
12945 live across a call.  Functions compiled this way save and restore
12946 the register @var{reg} if they use it.
12948 It is an error to use this flag with the frame pointer or stack pointer.
12949 Use of this flag for other registers that have fixed pervasive roles in
12950 the machine's execution model produces disastrous results.
12952 A different sort of disaster results from the use of this flag for
12953 a register in which function values may be returned.
12955 This flag does not have a negative form, because it specifies a
12956 three-way choice.
12958 @item -fpack-struct[=@var{n}]
12959 @opindex fpack-struct
12960 Without a value specified, pack all structure members together without
12961 holes.  When a value is specified (which must be a small power of two), pack
12962 structure members according to this value, representing the maximum
12963 alignment (that is, objects with default alignment requirements larger than
12964 this are output potentially unaligned at the next fitting location.
12966 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12967 code that is not binary compatible with code generated without that switch.
12968 Additionally, it makes the code suboptimal.
12969 Use it to conform to a non-default application binary interface.
12971 @item -fleading-underscore
12972 @opindex fleading-underscore
12973 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12974 change the way C symbols are represented in the object file.  One use
12975 is to help link with legacy assembly code.
12977 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12978 generate code that is not binary compatible with code generated without that
12979 switch.  Use it to conform to a non-default application binary interface.
12980 Not all targets provide complete support for this switch.
12982 @item -ftls-model=@var{model}
12983 @opindex ftls-model
12984 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12985 The @var{model} argument should be one of @samp{global-dynamic},
12986 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12987 Note that the choice is subject to optimization: the compiler may use
12988 a more efficient model for symbols not visible outside of the translation
12989 unit, or if @option{-fpic} is not given on the command line.
12991 The default without @option{-fpic} is @samp{initial-exec}; with
12992 @option{-fpic} the default is @samp{global-dynamic}.
12994 @item -ftrampolines
12995 @opindex ftrampolines
12996 For targets that normally need trampolines for nested functions, always
12997 generate them instead of using descriptors.  Otherwise, for targets that
12998 do not need them, like for example HP-PA or IA-64, do nothing.
13000 A trampoline is a small piece of code that is created at run time on the
13001 stack when the address of a nested function is taken, and is used to call
13002 the nested function indirectly.  Therefore, it requires the stack to be
13003 made executable in order for the program to work properly.
13005 @option{-fno-trampolines} is enabled by default on a language by language
13006 basis to let the compiler avoid generating them, if it computes that this
13007 is safe, and replace them with descriptors.  Descriptors are made up of data
13008 only, but the generated code must be prepared to deal with them.  As of this
13009 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13011 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13012 @option{-fno-trampolines} are not binary compatible if nested functions are
13013 present.  This option must therefore be used on a program-wide basis and be
13014 manipulated with extreme care.
13016 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13017 @opindex fvisibility
13018 Set the default ELF image symbol visibility to the specified option---all
13019 symbols are marked with this unless overridden within the code.
13020 Using this feature can very substantially improve linking and
13021 load times of shared object libraries, produce more optimized
13022 code, provide near-perfect API export and prevent symbol clashes.
13023 It is @strong{strongly} recommended that you use this in any shared objects
13024 you distribute.
13026 Despite the nomenclature, @samp{default} always means public; i.e.,
13027 available to be linked against from outside the shared object.
13028 @samp{protected} and @samp{internal} are pretty useless in real-world
13029 usage so the only other commonly used option is @samp{hidden}.
13030 The default if @option{-fvisibility} isn't specified is
13031 @samp{default}, i.e., make every symbol public.
13033 A good explanation of the benefits offered by ensuring ELF
13034 symbols have the correct visibility is given by ``How To Write
13035 Shared Libraries'' by Ulrich Drepper (which can be found at
13036 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13037 solution made possible by this option to marking things hidden when
13038 the default is public is to make the default hidden and mark things
13039 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13040 and @code{__attribute__ ((visibility("default")))} instead of
13041 @code{__declspec(dllexport)} you get almost identical semantics with
13042 identical syntax.  This is a great boon to those working with
13043 cross-platform projects.
13045 For those adding visibility support to existing code, you may find
13046 @code{#pragma GCC visibility} of use.  This works by you enclosing
13047 the declarations you wish to set visibility for with (for example)
13048 @code{#pragma GCC visibility push(hidden)} and
13049 @code{#pragma GCC visibility pop}.
13050 Bear in mind that symbol visibility should be viewed @strong{as
13051 part of the API interface contract} and thus all new code should
13052 always specify visibility when it is not the default; i.e., declarations
13053 only for use within the local DSO should @strong{always} be marked explicitly
13054 as hidden as so to avoid PLT indirection overheads---making this
13055 abundantly clear also aids readability and self-documentation of the code.
13056 Note that due to ISO C++ specification requirements, @code{operator new} and
13057 @code{operator delete} must always be of default visibility.
13059 Be aware that headers from outside your project, in particular system
13060 headers and headers from any other library you use, may not be
13061 expecting to be compiled with visibility other than the default.  You
13062 may need to explicitly say @code{#pragma GCC visibility push(default)}
13063 before including any such headers.
13065 @code{extern} declarations are not affected by @option{-fvisibility}, so
13066 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13067 no modifications.  However, this means that calls to @code{extern}
13068 functions with no explicit visibility use the PLT, so it is more
13069 effective to use @code{__attribute ((visibility))} and/or
13070 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13071 declarations should be treated as hidden.
13073 Note that @option{-fvisibility} does affect C++ vague linkage
13074 entities. This means that, for instance, an exception class that is
13075 be thrown between DSOs must be explicitly marked with default
13076 visibility so that the @samp{type_info} nodes are unified between
13077 the DSOs.
13079 An overview of these techniques, their benefits and how to use them
13080 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13082 @item -fstrict-volatile-bitfields
13083 @opindex fstrict-volatile-bitfields
13084 This option should be used if accesses to volatile bit-fields (or other
13085 structure fields, although the compiler usually honors those types
13086 anyway) should use a single access of the width of the
13087 field's type, aligned to a natural alignment if possible.  For
13088 example, targets with memory-mapped peripheral registers might require
13089 all such accesses to be 16 bits wide; with this flag you can
13090 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13091 is 16 bits on these targets) to force GCC to use 16-bit accesses
13092 instead of, perhaps, a more efficient 32-bit access.
13094 If this option is disabled, the compiler uses the most efficient
13095 instruction.  In the previous example, that might be a 32-bit load
13096 instruction, even though that accesses bytes that do not contain
13097 any portion of the bit-field, or memory-mapped registers unrelated to
13098 the one being updated.
13100 In some cases, such as when the @code{packed} attribute is applied to a 
13101 structure field, it may not be possible to access the field with a single
13102 read or write that is correctly aligned for the target machine.  In this
13103 case GCC falls back to generating multiple accesses rather than code that 
13104 will fault or truncate the result at run time.
13106 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13107 not allowed to touch non bit-field members.  It is therefore recommended
13108 to define all bits of the field's type as bit-field members.
13110 The default value of this option is determined by the application binary
13111 interface for the target processor.
13113 @item -fsync-libcalls
13114 @opindex fsync-libcalls
13115 This option controls whether any out-of-line instance of the @code{__sync}
13116 family of functions may be used to implement the C++11 @code{__atomic}
13117 family of functions.
13119 The default value of this option is enabled, thus the only useful form
13120 of the option is @option{-fno-sync-libcalls}.  This option is used in
13121 the implementation of the @file{libatomic} runtime library.
13123 @end table
13125 @node Developer Options
13126 @section GCC Developer Options
13127 @cindex developer options
13128 @cindex debugging GCC
13129 @cindex debug dump options
13130 @cindex dump options
13131 @cindex compilation statistics
13133 This section describes command-line options that are primarily of
13134 interest to GCC developers, including options to support compiler
13135 testing and investigation of compiler bugs and compile-time
13136 performance problems.  This includes options that produce debug dumps
13137 at various points in the compilation; that print statistics such as
13138 memory use and execution time; and that print information about GCC's
13139 configuration, such as where it searches for libraries.  You should
13140 rarely need to use any of these options for ordinary compilation and
13141 linking tasks.
13143 @table @gcctabopt
13145 @item -d@var{letters}
13146 @itemx -fdump-rtl-@var{pass}
13147 @itemx -fdump-rtl-@var{pass}=@var{filename}
13148 @opindex d
13149 @opindex fdump-rtl-@var{pass}
13150 Says to make debugging dumps during compilation at times specified by
13151 @var{letters}.  This is used for debugging the RTL-based passes of the
13152 compiler.  The file names for most of the dumps are made by appending
13153 a pass number and a word to the @var{dumpname}, and the files are
13154 created in the directory of the output file.  In case of
13155 @option{=@var{filename}} option, the dump is output on the given file
13156 instead of the pass numbered dump files.  Note that the pass number is
13157 assigned as passes are registered into the pass manager.  Most passes
13158 are registered in the order that they will execute and for these passes
13159 the number corresponds to the pass execution order.  However, passes
13160 registered by plugins, passes specific to compilation targets, or
13161 passes that are otherwise registered after all the other passes are
13162 numbered higher than a pass named "final", even if they are executed
13163 earlier.  @var{dumpname} is generated from the name of the output
13164 file if explicitly specified and not an executable, otherwise it is
13165 the basename of the source file.  
13167 Some @option{-d@var{letters}} switches have different meaning when
13168 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13169 for information about preprocessor-specific dump options.
13171 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13172 @option{-d} option @var{letters}.  Here are the possible
13173 letters for use in @var{pass} and @var{letters}, and their meanings:
13175 @table @gcctabopt
13177 @item -fdump-rtl-alignments
13178 @opindex fdump-rtl-alignments
13179 Dump after branch alignments have been computed.
13181 @item -fdump-rtl-asmcons
13182 @opindex fdump-rtl-asmcons
13183 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13185 @item -fdump-rtl-auto_inc_dec
13186 @opindex fdump-rtl-auto_inc_dec
13187 Dump after auto-inc-dec discovery.  This pass is only run on
13188 architectures that have auto inc or auto dec instructions.
13190 @item -fdump-rtl-barriers
13191 @opindex fdump-rtl-barriers
13192 Dump after cleaning up the barrier instructions.
13194 @item -fdump-rtl-bbpart
13195 @opindex fdump-rtl-bbpart
13196 Dump after partitioning hot and cold basic blocks.
13198 @item -fdump-rtl-bbro
13199 @opindex fdump-rtl-bbro
13200 Dump after block reordering.
13202 @item -fdump-rtl-btl1
13203 @itemx -fdump-rtl-btl2
13204 @opindex fdump-rtl-btl2
13205 @opindex fdump-rtl-btl2
13206 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13207 after the two branch
13208 target load optimization passes.
13210 @item -fdump-rtl-bypass
13211 @opindex fdump-rtl-bypass
13212 Dump after jump bypassing and control flow optimizations.
13214 @item -fdump-rtl-combine
13215 @opindex fdump-rtl-combine
13216 Dump after the RTL instruction combination pass.
13218 @item -fdump-rtl-compgotos
13219 @opindex fdump-rtl-compgotos
13220 Dump after duplicating the computed gotos.
13222 @item -fdump-rtl-ce1
13223 @itemx -fdump-rtl-ce2
13224 @itemx -fdump-rtl-ce3
13225 @opindex fdump-rtl-ce1
13226 @opindex fdump-rtl-ce2
13227 @opindex fdump-rtl-ce3
13228 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13229 @option{-fdump-rtl-ce3} enable dumping after the three
13230 if conversion passes.
13232 @item -fdump-rtl-cprop_hardreg
13233 @opindex fdump-rtl-cprop_hardreg
13234 Dump after hard register copy propagation.
13236 @item -fdump-rtl-csa
13237 @opindex fdump-rtl-csa
13238 Dump after combining stack adjustments.
13240 @item -fdump-rtl-cse1
13241 @itemx -fdump-rtl-cse2
13242 @opindex fdump-rtl-cse1
13243 @opindex fdump-rtl-cse2
13244 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13245 the two common subexpression elimination passes.
13247 @item -fdump-rtl-dce
13248 @opindex fdump-rtl-dce
13249 Dump after the standalone dead code elimination passes.
13251 @item -fdump-rtl-dbr
13252 @opindex fdump-rtl-dbr
13253 Dump after delayed branch scheduling.
13255 @item -fdump-rtl-dce1
13256 @itemx -fdump-rtl-dce2
13257 @opindex fdump-rtl-dce1
13258 @opindex fdump-rtl-dce2
13259 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13260 the two dead store elimination passes.
13262 @item -fdump-rtl-eh
13263 @opindex fdump-rtl-eh
13264 Dump after finalization of EH handling code.
13266 @item -fdump-rtl-eh_ranges
13267 @opindex fdump-rtl-eh_ranges
13268 Dump after conversion of EH handling range regions.
13270 @item -fdump-rtl-expand
13271 @opindex fdump-rtl-expand
13272 Dump after RTL generation.
13274 @item -fdump-rtl-fwprop1
13275 @itemx -fdump-rtl-fwprop2
13276 @opindex fdump-rtl-fwprop1
13277 @opindex fdump-rtl-fwprop2
13278 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13279 dumping after the two forward propagation passes.
13281 @item -fdump-rtl-gcse1
13282 @itemx -fdump-rtl-gcse2
13283 @opindex fdump-rtl-gcse1
13284 @opindex fdump-rtl-gcse2
13285 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13286 after global common subexpression elimination.
13288 @item -fdump-rtl-init-regs
13289 @opindex fdump-rtl-init-regs
13290 Dump after the initialization of the registers.
13292 @item -fdump-rtl-initvals
13293 @opindex fdump-rtl-initvals
13294 Dump after the computation of the initial value sets.
13296 @item -fdump-rtl-into_cfglayout
13297 @opindex fdump-rtl-into_cfglayout
13298 Dump after converting to cfglayout mode.
13300 @item -fdump-rtl-ira
13301 @opindex fdump-rtl-ira
13302 Dump after iterated register allocation.
13304 @item -fdump-rtl-jump
13305 @opindex fdump-rtl-jump
13306 Dump after the second jump optimization.
13308 @item -fdump-rtl-loop2
13309 @opindex fdump-rtl-loop2
13310 @option{-fdump-rtl-loop2} enables dumping after the rtl
13311 loop optimization passes.
13313 @item -fdump-rtl-mach
13314 @opindex fdump-rtl-mach
13315 Dump after performing the machine dependent reorganization pass, if that
13316 pass exists.
13318 @item -fdump-rtl-mode_sw
13319 @opindex fdump-rtl-mode_sw
13320 Dump after removing redundant mode switches.
13322 @item -fdump-rtl-rnreg
13323 @opindex fdump-rtl-rnreg
13324 Dump after register renumbering.
13326 @item -fdump-rtl-outof_cfglayout
13327 @opindex fdump-rtl-outof_cfglayout
13328 Dump after converting from cfglayout mode.
13330 @item -fdump-rtl-peephole2
13331 @opindex fdump-rtl-peephole2
13332 Dump after the peephole pass.
13334 @item -fdump-rtl-postreload
13335 @opindex fdump-rtl-postreload
13336 Dump after post-reload optimizations.
13338 @item -fdump-rtl-pro_and_epilogue
13339 @opindex fdump-rtl-pro_and_epilogue
13340 Dump after generating the function prologues and epilogues.
13342 @item -fdump-rtl-sched1
13343 @itemx -fdump-rtl-sched2
13344 @opindex fdump-rtl-sched1
13345 @opindex fdump-rtl-sched2
13346 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13347 after the basic block scheduling passes.
13349 @item -fdump-rtl-ree
13350 @opindex fdump-rtl-ree
13351 Dump after sign/zero extension elimination.
13353 @item -fdump-rtl-seqabstr
13354 @opindex fdump-rtl-seqabstr
13355 Dump after common sequence discovery.
13357 @item -fdump-rtl-shorten
13358 @opindex fdump-rtl-shorten
13359 Dump after shortening branches.
13361 @item -fdump-rtl-sibling
13362 @opindex fdump-rtl-sibling
13363 Dump after sibling call optimizations.
13365 @item -fdump-rtl-split1
13366 @itemx -fdump-rtl-split2
13367 @itemx -fdump-rtl-split3
13368 @itemx -fdump-rtl-split4
13369 @itemx -fdump-rtl-split5
13370 @opindex fdump-rtl-split1
13371 @opindex fdump-rtl-split2
13372 @opindex fdump-rtl-split3
13373 @opindex fdump-rtl-split4
13374 @opindex fdump-rtl-split5
13375 These options enable dumping after five rounds of
13376 instruction splitting.
13378 @item -fdump-rtl-sms
13379 @opindex fdump-rtl-sms
13380 Dump after modulo scheduling.  This pass is only run on some
13381 architectures.
13383 @item -fdump-rtl-stack
13384 @opindex fdump-rtl-stack
13385 Dump after conversion from GCC's ``flat register file'' registers to the
13386 x87's stack-like registers.  This pass is only run on x86 variants.
13388 @item -fdump-rtl-subreg1
13389 @itemx -fdump-rtl-subreg2
13390 @opindex fdump-rtl-subreg1
13391 @opindex fdump-rtl-subreg2
13392 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13393 the two subreg expansion passes.
13395 @item -fdump-rtl-unshare
13396 @opindex fdump-rtl-unshare
13397 Dump after all rtl has been unshared.
13399 @item -fdump-rtl-vartrack
13400 @opindex fdump-rtl-vartrack
13401 Dump after variable tracking.
13403 @item -fdump-rtl-vregs
13404 @opindex fdump-rtl-vregs
13405 Dump after converting virtual registers to hard registers.
13407 @item -fdump-rtl-web
13408 @opindex fdump-rtl-web
13409 Dump after live range splitting.
13411 @item -fdump-rtl-regclass
13412 @itemx -fdump-rtl-subregs_of_mode_init
13413 @itemx -fdump-rtl-subregs_of_mode_finish
13414 @itemx -fdump-rtl-dfinit
13415 @itemx -fdump-rtl-dfinish
13416 @opindex fdump-rtl-regclass
13417 @opindex fdump-rtl-subregs_of_mode_init
13418 @opindex fdump-rtl-subregs_of_mode_finish
13419 @opindex fdump-rtl-dfinit
13420 @opindex fdump-rtl-dfinish
13421 These dumps are defined but always produce empty files.
13423 @item -da
13424 @itemx -fdump-rtl-all
13425 @opindex da
13426 @opindex fdump-rtl-all
13427 Produce all the dumps listed above.
13429 @item -dA
13430 @opindex dA
13431 Annotate the assembler output with miscellaneous debugging information.
13433 @item -dD
13434 @opindex dD
13435 Dump all macro definitions, at the end of preprocessing, in addition to
13436 normal output.
13438 @item -dH
13439 @opindex dH
13440 Produce a core dump whenever an error occurs.
13442 @item -dp
13443 @opindex dp
13444 Annotate the assembler output with a comment indicating which
13445 pattern and alternative is used.  The length and cost of each instruction are
13446 also printed.
13448 @item -dP
13449 @opindex dP
13450 Dump the RTL in the assembler output as a comment before each instruction.
13451 Also turns on @option{-dp} annotation.
13453 @item -dx
13454 @opindex dx
13455 Just generate RTL for a function instead of compiling it.  Usually used
13456 with @option{-fdump-rtl-expand}.
13457 @end table
13459 @item -fdump-noaddr
13460 @opindex fdump-noaddr
13461 When doing debugging dumps, suppress address output.  This makes it more
13462 feasible to use diff on debugging dumps for compiler invocations with
13463 different compiler binaries and/or different
13464 text / bss / data / heap / stack / dso start locations.
13466 @item -freport-bug
13467 @opindex freport-bug
13468 Collect and dump debug information into a temporary file if an
13469 internal compiler error (ICE) occurs.
13471 @item -fdump-unnumbered
13472 @opindex fdump-unnumbered
13473 When doing debugging dumps, suppress instruction numbers and address output.
13474 This makes it more feasible to use diff on debugging dumps for compiler
13475 invocations with different options, in particular with and without
13476 @option{-g}.
13478 @item -fdump-unnumbered-links
13479 @opindex fdump-unnumbered-links
13480 When doing debugging dumps (see @option{-d} option above), suppress
13481 instruction numbers for the links to the previous and next instructions
13482 in a sequence.
13484 @item -fdump-ipa-@var{switch}
13485 @opindex fdump-ipa
13486 Control the dumping at various stages of inter-procedural analysis
13487 language tree to a file.  The file name is generated by appending a
13488 switch specific suffix to the source file name, and the file is created
13489 in the same directory as the output file.  The following dumps are
13490 possible:
13492 @table @samp
13493 @item all
13494 Enables all inter-procedural analysis dumps.
13496 @item cgraph
13497 Dumps information about call-graph optimization, unused function removal,
13498 and inlining decisions.
13500 @item inline
13501 Dump after function inlining.
13503 @end table
13505 @item -fdump-lang-all
13506 @itemx -fdump-lang-@var{switch}
13507 @itemx -fdump-lang-@var{switch}-@var{options}
13508 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13509 @opindex fdump-lang-all
13510 @opindex fdump-lang
13511 Control the dumping of language-specific information.  The @var{options}
13512 and @var{filename} portions behave as described in the
13513 @option{-fdump-tree} option.  The following @var{switch} values are
13514 accepted:
13516 @table @samp
13517 @item all
13519 Enable all language-specific dumps.
13521 @item class
13522 Dump class hierarchy information.  Virtual table information is emitted
13523 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13525 @item raw
13526 Dump the raw internal tree data.  This option is applicable to C++ only.
13528 @end table
13530 @item -fdump-passes
13531 @opindex fdump-passes
13532 Print on @file{stderr} the list of optimization passes that are turned
13533 on and off by the current command-line options.
13535 @item -fdump-statistics-@var{option}
13536 @opindex fdump-statistics
13537 Enable and control dumping of pass statistics in a separate file.  The
13538 file name is generated by appending a suffix ending in
13539 @samp{.statistics} to the source file name, and the file is created in
13540 the same directory as the output file.  If the @samp{-@var{option}}
13541 form is used, @samp{-stats} causes counters to be summed over the
13542 whole compilation unit while @samp{-details} dumps every event as
13543 the passes generate them.  The default with no option is to sum
13544 counters for each function compiled.
13546 @item -fdump-tree-all
13547 @itemx -fdump-tree-@var{switch}
13548 @itemx -fdump-tree-@var{switch}-@var{options}
13549 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13550 @opindex fdump-tree-all
13551 @opindex fdump-tree
13552 Control the dumping at various stages of processing the intermediate
13553 language tree to a file.  The file name is generated by appending a
13554 switch-specific suffix to the source file name, and the file is
13555 created in the same directory as the output file. In case of
13556 @option{=@var{filename}} option, the dump is output on the given file
13557 instead of the auto named dump files.  If the @samp{-@var{options}}
13558 form is used, @var{options} is a list of @samp{-} separated options
13559 which control the details of the dump.  Not all options are applicable
13560 to all dumps; those that are not meaningful are ignored.  The
13561 following options are available
13563 @table @samp
13564 @item address
13565 Print the address of each node.  Usually this is not meaningful as it
13566 changes according to the environment and source file.  Its primary use
13567 is for tying up a dump file with a debug environment.
13568 @item asmname
13569 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13570 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13571 use working backward from mangled names in the assembly file.
13572 @item slim
13573 When dumping front-end intermediate representations, inhibit dumping
13574 of members of a scope or body of a function merely because that scope
13575 has been reached.  Only dump such items when they are directly reachable
13576 by some other path.
13578 When dumping pretty-printed trees, this option inhibits dumping the
13579 bodies of control structures.
13581 When dumping RTL, print the RTL in slim (condensed) form instead of
13582 the default LISP-like representation.
13583 @item raw
13584 Print a raw representation of the tree.  By default, trees are
13585 pretty-printed into a C-like representation.
13586 @item details
13587 Enable more detailed dumps (not honored by every dump option). Also
13588 include information from the optimization passes.
13589 @item stats
13590 Enable dumping various statistics about the pass (not honored by every dump
13591 option).
13592 @item blocks
13593 Enable showing basic block boundaries (disabled in raw dumps).
13594 @item graph
13595 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13596 dump a representation of the control flow graph suitable for viewing with
13597 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13598 the file is pretty-printed as a subgraph, so that GraphViz can render them
13599 all in a single plot.
13601 This option currently only works for RTL dumps, and the RTL is always
13602 dumped in slim form.
13603 @item vops
13604 Enable showing virtual operands for every statement.
13605 @item lineno
13606 Enable showing line numbers for statements.
13607 @item uid
13608 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13609 @item verbose
13610 Enable showing the tree dump for each statement.
13611 @item eh
13612 Enable showing the EH region number holding each statement.
13613 @item scev
13614 Enable showing scalar evolution analysis details.
13615 @item optimized
13616 Enable showing optimization information (only available in certain
13617 passes).
13618 @item missed
13619 Enable showing missed optimization information (only available in certain
13620 passes).
13621 @item note
13622 Enable other detailed optimization information (only available in
13623 certain passes).
13624 @item =@var{filename}
13625 Instead of an auto named dump file, output into the given file
13626 name. The file names @file{stdout} and @file{stderr} are treated
13627 specially and are considered already open standard streams. For
13628 example,
13630 @smallexample
13631 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13632      -fdump-tree-pre=/dev/stderr file.c
13633 @end smallexample
13635 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13636 output on to @file{stderr}. If two conflicting dump filenames are
13637 given for the same pass, then the latter option overrides the earlier
13638 one.
13640 @item all
13641 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13642 and @option{lineno}.
13644 @item optall
13645 Turn on all optimization options, i.e., @option{optimized},
13646 @option{missed}, and @option{note}.
13647 @end table
13649 To determine what tree dumps are available or find the dump for a pass
13650 of interest follow the steps below.
13652 @enumerate
13653 @item
13654 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13655 look for a code that corresponds to the pass you are interested in.
13656 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13657 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13658 The number at the end distinguishes distinct invocations of the same pass.
13659 @item
13660 To enable the creation of the dump file, append the pass code to
13661 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13662 to enable the dump from the Early Value Range Propagation pass, invoke
13663 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13664 specify the name of the dump file.  If you don't specify one, GCC
13665 creates as described below.
13666 @item
13667 Find the pass dump in a file whose name is composed of three components
13668 separated by a period: the name of the source file GCC was invoked to
13669 compile, a numeric suffix indicating the pass number followed by the
13670 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13671 and finally the pass code.  For example, the Early VRP pass dump might
13672 be in a file named @file{myfile.c.038t.evrp} in the current working
13673 directory.  Note that the numeric codes are not stable and may change
13674 from one version of GCC to another.
13675 @end enumerate
13677 @item -fopt-info
13678 @itemx -fopt-info-@var{options}
13679 @itemx -fopt-info-@var{options}=@var{filename}
13680 @opindex fopt-info
13681 Controls optimization dumps from various optimization passes. If the
13682 @samp{-@var{options}} form is used, @var{options} is a list of
13683 @samp{-} separated option keywords to select the dump details and
13684 optimizations.  
13686 The @var{options} can be divided into two groups: options describing the
13687 verbosity of the dump, and options describing which optimizations
13688 should be included. The options from both the groups can be freely
13689 mixed as they are non-overlapping. However, in case of any conflicts,
13690 the later options override the earlier options on the command
13691 line. 
13693 The following options control the dump verbosity:
13695 @table @samp
13696 @item optimized
13697 Print information when an optimization is successfully applied. It is
13698 up to a pass to decide which information is relevant. For example, the
13699 vectorizer passes print the source location of loops which are
13700 successfully vectorized.
13701 @item missed
13702 Print information about missed optimizations. Individual passes
13703 control which information to include in the output. 
13704 @item note
13705 Print verbose information about optimizations, such as certain
13706 transformations, more detailed messages about decisions etc.
13707 @item all
13708 Print detailed optimization information. This includes
13709 @samp{optimized}, @samp{missed}, and @samp{note}.
13710 @end table
13712 One or more of the following option keywords can be used to describe a
13713 group of optimizations:
13715 @table @samp
13716 @item ipa
13717 Enable dumps from all interprocedural optimizations.
13718 @item loop
13719 Enable dumps from all loop optimizations.
13720 @item inline
13721 Enable dumps from all inlining optimizations.
13722 @item omp
13723 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13724 @item vec
13725 Enable dumps from all vectorization optimizations.
13726 @item optall
13727 Enable dumps from all optimizations. This is a superset of
13728 the optimization groups listed above.
13729 @end table
13731 If @var{options} is
13732 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13733 info about successful optimizations from all the passes.  
13735 If the @var{filename} is provided, then the dumps from all the
13736 applicable optimizations are concatenated into the @var{filename}.
13737 Otherwise the dump is output onto @file{stderr}. Though multiple
13738 @option{-fopt-info} options are accepted, only one of them can include
13739 a @var{filename}. If other filenames are provided then all but the
13740 first such option are ignored.
13742 Note that the output @var{filename} is overwritten
13743 in case of multiple translation units. If a combined output from
13744 multiple translation units is desired, @file{stderr} should be used
13745 instead.
13747 In the following example, the optimization info is output to
13748 @file{stderr}:
13750 @smallexample
13751 gcc -O3 -fopt-info
13752 @end smallexample
13754 This example:
13755 @smallexample
13756 gcc -O3 -fopt-info-missed=missed.all
13757 @end smallexample
13759 @noindent
13760 outputs missed optimization report from all the passes into
13761 @file{missed.all}, and this one:
13763 @smallexample
13764 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13765 @end smallexample
13767 @noindent
13768 prints information about missed optimization opportunities from
13769 vectorization passes on @file{stderr}.  
13770 Note that @option{-fopt-info-vec-missed} is equivalent to 
13771 @option{-fopt-info-missed-vec}.  The order of the optimization group
13772 names and message types listed after @option{-fopt-info} does not matter.
13774 As another example,
13775 @smallexample
13776 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13777 @end smallexample
13779 @noindent
13780 outputs information about missed optimizations as well as
13781 optimized locations from all the inlining passes into
13782 @file{inline.txt}.
13784 Finally, consider:
13786 @smallexample
13787 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13788 @end smallexample
13790 @noindent
13791 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13792 in conflict since only one output file is allowed. In this case, only
13793 the first option takes effect and the subsequent options are
13794 ignored. Thus only @file{vec.miss} is produced which contains
13795 dumps from the vectorizer about missed opportunities.
13797 @item -fsched-verbose=@var{n}
13798 @opindex fsched-verbose
13799 On targets that use instruction scheduling, this option controls the
13800 amount of debugging output the scheduler prints to the dump files.
13802 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13803 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13804 For @var{n} greater than one, it also output basic block probabilities,
13805 detailed ready list information and unit/insn info.  For @var{n} greater
13806 than two, it includes RTL at abort point, control-flow and regions info.
13807 And for @var{n} over four, @option{-fsched-verbose} also includes
13808 dependence info.
13812 @item -fenable-@var{kind}-@var{pass}
13813 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13814 @opindex fdisable-
13815 @opindex fenable-
13817 This is a set of options that are used to explicitly disable/enable
13818 optimization passes.  These options are intended for use for debugging GCC.
13819 Compiler users should use regular options for enabling/disabling
13820 passes instead.
13822 @table @gcctabopt
13824 @item -fdisable-ipa-@var{pass}
13825 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13826 statically invoked in the compiler multiple times, the pass name should be
13827 appended with a sequential number starting from 1.
13829 @item -fdisable-rtl-@var{pass}
13830 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13831 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13832 statically invoked in the compiler multiple times, the pass name should be
13833 appended with a sequential number starting from 1.  @var{range-list} is a 
13834 comma-separated list of function ranges or assembler names.  Each range is a number
13835 pair separated by a colon.  The range is inclusive in both ends.  If the range
13836 is trivial, the number pair can be simplified as a single number.  If the
13837 function's call graph node's @var{uid} falls within one of the specified ranges,
13838 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13839 function header of a dump file, and the pass names can be dumped by using
13840 option @option{-fdump-passes}.
13842 @item -fdisable-tree-@var{pass}
13843 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13844 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13845 option arguments.
13847 @item -fenable-ipa-@var{pass}
13848 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13849 statically invoked in the compiler multiple times, the pass name should be
13850 appended with a sequential number starting from 1.
13852 @item -fenable-rtl-@var{pass}
13853 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13854 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13855 description and examples.
13857 @item -fenable-tree-@var{pass}
13858 @itemx -fenable-tree-@var{pass}=@var{range-list}
13859 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13860 of option arguments.
13862 @end table
13864 Here are some examples showing uses of these options.
13866 @smallexample
13868 # disable ccp1 for all functions
13869    -fdisable-tree-ccp1
13870 # disable complete unroll for function whose cgraph node uid is 1
13871    -fenable-tree-cunroll=1
13872 # disable gcse2 for functions at the following ranges [1,1],
13873 # [300,400], and [400,1000]
13874 # disable gcse2 for functions foo and foo2
13875    -fdisable-rtl-gcse2=foo,foo2
13876 # disable early inlining
13877    -fdisable-tree-einline
13878 # disable ipa inlining
13879    -fdisable-ipa-inline
13880 # enable tree full unroll
13881    -fenable-tree-unroll
13883 @end smallexample
13885 @item -fchecking
13886 @itemx -fchecking=@var{n}
13887 @opindex fchecking
13888 @opindex fno-checking
13889 Enable internal consistency checking.  The default depends on
13890 the compiler configuration.  @option{-fchecking=2} enables further
13891 internal consistency checking that might affect code generation.
13893 @item -frandom-seed=@var{string}
13894 @opindex frandom-seed
13895 This option provides a seed that GCC uses in place of
13896 random numbers in generating certain symbol names
13897 that have to be different in every compiled file.  It is also used to
13898 place unique stamps in coverage data files and the object files that
13899 produce them.  You can use the @option{-frandom-seed} option to produce
13900 reproducibly identical object files.
13902 The @var{string} can either be a number (decimal, octal or hex) or an
13903 arbitrary string (in which case it's converted to a number by
13904 computing CRC32).
13906 The @var{string} should be different for every file you compile.
13908 @item -save-temps
13909 @itemx -save-temps=cwd
13910 @opindex save-temps
13911 Store the usual ``temporary'' intermediate files permanently; place them
13912 in the current directory and name them based on the source file.  Thus,
13913 compiling @file{foo.c} with @option{-c -save-temps} produces files
13914 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13915 preprocessed @file{foo.i} output file even though the compiler now
13916 normally uses an integrated preprocessor.
13918 When used in combination with the @option{-x} command-line option,
13919 @option{-save-temps} is sensible enough to avoid over writing an
13920 input source file with the same extension as an intermediate file.
13921 The corresponding intermediate file may be obtained by renaming the
13922 source file before using @option{-save-temps}.
13924 If you invoke GCC in parallel, compiling several different source
13925 files that share a common base name in different subdirectories or the
13926 same source file compiled for multiple output destinations, it is
13927 likely that the different parallel compilers will interfere with each
13928 other, and overwrite the temporary files.  For instance:
13930 @smallexample
13931 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13932 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13933 @end smallexample
13935 may result in @file{foo.i} and @file{foo.o} being written to
13936 simultaneously by both compilers.
13938 @item -save-temps=obj
13939 @opindex save-temps=obj
13940 Store the usual ``temporary'' intermediate files permanently.  If the
13941 @option{-o} option is used, the temporary files are based on the
13942 object file.  If the @option{-o} option is not used, the
13943 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13945 For example:
13947 @smallexample
13948 gcc -save-temps=obj -c foo.c
13949 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13950 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13951 @end smallexample
13953 @noindent
13954 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13955 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13956 @file{dir2/yfoobar.o}.
13958 @item -time@r{[}=@var{file}@r{]}
13959 @opindex time
13960 Report the CPU time taken by each subprocess in the compilation
13961 sequence.  For C source files, this is the compiler proper and assembler
13962 (plus the linker if linking is done).
13964 Without the specification of an output file, the output looks like this:
13966 @smallexample
13967 # cc1 0.12 0.01
13968 # as 0.00 0.01
13969 @end smallexample
13971 The first number on each line is the ``user time'', that is time spent
13972 executing the program itself.  The second number is ``system time'',
13973 time spent executing operating system routines on behalf of the program.
13974 Both numbers are in seconds.
13976 With the specification of an output file, the output is appended to the
13977 named file, and it looks like this:
13979 @smallexample
13980 0.12 0.01 cc1 @var{options}
13981 0.00 0.01 as @var{options}
13982 @end smallexample
13984 The ``user time'' and the ``system time'' are moved before the program
13985 name, and the options passed to the program are displayed, so that one
13986 can later tell what file was being compiled, and with which options.
13988 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13989 @opindex fdump-final-insns
13990 Dump the final internal representation (RTL) to @var{file}.  If the
13991 optional argument is omitted (or if @var{file} is @code{.}), the name
13992 of the dump file is determined by appending @code{.gkd} to the
13993 compilation output file name.
13995 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13996 @opindex fcompare-debug
13997 @opindex fno-compare-debug
13998 If no error occurs during compilation, run the compiler a second time,
13999 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14000 passed to the second compilation.  Dump the final internal
14001 representation in both compilations, and print an error if they differ.
14003 If the equal sign is omitted, the default @option{-gtoggle} is used.
14005 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14006 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14007 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14008 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14009 is used.
14011 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14012 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14013 of the final representation and the second compilation, preventing even
14014 @env{GCC_COMPARE_DEBUG} from taking effect.
14016 To verify full coverage during @option{-fcompare-debug} testing, set
14017 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14018 which GCC rejects as an invalid option in any actual compilation
14019 (rather than preprocessing, assembly or linking).  To get just a
14020 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14021 not overridden} will do.
14023 @item -fcompare-debug-second
14024 @opindex fcompare-debug-second
14025 This option is implicitly passed to the compiler for the second
14026 compilation requested by @option{-fcompare-debug}, along with options to
14027 silence warnings, and omitting other options that would cause
14028 side-effect compiler outputs to files or to the standard output.  Dump
14029 files and preserved temporary files are renamed so as to contain the
14030 @code{.gk} additional extension during the second compilation, to avoid
14031 overwriting those generated by the first.
14033 When this option is passed to the compiler driver, it causes the
14034 @emph{first} compilation to be skipped, which makes it useful for little
14035 other than debugging the compiler proper.
14037 @item -gtoggle
14038 @opindex gtoggle
14039 Turn off generation of debug info, if leaving out this option
14040 generates it, or turn it on at level 2 otherwise.  The position of this
14041 argument in the command line does not matter; it takes effect after all
14042 other options are processed, and it does so only once, no matter how
14043 many times it is given.  This is mainly intended to be used with
14044 @option{-fcompare-debug}.
14046 @item -fvar-tracking-assignments-toggle
14047 @opindex fvar-tracking-assignments-toggle
14048 @opindex fno-var-tracking-assignments-toggle
14049 Toggle @option{-fvar-tracking-assignments}, in the same way that
14050 @option{-gtoggle} toggles @option{-g}.
14052 @item -Q
14053 @opindex Q
14054 Makes the compiler print out each function name as it is compiled, and
14055 print some statistics about each pass when it finishes.
14057 @item -ftime-report
14058 @opindex ftime-report
14059 Makes the compiler print some statistics about the time consumed by each
14060 pass when it finishes.
14062 @item -ftime-report-details
14063 @opindex ftime-report-details
14064 Record the time consumed by infrastructure parts separately for each pass.
14066 @item -fira-verbose=@var{n}
14067 @opindex fira-verbose
14068 Control the verbosity of the dump file for the integrated register allocator.
14069 The default value is 5.  If the value @var{n} is greater or equal to 10,
14070 the dump output is sent to stderr using the same format as @var{n} minus 10.
14072 @item -flto-report
14073 @opindex flto-report
14074 Prints a report with internal details on the workings of the link-time
14075 optimizer.  The contents of this report vary from version to version.
14076 It is meant to be useful to GCC developers when processing object
14077 files in LTO mode (via @option{-flto}).
14079 Disabled by default.
14081 @item -flto-report-wpa
14082 @opindex flto-report-wpa
14083 Like @option{-flto-report}, but only print for the WPA phase of Link
14084 Time Optimization.
14086 @item -fmem-report
14087 @opindex fmem-report
14088 Makes the compiler print some statistics about permanent memory
14089 allocation when it finishes.
14091 @item -fmem-report-wpa
14092 @opindex fmem-report-wpa
14093 Makes the compiler print some statistics about permanent memory
14094 allocation for the WPA phase only.
14096 @item -fpre-ipa-mem-report
14097 @opindex fpre-ipa-mem-report
14098 @item -fpost-ipa-mem-report
14099 @opindex fpost-ipa-mem-report
14100 Makes the compiler print some statistics about permanent memory
14101 allocation before or after interprocedural optimization.
14103 @item -fprofile-report
14104 @opindex fprofile-report
14105 Makes the compiler print some statistics about consistency of the
14106 (estimated) profile and effect of individual passes.
14108 @item -fstack-usage
14109 @opindex fstack-usage
14110 Makes the compiler output stack usage information for the program, on a
14111 per-function basis.  The filename for the dump is made by appending
14112 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14113 the output file, if explicitly specified and it is not an executable,
14114 otherwise it is the basename of the source file.  An entry is made up
14115 of three fields:
14117 @itemize
14118 @item
14119 The name of the function.
14120 @item
14121 A number of bytes.
14122 @item
14123 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14124 @end itemize
14126 The qualifier @code{static} means that the function manipulates the stack
14127 statically: a fixed number of bytes are allocated for the frame on function
14128 entry and released on function exit; no stack adjustments are otherwise made
14129 in the function.  The second field is this fixed number of bytes.
14131 The qualifier @code{dynamic} means that the function manipulates the stack
14132 dynamically: in addition to the static allocation described above, stack
14133 adjustments are made in the body of the function, for example to push/pop
14134 arguments around function calls.  If the qualifier @code{bounded} is also
14135 present, the amount of these adjustments is bounded at compile time and
14136 the second field is an upper bound of the total amount of stack used by
14137 the function.  If it is not present, the amount of these adjustments is
14138 not bounded at compile time and the second field only represents the
14139 bounded part.
14141 @item -fstats
14142 @opindex fstats
14143 Emit statistics about front-end processing at the end of the compilation.
14144 This option is supported only by the C++ front end, and
14145 the information is generally only useful to the G++ development team.
14147 @item -fdbg-cnt-list
14148 @opindex fdbg-cnt-list
14149 Print the name and the counter upper bound for all debug counters.
14152 @item -fdbg-cnt=@var{counter-value-list}
14153 @opindex fdbg-cnt
14154 Set the internal debug counter upper bound.  @var{counter-value-list}
14155 is a comma-separated list of @var{name}:@var{value} pairs
14156 which sets the upper bound of each debug counter @var{name} to @var{value}.
14157 All debug counters have the initial upper bound of @code{UINT_MAX};
14158 thus @code{dbg_cnt} returns true always unless the upper bound
14159 is set by this option.
14160 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14161 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14163 @item -print-file-name=@var{library}
14164 @opindex print-file-name
14165 Print the full absolute name of the library file @var{library} that
14166 would be used when linking---and don't do anything else.  With this
14167 option, GCC does not compile or link anything; it just prints the
14168 file name.
14170 @item -print-multi-directory
14171 @opindex print-multi-directory
14172 Print the directory name corresponding to the multilib selected by any
14173 other switches present in the command line.  This directory is supposed
14174 to exist in @env{GCC_EXEC_PREFIX}.
14176 @item -print-multi-lib
14177 @opindex print-multi-lib
14178 Print the mapping from multilib directory names to compiler switches
14179 that enable them.  The directory name is separated from the switches by
14180 @samp{;}, and each switch starts with an @samp{@@} instead of the
14181 @samp{-}, without spaces between multiple switches.  This is supposed to
14182 ease shell processing.
14184 @item -print-multi-os-directory
14185 @opindex print-multi-os-directory
14186 Print the path to OS libraries for the selected
14187 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14188 present in the @file{lib} subdirectory and no multilibs are used, this is
14189 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14190 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14191 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14192 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14194 @item -print-multiarch
14195 @opindex print-multiarch
14196 Print the path to OS libraries for the selected multiarch,
14197 relative to some @file{lib} subdirectory.
14199 @item -print-prog-name=@var{program}
14200 @opindex print-prog-name
14201 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14203 @item -print-libgcc-file-name
14204 @opindex print-libgcc-file-name
14205 Same as @option{-print-file-name=libgcc.a}.
14207 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14208 but you do want to link with @file{libgcc.a}.  You can do:
14210 @smallexample
14211 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14212 @end smallexample
14214 @item -print-search-dirs
14215 @opindex print-search-dirs
14216 Print the name of the configured installation directory and a list of
14217 program and library directories @command{gcc} searches---and don't do anything else.
14219 This is useful when @command{gcc} prints the error message
14220 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14221 To resolve this you either need to put @file{cpp0} and the other compiler
14222 components where @command{gcc} expects to find them, or you can set the environment
14223 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14224 Don't forget the trailing @samp{/}.
14225 @xref{Environment Variables}.
14227 @item -print-sysroot
14228 @opindex print-sysroot
14229 Print the target sysroot directory that is used during
14230 compilation.  This is the target sysroot specified either at configure
14231 time or using the @option{--sysroot} option, possibly with an extra
14232 suffix that depends on compilation options.  If no target sysroot is
14233 specified, the option prints nothing.
14235 @item -print-sysroot-headers-suffix
14236 @opindex print-sysroot-headers-suffix
14237 Print the suffix added to the target sysroot when searching for
14238 headers, or give an error if the compiler is not configured with such
14239 a suffix---and don't do anything else.
14241 @item -dumpmachine
14242 @opindex dumpmachine
14243 Print the compiler's target machine (for example,
14244 @samp{i686-pc-linux-gnu})---and don't do anything else.
14246 @item -dumpversion
14247 @opindex dumpversion
14248 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14249 anything else.  This is the compiler version used in filesystem paths,
14250 specs, can be depending on how the compiler has been configured just
14251 a single number (major version), two numbers separated by dot (major and
14252 minor version) or three numbers separated by dots (major, minor and patchlevel
14253 version).
14255 @item -dumpfullversion
14256 @opindex dumpfullversion
14257 Print the full compiler version, always 3 numbers separated by dots,
14258 major, minor and patchlevel version.
14260 @item -dumpspecs
14261 @opindex dumpspecs
14262 Print the compiler's built-in specs---and don't do anything else.  (This
14263 is used when GCC itself is being built.)  @xref{Spec Files}.
14264 @end table
14266 @node Submodel Options
14267 @section Machine-Dependent Options
14268 @cindex submodel options
14269 @cindex specifying hardware config
14270 @cindex hardware models and configurations, specifying
14271 @cindex target-dependent options
14272 @cindex machine-dependent options
14274 Each target machine supported by GCC can have its own options---for
14275 example, to allow you to compile for a particular processor variant or
14276 ABI, or to control optimizations specific to that machine.  By
14277 convention, the names of machine-specific options start with
14278 @samp{-m}.
14280 Some configurations of the compiler also support additional target-specific
14281 options, usually for compatibility with other compilers on the same
14282 platform.
14284 @c This list is ordered alphanumerically by subsection name.
14285 @c It should be the same order and spelling as these options are listed
14286 @c in Machine Dependent Options
14288 @menu
14289 * AArch64 Options::
14290 * Adapteva Epiphany Options::
14291 * ARC Options::
14292 * ARM Options::
14293 * AVR Options::
14294 * Blackfin Options::
14295 * C6X Options::
14296 * CRIS Options::
14297 * CR16 Options::
14298 * Darwin Options::
14299 * DEC Alpha Options::
14300 * FR30 Options::
14301 * FT32 Options::
14302 * FRV Options::
14303 * GNU/Linux Options::
14304 * H8/300 Options::
14305 * HPPA Options::
14306 * IA-64 Options::
14307 * LM32 Options::
14308 * M32C Options::
14309 * M32R/D Options::
14310 * M680x0 Options::
14311 * MCore Options::
14312 * MeP Options::
14313 * MicroBlaze Options::
14314 * MIPS Options::
14315 * MMIX Options::
14316 * MN10300 Options::
14317 * Moxie Options::
14318 * MSP430 Options::
14319 * NDS32 Options::
14320 * Nios II Options::
14321 * Nvidia PTX Options::
14322 * PDP-11 Options::
14323 * picoChip Options::
14324 * PowerPC Options::
14325 * RISC-V Options::
14326 * RL78 Options::
14327 * RS/6000 and PowerPC Options::
14328 * RX Options::
14329 * S/390 and zSeries Options::
14330 * Score Options::
14331 * SH Options::
14332 * Solaris 2 Options::
14333 * SPARC Options::
14334 * SPU Options::
14335 * System V Options::
14336 * TILE-Gx Options::
14337 * TILEPro Options::
14338 * V850 Options::
14339 * VAX Options::
14340 * Visium Options::
14341 * VMS Options::
14342 * VxWorks Options::
14343 * x86 Options::
14344 * x86 Windows Options::
14345 * Xstormy16 Options::
14346 * Xtensa Options::
14347 * zSeries Options::
14348 @end menu
14350 @node AArch64 Options
14351 @subsection AArch64 Options
14352 @cindex AArch64 Options
14354 These options are defined for AArch64 implementations:
14356 @table @gcctabopt
14358 @item -mabi=@var{name}
14359 @opindex mabi
14360 Generate code for the specified data model.  Permissible values
14361 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14362 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14363 but long int and pointers are 64 bits.
14365 The default depends on the specific target configuration.  Note that
14366 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14367 entire program with the same ABI, and link with a compatible set of libraries.
14369 @item -mbig-endian
14370 @opindex mbig-endian
14371 Generate big-endian code.  This is the default when GCC is configured for an
14372 @samp{aarch64_be-*-*} target.
14374 @item -mgeneral-regs-only
14375 @opindex mgeneral-regs-only
14376 Generate code which uses only the general-purpose registers.  This will prevent
14377 the compiler from using floating-point and Advanced SIMD registers but will not
14378 impose any restrictions on the assembler.
14380 @item -mlittle-endian
14381 @opindex mlittle-endian
14382 Generate little-endian code.  This is the default when GCC is configured for an
14383 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14385 @item -mcmodel=tiny
14386 @opindex mcmodel=tiny
14387 Generate code for the tiny code model.  The program and its statically defined
14388 symbols must be within 1MB of each other.  Programs can be statically or
14389 dynamically linked.
14391 @item -mcmodel=small
14392 @opindex mcmodel=small
14393 Generate code for the small code model.  The program and its statically defined
14394 symbols must be within 4GB of each other.  Programs can be statically or
14395 dynamically linked.  This is the default code model.
14397 @item -mcmodel=large
14398 @opindex mcmodel=large
14399 Generate code for the large code model.  This makes no assumptions about
14400 addresses and sizes of sections.  Programs can be statically linked only.
14402 @item -mstrict-align
14403 @opindex mstrict-align
14404 Avoid generating memory accesses that may not be aligned on a natural object
14405 boundary as described in the architecture specification.
14407 @item -momit-leaf-frame-pointer
14408 @itemx -mno-omit-leaf-frame-pointer
14409 @opindex momit-leaf-frame-pointer
14410 @opindex mno-omit-leaf-frame-pointer
14411 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14412 default.
14414 @item -mtls-dialect=desc
14415 @opindex mtls-dialect=desc
14416 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14417 of TLS variables.  This is the default.
14419 @item -mtls-dialect=traditional
14420 @opindex mtls-dialect=traditional
14421 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14422 of TLS variables.
14424 @item -mtls-size=@var{size}
14425 @opindex mtls-size
14426 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14427 This option requires binutils 2.26 or newer.
14429 @item -mfix-cortex-a53-835769
14430 @itemx -mno-fix-cortex-a53-835769
14431 @opindex mfix-cortex-a53-835769
14432 @opindex mno-fix-cortex-a53-835769
14433 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14434 This involves inserting a NOP instruction between memory instructions and
14435 64-bit integer multiply-accumulate instructions.
14437 @item -mfix-cortex-a53-843419
14438 @itemx -mno-fix-cortex-a53-843419
14439 @opindex mfix-cortex-a53-843419
14440 @opindex mno-fix-cortex-a53-843419
14441 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14442 This erratum workaround is made at link time and this will only pass the
14443 corresponding flag to the linker.
14445 @item -mlow-precision-recip-sqrt
14446 @item -mno-low-precision-recip-sqrt
14447 @opindex mlow-precision-recip-sqrt
14448 @opindex mno-low-precision-recip-sqrt
14449 Enable or disable the reciprocal square root approximation.
14450 This option only has an effect if @option{-ffast-math} or
14451 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14452 precision of reciprocal square root results to about 16 bits for
14453 single precision and to 32 bits for double precision.
14455 @item -mlow-precision-sqrt
14456 @item -mno-low-precision-sqrt
14457 @opindex -mlow-precision-sqrt
14458 @opindex -mno-low-precision-sqrt
14459 Enable or disable the square root approximation.
14460 This option only has an effect if @option{-ffast-math} or
14461 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14462 precision of square root results to about 16 bits for
14463 single precision and to 32 bits for double precision.
14464 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14466 @item -mlow-precision-div
14467 @item -mno-low-precision-div
14468 @opindex -mlow-precision-div
14469 @opindex -mno-low-precision-div
14470 Enable or disable the division approximation.
14471 This option only has an effect if @option{-ffast-math} or
14472 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14473 precision of division results to about 16 bits for
14474 single precision and to 32 bits for double precision.
14476 @item -march=@var{name}
14477 @opindex march
14478 Specify the name of the target architecture and, optionally, one or
14479 more feature modifiers.  This option has the form
14480 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14482 The permissible values for @var{arch} are @samp{armv8-a},
14483 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14485 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14486 support for the ARMv8.3-A architecture extensions.
14488 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14489 support for the ARMv8.2-A architecture extensions.
14491 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14492 support for the ARMv8.1-A architecture extension.  In particular, it
14493 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14495 The value @samp{native} is available on native AArch64 GNU/Linux and
14496 causes the compiler to pick the architecture of the host system.  This
14497 option has no effect if the compiler is unable to recognize the
14498 architecture of the host system,
14500 The permissible values for @var{feature} are listed in the sub-section
14501 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14502 Feature Modifiers}.  Where conflicting feature modifiers are
14503 specified, the right-most feature is used.
14505 GCC uses @var{name} to determine what kind of instructions it can emit
14506 when generating assembly code.  If @option{-march} is specified
14507 without either of @option{-mtune} or @option{-mcpu} also being
14508 specified, the code is tuned to perform well across a range of target
14509 processors implementing the target architecture.
14511 @item -mtune=@var{name}
14512 @opindex mtune
14513 Specify the name of the target processor for which GCC should tune the
14514 performance of the code.  Permissible values for this option are:
14515 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14516 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14517 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14518 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14519 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14520 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14521 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14522 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14523 @samp{native}.
14525 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14526 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14527 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14528 big.LITTLE system.
14530 Additionally on native AArch64 GNU/Linux systems the value
14531 @samp{native} tunes performance to the host system.  This option has no effect
14532 if the compiler is unable to recognize the processor of the host system.
14534 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14535 are specified, the code is tuned to perform well across a range
14536 of target processors.
14538 This option cannot be suffixed by feature modifiers.
14540 @item -mcpu=@var{name}
14541 @opindex mcpu
14542 Specify the name of the target processor, optionally suffixed by one
14543 or more feature modifiers.  This option has the form
14544 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14545 the permissible values for @var{cpu} are the same as those available
14546 for @option{-mtune}.  The permissible values for @var{feature} are
14547 documented in the sub-section on
14548 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14549 Feature Modifiers}.  Where conflicting feature modifiers are
14550 specified, the right-most feature is used.
14552 GCC uses @var{name} to determine what kind of instructions it can emit when
14553 generating assembly code (as if by @option{-march}) and to determine
14554 the target processor for which to tune for performance (as if
14555 by @option{-mtune}).  Where this option is used in conjunction
14556 with @option{-march} or @option{-mtune}, those options take precedence
14557 over the appropriate part of this option.
14559 @item -moverride=@var{string}
14560 @opindex moverride
14561 Override tuning decisions made by the back-end in response to a
14562 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14563 for @var{string} in this option are not guaranteed to be consistent
14564 across releases.
14566 This option is only intended to be useful when developing GCC.
14568 @item -mverbose-cost-dump
14569 @opindex mverbose-cost-dump
14570 Enable verbose cost model dumping in the debug dump files.  This option is
14571 provided for use in debugging the compiler.
14573 @item -mpc-relative-literal-loads
14574 @itemx -mno-pc-relative-literal-loads
14575 @opindex mpc-relative-literal-loads
14576 @opindex mno-pc-relative-literal-loads
14577 Enable or disable PC-relative literal loads.  With this option literal pools are
14578 accessed using a single instruction and emitted after each function.  This
14579 limits the maximum size of functions to 1MB.  This is enabled by default for
14580 @option{-mcmodel=tiny}.
14582 @item -msign-return-address=@var{scope}
14583 @opindex msign-return-address
14584 Select the function scope on which return address signing will be applied.
14585 Permissible values are @samp{none}, which disables return address signing,
14586 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14587 functions, and @samp{all}, which enables pointer signing for all functions.  The
14588 default value is @samp{none}.
14590 @end table
14592 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14593 @anchor{aarch64-feature-modifiers}
14594 @cindex @option{-march} feature modifiers
14595 @cindex @option{-mcpu} feature modifiers
14596 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14597 the following and their inverses @option{no@var{feature}}:
14599 @table @samp
14600 @item crc
14601 Enable CRC extension.  This is on by default for
14602 @option{-march=armv8.1-a}.
14603 @item crypto
14604 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14605 instructions.
14606 @item fp
14607 Enable floating-point instructions.  This is on by default for all possible
14608 values for options @option{-march} and @option{-mcpu}.
14609 @item simd
14610 Enable Advanced SIMD instructions.  This also enables floating-point
14611 instructions.  This is on by default for all possible values for options
14612 @option{-march} and @option{-mcpu}.
14613 @item lse
14614 Enable Large System Extension instructions.  This is on by default for
14615 @option{-march=armv8.1-a}.
14616 @item rdma
14617 Enable Round Double Multiply Accumulate instructions.  This is on by default
14618 for @option{-march=armv8.1-a}.
14619 @item fp16
14620 Enable FP16 extension.  This also enables floating-point instructions.
14621 @item rcpc
14622 Enable the RcPc extension.  This does not change code generation from GCC,
14623 but is passed on to the assembler, enabling inline asm statements to use
14624 instructions from the RcPc extension.
14625 @item dotprod
14626 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14628 @end table
14630 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14631 Conversely, @option{nofp} implies @option{nosimd}, which implies
14632 @option{nocrypto}.
14634 @node Adapteva Epiphany Options
14635 @subsection Adapteva Epiphany Options
14637 These @samp{-m} options are defined for Adapteva Epiphany:
14639 @table @gcctabopt
14640 @item -mhalf-reg-file
14641 @opindex mhalf-reg-file
14642 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14643 That allows code to run on hardware variants that lack these registers.
14645 @item -mprefer-short-insn-regs
14646 @opindex mprefer-short-insn-regs
14647 Preferentially allocate registers that allow short instruction generation.
14648 This can result in increased instruction count, so this may either reduce or
14649 increase overall code size.
14651 @item -mbranch-cost=@var{num}
14652 @opindex mbranch-cost
14653 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14654 This cost is only a heuristic and is not guaranteed to produce
14655 consistent results across releases.
14657 @item -mcmove
14658 @opindex mcmove
14659 Enable the generation of conditional moves.
14661 @item -mnops=@var{num}
14662 @opindex mnops
14663 Emit @var{num} NOPs before every other generated instruction.
14665 @item -mno-soft-cmpsf
14666 @opindex mno-soft-cmpsf
14667 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14668 and test the flags.  This is faster than a software comparison, but can
14669 get incorrect results in the presence of NaNs, or when two different small
14670 numbers are compared such that their difference is calculated as zero.
14671 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14672 software comparisons.
14674 @item -mstack-offset=@var{num}
14675 @opindex mstack-offset
14676 Set the offset between the top of the stack and the stack pointer.
14677 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14678 can be used by leaf functions without stack allocation.
14679 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14680 Note also that this option changes the ABI; compiling a program with a
14681 different stack offset than the libraries have been compiled with
14682 generally does not work.
14683 This option can be useful if you want to evaluate if a different stack
14684 offset would give you better code, but to actually use a different stack
14685 offset to build working programs, it is recommended to configure the
14686 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14688 @item -mno-round-nearest
14689 @opindex mno-round-nearest
14690 Make the scheduler assume that the rounding mode has been set to
14691 truncating.  The default is @option{-mround-nearest}.
14693 @item -mlong-calls
14694 @opindex mlong-calls
14695 If not otherwise specified by an attribute, assume all calls might be beyond
14696 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14697 function address into a register before performing a (otherwise direct) call.
14698 This is the default.
14700 @item -mshort-calls
14701 @opindex short-calls
14702 If not otherwise specified by an attribute, assume all direct calls are
14703 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14704 for direct calls.  The default is @option{-mlong-calls}.
14706 @item -msmall16
14707 @opindex msmall16
14708 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14709 apply to function addresses for which @option{-mlong-calls} semantics
14710 are in effect.
14712 @item -mfp-mode=@var{mode}
14713 @opindex mfp-mode
14714 Set the prevailing mode of the floating-point unit.
14715 This determines the floating-point mode that is provided and expected
14716 at function call and return time.  Making this mode match the mode you
14717 predominantly need at function start can make your programs smaller and
14718 faster by avoiding unnecessary mode switches.
14720 @var{mode} can be set to one the following values:
14722 @table @samp
14723 @item caller
14724 Any mode at function entry is valid, and retained or restored when
14725 the function returns, and when it calls other functions.
14726 This mode is useful for compiling libraries or other compilation units
14727 you might want to incorporate into different programs with different
14728 prevailing FPU modes, and the convenience of being able to use a single
14729 object file outweighs the size and speed overhead for any extra
14730 mode switching that might be needed, compared with what would be needed
14731 with a more specific choice of prevailing FPU mode.
14733 @item truncate
14734 This is the mode used for floating-point calculations with
14735 truncating (i.e.@: round towards zero) rounding mode.  That includes
14736 conversion from floating point to integer.
14738 @item round-nearest
14739 This is the mode used for floating-point calculations with
14740 round-to-nearest-or-even rounding mode.
14742 @item int
14743 This is the mode used to perform integer calculations in the FPU, e.g.@:
14744 integer multiply, or integer multiply-and-accumulate.
14745 @end table
14747 The default is @option{-mfp-mode=caller}
14749 @item -mnosplit-lohi
14750 @itemx -mno-postinc
14751 @itemx -mno-postmodify
14752 @opindex mnosplit-lohi
14753 @opindex mno-postinc
14754 @opindex mno-postmodify
14755 Code generation tweaks that disable, respectively, splitting of 32-bit
14756 loads, generation of post-increment addresses, and generation of
14757 post-modify addresses.  The defaults are @option{msplit-lohi},
14758 @option{-mpost-inc}, and @option{-mpost-modify}.
14760 @item -mnovect-double
14761 @opindex mno-vect-double
14762 Change the preferred SIMD mode to SImode.  The default is
14763 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14765 @item -max-vect-align=@var{num}
14766 @opindex max-vect-align
14767 The maximum alignment for SIMD vector mode types.
14768 @var{num} may be 4 or 8.  The default is 8.
14769 Note that this is an ABI change, even though many library function
14770 interfaces are unaffected if they don't use SIMD vector modes
14771 in places that affect size and/or alignment of relevant types.
14773 @item -msplit-vecmove-early
14774 @opindex msplit-vecmove-early
14775 Split vector moves into single word moves before reload.  In theory this
14776 can give better register allocation, but so far the reverse seems to be
14777 generally the case.
14779 @item -m1reg-@var{reg}
14780 @opindex m1reg-
14781 Specify a register to hold the constant @minus{}1, which makes loading small negative
14782 constants and certain bitmasks faster.
14783 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14784 which specify use of that register as a fixed register,
14785 and @samp{none}, which means that no register is used for this
14786 purpose.  The default is @option{-m1reg-none}.
14788 @end table
14790 @node ARC Options
14791 @subsection ARC Options
14792 @cindex ARC options
14794 The following options control the architecture variant for which code
14795 is being compiled:
14797 @c architecture variants
14798 @table @gcctabopt
14800 @item -mbarrel-shifter
14801 @opindex mbarrel-shifter
14802 Generate instructions supported by barrel shifter.  This is the default
14803 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14805 @item -mcpu=@var{cpu}
14806 @opindex mcpu
14807 Set architecture type, register usage, and instruction scheduling
14808 parameters for @var{cpu}.  There are also shortcut alias options
14809 available for backward compatibility and convenience.  Supported
14810 values for @var{cpu} are
14812 @table @samp
14813 @opindex mA6
14814 @opindex mARC600
14815 @item arc600
14816 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14818 @item arc601
14819 @opindex mARC601
14820 Compile for ARC601.  Alias: @option{-mARC601}.
14822 @item arc700
14823 @opindex mA7
14824 @opindex mARC700
14825 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14826 This is the default when configured with @option{--with-cpu=arc700}@.
14828 @item arcem
14829 Compile for ARC EM.
14831 @item archs
14832 Compile for ARC HS.
14834 @item em
14835 Compile for ARC EM CPU with no hardware extensions.
14837 @item em4
14838 Compile for ARC EM4 CPU.
14840 @item em4_dmips
14841 Compile for ARC EM4 DMIPS CPU.
14843 @item em4_fpus
14844 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14845 extension.
14847 @item em4_fpuda
14848 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14849 double assist instructions.
14851 @item hs
14852 Compile for ARC HS CPU with no hardware extensions except the atomic
14853 instructions.
14855 @item hs34
14856 Compile for ARC HS34 CPU.
14858 @item hs38
14859 Compile for ARC HS38 CPU.
14861 @item hs38_linux
14862 Compile for ARC HS38 CPU with all hardware extensions on.
14864 @item arc600_norm
14865 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14867 @item arc600_mul32x16
14868 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14869 instructions enabled.
14871 @item arc600_mul64
14872 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14873 instructions enabled.
14875 @item arc601_norm
14876 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14878 @item arc601_mul32x16
14879 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14880 instructions enabled.
14882 @item arc601_mul64
14883 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14884 instructions enabled.
14886 @item nps400
14887 Compile for ARC 700 on NPS400 chip.
14889 @end table
14891 @item -mdpfp
14892 @opindex mdpfp
14893 @itemx -mdpfp-compact
14894 @opindex mdpfp-compact
14895 Generate double-precision FPX instructions, tuned for the compact
14896 implementation.
14898 @item -mdpfp-fast
14899 @opindex mdpfp-fast
14900 Generate double-precision FPX instructions, tuned for the fast
14901 implementation.
14903 @item -mno-dpfp-lrsr
14904 @opindex mno-dpfp-lrsr
14905 Disable @code{lr} and @code{sr} instructions from using FPX extension
14906 aux registers.
14908 @item -mea
14909 @opindex mea
14910 Generate extended arithmetic instructions.  Currently only
14911 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14912 supported.  This is always enabled for @option{-mcpu=ARC700}.
14914 @item -mno-mpy
14915 @opindex mno-mpy
14916 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14917 deprecated.
14919 @item -mmul32x16
14920 @opindex mmul32x16
14921 Generate 32x16-bit multiply and multiply-accumulate instructions.
14923 @item -mmul64
14924 @opindex mmul64
14925 Generate @code{mul64} and @code{mulu64} instructions.  
14926 Only valid for @option{-mcpu=ARC600}.
14928 @item -mnorm
14929 @opindex mnorm
14930 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14931 is in effect.
14933 @item -mspfp
14934 @opindex mspfp
14935 @itemx -mspfp-compact
14936 @opindex mspfp-compact
14937 Generate single-precision FPX instructions, tuned for the compact
14938 implementation.
14940 @item -mspfp-fast
14941 @opindex mspfp-fast
14942 Generate single-precision FPX instructions, tuned for the fast
14943 implementation.
14945 @item -msimd
14946 @opindex msimd
14947 Enable generation of ARC SIMD instructions via target-specific
14948 builtins.  Only valid for @option{-mcpu=ARC700}.
14950 @item -msoft-float
14951 @opindex msoft-float
14952 This option ignored; it is provided for compatibility purposes only.
14953 Software floating-point code is emitted by default, and this default
14954 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14955 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14956 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14958 @item -mswap
14959 @opindex mswap
14960 Generate @code{swap} instructions.
14962 @item -matomic
14963 @opindex matomic
14964 This enables use of the locked load/store conditional extension to implement
14965 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14966 EM cores.
14968 @item -mdiv-rem
14969 @opindex mdiv-rem
14970 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14972 @item -mcode-density
14973 @opindex mcode-density
14974 Enable code density instructions for ARC EM.  
14975 This option is on by default for ARC HS.
14977 @item -mll64
14978 @opindex mll64
14979 Enable double load/store operations for ARC HS cores.
14981 @item -mtp-regno=@var{regno}
14982 @opindex mtp-regno
14983 Specify thread pointer register number.
14985 @item -mmpy-option=@var{multo}
14986 @opindex mmpy-option
14987 Compile ARCv2 code with a multiplier design option.  You can specify 
14988 the option using either a string or numeric value for @var{multo}.  
14989 @samp{wlh1} is the default value.  The recognized values are:
14991 @table @samp
14992 @item 0
14993 @itemx none
14994 No multiplier available.
14996 @item 1
14997 @itemx w
14998 16x16 multiplier, fully pipelined.
14999 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15001 @item 2
15002 @itemx wlh1
15003 32x32 multiplier, fully
15004 pipelined (1 stage).  The following instructions are additionally
15005 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15007 @item 3
15008 @itemx wlh2
15009 32x32 multiplier, fully pipelined
15010 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15011 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15013 @item 4
15014 @itemx wlh3
15015 Two 16x16 multipliers, blocking,
15016 sequential.  The following instructions are additionally enabled: @code{mpy},
15017 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15019 @item 5
15020 @itemx wlh4
15021 One 16x16 multiplier, blocking,
15022 sequential.  The following instructions are additionally enabled: @code{mpy},
15023 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15025 @item 6
15026 @itemx wlh5
15027 One 32x4 multiplier, blocking,
15028 sequential.  The following instructions are additionally enabled: @code{mpy},
15029 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15031 @item 7
15032 @itemx plus_dmpy
15033 ARC HS SIMD support.
15035 @item 8
15036 @itemx plus_macd
15037 ARC HS SIMD support.
15039 @item 9
15040 @itemx plus_qmacw
15041 ARC HS SIMD support.
15043 @end table
15045 This option is only available for ARCv2 cores@.
15047 @item -mfpu=@var{fpu}
15048 @opindex mfpu
15049 Enables support for specific floating-point hardware extensions for ARCv2
15050 cores.  Supported values for @var{fpu} are:
15052 @table @samp
15054 @item fpus
15055 Enables support for single-precision floating-point hardware
15056 extensions@.
15058 @item fpud
15059 Enables support for double-precision floating-point hardware
15060 extensions.  The single-precision floating-point extension is also
15061 enabled.  Not available for ARC EM@.
15063 @item fpuda
15064 Enables support for double-precision floating-point hardware
15065 extensions using double-precision assist instructions.  The single-precision
15066 floating-point extension is also enabled.  This option is
15067 only available for ARC EM@.
15069 @item fpuda_div
15070 Enables support for double-precision floating-point hardware
15071 extensions using double-precision assist instructions.
15072 The single-precision floating-point, square-root, and divide 
15073 extensions are also enabled.  This option is
15074 only available for ARC EM@.
15076 @item fpuda_fma
15077 Enables support for double-precision floating-point hardware
15078 extensions using double-precision assist instructions.
15079 The single-precision floating-point and fused multiply and add 
15080 hardware extensions are also enabled.  This option is
15081 only available for ARC EM@.
15083 @item fpuda_all
15084 Enables support for double-precision floating-point hardware
15085 extensions using double-precision assist instructions.
15086 All single-precision floating-point hardware extensions are also
15087 enabled.  This option is only available for ARC EM@.
15089 @item fpus_div
15090 Enables support for single-precision floating-point, square-root and divide 
15091 hardware extensions@.
15093 @item fpud_div
15094 Enables support for double-precision floating-point, square-root and divide 
15095 hardware extensions.  This option
15096 includes option @samp{fpus_div}. Not available for ARC EM@.
15098 @item fpus_fma
15099 Enables support for single-precision floating-point and 
15100 fused multiply and add hardware extensions@.
15102 @item fpud_fma
15103 Enables support for double-precision floating-point and 
15104 fused multiply and add hardware extensions.  This option
15105 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15107 @item fpus_all
15108 Enables support for all single-precision floating-point hardware
15109 extensions@.
15111 @item fpud_all
15112 Enables support for all single- and double-precision floating-point
15113 hardware extensions.  Not available for ARC EM@.
15115 @end table
15117 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15118 @opindex mirq-ctrl-saved
15119 Specifies general-purposes registers that the processor automatically
15120 saves/restores on interrupt entry and exit.  @var{register-range} is
15121 specified as two registers separated by a dash.  The register range
15122 always starts with @code{r0}, the upper limit is @code{fp} register.
15123 @var{blink} and @var{lp_count} are optional.  This option is only
15124 valid for ARC EM and ARC HS cores.
15126 @item -mrgf-banked-regs=@var{number}
15127 @opindex mrgf-banked-regs
15128 Specifies the number of registers replicated in second register bank
15129 on entry to fast interrupt.  Fast interrupts are interrupts with the
15130 highest priority level P0.  These interrupts save only PC and STATUS32
15131 registers to avoid memory transactions during interrupt entry and exit
15132 sequences.  Use this option when you are using fast interrupts in an
15133 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15135 @item -mlpc-width=@var{width}
15136 @opindex mlpc-width
15137 Specify the width of the @code{lp_count} register.  Valid values for
15138 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15139 fixed to 32 bits.  If the width is less than 32, the compiler does not
15140 attempt to transform loops in your program to use the zero-delay loop
15141 mechanism unless it is known that the @code{lp_count} register can
15142 hold the required loop-counter value.  Depending on the width
15143 specified, the compiler and run-time library might continue to use the
15144 loop mechanism for various needs.  This option defines macro
15145 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15147 @end table
15149 The following options are passed through to the assembler, and also
15150 define preprocessor macro symbols.
15152 @c Flags used by the assembler, but for which we define preprocessor
15153 @c macro symbols as well.
15154 @table @gcctabopt
15155 @item -mdsp-packa
15156 @opindex mdsp-packa
15157 Passed down to the assembler to enable the DSP Pack A extensions.
15158 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15159 deprecated.
15161 @item -mdvbf
15162 @opindex mdvbf
15163 Passed down to the assembler to enable the dual Viterbi butterfly
15164 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15165 option is deprecated.
15167 @c ARC700 4.10 extension instruction
15168 @item -mlock
15169 @opindex mlock
15170 Passed down to the assembler to enable the locked load/store
15171 conditional extension.  Also sets the preprocessor symbol
15172 @code{__Xlock}.
15174 @item -mmac-d16
15175 @opindex mmac-d16
15176 Passed down to the assembler.  Also sets the preprocessor symbol
15177 @code{__Xxmac_d16}.  This option is deprecated.
15179 @item -mmac-24
15180 @opindex mmac-24
15181 Passed down to the assembler.  Also sets the preprocessor symbol
15182 @code{__Xxmac_24}.  This option is deprecated.
15184 @c ARC700 4.10 extension instruction
15185 @item -mrtsc
15186 @opindex mrtsc
15187 Passed down to the assembler to enable the 64-bit time-stamp counter
15188 extension instruction.  Also sets the preprocessor symbol
15189 @code{__Xrtsc}.  This option is deprecated.
15191 @c ARC700 4.10 extension instruction
15192 @item -mswape
15193 @opindex mswape
15194 Passed down to the assembler to enable the swap byte ordering
15195 extension instruction.  Also sets the preprocessor symbol
15196 @code{__Xswape}.
15198 @item -mtelephony
15199 @opindex mtelephony
15200 Passed down to the assembler to enable dual- and single-operand
15201 instructions for telephony.  Also sets the preprocessor symbol
15202 @code{__Xtelephony}.  This option is deprecated.
15204 @item -mxy
15205 @opindex mxy
15206 Passed down to the assembler to enable the XY memory extension.  Also
15207 sets the preprocessor symbol @code{__Xxy}.
15209 @end table
15211 The following options control how the assembly code is annotated:
15213 @c Assembly annotation options
15214 @table @gcctabopt
15215 @item -misize
15216 @opindex misize
15217 Annotate assembler instructions with estimated addresses.
15219 @item -mannotate-align
15220 @opindex mannotate-align
15221 Explain what alignment considerations lead to the decision to make an
15222 instruction short or long.
15224 @end table
15226 The following options are passed through to the linker:
15228 @c options passed through to the linker
15229 @table @gcctabopt
15230 @item -marclinux
15231 @opindex marclinux
15232 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15233 This option is enabled by default in tool chains built for
15234 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15235 when profiling is not requested.
15237 @item -marclinux_prof
15238 @opindex marclinux_prof
15239 Passed through to the linker, to specify use of the
15240 @code{arclinux_prof} emulation.  This option is enabled by default in
15241 tool chains built for @w{@code{arc-linux-uclibc}} and
15242 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15244 @end table
15246 The following options control the semantics of generated code:
15248 @c semantically relevant code generation options
15249 @table @gcctabopt
15250 @item -mlong-calls
15251 @opindex mlong-calls
15252 Generate calls as register indirect calls, thus providing access
15253 to the full 32-bit address range.
15255 @item -mmedium-calls
15256 @opindex mmedium-calls
15257 Don't use less than 25-bit addressing range for calls, which is the
15258 offset available for an unconditional branch-and-link
15259 instruction.  Conditional execution of function calls is suppressed, to
15260 allow use of the 25-bit range, rather than the 21-bit range with
15261 conditional branch-and-link.  This is the default for tool chains built
15262 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15264 @item -G @var{num}
15265 @opindex G
15266 Put definitions of externally-visible data in a small data section if
15267 that data is no bigger than @var{num} bytes.  The default value of
15268 @var{num} is 4 for any ARC configuration, or 8 when we have double
15269 load/store operations.
15271 @item -mno-sdata
15272 @opindex mno-sdata
15273 Do not generate sdata references.  This is the default for tool chains
15274 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15275 targets.
15277 @item -mvolatile-cache
15278 @opindex mvolatile-cache
15279 Use ordinarily cached memory accesses for volatile references.  This is the
15280 default.
15282 @item -mno-volatile-cache
15283 @opindex mno-volatile-cache
15284 Enable cache bypass for volatile references.
15286 @end table
15288 The following options fine tune code generation:
15289 @c code generation tuning options
15290 @table @gcctabopt
15291 @item -malign-call
15292 @opindex malign-call
15293 Do alignment optimizations for call instructions.
15295 @item -mauto-modify-reg
15296 @opindex mauto-modify-reg
15297 Enable the use of pre/post modify with register displacement.
15299 @item -mbbit-peephole
15300 @opindex mbbit-peephole
15301 Enable bbit peephole2.
15303 @item -mno-brcc
15304 @opindex mno-brcc
15305 This option disables a target-specific pass in @file{arc_reorg} to
15306 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15307 It has no effect on
15308 generation of these instructions driven by the combiner pass.
15310 @item -mcase-vector-pcrel
15311 @opindex mcase-vector-pcrel
15312 Use PC-relative switch case tables to enable case table shortening.
15313 This is the default for @option{-Os}.
15315 @item -mcompact-casesi
15316 @opindex mcompact-casesi
15317 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15318 and only available for ARCv1 cores.
15320 @item -mno-cond-exec
15321 @opindex mno-cond-exec
15322 Disable the ARCompact-specific pass to generate conditional 
15323 execution instructions.
15325 Due to delay slot scheduling and interactions between operand numbers,
15326 literal sizes, instruction lengths, and the support for conditional execution,
15327 the target-independent pass to generate conditional execution is often lacking,
15328 so the ARC port has kept a special pass around that tries to find more
15329 conditional execution generation opportunities after register allocation,
15330 branch shortening, and delay slot scheduling have been done.  This pass
15331 generally, but not always, improves performance and code size, at the cost of
15332 extra compilation time, which is why there is an option to switch it off.
15333 If you have a problem with call instructions exceeding their allowable
15334 offset range because they are conditionalized, you should consider using
15335 @option{-mmedium-calls} instead.
15337 @item -mearly-cbranchsi
15338 @opindex mearly-cbranchsi
15339 Enable pre-reload use of the @code{cbranchsi} pattern.
15341 @item -mexpand-adddi
15342 @opindex mexpand-adddi
15343 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15344 @code{add.f}, @code{adc} etc.  This option is deprecated.
15346 @item -mindexed-loads
15347 @opindex mindexed-loads
15348 Enable the use of indexed loads.  This can be problematic because some
15349 optimizers then assume that indexed stores exist, which is not
15350 the case.
15352 @item -mlra
15353 @opindex mlra
15354 Enable Local Register Allocation.  This is still experimental for ARC,
15355 so by default the compiler uses standard reload
15356 (i.e. @option{-mno-lra}).
15358 @item -mlra-priority-none
15359 @opindex mlra-priority-none
15360 Don't indicate any priority for target registers.
15362 @item -mlra-priority-compact
15363 @opindex mlra-priority-compact
15364 Indicate target register priority for r0..r3 / r12..r15.
15366 @item -mlra-priority-noncompact
15367 @opindex mlra-priority-noncompact
15368 Reduce target register priority for r0..r3 / r12..r15.
15370 @item -mno-millicode
15371 @opindex mno-millicode
15372 When optimizing for size (using @option{-Os}), prologues and epilogues
15373 that have to save or restore a large number of registers are often
15374 shortened by using call to a special function in libgcc; this is
15375 referred to as a @emph{millicode} call.  As these calls can pose
15376 performance issues, and/or cause linking issues when linking in a
15377 nonstandard way, this option is provided to turn off millicode call
15378 generation.
15380 @item -mmixed-code
15381 @opindex mmixed-code
15382 Tweak register allocation to help 16-bit instruction generation.
15383 This generally has the effect of decreasing the average instruction size
15384 while increasing the instruction count.
15386 @item -mq-class
15387 @opindex mq-class
15388 Enable @samp{q} instruction alternatives.
15389 This is the default for @option{-Os}.
15391 @item -mRcq
15392 @opindex mRcq
15393 Enable @samp{Rcq} constraint handling.  
15394 Most short code generation depends on this.
15395 This is the default.
15397 @item -mRcw
15398 @opindex mRcw
15399 Enable @samp{Rcw} constraint handling.  
15400 Most ccfsm condexec mostly depends on this.
15401 This is the default.
15403 @item -msize-level=@var{level}
15404 @opindex msize-level
15405 Fine-tune size optimization with regards to instruction lengths and alignment.
15406 The recognized values for @var{level} are:
15407 @table @samp
15408 @item 0
15409 No size optimization.  This level is deprecated and treated like @samp{1}.
15411 @item 1
15412 Short instructions are used opportunistically.
15414 @item 2
15415 In addition, alignment of loops and of code after barriers are dropped.
15417 @item 3
15418 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15420 @end table
15422 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15423 the behavior when this is not set is equivalent to level @samp{1}.
15425 @item -mtune=@var{cpu}
15426 @opindex mtune
15427 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15428 by @option{-mcpu=}.
15430 Supported values for @var{cpu} are
15432 @table @samp
15433 @item ARC600
15434 Tune for ARC600 CPU.
15436 @item ARC601
15437 Tune for ARC601 CPU.
15439 @item ARC700
15440 Tune for ARC700 CPU with standard multiplier block.
15442 @item ARC700-xmac
15443 Tune for ARC700 CPU with XMAC block.
15445 @item ARC725D
15446 Tune for ARC725D CPU.
15448 @item ARC750D
15449 Tune for ARC750D CPU.
15451 @end table
15453 @item -mmultcost=@var{num}
15454 @opindex mmultcost
15455 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15456 normal instruction.
15458 @item -munalign-prob-threshold=@var{probability}
15459 @opindex munalign-prob-threshold
15460 Set probability threshold for unaligning branches.
15461 When tuning for @samp{ARC700} and optimizing for speed, branches without
15462 filled delay slot are preferably emitted unaligned and long, unless
15463 profiling indicates that the probability for the branch to be taken
15464 is below @var{probability}.  @xref{Cross-profiling}.
15465 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15467 @end table
15469 The following options are maintained for backward compatibility, but
15470 are now deprecated and will be removed in a future release:
15472 @c Deprecated options
15473 @table @gcctabopt
15475 @item -margonaut
15476 @opindex margonaut
15477 Obsolete FPX.
15479 @item -mbig-endian
15480 @opindex mbig-endian
15481 @itemx -EB
15482 @opindex EB
15483 Compile code for big-endian targets.  Use of these options is now
15484 deprecated.  Big-endian code is supported by configuring GCC to build
15485 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15486 for which big endian is the default.
15488 @item -mlittle-endian
15489 @opindex mlittle-endian
15490 @itemx -EL
15491 @opindex EL
15492 Compile code for little-endian targets.  Use of these options is now
15493 deprecated.  Little-endian code is supported by configuring GCC to build 
15494 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15495 for which little endian is the default.
15497 @item -mbarrel_shifter
15498 @opindex mbarrel_shifter
15499 Replaced by @option{-mbarrel-shifter}.
15501 @item -mdpfp_compact
15502 @opindex mdpfp_compact
15503 Replaced by @option{-mdpfp-compact}.
15505 @item -mdpfp_fast
15506 @opindex mdpfp_fast
15507 Replaced by @option{-mdpfp-fast}.
15509 @item -mdsp_packa
15510 @opindex mdsp_packa
15511 Replaced by @option{-mdsp-packa}.
15513 @item -mEA
15514 @opindex mEA
15515 Replaced by @option{-mea}.
15517 @item -mmac_24
15518 @opindex mmac_24
15519 Replaced by @option{-mmac-24}.
15521 @item -mmac_d16
15522 @opindex mmac_d16
15523 Replaced by @option{-mmac-d16}.
15525 @item -mspfp_compact
15526 @opindex mspfp_compact
15527 Replaced by @option{-mspfp-compact}.
15529 @item -mspfp_fast
15530 @opindex mspfp_fast
15531 Replaced by @option{-mspfp-fast}.
15533 @item -mtune=@var{cpu}
15534 @opindex mtune
15535 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15536 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15537 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15539 @item -multcost=@var{num}
15540 @opindex multcost
15541 Replaced by @option{-mmultcost}.
15543 @end table
15545 @node ARM Options
15546 @subsection ARM Options
15547 @cindex ARM options
15549 These @samp{-m} options are defined for the ARM port:
15551 @table @gcctabopt
15552 @item -mabi=@var{name}
15553 @opindex mabi
15554 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15555 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15557 @item -mapcs-frame
15558 @opindex mapcs-frame
15559 Generate a stack frame that is compliant with the ARM Procedure Call
15560 Standard for all functions, even if this is not strictly necessary for
15561 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15562 with this option causes the stack frames not to be generated for
15563 leaf functions.  The default is @option{-mno-apcs-frame}.
15564 This option is deprecated.
15566 @item -mapcs
15567 @opindex mapcs
15568 This is a synonym for @option{-mapcs-frame} and is deprecated.
15570 @ignore
15571 @c not currently implemented
15572 @item -mapcs-stack-check
15573 @opindex mapcs-stack-check
15574 Generate code to check the amount of stack space available upon entry to
15575 every function (that actually uses some stack space).  If there is
15576 insufficient space available then either the function
15577 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15578 called, depending upon the amount of stack space required.  The runtime
15579 system is required to provide these functions.  The default is
15580 @option{-mno-apcs-stack-check}, since this produces smaller code.
15582 @c not currently implemented
15583 @item -mapcs-reentrant
15584 @opindex mapcs-reentrant
15585 Generate reentrant, position-independent code.  The default is
15586 @option{-mno-apcs-reentrant}.
15587 @end ignore
15589 @item -mthumb-interwork
15590 @opindex mthumb-interwork
15591 Generate code that supports calling between the ARM and Thumb
15592 instruction sets.  Without this option, on pre-v5 architectures, the
15593 two instruction sets cannot be reliably used inside one program.  The
15594 default is @option{-mno-thumb-interwork}, since slightly larger code
15595 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15596 configurations this option is meaningless.
15598 @item -mno-sched-prolog
15599 @opindex mno-sched-prolog
15600 Prevent the reordering of instructions in the function prologue, or the
15601 merging of those instruction with the instructions in the function's
15602 body.  This means that all functions start with a recognizable set
15603 of instructions (or in fact one of a choice from a small set of
15604 different function prologues), and this information can be used to
15605 locate the start of functions inside an executable piece of code.  The
15606 default is @option{-msched-prolog}.
15608 @item -mfloat-abi=@var{name}
15609 @opindex mfloat-abi
15610 Specifies which floating-point ABI to use.  Permissible values
15611 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15613 Specifying @samp{soft} causes GCC to generate output containing
15614 library calls for floating-point operations.
15615 @samp{softfp} allows the generation of code using hardware floating-point
15616 instructions, but still uses the soft-float calling conventions.
15617 @samp{hard} allows generation of floating-point instructions
15618 and uses FPU-specific calling conventions.
15620 The default depends on the specific target configuration.  Note that
15621 the hard-float and soft-float ABIs are not link-compatible; you must
15622 compile your entire program with the same ABI, and link with a
15623 compatible set of libraries.
15625 @item -mlittle-endian
15626 @opindex mlittle-endian
15627 Generate code for a processor running in little-endian mode.  This is
15628 the default for all standard configurations.
15630 @item -mbig-endian
15631 @opindex mbig-endian
15632 Generate code for a processor running in big-endian mode; the default is
15633 to compile code for a little-endian processor.
15635 @item -mbe8
15636 @itemx -mbe32
15637 @opindex mbe8
15638 When linking a big-endian image select between BE8 and BE32 formats.
15639 The option has no effect for little-endian images and is ignored.  The
15640 default is dependent on the selected target architecture.  For ARMv6
15641 and later architectures the default is BE8, for older architectures
15642 the default is BE32.  BE32 format has been deprecated by ARM.
15644 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15645 @opindex march
15646 This specifies the name of the target ARM architecture.  GCC uses this
15647 name to determine what kind of instructions it can emit when generating
15648 assembly code.  This option can be used in conjunction with or instead
15649 of the @option{-mcpu=} option.
15651 Permissible names are:
15652 @samp{armv4t},
15653 @samp{armv5t}, @samp{armv5te},
15654 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15655 @samp{armv6z}, @samp{armv6zk},
15656 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15657 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15658 @samp{armv7-r},
15659 @samp{armv8-r},
15660 @samp{armv6-m}, @samp{armv6s-m},
15661 @samp{armv7-m}, @samp{armv7e-m},
15662 @samp{armv8-m.base}, @samp{armv8-m.main},
15663 @samp{iwmmxt} and @samp{iwmmxt2}.
15665 Additionally, the following architectures, which lack support for the
15666 Thumb execution state, are recognized but support is deprecated:
15667 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15668 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15670 Many of the architectures support extensions.  These can be added by
15671 appending @samp{+@var{extension}} to the architecture name.  Extension
15672 options are processed in order and capabilities accumulate.  An extension
15673 will also enable any necessary base extensions
15674 upon which it depends.  For example, the @samp{+crypto} extension
15675 will always enable the @samp{+simd} extension.  The exception to the
15676 additive construction is for extensions that are prefixed with
15677 @samp{+no@dots{}}: these extensions disable the specified option and
15678 any other extensions that may depend on the presence of that
15679 extension.
15681 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15682 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15683 entirely disabled by the @samp{+nofp} option that follows it.
15685 Most extension names are generically named, but have an effect that is
15686 dependent upon the architecture to which it is applied.  For example,
15687 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15688 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15689 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15690 variant for @samp{armv8-a}.
15692 The table below lists the supported extensions for each architecture.
15693 Architectures not mentioned do not support any extensions.
15695 @table @samp
15696 @item  armv5e
15697 @itemx armv5te
15698 @itemx armv6
15699 @itemx armv6j
15700 @itemx armv6k
15701 @itemx armv6kz
15702 @itemx armv6t2
15703 @itemx armv6z
15704 @itemx armv6zk
15705 @table @samp
15706 @item +fp
15707 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15708 used as an alias for this extension.
15710 @item +nofp
15711 Disable the floating-point instructions.
15712 @end table
15714 @item armv7
15715 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15716 @table @samp
15717 @item +fp
15718 The VFPv3 floating-point instructions, with 16 double-precision
15719 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15720 for this extension.  Note that floating-point is not supported by the
15721 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15722 ARMv7-R architectures.
15724 @item +nofp
15725 Disable the floating-point instructions.
15726 @end table
15728 @item armv7-a
15729 @table @samp
15730 @item +fp
15731 The VFPv3 floating-point instructions, with 16 double-precision
15732 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15733 for this extension.
15735 @item +simd
15736 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15737 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15738 for this extension.
15740 @item +vfpv3
15741 The VFPv3 floating-point instructions, with 32 double-precision
15742 registers.
15744 @item +vfpv3-d16-fp16
15745 The VFPv3 floating-point instructions, with 16 double-precision
15746 registers and the half-precision floating-point conversion operations.
15748 @item +vfpv3-fp16
15749 The VFPv3 floating-point instructions, with 32 double-precision
15750 registers and the half-precision floating-point conversion operations.
15752 @item +vfpv4-d16
15753 The VFPv4 floating-point instructions, with 16 double-precision
15754 registers.
15756 @item +vfpv4
15757 The VFPv4 floating-point instructions, with 32 double-precision
15758 registers.
15760 @item +neon-fp16
15761 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15762 the half-precision floating-point conversion operations.
15764 @item +neon-vfpv4
15765 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15767 @item +nosimd
15768 Disable the Advanced SIMD instructions (does not disable floating point).
15770 @item +nofp
15771 Disable the floating-point and Advanced SIMD instructions.
15772 @end table
15774 @item armv7ve
15775 The extended version of the ARMv7-A architecture with support for
15776 virtualization.
15777 @table @samp
15778 @item +fp
15779 The VFPv4 floating-point instructions, with 16 double-precision registers.
15780 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15782 @item +simd
15783 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15784 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15786 @item +vfpv3-d16
15787 The VFPv3 floating-point instructions, with 16 double-precision
15788 registers.
15790 @item +vfpv3
15791 The VFPv3 floating-point instructions, with 32 double-precision
15792 registers.
15794 @item +vfpv3-d16-fp16
15795 The VFPv3 floating-point instructions, with 16 double-precision
15796 registers and the half-precision floating-point conversion operations.
15798 @item +vfpv3-fp16
15799 The VFPv3 floating-point instructions, with 32 double-precision
15800 registers and the half-precision floating-point conversion operations.
15802 @item +vfpv4-d16
15803 The VFPv4 floating-point instructions, with 16 double-precision
15804 registers.
15806 @item +vfpv4
15807 The VFPv4 floating-point instructions, with 32 double-precision
15808 registers.
15810 @item +neon
15811 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15812 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15814 @item +neon-fp16
15815 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15816 the half-precision floating-point conversion operations.
15818 @item +nosimd
15819 Disable the Advanced SIMD instructions (does not disable floating point).
15821 @item +nofp
15822 Disable the floating-point and Advanced SIMD instructions.
15823 @end table
15825 @item armv8-a
15826 @table @samp
15827 @item +crc
15828 The Cyclic Redundancy Check (CRC) instructions.
15829 @item +simd
15830 The ARMv8-A Advanced SIMD and floating-point instructions.
15831 @item +crypto
15832 The cryptographic instructions.
15833 @item +nocrypto
15834 Disable the cryptographic instructions.
15835 @item +nofp
15836 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15837 @end table
15839 @item armv8.1-a
15840 @table @samp
15841 @item +simd
15842 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15844 @item +crypto
15845 The cryptographic instructions.  This also enables the Advanced SIMD and
15846 floating-point instructions.
15848 @item +nocrypto
15849 Disable the cryptographic instructions.
15851 @item +nofp
15852 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15853 @end table
15855 @item armv8.2-a
15856 @itemx armv8.3-a
15857 @table @samp
15858 @item +fp16
15859 The half-precision floating-point data processing instructions.
15860 This also enables the Advanced SIMD and floating-point instructions.
15862 @item +simd
15863 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15865 @item +crypto
15866 The cryptographic instructions.  This also enables the Advanced SIMD and
15867 floating-point instructions.
15869 @item +dotprod
15870 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15872 @item +nocrypto
15873 Disable the cryptographic extension.
15875 @item +nofp
15876 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15877 @end table
15879 @item armv7-r
15880 @table @samp
15881 @item +fp.sp
15882 The single-precision VFPv3 floating-point instructions.  The extension
15883 @samp{+vfpv3xd} can be used as an alias for this extension.
15885 @item +fp
15886 The VFPv3 floating-point instructions with 16 double-precision registers.
15887 The extension +vfpv3-d16 can be used as an alias for this extension.
15889 @item +nofp
15890 Disable the floating-point extension.
15892 @item +idiv
15893 The ARM-state integer division instructions.
15895 @item +noidiv
15896 Disable the ARM-state integer division extension.
15897 @end table
15899 @item armv7e-m
15900 @table @samp
15901 @item +fp
15902 The single-precision VFPv4 floating-point instructions.
15904 @item +fpv5
15905 The single-precision FPv5 floating-point instructions.
15907 @item +fp.dp
15908 The single- and double-precision FPv5 floating-point instructions.
15910 @item +nofp
15911 Disable the floating-point extensions.
15912 @end table
15914 @item  armv8-m.main
15915 @table @samp
15916 @item +dsp
15917 The DSP instructions.
15919 @item +nodsp
15920 Disable the DSP extension.
15922 @item +fp
15923 The single-precision floating-point instructions.
15925 @item +fp.dp
15926 The single- and double-precision floating-point instructions.
15928 @item +nofp
15929 Disable the floating-point extension.
15930 @end table
15932 @item armv8-r
15933 @table @samp
15934 @item +crc
15935 The Cyclic Redundancy Check (CRC) instructions.
15936 @item +fp.sp
15937 The single-precision FPv5 floating-point instructions.
15938 @item +simd
15939 The ARMv8-A Advanced SIMD and floating-point instructions.
15940 @item +crypto
15941 The cryptographic instructions.
15942 @item +nocrypto
15943 Disable the cryptographic instructions.
15944 @item +nofp
15945 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15946 @end table
15948 @end table
15950 @option{-march=native} causes the compiler to auto-detect the architecture
15951 of the build computer.  At present, this feature is only supported on
15952 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15953 is unsuccessful the option has no effect.
15955 @item -mtune=@var{name}
15956 @opindex mtune
15957 This option specifies the name of the target ARM processor for
15958 which GCC should tune the performance of the code.
15959 For some ARM implementations better performance can be obtained by using
15960 this option.
15961 Permissible names are: @samp{arm2}, @samp{arm250},
15962 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15963 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15964 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15965 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15966 @samp{arm720},
15967 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15968 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15969 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15970 @samp{strongarm1110},
15971 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15972 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15973 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15974 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15975 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15976 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15977 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15978 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15979 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15980 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15981 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15982 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15983 @samp{cortex-r8}, @samp{cortex-r52},
15984 @samp{cortex-m33},
15985 @samp{cortex-m23},
15986 @samp{cortex-m7},
15987 @samp{cortex-m4},
15988 @samp{cortex-m3},
15989 @samp{cortex-m1},
15990 @samp{cortex-m0},
15991 @samp{cortex-m0plus},
15992 @samp{cortex-m1.small-multiply},
15993 @samp{cortex-m0.small-multiply},
15994 @samp{cortex-m0plus.small-multiply},
15995 @samp{exynos-m1},
15996 @samp{marvell-pj4},
15997 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15998 @samp{fa526}, @samp{fa626},
15999 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16000 @samp{xgene1}.
16002 Additionally, this option can specify that GCC should tune the performance
16003 of the code for a big.LITTLE system.  Permissible names are:
16004 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16005 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16006 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16007 @samp{cortex-a75.cortex-a55}.
16009 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16010 performance for a blend of processors within architecture @var{arch}.
16011 The aim is to generate code that run well on the current most popular
16012 processors, balancing between optimizations that benefit some CPUs in the
16013 range, and avoiding performance pitfalls of other CPUs.  The effects of
16014 this option may change in future GCC versions as CPU models come and go.
16016 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16017 the extension options do not affect the tuning of the generated code.
16019 @option{-mtune=native} causes the compiler to auto-detect the CPU
16020 of the build computer.  At present, this feature is only supported on
16021 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16022 unsuccessful the option has no effect.
16024 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16025 @opindex mcpu
16026 This specifies the name of the target ARM processor.  GCC uses this name
16027 to derive the name of the target ARM architecture (as if specified
16028 by @option{-march}) and the ARM processor type for which to tune for
16029 performance (as if specified by @option{-mtune}).  Where this option
16030 is used in conjunction with @option{-march} or @option{-mtune},
16031 those options take precedence over the appropriate part of this option.
16033 Many of the supported CPUs implement optional architectural
16034 extensions.  Where this is so the architectural extensions are
16035 normally enabled by default.  If implementations that lack the
16036 extension exist, then the extension syntax can be used to disable
16037 those extensions that have been omitted.  For floating-point and
16038 Advanced SIMD (Neon) instructions, the settings of the options
16039 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16040 floating-point and Advanced SIMD instructions will only be used if
16041 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16042 @option{-mfpu} other than @samp{auto} will override the available
16043 floating-point and SIMD extension instructions.
16045 For example, @samp{cortex-a9} can be found in three major
16046 configurations: integer only, with just a floating-point unit or with
16047 floating-point and Advanced SIMD.  The default is to enable all the
16048 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16049 be used to disable just the SIMD or both the SIMD and floating-point
16050 instructions respectively.
16052 Permissible names for this option are the same as those for
16053 @option{-mtune}.
16055 The following extension options are common to the listed CPUs:
16057 @table @samp
16058 @item +nodsp
16059 Disable the DSP instructions on @samp{cortex-m33}.
16061 @item  +nofp
16062 Disables the floating-point instructions on @samp{arm9e},
16063 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16064 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16065 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16066 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16067 Disables the floating-point and SIMD instructions on
16068 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16069 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16070 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16071 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16072 @samp{cortex-a53} and @samp{cortex-a55}.
16074 @item +nofp.dp
16075 Disables the double-precision component of the floating-point instructions
16076 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16078 @item +nosimd
16079 Disables the SIMD (but not floating-point) instructions on
16080 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16081 and @samp{cortex-a9}.
16083 @item +crypto
16084 Enables the cryptographic instructions on @samp{cortex-a32},
16085 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16086 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16087 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16088 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16089 @samp{cortex-a75.cortex-a55}.
16090 @end table
16092 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16093 VFPv3 with 16 double-precision registers.  It supports the following
16094 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16095 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16096 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16097 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16098 @option{-march=armv7-a}.
16100 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16101 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16102 See @option{-mtune} for more information.
16104 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16105 of the build computer.  At present, this feature is only supported on
16106 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16107 is unsuccessful the option has no effect.
16109 @item -mfpu=@var{name}
16110 @opindex mfpu
16111 This specifies what floating-point hardware (or hardware emulation) is
16112 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16113 @samp{vfpv3},
16114 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16115 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16116 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16117 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16118 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16119 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16120 is an alias for @samp{vfpv2}.
16122 The setting @samp{auto} is the default and is special.  It causes the
16123 compiler to select the floating-point and Advanced SIMD instructions
16124 based on the settings of @option{-mcpu} and @option{-march}.
16126 If the selected floating-point hardware includes the NEON extension
16127 (e.g. @option{-mfpu=neon}), note that floating-point
16128 operations are not generated by GCC's auto-vectorization pass unless
16129 @option{-funsafe-math-optimizations} is also specified.  This is
16130 because NEON hardware does not fully implement the IEEE 754 standard for
16131 floating-point arithmetic (in particular denormal values are treated as
16132 zero), so the use of NEON instructions may lead to a loss of precision.
16134 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}).
16136 @item -mfp16-format=@var{name}
16137 @opindex mfp16-format
16138 Specify the format of the @code{__fp16} half-precision floating-point type.
16139 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16140 the default is @samp{none}, in which case the @code{__fp16} type is not
16141 defined.  @xref{Half-Precision}, for more information.
16143 @item -mstructure-size-boundary=@var{n}
16144 @opindex mstructure-size-boundary
16145 The sizes of all structures and unions are rounded up to a multiple
16146 of the number of bits set by this option.  Permissible values are 8, 32
16147 and 64.  The default value varies for different toolchains.  For the COFF
16148 targeted toolchain the default value is 8.  A value of 64 is only allowed
16149 if the underlying ABI supports it.
16151 Specifying a larger number can produce faster, more efficient code, but
16152 can also increase the size of the program.  Different values are potentially
16153 incompatible.  Code compiled with one value cannot necessarily expect to
16154 work with code or libraries compiled with another value, if they exchange
16155 information using structures or unions.
16157 This option is deprecated.
16159 @item -mabort-on-noreturn
16160 @opindex mabort-on-noreturn
16161 Generate a call to the function @code{abort} at the end of a
16162 @code{noreturn} function.  It is executed if the function tries to
16163 return.
16165 @item -mlong-calls
16166 @itemx -mno-long-calls
16167 @opindex mlong-calls
16168 @opindex mno-long-calls
16169 Tells the compiler to perform function calls by first loading the
16170 address of the function into a register and then performing a subroutine
16171 call on this register.  This switch is needed if the target function
16172 lies outside of the 64-megabyte addressing range of the offset-based
16173 version of subroutine call instruction.
16175 Even if this switch is enabled, not all function calls are turned
16176 into long calls.  The heuristic is that static functions, functions
16177 that have the @code{short_call} attribute, functions that are inside
16178 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16179 definitions have already been compiled within the current compilation
16180 unit are not turned into long calls.  The exceptions to this rule are
16181 that weak function definitions, functions with the @code{long_call}
16182 attribute or the @code{section} attribute, and functions that are within
16183 the scope of a @code{#pragma long_calls} directive are always
16184 turned into long calls.
16186 This feature is not enabled by default.  Specifying
16187 @option{-mno-long-calls} restores the default behavior, as does
16188 placing the function calls within the scope of a @code{#pragma
16189 long_calls_off} directive.  Note these switches have no effect on how
16190 the compiler generates code to handle function calls via function
16191 pointers.
16193 @item -msingle-pic-base
16194 @opindex msingle-pic-base
16195 Treat the register used for PIC addressing as read-only, rather than
16196 loading it in the prologue for each function.  The runtime system is
16197 responsible for initializing this register with an appropriate value
16198 before execution begins.
16200 @item -mpic-register=@var{reg}
16201 @opindex mpic-register
16202 Specify the register to be used for PIC addressing.
16203 For standard PIC base case, the default is any suitable register
16204 determined by compiler.  For single PIC base case, the default is
16205 @samp{R9} if target is EABI based or stack-checking is enabled,
16206 otherwise the default is @samp{R10}.
16208 @item -mpic-data-is-text-relative
16209 @opindex mpic-data-is-text-relative
16210 Assume that the displacement between the text and data segments is fixed
16211 at static link time.  This permits using PC-relative addressing
16212 operations to access data known to be in the data segment.  For
16213 non-VxWorks RTP targets, this option is enabled by default.  When
16214 disabled on such targets, it will enable @option{-msingle-pic-base} by
16215 default.
16217 @item -mpoke-function-name
16218 @opindex mpoke-function-name
16219 Write the name of each function into the text section, directly
16220 preceding the function prologue.  The generated code is similar to this:
16222 @smallexample
16223      t0
16224          .ascii "arm_poke_function_name", 0
16225          .align
16226      t1
16227          .word 0xff000000 + (t1 - t0)
16228      arm_poke_function_name
16229          mov     ip, sp
16230          stmfd   sp!, @{fp, ip, lr, pc@}
16231          sub     fp, ip, #4
16232 @end smallexample
16234 When performing a stack backtrace, code can inspect the value of
16235 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16236 location @code{pc - 12} and the top 8 bits are set, then we know that
16237 there is a function name embedded immediately preceding this location
16238 and has length @code{((pc[-3]) & 0xff000000)}.
16240 @item -mthumb
16241 @itemx -marm
16242 @opindex marm
16243 @opindex mthumb
16245 Select between generating code that executes in ARM and Thumb
16246 states.  The default for most configurations is to generate code
16247 that executes in ARM state, but the default can be changed by
16248 configuring GCC with the @option{--with-mode=}@var{state}
16249 configure option.
16251 You can also override the ARM and Thumb mode for each function
16252 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16253 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16255 @item -mflip-thumb 
16256 @opindex mflip-thumb
16257 Switch ARM/Thumb modes on alternating functions.
16258 This option is provided for regression testing of mixed Thumb/ARM code
16259 generation, and is not intended for ordinary use in compiling code.
16261 @item -mtpcs-frame
16262 @opindex mtpcs-frame
16263 Generate a stack frame that is compliant with the Thumb Procedure Call
16264 Standard for all non-leaf functions.  (A leaf function is one that does
16265 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16267 @item -mtpcs-leaf-frame
16268 @opindex mtpcs-leaf-frame
16269 Generate a stack frame that is compliant with the Thumb Procedure Call
16270 Standard for all leaf functions.  (A leaf function is one that does
16271 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16273 @item -mcallee-super-interworking
16274 @opindex mcallee-super-interworking
16275 Gives all externally visible functions in the file being compiled an ARM
16276 instruction set header which switches to Thumb mode before executing the
16277 rest of the function.  This allows these functions to be called from
16278 non-interworking code.  This option is not valid in AAPCS configurations
16279 because interworking is enabled by default.
16281 @item -mcaller-super-interworking
16282 @opindex mcaller-super-interworking
16283 Allows calls via function pointers (including virtual functions) to
16284 execute correctly regardless of whether the target code has been
16285 compiled for interworking or not.  There is a small overhead in the cost
16286 of executing a function pointer if this option is enabled.  This option
16287 is not valid in AAPCS configurations because interworking is enabled
16288 by default.
16290 @item -mtp=@var{name}
16291 @opindex mtp
16292 Specify the access model for the thread local storage pointer.  The valid
16293 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16294 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16295 (supported in the arm6k architecture), and @samp{auto}, which uses the
16296 best available method for the selected processor.  The default setting is
16297 @samp{auto}.
16299 @item -mtls-dialect=@var{dialect}
16300 @opindex mtls-dialect
16301 Specify the dialect to use for accessing thread local storage.  Two
16302 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16303 @samp{gnu} dialect selects the original GNU scheme for supporting
16304 local and global dynamic TLS models.  The @samp{gnu2} dialect
16305 selects the GNU descriptor scheme, which provides better performance
16306 for shared libraries.  The GNU descriptor scheme is compatible with
16307 the original scheme, but does require new assembler, linker and
16308 library support.  Initial and local exec TLS models are unaffected by
16309 this option and always use the original scheme.
16311 @item -mword-relocations
16312 @opindex mword-relocations
16313 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16314 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16315 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16316 is specified.
16318 @item -mfix-cortex-m3-ldrd
16319 @opindex mfix-cortex-m3-ldrd
16320 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16321 with overlapping destination and base registers are used.  This option avoids
16322 generating these instructions.  This option is enabled by default when
16323 @option{-mcpu=cortex-m3} is specified.
16325 @item -munaligned-access
16326 @itemx -mno-unaligned-access
16327 @opindex munaligned-access
16328 @opindex mno-unaligned-access
16329 Enables (or disables) reading and writing of 16- and 32- bit values
16330 from addresses that are not 16- or 32- bit aligned.  By default
16331 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16332 ARMv8-M Baseline architectures, and enabled for all other
16333 architectures.  If unaligned access is not enabled then words in packed
16334 data structures are accessed a byte at a time.
16336 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16337 generated object file to either true or false, depending upon the
16338 setting of this option.  If unaligned access is enabled then the
16339 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16340 defined.
16342 @item -mneon-for-64bits
16343 @opindex mneon-for-64bits
16344 Enables using Neon to handle scalar 64-bits operations. This is
16345 disabled by default since the cost of moving data from core registers
16346 to Neon is high.
16348 @item -mslow-flash-data
16349 @opindex mslow-flash-data
16350 Assume loading data from flash is slower than fetching instruction.
16351 Therefore literal load is minimized for better performance.
16352 This option is only supported when compiling for ARMv7 M-profile and
16353 off by default.
16355 @item -masm-syntax-unified
16356 @opindex masm-syntax-unified
16357 Assume inline assembler is using unified asm syntax.  The default is
16358 currently off which implies divided syntax.  This option has no impact
16359 on Thumb2. However, this may change in future releases of GCC.
16360 Divided syntax should be considered deprecated.
16362 @item -mrestrict-it
16363 @opindex mrestrict-it
16364 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16365 IT blocks can only contain a single 16-bit instruction from a select
16366 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16368 @item -mprint-tune-info
16369 @opindex mprint-tune-info
16370 Print CPU tuning information as comment in assembler file.  This is
16371 an option used only for regression testing of the compiler and not
16372 intended for ordinary use in compiling code.  This option is disabled
16373 by default.
16375 @item -mverbose-cost-dump
16376 @opindex mverbose-cost-dump
16377 Enable verbose cost model dumping in the debug dump files.  This option is
16378 provided for use in debugging the compiler.
16380 @item -mpure-code
16381 @opindex mpure-code
16382 Do not allow constant data to be placed in code sections.
16383 Additionally, when compiling for ELF object format give all text sections the
16384 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16385 is only available when generating non-pic code for M-profile targets with the
16386 MOVT instruction.
16388 @item -mcmse
16389 @opindex mcmse
16390 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16391 Development Tools Engineering Specification", which can be found on
16392 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16393 @end table
16395 @node AVR Options
16396 @subsection AVR Options
16397 @cindex AVR Options
16399 These options are defined for AVR implementations:
16401 @table @gcctabopt
16402 @item -mmcu=@var{mcu}
16403 @opindex mmcu
16404 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16406 The default for this option is@tie{}@samp{avr2}.
16408 GCC supports the following AVR devices and ISAs:
16410 @include avr-mmcu.texi
16412 @item -mabsdata
16413 @opindex mabsdata
16415 Assume that all data in static storage can be accessed by LDS / STS
16416 instructions.  This option has only an effect on reduced Tiny devices like
16417 ATtiny40.  See also the @code{absdata}
16418 @ref{AVR Variable Attributes,variable attribute}.
16420 @item -maccumulate-args
16421 @opindex maccumulate-args
16422 Accumulate outgoing function arguments and acquire/release the needed
16423 stack space for outgoing function arguments once in function
16424 prologue/epilogue.  Without this option, outgoing arguments are pushed
16425 before calling a function and popped afterwards.
16427 Popping the arguments after the function call can be expensive on
16428 AVR so that accumulating the stack space might lead to smaller
16429 executables because arguments need not be removed from the
16430 stack after such a function call.
16432 This option can lead to reduced code size for functions that perform
16433 several calls to functions that get their arguments on the stack like
16434 calls to printf-like functions.
16436 @item -mbranch-cost=@var{cost}
16437 @opindex mbranch-cost
16438 Set the branch costs for conditional branch instructions to
16439 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16440 integers. The default branch cost is 0.
16442 @item -mcall-prologues
16443 @opindex mcall-prologues
16444 Functions prologues/epilogues are expanded as calls to appropriate
16445 subroutines.  Code size is smaller.
16447 @item -mgas-isr-prologues
16448 @opindex mgas-isr-prologues
16449 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16450 instruction supported by GNU Binutils.
16451 If this option is on, the feature can still be disabled for individual
16452 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16453 function attribute.  This feature is activated per default
16454 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16455 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16457 @item -mint8
16458 @opindex mint8
16459 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16460 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16461 and @code{long long} is 4 bytes.  Please note that this option does not
16462 conform to the C standards, but it results in smaller code
16463 size.
16465 @item -mn-flash=@var{num}
16466 @opindex mn-flash
16467 Assume that the flash memory has a size of 
16468 @var{num} times 64@tie{}KiB.
16470 @item -mno-interrupts
16471 @opindex mno-interrupts
16472 Generated code is not compatible with hardware interrupts.
16473 Code size is smaller.
16475 @item -mrelax
16476 @opindex mrelax
16477 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16478 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16479 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16480 the assembler's command line and the @option{--relax} option to the
16481 linker's command line.
16483 Jump relaxing is performed by the linker because jump offsets are not
16484 known before code is located. Therefore, the assembler code generated by the
16485 compiler is the same, but the instructions in the executable may
16486 differ from instructions in the assembler code.
16488 Relaxing must be turned on if linker stubs are needed, see the
16489 section on @code{EIND} and linker stubs below.
16491 @item -mrmw
16492 @opindex mrmw
16493 Assume that the device supports the Read-Modify-Write
16494 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16496 @item -mshort-calls
16497 @opindex mshort-calls
16499 Assume that @code{RJMP} and @code{RCALL} can target the whole
16500 program memory.
16502 This option is used internally for multilib selection.  It is
16503 not an optimization option, and you don't need to set it by hand.
16505 @item -msp8
16506 @opindex msp8
16507 Treat the stack pointer register as an 8-bit register,
16508 i.e.@: assume the high byte of the stack pointer is zero.
16509 In general, you don't need to set this option by hand.
16511 This option is used internally by the compiler to select and
16512 build multilibs for architectures @code{avr2} and @code{avr25}.
16513 These architectures mix devices with and without @code{SPH}.
16514 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16515 the compiler driver adds or removes this option from the compiler
16516 proper's command line, because the compiler then knows if the device
16517 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16518 register or not.
16520 @item -mstrict-X
16521 @opindex mstrict-X
16522 Use address register @code{X} in a way proposed by the hardware.  This means
16523 that @code{X} is only used in indirect, post-increment or
16524 pre-decrement addressing.
16526 Without this option, the @code{X} register may be used in the same way
16527 as @code{Y} or @code{Z} which then is emulated by additional
16528 instructions.  
16529 For example, loading a value with @code{X+const} addressing with a
16530 small non-negative @code{const < 64} to a register @var{Rn} is
16531 performed as
16533 @example
16534 adiw r26, const   ; X += const
16535 ld   @var{Rn}, X        ; @var{Rn} = *X
16536 sbiw r26, const   ; X -= const
16537 @end example
16539 @item -mtiny-stack
16540 @opindex mtiny-stack
16541 Only change the lower 8@tie{}bits of the stack pointer.
16543 @item -mfract-convert-truncate
16544 @opindex mfract-convert-truncate
16545 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16547 @item -nodevicelib
16548 @opindex nodevicelib
16549 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16551 @item -Waddr-space-convert
16552 @opindex Waddr-space-convert
16553 Warn about conversions between address spaces in the case where the
16554 resulting address space is not contained in the incoming address space.
16556 @item -Wmisspelled-isr
16557 @opindex Wmisspelled-isr
16558 Warn if the ISR is misspelled, i.e. without __vector prefix.
16559 Enabled by default.
16560 @end table
16562 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16563 @cindex @code{EIND}
16564 Pointers in the implementation are 16@tie{}bits wide.
16565 The address of a function or label is represented as word address so
16566 that indirect jumps and calls can target any code address in the
16567 range of 64@tie{}Ki words.
16569 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16570 bytes of program memory space, there is a special function register called
16571 @code{EIND} that serves as most significant part of the target address
16572 when @code{EICALL} or @code{EIJMP} instructions are used.
16574 Indirect jumps and calls on these devices are handled as follows by
16575 the compiler and are subject to some limitations:
16577 @itemize @bullet
16579 @item
16580 The compiler never sets @code{EIND}.
16582 @item
16583 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16584 instructions or might read @code{EIND} directly in order to emulate an
16585 indirect call/jump by means of a @code{RET} instruction.
16587 @item
16588 The compiler assumes that @code{EIND} never changes during the startup
16589 code or during the application. In particular, @code{EIND} is not
16590 saved/restored in function or interrupt service routine
16591 prologue/epilogue.
16593 @item
16594 For indirect calls to functions and computed goto, the linker
16595 generates @emph{stubs}. Stubs are jump pads sometimes also called
16596 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16597 The stub contains a direct jump to the desired address.
16599 @item
16600 Linker relaxation must be turned on so that the linker generates
16601 the stubs correctly in all situations. See the compiler option
16602 @option{-mrelax} and the linker option @option{--relax}.
16603 There are corner cases where the linker is supposed to generate stubs
16604 but aborts without relaxation and without a helpful error message.
16606 @item
16607 The default linker script is arranged for code with @code{EIND = 0}.
16608 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16609 linker script has to be used in order to place the sections whose
16610 name start with @code{.trampolines} into the segment where @code{EIND}
16611 points to.
16613 @item
16614 The startup code from libgcc never sets @code{EIND}.
16615 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16616 For the impact of AVR-LibC on @code{EIND}, see the
16617 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16619 @item
16620 It is legitimate for user-specific startup code to set up @code{EIND}
16621 early, for example by means of initialization code located in
16622 section @code{.init3}. Such code runs prior to general startup code
16623 that initializes RAM and calls constructors, but after the bit
16624 of startup code from AVR-LibC that sets @code{EIND} to the segment
16625 where the vector table is located.
16626 @example
16627 #include <avr/io.h>
16629 static void
16630 __attribute__((section(".init3"),naked,used,no_instrument_function))
16631 init3_set_eind (void)
16633   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16634                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16636 @end example
16638 @noindent
16639 The @code{__trampolines_start} symbol is defined in the linker script.
16641 @item
16642 Stubs are generated automatically by the linker if
16643 the following two conditions are met:
16644 @itemize @minus
16646 @item The address of a label is taken by means of the @code{gs} modifier
16647 (short for @emph{generate stubs}) like so:
16648 @example
16649 LDI r24, lo8(gs(@var{func}))
16650 LDI r25, hi8(gs(@var{func}))
16651 @end example
16652 @item The final location of that label is in a code segment
16653 @emph{outside} the segment where the stubs are located.
16654 @end itemize
16656 @item
16657 The compiler emits such @code{gs} modifiers for code labels in the
16658 following situations:
16659 @itemize @minus
16660 @item Taking address of a function or code label.
16661 @item Computed goto.
16662 @item If prologue-save function is used, see @option{-mcall-prologues}
16663 command-line option.
16664 @item Switch/case dispatch tables. If you do not want such dispatch
16665 tables you can specify the @option{-fno-jump-tables} command-line option.
16666 @item C and C++ constructors/destructors called during startup/shutdown.
16667 @item If the tools hit a @code{gs()} modifier explained above.
16668 @end itemize
16670 @item
16671 Jumping to non-symbolic addresses like so is @emph{not} supported:
16673 @example
16674 int main (void)
16676     /* Call function at word address 0x2 */
16677     return ((int(*)(void)) 0x2)();
16679 @end example
16681 Instead, a stub has to be set up, i.e.@: the function has to be called
16682 through a symbol (@code{func_4} in the example):
16684 @example
16685 int main (void)
16687     extern int func_4 (void);
16689     /* Call function at byte address 0x4 */
16690     return func_4();
16692 @end example
16694 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16695 Alternatively, @code{func_4} can be defined in the linker script.
16696 @end itemize
16698 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16699 @cindex @code{RAMPD}
16700 @cindex @code{RAMPX}
16701 @cindex @code{RAMPY}
16702 @cindex @code{RAMPZ}
16703 Some AVR devices support memories larger than the 64@tie{}KiB range
16704 that can be accessed with 16-bit pointers.  To access memory locations
16705 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16706 register is used as high part of the address:
16707 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16708 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16709 register, respectively, to get a wide address. Similarly,
16710 @code{RAMPD} is used together with direct addressing.
16712 @itemize
16713 @item
16714 The startup code initializes the @code{RAMP} special function
16715 registers with zero.
16717 @item
16718 If a @ref{AVR Named Address Spaces,named address space} other than
16719 generic or @code{__flash} is used, then @code{RAMPZ} is set
16720 as needed before the operation.
16722 @item
16723 If the device supports RAM larger than 64@tie{}KiB and the compiler
16724 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16725 is reset to zero after the operation.
16727 @item
16728 If the device comes with a specific @code{RAMP} register, the ISR
16729 prologue/epilogue saves/restores that SFR and initializes it with
16730 zero in case the ISR code might (implicitly) use it.
16732 @item
16733 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16734 If you use inline assembler to read from locations outside the
16735 16-bit address range and change one of the @code{RAMP} registers,
16736 you must reset it to zero after the access.
16738 @end itemize
16740 @subsubsection AVR Built-in Macros
16742 GCC defines several built-in macros so that the user code can test
16743 for the presence or absence of features.  Almost any of the following
16744 built-in macros are deduced from device capabilities and thus
16745 triggered by the @option{-mmcu=} command-line option.
16747 For even more AVR-specific built-in macros see
16748 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16750 @table @code
16752 @item __AVR_ARCH__
16753 Build-in macro that resolves to a decimal number that identifies the
16754 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16755 Possible values are:
16757 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16758 @code{4}, @code{5}, @code{51}, @code{6}
16760 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16761 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16763 respectively and
16765 @code{100},
16766 @code{102}, @code{103}, @code{104},
16767 @code{105}, @code{106}, @code{107}
16769 for @var{mcu}=@code{avrtiny},
16770 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16771 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16772 If @var{mcu} specifies a device, this built-in macro is set
16773 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16774 defined to @code{4}.
16776 @item __AVR_@var{Device}__
16777 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16778 the device's name. For example, @option{-mmcu=atmega8} defines the
16779 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16780 @code{__AVR_ATtiny261A__}, etc.
16782 The built-in macros' names follow
16783 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16784 the device name as from the AVR user manual. The difference between
16785 @var{Device} in the built-in macro and @var{device} in
16786 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16788 If @var{device} is not a device but only a core architecture like
16789 @samp{avr51}, this macro is not defined.
16791 @item __AVR_DEVICE_NAME__
16792 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16793 the device's name. For example, with @option{-mmcu=atmega8} the macro
16794 is defined to @code{atmega8}.
16796 If @var{device} is not a device but only a core architecture like
16797 @samp{avr51}, this macro is not defined.
16799 @item __AVR_XMEGA__
16800 The device / architecture belongs to the XMEGA family of devices.
16802 @item __AVR_HAVE_ELPM__
16803 The device has the @code{ELPM} instruction.
16805 @item __AVR_HAVE_ELPMX__
16806 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16807 R@var{n},Z+} instructions.
16809 @item __AVR_HAVE_MOVW__
16810 The device has the @code{MOVW} instruction to perform 16-bit
16811 register-register moves.
16813 @item __AVR_HAVE_LPMX__
16814 The device has the @code{LPM R@var{n},Z} and
16815 @code{LPM R@var{n},Z+} instructions.
16817 @item __AVR_HAVE_MUL__
16818 The device has a hardware multiplier. 
16820 @item __AVR_HAVE_JMP_CALL__
16821 The device has the @code{JMP} and @code{CALL} instructions.
16822 This is the case for devices with more than 8@tie{}KiB of program
16823 memory.
16825 @item __AVR_HAVE_EIJMP_EICALL__
16826 @itemx __AVR_3_BYTE_PC__
16827 The device has the @code{EIJMP} and @code{EICALL} instructions.
16828 This is the case for devices with more than 128@tie{}KiB of program memory.
16829 This also means that the program counter
16830 (PC) is 3@tie{}bytes wide.
16832 @item __AVR_2_BYTE_PC__
16833 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16834 with up to 128@tie{}KiB of program memory.
16836 @item __AVR_HAVE_8BIT_SP__
16837 @itemx __AVR_HAVE_16BIT_SP__
16838 The stack pointer (SP) register is treated as 8-bit respectively
16839 16-bit register by the compiler.
16840 The definition of these macros is affected by @option{-mtiny-stack}.
16842 @item __AVR_HAVE_SPH__
16843 @itemx __AVR_SP8__
16844 The device has the SPH (high part of stack pointer) special function
16845 register or has an 8-bit stack pointer, respectively.
16846 The definition of these macros is affected by @option{-mmcu=} and
16847 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16848 by @option{-msp8}.
16850 @item __AVR_HAVE_RAMPD__
16851 @itemx __AVR_HAVE_RAMPX__
16852 @itemx __AVR_HAVE_RAMPY__
16853 @itemx __AVR_HAVE_RAMPZ__
16854 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16855 @code{RAMPZ} special function register, respectively.
16857 @item __NO_INTERRUPTS__
16858 This macro reflects the @option{-mno-interrupts} command-line option.
16860 @item __AVR_ERRATA_SKIP__
16861 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16862 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16863 instructions because of a hardware erratum.  Skip instructions are
16864 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16865 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16866 set.
16868 @item __AVR_ISA_RMW__
16869 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16871 @item __AVR_SFR_OFFSET__=@var{offset}
16872 Instructions that can address I/O special function registers directly
16873 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16874 address as if addressed by an instruction to access RAM like @code{LD}
16875 or @code{STS}. This offset depends on the device architecture and has
16876 to be subtracted from the RAM address in order to get the
16877 respective I/O@tie{}address.
16879 @item __AVR_SHORT_CALLS__
16880 The @option{-mshort-calls} command line option is set.
16882 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16883 Some devices support reading from flash memory by means of @code{LD*}
16884 instructions.  The flash memory is seen in the data address space
16885 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16886 is not defined, this feature is not available.  If defined,
16887 the address space is linear and there is no need to put
16888 @code{.rodata} into RAM.  This is handled by the default linker
16889 description file, and is currently available for
16890 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16891 there is no need to use address spaces like @code{__flash} or
16892 features like attribute @code{progmem} and @code{pgm_read_*}.
16894 @item __WITH_AVRLIBC__
16895 The compiler is configured to be used together with AVR-Libc.
16896 See the @option{--with-avrlibc} configure option.
16898 @end table
16900 @node Blackfin Options
16901 @subsection Blackfin Options
16902 @cindex Blackfin Options
16904 @table @gcctabopt
16905 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16906 @opindex mcpu=
16907 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16908 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16909 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16910 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16911 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16912 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16913 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16914 @samp{bf561}, @samp{bf592}.
16916 The optional @var{sirevision} specifies the silicon revision of the target
16917 Blackfin processor.  Any workarounds available for the targeted silicon revision
16918 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16919 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16920 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16921 hexadecimal digits representing the major and minor numbers in the silicon
16922 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16923 is not defined.  If @var{sirevision} is @samp{any}, the
16924 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16925 If this optional @var{sirevision} is not used, GCC assumes the latest known
16926 silicon revision of the targeted Blackfin processor.
16928 GCC defines a preprocessor macro for the specified @var{cpu}.
16929 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16930 provided by libgloss to be linked in if @option{-msim} is not given.
16932 Without this option, @samp{bf532} is used as the processor by default.
16934 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16935 only the preprocessor macro is defined.
16937 @item -msim
16938 @opindex msim
16939 Specifies that the program will be run on the simulator.  This causes
16940 the simulator BSP provided by libgloss to be linked in.  This option
16941 has effect only for @samp{bfin-elf} toolchain.
16942 Certain other options, such as @option{-mid-shared-library} and
16943 @option{-mfdpic}, imply @option{-msim}.
16945 @item -momit-leaf-frame-pointer
16946 @opindex momit-leaf-frame-pointer
16947 Don't keep the frame pointer in a register for leaf functions.  This
16948 avoids the instructions to save, set up and restore frame pointers and
16949 makes an extra register available in leaf functions.
16951 @item -mspecld-anomaly
16952 @opindex mspecld-anomaly
16953 When enabled, the compiler ensures that the generated code does not
16954 contain speculative loads after jump instructions. If this option is used,
16955 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16957 @item -mno-specld-anomaly
16958 @opindex mno-specld-anomaly
16959 Don't generate extra code to prevent speculative loads from occurring.
16961 @item -mcsync-anomaly
16962 @opindex mcsync-anomaly
16963 When enabled, the compiler ensures that the generated code does not
16964 contain CSYNC or SSYNC instructions too soon after conditional branches.
16965 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16967 @item -mno-csync-anomaly
16968 @opindex mno-csync-anomaly
16969 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16970 occurring too soon after a conditional branch.
16972 @item -mlow-64k
16973 @opindex mlow-64k
16974 When enabled, the compiler is free to take advantage of the knowledge that
16975 the entire program fits into the low 64k of memory.
16977 @item -mno-low-64k
16978 @opindex mno-low-64k
16979 Assume that the program is arbitrarily large.  This is the default.
16981 @item -mstack-check-l1
16982 @opindex mstack-check-l1
16983 Do stack checking using information placed into L1 scratchpad memory by the
16984 uClinux kernel.
16986 @item -mid-shared-library
16987 @opindex mid-shared-library
16988 Generate code that supports shared libraries via the library ID method.
16989 This allows for execute in place and shared libraries in an environment
16990 without virtual memory management.  This option implies @option{-fPIC}.
16991 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16993 @item -mno-id-shared-library
16994 @opindex mno-id-shared-library
16995 Generate code that doesn't assume ID-based shared libraries are being used.
16996 This is the default.
16998 @item -mleaf-id-shared-library
16999 @opindex mleaf-id-shared-library
17000 Generate code that supports shared libraries via the library ID method,
17001 but assumes that this library or executable won't link against any other
17002 ID shared libraries.  That allows the compiler to use faster code for jumps
17003 and calls.
17005 @item -mno-leaf-id-shared-library
17006 @opindex mno-leaf-id-shared-library
17007 Do not assume that the code being compiled won't link against any ID shared
17008 libraries.  Slower code is generated for jump and call insns.
17010 @item -mshared-library-id=n
17011 @opindex mshared-library-id
17012 Specifies the identification number of the ID-based shared library being
17013 compiled.  Specifying a value of 0 generates more compact code; specifying
17014 other values forces the allocation of that number to the current
17015 library but is no more space- or time-efficient than omitting this option.
17017 @item -msep-data
17018 @opindex msep-data
17019 Generate code that allows the data segment to be located in a different
17020 area of memory from the text segment.  This allows for execute in place in
17021 an environment without virtual memory management by eliminating relocations
17022 against the text section.
17024 @item -mno-sep-data
17025 @opindex mno-sep-data
17026 Generate code that assumes that the data segment follows the text segment.
17027 This is the default.
17029 @item -mlong-calls
17030 @itemx -mno-long-calls
17031 @opindex mlong-calls
17032 @opindex mno-long-calls
17033 Tells the compiler to perform function calls by first loading the
17034 address of the function into a register and then performing a subroutine
17035 call on this register.  This switch is needed if the target function
17036 lies outside of the 24-bit addressing range of the offset-based
17037 version of subroutine call instruction.
17039 This feature is not enabled by default.  Specifying
17040 @option{-mno-long-calls} restores the default behavior.  Note these
17041 switches have no effect on how the compiler generates code to handle
17042 function calls via function pointers.
17044 @item -mfast-fp
17045 @opindex mfast-fp
17046 Link with the fast floating-point library. This library relaxes some of
17047 the IEEE floating-point standard's rules for checking inputs against
17048 Not-a-Number (NAN), in the interest of performance.
17050 @item -minline-plt
17051 @opindex minline-plt
17052 Enable inlining of PLT entries in function calls to functions that are
17053 not known to bind locally.  It has no effect without @option{-mfdpic}.
17055 @item -mmulticore
17056 @opindex mmulticore
17057 Build a standalone application for multicore Blackfin processors. 
17058 This option causes proper start files and link scripts supporting 
17059 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17060 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17062 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17063 selects the one-application-per-core programming model.  Without
17064 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17065 programming model is used. In this model, the main function of Core B
17066 should be named as @code{coreb_main}.
17068 If this option is not used, the single-core application programming
17069 model is used.
17071 @item -mcorea
17072 @opindex mcorea
17073 Build a standalone application for Core A of BF561 when using
17074 the one-application-per-core programming model. Proper start files
17075 and link scripts are used to support Core A, and the macro
17076 @code{__BFIN_COREA} is defined.
17077 This option can only be used in conjunction with @option{-mmulticore}.
17079 @item -mcoreb
17080 @opindex mcoreb
17081 Build a standalone application for Core B of BF561 when using
17082 the one-application-per-core programming model. Proper start files
17083 and link scripts are used to support Core B, and the macro
17084 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17085 should be used instead of @code{main}. 
17086 This option can only be used in conjunction with @option{-mmulticore}.
17088 @item -msdram
17089 @opindex msdram
17090 Build a standalone application for SDRAM. Proper start files and
17091 link scripts are used to put the application into SDRAM, and the macro
17092 @code{__BFIN_SDRAM} is defined.
17093 The loader should initialize SDRAM before loading the application.
17095 @item -micplb
17096 @opindex micplb
17097 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17098 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17099 are enabled; for standalone applications the default is off.
17100 @end table
17102 @node C6X Options
17103 @subsection C6X Options
17104 @cindex C6X Options
17106 @table @gcctabopt
17107 @item -march=@var{name}
17108 @opindex march
17109 This specifies the name of the target architecture.  GCC uses this
17110 name to determine what kind of instructions it can emit when generating
17111 assembly code.  Permissible names are: @samp{c62x},
17112 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17114 @item -mbig-endian
17115 @opindex mbig-endian
17116 Generate code for a big-endian target.
17118 @item -mlittle-endian
17119 @opindex mlittle-endian
17120 Generate code for a little-endian target.  This is the default.
17122 @item -msim
17123 @opindex msim
17124 Choose startup files and linker script suitable for the simulator.
17126 @item -msdata=default
17127 @opindex msdata=default
17128 Put small global and static data in the @code{.neardata} section,
17129 which is pointed to by register @code{B14}.  Put small uninitialized
17130 global and static data in the @code{.bss} section, which is adjacent
17131 to the @code{.neardata} section.  Put small read-only data into the
17132 @code{.rodata} section.  The corresponding sections used for large
17133 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17135 @item -msdata=all
17136 @opindex msdata=all
17137 Put all data, not just small objects, into the sections reserved for
17138 small data, and use addressing relative to the @code{B14} register to
17139 access them.
17141 @item -msdata=none
17142 @opindex msdata=none
17143 Make no use of the sections reserved for small data, and use absolute
17144 addresses to access all data.  Put all initialized global and static
17145 data in the @code{.fardata} section, and all uninitialized data in the
17146 @code{.far} section.  Put all constant data into the @code{.const}
17147 section.
17148 @end table
17150 @node CRIS Options
17151 @subsection CRIS Options
17152 @cindex CRIS Options
17154 These options are defined specifically for the CRIS ports.
17156 @table @gcctabopt
17157 @item -march=@var{architecture-type}
17158 @itemx -mcpu=@var{architecture-type}
17159 @opindex march
17160 @opindex mcpu
17161 Generate code for the specified architecture.  The choices for
17162 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17163 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17164 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17165 @samp{v10}.
17167 @item -mtune=@var{architecture-type}
17168 @opindex mtune
17169 Tune to @var{architecture-type} everything applicable about the generated
17170 code, except for the ABI and the set of available instructions.  The
17171 choices for @var{architecture-type} are the same as for
17172 @option{-march=@var{architecture-type}}.
17174 @item -mmax-stack-frame=@var{n}
17175 @opindex mmax-stack-frame
17176 Warn when the stack frame of a function exceeds @var{n} bytes.
17178 @item -metrax4
17179 @itemx -metrax100
17180 @opindex metrax4
17181 @opindex metrax100
17182 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17183 @option{-march=v3} and @option{-march=v8} respectively.
17185 @item -mmul-bug-workaround
17186 @itemx -mno-mul-bug-workaround
17187 @opindex mmul-bug-workaround
17188 @opindex mno-mul-bug-workaround
17189 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17190 models where it applies.  This option is active by default.
17192 @item -mpdebug
17193 @opindex mpdebug
17194 Enable CRIS-specific verbose debug-related information in the assembly
17195 code.  This option also has the effect of turning off the @samp{#NO_APP}
17196 formatted-code indicator to the assembler at the beginning of the
17197 assembly file.
17199 @item -mcc-init
17200 @opindex mcc-init
17201 Do not use condition-code results from previous instruction; always emit
17202 compare and test instructions before use of condition codes.
17204 @item -mno-side-effects
17205 @opindex mno-side-effects
17206 Do not emit instructions with side effects in addressing modes other than
17207 post-increment.
17209 @item -mstack-align
17210 @itemx -mno-stack-align
17211 @itemx -mdata-align
17212 @itemx -mno-data-align
17213 @itemx -mconst-align
17214 @itemx -mno-const-align
17215 @opindex mstack-align
17216 @opindex mno-stack-align
17217 @opindex mdata-align
17218 @opindex mno-data-align
17219 @opindex mconst-align
17220 @opindex mno-const-align
17221 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17222 stack frame, individual data and constants to be aligned for the maximum
17223 single data access size for the chosen CPU model.  The default is to
17224 arrange for 32-bit alignment.  ABI details such as structure layout are
17225 not affected by these options.
17227 @item -m32-bit
17228 @itemx -m16-bit
17229 @itemx -m8-bit
17230 @opindex m32-bit
17231 @opindex m16-bit
17232 @opindex m8-bit
17233 Similar to the stack- data- and const-align options above, these options
17234 arrange for stack frame, writable data and constants to all be 32-bit,
17235 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17237 @item -mno-prologue-epilogue
17238 @itemx -mprologue-epilogue
17239 @opindex mno-prologue-epilogue
17240 @opindex mprologue-epilogue
17241 With @option{-mno-prologue-epilogue}, the normal function prologue and
17242 epilogue which set up the stack frame are omitted and no return
17243 instructions or return sequences are generated in the code.  Use this
17244 option only together with visual inspection of the compiled code: no
17245 warnings or errors are generated when call-saved registers must be saved,
17246 or storage for local variables needs to be allocated.
17248 @item -mno-gotplt
17249 @itemx -mgotplt
17250 @opindex mno-gotplt
17251 @opindex mgotplt
17252 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17253 instruction sequences that load addresses for functions from the PLT part
17254 of the GOT rather than (traditional on other architectures) calls to the
17255 PLT@.  The default is @option{-mgotplt}.
17257 @item -melf
17258 @opindex melf
17259 Legacy no-op option only recognized with the cris-axis-elf and
17260 cris-axis-linux-gnu targets.
17262 @item -mlinux
17263 @opindex mlinux
17264 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17266 @item -sim
17267 @opindex sim
17268 This option, recognized for the cris-axis-elf, arranges
17269 to link with input-output functions from a simulator library.  Code,
17270 initialized data and zero-initialized data are allocated consecutively.
17272 @item -sim2
17273 @opindex sim2
17274 Like @option{-sim}, but pass linker options to locate initialized data at
17275 0x40000000 and zero-initialized data at 0x80000000.
17276 @end table
17278 @node CR16 Options
17279 @subsection CR16 Options
17280 @cindex CR16 Options
17282 These options are defined specifically for the CR16 ports.
17284 @table @gcctabopt
17286 @item -mmac
17287 @opindex mmac
17288 Enable the use of multiply-accumulate instructions. Disabled by default.
17290 @item -mcr16cplus
17291 @itemx -mcr16c
17292 @opindex mcr16cplus
17293 @opindex mcr16c
17294 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17295 is default.
17297 @item -msim
17298 @opindex msim
17299 Links the library libsim.a which is in compatible with simulator. Applicable
17300 to ELF compiler only.
17302 @item -mint32
17303 @opindex mint32
17304 Choose integer type as 32-bit wide.
17306 @item -mbit-ops
17307 @opindex mbit-ops
17308 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17310 @item -mdata-model=@var{model}
17311 @opindex mdata-model
17312 Choose a data model. The choices for @var{model} are @samp{near},
17313 @samp{far} or @samp{medium}. @samp{medium} is default.
17314 However, @samp{far} is not valid with @option{-mcr16c}, as the
17315 CR16C architecture does not support the far data model.
17316 @end table
17318 @node Darwin Options
17319 @subsection Darwin Options
17320 @cindex Darwin options
17322 These options are defined for all architectures running the Darwin operating
17323 system.
17325 FSF GCC on Darwin does not create ``fat'' object files; it creates
17326 an object file for the single architecture that GCC was built to
17327 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17328 @option{-arch} options are used; it does so by running the compiler or
17329 linker multiple times and joining the results together with
17330 @file{lipo}.
17332 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17333 @samp{i686}) is determined by the flags that specify the ISA
17334 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17335 @option{-force_cpusubtype_ALL} option can be used to override this.
17337 The Darwin tools vary in their behavior when presented with an ISA
17338 mismatch.  The assembler, @file{as}, only permits instructions to
17339 be used that are valid for the subtype of the file it is generating,
17340 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17341 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17342 and prints an error if asked to create a shared library with a less
17343 restrictive subtype than its input files (for instance, trying to put
17344 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17345 for executables, @command{ld}, quietly gives the executable the most
17346 restrictive subtype of any of its input files.
17348 @table @gcctabopt
17349 @item -F@var{dir}
17350 @opindex F
17351 Add the framework directory @var{dir} to the head of the list of
17352 directories to be searched for header files.  These directories are
17353 interleaved with those specified by @option{-I} options and are
17354 scanned in a left-to-right order.
17356 A framework directory is a directory with frameworks in it.  A
17357 framework is a directory with a @file{Headers} and/or
17358 @file{PrivateHeaders} directory contained directly in it that ends
17359 in @file{.framework}.  The name of a framework is the name of this
17360 directory excluding the @file{.framework}.  Headers associated with
17361 the framework are found in one of those two directories, with
17362 @file{Headers} being searched first.  A subframework is a framework
17363 directory that is in a framework's @file{Frameworks} directory.
17364 Includes of subframework headers can only appear in a header of a
17365 framework that contains the subframework, or in a sibling subframework
17366 header.  Two subframeworks are siblings if they occur in the same
17367 framework.  A subframework should not have the same name as a
17368 framework; a warning is issued if this is violated.  Currently a
17369 subframework cannot have subframeworks; in the future, the mechanism
17370 may be extended to support this.  The standard frameworks can be found
17371 in @file{/System/Library/Frameworks} and
17372 @file{/Library/Frameworks}.  An example include looks like
17373 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17374 the name of the framework and @file{header.h} is found in the
17375 @file{PrivateHeaders} or @file{Headers} directory.
17377 @item -iframework@var{dir}
17378 @opindex iframework
17379 Like @option{-F} except the directory is a treated as a system
17380 directory.  The main difference between this @option{-iframework} and
17381 @option{-F} is that with @option{-iframework} the compiler does not
17382 warn about constructs contained within header files found via
17383 @var{dir}.  This option is valid only for the C family of languages.
17385 @item -gused
17386 @opindex gused
17387 Emit debugging information for symbols that are used.  For stabs
17388 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17389 This is by default ON@.
17391 @item -gfull
17392 @opindex gfull
17393 Emit debugging information for all symbols and types.
17395 @item -mmacosx-version-min=@var{version}
17396 The earliest version of MacOS X that this executable will run on
17397 is @var{version}.  Typical values of @var{version} include @code{10.1},
17398 @code{10.2}, and @code{10.3.9}.
17400 If the compiler was built to use the system's headers by default,
17401 then the default for this option is the system version on which the
17402 compiler is running, otherwise the default is to make choices that
17403 are compatible with as many systems and code bases as possible.
17405 @item -mkernel
17406 @opindex mkernel
17407 Enable kernel development mode.  The @option{-mkernel} option sets
17408 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17409 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17410 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17411 applicable.  This mode also sets @option{-mno-altivec},
17412 @option{-msoft-float}, @option{-fno-builtin} and
17413 @option{-mlong-branch} for PowerPC targets.
17415 @item -mone-byte-bool
17416 @opindex mone-byte-bool
17417 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17418 By default @code{sizeof(bool)} is @code{4} when compiling for
17419 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17420 option has no effect on x86.
17422 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17423 to generate code that is not binary compatible with code generated
17424 without that switch.  Using this switch may require recompiling all
17425 other modules in a program, including system libraries.  Use this
17426 switch to conform to a non-default data model.
17428 @item -mfix-and-continue
17429 @itemx -ffix-and-continue
17430 @itemx -findirect-data
17431 @opindex mfix-and-continue
17432 @opindex ffix-and-continue
17433 @opindex findirect-data
17434 Generate code suitable for fast turnaround development, such as to
17435 allow GDB to dynamically load @file{.o} files into already-running
17436 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17437 are provided for backwards compatibility.
17439 @item -all_load
17440 @opindex all_load
17441 Loads all members of static archive libraries.
17442 See man ld(1) for more information.
17444 @item -arch_errors_fatal
17445 @opindex arch_errors_fatal
17446 Cause the errors having to do with files that have the wrong architecture
17447 to be fatal.
17449 @item -bind_at_load
17450 @opindex bind_at_load
17451 Causes the output file to be marked such that the dynamic linker will
17452 bind all undefined references when the file is loaded or launched.
17454 @item -bundle
17455 @opindex bundle
17456 Produce a Mach-o bundle format file.
17457 See man ld(1) for more information.
17459 @item -bundle_loader @var{executable}
17460 @opindex bundle_loader
17461 This option specifies the @var{executable} that will load the build
17462 output file being linked.  See man ld(1) for more information.
17464 @item -dynamiclib
17465 @opindex dynamiclib
17466 When passed this option, GCC produces a dynamic library instead of
17467 an executable when linking, using the Darwin @file{libtool} command.
17469 @item -force_cpusubtype_ALL
17470 @opindex force_cpusubtype_ALL
17471 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17472 one controlled by the @option{-mcpu} or @option{-march} option.
17474 @item -allowable_client  @var{client_name}
17475 @itemx -client_name
17476 @itemx -compatibility_version
17477 @itemx -current_version
17478 @itemx -dead_strip
17479 @itemx -dependency-file
17480 @itemx -dylib_file
17481 @itemx -dylinker_install_name
17482 @itemx -dynamic
17483 @itemx -exported_symbols_list
17484 @itemx -filelist
17485 @need 800
17486 @itemx -flat_namespace
17487 @itemx -force_flat_namespace
17488 @itemx -headerpad_max_install_names
17489 @itemx -image_base
17490 @itemx -init
17491 @itemx -install_name
17492 @itemx -keep_private_externs
17493 @itemx -multi_module
17494 @itemx -multiply_defined
17495 @itemx -multiply_defined_unused
17496 @need 800
17497 @itemx -noall_load
17498 @itemx -no_dead_strip_inits_and_terms
17499 @itemx -nofixprebinding
17500 @itemx -nomultidefs
17501 @itemx -noprebind
17502 @itemx -noseglinkedit
17503 @itemx -pagezero_size
17504 @itemx -prebind
17505 @itemx -prebind_all_twolevel_modules
17506 @itemx -private_bundle
17507 @need 800
17508 @itemx -read_only_relocs
17509 @itemx -sectalign
17510 @itemx -sectobjectsymbols
17511 @itemx -whyload
17512 @itemx -seg1addr
17513 @itemx -sectcreate
17514 @itemx -sectobjectsymbols
17515 @itemx -sectorder
17516 @itemx -segaddr
17517 @itemx -segs_read_only_addr
17518 @need 800
17519 @itemx -segs_read_write_addr
17520 @itemx -seg_addr_table
17521 @itemx -seg_addr_table_filename
17522 @itemx -seglinkedit
17523 @itemx -segprot
17524 @itemx -segs_read_only_addr
17525 @itemx -segs_read_write_addr
17526 @itemx -single_module
17527 @itemx -static
17528 @itemx -sub_library
17529 @need 800
17530 @itemx -sub_umbrella
17531 @itemx -twolevel_namespace
17532 @itemx -umbrella
17533 @itemx -undefined
17534 @itemx -unexported_symbols_list
17535 @itemx -weak_reference_mismatches
17536 @itemx -whatsloaded
17537 @opindex allowable_client
17538 @opindex client_name
17539 @opindex compatibility_version
17540 @opindex current_version
17541 @opindex dead_strip
17542 @opindex dependency-file
17543 @opindex dylib_file
17544 @opindex dylinker_install_name
17545 @opindex dynamic
17546 @opindex exported_symbols_list
17547 @opindex filelist
17548 @opindex flat_namespace
17549 @opindex force_flat_namespace
17550 @opindex headerpad_max_install_names
17551 @opindex image_base
17552 @opindex init
17553 @opindex install_name
17554 @opindex keep_private_externs
17555 @opindex multi_module
17556 @opindex multiply_defined
17557 @opindex multiply_defined_unused
17558 @opindex noall_load
17559 @opindex no_dead_strip_inits_and_terms
17560 @opindex nofixprebinding
17561 @opindex nomultidefs
17562 @opindex noprebind
17563 @opindex noseglinkedit
17564 @opindex pagezero_size
17565 @opindex prebind
17566 @opindex prebind_all_twolevel_modules
17567 @opindex private_bundle
17568 @opindex read_only_relocs
17569 @opindex sectalign
17570 @opindex sectobjectsymbols
17571 @opindex whyload
17572 @opindex seg1addr
17573 @opindex sectcreate
17574 @opindex sectobjectsymbols
17575 @opindex sectorder
17576 @opindex segaddr
17577 @opindex segs_read_only_addr
17578 @opindex segs_read_write_addr
17579 @opindex seg_addr_table
17580 @opindex seg_addr_table_filename
17581 @opindex seglinkedit
17582 @opindex segprot
17583 @opindex segs_read_only_addr
17584 @opindex segs_read_write_addr
17585 @opindex single_module
17586 @opindex static
17587 @opindex sub_library
17588 @opindex sub_umbrella
17589 @opindex twolevel_namespace
17590 @opindex umbrella
17591 @opindex undefined
17592 @opindex unexported_symbols_list
17593 @opindex weak_reference_mismatches
17594 @opindex whatsloaded
17595 These options are passed to the Darwin linker.  The Darwin linker man page
17596 describes them in detail.
17597 @end table
17599 @node DEC Alpha Options
17600 @subsection DEC Alpha Options
17602 These @samp{-m} options are defined for the DEC Alpha implementations:
17604 @table @gcctabopt
17605 @item -mno-soft-float
17606 @itemx -msoft-float
17607 @opindex mno-soft-float
17608 @opindex msoft-float
17609 Use (do not use) the hardware floating-point instructions for
17610 floating-point operations.  When @option{-msoft-float} is specified,
17611 functions in @file{libgcc.a} are used to perform floating-point
17612 operations.  Unless they are replaced by routines that emulate the
17613 floating-point operations, or compiled in such a way as to call such
17614 emulations routines, these routines issue floating-point
17615 operations.   If you are compiling for an Alpha without floating-point
17616 operations, you must ensure that the library is built so as not to call
17617 them.
17619 Note that Alpha implementations without floating-point operations are
17620 required to have floating-point registers.
17622 @item -mfp-reg
17623 @itemx -mno-fp-regs
17624 @opindex mfp-reg
17625 @opindex mno-fp-regs
17626 Generate code that uses (does not use) the floating-point register set.
17627 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17628 register set is not used, floating-point operands are passed in integer
17629 registers as if they were integers and floating-point results are passed
17630 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17631 so any function with a floating-point argument or return value called by code
17632 compiled with @option{-mno-fp-regs} must also be compiled with that
17633 option.
17635 A typical use of this option is building a kernel that does not use,
17636 and hence need not save and restore, any floating-point registers.
17638 @item -mieee
17639 @opindex mieee
17640 The Alpha architecture implements floating-point hardware optimized for
17641 maximum performance.  It is mostly compliant with the IEEE floating-point
17642 standard.  However, for full compliance, software assistance is
17643 required.  This option generates code fully IEEE-compliant code
17644 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17645 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17646 defined during compilation.  The resulting code is less efficient but is
17647 able to correctly support denormalized numbers and exceptional IEEE
17648 values such as not-a-number and plus/minus infinity.  Other Alpha
17649 compilers call this option @option{-ieee_with_no_inexact}.
17651 @item -mieee-with-inexact
17652 @opindex mieee-with-inexact
17653 This is like @option{-mieee} except the generated code also maintains
17654 the IEEE @var{inexact-flag}.  Turning on this option causes the
17655 generated code to implement fully-compliant IEEE math.  In addition to
17656 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17657 macro.  On some Alpha implementations the resulting code may execute
17658 significantly slower than the code generated by default.  Since there is
17659 very little code that depends on the @var{inexact-flag}, you should
17660 normally not specify this option.  Other Alpha compilers call this
17661 option @option{-ieee_with_inexact}.
17663 @item -mfp-trap-mode=@var{trap-mode}
17664 @opindex mfp-trap-mode
17665 This option controls what floating-point related traps are enabled.
17666 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17667 The trap mode can be set to one of four values:
17669 @table @samp
17670 @item n
17671 This is the default (normal) setting.  The only traps that are enabled
17672 are the ones that cannot be disabled in software (e.g., division by zero
17673 trap).
17675 @item u
17676 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17677 as well.
17679 @item su
17680 Like @samp{u}, but the instructions are marked to be safe for software
17681 completion (see Alpha architecture manual for details).
17683 @item sui
17684 Like @samp{su}, but inexact traps are enabled as well.
17685 @end table
17687 @item -mfp-rounding-mode=@var{rounding-mode}
17688 @opindex mfp-rounding-mode
17689 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17690 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17693 @table @samp
17694 @item n
17695 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17696 the nearest machine number or towards the even machine number in case
17697 of a tie.
17699 @item m
17700 Round towards minus infinity.
17702 @item c
17703 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17705 @item d
17706 Dynamic rounding mode.  A field in the floating-point control register
17707 (@var{fpcr}, see Alpha architecture reference manual) controls the
17708 rounding mode in effect.  The C library initializes this register for
17709 rounding towards plus infinity.  Thus, unless your program modifies the
17710 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17711 @end table
17713 @item -mtrap-precision=@var{trap-precision}
17714 @opindex mtrap-precision
17715 In the Alpha architecture, floating-point traps are imprecise.  This
17716 means without software assistance it is impossible to recover from a
17717 floating trap and program execution normally needs to be terminated.
17718 GCC can generate code that can assist operating system trap handlers
17719 in determining the exact location that caused a floating-point trap.
17720 Depending on the requirements of an application, different levels of
17721 precisions can be selected:
17723 @table @samp
17724 @item p
17725 Program precision.  This option is the default and means a trap handler
17726 can only identify which program caused a floating-point exception.
17728 @item f
17729 Function precision.  The trap handler can determine the function that
17730 caused a floating-point exception.
17732 @item i
17733 Instruction precision.  The trap handler can determine the exact
17734 instruction that caused a floating-point exception.
17735 @end table
17737 Other Alpha compilers provide the equivalent options called
17738 @option{-scope_safe} and @option{-resumption_safe}.
17740 @item -mieee-conformant
17741 @opindex mieee-conformant
17742 This option marks the generated code as IEEE conformant.  You must not
17743 use this option unless you also specify @option{-mtrap-precision=i} and either
17744 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17745 is to emit the line @samp{.eflag 48} in the function prologue of the
17746 generated assembly file.
17748 @item -mbuild-constants
17749 @opindex mbuild-constants
17750 Normally GCC examines a 32- or 64-bit integer constant to
17751 see if it can construct it from smaller constants in two or three
17752 instructions.  If it cannot, it outputs the constant as a literal and
17753 generates code to load it from the data segment at run time.
17755 Use this option to require GCC to construct @emph{all} integer constants
17756 using code, even if it takes more instructions (the maximum is six).
17758 You typically use this option to build a shared library dynamic
17759 loader.  Itself a shared library, it must relocate itself in memory
17760 before it can find the variables and constants in its own data segment.
17762 @item -mbwx
17763 @itemx -mno-bwx
17764 @itemx -mcix
17765 @itemx -mno-cix
17766 @itemx -mfix
17767 @itemx -mno-fix
17768 @itemx -mmax
17769 @itemx -mno-max
17770 @opindex mbwx
17771 @opindex mno-bwx
17772 @opindex mcix
17773 @opindex mno-cix
17774 @opindex mfix
17775 @opindex mno-fix
17776 @opindex mmax
17777 @opindex mno-max
17778 Indicate whether GCC should generate code to use the optional BWX,
17779 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17780 sets supported by the CPU type specified via @option{-mcpu=} option or that
17781 of the CPU on which GCC was built if none is specified.
17783 @item -mfloat-vax
17784 @itemx -mfloat-ieee
17785 @opindex mfloat-vax
17786 @opindex mfloat-ieee
17787 Generate code that uses (does not use) VAX F and G floating-point
17788 arithmetic instead of IEEE single and double precision.
17790 @item -mexplicit-relocs
17791 @itemx -mno-explicit-relocs
17792 @opindex mexplicit-relocs
17793 @opindex mno-explicit-relocs
17794 Older Alpha assemblers provided no way to generate symbol relocations
17795 except via assembler macros.  Use of these macros does not allow
17796 optimal instruction scheduling.  GNU binutils as of version 2.12
17797 supports a new syntax that allows the compiler to explicitly mark
17798 which relocations should apply to which instructions.  This option
17799 is mostly useful for debugging, as GCC detects the capabilities of
17800 the assembler when it is built and sets the default accordingly.
17802 @item -msmall-data
17803 @itemx -mlarge-data
17804 @opindex msmall-data
17805 @opindex mlarge-data
17806 When @option{-mexplicit-relocs} is in effect, static data is
17807 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17808 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17809 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17810 16-bit relocations off of the @code{$gp} register.  This limits the
17811 size of the small data area to 64KB, but allows the variables to be
17812 directly accessed via a single instruction.
17814 The default is @option{-mlarge-data}.  With this option the data area
17815 is limited to just below 2GB@.  Programs that require more than 2GB of
17816 data must use @code{malloc} or @code{mmap} to allocate the data in the
17817 heap instead of in the program's data segment.
17819 When generating code for shared libraries, @option{-fpic} implies
17820 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17822 @item -msmall-text
17823 @itemx -mlarge-text
17824 @opindex msmall-text
17825 @opindex mlarge-text
17826 When @option{-msmall-text} is used, the compiler assumes that the
17827 code of the entire program (or shared library) fits in 4MB, and is
17828 thus reachable with a branch instruction.  When @option{-msmall-data}
17829 is used, the compiler can assume that all local symbols share the
17830 same @code{$gp} value, and thus reduce the number of instructions
17831 required for a function call from 4 to 1.
17833 The default is @option{-mlarge-text}.
17835 @item -mcpu=@var{cpu_type}
17836 @opindex mcpu
17837 Set the instruction set and instruction scheduling parameters for
17838 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17839 style name or the corresponding chip number.  GCC supports scheduling
17840 parameters for the EV4, EV5 and EV6 family of processors and
17841 chooses the default values for the instruction set from the processor
17842 you specify.  If you do not specify a processor type, GCC defaults
17843 to the processor on which the compiler was built.
17845 Supported values for @var{cpu_type} are
17847 @table @samp
17848 @item ev4
17849 @itemx ev45
17850 @itemx 21064
17851 Schedules as an EV4 and has no instruction set extensions.
17853 @item ev5
17854 @itemx 21164
17855 Schedules as an EV5 and has no instruction set extensions.
17857 @item ev56
17858 @itemx 21164a
17859 Schedules as an EV5 and supports the BWX extension.
17861 @item pca56
17862 @itemx 21164pc
17863 @itemx 21164PC
17864 Schedules as an EV5 and supports the BWX and MAX extensions.
17866 @item ev6
17867 @itemx 21264
17868 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17870 @item ev67
17871 @itemx 21264a
17872 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17873 @end table
17875 Native toolchains also support the value @samp{native},
17876 which selects the best architecture option for the host processor.
17877 @option{-mcpu=native} has no effect if GCC does not recognize
17878 the processor.
17880 @item -mtune=@var{cpu_type}
17881 @opindex mtune
17882 Set only the instruction scheduling parameters for machine type
17883 @var{cpu_type}.  The instruction set is not changed.
17885 Native toolchains also support the value @samp{native},
17886 which selects the best architecture option for the host processor.
17887 @option{-mtune=native} has no effect if GCC does not recognize
17888 the processor.
17890 @item -mmemory-latency=@var{time}
17891 @opindex mmemory-latency
17892 Sets the latency the scheduler should assume for typical memory
17893 references as seen by the application.  This number is highly
17894 dependent on the memory access patterns used by the application
17895 and the size of the external cache on the machine.
17897 Valid options for @var{time} are
17899 @table @samp
17900 @item @var{number}
17901 A decimal number representing clock cycles.
17903 @item L1
17904 @itemx L2
17905 @itemx L3
17906 @itemx main
17907 The compiler contains estimates of the number of clock cycles for
17908 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17909 (also called Dcache, Scache, and Bcache), as well as to main memory.
17910 Note that L3 is only valid for EV5.
17912 @end table
17913 @end table
17915 @node FR30 Options
17916 @subsection FR30 Options
17917 @cindex FR30 Options
17919 These options are defined specifically for the FR30 port.
17921 @table @gcctabopt
17923 @item -msmall-model
17924 @opindex msmall-model
17925 Use the small address space model.  This can produce smaller code, but
17926 it does assume that all symbolic values and addresses fit into a
17927 20-bit range.
17929 @item -mno-lsim
17930 @opindex mno-lsim
17931 Assume that runtime support has been provided and so there is no need
17932 to include the simulator library (@file{libsim.a}) on the linker
17933 command line.
17935 @end table
17937 @node FT32 Options
17938 @subsection FT32 Options
17939 @cindex FT32 Options
17941 These options are defined specifically for the FT32 port.
17943 @table @gcctabopt
17945 @item -msim
17946 @opindex msim
17947 Specifies that the program will be run on the simulator.  This causes
17948 an alternate runtime startup and library to be linked.
17949 You must not use this option when generating programs that will run on
17950 real hardware; you must provide your own runtime library for whatever
17951 I/O functions are needed.
17953 @item -mlra
17954 @opindex mlra
17955 Enable Local Register Allocation.  This is still experimental for FT32,
17956 so by default the compiler uses standard reload.
17958 @item -mnodiv
17959 @opindex mnodiv
17960 Do not use div and mod instructions.
17962 @item -mft32b
17963 @opindex mft32b
17964 Enable use of the extended instructions of the FT32B processor.
17966 @item -mcompress
17967 @opindex mcompress
17968 Compress all code using the Ft32B code compression scheme.
17970 @item -mnopm
17971 @opindex  mnopm
17972 Do not generate code that reads program memory.
17974 @end table
17976 @node FRV Options
17977 @subsection FRV Options
17978 @cindex FRV Options
17980 @table @gcctabopt
17981 @item -mgpr-32
17982 @opindex mgpr-32
17984 Only use the first 32 general-purpose registers.
17986 @item -mgpr-64
17987 @opindex mgpr-64
17989 Use all 64 general-purpose registers.
17991 @item -mfpr-32
17992 @opindex mfpr-32
17994 Use only the first 32 floating-point registers.
17996 @item -mfpr-64
17997 @opindex mfpr-64
17999 Use all 64 floating-point registers.
18001 @item -mhard-float
18002 @opindex mhard-float
18004 Use hardware instructions for floating-point operations.
18006 @item -msoft-float
18007 @opindex msoft-float
18009 Use library routines for floating-point operations.
18011 @item -malloc-cc
18012 @opindex malloc-cc
18014 Dynamically allocate condition code registers.
18016 @item -mfixed-cc
18017 @opindex mfixed-cc
18019 Do not try to dynamically allocate condition code registers, only
18020 use @code{icc0} and @code{fcc0}.
18022 @item -mdword
18023 @opindex mdword
18025 Change ABI to use double word insns.
18027 @item -mno-dword
18028 @opindex mno-dword
18030 Do not use double word instructions.
18032 @item -mdouble
18033 @opindex mdouble
18035 Use floating-point double instructions.
18037 @item -mno-double
18038 @opindex mno-double
18040 Do not use floating-point double instructions.
18042 @item -mmedia
18043 @opindex mmedia
18045 Use media instructions.
18047 @item -mno-media
18048 @opindex mno-media
18050 Do not use media instructions.
18052 @item -mmuladd
18053 @opindex mmuladd
18055 Use multiply and add/subtract instructions.
18057 @item -mno-muladd
18058 @opindex mno-muladd
18060 Do not use multiply and add/subtract instructions.
18062 @item -mfdpic
18063 @opindex mfdpic
18065 Select the FDPIC ABI, which uses function descriptors to represent
18066 pointers to functions.  Without any PIC/PIE-related options, it
18067 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18068 assumes GOT entries and small data are within a 12-bit range from the
18069 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18070 are computed with 32 bits.
18071 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18073 @item -minline-plt
18074 @opindex minline-plt
18076 Enable inlining of PLT entries in function calls to functions that are
18077 not known to bind locally.  It has no effect without @option{-mfdpic}.
18078 It's enabled by default if optimizing for speed and compiling for
18079 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18080 optimization option such as @option{-O3} or above is present in the
18081 command line.
18083 @item -mTLS
18084 @opindex mTLS
18086 Assume a large TLS segment when generating thread-local code.
18088 @item -mtls
18089 @opindex mtls
18091 Do not assume a large TLS segment when generating thread-local code.
18093 @item -mgprel-ro
18094 @opindex mgprel-ro
18096 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18097 that is known to be in read-only sections.  It's enabled by default,
18098 except for @option{-fpic} or @option{-fpie}: even though it may help
18099 make the global offset table smaller, it trades 1 instruction for 4.
18100 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18101 one of which may be shared by multiple symbols, and it avoids the need
18102 for a GOT entry for the referenced symbol, so it's more likely to be a
18103 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18105 @item -multilib-library-pic
18106 @opindex multilib-library-pic
18108 Link with the (library, not FD) pic libraries.  It's implied by
18109 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18110 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18111 it explicitly.
18113 @item -mlinked-fp
18114 @opindex mlinked-fp
18116 Follow the EABI requirement of always creating a frame pointer whenever
18117 a stack frame is allocated.  This option is enabled by default and can
18118 be disabled with @option{-mno-linked-fp}.
18120 @item -mlong-calls
18121 @opindex mlong-calls
18123 Use indirect addressing to call functions outside the current
18124 compilation unit.  This allows the functions to be placed anywhere
18125 within the 32-bit address space.
18127 @item -malign-labels
18128 @opindex malign-labels
18130 Try to align labels to an 8-byte boundary by inserting NOPs into the
18131 previous packet.  This option only has an effect when VLIW packing
18132 is enabled.  It doesn't create new packets; it merely adds NOPs to
18133 existing ones.
18135 @item -mlibrary-pic
18136 @opindex mlibrary-pic
18138 Generate position-independent EABI code.
18140 @item -macc-4
18141 @opindex macc-4
18143 Use only the first four media accumulator registers.
18145 @item -macc-8
18146 @opindex macc-8
18148 Use all eight media accumulator registers.
18150 @item -mpack
18151 @opindex mpack
18153 Pack VLIW instructions.
18155 @item -mno-pack
18156 @opindex mno-pack
18158 Do not pack VLIW instructions.
18160 @item -mno-eflags
18161 @opindex mno-eflags
18163 Do not mark ABI switches in e_flags.
18165 @item -mcond-move
18166 @opindex mcond-move
18168 Enable the use of conditional-move instructions (default).
18170 This switch is mainly for debugging the compiler and will likely be removed
18171 in a future version.
18173 @item -mno-cond-move
18174 @opindex mno-cond-move
18176 Disable the use of conditional-move instructions.
18178 This switch is mainly for debugging the compiler and will likely be removed
18179 in a future version.
18181 @item -mscc
18182 @opindex mscc
18184 Enable the use of conditional set instructions (default).
18186 This switch is mainly for debugging the compiler and will likely be removed
18187 in a future version.
18189 @item -mno-scc
18190 @opindex mno-scc
18192 Disable the use of conditional set instructions.
18194 This switch is mainly for debugging the compiler and will likely be removed
18195 in a future version.
18197 @item -mcond-exec
18198 @opindex mcond-exec
18200 Enable the use of conditional execution (default).
18202 This switch is mainly for debugging the compiler and will likely be removed
18203 in a future version.
18205 @item -mno-cond-exec
18206 @opindex mno-cond-exec
18208 Disable the use of conditional execution.
18210 This switch is mainly for debugging the compiler and will likely be removed
18211 in a future version.
18213 @item -mvliw-branch
18214 @opindex mvliw-branch
18216 Run a pass to pack branches into VLIW instructions (default).
18218 This switch is mainly for debugging the compiler and will likely be removed
18219 in a future version.
18221 @item -mno-vliw-branch
18222 @opindex mno-vliw-branch
18224 Do not run a pass to pack branches into VLIW instructions.
18226 This switch is mainly for debugging the compiler and will likely be removed
18227 in a future version.
18229 @item -mmulti-cond-exec
18230 @opindex mmulti-cond-exec
18232 Enable optimization of @code{&&} and @code{||} in conditional execution
18233 (default).
18235 This switch is mainly for debugging the compiler and will likely be removed
18236 in a future version.
18238 @item -mno-multi-cond-exec
18239 @opindex mno-multi-cond-exec
18241 Disable optimization of @code{&&} and @code{||} in conditional execution.
18243 This switch is mainly for debugging the compiler and will likely be removed
18244 in a future version.
18246 @item -mnested-cond-exec
18247 @opindex mnested-cond-exec
18249 Enable nested conditional execution optimizations (default).
18251 This switch is mainly for debugging the compiler and will likely be removed
18252 in a future version.
18254 @item -mno-nested-cond-exec
18255 @opindex mno-nested-cond-exec
18257 Disable nested conditional execution optimizations.
18259 This switch is mainly for debugging the compiler and will likely be removed
18260 in a future version.
18262 @item -moptimize-membar
18263 @opindex moptimize-membar
18265 This switch removes redundant @code{membar} instructions from the
18266 compiler-generated code.  It is enabled by default.
18268 @item -mno-optimize-membar
18269 @opindex mno-optimize-membar
18271 This switch disables the automatic removal of redundant @code{membar}
18272 instructions from the generated code.
18274 @item -mtomcat-stats
18275 @opindex mtomcat-stats
18277 Cause gas to print out tomcat statistics.
18279 @item -mcpu=@var{cpu}
18280 @opindex mcpu
18282 Select the processor type for which to generate code.  Possible values are
18283 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18284 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18286 @end table
18288 @node GNU/Linux Options
18289 @subsection GNU/Linux Options
18291 These @samp{-m} options are defined for GNU/Linux targets:
18293 @table @gcctabopt
18294 @item -mglibc
18295 @opindex mglibc
18296 Use the GNU C library.  This is the default except
18297 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18298 @samp{*-*-linux-*android*} targets.
18300 @item -muclibc
18301 @opindex muclibc
18302 Use uClibc C library.  This is the default on
18303 @samp{*-*-linux-*uclibc*} targets.
18305 @item -mmusl
18306 @opindex mmusl
18307 Use the musl C library.  This is the default on
18308 @samp{*-*-linux-*musl*} targets.
18310 @item -mbionic
18311 @opindex mbionic
18312 Use Bionic C library.  This is the default on
18313 @samp{*-*-linux-*android*} targets.
18315 @item -mandroid
18316 @opindex mandroid
18317 Compile code compatible with Android platform.  This is the default on
18318 @samp{*-*-linux-*android*} targets.
18320 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18321 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18322 this option makes the GCC driver pass Android-specific options to the linker.
18323 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18324 to be defined.
18326 @item -tno-android-cc
18327 @opindex tno-android-cc
18328 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18329 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18330 @option{-fno-rtti} by default.
18332 @item -tno-android-ld
18333 @opindex tno-android-ld
18334 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18335 linking options to the linker.
18337 @end table
18339 @node H8/300 Options
18340 @subsection H8/300 Options
18342 These @samp{-m} options are defined for the H8/300 implementations:
18344 @table @gcctabopt
18345 @item -mrelax
18346 @opindex mrelax
18347 Shorten some address references at link time, when possible; uses the
18348 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18349 ld, Using ld}, for a fuller description.
18351 @item -mh
18352 @opindex mh
18353 Generate code for the H8/300H@.
18355 @item -ms
18356 @opindex ms
18357 Generate code for the H8S@.
18359 @item -mn
18360 @opindex mn
18361 Generate code for the H8S and H8/300H in the normal mode.  This switch
18362 must be used either with @option{-mh} or @option{-ms}.
18364 @item -ms2600
18365 @opindex ms2600
18366 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18368 @item -mexr
18369 @opindex mexr
18370 Extended registers are stored on stack before execution of function
18371 with monitor attribute. Default option is @option{-mexr}.
18372 This option is valid only for H8S targets.
18374 @item -mno-exr
18375 @opindex mno-exr
18376 Extended registers are not stored on stack before execution of function 
18377 with monitor attribute. Default option is @option{-mno-exr}. 
18378 This option is valid only for H8S targets.
18380 @item -mint32
18381 @opindex mint32
18382 Make @code{int} data 32 bits by default.
18384 @item -malign-300
18385 @opindex malign-300
18386 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18387 The default for the H8/300H and H8S is to align longs and floats on
18388 4-byte boundaries.
18389 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18390 This option has no effect on the H8/300.
18391 @end table
18393 @node HPPA Options
18394 @subsection HPPA Options
18395 @cindex HPPA Options
18397 These @samp{-m} options are defined for the HPPA family of computers:
18399 @table @gcctabopt
18400 @item -march=@var{architecture-type}
18401 @opindex march
18402 Generate code for the specified architecture.  The choices for
18403 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18404 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18405 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18406 architecture option for your machine.  Code compiled for lower numbered
18407 architectures runs on higher numbered architectures, but not the
18408 other way around.
18410 @item -mpa-risc-1-0
18411 @itemx -mpa-risc-1-1
18412 @itemx -mpa-risc-2-0
18413 @opindex mpa-risc-1-0
18414 @opindex mpa-risc-1-1
18415 @opindex mpa-risc-2-0
18416 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18418 @item -mcaller-copies
18419 @opindex mcaller-copies
18420 The caller copies function arguments passed by hidden reference.  This
18421 option should be used with care as it is not compatible with the default
18422 32-bit runtime.  However, only aggregates larger than eight bytes are
18423 passed by hidden reference and the option provides better compatibility
18424 with OpenMP.
18426 @item -mjump-in-delay
18427 @opindex mjump-in-delay
18428 This option is ignored and provided for compatibility purposes only.
18430 @item -mdisable-fpregs
18431 @opindex mdisable-fpregs
18432 Prevent floating-point registers from being used in any manner.  This is
18433 necessary for compiling kernels that perform lazy context switching of
18434 floating-point registers.  If you use this option and attempt to perform
18435 floating-point operations, the compiler aborts.
18437 @item -mdisable-indexing
18438 @opindex mdisable-indexing
18439 Prevent the compiler from using indexing address modes.  This avoids some
18440 rather obscure problems when compiling MIG generated code under MACH@.
18442 @item -mno-space-regs
18443 @opindex mno-space-regs
18444 Generate code that assumes the target has no space registers.  This allows
18445 GCC to generate faster indirect calls and use unscaled index address modes.
18447 Such code is suitable for level 0 PA systems and kernels.
18449 @item -mfast-indirect-calls
18450 @opindex mfast-indirect-calls
18451 Generate code that assumes calls never cross space boundaries.  This
18452 allows GCC to emit code that performs faster indirect calls.
18454 This option does not work in the presence of shared libraries or nested
18455 functions.
18457 @item -mfixed-range=@var{register-range}
18458 @opindex mfixed-range
18459 Generate code treating the given register range as fixed registers.
18460 A fixed register is one that the register allocator cannot use.  This is
18461 useful when compiling kernel code.  A register range is specified as
18462 two registers separated by a dash.  Multiple register ranges can be
18463 specified separated by a comma.
18465 @item -mlong-load-store
18466 @opindex mlong-load-store
18467 Generate 3-instruction load and store sequences as sometimes required by
18468 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18469 the HP compilers.
18471 @item -mportable-runtime
18472 @opindex mportable-runtime
18473 Use the portable calling conventions proposed by HP for ELF systems.
18475 @item -mgas
18476 @opindex mgas
18477 Enable the use of assembler directives only GAS understands.
18479 @item -mschedule=@var{cpu-type}
18480 @opindex mschedule
18481 Schedule code according to the constraints for the machine type
18482 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18483 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18484 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18485 proper scheduling option for your machine.  The default scheduling is
18486 @samp{8000}.
18488 @item -mlinker-opt
18489 @opindex mlinker-opt
18490 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18491 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18492 linkers in which they give bogus error messages when linking some programs.
18494 @item -msoft-float
18495 @opindex msoft-float
18496 Generate output containing library calls for floating point.
18497 @strong{Warning:} the requisite libraries are not available for all HPPA
18498 targets.  Normally the facilities of the machine's usual C compiler are
18499 used, but this cannot be done directly in cross-compilation.  You must make
18500 your own arrangements to provide suitable library functions for
18501 cross-compilation.
18503 @option{-msoft-float} changes the calling convention in the output file;
18504 therefore, it is only useful if you compile @emph{all} of a program with
18505 this option.  In particular, you need to compile @file{libgcc.a}, the
18506 library that comes with GCC, with @option{-msoft-float} in order for
18507 this to work.
18509 @item -msio
18510 @opindex msio
18511 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18512 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18513 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18514 options are available under HP-UX and HI-UX@.
18516 @item -mgnu-ld
18517 @opindex mgnu-ld
18518 Use options specific to GNU @command{ld}.
18519 This passes @option{-shared} to @command{ld} when
18520 building a shared library.  It is the default when GCC is configured,
18521 explicitly or implicitly, with the GNU linker.  This option does not
18522 affect which @command{ld} is called; it only changes what parameters
18523 are passed to that @command{ld}.
18524 The @command{ld} that is called is determined by the
18525 @option{--with-ld} configure option, GCC's program search path, and
18526 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18527 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18528 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18530 @item -mhp-ld
18531 @opindex mhp-ld
18532 Use options specific to HP @command{ld}.
18533 This passes @option{-b} to @command{ld} when building
18534 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18535 links.  It is the default when GCC is configured, explicitly or
18536 implicitly, with the HP linker.  This option does not affect
18537 which @command{ld} is called; it only changes what parameters are passed to that
18538 @command{ld}.
18539 The @command{ld} that is called is determined by the @option{--with-ld}
18540 configure option, GCC's program search path, and finally by the user's
18541 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18542 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18543 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18545 @item -mlong-calls
18546 @opindex mno-long-calls
18547 Generate code that uses long call sequences.  This ensures that a call
18548 is always able to reach linker generated stubs.  The default is to generate
18549 long calls only when the distance from the call site to the beginning
18550 of the function or translation unit, as the case may be, exceeds a
18551 predefined limit set by the branch type being used.  The limits for
18552 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18553 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18554 240,000 bytes.
18556 Distances are measured from the beginning of functions when using the
18557 @option{-ffunction-sections} option, or when using the @option{-mgas}
18558 and @option{-mno-portable-runtime} options together under HP-UX with
18559 the SOM linker.
18561 It is normally not desirable to use this option as it degrades
18562 performance.  However, it may be useful in large applications,
18563 particularly when partial linking is used to build the application.
18565 The types of long calls used depends on the capabilities of the
18566 assembler and linker, and the type of code being generated.  The
18567 impact on systems that support long absolute calls, and long pic
18568 symbol-difference or pc-relative calls should be relatively small.
18569 However, an indirect call is used on 32-bit ELF systems in pic code
18570 and it is quite long.
18572 @item -munix=@var{unix-std}
18573 @opindex march
18574 Generate compiler predefines and select a startfile for the specified
18575 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18576 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18577 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18578 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18579 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18580 and later.
18582 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18583 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18584 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18585 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18586 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18587 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18589 It is @emph{important} to note that this option changes the interfaces
18590 for various library routines.  It also affects the operational behavior
18591 of the C library.  Thus, @emph{extreme} care is needed in using this
18592 option.
18594 Library code that is intended to operate with more than one UNIX
18595 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18596 as appropriate.  Most GNU software doesn't provide this capability.
18598 @item -nolibdld
18599 @opindex nolibdld
18600 Suppress the generation of link options to search libdld.sl when the
18601 @option{-static} option is specified on HP-UX 10 and later.
18603 @item -static
18604 @opindex static
18605 The HP-UX implementation of setlocale in libc has a dependency on
18606 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18607 when the @option{-static} option is specified, special link options
18608 are needed to resolve this dependency.
18610 On HP-UX 10 and later, the GCC driver adds the necessary options to
18611 link with libdld.sl when the @option{-static} option is specified.
18612 This causes the resulting binary to be dynamic.  On the 64-bit port,
18613 the linkers generate dynamic binaries by default in any case.  The
18614 @option{-nolibdld} option can be used to prevent the GCC driver from
18615 adding these link options.
18617 @item -threads
18618 @opindex threads
18619 Add support for multithreading with the @dfn{dce thread} library
18620 under HP-UX@.  This option sets flags for both the preprocessor and
18621 linker.
18622 @end table
18624 @node IA-64 Options
18625 @subsection IA-64 Options
18626 @cindex IA-64 Options
18628 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18630 @table @gcctabopt
18631 @item -mbig-endian
18632 @opindex mbig-endian
18633 Generate code for a big-endian target.  This is the default for HP-UX@.
18635 @item -mlittle-endian
18636 @opindex mlittle-endian
18637 Generate code for a little-endian target.  This is the default for AIX5
18638 and GNU/Linux.
18640 @item -mgnu-as
18641 @itemx -mno-gnu-as
18642 @opindex mgnu-as
18643 @opindex mno-gnu-as
18644 Generate (or don't) code for the GNU assembler.  This is the default.
18645 @c Also, this is the default if the configure option @option{--with-gnu-as}
18646 @c is used.
18648 @item -mgnu-ld
18649 @itemx -mno-gnu-ld
18650 @opindex mgnu-ld
18651 @opindex mno-gnu-ld
18652 Generate (or don't) code for the GNU linker.  This is the default.
18653 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18654 @c is used.
18656 @item -mno-pic
18657 @opindex mno-pic
18658 Generate code that does not use a global pointer register.  The result
18659 is not position independent code, and violates the IA-64 ABI@.
18661 @item -mvolatile-asm-stop
18662 @itemx -mno-volatile-asm-stop
18663 @opindex mvolatile-asm-stop
18664 @opindex mno-volatile-asm-stop
18665 Generate (or don't) a stop bit immediately before and after volatile asm
18666 statements.
18668 @item -mregister-names
18669 @itemx -mno-register-names
18670 @opindex mregister-names
18671 @opindex mno-register-names
18672 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18673 the stacked registers.  This may make assembler output more readable.
18675 @item -mno-sdata
18676 @itemx -msdata
18677 @opindex mno-sdata
18678 @opindex msdata
18679 Disable (or enable) optimizations that use the small data section.  This may
18680 be useful for working around optimizer bugs.
18682 @item -mconstant-gp
18683 @opindex mconstant-gp
18684 Generate code that uses a single constant global pointer value.  This is
18685 useful when compiling kernel code.
18687 @item -mauto-pic
18688 @opindex mauto-pic
18689 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18690 This is useful when compiling firmware code.
18692 @item -minline-float-divide-min-latency
18693 @opindex minline-float-divide-min-latency
18694 Generate code for inline divides of floating-point values
18695 using the minimum latency algorithm.
18697 @item -minline-float-divide-max-throughput
18698 @opindex minline-float-divide-max-throughput
18699 Generate code for inline divides of floating-point values
18700 using the maximum throughput algorithm.
18702 @item -mno-inline-float-divide
18703 @opindex mno-inline-float-divide
18704 Do not generate inline code for divides of floating-point values.
18706 @item -minline-int-divide-min-latency
18707 @opindex minline-int-divide-min-latency
18708 Generate code for inline divides of integer values
18709 using the minimum latency algorithm.
18711 @item -minline-int-divide-max-throughput
18712 @opindex minline-int-divide-max-throughput
18713 Generate code for inline divides of integer values
18714 using the maximum throughput algorithm.
18716 @item -mno-inline-int-divide
18717 @opindex mno-inline-int-divide
18718 Do not generate inline code for divides of integer values.
18720 @item -minline-sqrt-min-latency
18721 @opindex minline-sqrt-min-latency
18722 Generate code for inline square roots
18723 using the minimum latency algorithm.
18725 @item -minline-sqrt-max-throughput
18726 @opindex minline-sqrt-max-throughput
18727 Generate code for inline square roots
18728 using the maximum throughput algorithm.
18730 @item -mno-inline-sqrt
18731 @opindex mno-inline-sqrt
18732 Do not generate inline code for @code{sqrt}.
18734 @item -mfused-madd
18735 @itemx -mno-fused-madd
18736 @opindex mfused-madd
18737 @opindex mno-fused-madd
18738 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18739 instructions.  The default is to use these instructions.
18741 @item -mno-dwarf2-asm
18742 @itemx -mdwarf2-asm
18743 @opindex mno-dwarf2-asm
18744 @opindex mdwarf2-asm
18745 Don't (or do) generate assembler code for the DWARF line number debugging
18746 info.  This may be useful when not using the GNU assembler.
18748 @item -mearly-stop-bits
18749 @itemx -mno-early-stop-bits
18750 @opindex mearly-stop-bits
18751 @opindex mno-early-stop-bits
18752 Allow stop bits to be placed earlier than immediately preceding the
18753 instruction that triggered the stop bit.  This can improve instruction
18754 scheduling, but does not always do so.
18756 @item -mfixed-range=@var{register-range}
18757 @opindex mfixed-range
18758 Generate code treating the given register range as fixed registers.
18759 A fixed register is one that the register allocator cannot use.  This is
18760 useful when compiling kernel code.  A register range is specified as
18761 two registers separated by a dash.  Multiple register ranges can be
18762 specified separated by a comma.
18764 @item -mtls-size=@var{tls-size}
18765 @opindex mtls-size
18766 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18769 @item -mtune=@var{cpu-type}
18770 @opindex mtune
18771 Tune the instruction scheduling for a particular CPU, Valid values are
18772 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18773 and @samp{mckinley}.
18775 @item -milp32
18776 @itemx -mlp64
18777 @opindex milp32
18778 @opindex mlp64
18779 Generate code for a 32-bit or 64-bit environment.
18780 The 32-bit environment sets int, long and pointer to 32 bits.
18781 The 64-bit environment sets int to 32 bits and long and pointer
18782 to 64 bits.  These are HP-UX specific flags.
18784 @item -mno-sched-br-data-spec
18785 @itemx -msched-br-data-spec
18786 @opindex mno-sched-br-data-spec
18787 @opindex msched-br-data-spec
18788 (Dis/En)able data speculative scheduling before reload.
18789 This results in generation of @code{ld.a} instructions and
18790 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18791 The default setting is disabled.
18793 @item -msched-ar-data-spec
18794 @itemx -mno-sched-ar-data-spec
18795 @opindex msched-ar-data-spec
18796 @opindex mno-sched-ar-data-spec
18797 (En/Dis)able data speculative scheduling after reload.
18798 This results in generation of @code{ld.a} instructions and
18799 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18800 The default setting is enabled.
18802 @item -mno-sched-control-spec
18803 @itemx -msched-control-spec
18804 @opindex mno-sched-control-spec
18805 @opindex msched-control-spec
18806 (Dis/En)able control speculative scheduling.  This feature is
18807 available only during region scheduling (i.e.@: before reload).
18808 This results in generation of the @code{ld.s} instructions and
18809 the corresponding check instructions @code{chk.s}.
18810 The default setting is disabled.
18812 @item -msched-br-in-data-spec
18813 @itemx -mno-sched-br-in-data-spec
18814 @opindex msched-br-in-data-spec
18815 @opindex mno-sched-br-in-data-spec
18816 (En/Dis)able speculative scheduling of the instructions that
18817 are dependent on the data speculative loads before reload.
18818 This is effective only with @option{-msched-br-data-spec} enabled.
18819 The default setting is enabled.
18821 @item -msched-ar-in-data-spec
18822 @itemx -mno-sched-ar-in-data-spec
18823 @opindex msched-ar-in-data-spec
18824 @opindex mno-sched-ar-in-data-spec
18825 (En/Dis)able speculative scheduling of the instructions that
18826 are dependent on the data speculative loads after reload.
18827 This is effective only with @option{-msched-ar-data-spec} enabled.
18828 The default setting is enabled.
18830 @item -msched-in-control-spec
18831 @itemx -mno-sched-in-control-spec
18832 @opindex msched-in-control-spec
18833 @opindex mno-sched-in-control-spec
18834 (En/Dis)able speculative scheduling of the instructions that
18835 are dependent on the control speculative loads.
18836 This is effective only with @option{-msched-control-spec} enabled.
18837 The default setting is enabled.
18839 @item -mno-sched-prefer-non-data-spec-insns
18840 @itemx -msched-prefer-non-data-spec-insns
18841 @opindex mno-sched-prefer-non-data-spec-insns
18842 @opindex msched-prefer-non-data-spec-insns
18843 If enabled, data-speculative instructions are chosen for schedule
18844 only if there are no other choices at the moment.  This makes
18845 the use of the data speculation much more conservative.
18846 The default setting is disabled.
18848 @item -mno-sched-prefer-non-control-spec-insns
18849 @itemx -msched-prefer-non-control-spec-insns
18850 @opindex mno-sched-prefer-non-control-spec-insns
18851 @opindex msched-prefer-non-control-spec-insns
18852 If enabled, control-speculative instructions are chosen for schedule
18853 only if there are no other choices at the moment.  This makes
18854 the use of the control speculation much more conservative.
18855 The default setting is disabled.
18857 @item -mno-sched-count-spec-in-critical-path
18858 @itemx -msched-count-spec-in-critical-path
18859 @opindex mno-sched-count-spec-in-critical-path
18860 @opindex msched-count-spec-in-critical-path
18861 If enabled, speculative dependencies are considered during
18862 computation of the instructions priorities.  This makes the use of the
18863 speculation a bit more conservative.
18864 The default setting is disabled.
18866 @item -msched-spec-ldc
18867 @opindex msched-spec-ldc
18868 Use a simple data speculation check.  This option is on by default.
18870 @item -msched-control-spec-ldc
18871 @opindex msched-spec-ldc
18872 Use a simple check for control speculation.  This option is on by default.
18874 @item -msched-stop-bits-after-every-cycle
18875 @opindex msched-stop-bits-after-every-cycle
18876 Place a stop bit after every cycle when scheduling.  This option is on
18877 by default.
18879 @item -msched-fp-mem-deps-zero-cost
18880 @opindex msched-fp-mem-deps-zero-cost
18881 Assume that floating-point stores and loads are not likely to cause a conflict
18882 when placed into the same instruction group.  This option is disabled by
18883 default.
18885 @item -msel-sched-dont-check-control-spec
18886 @opindex msel-sched-dont-check-control-spec
18887 Generate checks for control speculation in selective scheduling.
18888 This flag is disabled by default.
18890 @item -msched-max-memory-insns=@var{max-insns}
18891 @opindex msched-max-memory-insns
18892 Limit on the number of memory insns per instruction group, giving lower
18893 priority to subsequent memory insns attempting to schedule in the same
18894 instruction group. Frequently useful to prevent cache bank conflicts.
18895 The default value is 1.
18897 @item -msched-max-memory-insns-hard-limit
18898 @opindex msched-max-memory-insns-hard-limit
18899 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18900 disallowing more than that number in an instruction group.
18901 Otherwise, the limit is ``soft'', meaning that non-memory operations
18902 are preferred when the limit is reached, but memory operations may still
18903 be scheduled.
18905 @end table
18907 @node LM32 Options
18908 @subsection LM32 Options
18909 @cindex LM32 options
18911 These @option{-m} options are defined for the LatticeMico32 architecture:
18913 @table @gcctabopt
18914 @item -mbarrel-shift-enabled
18915 @opindex mbarrel-shift-enabled
18916 Enable barrel-shift instructions.
18918 @item -mdivide-enabled
18919 @opindex mdivide-enabled
18920 Enable divide and modulus instructions.
18922 @item -mmultiply-enabled
18923 @opindex multiply-enabled
18924 Enable multiply instructions.
18926 @item -msign-extend-enabled
18927 @opindex msign-extend-enabled
18928 Enable sign extend instructions.
18930 @item -muser-enabled
18931 @opindex muser-enabled
18932 Enable user-defined instructions.
18934 @end table
18936 @node M32C Options
18937 @subsection M32C Options
18938 @cindex M32C options
18940 @table @gcctabopt
18941 @item -mcpu=@var{name}
18942 @opindex mcpu=
18943 Select the CPU for which code is generated.  @var{name} may be one of
18944 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18945 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18946 the M32C/80 series.
18948 @item -msim
18949 @opindex msim
18950 Specifies that the program will be run on the simulator.  This causes
18951 an alternate runtime library to be linked in which supports, for
18952 example, file I/O@.  You must not use this option when generating
18953 programs that will run on real hardware; you must provide your own
18954 runtime library for whatever I/O functions are needed.
18956 @item -memregs=@var{number}
18957 @opindex memregs=
18958 Specifies the number of memory-based pseudo-registers GCC uses
18959 during code generation.  These pseudo-registers are used like real
18960 registers, so there is a tradeoff between GCC's ability to fit the
18961 code into available registers, and the performance penalty of using
18962 memory instead of registers.  Note that all modules in a program must
18963 be compiled with the same value for this option.  Because of that, you
18964 must not use this option with GCC's default runtime libraries.
18966 @end table
18968 @node M32R/D Options
18969 @subsection M32R/D Options
18970 @cindex M32R/D options
18972 These @option{-m} options are defined for Renesas M32R/D architectures:
18974 @table @gcctabopt
18975 @item -m32r2
18976 @opindex m32r2
18977 Generate code for the M32R/2@.
18979 @item -m32rx
18980 @opindex m32rx
18981 Generate code for the M32R/X@.
18983 @item -m32r
18984 @opindex m32r
18985 Generate code for the M32R@.  This is the default.
18987 @item -mmodel=small
18988 @opindex mmodel=small
18989 Assume all objects live in the lower 16MB of memory (so that their addresses
18990 can be loaded with the @code{ld24} instruction), and assume all subroutines
18991 are reachable with the @code{bl} instruction.
18992 This is the default.
18994 The addressability of a particular object can be set with the
18995 @code{model} attribute.
18997 @item -mmodel=medium
18998 @opindex mmodel=medium
18999 Assume objects may be anywhere in the 32-bit address space (the compiler
19000 generates @code{seth/add3} instructions to load their addresses), and
19001 assume all subroutines are reachable with the @code{bl} instruction.
19003 @item -mmodel=large
19004 @opindex mmodel=large
19005 Assume objects may be anywhere in the 32-bit address space (the compiler
19006 generates @code{seth/add3} instructions to load their addresses), and
19007 assume subroutines may not be reachable with the @code{bl} instruction
19008 (the compiler generates the much slower @code{seth/add3/jl}
19009 instruction sequence).
19011 @item -msdata=none
19012 @opindex msdata=none
19013 Disable use of the small data area.  Variables are put into
19014 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19015 @code{section} attribute has been specified).
19016 This is the default.
19018 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19019 Objects may be explicitly put in the small data area with the
19020 @code{section} attribute using one of these sections.
19022 @item -msdata=sdata
19023 @opindex msdata=sdata
19024 Put small global and static data in the small data area, but do not
19025 generate special code to reference them.
19027 @item -msdata=use
19028 @opindex msdata=use
19029 Put small global and static data in the small data area, and generate
19030 special instructions to reference them.
19032 @item -G @var{num}
19033 @opindex G
19034 @cindex smaller data references
19035 Put global and static objects less than or equal to @var{num} bytes
19036 into the small data or BSS sections instead of the normal data or BSS
19037 sections.  The default value of @var{num} is 8.
19038 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19039 for this option to have any effect.
19041 All modules should be compiled with the same @option{-G @var{num}} value.
19042 Compiling with different values of @var{num} may or may not work; if it
19043 doesn't the linker gives an error message---incorrect code is not
19044 generated.
19046 @item -mdebug
19047 @opindex mdebug
19048 Makes the M32R-specific code in the compiler display some statistics
19049 that might help in debugging programs.
19051 @item -malign-loops
19052 @opindex malign-loops
19053 Align all loops to a 32-byte boundary.
19055 @item -mno-align-loops
19056 @opindex mno-align-loops
19057 Do not enforce a 32-byte alignment for loops.  This is the default.
19059 @item -missue-rate=@var{number}
19060 @opindex missue-rate=@var{number}
19061 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19062 or 2.
19064 @item -mbranch-cost=@var{number}
19065 @opindex mbranch-cost=@var{number}
19066 @var{number} can only be 1 or 2.  If it is 1 then branches are
19067 preferred over conditional code, if it is 2, then the opposite applies.
19069 @item -mflush-trap=@var{number}
19070 @opindex mflush-trap=@var{number}
19071 Specifies the trap number to use to flush the cache.  The default is
19072 12.  Valid numbers are between 0 and 15 inclusive.
19074 @item -mno-flush-trap
19075 @opindex mno-flush-trap
19076 Specifies that the cache cannot be flushed by using a trap.
19078 @item -mflush-func=@var{name}
19079 @opindex mflush-func=@var{name}
19080 Specifies the name of the operating system function to call to flush
19081 the cache.  The default is @samp{_flush_cache}, but a function call
19082 is only used if a trap is not available.
19084 @item -mno-flush-func
19085 @opindex mno-flush-func
19086 Indicates that there is no OS function for flushing the cache.
19088 @end table
19090 @node M680x0 Options
19091 @subsection M680x0 Options
19092 @cindex M680x0 options
19094 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19095 The default settings depend on which architecture was selected when
19096 the compiler was configured; the defaults for the most common choices
19097 are given below.
19099 @table @gcctabopt
19100 @item -march=@var{arch}
19101 @opindex march
19102 Generate code for a specific M680x0 or ColdFire instruction set
19103 architecture.  Permissible values of @var{arch} for M680x0
19104 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19105 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19106 architectures are selected according to Freescale's ISA classification
19107 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19108 @samp{isab} and @samp{isac}.
19110 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19111 code for a ColdFire target.  The @var{arch} in this macro is one of the
19112 @option{-march} arguments given above.
19114 When used together, @option{-march} and @option{-mtune} select code
19115 that runs on a family of similar processors but that is optimized
19116 for a particular microarchitecture.
19118 @item -mcpu=@var{cpu}
19119 @opindex mcpu
19120 Generate code for a specific M680x0 or ColdFire processor.
19121 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19122 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19123 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19124 below, which also classifies the CPUs into families:
19126 @multitable @columnfractions 0.20 0.80
19127 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19128 @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}
19129 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19130 @item @samp{5206e} @tab @samp{5206e}
19131 @item @samp{5208} @tab @samp{5207} @samp{5208}
19132 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19133 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19134 @item @samp{5216} @tab @samp{5214} @samp{5216}
19135 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19136 @item @samp{5225} @tab @samp{5224} @samp{5225}
19137 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19138 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19139 @item @samp{5249} @tab @samp{5249}
19140 @item @samp{5250} @tab @samp{5250}
19141 @item @samp{5271} @tab @samp{5270} @samp{5271}
19142 @item @samp{5272} @tab @samp{5272}
19143 @item @samp{5275} @tab @samp{5274} @samp{5275}
19144 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19145 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19146 @item @samp{5307} @tab @samp{5307}
19147 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19148 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19149 @item @samp{5407} @tab @samp{5407}
19150 @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}
19151 @end multitable
19153 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19154 @var{arch} is compatible with @var{cpu}.  Other combinations of
19155 @option{-mcpu} and @option{-march} are rejected.
19157 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19158 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19159 where the value of @var{family} is given by the table above.
19161 @item -mtune=@var{tune}
19162 @opindex mtune
19163 Tune the code for a particular microarchitecture within the
19164 constraints set by @option{-march} and @option{-mcpu}.
19165 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19166 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19167 and @samp{cpu32}.  The ColdFire microarchitectures
19168 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19170 You can also use @option{-mtune=68020-40} for code that needs
19171 to run relatively well on 68020, 68030 and 68040 targets.
19172 @option{-mtune=68020-60} is similar but includes 68060 targets
19173 as well.  These two options select the same tuning decisions as
19174 @option{-m68020-40} and @option{-m68020-60} respectively.
19176 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19177 when tuning for 680x0 architecture @var{arch}.  It also defines
19178 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19179 option is used.  If GCC is tuning for a range of architectures,
19180 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19181 it defines the macros for every architecture in the range.
19183 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19184 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19185 of the arguments given above.
19187 @item -m68000
19188 @itemx -mc68000
19189 @opindex m68000
19190 @opindex mc68000
19191 Generate output for a 68000.  This is the default
19192 when the compiler is configured for 68000-based systems.
19193 It is equivalent to @option{-march=68000}.
19195 Use this option for microcontrollers with a 68000 or EC000 core,
19196 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19198 @item -m68010
19199 @opindex m68010
19200 Generate output for a 68010.  This is the default
19201 when the compiler is configured for 68010-based systems.
19202 It is equivalent to @option{-march=68010}.
19204 @item -m68020
19205 @itemx -mc68020
19206 @opindex m68020
19207 @opindex mc68020
19208 Generate output for a 68020.  This is the default
19209 when the compiler is configured for 68020-based systems.
19210 It is equivalent to @option{-march=68020}.
19212 @item -m68030
19213 @opindex m68030
19214 Generate output for a 68030.  This is the default when the compiler is
19215 configured for 68030-based systems.  It is equivalent to
19216 @option{-march=68030}.
19218 @item -m68040
19219 @opindex m68040
19220 Generate output for a 68040.  This is the default when the compiler is
19221 configured for 68040-based systems.  It is equivalent to
19222 @option{-march=68040}.
19224 This option inhibits the use of 68881/68882 instructions that have to be
19225 emulated by software on the 68040.  Use this option if your 68040 does not
19226 have code to emulate those instructions.
19228 @item -m68060
19229 @opindex m68060
19230 Generate output for a 68060.  This is the default when the compiler is
19231 configured for 68060-based systems.  It is equivalent to
19232 @option{-march=68060}.
19234 This option inhibits the use of 68020 and 68881/68882 instructions that
19235 have to be emulated by software on the 68060.  Use this option if your 68060
19236 does not have code to emulate those instructions.
19238 @item -mcpu32
19239 @opindex mcpu32
19240 Generate output for a CPU32.  This is the default
19241 when the compiler is configured for CPU32-based systems.
19242 It is equivalent to @option{-march=cpu32}.
19244 Use this option for microcontrollers with a
19245 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19246 68336, 68340, 68341, 68349 and 68360.
19248 @item -m5200
19249 @opindex m5200
19250 Generate output for a 520X ColdFire CPU@.  This is the default
19251 when the compiler is configured for 520X-based systems.
19252 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19253 in favor of that option.
19255 Use this option for microcontroller with a 5200 core, including
19256 the MCF5202, MCF5203, MCF5204 and MCF5206.
19258 @item -m5206e
19259 @opindex m5206e
19260 Generate output for a 5206e ColdFire CPU@.  The option is now
19261 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19263 @item -m528x
19264 @opindex m528x
19265 Generate output for a member of the ColdFire 528X family.
19266 The option is now deprecated in favor of the equivalent
19267 @option{-mcpu=528x}.
19269 @item -m5307
19270 @opindex m5307
19271 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19272 in favor of the equivalent @option{-mcpu=5307}.
19274 @item -m5407
19275 @opindex m5407
19276 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19277 in favor of the equivalent @option{-mcpu=5407}.
19279 @item -mcfv4e
19280 @opindex mcfv4e
19281 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19282 This includes use of hardware floating-point instructions.
19283 The option is equivalent to @option{-mcpu=547x}, and is now
19284 deprecated in favor of that option.
19286 @item -m68020-40
19287 @opindex m68020-40
19288 Generate output for a 68040, without using any of the new instructions.
19289 This results in code that can run relatively efficiently on either a
19290 68020/68881 or a 68030 or a 68040.  The generated code does use the
19291 68881 instructions that are emulated on the 68040.
19293 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19295 @item -m68020-60
19296 @opindex m68020-60
19297 Generate output for a 68060, without using any of the new instructions.
19298 This results in code that can run relatively efficiently on either a
19299 68020/68881 or a 68030 or a 68040.  The generated code does use the
19300 68881 instructions that are emulated on the 68060.
19302 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19304 @item -mhard-float
19305 @itemx -m68881
19306 @opindex mhard-float
19307 @opindex m68881
19308 Generate floating-point instructions.  This is the default for 68020
19309 and above, and for ColdFire devices that have an FPU@.  It defines the
19310 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19311 on ColdFire targets.
19313 @item -msoft-float
19314 @opindex msoft-float
19315 Do not generate floating-point instructions; use library calls instead.
19316 This is the default for 68000, 68010, and 68832 targets.  It is also
19317 the default for ColdFire devices that have no FPU.
19319 @item -mdiv
19320 @itemx -mno-div
19321 @opindex mdiv
19322 @opindex mno-div
19323 Generate (do not generate) ColdFire hardware divide and remainder
19324 instructions.  If @option{-march} is used without @option{-mcpu},
19325 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19326 architectures.  Otherwise, the default is taken from the target CPU
19327 (either the default CPU, or the one specified by @option{-mcpu}).  For
19328 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19329 @option{-mcpu=5206e}.
19331 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19333 @item -mshort
19334 @opindex mshort
19335 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19336 Additionally, parameters passed on the stack are also aligned to a
19337 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19339 @item -mno-short
19340 @opindex mno-short
19341 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19343 @item -mnobitfield
19344 @itemx -mno-bitfield
19345 @opindex mnobitfield
19346 @opindex mno-bitfield
19347 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19348 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19350 @item -mbitfield
19351 @opindex mbitfield
19352 Do use the bit-field instructions.  The @option{-m68020} option implies
19353 @option{-mbitfield}.  This is the default if you use a configuration
19354 designed for a 68020.
19356 @item -mrtd
19357 @opindex mrtd
19358 Use a different function-calling convention, in which functions
19359 that take a fixed number of arguments return with the @code{rtd}
19360 instruction, which pops their arguments while returning.  This
19361 saves one instruction in the caller since there is no need to pop
19362 the arguments there.
19364 This calling convention is incompatible with the one normally
19365 used on Unix, so you cannot use it if you need to call libraries
19366 compiled with the Unix compiler.
19368 Also, you must provide function prototypes for all functions that
19369 take variable numbers of arguments (including @code{printf});
19370 otherwise incorrect code is generated for calls to those
19371 functions.
19373 In addition, seriously incorrect code results if you call a
19374 function with too many arguments.  (Normally, extra arguments are
19375 harmlessly ignored.)
19377 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19378 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19380 @item -mno-rtd
19381 @opindex mno-rtd
19382 Do not use the calling conventions selected by @option{-mrtd}.
19383 This is the default.
19385 @item -malign-int
19386 @itemx -mno-align-int
19387 @opindex malign-int
19388 @opindex mno-align-int
19389 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19390 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19391 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19392 Aligning variables on 32-bit boundaries produces code that runs somewhat
19393 faster on processors with 32-bit busses at the expense of more memory.
19395 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19396 aligns structures containing the above types differently than
19397 most published application binary interface specifications for the m68k.
19399 @item -mpcrel
19400 @opindex mpcrel
19401 Use the pc-relative addressing mode of the 68000 directly, instead of
19402 using a global offset table.  At present, this option implies @option{-fpic},
19403 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19404 not presently supported with @option{-mpcrel}, though this could be supported for
19405 68020 and higher processors.
19407 @item -mno-strict-align
19408 @itemx -mstrict-align
19409 @opindex mno-strict-align
19410 @opindex mstrict-align
19411 Do not (do) assume that unaligned memory references are handled by
19412 the system.
19414 @item -msep-data
19415 Generate code that allows the data segment to be located in a different
19416 area of memory from the text segment.  This allows for execute-in-place in
19417 an environment without virtual memory management.  This option implies
19418 @option{-fPIC}.
19420 @item -mno-sep-data
19421 Generate code that assumes that the data segment follows the text segment.
19422 This is the default.
19424 @item -mid-shared-library
19425 Generate code that supports shared libraries via the library ID method.
19426 This allows for execute-in-place and shared libraries in an environment
19427 without virtual memory management.  This option implies @option{-fPIC}.
19429 @item -mno-id-shared-library
19430 Generate code that doesn't assume ID-based shared libraries are being used.
19431 This is the default.
19433 @item -mshared-library-id=n
19434 Specifies the identification number of the ID-based shared library being
19435 compiled.  Specifying a value of 0 generates more compact code; specifying
19436 other values forces the allocation of that number to the current
19437 library, but is no more space- or time-efficient than omitting this option.
19439 @item -mxgot
19440 @itemx -mno-xgot
19441 @opindex mxgot
19442 @opindex mno-xgot
19443 When generating position-independent code for ColdFire, generate code
19444 that works if the GOT has more than 8192 entries.  This code is
19445 larger and slower than code generated without this option.  On M680x0
19446 processors, this option is not needed; @option{-fPIC} suffices.
19448 GCC normally uses a single instruction to load values from the GOT@.
19449 While this is relatively efficient, it only works if the GOT
19450 is smaller than about 64k.  Anything larger causes the linker
19451 to report an error such as:
19453 @cindex relocation truncated to fit (ColdFire)
19454 @smallexample
19455 relocation truncated to fit: R_68K_GOT16O foobar
19456 @end smallexample
19458 If this happens, you should recompile your code with @option{-mxgot}.
19459 It should then work with very large GOTs.  However, code generated with
19460 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19461 the value of a global symbol.
19463 Note that some linkers, including newer versions of the GNU linker,
19464 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19465 you should only need to use @option{-mxgot} when compiling a single
19466 object file that accesses more than 8192 GOT entries.  Very few do.
19468 These options have no effect unless GCC is generating
19469 position-independent code.
19471 @item -mlong-jump-table-offsets
19472 @opindex mlong-jump-table-offsets
19473 Use 32-bit offsets in @code{switch} tables.  The default is to use
19474 16-bit offsets.
19476 @end table
19478 @node MCore Options
19479 @subsection MCore Options
19480 @cindex MCore options
19482 These are the @samp{-m} options defined for the Motorola M*Core
19483 processors.
19485 @table @gcctabopt
19487 @item -mhardlit
19488 @itemx -mno-hardlit
19489 @opindex mhardlit
19490 @opindex mno-hardlit
19491 Inline constants into the code stream if it can be done in two
19492 instructions or less.
19494 @item -mdiv
19495 @itemx -mno-div
19496 @opindex mdiv
19497 @opindex mno-div
19498 Use the divide instruction.  (Enabled by default).
19500 @item -mrelax-immediate
19501 @itemx -mno-relax-immediate
19502 @opindex mrelax-immediate
19503 @opindex mno-relax-immediate
19504 Allow arbitrary-sized immediates in bit operations.
19506 @item -mwide-bitfields
19507 @itemx -mno-wide-bitfields
19508 @opindex mwide-bitfields
19509 @opindex mno-wide-bitfields
19510 Always treat bit-fields as @code{int}-sized.
19512 @item -m4byte-functions
19513 @itemx -mno-4byte-functions
19514 @opindex m4byte-functions
19515 @opindex mno-4byte-functions
19516 Force all functions to be aligned to a 4-byte boundary.
19518 @item -mcallgraph-data
19519 @itemx -mno-callgraph-data
19520 @opindex mcallgraph-data
19521 @opindex mno-callgraph-data
19522 Emit callgraph information.
19524 @item -mslow-bytes
19525 @itemx -mno-slow-bytes
19526 @opindex mslow-bytes
19527 @opindex mno-slow-bytes
19528 Prefer word access when reading byte quantities.
19530 @item -mlittle-endian
19531 @itemx -mbig-endian
19532 @opindex mlittle-endian
19533 @opindex mbig-endian
19534 Generate code for a little-endian target.
19536 @item -m210
19537 @itemx -m340
19538 @opindex m210
19539 @opindex m340
19540 Generate code for the 210 processor.
19542 @item -mno-lsim
19543 @opindex mno-lsim
19544 Assume that runtime support has been provided and so omit the
19545 simulator library (@file{libsim.a)} from the linker command line.
19547 @item -mstack-increment=@var{size}
19548 @opindex mstack-increment
19549 Set the maximum amount for a single stack increment operation.  Large
19550 values can increase the speed of programs that contain functions
19551 that need a large amount of stack space, but they can also trigger a
19552 segmentation fault if the stack is extended too much.  The default
19553 value is 0x1000.
19555 @end table
19557 @node MeP Options
19558 @subsection MeP Options
19559 @cindex MeP options
19561 @table @gcctabopt
19563 @item -mabsdiff
19564 @opindex mabsdiff
19565 Enables the @code{abs} instruction, which is the absolute difference
19566 between two registers.
19568 @item -mall-opts
19569 @opindex mall-opts
19570 Enables all the optional instructions---average, multiply, divide, bit
19571 operations, leading zero, absolute difference, min/max, clip, and
19572 saturation.
19575 @item -maverage
19576 @opindex maverage
19577 Enables the @code{ave} instruction, which computes the average of two
19578 registers.
19580 @item -mbased=@var{n}
19581 @opindex mbased=
19582 Variables of size @var{n} bytes or smaller are placed in the
19583 @code{.based} section by default.  Based variables use the @code{$tp}
19584 register as a base register, and there is a 128-byte limit to the
19585 @code{.based} section.
19587 @item -mbitops
19588 @opindex mbitops
19589 Enables the bit operation instructions---bit test (@code{btstm}), set
19590 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19591 test-and-set (@code{tas}).
19593 @item -mc=@var{name}
19594 @opindex mc=
19595 Selects which section constant data is placed in.  @var{name} may
19596 be @samp{tiny}, @samp{near}, or @samp{far}.
19598 @item -mclip
19599 @opindex mclip
19600 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19601 useful unless you also provide @option{-mminmax}.
19603 @item -mconfig=@var{name}
19604 @opindex mconfig=
19605 Selects one of the built-in core configurations.  Each MeP chip has
19606 one or more modules in it; each module has a core CPU and a variety of
19607 coprocessors, optional instructions, and peripherals.  The
19608 @code{MeP-Integrator} tool, not part of GCC, provides these
19609 configurations through this option; using this option is the same as
19610 using all the corresponding command-line options.  The default
19611 configuration is @samp{default}.
19613 @item -mcop
19614 @opindex mcop
19615 Enables the coprocessor instructions.  By default, this is a 32-bit
19616 coprocessor.  Note that the coprocessor is normally enabled via the
19617 @option{-mconfig=} option.
19619 @item -mcop32
19620 @opindex mcop32
19621 Enables the 32-bit coprocessor's instructions.
19623 @item -mcop64
19624 @opindex mcop64
19625 Enables the 64-bit coprocessor's instructions.
19627 @item -mivc2
19628 @opindex mivc2
19629 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19631 @item -mdc
19632 @opindex mdc
19633 Causes constant variables to be placed in the @code{.near} section.
19635 @item -mdiv
19636 @opindex mdiv
19637 Enables the @code{div} and @code{divu} instructions.
19639 @item -meb
19640 @opindex meb
19641 Generate big-endian code.
19643 @item -mel
19644 @opindex mel
19645 Generate little-endian code.
19647 @item -mio-volatile
19648 @opindex mio-volatile
19649 Tells the compiler that any variable marked with the @code{io}
19650 attribute is to be considered volatile.
19652 @item -ml
19653 @opindex ml
19654 Causes variables to be assigned to the @code{.far} section by default.
19656 @item -mleadz
19657 @opindex mleadz
19658 Enables the @code{leadz} (leading zero) instruction.
19660 @item -mm
19661 @opindex mm
19662 Causes variables to be assigned to the @code{.near} section by default.
19664 @item -mminmax
19665 @opindex mminmax
19666 Enables the @code{min} and @code{max} instructions.
19668 @item -mmult
19669 @opindex mmult
19670 Enables the multiplication and multiply-accumulate instructions.
19672 @item -mno-opts
19673 @opindex mno-opts
19674 Disables all the optional instructions enabled by @option{-mall-opts}.
19676 @item -mrepeat
19677 @opindex mrepeat
19678 Enables the @code{repeat} and @code{erepeat} instructions, used for
19679 low-overhead looping.
19681 @item -ms
19682 @opindex ms
19683 Causes all variables to default to the @code{.tiny} section.  Note
19684 that there is a 65536-byte limit to this section.  Accesses to these
19685 variables use the @code{%gp} base register.
19687 @item -msatur
19688 @opindex msatur
19689 Enables the saturation instructions.  Note that the compiler does not
19690 currently generate these itself, but this option is included for
19691 compatibility with other tools, like @code{as}.
19693 @item -msdram
19694 @opindex msdram
19695 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19697 @item -msim
19698 @opindex msim
19699 Link the simulator run-time libraries.
19701 @item -msimnovec
19702 @opindex msimnovec
19703 Link the simulator runtime libraries, excluding built-in support
19704 for reset and exception vectors and tables.
19706 @item -mtf
19707 @opindex mtf
19708 Causes all functions to default to the @code{.far} section.  Without
19709 this option, functions default to the @code{.near} section.
19711 @item -mtiny=@var{n}
19712 @opindex mtiny=
19713 Variables that are @var{n} bytes or smaller are allocated to the
19714 @code{.tiny} section.  These variables use the @code{$gp} base
19715 register.  The default for this option is 4, but note that there's a
19716 65536-byte limit to the @code{.tiny} section.
19718 @end table
19720 @node MicroBlaze Options
19721 @subsection MicroBlaze Options
19722 @cindex MicroBlaze Options
19724 @table @gcctabopt
19726 @item -msoft-float
19727 @opindex msoft-float
19728 Use software emulation for floating point (default).
19730 @item -mhard-float
19731 @opindex mhard-float
19732 Use hardware floating-point instructions.
19734 @item -mmemcpy
19735 @opindex mmemcpy
19736 Do not optimize block moves, use @code{memcpy}.
19738 @item -mno-clearbss
19739 @opindex mno-clearbss
19740 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19742 @item -mcpu=@var{cpu-type}
19743 @opindex mcpu=
19744 Use features of, and schedule code for, the given CPU.
19745 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19746 where @var{X} is a major version, @var{YY} is the minor version, and
19747 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19748 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19750 @item -mxl-soft-mul
19751 @opindex mxl-soft-mul
19752 Use software multiply emulation (default).
19754 @item -mxl-soft-div
19755 @opindex mxl-soft-div
19756 Use software emulation for divides (default).
19758 @item -mxl-barrel-shift
19759 @opindex mxl-barrel-shift
19760 Use the hardware barrel shifter.
19762 @item -mxl-pattern-compare
19763 @opindex mxl-pattern-compare
19764 Use pattern compare instructions.
19766 @item -msmall-divides
19767 @opindex msmall-divides
19768 Use table lookup optimization for small signed integer divisions.
19770 @item -mxl-stack-check
19771 @opindex mxl-stack-check
19772 This option is deprecated.  Use @option{-fstack-check} instead.
19774 @item -mxl-gp-opt
19775 @opindex mxl-gp-opt
19776 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19778 @item -mxl-multiply-high
19779 @opindex mxl-multiply-high
19780 Use multiply high instructions for high part of 32x32 multiply.
19782 @item -mxl-float-convert
19783 @opindex mxl-float-convert
19784 Use hardware floating-point conversion instructions.
19786 @item -mxl-float-sqrt
19787 @opindex mxl-float-sqrt
19788 Use hardware floating-point square root instruction.
19790 @item -mbig-endian
19791 @opindex mbig-endian
19792 Generate code for a big-endian target.
19794 @item -mlittle-endian
19795 @opindex mlittle-endian
19796 Generate code for a little-endian target.
19798 @item -mxl-reorder
19799 @opindex mxl-reorder
19800 Use reorder instructions (swap and byte reversed load/store).
19802 @item -mxl-mode-@var{app-model}
19803 Select application model @var{app-model}.  Valid models are
19804 @table @samp
19805 @item executable
19806 normal executable (default), uses startup code @file{crt0.o}.
19808 @item xmdstub
19809 for use with Xilinx Microprocessor Debugger (XMD) based
19810 software intrusive debug agent called xmdstub. This uses startup file
19811 @file{crt1.o} and sets the start address of the program to 0x800.
19813 @item bootstrap
19814 for applications that are loaded using a bootloader.
19815 This model uses startup file @file{crt2.o} which does not contain a processor
19816 reset vector handler. This is suitable for transferring control on a
19817 processor reset to the bootloader rather than the application.
19819 @item novectors
19820 for applications that do not require any of the
19821 MicroBlaze vectors. This option may be useful for applications running
19822 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19823 @end table
19825 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19826 @option{-mxl-mode-@var{app-model}}.
19828 @end table
19830 @node MIPS Options
19831 @subsection MIPS Options
19832 @cindex MIPS options
19834 @table @gcctabopt
19836 @item -EB
19837 @opindex EB
19838 Generate big-endian code.
19840 @item -EL
19841 @opindex EL
19842 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19843 configurations.
19845 @item -march=@var{arch}
19846 @opindex march
19847 Generate code that runs on @var{arch}, which can be the name of a
19848 generic MIPS ISA, or the name of a particular processor.
19849 The ISA names are:
19850 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19851 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19852 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19853 @samp{mips64r5} and @samp{mips64r6}.
19854 The processor names are:
19855 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19856 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19857 @samp{5kc}, @samp{5kf},
19858 @samp{20kc},
19859 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19860 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19861 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19862 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19863 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19864 @samp{i6400},
19865 @samp{interaptiv},
19866 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19867 @samp{m4k},
19868 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19869 @samp{m5100}, @samp{m5101},
19870 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19871 @samp{orion},
19872 @samp{p5600},
19873 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19874 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19875 @samp{rm7000}, @samp{rm9000},
19876 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19877 @samp{sb1},
19878 @samp{sr71000},
19879 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19880 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19881 @samp{xlr} and @samp{xlp}.
19882 The special value @samp{from-abi} selects the
19883 most compatible architecture for the selected ABI (that is,
19884 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19886 The native Linux/GNU toolchain also supports the value @samp{native},
19887 which selects the best architecture option for the host processor.
19888 @option{-march=native} has no effect if GCC does not recognize
19889 the processor.
19891 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19892 (for example, @option{-march=r2k}).  Prefixes are optional, and
19893 @samp{vr} may be written @samp{r}.
19895 Names of the form @samp{@var{n}f2_1} refer to processors with
19896 FPUs clocked at half the rate of the core, names of the form
19897 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19898 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19899 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19900 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19901 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19902 accepted as synonyms for @samp{@var{n}f1_1}.
19904 GCC defines two macros based on the value of this option.  The first
19905 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19906 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19907 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19908 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19909 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19911 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19912 above.  In other words, it has the full prefix and does not
19913 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19914 the macro names the resolved architecture (either @code{"mips1"} or
19915 @code{"mips3"}).  It names the default architecture when no
19916 @option{-march} option is given.
19918 @item -mtune=@var{arch}
19919 @opindex mtune
19920 Optimize for @var{arch}.  Among other things, this option controls
19921 the way instructions are scheduled, and the perceived cost of arithmetic
19922 operations.  The list of @var{arch} values is the same as for
19923 @option{-march}.
19925 When this option is not used, GCC optimizes for the processor
19926 specified by @option{-march}.  By using @option{-march} and
19927 @option{-mtune} together, it is possible to generate code that
19928 runs on a family of processors, but optimize the code for one
19929 particular member of that family.
19931 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19932 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19933 @option{-march} ones described above.
19935 @item -mips1
19936 @opindex mips1
19937 Equivalent to @option{-march=mips1}.
19939 @item -mips2
19940 @opindex mips2
19941 Equivalent to @option{-march=mips2}.
19943 @item -mips3
19944 @opindex mips3
19945 Equivalent to @option{-march=mips3}.
19947 @item -mips4
19948 @opindex mips4
19949 Equivalent to @option{-march=mips4}.
19951 @item -mips32
19952 @opindex mips32
19953 Equivalent to @option{-march=mips32}.
19955 @item -mips32r3
19956 @opindex mips32r3
19957 Equivalent to @option{-march=mips32r3}.
19959 @item -mips32r5
19960 @opindex mips32r5
19961 Equivalent to @option{-march=mips32r5}.
19963 @item -mips32r6
19964 @opindex mips32r6
19965 Equivalent to @option{-march=mips32r6}.
19967 @item -mips64
19968 @opindex mips64
19969 Equivalent to @option{-march=mips64}.
19971 @item -mips64r2
19972 @opindex mips64r2
19973 Equivalent to @option{-march=mips64r2}.
19975 @item -mips64r3
19976 @opindex mips64r3
19977 Equivalent to @option{-march=mips64r3}.
19979 @item -mips64r5
19980 @opindex mips64r5
19981 Equivalent to @option{-march=mips64r5}.
19983 @item -mips64r6
19984 @opindex mips64r6
19985 Equivalent to @option{-march=mips64r6}.
19987 @item -mips16
19988 @itemx -mno-mips16
19989 @opindex mips16
19990 @opindex mno-mips16
19991 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19992 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19994 MIPS16 code generation can also be controlled on a per-function basis
19995 by means of @code{mips16} and @code{nomips16} attributes.
19996 @xref{Function Attributes}, for more information.
19998 @item -mflip-mips16
19999 @opindex mflip-mips16
20000 Generate MIPS16 code on alternating functions.  This option is provided
20001 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20002 not intended for ordinary use in compiling user code.
20004 @item -minterlink-compressed
20005 @item -mno-interlink-compressed
20006 @opindex minterlink-compressed
20007 @opindex mno-interlink-compressed
20008 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20009 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20011 For example, code using the standard ISA encoding cannot jump directly
20012 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20013 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20014 knows that the target of the jump is not compressed.
20016 @item -minterlink-mips16
20017 @itemx -mno-interlink-mips16
20018 @opindex minterlink-mips16
20019 @opindex mno-interlink-mips16
20020 Aliases of @option{-minterlink-compressed} and
20021 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20022 and are retained for backwards compatibility.
20024 @item -mabi=32
20025 @itemx -mabi=o64
20026 @itemx -mabi=n32
20027 @itemx -mabi=64
20028 @itemx -mabi=eabi
20029 @opindex mabi=32
20030 @opindex mabi=o64
20031 @opindex mabi=n32
20032 @opindex mabi=64
20033 @opindex mabi=eabi
20034 Generate code for the given ABI@.
20036 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20037 generates 64-bit code when you select a 64-bit architecture, but you
20038 can use @option{-mgp32} to get 32-bit code instead.
20040 For information about the O64 ABI, see
20041 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20043 GCC supports a variant of the o32 ABI in which floating-point registers
20044 are 64 rather than 32 bits wide.  You can select this combination with
20045 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20046 and @code{mfhc1} instructions and is therefore only supported for
20047 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20049 The register assignments for arguments and return values remain the
20050 same, but each scalar value is passed in a single 64-bit register
20051 rather than a pair of 32-bit registers.  For example, scalar
20052 floating-point values are returned in @samp{$f0} only, not a
20053 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20054 remains the same in that the even-numbered double-precision registers
20055 are saved.
20057 Two additional variants of the o32 ABI are supported to enable
20058 a transition from 32-bit to 64-bit registers.  These are FPXX
20059 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20060 The FPXX extension mandates that all code must execute correctly
20061 when run using 32-bit or 64-bit registers.  The code can be interlinked
20062 with either FP32 or FP64, but not both.
20063 The FP64A extension is similar to the FP64 extension but forbids the
20064 use of odd-numbered single-precision registers.  This can be used
20065 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20066 processors and allows both FP32 and FP64A code to interlink and
20067 run in the same process without changing FPU modes.
20069 @item -mabicalls
20070 @itemx -mno-abicalls
20071 @opindex mabicalls
20072 @opindex mno-abicalls
20073 Generate (do not generate) code that is suitable for SVR4-style
20074 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20075 systems.
20077 @item -mshared
20078 @itemx -mno-shared
20079 Generate (do not generate) code that is fully position-independent,
20080 and that can therefore be linked into shared libraries.  This option
20081 only affects @option{-mabicalls}.
20083 All @option{-mabicalls} code has traditionally been position-independent,
20084 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20085 as an extension, the GNU toolchain allows executables to use absolute
20086 accesses for locally-binding symbols.  It can also use shorter GP
20087 initialization sequences and generate direct calls to locally-defined
20088 functions.  This mode is selected by @option{-mno-shared}.
20090 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20091 objects that can only be linked by the GNU linker.  However, the option
20092 does not affect the ABI of the final executable; it only affects the ABI
20093 of relocatable objects.  Using @option{-mno-shared} generally makes
20094 executables both smaller and quicker.
20096 @option{-mshared} is the default.
20098 @item -mplt
20099 @itemx -mno-plt
20100 @opindex mplt
20101 @opindex mno-plt
20102 Assume (do not assume) that the static and dynamic linkers
20103 support PLTs and copy relocations.  This option only affects
20104 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20105 has no effect without @option{-msym32}.
20107 You can make @option{-mplt} the default by configuring
20108 GCC with @option{--with-mips-plt}.  The default is
20109 @option{-mno-plt} otherwise.
20111 @item -mxgot
20112 @itemx -mno-xgot
20113 @opindex mxgot
20114 @opindex mno-xgot
20115 Lift (do not lift) the usual restrictions on the size of the global
20116 offset table.
20118 GCC normally uses a single instruction to load values from the GOT@.
20119 While this is relatively efficient, it only works if the GOT
20120 is smaller than about 64k.  Anything larger causes the linker
20121 to report an error such as:
20123 @cindex relocation truncated to fit (MIPS)
20124 @smallexample
20125 relocation truncated to fit: R_MIPS_GOT16 foobar
20126 @end smallexample
20128 If this happens, you should recompile your code with @option{-mxgot}.
20129 This works with very large GOTs, although the code is also
20130 less efficient, since it takes three instructions to fetch the
20131 value of a global symbol.
20133 Note that some linkers can create multiple GOTs.  If you have such a
20134 linker, you should only need to use @option{-mxgot} when a single object
20135 file accesses more than 64k's worth of GOT entries.  Very few do.
20137 These options have no effect unless GCC is generating position
20138 independent code.
20140 @item -mgp32
20141 @opindex mgp32
20142 Assume that general-purpose registers are 32 bits wide.
20144 @item -mgp64
20145 @opindex mgp64
20146 Assume that general-purpose registers are 64 bits wide.
20148 @item -mfp32
20149 @opindex mfp32
20150 Assume that floating-point registers are 32 bits wide.
20152 @item -mfp64
20153 @opindex mfp64
20154 Assume that floating-point registers are 64 bits wide.
20156 @item -mfpxx
20157 @opindex mfpxx
20158 Do not assume the width of floating-point registers.
20160 @item -mhard-float
20161 @opindex mhard-float
20162 Use floating-point coprocessor instructions.
20164 @item -msoft-float
20165 @opindex msoft-float
20166 Do not use floating-point coprocessor instructions.  Implement
20167 floating-point calculations using library calls instead.
20169 @item -mno-float
20170 @opindex mno-float
20171 Equivalent to @option{-msoft-float}, but additionally asserts that the
20172 program being compiled does not perform any floating-point operations.
20173 This option is presently supported only by some bare-metal MIPS
20174 configurations, where it may select a special set of libraries
20175 that lack all floating-point support (including, for example, the
20176 floating-point @code{printf} formats).  
20177 If code compiled with @option{-mno-float} accidentally contains
20178 floating-point operations, it is likely to suffer a link-time
20179 or run-time failure.
20181 @item -msingle-float
20182 @opindex msingle-float
20183 Assume that the floating-point coprocessor only supports single-precision
20184 operations.
20186 @item -mdouble-float
20187 @opindex mdouble-float
20188 Assume that the floating-point coprocessor supports double-precision
20189 operations.  This is the default.
20191 @item -modd-spreg
20192 @itemx -mno-odd-spreg
20193 @opindex modd-spreg
20194 @opindex mno-odd-spreg
20195 Enable the use of odd-numbered single-precision floating-point registers
20196 for the o32 ABI.  This is the default for processors that are known to
20197 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20198 is set by default.
20200 @item -mabs=2008
20201 @itemx -mabs=legacy
20202 @opindex mabs=2008
20203 @opindex mabs=legacy
20204 These options control the treatment of the special not-a-number (NaN)
20205 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20206 @code{neg.@i{fmt}} machine instructions.
20208 By default or when @option{-mabs=legacy} is used the legacy
20209 treatment is selected.  In this case these instructions are considered
20210 arithmetic and avoided where correct operation is required and the
20211 input operand might be a NaN.  A longer sequence of instructions that
20212 manipulate the sign bit of floating-point datum manually is used
20213 instead unless the @option{-ffinite-math-only} option has also been
20214 specified.
20216 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20217 this case these instructions are considered non-arithmetic and therefore
20218 operating correctly in all cases, including in particular where the
20219 input operand is a NaN.  These instructions are therefore always used
20220 for the respective operations.
20222 @item -mnan=2008
20223 @itemx -mnan=legacy
20224 @opindex mnan=2008
20225 @opindex mnan=legacy
20226 These options control the encoding of the special not-a-number (NaN)
20227 IEEE 754 floating-point data.
20229 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20230 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20231 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20232 by the first bit of their trailing significand field being 1.
20234 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20235 this case qNaNs are denoted by the first bit of their trailing
20236 significand field being 1, whereas sNaNs are denoted by the first bit of
20237 their trailing significand field being 0.
20239 The default is @option{-mnan=legacy} unless GCC has been configured with
20240 @option{--with-nan=2008}.
20242 @item -mllsc
20243 @itemx -mno-llsc
20244 @opindex mllsc
20245 @opindex mno-llsc
20246 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20247 implement atomic memory built-in functions.  When neither option is
20248 specified, GCC uses the instructions if the target architecture
20249 supports them.
20251 @option{-mllsc} is useful if the runtime environment can emulate the
20252 instructions and @option{-mno-llsc} can be useful when compiling for
20253 nonstandard ISAs.  You can make either option the default by
20254 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20255 respectively.  @option{--with-llsc} is the default for some
20256 configurations; see the installation documentation for details.
20258 @item -mdsp
20259 @itemx -mno-dsp
20260 @opindex mdsp
20261 @opindex mno-dsp
20262 Use (do not use) revision 1 of the MIPS DSP ASE@.
20263 @xref{MIPS DSP Built-in Functions}.  This option defines the
20264 preprocessor macro @code{__mips_dsp}.  It also defines
20265 @code{__mips_dsp_rev} to 1.
20267 @item -mdspr2
20268 @itemx -mno-dspr2
20269 @opindex mdspr2
20270 @opindex mno-dspr2
20271 Use (do not use) revision 2 of the MIPS DSP ASE@.
20272 @xref{MIPS DSP Built-in Functions}.  This option defines the
20273 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20274 It also defines @code{__mips_dsp_rev} to 2.
20276 @item -msmartmips
20277 @itemx -mno-smartmips
20278 @opindex msmartmips
20279 @opindex mno-smartmips
20280 Use (do not use) the MIPS SmartMIPS ASE.
20282 @item -mpaired-single
20283 @itemx -mno-paired-single
20284 @opindex mpaired-single
20285 @opindex mno-paired-single
20286 Use (do not use) paired-single floating-point instructions.
20287 @xref{MIPS Paired-Single Support}.  This option requires
20288 hardware floating-point support to be enabled.
20290 @item -mdmx
20291 @itemx -mno-mdmx
20292 @opindex mdmx
20293 @opindex mno-mdmx
20294 Use (do not use) MIPS Digital Media Extension instructions.
20295 This option can only be used when generating 64-bit code and requires
20296 hardware floating-point support to be enabled.
20298 @item -mips3d
20299 @itemx -mno-mips3d
20300 @opindex mips3d
20301 @opindex mno-mips3d
20302 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20303 The option @option{-mips3d} implies @option{-mpaired-single}.
20305 @item -mmicromips
20306 @itemx -mno-micromips
20307 @opindex mmicromips
20308 @opindex mno-mmicromips
20309 Generate (do not generate) microMIPS code.
20311 MicroMIPS code generation can also be controlled on a per-function basis
20312 by means of @code{micromips} and @code{nomicromips} attributes.
20313 @xref{Function Attributes}, for more information.
20315 @item -mmt
20316 @itemx -mno-mt
20317 @opindex mmt
20318 @opindex mno-mt
20319 Use (do not use) MT Multithreading instructions.
20321 @item -mmcu
20322 @itemx -mno-mcu
20323 @opindex mmcu
20324 @opindex mno-mcu
20325 Use (do not use) the MIPS MCU ASE instructions.
20327 @item -meva
20328 @itemx -mno-eva
20329 @opindex meva
20330 @opindex mno-eva
20331 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20333 @item -mvirt
20334 @itemx -mno-virt
20335 @opindex mvirt
20336 @opindex mno-virt
20337 Use (do not use) the MIPS Virtualization (VZ) instructions.
20339 @item -mxpa
20340 @itemx -mno-xpa
20341 @opindex mxpa
20342 @opindex mno-xpa
20343 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20345 @item -mlong64
20346 @opindex mlong64
20347 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20348 an explanation of the default and the way that the pointer size is
20349 determined.
20351 @item -mlong32
20352 @opindex mlong32
20353 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20355 The default size of @code{int}s, @code{long}s and pointers depends on
20356 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20357 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20358 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20359 or the same size as integer registers, whichever is smaller.
20361 @item -msym32
20362 @itemx -mno-sym32
20363 @opindex msym32
20364 @opindex mno-sym32
20365 Assume (do not assume) that all symbols have 32-bit values, regardless
20366 of the selected ABI@.  This option is useful in combination with
20367 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20368 to generate shorter and faster references to symbolic addresses.
20370 @item -G @var{num}
20371 @opindex G
20372 Put definitions of externally-visible data in a small data section
20373 if that data is no bigger than @var{num} bytes.  GCC can then generate
20374 more efficient accesses to the data; see @option{-mgpopt} for details.
20376 The default @option{-G} option depends on the configuration.
20378 @item -mlocal-sdata
20379 @itemx -mno-local-sdata
20380 @opindex mlocal-sdata
20381 @opindex mno-local-sdata
20382 Extend (do not extend) the @option{-G} behavior to local data too,
20383 such as to static variables in C@.  @option{-mlocal-sdata} is the
20384 default for all configurations.
20386 If the linker complains that an application is using too much small data,
20387 you might want to try rebuilding the less performance-critical parts with
20388 @option{-mno-local-sdata}.  You might also want to build large
20389 libraries with @option{-mno-local-sdata}, so that the libraries leave
20390 more room for the main program.
20392 @item -mextern-sdata
20393 @itemx -mno-extern-sdata
20394 @opindex mextern-sdata
20395 @opindex mno-extern-sdata
20396 Assume (do not assume) that externally-defined data is in
20397 a small data section if the size of that data is within the @option{-G} limit.
20398 @option{-mextern-sdata} is the default for all configurations.
20400 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20401 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20402 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20403 is placed in a small data section.  If @var{Var} is defined by another
20404 module, you must either compile that module with a high-enough
20405 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20406 definition.  If @var{Var} is common, you must link the application
20407 with a high-enough @option{-G} setting.
20409 The easiest way of satisfying these restrictions is to compile
20410 and link every module with the same @option{-G} option.  However,
20411 you may wish to build a library that supports several different
20412 small data limits.  You can do this by compiling the library with
20413 the highest supported @option{-G} setting and additionally using
20414 @option{-mno-extern-sdata} to stop the library from making assumptions
20415 about externally-defined data.
20417 @item -mgpopt
20418 @itemx -mno-gpopt
20419 @opindex mgpopt
20420 @opindex mno-gpopt
20421 Use (do not use) GP-relative accesses for symbols that are known to be
20422 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20423 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20424 configurations.
20426 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20427 might not hold the value of @code{_gp}.  For example, if the code is
20428 part of a library that might be used in a boot monitor, programs that
20429 call boot monitor routines pass an unknown value in @code{$gp}.
20430 (In such situations, the boot monitor itself is usually compiled
20431 with @option{-G0}.)
20433 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20434 @option{-mno-extern-sdata}.
20436 @item -membedded-data
20437 @itemx -mno-embedded-data
20438 @opindex membedded-data
20439 @opindex mno-embedded-data
20440 Allocate variables to the read-only data section first if possible, then
20441 next in the small data section if possible, otherwise in data.  This gives
20442 slightly slower code than the default, but reduces the amount of RAM required
20443 when executing, and thus may be preferred for some embedded systems.
20445 @item -muninit-const-in-rodata
20446 @itemx -mno-uninit-const-in-rodata
20447 @opindex muninit-const-in-rodata
20448 @opindex mno-uninit-const-in-rodata
20449 Put uninitialized @code{const} variables in the read-only data section.
20450 This option is only meaningful in conjunction with @option{-membedded-data}.
20452 @item -mcode-readable=@var{setting}
20453 @opindex mcode-readable
20454 Specify whether GCC may generate code that reads from executable sections.
20455 There are three possible settings:
20457 @table @gcctabopt
20458 @item -mcode-readable=yes
20459 Instructions may freely access executable sections.  This is the
20460 default setting.
20462 @item -mcode-readable=pcrel
20463 MIPS16 PC-relative load instructions can access executable sections,
20464 but other instructions must not do so.  This option is useful on 4KSc
20465 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20466 It is also useful on processors that can be configured to have a dual
20467 instruction/data SRAM interface and that, like the M4K, automatically
20468 redirect PC-relative loads to the instruction RAM.
20470 @item -mcode-readable=no
20471 Instructions must not access executable sections.  This option can be
20472 useful on targets that are configured to have a dual instruction/data
20473 SRAM interface but that (unlike the M4K) do not automatically redirect
20474 PC-relative loads to the instruction RAM.
20475 @end table
20477 @item -msplit-addresses
20478 @itemx -mno-split-addresses
20479 @opindex msplit-addresses
20480 @opindex mno-split-addresses
20481 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20482 relocation operators.  This option has been superseded by
20483 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20485 @item -mexplicit-relocs
20486 @itemx -mno-explicit-relocs
20487 @opindex mexplicit-relocs
20488 @opindex mno-explicit-relocs
20489 Use (do not use) assembler relocation operators when dealing with symbolic
20490 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20491 is to use assembler macros instead.
20493 @option{-mexplicit-relocs} is the default if GCC was configured
20494 to use an assembler that supports relocation operators.
20496 @item -mcheck-zero-division
20497 @itemx -mno-check-zero-division
20498 @opindex mcheck-zero-division
20499 @opindex mno-check-zero-division
20500 Trap (do not trap) on integer division by zero.
20502 The default is @option{-mcheck-zero-division}.
20504 @item -mdivide-traps
20505 @itemx -mdivide-breaks
20506 @opindex mdivide-traps
20507 @opindex mdivide-breaks
20508 MIPS systems check for division by zero by generating either a
20509 conditional trap or a break instruction.  Using traps results in
20510 smaller code, but is only supported on MIPS II and later.  Also, some
20511 versions of the Linux kernel have a bug that prevents trap from
20512 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20513 allow conditional traps on architectures that support them and
20514 @option{-mdivide-breaks} to force the use of breaks.
20516 The default is usually @option{-mdivide-traps}, but this can be
20517 overridden at configure time using @option{--with-divide=breaks}.
20518 Divide-by-zero checks can be completely disabled using
20519 @option{-mno-check-zero-division}.
20521 @item -mload-store-pairs
20522 @itemx -mno-load-store-pairs
20523 @opindex mload-store-pairs
20524 @opindex mno-load-store-pairs
20525 Enable (disable) an optimization that pairs consecutive load or store
20526 instructions to enable load/store bonding.  This option is enabled by
20527 default but only takes effect when the selected architecture is known
20528 to support bonding.
20530 @item -mmemcpy
20531 @itemx -mno-memcpy
20532 @opindex mmemcpy
20533 @opindex mno-memcpy
20534 Force (do not force) the use of @code{memcpy} for non-trivial block
20535 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20536 most constant-sized copies.
20538 @item -mlong-calls
20539 @itemx -mno-long-calls
20540 @opindex mlong-calls
20541 @opindex mno-long-calls
20542 Disable (do not disable) use of the @code{jal} instruction.  Calling
20543 functions using @code{jal} is more efficient but requires the caller
20544 and callee to be in the same 256 megabyte segment.
20546 This option has no effect on abicalls code.  The default is
20547 @option{-mno-long-calls}.
20549 @item -mmad
20550 @itemx -mno-mad
20551 @opindex mmad
20552 @opindex mno-mad
20553 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20554 instructions, as provided by the R4650 ISA@.
20556 @item -mimadd
20557 @itemx -mno-imadd
20558 @opindex mimadd
20559 @opindex mno-imadd
20560 Enable (disable) use of the @code{madd} and @code{msub} integer
20561 instructions.  The default is @option{-mimadd} on architectures
20562 that support @code{madd} and @code{msub} except for the 74k 
20563 architecture where it was found to generate slower code.
20565 @item -mfused-madd
20566 @itemx -mno-fused-madd
20567 @opindex mfused-madd
20568 @opindex mno-fused-madd
20569 Enable (disable) use of the floating-point multiply-accumulate
20570 instructions, when they are available.  The default is
20571 @option{-mfused-madd}.
20573 On the R8000 CPU when multiply-accumulate instructions are used,
20574 the intermediate product is calculated to infinite precision
20575 and is not subject to the FCSR Flush to Zero bit.  This may be
20576 undesirable in some circumstances.  On other processors the result
20577 is numerically identical to the equivalent computation using
20578 separate multiply, add, subtract and negate instructions.
20580 @item -nocpp
20581 @opindex nocpp
20582 Tell the MIPS assembler to not run its preprocessor over user
20583 assembler files (with a @samp{.s} suffix) when assembling them.
20585 @item -mfix-24k
20586 @item -mno-fix-24k
20587 @opindex mfix-24k
20588 @opindex mno-fix-24k
20589 Work around the 24K E48 (lost data on stores during refill) errata.
20590 The workarounds are implemented by the assembler rather than by GCC@.
20592 @item -mfix-r4000
20593 @itemx -mno-fix-r4000
20594 @opindex mfix-r4000
20595 @opindex mno-fix-r4000
20596 Work around certain R4000 CPU errata:
20597 @itemize @minus
20598 @item
20599 A double-word or a variable shift may give an incorrect result if executed
20600 immediately after starting an integer division.
20601 @item
20602 A double-word or a variable shift may give an incorrect result if executed
20603 while an integer multiplication is in progress.
20604 @item
20605 An integer division may give an incorrect result if started in a delay slot
20606 of a taken branch or a jump.
20607 @end itemize
20609 @item -mfix-r4400
20610 @itemx -mno-fix-r4400
20611 @opindex mfix-r4400
20612 @opindex mno-fix-r4400
20613 Work around certain R4400 CPU errata:
20614 @itemize @minus
20615 @item
20616 A double-word or a variable shift may give an incorrect result if executed
20617 immediately after starting an integer division.
20618 @end itemize
20620 @item -mfix-r10000
20621 @itemx -mno-fix-r10000
20622 @opindex mfix-r10000
20623 @opindex mno-fix-r10000
20624 Work around certain R10000 errata:
20625 @itemize @minus
20626 @item
20627 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20628 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20629 @end itemize
20631 This option can only be used if the target architecture supports
20632 branch-likely instructions.  @option{-mfix-r10000} is the default when
20633 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20634 otherwise.
20636 @item -mfix-rm7000
20637 @itemx -mno-fix-rm7000
20638 @opindex mfix-rm7000
20639 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20640 workarounds are implemented by the assembler rather than by GCC@.
20642 @item -mfix-vr4120
20643 @itemx -mno-fix-vr4120
20644 @opindex mfix-vr4120
20645 Work around certain VR4120 errata:
20646 @itemize @minus
20647 @item
20648 @code{dmultu} does not always produce the correct result.
20649 @item
20650 @code{div} and @code{ddiv} do not always produce the correct result if one
20651 of the operands is negative.
20652 @end itemize
20653 The workarounds for the division errata rely on special functions in
20654 @file{libgcc.a}.  At present, these functions are only provided by
20655 the @code{mips64vr*-elf} configurations.
20657 Other VR4120 errata require a NOP to be inserted between certain pairs of
20658 instructions.  These errata are handled by the assembler, not by GCC itself.
20660 @item -mfix-vr4130
20661 @opindex mfix-vr4130
20662 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20663 workarounds are implemented by the assembler rather than by GCC,
20664 although GCC avoids using @code{mflo} and @code{mfhi} if the
20665 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20666 instructions are available instead.
20668 @item -mfix-sb1
20669 @itemx -mno-fix-sb1
20670 @opindex mfix-sb1
20671 Work around certain SB-1 CPU core errata.
20672 (This flag currently works around the SB-1 revision 2
20673 ``F1'' and ``F2'' floating-point errata.)
20675 @item -mr10k-cache-barrier=@var{setting}
20676 @opindex mr10k-cache-barrier
20677 Specify whether GCC should insert cache barriers to avoid the
20678 side-effects of speculation on R10K processors.
20680 In common with many processors, the R10K tries to predict the outcome
20681 of a conditional branch and speculatively executes instructions from
20682 the ``taken'' branch.  It later aborts these instructions if the
20683 predicted outcome is wrong.  However, on the R10K, even aborted
20684 instructions can have side effects.
20686 This problem only affects kernel stores and, depending on the system,
20687 kernel loads.  As an example, a speculatively-executed store may load
20688 the target memory into cache and mark the cache line as dirty, even if
20689 the store itself is later aborted.  If a DMA operation writes to the
20690 same area of memory before the ``dirty'' line is flushed, the cached
20691 data overwrites the DMA-ed data.  See the R10K processor manual
20692 for a full description, including other potential problems.
20694 One workaround is to insert cache barrier instructions before every memory
20695 access that might be speculatively executed and that might have side
20696 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20697 controls GCC's implementation of this workaround.  It assumes that
20698 aborted accesses to any byte in the following regions does not have
20699 side effects:
20701 @enumerate
20702 @item
20703 the memory occupied by the current function's stack frame;
20705 @item
20706 the memory occupied by an incoming stack argument;
20708 @item
20709 the memory occupied by an object with a link-time-constant address.
20710 @end enumerate
20712 It is the kernel's responsibility to ensure that speculative
20713 accesses to these regions are indeed safe.
20715 If the input program contains a function declaration such as:
20717 @smallexample
20718 void foo (void);
20719 @end smallexample
20721 then the implementation of @code{foo} must allow @code{j foo} and
20722 @code{jal foo} to be executed speculatively.  GCC honors this
20723 restriction for functions it compiles itself.  It expects non-GCC
20724 functions (such as hand-written assembly code) to do the same.
20726 The option has three forms:
20728 @table @gcctabopt
20729 @item -mr10k-cache-barrier=load-store
20730 Insert a cache barrier before a load or store that might be
20731 speculatively executed and that might have side effects even
20732 if aborted.
20734 @item -mr10k-cache-barrier=store
20735 Insert a cache barrier before a store that might be speculatively
20736 executed and that might have side effects even if aborted.
20738 @item -mr10k-cache-barrier=none
20739 Disable the insertion of cache barriers.  This is the default setting.
20740 @end table
20742 @item -mflush-func=@var{func}
20743 @itemx -mno-flush-func
20744 @opindex mflush-func
20745 Specifies the function to call to flush the I and D caches, or to not
20746 call any such function.  If called, the function must take the same
20747 arguments as the common @code{_flush_func}, that is, the address of the
20748 memory range for which the cache is being flushed, the size of the
20749 memory range, and the number 3 (to flush both caches).  The default
20750 depends on the target GCC was configured for, but commonly is either
20751 @code{_flush_func} or @code{__cpu_flush}.
20753 @item mbranch-cost=@var{num}
20754 @opindex mbranch-cost
20755 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20756 This cost is only a heuristic and is not guaranteed to produce
20757 consistent results across releases.  A zero cost redundantly selects
20758 the default, which is based on the @option{-mtune} setting.
20760 @item -mbranch-likely
20761 @itemx -mno-branch-likely
20762 @opindex mbranch-likely
20763 @opindex mno-branch-likely
20764 Enable or disable use of Branch Likely instructions, regardless of the
20765 default for the selected architecture.  By default, Branch Likely
20766 instructions may be generated if they are supported by the selected
20767 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20768 and processors that implement those architectures; for those, Branch
20769 Likely instructions are not be generated by default because the MIPS32
20770 and MIPS64 architectures specifically deprecate their use.
20772 @item -mcompact-branches=never
20773 @itemx -mcompact-branches=optimal
20774 @itemx -mcompact-branches=always
20775 @opindex mcompact-branches=never
20776 @opindex mcompact-branches=optimal
20777 @opindex mcompact-branches=always
20778 These options control which form of branches will be generated.  The
20779 default is @option{-mcompact-branches=optimal}.
20781 The @option{-mcompact-branches=never} option ensures that compact branch
20782 instructions will never be generated.
20784 The @option{-mcompact-branches=always} option ensures that a compact
20785 branch instruction will be generated if available.  If a compact branch
20786 instruction is not available, a delay slot form of the branch will be
20787 used instead.
20789 This option is supported from MIPS Release 6 onwards.
20791 The @option{-mcompact-branches=optimal} option will cause a delay slot
20792 branch to be used if one is available in the current ISA and the delay
20793 slot is successfully filled.  If the delay slot is not filled, a compact
20794 branch will be chosen if one is available.
20796 @item -mfp-exceptions
20797 @itemx -mno-fp-exceptions
20798 @opindex mfp-exceptions
20799 Specifies whether FP exceptions are enabled.  This affects how
20800 FP instructions are scheduled for some processors.
20801 The default is that FP exceptions are
20802 enabled.
20804 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20805 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20806 FP pipe.
20808 @item -mvr4130-align
20809 @itemx -mno-vr4130-align
20810 @opindex mvr4130-align
20811 The VR4130 pipeline is two-way superscalar, but can only issue two
20812 instructions together if the first one is 8-byte aligned.  When this
20813 option is enabled, GCC aligns pairs of instructions that it
20814 thinks should execute in parallel.
20816 This option only has an effect when optimizing for the VR4130.
20817 It normally makes code faster, but at the expense of making it bigger.
20818 It is enabled by default at optimization level @option{-O3}.
20820 @item -msynci
20821 @itemx -mno-synci
20822 @opindex msynci
20823 Enable (disable) generation of @code{synci} instructions on
20824 architectures that support it.  The @code{synci} instructions (if
20825 enabled) are generated when @code{__builtin___clear_cache} is
20826 compiled.
20828 This option defaults to @option{-mno-synci}, but the default can be
20829 overridden by configuring GCC with @option{--with-synci}.
20831 When compiling code for single processor systems, it is generally safe
20832 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20833 does not invalidate the instruction caches on all cores and may lead
20834 to undefined behavior.
20836 @item -mrelax-pic-calls
20837 @itemx -mno-relax-pic-calls
20838 @opindex mrelax-pic-calls
20839 Try to turn PIC calls that are normally dispatched via register
20840 @code{$25} into direct calls.  This is only possible if the linker can
20841 resolve the destination at link time and if the destination is within
20842 range for a direct call.
20844 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20845 an assembler and a linker that support the @code{.reloc} assembly
20846 directive and @option{-mexplicit-relocs} is in effect.  With
20847 @option{-mno-explicit-relocs}, this optimization can be performed by the
20848 assembler and the linker alone without help from the compiler.
20850 @item -mmcount-ra-address
20851 @itemx -mno-mcount-ra-address
20852 @opindex mmcount-ra-address
20853 @opindex mno-mcount-ra-address
20854 Emit (do not emit) code that allows @code{_mcount} to modify the
20855 calling function's return address.  When enabled, this option extends
20856 the usual @code{_mcount} interface with a new @var{ra-address}
20857 parameter, which has type @code{intptr_t *} and is passed in register
20858 @code{$12}.  @code{_mcount} can then modify the return address by
20859 doing both of the following:
20860 @itemize
20861 @item
20862 Returning the new address in register @code{$31}.
20863 @item
20864 Storing the new address in @code{*@var{ra-address}},
20865 if @var{ra-address} is nonnull.
20866 @end itemize
20868 The default is @option{-mno-mcount-ra-address}.
20870 @item -mframe-header-opt
20871 @itemx -mno-frame-header-opt
20872 @opindex mframe-header-opt
20873 Enable (disable) frame header optimization in the o32 ABI.  When using the
20874 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20875 function to write out register arguments.  When enabled, this optimization
20876 will suppress the allocation of the frame header if it can be determined that
20877 it is unused.
20879 This optimization is off by default at all optimization levels.
20881 @item -mlxc1-sxc1
20882 @itemx -mno-lxc1-sxc1
20883 @opindex mlxc1-sxc1
20884 When applicable, enable (disable) the generation of @code{lwxc1},
20885 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20887 @item -mmadd4
20888 @itemx -mno-madd4
20889 @opindex mmadd4
20890 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20891 @code{madd.d} and related instructions.  Enabled by default.
20893 @end table
20895 @node MMIX Options
20896 @subsection MMIX Options
20897 @cindex MMIX Options
20899 These options are defined for the MMIX:
20901 @table @gcctabopt
20902 @item -mlibfuncs
20903 @itemx -mno-libfuncs
20904 @opindex mlibfuncs
20905 @opindex mno-libfuncs
20906 Specify that intrinsic library functions are being compiled, passing all
20907 values in registers, no matter the size.
20909 @item -mepsilon
20910 @itemx -mno-epsilon
20911 @opindex mepsilon
20912 @opindex mno-epsilon
20913 Generate floating-point comparison instructions that compare with respect
20914 to the @code{rE} epsilon register.
20916 @item -mabi=mmixware
20917 @itemx -mabi=gnu
20918 @opindex mabi=mmixware
20919 @opindex mabi=gnu
20920 Generate code that passes function parameters and return values that (in
20921 the called function) are seen as registers @code{$0} and up, as opposed to
20922 the GNU ABI which uses global registers @code{$231} and up.
20924 @item -mzero-extend
20925 @itemx -mno-zero-extend
20926 @opindex mzero-extend
20927 @opindex mno-zero-extend
20928 When reading data from memory in sizes shorter than 64 bits, use (do not
20929 use) zero-extending load instructions by default, rather than
20930 sign-extending ones.
20932 @item -mknuthdiv
20933 @itemx -mno-knuthdiv
20934 @opindex mknuthdiv
20935 @opindex mno-knuthdiv
20936 Make the result of a division yielding a remainder have the same sign as
20937 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20938 remainder follows the sign of the dividend.  Both methods are
20939 arithmetically valid, the latter being almost exclusively used.
20941 @item -mtoplevel-symbols
20942 @itemx -mno-toplevel-symbols
20943 @opindex mtoplevel-symbols
20944 @opindex mno-toplevel-symbols
20945 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20946 code can be used with the @code{PREFIX} assembly directive.
20948 @item -melf
20949 @opindex melf
20950 Generate an executable in the ELF format, rather than the default
20951 @samp{mmo} format used by the @command{mmix} simulator.
20953 @item -mbranch-predict
20954 @itemx -mno-branch-predict
20955 @opindex mbranch-predict
20956 @opindex mno-branch-predict
20957 Use (do not use) the probable-branch instructions, when static branch
20958 prediction indicates a probable branch.
20960 @item -mbase-addresses
20961 @itemx -mno-base-addresses
20962 @opindex mbase-addresses
20963 @opindex mno-base-addresses
20964 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20965 base address automatically generates a request (handled by the assembler
20966 and the linker) for a constant to be set up in a global register.  The
20967 register is used for one or more base address requests within the range 0
20968 to 255 from the value held in the register.  The generally leads to short
20969 and fast code, but the number of different data items that can be
20970 addressed is limited.  This means that a program that uses lots of static
20971 data may require @option{-mno-base-addresses}.
20973 @item -msingle-exit
20974 @itemx -mno-single-exit
20975 @opindex msingle-exit
20976 @opindex mno-single-exit
20977 Force (do not force) generated code to have a single exit point in each
20978 function.
20979 @end table
20981 @node MN10300 Options
20982 @subsection MN10300 Options
20983 @cindex MN10300 options
20985 These @option{-m} options are defined for Matsushita MN10300 architectures:
20987 @table @gcctabopt
20988 @item -mmult-bug
20989 @opindex mmult-bug
20990 Generate code to avoid bugs in the multiply instructions for the MN10300
20991 processors.  This is the default.
20993 @item -mno-mult-bug
20994 @opindex mno-mult-bug
20995 Do not generate code to avoid bugs in the multiply instructions for the
20996 MN10300 processors.
20998 @item -mam33
20999 @opindex mam33
21000 Generate code using features specific to the AM33 processor.
21002 @item -mno-am33
21003 @opindex mno-am33
21004 Do not generate code using features specific to the AM33 processor.  This
21005 is the default.
21007 @item -mam33-2
21008 @opindex mam33-2
21009 Generate code using features specific to the AM33/2.0 processor.
21011 @item -mam34
21012 @opindex mam34
21013 Generate code using features specific to the AM34 processor.
21015 @item -mtune=@var{cpu-type}
21016 @opindex mtune
21017 Use the timing characteristics of the indicated CPU type when
21018 scheduling instructions.  This does not change the targeted processor
21019 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21020 @samp{am33-2} or @samp{am34}.
21022 @item -mreturn-pointer-on-d0
21023 @opindex mreturn-pointer-on-d0
21024 When generating a function that returns a pointer, return the pointer
21025 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21026 only in @code{a0}, and attempts to call such functions without a prototype
21027 result in errors.  Note that this option is on by default; use
21028 @option{-mno-return-pointer-on-d0} to disable it.
21030 @item -mno-crt0
21031 @opindex mno-crt0
21032 Do not link in the C run-time initialization object file.
21034 @item -mrelax
21035 @opindex mrelax
21036 Indicate to the linker that it should perform a relaxation optimization pass
21037 to shorten branches, calls and absolute memory addresses.  This option only
21038 has an effect when used on the command line for the final link step.
21040 This option makes symbolic debugging impossible.
21042 @item -mliw
21043 @opindex mliw
21044 Allow the compiler to generate @emph{Long Instruction Word}
21045 instructions if the target is the @samp{AM33} or later.  This is the
21046 default.  This option defines the preprocessor macro @code{__LIW__}.
21048 @item -mnoliw
21049 @opindex mnoliw
21050 Do not allow the compiler to generate @emph{Long Instruction Word}
21051 instructions.  This option defines the preprocessor macro
21052 @code{__NO_LIW__}.
21054 @item -msetlb
21055 @opindex msetlb
21056 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21057 instructions if the target is the @samp{AM33} or later.  This is the
21058 default.  This option defines the preprocessor macro @code{__SETLB__}.
21060 @item -mnosetlb
21061 @opindex mnosetlb
21062 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21063 instructions.  This option defines the preprocessor macro
21064 @code{__NO_SETLB__}.
21066 @end table
21068 @node Moxie Options
21069 @subsection Moxie Options
21070 @cindex Moxie Options
21072 @table @gcctabopt
21074 @item -meb
21075 @opindex meb
21076 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21077 configurations.
21079 @item -mel
21080 @opindex mel
21081 Generate little-endian code.
21083 @item -mmul.x
21084 @opindex mmul.x
21085 Generate mul.x and umul.x instructions.  This is the default for
21086 @samp{moxiebox-*-*} configurations.
21088 @item -mno-crt0
21089 @opindex mno-crt0
21090 Do not link in the C run-time initialization object file.
21092 @end table
21094 @node MSP430 Options
21095 @subsection MSP430 Options
21096 @cindex MSP430 Options
21098 These options are defined for the MSP430:
21100 @table @gcctabopt
21102 @item -masm-hex
21103 @opindex masm-hex
21104 Force assembly output to always use hex constants.  Normally such
21105 constants are signed decimals, but this option is available for
21106 testsuite and/or aesthetic purposes.
21108 @item -mmcu=
21109 @opindex mmcu=
21110 Select the MCU to target.  This is used to create a C preprocessor
21111 symbol based upon the MCU name, converted to upper case and pre- and
21112 post-fixed with @samp{__}.  This in turn is used by the
21113 @file{msp430.h} header file to select an MCU-specific supplementary
21114 header file.
21116 The option also sets the ISA to use.  If the MCU name is one that is
21117 known to only support the 430 ISA then that is selected, otherwise the
21118 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21119 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21120 name selects the 430X ISA.
21122 In addition an MCU-specific linker script is added to the linker
21123 command line.  The script's name is the name of the MCU with
21124 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21125 command line defines the C preprocessor symbol @code{__XXX__} and
21126 cause the linker to search for a script called @file{xxx.ld}.
21128 This option is also passed on to the assembler.
21130 @item -mwarn-mcu
21131 @itemx -mno-warn-mcu
21132 @opindex mwarn-mcu
21133 @opindex mno-warn-mcu
21134 This option enables or disables warnings about conflicts between the
21135 MCU name specified by the @option{-mmcu} option and the ISA set by the
21136 @option{-mcpu} option and/or the hardware multiply support set by the
21137 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21138 MCU names.  This option is on by default.
21140 @item -mcpu=
21141 @opindex mcpu=
21142 Specifies the ISA to use.  Accepted values are @samp{msp430},
21143 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21144 @option{-mmcu=} option should be used to select the ISA.
21146 @item -msim
21147 @opindex msim
21148 Link to the simulator runtime libraries and linker script.  Overrides
21149 any scripts that would be selected by the @option{-mmcu=} option.
21151 @item -mlarge
21152 @opindex mlarge
21153 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21155 @item -msmall
21156 @opindex msmall
21157 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21159 @item -mrelax
21160 @opindex mrelax
21161 This option is passed to the assembler and linker, and allows the
21162 linker to perform certain optimizations that cannot be done until
21163 the final link.
21165 @item mhwmult=
21166 @opindex mhwmult=
21167 Describes the type of hardware multiply supported by the target.
21168 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21169 for the original 16-bit-only multiply supported by early MCUs.
21170 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21171 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21172 A value of @samp{auto} can also be given.  This tells GCC to deduce
21173 the hardware multiply support based upon the MCU name provided by the
21174 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21175 the MCU name is not recognized then no hardware multiply support is
21176 assumed.  @code{auto} is the default setting.
21178 Hardware multiplies are normally performed by calling a library
21179 routine.  This saves space in the generated code.  When compiling at
21180 @option{-O3} or higher however the hardware multiplier is invoked
21181 inline.  This makes for bigger, but faster code.
21183 The hardware multiply routines disable interrupts whilst running and
21184 restore the previous interrupt state when they finish.  This makes
21185 them safe to use inside interrupt handlers as well as in normal code.
21187 @item -minrt
21188 @opindex minrt
21189 Enable the use of a minimum runtime environment - no static
21190 initializers or constructors.  This is intended for memory-constrained
21191 devices.  The compiler includes special symbols in some objects
21192 that tell the linker and runtime which code fragments are required.
21194 @item -mcode-region=
21195 @itemx -mdata-region=
21196 @opindex mcode-region
21197 @opindex mdata-region
21198 These options tell the compiler where to place functions and data that
21199 do not have one of the @code{lower}, @code{upper}, @code{either} or
21200 @code{section} attributes.  Possible values are @code{lower},
21201 @code{upper}, @code{either} or @code{any}.  The first three behave
21202 like the corresponding attribute.  The fourth possible value -
21203 @code{any} - is the default.  It leaves placement entirely up to the
21204 linker script and how it assigns the standard sections
21205 (@code{.text}, @code{.data}, etc) to the memory regions.
21207 @item -msilicon-errata=
21208 @opindex msilicon-errata
21209 This option passes on a request to assembler to enable the fixes for
21210 the named silicon errata.
21212 @item -msilicon-errata-warn=
21213 @opindex msilicon-errata-warn
21214 This option passes on a request to the assembler to enable warning
21215 messages when a silicon errata might need to be applied.
21217 @end table
21219 @node NDS32 Options
21220 @subsection NDS32 Options
21221 @cindex NDS32 Options
21223 These options are defined for NDS32 implementations:
21225 @table @gcctabopt
21227 @item -mbig-endian
21228 @opindex mbig-endian
21229 Generate code in big-endian mode.
21231 @item -mlittle-endian
21232 @opindex mlittle-endian
21233 Generate code in little-endian mode.
21235 @item -mreduced-regs
21236 @opindex mreduced-regs
21237 Use reduced-set registers for register allocation.
21239 @item -mfull-regs
21240 @opindex mfull-regs
21241 Use full-set registers for register allocation.
21243 @item -mcmov
21244 @opindex mcmov
21245 Generate conditional move instructions.
21247 @item -mno-cmov
21248 @opindex mno-cmov
21249 Do not generate conditional move instructions.
21251 @item -mperf-ext
21252 @opindex mperf-ext
21253 Generate performance extension instructions.
21255 @item -mno-perf-ext
21256 @opindex mno-perf-ext
21257 Do not generate performance extension instructions.
21259 @item -mv3push
21260 @opindex mv3push
21261 Generate v3 push25/pop25 instructions.
21263 @item -mno-v3push
21264 @opindex mno-v3push
21265 Do not generate v3 push25/pop25 instructions.
21267 @item -m16-bit
21268 @opindex m16-bit
21269 Generate 16-bit instructions.
21271 @item -mno-16-bit
21272 @opindex mno-16-bit
21273 Do not generate 16-bit instructions.
21275 @item -misr-vector-size=@var{num}
21276 @opindex misr-vector-size
21277 Specify the size of each interrupt vector, which must be 4 or 16.
21279 @item -mcache-block-size=@var{num}
21280 @opindex mcache-block-size
21281 Specify the size of each cache block,
21282 which must be a power of 2 between 4 and 512.
21284 @item -march=@var{arch}
21285 @opindex march
21286 Specify the name of the target architecture.
21288 @item -mcmodel=@var{code-model}
21289 @opindex mcmodel
21290 Set the code model to one of
21291 @table @asis
21292 @item @samp{small}
21293 All the data and read-only data segments must be within 512KB addressing space.
21294 The text segment must be within 16MB addressing space.
21295 @item @samp{medium}
21296 The data segment must be within 512KB while the read-only data segment can be
21297 within 4GB addressing space.  The text segment should be still within 16MB
21298 addressing space.
21299 @item @samp{large}
21300 All the text and data segments can be within 4GB addressing space.
21301 @end table
21303 @item -mctor-dtor
21304 @opindex mctor-dtor
21305 Enable constructor/destructor feature.
21307 @item -mrelax
21308 @opindex mrelax
21309 Guide linker to relax instructions.
21311 @end table
21313 @node Nios II Options
21314 @subsection Nios II Options
21315 @cindex Nios II options
21316 @cindex Altera Nios II options
21318 These are the options defined for the Altera Nios II processor.
21320 @table @gcctabopt
21322 @item -G @var{num}
21323 @opindex G
21324 @cindex smaller data references
21325 Put global and static objects less than or equal to @var{num} bytes
21326 into the small data or BSS sections instead of the normal data or BSS
21327 sections.  The default value of @var{num} is 8.
21329 @item -mgpopt=@var{option}
21330 @item -mgpopt
21331 @itemx -mno-gpopt
21332 @opindex mgpopt
21333 @opindex mno-gpopt
21334 Generate (do not generate) GP-relative accesses.  The following 
21335 @var{option} names are recognized:
21337 @table @samp
21339 @item none
21340 Do not generate GP-relative accesses.
21342 @item local
21343 Generate GP-relative accesses for small data objects that are not 
21344 external, weak, or uninitialized common symbols.  
21345 Also use GP-relative addressing for objects that
21346 have been explicitly placed in a small data section via a @code{section}
21347 attribute.
21349 @item global
21350 As for @samp{local}, but also generate GP-relative accesses for
21351 small data objects that are external, weak, or common.  If you use this option,
21352 you must ensure that all parts of your program (including libraries) are
21353 compiled with the same @option{-G} setting.
21355 @item data
21356 Generate GP-relative accesses for all data objects in the program.  If you
21357 use this option, the entire data and BSS segments
21358 of your program must fit in 64K of memory and you must use an appropriate
21359 linker script to allocate them within the addressable range of the
21360 global pointer.
21362 @item all
21363 Generate GP-relative addresses for function pointers as well as data
21364 pointers.  If you use this option, the entire text, data, and BSS segments
21365 of your program must fit in 64K of memory and you must use an appropriate
21366 linker script to allocate them within the addressable range of the
21367 global pointer.
21369 @end table
21371 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21372 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21374 The default is @option{-mgpopt} except when @option{-fpic} or
21375 @option{-fPIC} is specified to generate position-independent code.
21376 Note that the Nios II ABI does not permit GP-relative accesses from
21377 shared libraries.
21379 You may need to specify @option{-mno-gpopt} explicitly when building
21380 programs that include large amounts of small data, including large
21381 GOT data sections.  In this case, the 16-bit offset for GP-relative
21382 addressing may not be large enough to allow access to the entire 
21383 small data section.
21385 @item -mgprel-sec=@var{regexp}
21386 @opindex mgprel-sec
21387 This option specifies additional section names that can be accessed via
21388 GP-relative addressing.  It is most useful in conjunction with 
21389 @code{section} attributes on variable declarations 
21390 (@pxref{Common Variable Attributes}) and a custom linker script.  
21391 The @var{regexp} is a POSIX Extended Regular Expression.
21393 This option does not affect the behavior of the @option{-G} option, and 
21394 and the specified sections are in addition to the standard @code{.sdata} 
21395 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21397 @item -mr0rel-sec=@var{regexp}
21398 @opindex mr0rel-sec
21399 This option specifies names of sections that can be accessed via a 
21400 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21401 of the 32-bit address space.  It is most useful in conjunction with 
21402 @code{section} attributes on variable declarations 
21403 (@pxref{Common Variable Attributes}) and a custom linker script.  
21404 The @var{regexp} is a POSIX Extended Regular Expression.
21406 In contrast to the use of GP-relative addressing for small data, 
21407 zero-based addressing is never generated by default and there are no 
21408 conventional section names used in standard linker scripts for sections
21409 in the low or high areas of memory.
21411 @item -mel
21412 @itemx -meb
21413 @opindex mel
21414 @opindex meb
21415 Generate little-endian (default) or big-endian (experimental) code,
21416 respectively.
21418 @item -march=@var{arch}
21419 @opindex march
21420 This specifies the name of the target Nios II architecture.  GCC uses this
21421 name to determine what kind of instructions it can emit when generating
21422 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21424 The preprocessor macro @code{__nios2_arch__} is available to programs,
21425 with value 1 or 2, indicating the targeted ISA level.
21427 @item -mbypass-cache
21428 @itemx -mno-bypass-cache
21429 @opindex mno-bypass-cache
21430 @opindex mbypass-cache
21431 Force all load and store instructions to always bypass cache by 
21432 using I/O variants of the instructions. The default is not to
21433 bypass the cache.
21435 @item -mno-cache-volatile 
21436 @itemx -mcache-volatile       
21437 @opindex mcache-volatile 
21438 @opindex mno-cache-volatile
21439 Volatile memory access bypass the cache using the I/O variants of 
21440 the load and store instructions. The default is not to bypass the cache.
21442 @item -mno-fast-sw-div
21443 @itemx -mfast-sw-div
21444 @opindex mno-fast-sw-div
21445 @opindex mfast-sw-div
21446 Do not use table-based fast divide for small numbers. The default 
21447 is to use the fast divide at @option{-O3} and above.
21449 @item -mno-hw-mul
21450 @itemx -mhw-mul
21451 @itemx -mno-hw-mulx
21452 @itemx -mhw-mulx
21453 @itemx -mno-hw-div
21454 @itemx -mhw-div
21455 @opindex mno-hw-mul
21456 @opindex mhw-mul
21457 @opindex mno-hw-mulx
21458 @opindex mhw-mulx
21459 @opindex mno-hw-div
21460 @opindex mhw-div
21461 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21462 instructions by the compiler. The default is to emit @code{mul}
21463 and not emit @code{div} and @code{mulx}.
21465 @item -mbmx
21466 @itemx -mno-bmx
21467 @itemx -mcdx
21468 @itemx -mno-cdx
21469 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21470 CDX (code density) instructions.  Enabling these instructions also
21471 requires @option{-march=r2}.  Since these instructions are optional
21472 extensions to the R2 architecture, the default is not to emit them.
21474 @item -mcustom-@var{insn}=@var{N}
21475 @itemx -mno-custom-@var{insn}
21476 @opindex mcustom-@var{insn}
21477 @opindex mno-custom-@var{insn}
21478 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21479 custom instruction with encoding @var{N} when generating code that uses 
21480 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21481 instruction 253 for single-precision floating-point add operations instead
21482 of the default behavior of using a library call.
21484 The following values of @var{insn} are supported.  Except as otherwise
21485 noted, floating-point operations are expected to be implemented with
21486 normal IEEE 754 semantics and correspond directly to the C operators or the
21487 equivalent GCC built-in functions (@pxref{Other Builtins}).
21489 Single-precision floating point:
21490 @table @asis
21492 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21493 Binary arithmetic operations.
21495 @item @samp{fnegs}
21496 Unary negation.
21498 @item @samp{fabss}
21499 Unary absolute value.
21501 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21502 Comparison operations.
21504 @item @samp{fmins}, @samp{fmaxs}
21505 Floating-point minimum and maximum.  These instructions are only
21506 generated if @option{-ffinite-math-only} is specified.
21508 @item @samp{fsqrts}
21509 Unary square root operation.
21511 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21512 Floating-point trigonometric and exponential functions.  These instructions
21513 are only generated if @option{-funsafe-math-optimizations} is also specified.
21515 @end table
21517 Double-precision floating point:
21518 @table @asis
21520 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21521 Binary arithmetic operations.
21523 @item @samp{fnegd}
21524 Unary negation.
21526 @item @samp{fabsd}
21527 Unary absolute value.
21529 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21530 Comparison operations.
21532 @item @samp{fmind}, @samp{fmaxd}
21533 Double-precision minimum and maximum.  These instructions are only
21534 generated if @option{-ffinite-math-only} is specified.
21536 @item @samp{fsqrtd}
21537 Unary square root operation.
21539 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21540 Double-precision trigonometric and exponential functions.  These instructions
21541 are only generated if @option{-funsafe-math-optimizations} is also specified.
21543 @end table
21545 Conversions:
21546 @table @asis
21547 @item @samp{fextsd}
21548 Conversion from single precision to double precision.
21550 @item @samp{ftruncds}
21551 Conversion from double precision to single precision.
21553 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21554 Conversion from floating point to signed or unsigned integer types, with
21555 truncation towards zero.
21557 @item @samp{round}
21558 Conversion from single-precision floating point to signed integer,
21559 rounding to the nearest integer and ties away from zero.
21560 This corresponds to the @code{__builtin_lroundf} function when
21561 @option{-fno-math-errno} is used.
21563 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21564 Conversion from signed or unsigned integer types to floating-point types.
21566 @end table
21568 In addition, all of the following transfer instructions for internal
21569 registers X and Y must be provided to use any of the double-precision
21570 floating-point instructions.  Custom instructions taking two
21571 double-precision source operands expect the first operand in the
21572 64-bit register X.  The other operand (or only operand of a unary
21573 operation) is given to the custom arithmetic instruction with the
21574 least significant half in source register @var{src1} and the most
21575 significant half in @var{src2}.  A custom instruction that returns a
21576 double-precision result returns the most significant 32 bits in the
21577 destination register and the other half in 32-bit register Y.  
21578 GCC automatically generates the necessary code sequences to write
21579 register X and/or read register Y when double-precision floating-point
21580 instructions are used.
21582 @table @asis
21584 @item @samp{fwrx}
21585 Write @var{src1} into the least significant half of X and @var{src2} into
21586 the most significant half of X.
21588 @item @samp{fwry}
21589 Write @var{src1} into Y.
21591 @item @samp{frdxhi}, @samp{frdxlo}
21592 Read the most or least (respectively) significant half of X and store it in
21593 @var{dest}.
21595 @item @samp{frdy}
21596 Read the value of Y and store it into @var{dest}.
21597 @end table
21599 Note that you can gain more local control over generation of Nios II custom
21600 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21601 and @code{target("no-custom-@var{insn}")} function attributes
21602 (@pxref{Function Attributes})
21603 or pragmas (@pxref{Function Specific Option Pragmas}).
21605 @item -mcustom-fpu-cfg=@var{name}
21606 @opindex mcustom-fpu-cfg
21608 This option enables a predefined, named set of custom instruction encodings
21609 (see @option{-mcustom-@var{insn}} above).  
21610 Currently, the following sets are defined:
21612 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21613 @gccoptlist{-mcustom-fmuls=252 @gol
21614 -mcustom-fadds=253 @gol
21615 -mcustom-fsubs=254 @gol
21616 -fsingle-precision-constant}
21618 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21619 @gccoptlist{-mcustom-fmuls=252 @gol
21620 -mcustom-fadds=253 @gol
21621 -mcustom-fsubs=254 @gol
21622 -mcustom-fdivs=255 @gol
21623 -fsingle-precision-constant}
21625 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21626 @gccoptlist{-mcustom-floatus=243 @gol
21627 -mcustom-fixsi=244 @gol
21628 -mcustom-floatis=245 @gol
21629 -mcustom-fcmpgts=246 @gol
21630 -mcustom-fcmples=249 @gol
21631 -mcustom-fcmpeqs=250 @gol
21632 -mcustom-fcmpnes=251 @gol
21633 -mcustom-fmuls=252 @gol
21634 -mcustom-fadds=253 @gol
21635 -mcustom-fsubs=254 @gol
21636 -mcustom-fdivs=255 @gol
21637 -fsingle-precision-constant}
21639 Custom instruction assignments given by individual
21640 @option{-mcustom-@var{insn}=} options override those given by
21641 @option{-mcustom-fpu-cfg=}, regardless of the
21642 order of the options on the command line.
21644 Note that you can gain more local control over selection of a FPU
21645 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21646 function attribute (@pxref{Function Attributes})
21647 or pragma (@pxref{Function Specific Option Pragmas}).
21649 @end table
21651 These additional @samp{-m} options are available for the Altera Nios II
21652 ELF (bare-metal) target:
21654 @table @gcctabopt
21656 @item -mhal
21657 @opindex mhal
21658 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21659 startup and termination code, and is typically used in conjunction with
21660 @option{-msys-crt0=} to specify the location of the alternate startup code
21661 provided by the HAL BSP.
21663 @item -msmallc
21664 @opindex msmallc
21665 Link with a limited version of the C library, @option{-lsmallc}, rather than
21666 Newlib.
21668 @item -msys-crt0=@var{startfile}
21669 @opindex msys-crt0
21670 @var{startfile} is the file name of the startfile (crt0) to use 
21671 when linking.  This option is only useful in conjunction with @option{-mhal}.
21673 @item -msys-lib=@var{systemlib}
21674 @opindex msys-lib
21675 @var{systemlib} is the library name of the library that provides
21676 low-level system calls required by the C library,
21677 e.g. @code{read} and @code{write}.
21678 This option is typically used to link with a library provided by a HAL BSP.
21680 @end table
21682 @node Nvidia PTX Options
21683 @subsection Nvidia PTX Options
21684 @cindex Nvidia PTX options
21685 @cindex nvptx options
21687 These options are defined for Nvidia PTX:
21689 @table @gcctabopt
21691 @item -m32
21692 @itemx -m64
21693 @opindex m32
21694 @opindex m64
21695 Generate code for 32-bit or 64-bit ABI.
21697 @item -mmainkernel
21698 @opindex mmainkernel
21699 Link in code for a __main kernel.  This is for stand-alone instead of
21700 offloading execution.
21702 @item -moptimize
21703 @opindex moptimize
21704 Apply partitioned execution optimizations.  This is the default when any
21705 level of optimization is selected.
21707 @item -msoft-stack
21708 @opindex msoft-stack
21709 Generate code that does not use @code{.local} memory
21710 directly for stack storage. Instead, a per-warp stack pointer is
21711 maintained explicitly. This enables variable-length stack allocation (with
21712 variable-length arrays or @code{alloca}), and when global memory is used for
21713 underlying storage, makes it possible to access automatic variables from other
21714 threads, or with atomic instructions. This code generation variant is used
21715 for OpenMP offloading, but the option is exposed on its own for the purpose
21716 of testing the compiler; to generate code suitable for linking into programs
21717 using OpenMP offloading, use option @option{-mgomp}.
21719 @item -muniform-simt
21720 @opindex muniform-simt
21721 Switch to code generation variant that allows to execute all threads in each
21722 warp, while maintaining memory state and side effects as if only one thread
21723 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21724 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21725 current lane index equals the master lane index), and the register being
21726 assigned is copied via a shuffle instruction from the master lane.  Outside of
21727 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21728 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21729 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21730 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21731 with current lane index to compute the master lane index.
21733 @item -mgomp
21734 @opindex mgomp
21735 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21736 @option{-muniform-simt} options, and selects corresponding multilib variant.
21738 @end table
21740 @node PDP-11 Options
21741 @subsection PDP-11 Options
21742 @cindex PDP-11 Options
21744 These options are defined for the PDP-11:
21746 @table @gcctabopt
21747 @item -mfpu
21748 @opindex mfpu
21749 Use hardware FPP floating point.  This is the default.  (FIS floating
21750 point on the PDP-11/40 is not supported.)
21752 @item -msoft-float
21753 @opindex msoft-float
21754 Do not use hardware floating point.
21756 @item -mac0
21757 @opindex mac0
21758 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21760 @item -mno-ac0
21761 @opindex mno-ac0
21762 Return floating-point results in memory.  This is the default.
21764 @item -m40
21765 @opindex m40
21766 Generate code for a PDP-11/40.
21768 @item -m45
21769 @opindex m45
21770 Generate code for a PDP-11/45.  This is the default.
21772 @item -m10
21773 @opindex m10
21774 Generate code for a PDP-11/10.
21776 @item -mbcopy-builtin
21777 @opindex mbcopy-builtin
21778 Use inline @code{movmemhi} patterns for copying memory.  This is the
21779 default.
21781 @item -mbcopy
21782 @opindex mbcopy
21783 Do not use inline @code{movmemhi} patterns for copying memory.
21785 @item -mint16
21786 @itemx -mno-int32
21787 @opindex mint16
21788 @opindex mno-int32
21789 Use 16-bit @code{int}.  This is the default.
21791 @item -mint32
21792 @itemx -mno-int16
21793 @opindex mint32
21794 @opindex mno-int16
21795 Use 32-bit @code{int}.
21797 @item -mfloat64
21798 @itemx -mno-float32
21799 @opindex mfloat64
21800 @opindex mno-float32
21801 Use 64-bit @code{float}.  This is the default.
21803 @item -mfloat32
21804 @itemx -mno-float64
21805 @opindex mfloat32
21806 @opindex mno-float64
21807 Use 32-bit @code{float}.
21809 @item -mabshi
21810 @opindex mabshi
21811 Use @code{abshi2} pattern.  This is the default.
21813 @item -mno-abshi
21814 @opindex mno-abshi
21815 Do not use @code{abshi2} pattern.
21817 @item -mbranch-expensive
21818 @opindex mbranch-expensive
21819 Pretend that branches are expensive.  This is for experimenting with
21820 code generation only.
21822 @item -mbranch-cheap
21823 @opindex mbranch-cheap
21824 Do not pretend that branches are expensive.  This is the default.
21826 @item -munix-asm
21827 @opindex munix-asm
21828 Use Unix assembler syntax.  This is the default when configured for
21829 @samp{pdp11-*-bsd}.
21831 @item -mdec-asm
21832 @opindex mdec-asm
21833 Use DEC assembler syntax.  This is the default when configured for any
21834 PDP-11 target other than @samp{pdp11-*-bsd}.
21835 @end table
21837 @node picoChip Options
21838 @subsection picoChip Options
21839 @cindex picoChip options
21841 These @samp{-m} options are defined for picoChip implementations:
21843 @table @gcctabopt
21845 @item -mae=@var{ae_type}
21846 @opindex mcpu
21847 Set the instruction set, register set, and instruction scheduling
21848 parameters for array element type @var{ae_type}.  Supported values
21849 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21851 @option{-mae=ANY} selects a completely generic AE type.  Code
21852 generated with this option runs on any of the other AE types.  The
21853 code is not as efficient as it would be if compiled for a specific
21854 AE type, and some types of operation (e.g., multiplication) do not
21855 work properly on all types of AE.
21857 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21858 for compiled code, and is the default.
21860 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21861 option may suffer from poor performance of byte (char) manipulation,
21862 since the DSP AE does not provide hardware support for byte load/stores.
21864 @item -msymbol-as-address
21865 Enable the compiler to directly use a symbol name as an address in a
21866 load/store instruction, without first loading it into a
21867 register.  Typically, the use of this option generates larger
21868 programs, which run faster than when the option isn't used.  However, the
21869 results vary from program to program, so it is left as a user option,
21870 rather than being permanently enabled.
21872 @item -mno-inefficient-warnings
21873 Disables warnings about the generation of inefficient code.  These
21874 warnings can be generated, for example, when compiling code that
21875 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21876 no hardware support for byte-level memory operations, so all byte
21877 load/stores must be synthesized from word load/store operations.  This is
21878 inefficient and a warning is generated to indicate
21879 that you should rewrite the code to avoid byte operations, or to target
21880 an AE type that has the necessary hardware support.  This option disables
21881 these warnings.
21883 @end table
21885 @node PowerPC Options
21886 @subsection PowerPC Options
21887 @cindex PowerPC options
21889 These are listed under @xref{RS/6000 and PowerPC Options}.
21891 @node RISC-V Options
21892 @subsection RISC-V Options
21893 @cindex RISC-V Options
21895 These command-line options are defined for RISC-V targets:
21897 @table @gcctabopt
21898 @item -mbranch-cost=@var{n}
21899 @opindex mbranch-cost
21900 Set the cost of branches to roughly @var{n} instructions.
21902 @item -mplt
21903 @itemx -mno-plt
21904 @opindex plt
21905 When generating PIC code, do or don't allow the use of PLTs. Ignored for
21906 non-PIC.  The default is @option{-mplt}.
21908 @item -mabi=@var{ABI-string}
21909 @opindex mabi
21910 Specify integer and floating-point calling convention.  @var{ABI-string}
21911 contains two parts: the size of integer types and the registers used for
21912 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
21913 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
21914 32-bit), and that floating-point values up to 64 bits wide are passed in F
21915 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
21916 allows the compiler to generate code that uses the F and D extensions but only
21917 allows floating-point values up to 32 bits long to be passed in registers; or
21918 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
21919 passed in registers.
21921 The default for this argument is system dependent, users who want a specific
21922 calling convention should specify one explicitly.  The valid calling
21923 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
21924 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
21925 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
21926 invalid because the ABI requires 64-bit values be passed in F registers, but F
21927 registers are only 32 bits wide.
21929 @item -mfdiv
21930 @itemx -mno-fdiv
21931 @opindex mfdiv
21932 Do or don't use hardware floating-point divide and square root instructions.
21933 This requires the F or D extensions for floating-point registers.  The default
21934 is to use them if the specified architecture has these instructions.
21936 @item -mdiv
21937 @itemx -mno-div
21938 @opindex mdiv
21939 Do or don't use hardware instructions for integer division.  This requires the
21940 M extension.  The default is to use them if the specified architecture has
21941 these instructions.
21943 @item -march=@var{ISA-string}
21944 @opindex march
21945 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21946 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21948 @item -mtune=@var{processor-string}
21949 @opindex mtune
21950 Optimize the output for the given processor, specified by microarchitecture
21951 name.
21953 @item -msmall-data-limit=@var{n}
21954 @opindex msmall-data-limit
21955 Put global and static data smaller than @var{n} bytes into a special section
21956 (on some targets).
21958 @item -msave-restore
21959 @itemx -mno-save-restore
21960 @opindex msave-restore
21961 Do or don't use smaller but slower prologue and epilogue code that uses
21962 library function calls.  The default is to use fast inline prologues and
21963 epilogues.
21965 @item -mstrict-align
21966 @itemx -mno-strict-align
21967 @opindex mstrict-align
21968 Do not or do generate unaligned memory accesses.  The default is set depending
21969 on whether the processor we are optimizing for supports fast unaligned access
21970 or not.
21972 @item -mcmodel=medlow
21973 @opindex mcmodel=medlow
21974 Generate code for the medium-low code model. The program and its statically
21975 defined symbols must lie within a single 2 GiB address range and must lie
21976 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
21977 statically or dynamically linked. This is the default code model.
21979 @item -mcmodel=medany
21980 @opindex mcmodel=medany
21981 Generate code for the medium-any code model. The program and its statically
21982 defined symbols must be within any single 2 GiB address range. Programs can be
21983 statically or dynamically linked.
21985 @item -mexplicit-relocs
21986 @itemx -mno-exlicit-relocs
21987 Use or do not use assembler relocation operators when dealing with symbolic
21988 addresses.  The alternative is to use assembler macros instead, which may
21989 limit optimization.
21991 @end table
21993 @node RL78 Options
21994 @subsection RL78 Options
21995 @cindex RL78 Options
21997 @table @gcctabopt
21999 @item -msim
22000 @opindex msim
22001 Links in additional target libraries to support operation within a
22002 simulator.
22004 @item -mmul=none
22005 @itemx -mmul=g10
22006 @itemx -mmul=g13
22007 @itemx -mmul=g14
22008 @itemx -mmul=rl78
22009 @opindex mmul
22010 Specifies the type of hardware multiplication and division support to
22011 be used.  The simplest is @code{none}, which uses software for both
22012 multiplication and division.  This is the default.  The @code{g13}
22013 value is for the hardware multiply/divide peripheral found on the
22014 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
22015 the multiplication and division instructions supported by the RL78/G14
22016 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
22017 the value @code{mg10} is an alias for @code{none}.
22019 In addition a C preprocessor macro is defined, based upon the setting
22020 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
22021 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
22023 @item -mcpu=g10
22024 @itemx -mcpu=g13
22025 @itemx -mcpu=g14
22026 @itemx -mcpu=rl78
22027 @opindex mcpu
22028 Specifies the RL78 core to target.  The default is the G14 core, also
22029 known as an S3 core or just RL78.  The G13 or S2 core does not have
22030 multiply or divide instructions, instead it uses a hardware peripheral
22031 for these operations.  The G10 or S1 core does not have register
22032 banks, so it uses a different calling convention.
22034 If this option is set it also selects the type of hardware multiply
22035 support to use, unless this is overridden by an explicit
22036 @option{-mmul=none} option on the command line.  Thus specifying
22037 @option{-mcpu=g13} enables the use of the G13 hardware multiply
22038 peripheral and specifying @option{-mcpu=g10} disables the use of
22039 hardware multiplications altogether.
22041 Note, although the RL78/G14 core is the default target, specifying
22042 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
22043 change the behavior of the toolchain since it also enables G14
22044 hardware multiply support.  If these options are not specified on the
22045 command line then software multiplication routines will be used even
22046 though the code targets the RL78 core.  This is for backwards
22047 compatibility with older toolchains which did not have hardware
22048 multiply and divide support.
22050 In addition a C preprocessor macro is defined, based upon the setting
22051 of this option.  Possible values are: @code{__RL78_G10__},
22052 @code{__RL78_G13__} or @code{__RL78_G14__}.
22054 @item -mg10
22055 @itemx -mg13
22056 @itemx -mg14
22057 @itemx -mrl78
22058 @opindex mg10
22059 @opindex mg13
22060 @opindex mg14
22061 @opindex mrl78
22062 These are aliases for the corresponding @option{-mcpu=} option.  They
22063 are provided for backwards compatibility.
22065 @item -mallregs
22066 @opindex mallregs
22067 Allow the compiler to use all of the available registers.  By default
22068 registers @code{r24..r31} are reserved for use in interrupt handlers.
22069 With this option enabled these registers can be used in ordinary
22070 functions as well.
22072 @item -m64bit-doubles
22073 @itemx -m32bit-doubles
22074 @opindex m64bit-doubles
22075 @opindex m32bit-doubles
22076 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22077 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22078 @option{-m32bit-doubles}.
22080 @item -msave-mduc-in-interrupts
22081 @item -mno-save-mduc-in-interrupts
22082 @opindex msave-mduc-in-interrupts
22083 @opindex mno-save-mduc-in-interrupts
22084 Specifies that interrupt handler functions should preserve the
22085 MDUC registers.  This is only necessary if normal code might use
22086 the MDUC registers, for example because it performs multiplication
22087 and division operations.  The default is to ignore the MDUC registers
22088 as this makes the interrupt handlers faster.  The target option -mg13
22089 needs to be passed for this to work as this feature is only available
22090 on the G13 target (S2 core).  The MDUC registers will only be saved
22091 if the interrupt handler performs a multiplication or division
22092 operation or it calls another function.
22094 @end table
22096 @node RS/6000 and PowerPC Options
22097 @subsection IBM RS/6000 and PowerPC Options
22098 @cindex RS/6000 and PowerPC Options
22099 @cindex IBM RS/6000 and PowerPC Options
22101 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22102 @table @gcctabopt
22103 @item -mpowerpc-gpopt
22104 @itemx -mno-powerpc-gpopt
22105 @itemx -mpowerpc-gfxopt
22106 @itemx -mno-powerpc-gfxopt
22107 @need 800
22108 @itemx -mpowerpc64
22109 @itemx -mno-powerpc64
22110 @itemx -mmfcrf
22111 @itemx -mno-mfcrf
22112 @itemx -mpopcntb
22113 @itemx -mno-popcntb
22114 @itemx -mpopcntd
22115 @itemx -mno-popcntd
22116 @itemx -mfprnd
22117 @itemx -mno-fprnd
22118 @need 800
22119 @itemx -mcmpb
22120 @itemx -mno-cmpb
22121 @itemx -mmfpgpr
22122 @itemx -mno-mfpgpr
22123 @itemx -mhard-dfp
22124 @itemx -mno-hard-dfp
22125 @opindex mpowerpc-gpopt
22126 @opindex mno-powerpc-gpopt
22127 @opindex mpowerpc-gfxopt
22128 @opindex mno-powerpc-gfxopt
22129 @opindex mpowerpc64
22130 @opindex mno-powerpc64
22131 @opindex mmfcrf
22132 @opindex mno-mfcrf
22133 @opindex mpopcntb
22134 @opindex mno-popcntb
22135 @opindex mpopcntd
22136 @opindex mno-popcntd
22137 @opindex mfprnd
22138 @opindex mno-fprnd
22139 @opindex mcmpb
22140 @opindex mno-cmpb
22141 @opindex mmfpgpr
22142 @opindex mno-mfpgpr
22143 @opindex mhard-dfp
22144 @opindex mno-hard-dfp
22145 You use these options to specify which instructions are available on the
22146 processor you are using.  The default value of these options is
22147 determined when configuring GCC@.  Specifying the
22148 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22149 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22150 rather than the options listed above.
22152 Specifying @option{-mpowerpc-gpopt} allows
22153 GCC to use the optional PowerPC architecture instructions in the
22154 General Purpose group, including floating-point square root.  Specifying
22155 @option{-mpowerpc-gfxopt} allows GCC to
22156 use the optional PowerPC architecture instructions in the Graphics
22157 group, including floating-point select.
22159 The @option{-mmfcrf} option allows GCC to generate the move from
22160 condition register field instruction implemented on the POWER4
22161 processor and other processors that support the PowerPC V2.01
22162 architecture.
22163 The @option{-mpopcntb} option allows GCC to generate the popcount and
22164 double-precision FP reciprocal estimate instruction implemented on the
22165 POWER5 processor and other processors that support the PowerPC V2.02
22166 architecture.
22167 The @option{-mpopcntd} option allows GCC to generate the popcount
22168 instruction implemented on the POWER7 processor and other processors
22169 that support the PowerPC V2.06 architecture.
22170 The @option{-mfprnd} option allows GCC to generate the FP round to
22171 integer instructions implemented on the POWER5+ processor and other
22172 processors that support the PowerPC V2.03 architecture.
22173 The @option{-mcmpb} option allows GCC to generate the compare bytes
22174 instruction implemented on the POWER6 processor and other processors
22175 that support the PowerPC V2.05 architecture.
22176 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22177 general-purpose register instructions implemented on the POWER6X
22178 processor and other processors that support the extended PowerPC V2.05
22179 architecture.
22180 The @option{-mhard-dfp} option allows GCC to generate the decimal
22181 floating-point instructions implemented on some POWER processors.
22183 The @option{-mpowerpc64} option allows GCC to generate the additional
22184 64-bit instructions that are found in the full PowerPC64 architecture
22185 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22186 @option{-mno-powerpc64}.
22188 @item -mcpu=@var{cpu_type}
22189 @opindex mcpu
22190 Set architecture type, register usage, and
22191 instruction scheduling parameters for machine type @var{cpu_type}.
22192 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22193 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22194 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22195 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22196 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22197 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22198 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22199 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22200 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22201 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22202 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22203 and @samp{rs64}.
22205 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22206 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22207 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22208 architecture machine types, with an appropriate, generic processor
22209 model assumed for scheduling purposes.
22211 The other options specify a specific processor.  Code generated under
22212 those options runs best on that processor, and may not run at all on
22213 others.
22215 The @option{-mcpu} options automatically enable or disable the
22216 following options:
22218 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22219 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22220 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22221 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22222 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22223 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22225 The particular options set for any particular CPU varies between
22226 compiler versions, depending on what setting seems to produce optimal
22227 code for that CPU; it doesn't necessarily reflect the actual hardware's
22228 capabilities.  If you wish to set an individual option to a particular
22229 value, you may specify it after the @option{-mcpu} option, like
22230 @option{-mcpu=970 -mno-altivec}.
22232 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22233 not enabled or disabled by the @option{-mcpu} option at present because
22234 AIX does not have full support for these options.  You may still
22235 enable or disable them individually if you're sure it'll work in your
22236 environment.
22238 @item -mtune=@var{cpu_type}
22239 @opindex mtune
22240 Set the instruction scheduling parameters for machine type
22241 @var{cpu_type}, but do not set the architecture type or register usage,
22242 as @option{-mcpu=@var{cpu_type}} does.  The same
22243 values for @var{cpu_type} are used for @option{-mtune} as for
22244 @option{-mcpu}.  If both are specified, the code generated uses the
22245 architecture and registers set by @option{-mcpu}, but the
22246 scheduling parameters set by @option{-mtune}.
22248 @item -mcmodel=small
22249 @opindex mcmodel=small
22250 Generate PowerPC64 code for the small model: The TOC is limited to
22251 64k.
22253 @item -mcmodel=medium
22254 @opindex mcmodel=medium
22255 Generate PowerPC64 code for the medium model: The TOC and other static
22256 data may be up to a total of 4G in size.  This is the default for 64-bit
22257 Linux.
22259 @item -mcmodel=large
22260 @opindex mcmodel=large
22261 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22262 in size.  Other data and code is only limited by the 64-bit address
22263 space.
22265 @item -maltivec
22266 @itemx -mno-altivec
22267 @opindex maltivec
22268 @opindex mno-altivec
22269 Generate code that uses (does not use) AltiVec instructions, and also
22270 enable the use of built-in functions that allow more direct access to
22271 the AltiVec instruction set.  You may also need to set
22272 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22273 enhancements.
22275 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22276 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22277 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22278 match array element order corresponding to the endianness of the
22279 target.  That is, element zero identifies the leftmost element in a
22280 vector register when targeting a big-endian platform, and identifies
22281 the rightmost element in a vector register when targeting a
22282 little-endian platform.
22284 @item -maltivec=be
22285 @opindex maltivec=be
22286 Generate AltiVec instructions using big-endian element order,
22287 regardless of whether the target is big- or little-endian.  This is
22288 the default when targeting a big-endian platform.
22290 The element order is used to interpret element numbers in AltiVec
22291 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22292 @code{vec_insert}.  By default, these match array element order
22293 corresponding to the endianness for the target.
22295 @item -maltivec=le
22296 @opindex maltivec=le
22297 Generate AltiVec instructions using little-endian element order,
22298 regardless of whether the target is big- or little-endian.  This is
22299 the default when targeting a little-endian platform.  This option is
22300 currently ignored when targeting a big-endian platform.
22302 The element order is used to interpret element numbers in AltiVec
22303 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22304 @code{vec_insert}.  By default, these match array element order
22305 corresponding to the endianness for the target.
22307 @item -mvrsave
22308 @itemx -mno-vrsave
22309 @opindex mvrsave
22310 @opindex mno-vrsave
22311 Generate VRSAVE instructions when generating AltiVec code.
22313 @item -msecure-plt
22314 @opindex msecure-plt
22315 Generate code that allows @command{ld} and @command{ld.so}
22316 to build executables and shared
22317 libraries with non-executable @code{.plt} and @code{.got} sections.
22318 This is a PowerPC
22319 32-bit SYSV ABI option.
22321 @item -mbss-plt
22322 @opindex mbss-plt
22323 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22324 fills in, and
22325 requires @code{.plt} and @code{.got}
22326 sections that are both writable and executable.
22327 This is a PowerPC 32-bit SYSV ABI option.
22329 @item -misel
22330 @itemx -mno-isel
22331 @opindex misel
22332 @opindex mno-isel
22333 This switch enables or disables the generation of ISEL instructions.
22335 @item -misel=@var{yes/no}
22336 This switch has been deprecated.  Use @option{-misel} and
22337 @option{-mno-isel} instead.
22339 @item -mspe
22340 @itemx -mno-spe
22341 @opindex mspe
22342 @opindex mno-spe
22343 This switch enables or disables the generation of SPE simd
22344 instructions.
22346 @item -mpaired
22347 @itemx -mno-paired
22348 @opindex mpaired
22349 @opindex mno-paired
22350 This switch enables or disables the generation of PAIRED simd
22351 instructions.
22353 @item -mspe=@var{yes/no}
22354 This option has been deprecated.  Use @option{-mspe} and
22355 @option{-mno-spe} instead.
22357 @item -mvsx
22358 @itemx -mno-vsx
22359 @opindex mvsx
22360 @opindex mno-vsx
22361 Generate code that uses (does not use) vector/scalar (VSX)
22362 instructions, and also enable the use of built-in functions that allow
22363 more direct access to the VSX instruction set.
22365 @item -mcrypto
22366 @itemx -mno-crypto
22367 @opindex mcrypto
22368 @opindex mno-crypto
22369 Enable the use (disable) of the built-in functions that allow direct
22370 access to the cryptographic instructions that were added in version
22371 2.07 of the PowerPC ISA.
22373 @item -mdirect-move
22374 @itemx -mno-direct-move
22375 @opindex mdirect-move
22376 @opindex mno-direct-move
22377 Generate code that uses (does not use) the instructions to move data
22378 between the general purpose registers and the vector/scalar (VSX)
22379 registers that were added in version 2.07 of the PowerPC ISA.
22381 @item -mhtm
22382 @itemx -mno-htm
22383 @opindex mhtm
22384 @opindex mno-htm
22385 Enable (disable) the use of the built-in functions that allow direct
22386 access to the Hardware Transactional Memory (HTM) instructions that
22387 were added in version 2.07 of the PowerPC ISA.
22389 @item -mpower8-fusion
22390 @itemx -mno-power8-fusion
22391 @opindex mpower8-fusion
22392 @opindex mno-power8-fusion
22393 Generate code that keeps (does not keeps) some integer operations
22394 adjacent so that the instructions can be fused together on power8 and
22395 later processors.
22397 @item -mpower8-vector
22398 @itemx -mno-power8-vector
22399 @opindex mpower8-vector
22400 @opindex mno-power8-vector
22401 Generate code that uses (does not use) the vector and scalar
22402 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22403 enable the use of built-in functions that allow more direct access to
22404 the vector instructions.
22406 @item -mquad-memory
22407 @itemx -mno-quad-memory
22408 @opindex mquad-memory
22409 @opindex mno-quad-memory
22410 Generate code that uses (does not use) the non-atomic quad word memory
22411 instructions.  The @option{-mquad-memory} option requires use of
22412 64-bit mode.
22414 @item -mquad-memory-atomic
22415 @itemx -mno-quad-memory-atomic
22416 @opindex mquad-memory-atomic
22417 @opindex mno-quad-memory-atomic
22418 Generate code that uses (does not use) the atomic quad word memory
22419 instructions.  The @option{-mquad-memory-atomic} option requires use of
22420 64-bit mode.
22422 @item -mfloat128
22423 @itemx -mno-float128
22424 @opindex mfloat128
22425 @opindex mno-float128
22426 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22427 and use either software emulation for IEEE 128-bit floating point or
22428 hardware instructions.
22430 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22431 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22432 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22433 floating point support only works on PowerPC Linux systems.
22435 The default for @option{-mfloat128} is enabled on PowerPC Linux
22436 systems using the VSX instruction set, and disabled on other systems.
22438 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22439 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22440 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22441 floating point instructions.  Otherwise, if you do not specify to
22442 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22443 system, IEEE 128-bit floating point will be done with software
22444 emulation.
22446 @item -mfloat128-hardware
22447 @itemx -mno-float128-hardware
22448 @opindex mfloat128-hardware
22449 @opindex mno-float128-hardware
22450 Enable/disable using ISA 3.0 hardware instructions to support the
22451 @var{__float128} data type.
22453 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22454 Linux systems using the ISA 3.0 instruction set, and disabled on other
22455 systems.
22457 @item -mfloat-gprs=@var{yes/single/double/no}
22458 @itemx -mfloat-gprs
22459 @opindex mfloat-gprs
22460 This switch enables or disables the generation of floating-point
22461 operations on the general-purpose registers for architectures that
22462 support it.
22464 The argument @samp{yes} or @samp{single} enables the use of
22465 single-precision floating-point operations.
22467 The argument @samp{double} enables the use of single and
22468 double-precision floating-point operations.
22470 The argument @samp{no} disables floating-point operations on the
22471 general-purpose registers.
22473 This option is currently only available on the MPC854x.
22475 @item -m32
22476 @itemx -m64
22477 @opindex m32
22478 @opindex m64
22479 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22480 targets (including GNU/Linux).  The 32-bit environment sets int, long
22481 and pointer to 32 bits and generates code that runs on any PowerPC
22482 variant.  The 64-bit environment sets int to 32 bits and long and
22483 pointer to 64 bits, and generates code for PowerPC64, as for
22484 @option{-mpowerpc64}.
22486 @item -mfull-toc
22487 @itemx -mno-fp-in-toc
22488 @itemx -mno-sum-in-toc
22489 @itemx -mminimal-toc
22490 @opindex mfull-toc
22491 @opindex mno-fp-in-toc
22492 @opindex mno-sum-in-toc
22493 @opindex mminimal-toc
22494 Modify generation of the TOC (Table Of Contents), which is created for
22495 every executable file.  The @option{-mfull-toc} option is selected by
22496 default.  In that case, GCC allocates at least one TOC entry for
22497 each unique non-automatic variable reference in your program.  GCC
22498 also places floating-point constants in the TOC@.  However, only
22499 16,384 entries are available in the TOC@.
22501 If you receive a linker error message that saying you have overflowed
22502 the available TOC space, you can reduce the amount of TOC space used
22503 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22504 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22505 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22506 generate code to calculate the sum of an address and a constant at
22507 run time instead of putting that sum into the TOC@.  You may specify one
22508 or both of these options.  Each causes GCC to produce very slightly
22509 slower and larger code at the expense of conserving TOC space.
22511 If you still run out of space in the TOC even when you specify both of
22512 these options, specify @option{-mminimal-toc} instead.  This option causes
22513 GCC to make only one TOC entry for every file.  When you specify this
22514 option, GCC produces code that is slower and larger but which
22515 uses extremely little TOC space.  You may wish to use this option
22516 only on files that contain less frequently-executed code.
22518 @item -maix64
22519 @itemx -maix32
22520 @opindex maix64
22521 @opindex maix32
22522 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22523 @code{long} type, and the infrastructure needed to support them.
22524 Specifying @option{-maix64} implies @option{-mpowerpc64},
22525 while @option{-maix32} disables the 64-bit ABI and
22526 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22528 @item -mxl-compat
22529 @itemx -mno-xl-compat
22530 @opindex mxl-compat
22531 @opindex mno-xl-compat
22532 Produce code that conforms more closely to IBM XL compiler semantics
22533 when using AIX-compatible ABI@.  Pass floating-point arguments to
22534 prototyped functions beyond the register save area (RSA) on the stack
22535 in addition to argument FPRs.  Do not assume that most significant
22536 double in 128-bit long double value is properly rounded when comparing
22537 values and converting to double.  Use XL symbol names for long double
22538 support routines.
22540 The AIX calling convention was extended but not initially documented to
22541 handle an obscure K&R C case of calling a function that takes the
22542 address of its arguments with fewer arguments than declared.  IBM XL
22543 compilers access floating-point arguments that do not fit in the
22544 RSA from the stack when a subroutine is compiled without
22545 optimization.  Because always storing floating-point arguments on the
22546 stack is inefficient and rarely needed, this option is not enabled by
22547 default and only is necessary when calling subroutines compiled by IBM
22548 XL compilers without optimization.
22550 @item -mpe
22551 @opindex mpe
22552 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22553 application written to use message passing with special startup code to
22554 enable the application to run.  The system must have PE installed in the
22555 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22556 must be overridden with the @option{-specs=} option to specify the
22557 appropriate directory location.  The Parallel Environment does not
22558 support threads, so the @option{-mpe} option and the @option{-pthread}
22559 option are incompatible.
22561 @item -malign-natural
22562 @itemx -malign-power
22563 @opindex malign-natural
22564 @opindex malign-power
22565 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22566 @option{-malign-natural} overrides the ABI-defined alignment of larger
22567 types, such as floating-point doubles, on their natural size-based boundary.
22568 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22569 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22571 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22572 is not supported.
22574 @item -msoft-float
22575 @itemx -mhard-float
22576 @opindex msoft-float
22577 @opindex mhard-float
22578 Generate code that does not use (uses) the floating-point register set.
22579 Software floating-point emulation is provided if you use the
22580 @option{-msoft-float} option, and pass the option to GCC when linking.
22582 @item -msingle-float
22583 @itemx -mdouble-float
22584 @opindex msingle-float
22585 @opindex mdouble-float
22586 Generate code for single- or double-precision floating-point operations.
22587 @option{-mdouble-float} implies @option{-msingle-float}.
22589 @item -msimple-fpu
22590 @opindex msimple-fpu
22591 Do not generate @code{sqrt} and @code{div} instructions for hardware
22592 floating-point unit.
22594 @item -mfpu=@var{name}
22595 @opindex mfpu
22596 Specify type of floating-point unit.  Valid values for @var{name} are
22597 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22598 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22599 @samp{sp_full} (equivalent to @option{-msingle-float}),
22600 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22602 @item -mxilinx-fpu
22603 @opindex mxilinx-fpu
22604 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22606 @item -mmultiple
22607 @itemx -mno-multiple
22608 @opindex mmultiple
22609 @opindex mno-multiple
22610 Generate code that uses (does not use) the load multiple word
22611 instructions and the store multiple word instructions.  These
22612 instructions are generated by default on POWER systems, and not
22613 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22614 PowerPC systems, since those instructions do not work when the
22615 processor is in little-endian mode.  The exceptions are PPC740 and
22616 PPC750 which permit these instructions in little-endian mode.
22618 @item -mstring
22619 @itemx -mno-string
22620 @opindex mstring
22621 @opindex mno-string
22622 Generate code that uses (does not use) the load string instructions
22623 and the store string word instructions to save multiple registers and
22624 do small block moves.  These instructions are generated by default on
22625 POWER systems, and not generated on PowerPC systems.  Do not use
22626 @option{-mstring} on little-endian PowerPC systems, since those
22627 instructions do not work when the processor is in little-endian mode.
22628 The exceptions are PPC740 and PPC750 which permit these instructions
22629 in little-endian mode.
22631 @item -mupdate
22632 @itemx -mno-update
22633 @opindex mupdate
22634 @opindex mno-update
22635 Generate code that uses (does not use) the load or store instructions
22636 that update the base register to the address of the calculated memory
22637 location.  These instructions are generated by default.  If you use
22638 @option{-mno-update}, there is a small window between the time that the
22639 stack pointer is updated and the address of the previous frame is
22640 stored, which means code that walks the stack frame across interrupts or
22641 signals may get corrupted data.
22643 @item -mavoid-indexed-addresses
22644 @itemx -mno-avoid-indexed-addresses
22645 @opindex mavoid-indexed-addresses
22646 @opindex mno-avoid-indexed-addresses
22647 Generate code that tries to avoid (not avoid) the use of indexed load
22648 or store instructions. These instructions can incur a performance
22649 penalty on Power6 processors in certain situations, such as when
22650 stepping through large arrays that cross a 16M boundary.  This option
22651 is enabled by default when targeting Power6 and disabled otherwise.
22653 @item -mfused-madd
22654 @itemx -mno-fused-madd
22655 @opindex mfused-madd
22656 @opindex mno-fused-madd
22657 Generate code that uses (does not use) the floating-point multiply and
22658 accumulate instructions.  These instructions are generated by default
22659 if hardware floating point is used.  The machine-dependent
22660 @option{-mfused-madd} option is now mapped to the machine-independent
22661 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22662 mapped to @option{-ffp-contract=off}.
22664 @item -mmulhw
22665 @itemx -mno-mulhw
22666 @opindex mmulhw
22667 @opindex mno-mulhw
22668 Generate code that uses (does not use) the half-word multiply and
22669 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22670 These instructions are generated by default when targeting those
22671 processors.
22673 @item -mdlmzb
22674 @itemx -mno-dlmzb
22675 @opindex mdlmzb
22676 @opindex mno-dlmzb
22677 Generate code that uses (does not use) the string-search @samp{dlmzb}
22678 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22679 generated by default when targeting those processors.
22681 @item -mno-bit-align
22682 @itemx -mbit-align
22683 @opindex mno-bit-align
22684 @opindex mbit-align
22685 On System V.4 and embedded PowerPC systems do not (do) force structures
22686 and unions that contain bit-fields to be aligned to the base type of the
22687 bit-field.
22689 For example, by default a structure containing nothing but 8
22690 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22691 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22692 the structure is aligned to a 1-byte boundary and is 1 byte in
22693 size.
22695 @item -mno-strict-align
22696 @itemx -mstrict-align
22697 @opindex mno-strict-align
22698 @opindex mstrict-align
22699 On System V.4 and embedded PowerPC systems do not (do) assume that
22700 unaligned memory references are handled by the system.
22702 @item -mrelocatable
22703 @itemx -mno-relocatable
22704 @opindex mrelocatable
22705 @opindex mno-relocatable
22706 Generate code that allows (does not allow) a static executable to be
22707 relocated to a different address at run time.  A simple embedded
22708 PowerPC system loader should relocate the entire contents of
22709 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22710 a table of 32-bit addresses generated by this option.  For this to
22711 work, all objects linked together must be compiled with
22712 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22713 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22715 @item -mrelocatable-lib
22716 @itemx -mno-relocatable-lib
22717 @opindex mrelocatable-lib
22718 @opindex mno-relocatable-lib
22719 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22720 @code{.fixup} section to allow static executables to be relocated at
22721 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22722 alignment of @option{-mrelocatable}.  Objects compiled with
22723 @option{-mrelocatable-lib} may be linked with objects compiled with
22724 any combination of the @option{-mrelocatable} options.
22726 @item -mno-toc
22727 @itemx -mtoc
22728 @opindex mno-toc
22729 @opindex mtoc
22730 On System V.4 and embedded PowerPC systems do not (do) assume that
22731 register 2 contains a pointer to a global area pointing to the addresses
22732 used in the program.
22734 @item -mlittle
22735 @itemx -mlittle-endian
22736 @opindex mlittle
22737 @opindex mlittle-endian
22738 On System V.4 and embedded PowerPC systems compile code for the
22739 processor in little-endian mode.  The @option{-mlittle-endian} option is
22740 the same as @option{-mlittle}.
22742 @item -mbig
22743 @itemx -mbig-endian
22744 @opindex mbig
22745 @opindex mbig-endian
22746 On System V.4 and embedded PowerPC systems compile code for the
22747 processor in big-endian mode.  The @option{-mbig-endian} option is
22748 the same as @option{-mbig}.
22750 @item -mdynamic-no-pic
22751 @opindex mdynamic-no-pic
22752 On Darwin and Mac OS X systems, compile code so that it is not
22753 relocatable, but that its external references are relocatable.  The
22754 resulting code is suitable for applications, but not shared
22755 libraries.
22757 @item -msingle-pic-base
22758 @opindex msingle-pic-base
22759 Treat the register used for PIC addressing as read-only, rather than
22760 loading it in the prologue for each function.  The runtime system is
22761 responsible for initializing this register with an appropriate value
22762 before execution begins.
22764 @item -mprioritize-restricted-insns=@var{priority}
22765 @opindex mprioritize-restricted-insns
22766 This option controls the priority that is assigned to
22767 dispatch-slot restricted instructions during the second scheduling
22768 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22769 or @samp{2} to assign no, highest, or second-highest (respectively) 
22770 priority to dispatch-slot restricted
22771 instructions.
22773 @item -msched-costly-dep=@var{dependence_type}
22774 @opindex msched-costly-dep
22775 This option controls which dependences are considered costly
22776 by the target during instruction scheduling.  The argument
22777 @var{dependence_type} takes one of the following values:
22779 @table @asis
22780 @item @samp{no}
22781 No dependence is costly.
22783 @item @samp{all}
22784 All dependences are costly.
22786 @item @samp{true_store_to_load}
22787 A true dependence from store to load is costly.
22789 @item @samp{store_to_load}
22790 Any dependence from store to load is costly.
22792 @item @var{number}
22793 Any dependence for which the latency is greater than or equal to 
22794 @var{number} is costly.
22795 @end table
22797 @item -minsert-sched-nops=@var{scheme}
22798 @opindex minsert-sched-nops
22799 This option controls which NOP insertion scheme is used during
22800 the second scheduling pass.  The argument @var{scheme} takes one of the
22801 following values:
22803 @table @asis
22804 @item @samp{no}
22805 Don't insert NOPs.
22807 @item @samp{pad}
22808 Pad with NOPs any dispatch group that has vacant issue slots,
22809 according to the scheduler's grouping.
22811 @item @samp{regroup_exact}
22812 Insert NOPs to force costly dependent insns into
22813 separate groups.  Insert exactly as many NOPs as needed to force an insn
22814 to a new group, according to the estimated processor grouping.
22816 @item @var{number}
22817 Insert NOPs to force costly dependent insns into
22818 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22819 @end table
22821 @item -mcall-sysv
22822 @opindex mcall-sysv
22823 On System V.4 and embedded PowerPC systems compile code using calling
22824 conventions that adhere to the March 1995 draft of the System V
22825 Application Binary Interface, PowerPC processor supplement.  This is the
22826 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22828 @item -mcall-sysv-eabi
22829 @itemx -mcall-eabi
22830 @opindex mcall-sysv-eabi
22831 @opindex mcall-eabi
22832 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22834 @item -mcall-sysv-noeabi
22835 @opindex mcall-sysv-noeabi
22836 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22838 @item -mcall-aixdesc
22839 @opindex m
22840 On System V.4 and embedded PowerPC systems compile code for the AIX
22841 operating system.
22843 @item -mcall-linux
22844 @opindex mcall-linux
22845 On System V.4 and embedded PowerPC systems compile code for the
22846 Linux-based GNU system.
22848 @item -mcall-freebsd
22849 @opindex mcall-freebsd
22850 On System V.4 and embedded PowerPC systems compile code for the
22851 FreeBSD operating system.
22853 @item -mcall-netbsd
22854 @opindex mcall-netbsd
22855 On System V.4 and embedded PowerPC systems compile code for the
22856 NetBSD operating system.
22858 @item -mcall-openbsd
22859 @opindex mcall-netbsd
22860 On System V.4 and embedded PowerPC systems compile code for the
22861 OpenBSD operating system.
22863 @item -maix-struct-return
22864 @opindex maix-struct-return
22865 Return all structures in memory (as specified by the AIX ABI)@.
22867 @item -msvr4-struct-return
22868 @opindex msvr4-struct-return
22869 Return structures smaller than 8 bytes in registers (as specified by the
22870 SVR4 ABI)@.
22872 @item -mabi=@var{abi-type}
22873 @opindex mabi
22874 Extend the current ABI with a particular extension, or remove such extension.
22875 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22876 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22877 @samp{elfv1}, @samp{elfv2}@.
22879 @item -mabi=spe
22880 @opindex mabi=spe
22881 Extend the current ABI with SPE ABI extensions.  This does not change
22882 the default ABI, instead it adds the SPE ABI extensions to the current
22883 ABI@.
22885 @item -mabi=no-spe
22886 @opindex mabi=no-spe
22887 Disable Book-E SPE ABI extensions for the current ABI@.
22889 @item -mabi=ibmlongdouble
22890 @opindex mabi=ibmlongdouble
22891 Change the current ABI to use IBM extended-precision long double.
22892 This is not likely to work if your system defaults to using IEEE
22893 extended-precision long double.  If you change the long double type
22894 from IEEE extended-precision, the compiler will issue a warning unless
22895 you use the @option{-Wno-psabi} option.
22897 @item -mabi=ieeelongdouble
22898 @opindex mabi=ieeelongdouble
22899 Change the current ABI to use IEEE extended-precision long double.
22900 This is not likely to work if your system defaults to using IBM
22901 extended-precision long double.  If you change the long double type
22902 from IBM extended-precision, the compiler will issue a warning unless
22903 you use the @option{-Wno-psabi} option.
22905 @item -mabi=elfv1
22906 @opindex mabi=elfv1
22907 Change the current ABI to use the ELFv1 ABI.
22908 This is the default ABI for big-endian PowerPC 64-bit Linux.
22909 Overriding the default ABI requires special system support and is
22910 likely to fail in spectacular ways.
22912 @item -mabi=elfv2
22913 @opindex mabi=elfv2
22914 Change the current ABI to use the ELFv2 ABI.
22915 This is the default ABI for little-endian PowerPC 64-bit Linux.
22916 Overriding the default ABI requires special system support and is
22917 likely to fail in spectacular ways.
22919 @item -mgnu-attribute
22920 @itemx -mno-gnu-attribute
22921 @opindex mgnu-attribute
22922 @opindex mno-gnu-attribute
22923 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22924 .gnu.attributes section that specify ABI variations in function
22925 parameters or return values.
22927 @item -mprototype
22928 @itemx -mno-prototype
22929 @opindex mprototype
22930 @opindex mno-prototype
22931 On System V.4 and embedded PowerPC systems assume that all calls to
22932 variable argument functions are properly prototyped.  Otherwise, the
22933 compiler must insert an instruction before every non-prototyped call to
22934 set or clear bit 6 of the condition code register (@code{CR}) to
22935 indicate whether floating-point values are passed in the floating-point
22936 registers in case the function takes variable arguments.  With
22937 @option{-mprototype}, only calls to prototyped variable argument functions
22938 set or clear the bit.
22940 @item -msim
22941 @opindex msim
22942 On embedded PowerPC systems, assume that the startup module is called
22943 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22944 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22945 configurations.
22947 @item -mmvme
22948 @opindex mmvme
22949 On embedded PowerPC systems, assume that the startup module is called
22950 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22951 @file{libc.a}.
22953 @item -mads
22954 @opindex mads
22955 On embedded PowerPC systems, assume that the startup module is called
22956 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22957 @file{libc.a}.
22959 @item -myellowknife
22960 @opindex myellowknife
22961 On embedded PowerPC systems, assume that the startup module is called
22962 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22963 @file{libc.a}.
22965 @item -mvxworks
22966 @opindex mvxworks
22967 On System V.4 and embedded PowerPC systems, specify that you are
22968 compiling for a VxWorks system.
22970 @item -memb
22971 @opindex memb
22972 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22973 header to indicate that @samp{eabi} extended relocations are used.
22975 @item -meabi
22976 @itemx -mno-eabi
22977 @opindex meabi
22978 @opindex mno-eabi
22979 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22980 Embedded Applications Binary Interface (EABI), which is a set of
22981 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22982 means that the stack is aligned to an 8-byte boundary, a function
22983 @code{__eabi} is called from @code{main} to set up the EABI
22984 environment, and the @option{-msdata} option can use both @code{r2} and
22985 @code{r13} to point to two separate small data areas.  Selecting
22986 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22987 no EABI initialization function is called from @code{main}, and the
22988 @option{-msdata} option only uses @code{r13} to point to a single
22989 small data area.  The @option{-meabi} option is on by default if you
22990 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22992 @item -msdata=eabi
22993 @opindex msdata=eabi
22994 On System V.4 and embedded PowerPC systems, put small initialized
22995 @code{const} global and static data in the @code{.sdata2} section, which
22996 is pointed to by register @code{r2}.  Put small initialized
22997 non-@code{const} global and static data in the @code{.sdata} section,
22998 which is pointed to by register @code{r13}.  Put small uninitialized
22999 global and static data in the @code{.sbss} section, which is adjacent to
23000 the @code{.sdata} section.  The @option{-msdata=eabi} option is
23001 incompatible with the @option{-mrelocatable} option.  The
23002 @option{-msdata=eabi} option also sets the @option{-memb} option.
23004 @item -msdata=sysv
23005 @opindex msdata=sysv
23006 On System V.4 and embedded PowerPC systems, put small global and static
23007 data in the @code{.sdata} section, which is pointed to by register
23008 @code{r13}.  Put small uninitialized global and static data in the
23009 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
23010 The @option{-msdata=sysv} option is incompatible with the
23011 @option{-mrelocatable} option.
23013 @item -msdata=default
23014 @itemx -msdata
23015 @opindex msdata=default
23016 @opindex msdata
23017 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
23018 compile code the same as @option{-msdata=eabi}, otherwise compile code the
23019 same as @option{-msdata=sysv}.
23021 @item -msdata=data
23022 @opindex msdata=data
23023 On System V.4 and embedded PowerPC systems, put small global
23024 data in the @code{.sdata} section.  Put small uninitialized global
23025 data in the @code{.sbss} section.  Do not use register @code{r13}
23026 to address small data however.  This is the default behavior unless
23027 other @option{-msdata} options are used.
23029 @item -msdata=none
23030 @itemx -mno-sdata
23031 @opindex msdata=none
23032 @opindex mno-sdata
23033 On embedded PowerPC systems, put all initialized global and static data
23034 in the @code{.data} section, and all uninitialized data in the
23035 @code{.bss} section.
23037 @item -mblock-move-inline-limit=@var{num}
23038 @opindex mblock-move-inline-limit
23039 Inline all block moves (such as calls to @code{memcpy} or structure
23040 copies) less than or equal to @var{num} bytes.  The minimum value for
23041 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23042 targets.  The default value is target-specific.
23044 @item -G @var{num}
23045 @opindex G
23046 @cindex smaller data references (PowerPC)
23047 @cindex .sdata/.sdata2 references (PowerPC)
23048 On embedded PowerPC systems, put global and static items less than or
23049 equal to @var{num} bytes into the small data or BSS sections instead of
23050 the normal data or BSS section.  By default, @var{num} is 8.  The
23051 @option{-G @var{num}} switch is also passed to the linker.
23052 All modules should be compiled with the same @option{-G @var{num}} value.
23054 @item -mregnames
23055 @itemx -mno-regnames
23056 @opindex mregnames
23057 @opindex mno-regnames
23058 On System V.4 and embedded PowerPC systems do (do not) emit register
23059 names in the assembly language output using symbolic forms.
23061 @item -mlongcall
23062 @itemx -mno-longcall
23063 @opindex mlongcall
23064 @opindex mno-longcall
23065 By default assume that all calls are far away so that a longer and more
23066 expensive calling sequence is required.  This is required for calls
23067 farther than 32 megabytes (33,554,432 bytes) from the current location.
23068 A short call is generated if the compiler knows
23069 the call cannot be that far away.  This setting can be overridden by
23070 the @code{shortcall} function attribute, or by @code{#pragma
23071 longcall(0)}.
23073 Some linkers are capable of detecting out-of-range calls and generating
23074 glue code on the fly.  On these systems, long calls are unnecessary and
23075 generate slower code.  As of this writing, the AIX linker can do this,
23076 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23077 to the GNU linker for 32-bit PowerPC systems as well.
23079 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23080 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23081 addresses represent the callee and the branch island.  The
23082 Darwin/PPC linker prefers the first address and generates a @code{bl
23083 callee} if the PPC @code{bl} instruction reaches the callee directly;
23084 otherwise, the linker generates @code{bl L42} to call the branch
23085 island.  The branch island is appended to the body of the
23086 calling function; it computes the full 32-bit address of the callee
23087 and jumps to it.
23089 On Mach-O (Darwin) systems, this option directs the compiler emit to
23090 the glue for every direct call, and the Darwin linker decides whether
23091 to use or discard it.
23093 In the future, GCC may ignore all longcall specifications
23094 when the linker is known to generate glue.
23096 @item -mtls-markers
23097 @itemx -mno-tls-markers
23098 @opindex mtls-markers
23099 @opindex mno-tls-markers
23100 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23101 specifying the function argument.  The relocation allows the linker to
23102 reliably associate function call with argument setup instructions for
23103 TLS optimization, which in turn allows GCC to better schedule the
23104 sequence.
23106 @item -mrecip
23107 @itemx -mno-recip
23108 @opindex mrecip
23109 This option enables use of the reciprocal estimate and
23110 reciprocal square root estimate instructions with additional
23111 Newton-Raphson steps to increase precision instead of doing a divide or
23112 square root and divide for floating-point arguments.  You should use
23113 the @option{-ffast-math} option when using @option{-mrecip} (or at
23114 least @option{-funsafe-math-optimizations},
23115 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23116 @option{-fno-trapping-math}).  Note that while the throughput of the
23117 sequence is generally higher than the throughput of the non-reciprocal
23118 instruction, the precision of the sequence can be decreased by up to 2
23119 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23120 roots.
23122 @item -mrecip=@var{opt}
23123 @opindex mrecip=opt
23124 This option controls which reciprocal estimate instructions
23125 may be used.  @var{opt} is a comma-separated list of options, which may
23126 be preceded by a @code{!} to invert the option:
23128 @table @samp
23130 @item all
23131 Enable all estimate instructions.
23133 @item default 
23134 Enable the default instructions, equivalent to @option{-mrecip}.
23136 @item none 
23137 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23139 @item div 
23140 Enable the reciprocal approximation instructions for both 
23141 single and double precision.
23143 @item divf 
23144 Enable the single-precision reciprocal approximation instructions.
23146 @item divd 
23147 Enable the double-precision reciprocal approximation instructions.
23149 @item rsqrt 
23150 Enable the reciprocal square root approximation instructions for both
23151 single and double precision.
23153 @item rsqrtf 
23154 Enable the single-precision reciprocal square root approximation instructions.
23156 @item rsqrtd 
23157 Enable the double-precision reciprocal square root approximation instructions.
23159 @end table
23161 So, for example, @option{-mrecip=all,!rsqrtd} enables
23162 all of the reciprocal estimate instructions, except for the
23163 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23164 which handle the double-precision reciprocal square root calculations.
23166 @item -mrecip-precision
23167 @itemx -mno-recip-precision
23168 @opindex mrecip-precision
23169 Assume (do not assume) that the reciprocal estimate instructions
23170 provide higher-precision estimates than is mandated by the PowerPC
23171 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23172 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23173 The double-precision square root estimate instructions are not generated by
23174 default on low-precision machines, since they do not provide an
23175 estimate that converges after three steps.
23177 @item -mveclibabi=@var{type}
23178 @opindex mveclibabi
23179 Specifies the ABI type to use for vectorizing intrinsics using an
23180 external library.  The only type supported at present is @samp{mass},
23181 which specifies to use IBM's Mathematical Acceleration Subsystem
23182 (MASS) libraries for vectorizing intrinsics using external libraries.
23183 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23184 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23185 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23186 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23187 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23188 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23189 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23190 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23191 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23192 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23193 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23194 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23195 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23196 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23197 for power7.  Both @option{-ftree-vectorize} and
23198 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23199 libraries must be specified at link time.
23201 @item -mfriz
23202 @itemx -mno-friz
23203 @opindex mfriz
23204 Generate (do not generate) the @code{friz} instruction when the
23205 @option{-funsafe-math-optimizations} option is used to optimize
23206 rounding of floating-point values to 64-bit integer and back to floating
23207 point.  The @code{friz} instruction does not return the same value if
23208 the floating-point number is too large to fit in an integer.
23210 @item -mpointers-to-nested-functions
23211 @itemx -mno-pointers-to-nested-functions
23212 @opindex mpointers-to-nested-functions
23213 Generate (do not generate) code to load up the static chain register
23214 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23215 systems where a function pointer points to a 3-word descriptor giving
23216 the function address, TOC value to be loaded in register @code{r2}, and
23217 static chain value to be loaded in register @code{r11}.  The
23218 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23219 call through pointers to nested functions or pointers
23220 to functions compiled in other languages that use the static chain if
23221 you use @option{-mno-pointers-to-nested-functions}.
23223 @item -msave-toc-indirect
23224 @itemx -mno-save-toc-indirect
23225 @opindex msave-toc-indirect
23226 Generate (do not generate) code to save the TOC value in the reserved
23227 stack location in the function prologue if the function calls through
23228 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23229 saved in the prologue, it is saved just before the call through the
23230 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23232 @item -mcompat-align-parm
23233 @itemx -mno-compat-align-parm
23234 @opindex mcompat-align-parm
23235 Generate (do not generate) code to pass structure parameters with a
23236 maximum alignment of 64 bits, for compatibility with older versions
23237 of GCC.
23239 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23240 structure parameter on a 128-bit boundary when that structure contained
23241 a member requiring 128-bit alignment.  This is corrected in more
23242 recent versions of GCC.  This option may be used to generate code
23243 that is compatible with functions compiled with older versions of
23244 GCC.
23246 The @option{-mno-compat-align-parm} option is the default.
23248 @item -mstack-protector-guard=@var{guard}
23249 @itemx -mstack-protector-guard-reg=@var{reg}
23250 @itemx -mstack-protector-guard-offset=@var{offset}
23251 @itemx -mstack-protector-guard-symbol=@var{symbol}
23252 @opindex mstack-protector-guard
23253 @opindex mstack-protector-guard-reg
23254 @opindex mstack-protector-guard-offset
23255 @opindex mstack-protector-guard-symbol
23256 Generate stack protection code using canary at @var{guard}.  Supported
23257 locations are @samp{global} for global canary or @samp{tls} for per-thread
23258 canary in the TLS block (the default with GNU libc version 2.4 or later).
23260 With the latter choice the options
23261 @option{-mstack-protector-guard-reg=@var{reg}} and
23262 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23263 which register to use as base register for reading the canary, and from what
23264 offset from that base register. The default for those is as specified in the
23265 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23266 the offset with a symbol reference to a canary in the TLS block.
23267 @end table
23269 @node RX Options
23270 @subsection RX Options
23271 @cindex RX Options
23273 These command-line options are defined for RX targets:
23275 @table @gcctabopt
23276 @item -m64bit-doubles
23277 @itemx -m32bit-doubles
23278 @opindex m64bit-doubles
23279 @opindex m32bit-doubles
23280 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23281 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23282 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23283 works on 32-bit values, which is why the default is
23284 @option{-m32bit-doubles}.
23286 @item -fpu
23287 @itemx -nofpu
23288 @opindex fpu
23289 @opindex nofpu
23290 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23291 floating-point hardware.  The default is enabled for the RX600
23292 series and disabled for the RX200 series.
23294 Floating-point instructions are only generated for 32-bit floating-point 
23295 values, however, so the FPU hardware is not used for doubles if the
23296 @option{-m64bit-doubles} option is used.
23298 @emph{Note} If the @option{-fpu} option is enabled then
23299 @option{-funsafe-math-optimizations} is also enabled automatically.
23300 This is because the RX FPU instructions are themselves unsafe.
23302 @item -mcpu=@var{name}
23303 @opindex mcpu
23304 Selects the type of RX CPU to be targeted.  Currently three types are
23305 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23306 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23308 The only difference between @samp{RX600} and @samp{RX610} is that the
23309 @samp{RX610} does not support the @code{MVTIPL} instruction.
23311 The @samp{RX200} series does not have a hardware floating-point unit
23312 and so @option{-nofpu} is enabled by default when this type is
23313 selected.
23315 @item -mbig-endian-data
23316 @itemx -mlittle-endian-data
23317 @opindex mbig-endian-data
23318 @opindex mlittle-endian-data
23319 Store data (but not code) in the big-endian format.  The default is
23320 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23321 format.
23323 @item -msmall-data-limit=@var{N}
23324 @opindex msmall-data-limit
23325 Specifies the maximum size in bytes of global and static variables
23326 which can be placed into the small data area.  Using the small data
23327 area can lead to smaller and faster code, but the size of area is
23328 limited and it is up to the programmer to ensure that the area does
23329 not overflow.  Also when the small data area is used one of the RX's
23330 registers (usually @code{r13}) is reserved for use pointing to this
23331 area, so it is no longer available for use by the compiler.  This
23332 could result in slower and/or larger code if variables are pushed onto
23333 the stack instead of being held in this register.
23335 Note, common variables (variables that have not been initialized) and
23336 constants are not placed into the small data area as they are assigned
23337 to other sections in the output executable.
23339 The default value is zero, which disables this feature.  Note, this
23340 feature is not enabled by default with higher optimization levels
23341 (@option{-O2} etc) because of the potentially detrimental effects of
23342 reserving a register.  It is up to the programmer to experiment and
23343 discover whether this feature is of benefit to their program.  See the
23344 description of the @option{-mpid} option for a description of how the
23345 actual register to hold the small data area pointer is chosen.
23347 @item -msim
23348 @itemx -mno-sim
23349 @opindex msim
23350 @opindex mno-sim
23351 Use the simulator runtime.  The default is to use the libgloss
23352 board-specific runtime.
23354 @item -mas100-syntax
23355 @itemx -mno-as100-syntax
23356 @opindex mas100-syntax
23357 @opindex mno-as100-syntax
23358 When generating assembler output use a syntax that is compatible with
23359 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23360 assembler, but it has some restrictions so it is not generated by default.
23362 @item -mmax-constant-size=@var{N}
23363 @opindex mmax-constant-size
23364 Specifies the maximum size, in bytes, of a constant that can be used as
23365 an operand in a RX instruction.  Although the RX instruction set does
23366 allow constants of up to 4 bytes in length to be used in instructions,
23367 a longer value equates to a longer instruction.  Thus in some
23368 circumstances it can be beneficial to restrict the size of constants
23369 that are used in instructions.  Constants that are too big are instead
23370 placed into a constant pool and referenced via register indirection.
23372 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23373 or 4 means that constants of any size are allowed.
23375 @item -mrelax
23376 @opindex mrelax
23377 Enable linker relaxation.  Linker relaxation is a process whereby the
23378 linker attempts to reduce the size of a program by finding shorter
23379 versions of various instructions.  Disabled by default.
23381 @item -mint-register=@var{N}
23382 @opindex mint-register
23383 Specify the number of registers to reserve for fast interrupt handler
23384 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23385 means that register @code{r13} is reserved for the exclusive use
23386 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23387 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23388 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23389 A value of 0, the default, does not reserve any registers.
23391 @item -msave-acc-in-interrupts
23392 @opindex msave-acc-in-interrupts
23393 Specifies that interrupt handler functions should preserve the
23394 accumulator register.  This is only necessary if normal code might use
23395 the accumulator register, for example because it performs 64-bit
23396 multiplications.  The default is to ignore the accumulator as this
23397 makes the interrupt handlers faster.
23399 @item -mpid
23400 @itemx -mno-pid
23401 @opindex mpid
23402 @opindex mno-pid
23403 Enables the generation of position independent data.  When enabled any
23404 access to constant data is done via an offset from a base address
23405 held in a register.  This allows the location of constant data to be
23406 determined at run time without requiring the executable to be
23407 relocated, which is a benefit to embedded applications with tight
23408 memory constraints.  Data that can be modified is not affected by this
23409 option.
23411 Note, using this feature reserves a register, usually @code{r13}, for
23412 the constant data base address.  This can result in slower and/or
23413 larger code, especially in complicated functions.
23415 The actual register chosen to hold the constant data base address
23416 depends upon whether the @option{-msmall-data-limit} and/or the
23417 @option{-mint-register} command-line options are enabled.  Starting
23418 with register @code{r13} and proceeding downwards, registers are
23419 allocated first to satisfy the requirements of @option{-mint-register},
23420 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23421 is possible for the small data area register to be @code{r8} if both
23422 @option{-mint-register=4} and @option{-mpid} are specified on the
23423 command line.
23425 By default this feature is not enabled.  The default can be restored
23426 via the @option{-mno-pid} command-line option.
23428 @item -mno-warn-multiple-fast-interrupts
23429 @itemx -mwarn-multiple-fast-interrupts
23430 @opindex mno-warn-multiple-fast-interrupts
23431 @opindex mwarn-multiple-fast-interrupts
23432 Prevents GCC from issuing a warning message if it finds more than one
23433 fast interrupt handler when it is compiling a file.  The default is to
23434 issue a warning for each extra fast interrupt handler found, as the RX
23435 only supports one such interrupt.
23437 @item -mallow-string-insns
23438 @itemx -mno-allow-string-insns
23439 @opindex mallow-string-insns
23440 @opindex mno-allow-string-insns
23441 Enables or disables the use of the string manipulation instructions
23442 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23443 @code{SWHILE} and also the @code{RMPA} instruction.  These
23444 instructions may prefetch data, which is not safe to do if accessing
23445 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23446 for more information).
23448 The default is to allow these instructions, but it is not possible for
23449 GCC to reliably detect all circumstances where a string instruction
23450 might be used to access an I/O register, so their use cannot be
23451 disabled automatically.  Instead it is reliant upon the programmer to
23452 use the @option{-mno-allow-string-insns} option if their program
23453 accesses I/O space.
23455 When the instructions are enabled GCC defines the C preprocessor
23456 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23457 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23459 @item -mjsr
23460 @itemx -mno-jsr
23461 @opindex mjsr
23462 @opindex mno-jsr
23463 Use only (or not only) @code{JSR} instructions to access functions.
23464 This option can be used when code size exceeds the range of @code{BSR}
23465 instructions.  Note that @option{-mno-jsr} does not mean to not use
23466 @code{JSR} but instead means that any type of branch may be used.
23467 @end table
23469 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23470 has special significance to the RX port when used with the
23471 @code{interrupt} function attribute.  This attribute indicates a
23472 function intended to process fast interrupts.  GCC ensures
23473 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23474 and/or @code{r13} and only provided that the normal use of the
23475 corresponding registers have been restricted via the
23476 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23477 options.
23479 @node S/390 and zSeries Options
23480 @subsection S/390 and zSeries Options
23481 @cindex S/390 and zSeries Options
23483 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23485 @table @gcctabopt
23486 @item -mhard-float
23487 @itemx -msoft-float
23488 @opindex mhard-float
23489 @opindex msoft-float
23490 Use (do not use) the hardware floating-point instructions and registers
23491 for floating-point operations.  When @option{-msoft-float} is specified,
23492 functions in @file{libgcc.a} are used to perform floating-point
23493 operations.  When @option{-mhard-float} is specified, the compiler
23494 generates IEEE floating-point instructions.  This is the default.
23496 @item -mhard-dfp
23497 @itemx -mno-hard-dfp
23498 @opindex mhard-dfp
23499 @opindex mno-hard-dfp
23500 Use (do not use) the hardware decimal-floating-point instructions for
23501 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23502 specified, functions in @file{libgcc.a} are used to perform
23503 decimal-floating-point operations.  When @option{-mhard-dfp} is
23504 specified, the compiler generates decimal-floating-point hardware
23505 instructions.  This is the default for @option{-march=z9-ec} or higher.
23507 @item -mlong-double-64
23508 @itemx -mlong-double-128
23509 @opindex mlong-double-64
23510 @opindex mlong-double-128
23511 These switches control the size of @code{long double} type. A size
23512 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23513 type. This is the default.
23515 @item -mbackchain
23516 @itemx -mno-backchain
23517 @opindex mbackchain
23518 @opindex mno-backchain
23519 Store (do not store) the address of the caller's frame as backchain pointer
23520 into the callee's stack frame.
23521 A backchain may be needed to allow debugging using tools that do not understand
23522 DWARF call frame information.
23523 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23524 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23525 the backchain is placed into the topmost word of the 96/160 byte register
23526 save area.
23528 In general, code compiled with @option{-mbackchain} is call-compatible with
23529 code compiled with @option{-mmo-backchain}; however, use of the backchain
23530 for debugging purposes usually requires that the whole binary is built with
23531 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23532 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23533 to build a linux kernel use @option{-msoft-float}.
23535 The default is to not maintain the backchain.
23537 @item -mpacked-stack
23538 @itemx -mno-packed-stack
23539 @opindex mpacked-stack
23540 @opindex mno-packed-stack
23541 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23542 specified, the compiler uses the all fields of the 96/160 byte register save
23543 area only for their default purpose; unused fields still take up stack space.
23544 When @option{-mpacked-stack} is specified, register save slots are densely
23545 packed at the top of the register save area; unused space is reused for other
23546 purposes, allowing for more efficient use of the available stack space.
23547 However, when @option{-mbackchain} is also in effect, the topmost word of
23548 the save area is always used to store the backchain, and the return address
23549 register is always saved two words below the backchain.
23551 As long as the stack frame backchain is not used, code generated with
23552 @option{-mpacked-stack} is call-compatible with code generated with
23553 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23554 S/390 or zSeries generated code that uses the stack frame backchain at run
23555 time, not just for debugging purposes.  Such code is not call-compatible
23556 with code compiled with @option{-mpacked-stack}.  Also, note that the
23557 combination of @option{-mbackchain},
23558 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23559 to build a linux kernel use @option{-msoft-float}.
23561 The default is to not use the packed stack layout.
23563 @item -msmall-exec
23564 @itemx -mno-small-exec
23565 @opindex msmall-exec
23566 @opindex mno-small-exec
23567 Generate (or do not generate) code using the @code{bras} instruction
23568 to do subroutine calls.
23569 This only works reliably if the total executable size does not
23570 exceed 64k.  The default is to use the @code{basr} instruction instead,
23571 which does not have this limitation.
23573 @item -m64
23574 @itemx -m31
23575 @opindex m64
23576 @opindex m31
23577 When @option{-m31} is specified, generate code compliant to the
23578 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23579 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23580 particular to generate 64-bit instructions.  For the @samp{s390}
23581 targets, the default is @option{-m31}, while the @samp{s390x}
23582 targets default to @option{-m64}.
23584 @item -mzarch
23585 @itemx -mesa
23586 @opindex mzarch
23587 @opindex mesa
23588 When @option{-mzarch} is specified, generate code using the
23589 instructions available on z/Architecture.
23590 When @option{-mesa} is specified, generate code using the
23591 instructions available on ESA/390.  Note that @option{-mesa} is
23592 not possible with @option{-m64}.
23593 When generating code compliant to the GNU/Linux for S/390 ABI,
23594 the default is @option{-mesa}.  When generating code compliant
23595 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23597 @item -mhtm
23598 @itemx -mno-htm
23599 @opindex mhtm
23600 @opindex mno-htm
23601 The @option{-mhtm} option enables a set of builtins making use of
23602 instructions available with the transactional execution facility
23603 introduced with the IBM zEnterprise EC12 machine generation
23604 @ref{S/390 System z Built-in Functions}.
23605 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23607 @item -mvx
23608 @itemx -mno-vx
23609 @opindex mvx
23610 @opindex mno-vx
23611 When @option{-mvx} is specified, generate code using the instructions
23612 available with the vector extension facility introduced with the IBM
23613 z13 machine generation.
23614 This option changes the ABI for some vector type values with regard to
23615 alignment and calling conventions.  In case vector type values are
23616 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23617 command will be added to mark the resulting binary with the ABI used.
23618 @option{-mvx} is enabled by default when using @option{-march=z13}.
23620 @item -mzvector
23621 @itemx -mno-zvector
23622 @opindex mzvector
23623 @opindex mno-zvector
23624 The @option{-mzvector} option enables vector language extensions and
23625 builtins using instructions available with the vector extension
23626 facility introduced with the IBM z13 machine generation.
23627 This option adds support for @samp{vector} to be used as a keyword to
23628 define vector type variables and arguments.  @samp{vector} is only
23629 available when GNU extensions are enabled.  It will not be expanded
23630 when requesting strict standard compliance e.g. with @option{-std=c99}.
23631 In addition to the GCC low-level builtins @option{-mzvector} enables
23632 a set of builtins added for compatibility with AltiVec-style
23633 implementations like Power and Cell.  In order to make use of these
23634 builtins the header file @file{vecintrin.h} needs to be included.
23635 @option{-mzvector} is disabled by default.
23637 @item -mmvcle
23638 @itemx -mno-mvcle
23639 @opindex mmvcle
23640 @opindex mno-mvcle
23641 Generate (or do not generate) code using the @code{mvcle} instruction
23642 to perform block moves.  When @option{-mno-mvcle} is specified,
23643 use a @code{mvc} loop instead.  This is the default unless optimizing for
23644 size.
23646 @item -mdebug
23647 @itemx -mno-debug
23648 @opindex mdebug
23649 @opindex mno-debug
23650 Print (or do not print) additional debug information when compiling.
23651 The default is to not print debug information.
23653 @item -march=@var{cpu-type}
23654 @opindex march
23655 Generate code that runs on @var{cpu-type}, which is the name of a
23656 system representing a certain processor type.  Possible values for
23657 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23658 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23659 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23660 @samp{native}.
23662 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23663 @samp{g6} are deprecated and will be removed with future releases.
23665 Specifying @samp{native} as cpu type can be used to select the best
23666 architecture option for the host processor.
23667 @option{-march=native} has no effect if GCC does not recognize the
23668 processor.
23670 @item -mtune=@var{cpu-type}
23671 @opindex mtune
23672 Tune to @var{cpu-type} everything applicable about the generated code,
23673 except for the ABI and the set of available instructions.
23674 The list of @var{cpu-type} values is the same as for @option{-march}.
23675 The default is the value used for @option{-march}.
23677 @item -mtpf-trace
23678 @itemx -mno-tpf-trace
23679 @opindex mtpf-trace
23680 @opindex mno-tpf-trace
23681 Generate code that adds (does not add) in TPF OS specific branches to trace
23682 routines in the operating system.  This option is off by default, even
23683 when compiling for the TPF OS@.
23685 @item -mfused-madd
23686 @itemx -mno-fused-madd
23687 @opindex mfused-madd
23688 @opindex mno-fused-madd
23689 Generate code that uses (does not use) the floating-point multiply and
23690 accumulate instructions.  These instructions are generated by default if
23691 hardware floating point is used.
23693 @item -mwarn-framesize=@var{framesize}
23694 @opindex mwarn-framesize
23695 Emit a warning if the current function exceeds the given frame size.  Because
23696 this is a compile-time check it doesn't need to be a real problem when the program
23697 runs.  It is intended to identify functions that most probably cause
23698 a stack overflow.  It is useful to be used in an environment with limited stack
23699 size e.g.@: the linux kernel.
23701 @item -mwarn-dynamicstack
23702 @opindex mwarn-dynamicstack
23703 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23704 arrays.  This is generally a bad idea with a limited stack size.
23706 @item -mstack-guard=@var{stack-guard}
23707 @itemx -mstack-size=@var{stack-size}
23708 @opindex mstack-guard
23709 @opindex mstack-size
23710 If these options are provided the S/390 back end emits additional instructions in
23711 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23712 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23713 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23714 the frame size of the compiled function is chosen.
23715 These options are intended to be used to help debugging stack overflow problems.
23716 The additionally emitted code causes only little overhead and hence can also be
23717 used in production-like systems without greater performance degradation.  The given
23718 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23719 @var{stack-guard} without exceeding 64k.
23720 In order to be efficient the extra code makes the assumption that the stack starts
23721 at an address aligned to the value given by @var{stack-size}.
23722 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23724 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23725 @opindex mhotpatch
23726 If the hotpatch option is enabled, a ``hot-patching'' function
23727 prologue is generated for all functions in the compilation unit.
23728 The funtion label is prepended with the given number of two-byte
23729 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23730 the label, 2 * @var{post-halfwords} bytes are appended, using the
23731 largest NOP like instructions the architecture allows (maximum
23732 1000000).
23734 If both arguments are zero, hotpatching is disabled.
23736 This option can be overridden for individual functions with the
23737 @code{hotpatch} attribute.
23738 @end table
23740 @node Score Options
23741 @subsection Score Options
23742 @cindex Score Options
23744 These options are defined for Score implementations:
23746 @table @gcctabopt
23747 @item -meb
23748 @opindex meb
23749 Compile code for big-endian mode.  This is the default.
23751 @item -mel
23752 @opindex mel
23753 Compile code for little-endian mode.
23755 @item -mnhwloop
23756 @opindex mnhwloop
23757 Disable generation of @code{bcnz} instructions.
23759 @item -muls
23760 @opindex muls
23761 Enable generation of unaligned load and store instructions.
23763 @item -mmac
23764 @opindex mmac
23765 Enable the use of multiply-accumulate instructions. Disabled by default.
23767 @item -mscore5
23768 @opindex mscore5
23769 Specify the SCORE5 as the target architecture.
23771 @item -mscore5u
23772 @opindex mscore5u
23773 Specify the SCORE5U of the target architecture.
23775 @item -mscore7
23776 @opindex mscore7
23777 Specify the SCORE7 as the target architecture. This is the default.
23779 @item -mscore7d
23780 @opindex mscore7d
23781 Specify the SCORE7D as the target architecture.
23782 @end table
23784 @node SH Options
23785 @subsection SH Options
23787 These @samp{-m} options are defined for the SH implementations:
23789 @table @gcctabopt
23790 @item -m1
23791 @opindex m1
23792 Generate code for the SH1.
23794 @item -m2
23795 @opindex m2
23796 Generate code for the SH2.
23798 @item -m2e
23799 Generate code for the SH2e.
23801 @item -m2a-nofpu
23802 @opindex m2a-nofpu
23803 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23804 that the floating-point unit is not used.
23806 @item -m2a-single-only
23807 @opindex m2a-single-only
23808 Generate code for the SH2a-FPU, in such a way that no double-precision
23809 floating-point operations are used.
23811 @item -m2a-single
23812 @opindex m2a-single
23813 Generate code for the SH2a-FPU assuming the floating-point unit is in
23814 single-precision mode by default.
23816 @item -m2a
23817 @opindex m2a
23818 Generate code for the SH2a-FPU assuming the floating-point unit is in
23819 double-precision mode by default.
23821 @item -m3
23822 @opindex m3
23823 Generate code for the SH3.
23825 @item -m3e
23826 @opindex m3e
23827 Generate code for the SH3e.
23829 @item -m4-nofpu
23830 @opindex m4-nofpu
23831 Generate code for the SH4 without a floating-point unit.
23833 @item -m4-single-only
23834 @opindex m4-single-only
23835 Generate code for the SH4 with a floating-point unit that only
23836 supports single-precision arithmetic.
23838 @item -m4-single
23839 @opindex m4-single
23840 Generate code for the SH4 assuming the floating-point unit is in
23841 single-precision mode by default.
23843 @item -m4
23844 @opindex m4
23845 Generate code for the SH4.
23847 @item -m4-100
23848 @opindex m4-100
23849 Generate code for SH4-100.
23851 @item -m4-100-nofpu
23852 @opindex m4-100-nofpu
23853 Generate code for SH4-100 in such a way that the
23854 floating-point unit is not used.
23856 @item -m4-100-single
23857 @opindex m4-100-single
23858 Generate code for SH4-100 assuming the floating-point unit is in
23859 single-precision mode by default.
23861 @item -m4-100-single-only
23862 @opindex m4-100-single-only
23863 Generate code for SH4-100 in such a way that no double-precision
23864 floating-point operations are used.
23866 @item -m4-200
23867 @opindex m4-200
23868 Generate code for SH4-200.
23870 @item -m4-200-nofpu
23871 @opindex m4-200-nofpu
23872 Generate code for SH4-200 without in such a way that the
23873 floating-point unit is not used.
23875 @item -m4-200-single
23876 @opindex m4-200-single
23877 Generate code for SH4-200 assuming the floating-point unit is in
23878 single-precision mode by default.
23880 @item -m4-200-single-only
23881 @opindex m4-200-single-only
23882 Generate code for SH4-200 in such a way that no double-precision
23883 floating-point operations are used.
23885 @item -m4-300
23886 @opindex m4-300
23887 Generate code for SH4-300.
23889 @item -m4-300-nofpu
23890 @opindex m4-300-nofpu
23891 Generate code for SH4-300 without in such a way that the
23892 floating-point unit is not used.
23894 @item -m4-300-single
23895 @opindex m4-300-single
23896 Generate code for SH4-300 in such a way that no double-precision
23897 floating-point operations are used.
23899 @item -m4-300-single-only
23900 @opindex m4-300-single-only
23901 Generate code for SH4-300 in such a way that no double-precision
23902 floating-point operations are used.
23904 @item -m4-340
23905 @opindex m4-340
23906 Generate code for SH4-340 (no MMU, no FPU).
23908 @item -m4-500
23909 @opindex m4-500
23910 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23911 assembler.
23913 @item -m4a-nofpu
23914 @opindex m4a-nofpu
23915 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23916 floating-point unit is not used.
23918 @item -m4a-single-only
23919 @opindex m4a-single-only
23920 Generate code for the SH4a, in such a way that no double-precision
23921 floating-point operations are used.
23923 @item -m4a-single
23924 @opindex m4a-single
23925 Generate code for the SH4a assuming the floating-point unit is in
23926 single-precision mode by default.
23928 @item -m4a
23929 @opindex m4a
23930 Generate code for the SH4a.
23932 @item -m4al
23933 @opindex m4al
23934 Same as @option{-m4a-nofpu}, except that it implicitly passes
23935 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23936 instructions at the moment.
23938 @item -mb
23939 @opindex mb
23940 Compile code for the processor in big-endian mode.
23942 @item -ml
23943 @opindex ml
23944 Compile code for the processor in little-endian mode.
23946 @item -mdalign
23947 @opindex mdalign
23948 Align doubles at 64-bit boundaries.  Note that this changes the calling
23949 conventions, and thus some functions from the standard C library do
23950 not work unless you recompile it first with @option{-mdalign}.
23952 @item -mrelax
23953 @opindex mrelax
23954 Shorten some address references at link time, when possible; uses the
23955 linker option @option{-relax}.
23957 @item -mbigtable
23958 @opindex mbigtable
23959 Use 32-bit offsets in @code{switch} tables.  The default is to use
23960 16-bit offsets.
23962 @item -mbitops
23963 @opindex mbitops
23964 Enable the use of bit manipulation instructions on SH2A.
23966 @item -mfmovd
23967 @opindex mfmovd
23968 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23969 alignment constraints.
23971 @item -mrenesas
23972 @opindex mrenesas
23973 Comply with the calling conventions defined by Renesas.
23975 @item -mno-renesas
23976 @opindex mno-renesas
23977 Comply with the calling conventions defined for GCC before the Renesas
23978 conventions were available.  This option is the default for all
23979 targets of the SH toolchain.
23981 @item -mnomacsave
23982 @opindex mnomacsave
23983 Mark the @code{MAC} register as call-clobbered, even if
23984 @option{-mrenesas} is given.
23986 @item -mieee
23987 @itemx -mno-ieee
23988 @opindex mieee
23989 @opindex mno-ieee
23990 Control the IEEE compliance of floating-point comparisons, which affects the
23991 handling of cases where the result of a comparison is unordered.  By default
23992 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23993 enabled @option{-mno-ieee} is implicitly set, which results in faster
23994 floating-point greater-equal and less-equal comparisons.  The implicit settings
23995 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23997 @item -minline-ic_invalidate
23998 @opindex minline-ic_invalidate
23999 Inline code to invalidate instruction cache entries after setting up
24000 nested function trampolines.
24001 This option has no effect if @option{-musermode} is in effect and the selected
24002 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
24003 instruction.
24004 If the selected code generation option does not allow the use of the @code{icbi}
24005 instruction, and @option{-musermode} is not in effect, the inlined code
24006 manipulates the instruction cache address array directly with an associative
24007 write.  This not only requires privileged mode at run time, but it also
24008 fails if the cache line had been mapped via the TLB and has become unmapped.
24010 @item -misize
24011 @opindex misize
24012 Dump instruction size and location in the assembly code.
24014 @item -mpadstruct
24015 @opindex mpadstruct
24016 This option is deprecated.  It pads structures to multiple of 4 bytes,
24017 which is incompatible with the SH ABI@.
24019 @item -matomic-model=@var{model}
24020 @opindex matomic-model=@var{model}
24021 Sets the model of atomic operations and additional parameters as a comma
24022 separated list.  For details on the atomic built-in functions see
24023 @ref{__atomic Builtins}.  The following models and parameters are supported:
24025 @table @samp
24027 @item none
24028 Disable compiler generated atomic sequences and emit library calls for atomic
24029 operations.  This is the default if the target is not @code{sh*-*-linux*}.
24031 @item soft-gusa
24032 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
24033 built-in functions.  The generated atomic sequences require additional support
24034 from the interrupt/exception handling code of the system and are only suitable
24035 for SH3* and SH4* single-core systems.  This option is enabled by default when
24036 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
24037 this option also partially utilizes the hardware atomic instructions
24038 @code{movli.l} and @code{movco.l} to create more efficient code, unless
24039 @samp{strict} is specified.  
24041 @item soft-tcb
24042 Generate software atomic sequences that use a variable in the thread control
24043 block.  This is a variation of the gUSA sequences which can also be used on
24044 SH1* and SH2* targets.  The generated atomic sequences require additional
24045 support from the interrupt/exception handling code of the system and are only
24046 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
24047 parameter has to be specified as well.
24049 @item soft-imask
24050 Generate software atomic sequences that temporarily disable interrupts by
24051 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
24052 in privileged mode and is only suitable for single-core systems.  Additional
24053 support from the interrupt/exception handling code of the system is not
24054 required.  This model is enabled by default when the target is
24055 @code{sh*-*-linux*} and SH1* or SH2*.
24057 @item hard-llcs
24058 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24059 instructions only.  This is only available on SH4A and is suitable for
24060 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24061 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24062 Code compiled with this option is also compatible with other software
24063 atomic model interrupt/exception handling systems if executed on an SH4A
24064 system.  Additional support from the interrupt/exception handling code of the
24065 system is not required for this model.
24067 @item gbr-offset=
24068 This parameter specifies the offset in bytes of the variable in the thread
24069 control block structure that should be used by the generated atomic sequences
24070 when the @samp{soft-tcb} model has been selected.  For other models this
24071 parameter is ignored.  The specified value must be an integer multiple of four
24072 and in the range 0-1020.
24074 @item strict
24075 This parameter prevents mixed usage of multiple atomic models, even if they
24076 are compatible, and makes the compiler generate atomic sequences of the
24077 specified model only.
24079 @end table
24081 @item -mtas
24082 @opindex mtas
24083 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24084 Notice that depending on the particular hardware and software configuration
24085 this can degrade overall performance due to the operand cache line flushes
24086 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24087 processors the @code{tas.b} instruction must be used with caution since it
24088 can result in data corruption for certain cache configurations.
24090 @item -mprefergot
24091 @opindex mprefergot
24092 When generating position-independent code, emit function calls using
24093 the Global Offset Table instead of the Procedure Linkage Table.
24095 @item -musermode
24096 @itemx -mno-usermode
24097 @opindex musermode
24098 @opindex mno-usermode
24099 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24100 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24101 inlined code would not work in user mode.  @option{-musermode} is the default
24102 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24103 @option{-musermode} has no effect, since there is no user mode.
24105 @item -multcost=@var{number}
24106 @opindex multcost=@var{number}
24107 Set the cost to assume for a multiply insn.
24109 @item -mdiv=@var{strategy}
24110 @opindex mdiv=@var{strategy}
24111 Set the division strategy to be used for integer division operations.
24112 @var{strategy} can be one of: 
24114 @table @samp
24116 @item call-div1
24117 Calls a library function that uses the single-step division instruction
24118 @code{div1} to perform the operation.  Division by zero calculates an
24119 unspecified result and does not trap.  This is the default except for SH4,
24120 SH2A and SHcompact.
24122 @item call-fp
24123 Calls a library function that performs the operation in double precision
24124 floating point.  Division by zero causes a floating-point exception.  This is
24125 the default for SHcompact with FPU.  Specifying this for targets that do not
24126 have a double precision FPU defaults to @code{call-div1}.
24128 @item call-table
24129 Calls a library function that uses a lookup table for small divisors and
24130 the @code{div1} instruction with case distinction for larger divisors.  Division
24131 by zero calculates an unspecified result and does not trap.  This is the default
24132 for SH4.  Specifying this for targets that do not have dynamic shift
24133 instructions defaults to @code{call-div1}.
24135 @end table
24137 When a division strategy has not been specified the default strategy is
24138 selected based on the current target.  For SH2A the default strategy is to
24139 use the @code{divs} and @code{divu} instructions instead of library function
24140 calls.
24142 @item -maccumulate-outgoing-args
24143 @opindex maccumulate-outgoing-args
24144 Reserve space once for outgoing arguments in the function prologue rather
24145 than around each call.  Generally beneficial for performance and size.  Also
24146 needed for unwinding to avoid changing the stack frame around conditional code.
24148 @item -mdivsi3_libfunc=@var{name}
24149 @opindex mdivsi3_libfunc=@var{name}
24150 Set the name of the library function used for 32-bit signed division to
24151 @var{name}.
24152 This only affects the name used in the @samp{call} division strategies, and
24153 the compiler still expects the same sets of input/output/clobbered registers as
24154 if this option were not present.
24156 @item -mfixed-range=@var{register-range}
24157 @opindex mfixed-range
24158 Generate code treating the given register range as fixed registers.
24159 A fixed register is one that the register allocator can not use.  This is
24160 useful when compiling kernel code.  A register range is specified as
24161 two registers separated by a dash.  Multiple register ranges can be
24162 specified separated by a comma.
24164 @item -mbranch-cost=@var{num}
24165 @opindex mbranch-cost=@var{num}
24166 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24167 make the compiler try to generate more branch-free code if possible.  
24168 If not specified the value is selected depending on the processor type that
24169 is being compiled for.
24171 @item -mzdcbranch
24172 @itemx -mno-zdcbranch
24173 @opindex mzdcbranch
24174 @opindex mno-zdcbranch
24175 Assume (do not assume) that zero displacement conditional branch instructions
24176 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24177 compiler prefers zero displacement branch code sequences.  This is
24178 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24179 disabled by specifying @option{-mno-zdcbranch}.
24181 @item -mcbranch-force-delay-slot
24182 @opindex mcbranch-force-delay-slot
24183 Force the usage of delay slots for conditional branches, which stuffs the delay
24184 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24185 this option is disabled.  It can be enabled to work around hardware bugs as
24186 found in the original SH7055.
24188 @item -mfused-madd
24189 @itemx -mno-fused-madd
24190 @opindex mfused-madd
24191 @opindex mno-fused-madd
24192 Generate code that uses (does not use) the floating-point multiply and
24193 accumulate instructions.  These instructions are generated by default
24194 if hardware floating point is used.  The machine-dependent
24195 @option{-mfused-madd} option is now mapped to the machine-independent
24196 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24197 mapped to @option{-ffp-contract=off}.
24199 @item -mfsca
24200 @itemx -mno-fsca
24201 @opindex mfsca
24202 @opindex mno-fsca
24203 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24204 and cosine approximations.  The option @option{-mfsca} must be used in
24205 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24206 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24207 approximations even if @option{-funsafe-math-optimizations} is in effect.
24209 @item -mfsrra
24210 @itemx -mno-fsrra
24211 @opindex mfsrra
24212 @opindex mno-fsrra
24213 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24214 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24215 in combination with @option{-funsafe-math-optimizations} and
24216 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24217 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24218 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24219 in effect.
24221 @item -mpretend-cmove
24222 @opindex mpretend-cmove
24223 Prefer zero-displacement conditional branches for conditional move instruction
24224 patterns.  This can result in faster code on the SH4 processor.
24226 @item -mfdpic
24227 @opindex fdpic
24228 Generate code using the FDPIC ABI.
24230 @end table
24232 @node Solaris 2 Options
24233 @subsection Solaris 2 Options
24234 @cindex Solaris 2 options
24236 These @samp{-m} options are supported on Solaris 2:
24238 @table @gcctabopt
24239 @item -mclear-hwcap
24240 @opindex mclear-hwcap
24241 @option{-mclear-hwcap} tells the compiler to remove the hardware
24242 capabilities generated by the Solaris assembler.  This is only necessary
24243 when object files use ISA extensions not supported by the current
24244 machine, but check at runtime whether or not to use them.
24246 @item -mimpure-text
24247 @opindex mimpure-text
24248 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24249 the compiler to not pass @option{-z text} to the linker when linking a
24250 shared object.  Using this option, you can link position-dependent
24251 code into a shared object.
24253 @option{-mimpure-text} suppresses the ``relocations remain against
24254 allocatable but non-writable sections'' linker error message.
24255 However, the necessary relocations trigger copy-on-write, and the
24256 shared object is not actually shared across processes.  Instead of
24257 using @option{-mimpure-text}, you should compile all source code with
24258 @option{-fpic} or @option{-fPIC}.
24260 @end table
24262 These switches are supported in addition to the above on Solaris 2:
24264 @table @gcctabopt
24265 @item -pthreads
24266 @opindex pthreads
24267 This is a synonym for @option{-pthread}.
24268 @end table
24270 @node SPARC Options
24271 @subsection SPARC Options
24272 @cindex SPARC options
24274 These @samp{-m} options are supported on the SPARC:
24276 @table @gcctabopt
24277 @item -mno-app-regs
24278 @itemx -mapp-regs
24279 @opindex mno-app-regs
24280 @opindex mapp-regs
24281 Specify @option{-mapp-regs} to generate output using the global registers
24282 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24283 global register 1, each global register 2 through 4 is then treated as an
24284 allocable register that is clobbered by function calls.  This is the default.
24286 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24287 specify @option{-mno-app-regs}.  You should compile libraries and system
24288 software with this option.
24290 @item -mflat
24291 @itemx -mno-flat
24292 @opindex mflat
24293 @opindex mno-flat
24294 With @option{-mflat}, the compiler does not generate save/restore instructions
24295 and uses a ``flat'' or single register window model.  This model is compatible
24296 with the regular register window model.  The local registers and the input
24297 registers (0--5) are still treated as ``call-saved'' registers and are
24298 saved on the stack as needed.
24300 With @option{-mno-flat} (the default), the compiler generates save/restore
24301 instructions (except for leaf functions).  This is the normal operating mode.
24303 @item -mfpu
24304 @itemx -mhard-float
24305 @opindex mfpu
24306 @opindex mhard-float
24307 Generate output containing floating-point instructions.  This is the
24308 default.
24310 @item -mno-fpu
24311 @itemx -msoft-float
24312 @opindex mno-fpu
24313 @opindex msoft-float
24314 Generate output containing library calls for floating point.
24315 @strong{Warning:} the requisite libraries are not available for all SPARC
24316 targets.  Normally the facilities of the machine's usual C compiler are
24317 used, but this cannot be done directly in cross-compilation.  You must make
24318 your own arrangements to provide suitable library functions for
24319 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24320 @samp{sparclite-*-*} do provide software floating-point support.
24322 @option{-msoft-float} changes the calling convention in the output file;
24323 therefore, it is only useful if you compile @emph{all} of a program with
24324 this option.  In particular, you need to compile @file{libgcc.a}, the
24325 library that comes with GCC, with @option{-msoft-float} in order for
24326 this to work.
24328 @item -mhard-quad-float
24329 @opindex mhard-quad-float
24330 Generate output containing quad-word (long double) floating-point
24331 instructions.
24333 @item -msoft-quad-float
24334 @opindex msoft-quad-float
24335 Generate output containing library calls for quad-word (long double)
24336 floating-point instructions.  The functions called are those specified
24337 in the SPARC ABI@.  This is the default.
24339 As of this writing, there are no SPARC implementations that have hardware
24340 support for the quad-word floating-point instructions.  They all invoke
24341 a trap handler for one of these instructions, and then the trap handler
24342 emulates the effect of the instruction.  Because of the trap handler overhead,
24343 this is much slower than calling the ABI library routines.  Thus the
24344 @option{-msoft-quad-float} option is the default.
24346 @item -mno-unaligned-doubles
24347 @itemx -munaligned-doubles
24348 @opindex mno-unaligned-doubles
24349 @opindex munaligned-doubles
24350 Assume that doubles have 8-byte alignment.  This is the default.
24352 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24353 alignment only if they are contained in another type, or if they have an
24354 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24355 Specifying this option avoids some rare compatibility problems with code
24356 generated by other compilers.  It is not the default because it results
24357 in a performance loss, especially for floating-point code.
24359 @item -muser-mode
24360 @itemx -mno-user-mode
24361 @opindex muser-mode
24362 @opindex mno-user-mode
24363 Do not generate code that can only run in supervisor mode.  This is relevant
24364 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24365 is the default.
24367 @item -mfaster-structs
24368 @itemx -mno-faster-structs
24369 @opindex mfaster-structs
24370 @opindex mno-faster-structs
24371 With @option{-mfaster-structs}, the compiler assumes that structures
24372 should have 8-byte alignment.  This enables the use of pairs of
24373 @code{ldd} and @code{std} instructions for copies in structure
24374 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24375 However, the use of this changed alignment directly violates the SPARC
24376 ABI@.  Thus, it's intended only for use on targets where the developer
24377 acknowledges that their resulting code is not directly in line with
24378 the rules of the ABI@.
24380 @item -mstd-struct-return
24381 @itemx -mno-std-struct-return
24382 @opindex mstd-struct-return
24383 @opindex mno-std-struct-return
24384 With @option{-mstd-struct-return}, the compiler generates checking code
24385 in functions returning structures or unions to detect size mismatches
24386 between the two sides of function calls, as per the 32-bit ABI@.
24388 The default is @option{-mno-std-struct-return}.  This option has no effect
24389 in 64-bit mode.
24391 @item -mlra
24392 @itemx -mno-lra
24393 @opindex mlra
24394 @opindex mno-lra
24395 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24396 so @option{-mno-lra} needs to be passed to get old Reload.
24398 @item -mcpu=@var{cpu_type}
24399 @opindex mcpu
24400 Set the instruction set, register set, and instruction scheduling parameters
24401 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24402 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24403 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24404 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24405 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24406 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24408 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24409 which selects the best architecture option for the host processor.
24410 @option{-mcpu=native} has no effect if GCC does not recognize
24411 the processor.
24413 Default instruction scheduling parameters are used for values that select
24414 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24415 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24417 Here is a list of each supported architecture and their supported
24418 implementations.
24420 @table @asis
24421 @item v7
24422 cypress, leon3v7
24424 @item v8
24425 supersparc, hypersparc, leon, leon3
24427 @item sparclite
24428 f930, f934, sparclite86x
24430 @item sparclet
24431 tsc701
24433 @item v9
24434 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24435 niagara7, m8
24436 @end table
24438 By default (unless configured otherwise), GCC generates code for the V7
24439 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24440 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24441 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24442 SPARCStation 1, 2, IPX etc.
24444 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24445 architecture.  The only difference from V7 code is that the compiler emits
24446 the integer multiply and integer divide instructions which exist in SPARC-V8
24447 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24448 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24449 2000 series.
24451 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24452 the SPARC architecture.  This adds the integer multiply, integer divide step
24453 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24454 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24455 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24456 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24457 MB86934 chip, which is the more recent SPARClite with FPU@.
24459 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24460 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24461 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24462 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24463 optimizes it for the TEMIC SPARClet chip.
24465 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24466 architecture.  This adds 64-bit integer and floating-point move instructions,
24467 3 additional floating-point condition code registers and conditional move
24468 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24469 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24470 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24471 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24472 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24473 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24474 additionally optimizes it for Sun UltraSPARC T2 chips. With
24475 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24476 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24477 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24478 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24479 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24480 additionally optimizes it for Oracle M8 chips.
24482 @item -mtune=@var{cpu_type}
24483 @opindex mtune
24484 Set the instruction scheduling parameters for machine type
24485 @var{cpu_type}, but do not set the instruction set or register set that the
24486 option @option{-mcpu=@var{cpu_type}} does.
24488 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24489 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24490 that select a particular CPU implementation.  Those are
24491 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24492 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24493 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24494 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24495 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24496 and GNU/Linux toolchains, @samp{native} can also be used.
24498 @item -mv8plus
24499 @itemx -mno-v8plus
24500 @opindex mv8plus
24501 @opindex mno-v8plus
24502 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24503 difference from the V8 ABI is that the global and out registers are
24504 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24505 mode for all SPARC-V9 processors.
24507 @item -mvis
24508 @itemx -mno-vis
24509 @opindex mvis
24510 @opindex mno-vis
24511 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24512 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24514 @item -mvis2
24515 @itemx -mno-vis2
24516 @opindex mvis2
24517 @opindex mno-vis2
24518 With @option{-mvis2}, GCC generates code that takes advantage of
24519 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24520 default is @option{-mvis2} when targeting a cpu that supports such
24521 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24522 also sets @option{-mvis}.
24524 @item -mvis3
24525 @itemx -mno-vis3
24526 @opindex mvis3
24527 @opindex mno-vis3
24528 With @option{-mvis3}, GCC generates code that takes advantage of
24529 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24530 default is @option{-mvis3} when targeting a cpu that supports such
24531 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24532 also sets @option{-mvis2} and @option{-mvis}.
24534 @item -mvis4
24535 @itemx -mno-vis4
24536 @opindex mvis4
24537 @opindex mno-vis4
24538 With @option{-mvis4}, GCC generates code that takes advantage of
24539 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24540 default is @option{-mvis4} when targeting a cpu that supports such
24541 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24542 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24544 @item -mvis4b
24545 @itemx -mno-vis4b
24546 @opindex mvis4b
24547 @opindex mno-vis4b
24548 With @option{-mvis4b}, GCC generates code that takes advantage of
24549 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24550 the additional VIS instructions introduced in the Oracle SPARC
24551 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24552 cpu that supports such instructions, such as m8 and later.  Setting
24553 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24554 @option{-mvis2} and @option{-mvis}.
24556 @item -mcbcond
24557 @itemx -mno-cbcond
24558 @opindex mcbcond
24559 @opindex mno-cbcond
24560 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24561 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24562 when targeting a CPU that supports such instructions, such as Niagara-4 and
24563 later.
24565 @item -mfmaf
24566 @itemx -mno-fmaf
24567 @opindex mfmaf
24568 @opindex mno-fmaf
24569 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24570 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24571 when targeting a CPU that supports such instructions, such as Niagara-3 and
24572 later.
24574 @item -mfsmuld
24575 @itemx -mno-fsmuld
24576 @opindex mfsmuld
24577 @opindex mno-fsmuld
24578 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24579 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24580 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24581 or V9 with FPU except @option{-mcpu=leon}.
24583 @item -mpopc
24584 @itemx -mno-popc
24585 @opindex mpopc
24586 @opindex mno-popc
24587 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24588 Population Count instruction.  The default is @option{-mpopc}
24589 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24590 later.
24592 @item -msubxc
24593 @itemx -mno-subxc
24594 @opindex msubxc
24595 @opindex mno-subxc
24596 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24597 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24598 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24599 later.
24601 @item -mfix-at697f
24602 @opindex mfix-at697f
24603 Enable the documented workaround for the single erratum of the Atmel AT697F
24604 processor (which corresponds to erratum #13 of the AT697E processor).
24606 @item -mfix-ut699
24607 @opindex mfix-ut699
24608 Enable the documented workarounds for the floating-point errata and the data
24609 cache nullify errata of the UT699 processor.
24611 @item -mfix-ut700
24612 @opindex mfix-ut700
24613 Enable the documented workaround for the back-to-back store errata of
24614 the UT699E/UT700 processor.
24616 @item -mfix-gr712rc
24617 @opindex mfix-gr712rc
24618 Enable the documented workaround for the back-to-back store errata of
24619 the GR712RC processor.
24620 @end table
24622 These @samp{-m} options are supported in addition to the above
24623 on SPARC-V9 processors in 64-bit environments:
24625 @table @gcctabopt
24626 @item -m32
24627 @itemx -m64
24628 @opindex m32
24629 @opindex m64
24630 Generate code for a 32-bit or 64-bit environment.
24631 The 32-bit environment sets int, long and pointer to 32 bits.
24632 The 64-bit environment sets int to 32 bits and long and pointer
24633 to 64 bits.
24635 @item -mcmodel=@var{which}
24636 @opindex mcmodel
24637 Set the code model to one of
24639 @table @samp
24640 @item medlow
24641 The Medium/Low code model: 64-bit addresses, programs
24642 must be linked in the low 32 bits of memory.  Programs can be statically
24643 or dynamically linked.
24645 @item medmid
24646 The Medium/Middle code model: 64-bit addresses, programs
24647 must be linked in the low 44 bits of memory, the text and data segments must
24648 be less than 2GB in size and the data segment must be located within 2GB of
24649 the text segment.
24651 @item medany
24652 The Medium/Anywhere code model: 64-bit addresses, programs
24653 may be linked anywhere in memory, the text and data segments must be less
24654 than 2GB in size and the data segment must be located within 2GB of the
24655 text segment.
24657 @item embmedany
24658 The Medium/Anywhere code model for embedded systems:
24659 64-bit addresses, the text and data segments must be less than 2GB in
24660 size, both starting anywhere in memory (determined at link time).  The
24661 global register %g4 points to the base of the data segment.  Programs
24662 are statically linked and PIC is not supported.
24663 @end table
24665 @item -mmemory-model=@var{mem-model}
24666 @opindex mmemory-model
24667 Set the memory model in force on the processor to one of
24669 @table @samp
24670 @item default
24671 The default memory model for the processor and operating system.
24673 @item rmo
24674 Relaxed Memory Order
24676 @item pso
24677 Partial Store Order
24679 @item tso
24680 Total Store Order
24682 @item sc
24683 Sequential Consistency
24684 @end table
24686 These memory models are formally defined in Appendix D of the SPARC-V9
24687 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24689 @item -mstack-bias
24690 @itemx -mno-stack-bias
24691 @opindex mstack-bias
24692 @opindex mno-stack-bias
24693 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24694 frame pointer if present, are offset by @minus{}2047 which must be added back
24695 when making stack frame references.  This is the default in 64-bit mode.
24696 Otherwise, assume no such offset is present.
24697 @end table
24699 @node SPU Options
24700 @subsection SPU Options
24701 @cindex SPU options
24703 These @samp{-m} options are supported on the SPU:
24705 @table @gcctabopt
24706 @item -mwarn-reloc
24707 @itemx -merror-reloc
24708 @opindex mwarn-reloc
24709 @opindex merror-reloc
24711 The loader for SPU does not handle dynamic relocations.  By default, GCC
24712 gives an error when it generates code that requires a dynamic
24713 relocation.  @option{-mno-error-reloc} disables the error,
24714 @option{-mwarn-reloc} generates a warning instead.
24716 @item -msafe-dma
24717 @itemx -munsafe-dma
24718 @opindex msafe-dma
24719 @opindex munsafe-dma
24721 Instructions that initiate or test completion of DMA must not be
24722 reordered with respect to loads and stores of the memory that is being
24723 accessed.
24724 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24725 memory accesses, but that can lead to inefficient code in places where the
24726 memory is known to not change.  Rather than mark the memory as volatile,
24727 you can use @option{-msafe-dma} to tell the compiler to treat
24728 the DMA instructions as potentially affecting all memory.  
24730 @item -mbranch-hints
24731 @opindex mbranch-hints
24733 By default, GCC generates a branch hint instruction to avoid
24734 pipeline stalls for always-taken or probably-taken branches.  A hint
24735 is not generated closer than 8 instructions away from its branch.
24736 There is little reason to disable them, except for debugging purposes,
24737 or to make an object a little bit smaller.
24739 @item -msmall-mem
24740 @itemx -mlarge-mem
24741 @opindex msmall-mem
24742 @opindex mlarge-mem
24744 By default, GCC generates code assuming that addresses are never larger
24745 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24746 a full 32-bit address.
24748 @item -mstdmain
24749 @opindex mstdmain
24751 By default, GCC links against startup code that assumes the SPU-style
24752 main function interface (which has an unconventional parameter list).
24753 With @option{-mstdmain}, GCC links your program against startup
24754 code that assumes a C99-style interface to @code{main}, including a
24755 local copy of @code{argv} strings.
24757 @item -mfixed-range=@var{register-range}
24758 @opindex mfixed-range
24759 Generate code treating the given register range as fixed registers.
24760 A fixed register is one that the register allocator cannot use.  This is
24761 useful when compiling kernel code.  A register range is specified as
24762 two registers separated by a dash.  Multiple register ranges can be
24763 specified separated by a comma.
24765 @item -mea32
24766 @itemx -mea64
24767 @opindex mea32
24768 @opindex mea64
24769 Compile code assuming that pointers to the PPU address space accessed
24770 via the @code{__ea} named address space qualifier are either 32 or 64
24771 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24772 all object code in an executable must be compiled with the same setting.
24774 @item -maddress-space-conversion
24775 @itemx -mno-address-space-conversion
24776 @opindex maddress-space-conversion
24777 @opindex mno-address-space-conversion
24778 Allow/disallow treating the @code{__ea} address space as superset
24779 of the generic address space.  This enables explicit type casts
24780 between @code{__ea} and generic pointer as well as implicit
24781 conversions of generic pointers to @code{__ea} pointers.  The
24782 default is to allow address space pointer conversions.
24784 @item -mcache-size=@var{cache-size}
24785 @opindex mcache-size
24786 This option controls the version of libgcc that the compiler links to an
24787 executable and selects a software-managed cache for accessing variables
24788 in the @code{__ea} address space with a particular cache size.  Possible
24789 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24790 and @samp{128}.  The default cache size is 64KB.
24792 @item -matomic-updates
24793 @itemx -mno-atomic-updates
24794 @opindex matomic-updates
24795 @opindex mno-atomic-updates
24796 This option controls the version of libgcc that the compiler links to an
24797 executable and selects whether atomic updates to the software-managed
24798 cache of PPU-side variables are used.  If you use atomic updates, changes
24799 to a PPU variable from SPU code using the @code{__ea} named address space
24800 qualifier do not interfere with changes to other PPU variables residing
24801 in the same cache line from PPU code.  If you do not use atomic updates,
24802 such interference may occur; however, writing back cache lines is
24803 more efficient.  The default behavior is to use atomic updates.
24805 @item -mdual-nops
24806 @itemx -mdual-nops=@var{n}
24807 @opindex mdual-nops
24808 By default, GCC inserts NOPs to increase dual issue when it expects
24809 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24810 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24811 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24813 @item -mhint-max-nops=@var{n}
24814 @opindex mhint-max-nops
24815 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24816 be at least 8 instructions away from the branch it is affecting.  GCC
24817 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24818 generate the branch hint.
24820 @item -mhint-max-distance=@var{n}
24821 @opindex mhint-max-distance
24822 The encoding of the branch hint instruction limits the hint to be within
24823 256 instructions of the branch it is affecting.  By default, GCC makes
24824 sure it is within 125.
24826 @item -msafe-hints
24827 @opindex msafe-hints
24828 Work around a hardware bug that causes the SPU to stall indefinitely.
24829 By default, GCC inserts the @code{hbrp} instruction to make sure
24830 this stall won't happen.
24832 @end table
24834 @node System V Options
24835 @subsection Options for System V
24837 These additional options are available on System V Release 4 for
24838 compatibility with other compilers on those systems:
24840 @table @gcctabopt
24841 @item -G
24842 @opindex G
24843 Create a shared object.
24844 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24846 @item -Qy
24847 @opindex Qy
24848 Identify the versions of each tool used by the compiler, in a
24849 @code{.ident} assembler directive in the output.
24851 @item -Qn
24852 @opindex Qn
24853 Refrain from adding @code{.ident} directives to the output file (this is
24854 the default).
24856 @item -YP,@var{dirs}
24857 @opindex YP
24858 Search the directories @var{dirs}, and no others, for libraries
24859 specified with @option{-l}.
24861 @item -Ym,@var{dir}
24862 @opindex Ym
24863 Look in the directory @var{dir} to find the M4 preprocessor.
24864 The assembler uses this option.
24865 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24866 @c the generic assembler that comes with Solaris takes just -Ym.
24867 @end table
24869 @node TILE-Gx Options
24870 @subsection TILE-Gx Options
24871 @cindex TILE-Gx options
24873 These @samp{-m} options are supported on the TILE-Gx:
24875 @table @gcctabopt
24876 @item -mcmodel=small
24877 @opindex mcmodel=small
24878 Generate code for the small model.  The distance for direct calls is
24879 limited to 500M in either direction.  PC-relative addresses are 32
24880 bits.  Absolute addresses support the full address range.
24882 @item -mcmodel=large
24883 @opindex mcmodel=large
24884 Generate code for the large model.  There is no limitation on call
24885 distance, pc-relative addresses, or absolute addresses.
24887 @item -mcpu=@var{name}
24888 @opindex mcpu
24889 Selects the type of CPU to be targeted.  Currently the only supported
24890 type is @samp{tilegx}.
24892 @item -m32
24893 @itemx -m64
24894 @opindex m32
24895 @opindex m64
24896 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24897 environment sets int, long, and pointer to 32 bits.  The 64-bit
24898 environment sets int to 32 bits and long and pointer to 64 bits.
24900 @item -mbig-endian
24901 @itemx -mlittle-endian
24902 @opindex mbig-endian
24903 @opindex mlittle-endian
24904 Generate code in big/little endian mode, respectively.
24905 @end table
24907 @node TILEPro Options
24908 @subsection TILEPro Options
24909 @cindex TILEPro options
24911 These @samp{-m} options are supported on the TILEPro:
24913 @table @gcctabopt
24914 @item -mcpu=@var{name}
24915 @opindex mcpu
24916 Selects the type of CPU to be targeted.  Currently the only supported
24917 type is @samp{tilepro}.
24919 @item -m32
24920 @opindex m32
24921 Generate code for a 32-bit environment, which sets int, long, and
24922 pointer to 32 bits.  This is the only supported behavior so the flag
24923 is essentially ignored.
24924 @end table
24926 @node V850 Options
24927 @subsection V850 Options
24928 @cindex V850 Options
24930 These @samp{-m} options are defined for V850 implementations:
24932 @table @gcctabopt
24933 @item -mlong-calls
24934 @itemx -mno-long-calls
24935 @opindex mlong-calls
24936 @opindex mno-long-calls
24937 Treat all calls as being far away (near).  If calls are assumed to be
24938 far away, the compiler always loads the function's address into a
24939 register, and calls indirect through the pointer.
24941 @item -mno-ep
24942 @itemx -mep
24943 @opindex mno-ep
24944 @opindex mep
24945 Do not optimize (do optimize) basic blocks that use the same index
24946 pointer 4 or more times to copy pointer into the @code{ep} register, and
24947 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24948 option is on by default if you optimize.
24950 @item -mno-prolog-function
24951 @itemx -mprolog-function
24952 @opindex mno-prolog-function
24953 @opindex mprolog-function
24954 Do not use (do use) external functions to save and restore registers
24955 at the prologue and epilogue of a function.  The external functions
24956 are slower, but use less code space if more than one function saves
24957 the same number of registers.  The @option{-mprolog-function} option
24958 is on by default if you optimize.
24960 @item -mspace
24961 @opindex mspace
24962 Try to make the code as small as possible.  At present, this just turns
24963 on the @option{-mep} and @option{-mprolog-function} options.
24965 @item -mtda=@var{n}
24966 @opindex mtda
24967 Put static or global variables whose size is @var{n} bytes or less into
24968 the tiny data area that register @code{ep} points to.  The tiny data
24969 area can hold up to 256 bytes in total (128 bytes for byte references).
24971 @item -msda=@var{n}
24972 @opindex msda
24973 Put static or global variables whose size is @var{n} bytes or less into
24974 the small data area that register @code{gp} points to.  The small data
24975 area can hold up to 64 kilobytes.
24977 @item -mzda=@var{n}
24978 @opindex mzda
24979 Put static or global variables whose size is @var{n} bytes or less into
24980 the first 32 kilobytes of memory.
24982 @item -mv850
24983 @opindex mv850
24984 Specify that the target processor is the V850.
24986 @item -mv850e3v5
24987 @opindex mv850e3v5
24988 Specify that the target processor is the V850E3V5.  The preprocessor
24989 constant @code{__v850e3v5__} is defined if this option is used.
24991 @item -mv850e2v4
24992 @opindex mv850e2v4
24993 Specify that the target processor is the V850E3V5.  This is an alias for
24994 the @option{-mv850e3v5} option.
24996 @item -mv850e2v3
24997 @opindex mv850e2v3
24998 Specify that the target processor is the V850E2V3.  The preprocessor
24999 constant @code{__v850e2v3__} is defined if this option is used.
25001 @item -mv850e2
25002 @opindex mv850e2
25003 Specify that the target processor is the V850E2.  The preprocessor
25004 constant @code{__v850e2__} is defined if this option is used.
25006 @item -mv850e1
25007 @opindex mv850e1
25008 Specify that the target processor is the V850E1.  The preprocessor
25009 constants @code{__v850e1__} and @code{__v850e__} are defined if
25010 this option is used.
25012 @item -mv850es
25013 @opindex mv850es
25014 Specify that the target processor is the V850ES.  This is an alias for
25015 the @option{-mv850e1} option.
25017 @item -mv850e
25018 @opindex mv850e
25019 Specify that the target processor is the V850E@.  The preprocessor
25020 constant @code{__v850e__} is defined if this option is used.
25022 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
25023 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
25024 are defined then a default target processor is chosen and the
25025 relevant @samp{__v850*__} preprocessor constant is defined.
25027 The preprocessor constants @code{__v850} and @code{__v851__} are always
25028 defined, regardless of which processor variant is the target.
25030 @item -mdisable-callt
25031 @itemx -mno-disable-callt
25032 @opindex mdisable-callt
25033 @opindex mno-disable-callt
25034 This option suppresses generation of the @code{CALLT} instruction for the
25035 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
25036 architecture.
25038 This option is enabled by default when the RH850 ABI is
25039 in use (see @option{-mrh850-abi}), and disabled by default when the
25040 GCC ABI is in use.  If @code{CALLT} instructions are being generated
25041 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
25043 @item -mrelax
25044 @itemx -mno-relax
25045 @opindex mrelax
25046 @opindex mno-relax
25047 Pass on (or do not pass on) the @option{-mrelax} command-line option
25048 to the assembler.
25050 @item -mlong-jumps
25051 @itemx -mno-long-jumps
25052 @opindex mlong-jumps
25053 @opindex mno-long-jumps
25054 Disable (or re-enable) the generation of PC-relative jump instructions.
25056 @item -msoft-float
25057 @itemx -mhard-float
25058 @opindex msoft-float
25059 @opindex mhard-float
25060 Disable (or re-enable) the generation of hardware floating point
25061 instructions.  This option is only significant when the target
25062 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25063 instructions are being generated then the C preprocessor symbol
25064 @code{__FPU_OK__} is defined, otherwise the symbol
25065 @code{__NO_FPU__} is defined.
25067 @item -mloop
25068 @opindex mloop
25069 Enables the use of the e3v5 LOOP instruction.  The use of this
25070 instruction is not enabled by default when the e3v5 architecture is
25071 selected because its use is still experimental.
25073 @item -mrh850-abi
25074 @itemx -mghs
25075 @opindex mrh850-abi
25076 @opindex mghs
25077 Enables support for the RH850 version of the V850 ABI.  This is the
25078 default.  With this version of the ABI the following rules apply:
25080 @itemize
25081 @item
25082 Integer sized structures and unions are returned via a memory pointer
25083 rather than a register.
25085 @item
25086 Large structures and unions (more than 8 bytes in size) are passed by
25087 value.
25089 @item
25090 Functions are aligned to 16-bit boundaries.
25092 @item
25093 The @option{-m8byte-align} command-line option is supported.
25095 @item
25096 The @option{-mdisable-callt} command-line option is enabled by
25097 default.  The @option{-mno-disable-callt} command-line option is not
25098 supported.
25099 @end itemize
25101 When this version of the ABI is enabled the C preprocessor symbol
25102 @code{__V850_RH850_ABI__} is defined.
25104 @item -mgcc-abi
25105 @opindex mgcc-abi
25106 Enables support for the old GCC version of the V850 ABI.  With this
25107 version of the ABI the following rules apply:
25109 @itemize
25110 @item
25111 Integer sized structures and unions are returned in register @code{r10}.
25113 @item
25114 Large structures and unions (more than 8 bytes in size) are passed by
25115 reference.
25117 @item
25118 Functions are aligned to 32-bit boundaries, unless optimizing for
25119 size.
25121 @item
25122 The @option{-m8byte-align} command-line option is not supported.
25124 @item
25125 The @option{-mdisable-callt} command-line option is supported but not
25126 enabled by default.
25127 @end itemize
25129 When this version of the ABI is enabled the C preprocessor symbol
25130 @code{__V850_GCC_ABI__} is defined.
25132 @item -m8byte-align
25133 @itemx -mno-8byte-align
25134 @opindex m8byte-align
25135 @opindex mno-8byte-align
25136 Enables support for @code{double} and @code{long long} types to be
25137 aligned on 8-byte boundaries.  The default is to restrict the
25138 alignment of all objects to at most 4-bytes.  When
25139 @option{-m8byte-align} is in effect the C preprocessor symbol
25140 @code{__V850_8BYTE_ALIGN__} is defined.
25142 @item -mbig-switch
25143 @opindex mbig-switch
25144 Generate code suitable for big switch tables.  Use this option only if
25145 the assembler/linker complain about out of range branches within a switch
25146 table.
25148 @item -mapp-regs
25149 @opindex mapp-regs
25150 This option causes r2 and r5 to be used in the code generated by
25151 the compiler.  This setting is the default.
25153 @item -mno-app-regs
25154 @opindex mno-app-regs
25155 This option causes r2 and r5 to be treated as fixed registers.
25157 @end table
25159 @node VAX Options
25160 @subsection VAX Options
25161 @cindex VAX options
25163 These @samp{-m} options are defined for the VAX:
25165 @table @gcctabopt
25166 @item -munix
25167 @opindex munix
25168 Do not output certain jump instructions (@code{aobleq} and so on)
25169 that the Unix assembler for the VAX cannot handle across long
25170 ranges.
25172 @item -mgnu
25173 @opindex mgnu
25174 Do output those jump instructions, on the assumption that the
25175 GNU assembler is being used.
25177 @item -mg
25178 @opindex mg
25179 Output code for G-format floating-point numbers instead of D-format.
25180 @end table
25182 @node Visium Options
25183 @subsection Visium Options
25184 @cindex Visium options
25186 @table @gcctabopt
25188 @item -mdebug
25189 @opindex mdebug
25190 A program which performs file I/O and is destined to run on an MCM target
25191 should be linked with this option.  It causes the libraries libc.a and
25192 libdebug.a to be linked.  The program should be run on the target under
25193 the control of the GDB remote debugging stub.
25195 @item -msim
25196 @opindex msim
25197 A program which performs file I/O and is destined to run on the simulator
25198 should be linked with option.  This causes libraries libc.a and libsim.a to
25199 be linked.
25201 @item -mfpu
25202 @itemx -mhard-float
25203 @opindex mfpu
25204 @opindex mhard-float
25205 Generate code containing floating-point instructions.  This is the
25206 default.
25208 @item -mno-fpu
25209 @itemx -msoft-float
25210 @opindex mno-fpu
25211 @opindex msoft-float
25212 Generate code containing library calls for floating-point.
25214 @option{-msoft-float} changes the calling convention in the output file;
25215 therefore, it is only useful if you compile @emph{all} of a program with
25216 this option.  In particular, you need to compile @file{libgcc.a}, the
25217 library that comes with GCC, with @option{-msoft-float} in order for
25218 this to work.
25220 @item -mcpu=@var{cpu_type}
25221 @opindex mcpu
25222 Set the instruction set, register set, and instruction scheduling parameters
25223 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25224 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25226 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25228 By default (unless configured otherwise), GCC generates code for the GR5
25229 variant of the Visium architecture.  
25231 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25232 architecture.  The only difference from GR5 code is that the compiler will
25233 generate block move instructions.
25235 @item -mtune=@var{cpu_type}
25236 @opindex mtune
25237 Set the instruction scheduling parameters for machine type @var{cpu_type},
25238 but do not set the instruction set or register set that the option
25239 @option{-mcpu=@var{cpu_type}} would.
25241 @item -msv-mode
25242 @opindex msv-mode
25243 Generate code for the supervisor mode, where there are no restrictions on
25244 the access to general registers.  This is the default.
25246 @item -muser-mode
25247 @opindex muser-mode
25248 Generate code for the user mode, where the access to some general registers
25249 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25250 mode; on the GR6, only registers r29 to r31 are affected.
25251 @end table
25253 @node VMS Options
25254 @subsection VMS Options
25256 These @samp{-m} options are defined for the VMS implementations:
25258 @table @gcctabopt
25259 @item -mvms-return-codes
25260 @opindex mvms-return-codes
25261 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25262 condition (e.g.@ error) codes.
25264 @item -mdebug-main=@var{prefix}
25265 @opindex mdebug-main=@var{prefix}
25266 Flag the first routine whose name starts with @var{prefix} as the main
25267 routine for the debugger.
25269 @item -mmalloc64
25270 @opindex mmalloc64
25271 Default to 64-bit memory allocation routines.
25273 @item -mpointer-size=@var{size}
25274 @opindex mpointer-size=@var{size}
25275 Set the default size of pointers. Possible options for @var{size} are
25276 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25277 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25278 The later option disables @code{pragma pointer_size}.
25279 @end table
25281 @node VxWorks Options
25282 @subsection VxWorks Options
25283 @cindex VxWorks Options
25285 The options in this section are defined for all VxWorks targets.
25286 Options specific to the target hardware are listed with the other
25287 options for that target.
25289 @table @gcctabopt
25290 @item -mrtp
25291 @opindex mrtp
25292 GCC can generate code for both VxWorks kernels and real time processes
25293 (RTPs).  This option switches from the former to the latter.  It also
25294 defines the preprocessor macro @code{__RTP__}.
25296 @item -non-static
25297 @opindex non-static
25298 Link an RTP executable against shared libraries rather than static
25299 libraries.  The options @option{-static} and @option{-shared} can
25300 also be used for RTPs (@pxref{Link Options}); @option{-static}
25301 is the default.
25303 @item -Bstatic
25304 @itemx -Bdynamic
25305 @opindex Bstatic
25306 @opindex Bdynamic
25307 These options are passed down to the linker.  They are defined for
25308 compatibility with Diab.
25310 @item -Xbind-lazy
25311 @opindex Xbind-lazy
25312 Enable lazy binding of function calls.  This option is equivalent to
25313 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25315 @item -Xbind-now
25316 @opindex Xbind-now
25317 Disable lazy binding of function calls.  This option is the default and
25318 is defined for compatibility with Diab.
25319 @end table
25321 @node x86 Options
25322 @subsection x86 Options
25323 @cindex x86 Options
25325 These @samp{-m} options are defined for the x86 family of computers.
25327 @table @gcctabopt
25329 @item -march=@var{cpu-type}
25330 @opindex march
25331 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25332 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25333 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25334 to generate code that may not run at all on processors other than the one
25335 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25336 @option{-mtune=@var{cpu-type}}.
25338 The choices for @var{cpu-type} are:
25340 @table @samp
25341 @item native
25342 This selects the CPU to generate code for at compilation time by determining
25343 the processor type of the compiling machine.  Using @option{-march=native}
25344 enables all instruction subsets supported by the local machine (hence
25345 the result might not run on different machines).  Using @option{-mtune=native}
25346 produces code optimized for the local machine under the constraints
25347 of the selected instruction set.  
25349 @item i386
25350 Original Intel i386 CPU@.
25352 @item i486
25353 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25355 @item i586
25356 @itemx pentium
25357 Intel Pentium CPU with no MMX support.
25359 @item lakemont
25360 Intel Lakemont MCU, based on Intel Pentium CPU.
25362 @item pentium-mmx
25363 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25365 @item pentiumpro
25366 Intel Pentium Pro CPU@.
25368 @item i686
25369 When used with @option{-march}, the Pentium Pro
25370 instruction set is used, so the code runs on all i686 family chips.
25371 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25373 @item pentium2
25374 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25375 support.
25377 @item pentium3
25378 @itemx pentium3m
25379 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25380 set support.
25382 @item pentium-m
25383 Intel Pentium M; low-power version of Intel Pentium III CPU
25384 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25386 @item pentium4
25387 @itemx pentium4m
25388 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25390 @item prescott
25391 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25392 set support.
25394 @item nocona
25395 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25396 SSE2 and SSE3 instruction set support.
25398 @item core2
25399 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25400 instruction set support.
25402 @item nehalem
25403 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25404 SSE4.1, SSE4.2 and POPCNT instruction set support.
25406 @item westmere
25407 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25408 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25410 @item sandybridge
25411 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25412 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25414 @item ivybridge
25415 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25416 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25417 instruction set support.
25419 @item haswell
25420 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25421 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25422 BMI, BMI2 and F16C instruction set support.
25424 @item broadwell
25425 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25426 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25427 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25429 @item skylake
25430 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25431 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25432 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25433 XSAVES instruction set support.
25435 @item bonnell
25436 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25437 instruction set support.
25439 @item silvermont
25440 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25441 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25443 @item knl
25444 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25445 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25446 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25447 AVX512CD instruction set support.
25449 @item knm
25450 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25451 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25452 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25453 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25455 @item skylake-avx512
25456 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25457 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25458 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25459 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25461 @item cannonlake
25462 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25463 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25464 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25465 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25466 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25468 @item k6
25469 AMD K6 CPU with MMX instruction set support.
25471 @item k6-2
25472 @itemx k6-3
25473 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25475 @item athlon
25476 @itemx athlon-tbird
25477 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25478 support.
25480 @item athlon-4
25481 @itemx athlon-xp
25482 @itemx athlon-mp
25483 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25484 instruction set support.
25486 @item k8
25487 @itemx opteron
25488 @itemx athlon64
25489 @itemx athlon-fx
25490 Processors based on the AMD K8 core with x86-64 instruction set support,
25491 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25492 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25493 instruction set extensions.)
25495 @item k8-sse3
25496 @itemx opteron-sse3
25497 @itemx athlon64-sse3
25498 Improved versions of AMD K8 cores with SSE3 instruction set support.
25500 @item amdfam10
25501 @itemx barcelona
25502 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25503 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25504 instruction set extensions.)
25506 @item bdver1
25507 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25508 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25509 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25510 @item bdver2
25511 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25512 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25513 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25514 extensions.)
25515 @item bdver3
25516 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25517 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25518 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25519 64-bit instruction set extensions.
25520 @item bdver4
25521 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25522 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25523 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25524 SSE4.2, ABM and 64-bit instruction set extensions.
25526 @item znver1
25527 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25528 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25529 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25530 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25531 instruction set extensions.
25533 @item btver1
25534 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25535 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25536 instruction set extensions.)
25538 @item btver2
25539 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25540 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25541 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25543 @item winchip-c6
25544 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25545 set support.
25547 @item winchip2
25548 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25549 instruction set support.
25551 @item c3
25552 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25553 (No scheduling is implemented for this chip.)
25555 @item c3-2
25556 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25557 (No scheduling is implemented for this chip.)
25559 @item c7
25560 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25561 (No scheduling is implemented for this chip.)
25563 @item samuel-2
25564 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25565 (No scheduling is implemented for this chip.)
25567 @item nehemiah
25568 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25569 (No scheduling is implemented for this chip.)
25571 @item esther
25572 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25573 (No scheduling is implemented for this chip.)
25575 @item eden-x2
25576 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25577 (No scheduling is implemented for this chip.)
25579 @item eden-x4
25580 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25581 AVX and AVX2 instruction set support.
25582 (No scheduling is implemented for this chip.)
25584 @item nano
25585 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25586 instruction set support.
25587 (No scheduling is implemented for this chip.)
25589 @item nano-1000
25590 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25591 instruction set support.
25592 (No scheduling is implemented for this chip.)
25594 @item nano-2000
25595 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25596 instruction set support.
25597 (No scheduling is implemented for this chip.)
25599 @item nano-3000
25600 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25601 instruction set support.
25602 (No scheduling is implemented for this chip.)
25604 @item nano-x2
25605 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25606 instruction set support.
25607 (No scheduling is implemented for this chip.)
25609 @item nano-x4
25610 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25611 instruction set support.
25612 (No scheduling is implemented for this chip.)
25614 @item geode
25615 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25616 @end table
25618 @item -mtune=@var{cpu-type}
25619 @opindex mtune
25620 Tune to @var{cpu-type} everything applicable about the generated code, except
25621 for the ABI and the set of available instructions.  
25622 While picking a specific @var{cpu-type} schedules things appropriately
25623 for that particular chip, the compiler does not generate any code that
25624 cannot run on the default machine type unless you use a
25625 @option{-march=@var{cpu-type}} option.
25626 For example, if GCC is configured for i686-pc-linux-gnu
25627 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25628 but still runs on i686 machines.
25630 The choices for @var{cpu-type} are the same as for @option{-march}.
25631 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25633 @table @samp
25634 @item generic
25635 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25636 If you know the CPU on which your code will run, then you should use
25637 the corresponding @option{-mtune} or @option{-march} option instead of
25638 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25639 of your application will have, then you should use this option.
25641 As new processors are deployed in the marketplace, the behavior of this
25642 option will change.  Therefore, if you upgrade to a newer version of
25643 GCC, code generation controlled by this option will change to reflect
25644 the processors
25645 that are most common at the time that version of GCC is released.
25647 There is no @option{-march=generic} option because @option{-march}
25648 indicates the instruction set the compiler can use, and there is no
25649 generic instruction set applicable to all processors.  In contrast,
25650 @option{-mtune} indicates the processor (or, in this case, collection of
25651 processors) for which the code is optimized.
25653 @item intel
25654 Produce code optimized for the most current Intel processors, which are
25655 Haswell and Silvermont for this version of GCC.  If you know the CPU
25656 on which your code will run, then you should use the corresponding
25657 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25658 But, if you want your application performs better on both Haswell and
25659 Silvermont, then you should use this option.
25661 As new Intel processors are deployed in the marketplace, the behavior of
25662 this option will change.  Therefore, if you upgrade to a newer version of
25663 GCC, code generation controlled by this option will change to reflect
25664 the most current Intel processors at the time that version of GCC is
25665 released.
25667 There is no @option{-march=intel} option because @option{-march} indicates
25668 the instruction set the compiler can use, and there is no common
25669 instruction set applicable to all processors.  In contrast,
25670 @option{-mtune} indicates the processor (or, in this case, collection of
25671 processors) for which the code is optimized.
25672 @end table
25674 @item -mcpu=@var{cpu-type}
25675 @opindex mcpu
25676 A deprecated synonym for @option{-mtune}.
25678 @item -mfpmath=@var{unit}
25679 @opindex mfpmath
25680 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25681 for @var{unit} are:
25683 @table @samp
25684 @item 387
25685 Use the standard 387 floating-point coprocessor present on the majority of chips and
25686 emulated otherwise.  Code compiled with this option runs almost everywhere.
25687 The temporary results are computed in 80-bit precision instead of the precision
25688 specified by the type, resulting in slightly different results compared to most
25689 of other chips.  See @option{-ffloat-store} for more detailed description.
25691 This is the default choice for non-Darwin x86-32 targets.
25693 @item sse
25694 Use scalar floating-point instructions present in the SSE instruction set.
25695 This instruction set is supported by Pentium III and newer chips,
25696 and in the AMD line
25697 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25698 instruction set supports only single-precision arithmetic, thus the double and
25699 extended-precision arithmetic are still done using 387.  A later version, present
25700 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25701 arithmetic too.
25703 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25704 or @option{-msse2} switches to enable SSE extensions and make this option
25705 effective.  For the x86-64 compiler, these extensions are enabled by default.
25707 The resulting code should be considerably faster in the majority of cases and avoid
25708 the numerical instability problems of 387 code, but may break some existing
25709 code that expects temporaries to be 80 bits.
25711 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25712 and the default choice for x86-32 targets with the SSE2 instruction set
25713 when @option{-ffast-math} is enabled.
25715 @item sse,387
25716 @itemx sse+387
25717 @itemx both
25718 Attempt to utilize both instruction sets at once.  This effectively doubles the
25719 amount of available registers, and on chips with separate execution units for
25720 387 and SSE the execution resources too.  Use this option with care, as it is
25721 still experimental, because the GCC register allocator does not model separate
25722 functional units well, resulting in unstable performance.
25723 @end table
25725 @item -masm=@var{dialect}
25726 @opindex masm=@var{dialect}
25727 Output assembly instructions using selected @var{dialect}.  Also affects
25728 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25729 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25730 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25731 not support @samp{intel}.
25733 @item -mieee-fp
25734 @itemx -mno-ieee-fp
25735 @opindex mieee-fp
25736 @opindex mno-ieee-fp
25737 Control whether or not the compiler uses IEEE floating-point
25738 comparisons.  These correctly handle the case where the result of a
25739 comparison is unordered.
25741 @item -m80387
25742 @item -mhard-float
25743 @opindex 80387
25744 @opindex mhard-float
25745 Generate output containing 80387 instructions for floating point.
25747 @item -mno-80387
25748 @item -msoft-float
25749 @opindex no-80387
25750 @opindex msoft-float
25751 Generate output containing library calls for floating point.
25753 @strong{Warning:} the requisite libraries are not part of GCC@.
25754 Normally the facilities of the machine's usual C compiler are used, but
25755 this cannot be done directly in cross-compilation.  You must make your
25756 own arrangements to provide suitable library functions for
25757 cross-compilation.
25759 On machines where a function returns floating-point results in the 80387
25760 register stack, some floating-point opcodes may be emitted even if
25761 @option{-msoft-float} is used.
25763 @item -mno-fp-ret-in-387
25764 @opindex mno-fp-ret-in-387
25765 Do not use the FPU registers for return values of functions.
25767 The usual calling convention has functions return values of types
25768 @code{float} and @code{double} in an FPU register, even if there
25769 is no FPU@.  The idea is that the operating system should emulate
25770 an FPU@.
25772 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25773 in ordinary CPU registers instead.
25775 @item -mno-fancy-math-387
25776 @opindex mno-fancy-math-387
25777 Some 387 emulators do not support the @code{sin}, @code{cos} and
25778 @code{sqrt} instructions for the 387.  Specify this option to avoid
25779 generating those instructions.  This option is the default on
25780 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25781 indicates that the target CPU always has an FPU and so the
25782 instruction does not need emulation.  These
25783 instructions are not generated unless you also use the
25784 @option{-funsafe-math-optimizations} switch.
25786 @item -malign-double
25787 @itemx -mno-align-double
25788 @opindex malign-double
25789 @opindex mno-align-double
25790 Control whether GCC aligns @code{double}, @code{long double}, and
25791 @code{long long} variables on a two-word boundary or a one-word
25792 boundary.  Aligning @code{double} variables on a two-word boundary
25793 produces code that runs somewhat faster on a Pentium at the
25794 expense of more memory.
25796 On x86-64, @option{-malign-double} is enabled by default.
25798 @strong{Warning:} if you use the @option{-malign-double} switch,
25799 structures containing the above types are aligned differently than
25800 the published application binary interface specifications for the x86-32
25801 and are not binary compatible with structures in code compiled
25802 without that switch.
25804 @item -m96bit-long-double
25805 @itemx -m128bit-long-double
25806 @opindex m96bit-long-double
25807 @opindex m128bit-long-double
25808 These switches control the size of @code{long double} type.  The x86-32
25809 application binary interface specifies the size to be 96 bits,
25810 so @option{-m96bit-long-double} is the default in 32-bit mode.
25812 Modern architectures (Pentium and newer) prefer @code{long double}
25813 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25814 conforming to the ABI, this is not possible.  So specifying
25815 @option{-m128bit-long-double} aligns @code{long double}
25816 to a 16-byte boundary by padding the @code{long double} with an additional
25817 32-bit zero.
25819 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25820 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25822 Notice that neither of these options enable any extra precision over the x87
25823 standard of 80 bits for a @code{long double}.
25825 @strong{Warning:} if you override the default value for your target ABI, this
25826 changes the size of 
25827 structures and arrays containing @code{long double} variables,
25828 as well as modifying the function calling convention for functions taking
25829 @code{long double}.  Hence they are not binary-compatible
25830 with code compiled without that switch.
25832 @item -mlong-double-64
25833 @itemx -mlong-double-80
25834 @itemx -mlong-double-128
25835 @opindex mlong-double-64
25836 @opindex mlong-double-80
25837 @opindex mlong-double-128
25838 These switches control the size of @code{long double} type. A size
25839 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25840 type. This is the default for 32-bit Bionic C library.  A size
25841 of 128 bits makes the @code{long double} type equivalent to the
25842 @code{__float128} type. This is the default for 64-bit Bionic C library.
25844 @strong{Warning:} if you override the default value for your target ABI, this
25845 changes the size of
25846 structures and arrays containing @code{long double} variables,
25847 as well as modifying the function calling convention for functions taking
25848 @code{long double}.  Hence they are not binary-compatible
25849 with code compiled without that switch.
25851 @item -malign-data=@var{type}
25852 @opindex malign-data
25853 Control how GCC aligns variables.  Supported values for @var{type} are
25854 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25855 and earlier, @samp{abi} uses alignment value as specified by the
25856 psABI, and @samp{cacheline} uses increased alignment value to match
25857 the cache line size.  @samp{compat} is the default.
25859 @item -mlarge-data-threshold=@var{threshold}
25860 @opindex mlarge-data-threshold
25861 When @option{-mcmodel=medium} is specified, data objects larger than
25862 @var{threshold} are placed in the large data section.  This value must be the
25863 same across all objects linked into the binary, and defaults to 65535.
25865 @item -mrtd
25866 @opindex mrtd
25867 Use a different function-calling convention, in which functions that
25868 take a fixed number of arguments return with the @code{ret @var{num}}
25869 instruction, which pops their arguments while returning.  This saves one
25870 instruction in the caller since there is no need to pop the arguments
25871 there.
25873 You can specify that an individual function is called with this calling
25874 sequence with the function attribute @code{stdcall}.  You can also
25875 override the @option{-mrtd} option by using the function attribute
25876 @code{cdecl}.  @xref{Function Attributes}.
25878 @strong{Warning:} this calling convention is incompatible with the one
25879 normally used on Unix, so you cannot use it if you need to call
25880 libraries compiled with the Unix compiler.
25882 Also, you must provide function prototypes for all functions that
25883 take variable numbers of arguments (including @code{printf});
25884 otherwise incorrect code is generated for calls to those
25885 functions.
25887 In addition, seriously incorrect code results if you call a
25888 function with too many arguments.  (Normally, extra arguments are
25889 harmlessly ignored.)
25891 @item -mregparm=@var{num}
25892 @opindex mregparm
25893 Control how many registers are used to pass integer arguments.  By
25894 default, no registers are used to pass arguments, and at most 3
25895 registers can be used.  You can control this behavior for a specific
25896 function by using the function attribute @code{regparm}.
25897 @xref{Function Attributes}.
25899 @strong{Warning:} if you use this switch, and
25900 @var{num} is nonzero, then you must build all modules with the same
25901 value, including any libraries.  This includes the system libraries and
25902 startup modules.
25904 @item -msseregparm
25905 @opindex msseregparm
25906 Use SSE register passing conventions for float and double arguments
25907 and return values.  You can control this behavior for a specific
25908 function by using the function attribute @code{sseregparm}.
25909 @xref{Function Attributes}.
25911 @strong{Warning:} if you use this switch then you must build all
25912 modules with the same value, including any libraries.  This includes
25913 the system libraries and startup modules.
25915 @item -mvect8-ret-in-mem
25916 @opindex mvect8-ret-in-mem
25917 Return 8-byte vectors in memory instead of MMX registers.  This is the
25918 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25919 Studio compilers until version 12.  Later compiler versions (starting
25920 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25921 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25922 you need to remain compatible with existing code produced by those
25923 previous compiler versions or older versions of GCC@.
25925 @item -mpc32
25926 @itemx -mpc64
25927 @itemx -mpc80
25928 @opindex mpc32
25929 @opindex mpc64
25930 @opindex mpc80
25932 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25933 is specified, the significands of results of floating-point operations are
25934 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25935 significands of results of floating-point operations to 53 bits (double
25936 precision) and @option{-mpc80} rounds the significands of results of
25937 floating-point operations to 64 bits (extended double precision), which is
25938 the default.  When this option is used, floating-point operations in higher
25939 precisions are not available to the programmer without setting the FPU
25940 control word explicitly.
25942 Setting the rounding of floating-point operations to less than the default
25943 80 bits can speed some programs by 2% or more.  Note that some mathematical
25944 libraries assume that extended-precision (80-bit) floating-point operations
25945 are enabled by default; routines in such libraries could suffer significant
25946 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25947 when this option is used to set the precision to less than extended precision.
25949 @item -mstackrealign
25950 @opindex mstackrealign
25951 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25952 option generates an alternate prologue and epilogue that realigns the
25953 run-time stack if necessary.  This supports mixing legacy codes that keep
25954 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25955 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25956 applicable to individual functions.
25958 @item -mpreferred-stack-boundary=@var{num}
25959 @opindex mpreferred-stack-boundary
25960 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25961 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25962 the default is 4 (16 bytes or 128 bits).
25964 @strong{Warning:} When generating code for the x86-64 architecture with
25965 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25966 used to keep the stack boundary aligned to 8 byte boundary.  Since
25967 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25968 intended to be used in controlled environment where stack space is
25969 important limitation.  This option leads to wrong code when functions
25970 compiled with 16 byte stack alignment (such as functions from a standard
25971 library) are called with misaligned stack.  In this case, SSE
25972 instructions may lead to misaligned memory access traps.  In addition,
25973 variable arguments are handled incorrectly for 16 byte aligned
25974 objects (including x87 long double and __int128), leading to wrong
25975 results.  You must build all modules with
25976 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25977 includes the system libraries and startup modules.
25979 @item -mincoming-stack-boundary=@var{num}
25980 @opindex mincoming-stack-boundary
25981 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25982 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25983 the one specified by @option{-mpreferred-stack-boundary} is used.
25985 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25986 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25987 suffer significant run time performance penalties.  On Pentium III, the
25988 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25989 properly if it is not 16-byte aligned.
25991 To ensure proper alignment of this values on the stack, the stack boundary
25992 must be as aligned as that required by any value stored on the stack.
25993 Further, every function must be generated such that it keeps the stack
25994 aligned.  Thus calling a function compiled with a higher preferred
25995 stack boundary from a function compiled with a lower preferred stack
25996 boundary most likely misaligns the stack.  It is recommended that
25997 libraries that use callbacks always use the default setting.
25999 This extra alignment does consume extra stack space, and generally
26000 increases code size.  Code that is sensitive to stack space usage, such
26001 as embedded systems and operating system kernels, may want to reduce the
26002 preferred alignment to @option{-mpreferred-stack-boundary=2}.
26004 @need 200
26005 @item -mmmx
26006 @opindex mmmx
26007 @need 200
26008 @itemx -msse
26009 @opindex msse
26010 @need 200
26011 @itemx -msse2
26012 @opindex msse2
26013 @need 200
26014 @itemx -msse3
26015 @opindex msse3
26016 @need 200
26017 @itemx -mssse3
26018 @opindex mssse3
26019 @need 200
26020 @itemx -msse4
26021 @opindex msse4
26022 @need 200
26023 @itemx -msse4a
26024 @opindex msse4a
26025 @need 200
26026 @itemx -msse4.1
26027 @opindex msse4.1
26028 @need 200
26029 @itemx -msse4.2
26030 @opindex msse4.2
26031 @need 200
26032 @itemx -mavx
26033 @opindex mavx
26034 @need 200
26035 @itemx -mavx2
26036 @opindex mavx2
26037 @need 200
26038 @itemx -mavx512f
26039 @opindex mavx512f
26040 @need 200
26041 @itemx -mavx512pf
26042 @opindex mavx512pf
26043 @need 200
26044 @itemx -mavx512er
26045 @opindex mavx512er
26046 @need 200
26047 @itemx -mavx512cd
26048 @opindex mavx512cd
26049 @need 200
26050 @itemx -mavx512vl
26051 @opindex mavx512vl
26052 @need 200
26053 @itemx -mavx512bw
26054 @opindex mavx512bw
26055 @need 200
26056 @itemx -mavx512dq
26057 @opindex mavx512dq
26058 @need 200
26059 @itemx -mavx512ifma
26060 @opindex mavx512ifma
26061 @need 200
26062 @itemx -mavx512vbmi
26063 @opindex mavx512vbmi
26064 @need 200
26065 @itemx -msha
26066 @opindex msha
26067 @need 200
26068 @itemx -maes
26069 @opindex maes
26070 @need 200
26071 @itemx -mpclmul
26072 @opindex mpclmul
26073 @need 200
26074 @itemx -mclfushopt
26075 @opindex mclfushopt
26076 @need 200
26077 @itemx -mfsgsbase
26078 @opindex mfsgsbase
26079 @need 200
26080 @itemx -mrdrnd
26081 @opindex mrdrnd
26082 @need 200
26083 @itemx -mf16c
26084 @opindex mf16c
26085 @need 200
26086 @itemx -mfma
26087 @opindex mfma
26088 @need 200
26089 @itemx -mfma4
26090 @opindex mfma4
26091 @need 200
26092 @itemx -mprefetchwt1
26093 @opindex mprefetchwt1
26094 @need 200
26095 @itemx -mxop
26096 @opindex mxop
26097 @need 200
26098 @itemx -mlwp
26099 @opindex mlwp
26100 @need 200
26101 @itemx -m3dnow
26102 @opindex m3dnow
26103 @need 200
26104 @itemx -m3dnowa
26105 @opindex m3dnowa
26106 @need 200
26107 @itemx -mpopcnt
26108 @opindex mpopcnt
26109 @need 200
26110 @itemx -mabm
26111 @opindex mabm
26112 @need 200
26113 @itemx -mbmi
26114 @opindex mbmi
26115 @need 200
26116 @itemx -mbmi2
26117 @need 200
26118 @itemx -mlzcnt
26119 @opindex mlzcnt
26120 @need 200
26121 @itemx -mfxsr
26122 @opindex mfxsr
26123 @need 200
26124 @itemx -mxsave
26125 @opindex mxsave
26126 @need 200
26127 @itemx -mxsaveopt
26128 @opindex mxsaveopt
26129 @need 200
26130 @itemx -mxsavec
26131 @opindex mxsavec
26132 @need 200
26133 @itemx -mxsaves
26134 @opindex mxsaves
26135 @need 200
26136 @itemx -mrtm
26137 @opindex mrtm
26138 @need 200
26139 @itemx -mtbm
26140 @opindex mtbm
26141 @need 200
26142 @itemx -mmpx
26143 @opindex mmpx
26144 @need 200
26145 @itemx -mmwaitx
26146 @opindex mmwaitx
26147 @need 200
26148 @itemx -mclzero
26149 @opindex mclzero
26150 @need 200
26151 @itemx -mpku
26152 @opindex mpku
26153 @need 200
26154 @itemx -mcet
26155 @opindex mcet
26156 @need 200
26157 @itemx -mavx512vbmi2
26158 @opindex mavx512vbmi2
26159 @need 200
26160 @itemx -mgfni
26161 @opindex mgfni
26162 @need 200
26163 @itemx -mvaes
26164 @opindex mvaes
26165 @need 200
26166 @itemx -mvpclmulqdq
26167 @opindex mvpclmulqdq
26168 @need 200
26169 @itemx -mavx512bitalg
26170 @opindex mavx512bitalg
26171 @need 200
26172 @itemx -mavx512vpopcntdq
26173 @opindex mavx512vpopcntdq
26174 These switches enable the use of instructions in the MMX, SSE,
26175 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26176 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26177 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
26178 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26179 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
26180 extended instruction sets.
26181 Each has a corresponding @option{-mno-} option to disable use of these
26182 instructions.
26184 These extensions are also available as built-in functions: see
26185 @ref{x86 Built-in Functions}, for details of the functions enabled and
26186 disabled by these switches.
26188 To generate SSE/SSE2 instructions automatically from floating-point
26189 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26191 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26192 generates new AVX instructions or AVX equivalence for all SSEx instructions
26193 when needed.
26195 These options enable GCC to use these extended instructions in
26196 generated code, even without @option{-mfpmath=sse}.  Applications that
26197 perform run-time CPU detection must compile separate files for each
26198 supported architecture, using the appropriate flags.  In particular,
26199 the file containing the CPU detection code should be compiled without
26200 these options.
26202 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26203 options.  The @option{-mibt} option enables indirect branch tracking support
26204 and the @option{-mshstk} option enables shadow stack support from
26205 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26206 a number of built-in functions for fine-grained control in a CET-based
26207 application.  See @xref{x86 Built-in Functions}, for more information.
26209 @item -mdump-tune-features
26210 @opindex mdump-tune-features
26211 This option instructs GCC to dump the names of the x86 performance 
26212 tuning features and default settings. The names can be used in 
26213 @option{-mtune-ctrl=@var{feature-list}}.
26215 @item -mtune-ctrl=@var{feature-list}
26216 @opindex mtune-ctrl=@var{feature-list}
26217 This option is used to do fine grain control of x86 code generation features.
26218 @var{feature-list} is a comma separated list of @var{feature} names. See also
26219 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26220 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26221 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26222 developers. Using it may lead to code paths not covered by testing and can
26223 potentially result in compiler ICEs or runtime errors.
26225 @item -mno-default
26226 @opindex mno-default
26227 This option instructs GCC to turn off all tunable features. See also 
26228 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26230 @item -mcld
26231 @opindex mcld
26232 This option instructs GCC to emit a @code{cld} instruction in the prologue
26233 of functions that use string instructions.  String instructions depend on
26234 the DF flag to select between autoincrement or autodecrement mode.  While the
26235 ABI specifies the DF flag to be cleared on function entry, some operating
26236 systems violate this specification by not clearing the DF flag in their
26237 exception dispatchers.  The exception handler can be invoked with the DF flag
26238 set, which leads to wrong direction mode when string instructions are used.
26239 This option can be enabled by default on 32-bit x86 targets by configuring
26240 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26241 instructions can be suppressed with the @option{-mno-cld} compiler option
26242 in this case.
26244 @item -mvzeroupper
26245 @opindex mvzeroupper
26246 This option instructs GCC to emit a @code{vzeroupper} instruction
26247 before a transfer of control flow out of the function to minimize
26248 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26249 intrinsics.
26251 @item -mprefer-avx128
26252 @opindex mprefer-avx128
26253 This option instructs GCC to use 128-bit AVX instructions instead of
26254 256-bit AVX instructions in the auto-vectorizer.
26256 @item -mprefer-vector-width=@var{opt}
26257 @opindex mprefer-vector-width
26258 This option instructs GCC to use @var{opt}-bit vector width in instructions
26259 instead of default on the selected platform.
26261 @table @samp
26262 @item none
26263 No extra limitations applied to GCC other than defined by the selected platform.
26265 @item 128
26266 Prefer 128-bit vector width for instructions.
26268 @item 256
26269 Prefer 256-bit vector width for instructions.
26271 @item 512
26272 Prefer 512-bit vector width for instructions.
26273 @end table
26275 @item -mcx16
26276 @opindex mcx16
26277 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26278 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26279 objects.  This is useful for atomic updates of data structures exceeding one
26280 machine word in size.  The compiler uses this instruction to implement
26281 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26282 128-bit integers, a library call is always used.
26284 @item -msahf
26285 @opindex msahf
26286 This option enables generation of @code{SAHF} instructions in 64-bit code.
26287 Early Intel Pentium 4 CPUs with Intel 64 support,
26288 prior to the introduction of Pentium 4 G1 step in December 2005,
26289 lacked the @code{LAHF} and @code{SAHF} instructions
26290 which are supported by AMD64.
26291 These are load and store instructions, respectively, for certain status flags.
26292 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26293 @code{drem}, and @code{remainder} built-in functions;
26294 see @ref{Other Builtins} for details.
26296 @item -mmovbe
26297 @opindex mmovbe
26298 This option enables use of the @code{movbe} instruction to implement
26299 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26301 @item -mibt
26302 @opindex mibt
26303 This option tells the compiler to use indirect branch tracking support
26304 (for indirect calls and jumps) from x86 Control-flow Enforcement
26305 Technology (CET).  The option has effect only if the
26306 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26307 is specified. The option @option{-mibt} is on by default when the
26308 @code{-mcet} option is specified.
26310 @item -mshstk
26311 @opindex mshstk
26312 This option tells the compiler to use shadow stack support (return
26313 address tracking) from x86 Control-flow Enforcement Technology (CET).
26314 The option has effect only if the @option{-fcf-protection=full} or
26315 @option{-fcf-protection=return} option is specified.  The option
26316 @option{-mshstk} is on by default when the @option{-mcet} option is
26317 specified.
26319 @item -mcrc32
26320 @opindex mcrc32
26321 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26322 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26323 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26325 @item -mrecip
26326 @opindex mrecip
26327 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26328 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26329 with an additional Newton-Raphson step
26330 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26331 (and their vectorized
26332 variants) for single-precision floating-point arguments.  These instructions
26333 are generated only when @option{-funsafe-math-optimizations} is enabled
26334 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26335 Note that while the throughput of the sequence is higher than the throughput
26336 of the non-reciprocal instruction, the precision of the sequence can be
26337 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26339 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26340 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26341 combination), and doesn't need @option{-mrecip}.
26343 Also note that GCC emits the above sequence with additional Newton-Raphson step
26344 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26345 already with @option{-ffast-math} (or the above option combination), and
26346 doesn't need @option{-mrecip}.
26348 @item -mrecip=@var{opt}
26349 @opindex mrecip=opt
26350 This option controls which reciprocal estimate instructions
26351 may be used.  @var{opt} is a comma-separated list of options, which may
26352 be preceded by a @samp{!} to invert the option:
26354 @table @samp
26355 @item all
26356 Enable all estimate instructions.
26358 @item default
26359 Enable the default instructions, equivalent to @option{-mrecip}.
26361 @item none
26362 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26364 @item div
26365 Enable the approximation for scalar division.
26367 @item vec-div
26368 Enable the approximation for vectorized division.
26370 @item sqrt
26371 Enable the approximation for scalar square root.
26373 @item vec-sqrt
26374 Enable the approximation for vectorized square root.
26375 @end table
26377 So, for example, @option{-mrecip=all,!sqrt} enables
26378 all of the reciprocal approximations, except for square root.
26380 @item -mveclibabi=@var{type}
26381 @opindex mveclibabi
26382 Specifies the ABI type to use for vectorizing intrinsics using an
26383 external library.  Supported values for @var{type} are @samp{svml} 
26384 for the Intel short
26385 vector math library and @samp{acml} for the AMD math core library.
26386 To use this option, both @option{-ftree-vectorize} and
26387 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26388 ABI-compatible library must be specified at link time.
26390 GCC currently emits calls to @code{vmldExp2},
26391 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26392 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26393 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26394 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26395 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26396 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26397 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26398 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26399 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26400 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26401 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26402 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26403 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26404 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26405 when @option{-mveclibabi=acml} is used.  
26407 @item -mabi=@var{name}
26408 @opindex mabi
26409 Generate code for the specified calling convention.  Permissible values
26410 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26411 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26412 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26413 You can control this behavior for specific functions by
26414 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26415 @xref{Function Attributes}.
26417 @item -mforce-indirect-call
26418 @opindex mforce-indirect-call
26419 Force all calls to functions to be indirect. This is useful
26420 when using Intel Processor Trace where it generates more precise timing
26421 information for function calls.
26423 @item -mcall-ms2sysv-xlogues
26424 @opindex mcall-ms2sysv-xlogues
26425 @opindex mno-call-ms2sysv-xlogues
26426 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26427 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26428 default, the code for saving and restoring these registers is emitted inline,
26429 resulting in fairly lengthy prologues and epilogues.  Using
26430 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26431 use stubs in the static portion of libgcc to perform these saves and restores,
26432 thus reducing function size at the cost of a few extra instructions.
26434 @item -mtls-dialect=@var{type}
26435 @opindex mtls-dialect
26436 Generate code to access thread-local storage using the @samp{gnu} or
26437 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26438 @samp{gnu2} is more efficient, but it may add compile- and run-time
26439 requirements that cannot be satisfied on all systems.
26441 @item -mpush-args
26442 @itemx -mno-push-args
26443 @opindex mpush-args
26444 @opindex mno-push-args
26445 Use PUSH operations to store outgoing parameters.  This method is shorter
26446 and usually equally fast as method using SUB/MOV operations and is enabled
26447 by default.  In some cases disabling it may improve performance because of
26448 improved scheduling and reduced dependencies.
26450 @item -maccumulate-outgoing-args
26451 @opindex maccumulate-outgoing-args
26452 If enabled, the maximum amount of space required for outgoing arguments is
26453 computed in the function prologue.  This is faster on most modern CPUs
26454 because of reduced dependencies, improved scheduling and reduced stack usage
26455 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26456 increase in code size.  This switch implies @option{-mno-push-args}.
26458 @item -mthreads
26459 @opindex mthreads
26460 Support thread-safe exception handling on MinGW.  Programs that rely
26461 on thread-safe exception handling must compile and link all code with the
26462 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26463 @option{-D_MT}; when linking, it links in a special thread helper library
26464 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26466 @item -mms-bitfields
26467 @itemx -mno-ms-bitfields
26468 @opindex mms-bitfields
26469 @opindex mno-ms-bitfields
26471 Enable/disable bit-field layout compatible with the native Microsoft
26472 Windows compiler.  
26474 If @code{packed} is used on a structure, or if bit-fields are used,
26475 it may be that the Microsoft ABI lays out the structure differently
26476 than the way GCC normally does.  Particularly when moving packed
26477 data between functions compiled with GCC and the native Microsoft compiler
26478 (either via function call or as data in a file), it may be necessary to access
26479 either format.
26481 This option is enabled by default for Microsoft Windows
26482 targets.  This behavior can also be controlled locally by use of variable
26483 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26484 and @ref{x86 Type Attributes}.
26486 The Microsoft structure layout algorithm is fairly simple with the exception
26487 of the bit-field packing.  
26488 The padding and alignment of members of structures and whether a bit-field 
26489 can straddle a storage-unit boundary are determine by these rules:
26491 @enumerate
26492 @item Structure members are stored sequentially in the order in which they are
26493 declared: the first member has the lowest memory address and the last member
26494 the highest.
26496 @item Every data object has an alignment requirement.  The alignment requirement
26497 for all data except structures, unions, and arrays is either the size of the
26498 object or the current packing size (specified with either the
26499 @code{aligned} attribute or the @code{pack} pragma),
26500 whichever is less.  For structures, unions, and arrays,
26501 the alignment requirement is the largest alignment requirement of its members.
26502 Every object is allocated an offset so that:
26504 @smallexample
26505 offset % alignment_requirement == 0
26506 @end smallexample
26508 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26509 unit if the integral types are the same size and if the next bit-field fits
26510 into the current allocation unit without crossing the boundary imposed by the
26511 common alignment requirements of the bit-fields.
26512 @end enumerate
26514 MSVC interprets zero-length bit-fields in the following ways:
26516 @enumerate
26517 @item If a zero-length bit-field is inserted between two bit-fields that
26518 are normally coalesced, the bit-fields are not coalesced.
26520 For example:
26522 @smallexample
26523 struct
26524  @{
26525    unsigned long bf_1 : 12;
26526    unsigned long : 0;
26527    unsigned long bf_2 : 12;
26528  @} t1;
26529 @end smallexample
26531 @noindent
26532 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26533 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26535 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26536 alignment of the zero-length bit-field is greater than the member that follows it,
26537 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26539 For example:
26541 @smallexample
26542 struct
26543  @{
26544    char foo : 4;
26545    short : 0;
26546    char bar;
26547  @} t2;
26549 struct
26550  @{
26551    char foo : 4;
26552    short : 0;
26553    double bar;
26554  @} t3;
26555 @end smallexample
26557 @noindent
26558 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26559 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26560 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26561 of the structure.
26563 Taking this into account, it is important to note the following:
26565 @enumerate
26566 @item If a zero-length bit-field follows a normal bit-field, the type of the
26567 zero-length bit-field may affect the alignment of the structure as whole. For
26568 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26569 normal bit-field, and is of type short.
26571 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26572 still affect the alignment of the structure:
26574 @smallexample
26575 struct
26576  @{
26577    char foo : 6;
26578    long : 0;
26579  @} t4;
26580 @end smallexample
26582 @noindent
26583 Here, @code{t4} takes up 4 bytes.
26584 @end enumerate
26586 @item Zero-length bit-fields following non-bit-field members are ignored:
26588 @smallexample
26589 struct
26590  @{
26591    char foo;
26592    long : 0;
26593    char bar;
26594  @} t5;
26595 @end smallexample
26597 @noindent
26598 Here, @code{t5} takes up 2 bytes.
26599 @end enumerate
26602 @item -mno-align-stringops
26603 @opindex mno-align-stringops
26604 Do not align the destination of inlined string operations.  This switch reduces
26605 code size and improves performance in case the destination is already aligned,
26606 but GCC doesn't know about it.
26608 @item -minline-all-stringops
26609 @opindex minline-all-stringops
26610 By default GCC inlines string operations only when the destination is 
26611 known to be aligned to least a 4-byte boundary.  
26612 This enables more inlining and increases code
26613 size, but may improve performance of code that depends on fast
26614 @code{memcpy}, @code{strlen},
26615 and @code{memset} for short lengths.
26617 @item -minline-stringops-dynamically
26618 @opindex minline-stringops-dynamically
26619 For string operations of unknown size, use run-time checks with
26620 inline code for small blocks and a library call for large blocks.
26622 @item -mstringop-strategy=@var{alg}
26623 @opindex mstringop-strategy=@var{alg}
26624 Override the internal decision heuristic for the particular algorithm to use
26625 for inlining string operations.  The allowed values for @var{alg} are:
26627 @table @samp
26628 @item rep_byte
26629 @itemx rep_4byte
26630 @itemx rep_8byte
26631 Expand using i386 @code{rep} prefix of the specified size.
26633 @item byte_loop
26634 @itemx loop
26635 @itemx unrolled_loop
26636 Expand into an inline loop.
26638 @item libcall
26639 Always use a library call.
26640 @end table
26642 @item -mmemcpy-strategy=@var{strategy}
26643 @opindex mmemcpy-strategy=@var{strategy}
26644 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26645 should be inlined and what inline algorithm to use when the expected size
26646 of the copy operation is known. @var{strategy} 
26647 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26648 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26649 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26650 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26651 in the list must be specified in increasing order.  The minimal byte size for 
26652 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26653 preceding range.
26655 @item -mmemset-strategy=@var{strategy}
26656 @opindex mmemset-strategy=@var{strategy}
26657 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26658 @code{__builtin_memset} expansion.
26660 @item -momit-leaf-frame-pointer
26661 @opindex momit-leaf-frame-pointer
26662 Don't keep the frame pointer in a register for leaf functions.  This
26663 avoids the instructions to save, set up, and restore frame pointers and
26664 makes an extra register available in leaf functions.  The option
26665 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26666 which might make debugging harder.
26668 @item -mtls-direct-seg-refs
26669 @itemx -mno-tls-direct-seg-refs
26670 @opindex mtls-direct-seg-refs
26671 Controls whether TLS variables may be accessed with offsets from the
26672 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26673 or whether the thread base pointer must be added.  Whether or not this
26674 is valid depends on the operating system, and whether it maps the
26675 segment to cover the entire TLS area.
26677 For systems that use the GNU C Library, the default is on.
26679 @item -msse2avx
26680 @itemx -mno-sse2avx
26681 @opindex msse2avx
26682 Specify that the assembler should encode SSE instructions with VEX
26683 prefix.  The option @option{-mavx} turns this on by default.
26685 @item -mfentry
26686 @itemx -mno-fentry
26687 @opindex mfentry
26688 If profiling is active (@option{-pg}), put the profiling
26689 counter call before the prologue.
26690 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26691 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26693 @item -mrecord-mcount
26694 @itemx -mno-record-mcount
26695 @opindex mrecord-mcount
26696 If profiling is active (@option{-pg}), generate a __mcount_loc section
26697 that contains pointers to each profiling call. This is useful for
26698 automatically patching and out calls.
26700 @item -mnop-mcount
26701 @itemx -mno-nop-mcount
26702 @opindex mnop-mcount
26703 If profiling is active (@option{-pg}), generate the calls to
26704 the profiling functions as NOPs. This is useful when they
26705 should be patched in later dynamically. This is likely only
26706 useful together with @option{-mrecord-mcount}.
26708 @item -mskip-rax-setup
26709 @itemx -mno-skip-rax-setup
26710 @opindex mskip-rax-setup
26711 When generating code for the x86-64 architecture with SSE extensions
26712 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26713 register when there are no variable arguments passed in vector registers.
26715 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26716 saving vector registers on stack when passing variable arguments, the
26717 impacts of this option are callees may waste some stack space,
26718 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26719 those issues, regardless the RAX register value.
26721 @item -m8bit-idiv
26722 @itemx -mno-8bit-idiv
26723 @opindex m8bit-idiv
26724 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26725 much faster than 32-bit/64-bit integer divide.  This option generates a
26726 run-time check.  If both dividend and divisor are within range of 0
26727 to 255, 8-bit unsigned integer divide is used instead of
26728 32-bit/64-bit integer divide.
26730 @item -mavx256-split-unaligned-load
26731 @itemx -mavx256-split-unaligned-store
26732 @opindex mavx256-split-unaligned-load
26733 @opindex mavx256-split-unaligned-store
26734 Split 32-byte AVX unaligned load and store.
26736 @item -mstack-protector-guard=@var{guard}
26737 @itemx -mstack-protector-guard-reg=@var{reg}
26738 @itemx -mstack-protector-guard-offset=@var{offset}
26739 @opindex mstack-protector-guard
26740 @opindex mstack-protector-guard-reg
26741 @opindex mstack-protector-guard-offset
26742 Generate stack protection code using canary at @var{guard}.  Supported
26743 locations are @samp{global} for global canary or @samp{tls} for per-thread
26744 canary in the TLS block (the default).  This option has effect only when
26745 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26747 With the latter choice the options
26748 @option{-mstack-protector-guard-reg=@var{reg}} and
26749 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26750 which segment register (@code{%fs} or @code{%gs}) to use as base register
26751 for reading the canary, and from what offset from that base register.
26752 The default for those is as specified in the relevant ABI.
26754 @item -mmitigate-rop
26755 @opindex mmitigate-rop
26756 Try to avoid generating code sequences that contain unintended return
26757 opcodes, to mitigate against certain forms of attack. At the moment,
26758 this option is limited in what it can do and should not be relied
26759 on to provide serious protection.
26761 @item -mgeneral-regs-only
26762 @opindex mgeneral-regs-only
26763 Generate code that uses only the general-purpose registers.  This
26764 prevents the compiler from using floating-point, vector, mask and bound
26765 registers.
26767 @end table
26769 These @samp{-m} switches are supported in addition to the above
26770 on x86-64 processors in 64-bit environments.
26772 @table @gcctabopt
26773 @item -m32
26774 @itemx -m64
26775 @itemx -mx32
26776 @itemx -m16
26777 @itemx -miamcu
26778 @opindex m32
26779 @opindex m64
26780 @opindex mx32
26781 @opindex m16
26782 @opindex miamcu
26783 Generate code for a 16-bit, 32-bit or 64-bit environment.
26784 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26785 to 32 bits, and
26786 generates code that runs on any i386 system.
26788 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26789 types to 64 bits, and generates code for the x86-64 architecture.
26790 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26791 and @option{-mdynamic-no-pic} options.
26793 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26794 to 32 bits, and
26795 generates code for the x86-64 architecture.
26797 The @option{-m16} option is the same as @option{-m32}, except for that
26798 it outputs the @code{.code16gcc} assembly directive at the beginning of
26799 the assembly output so that the binary can run in 16-bit mode.
26801 The @option{-miamcu} option generates code which conforms to Intel MCU
26802 psABI.  It requires the @option{-m32} option to be turned on.
26804 @item -mno-red-zone
26805 @opindex mno-red-zone
26806 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26807 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26808 stack pointer that is not modified by signal or interrupt handlers
26809 and therefore can be used for temporary data without adjusting the stack
26810 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26812 @item -mcmodel=small
26813 @opindex mcmodel=small
26814 Generate code for the small code model: the program and its symbols must
26815 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26816 Programs can be statically or dynamically linked.  This is the default
26817 code model.
26819 @item -mcmodel=kernel
26820 @opindex mcmodel=kernel
26821 Generate code for the kernel code model.  The kernel runs in the
26822 negative 2 GB of the address space.
26823 This model has to be used for Linux kernel code.
26825 @item -mcmodel=medium
26826 @opindex mcmodel=medium
26827 Generate code for the medium model: the program is linked in the lower 2
26828 GB of the address space.  Small symbols are also placed there.  Symbols
26829 with sizes larger than @option{-mlarge-data-threshold} are put into
26830 large data or BSS sections and can be located above 2GB.  Programs can
26831 be statically or dynamically linked.
26833 @item -mcmodel=large
26834 @opindex mcmodel=large
26835 Generate code for the large model.  This model makes no assumptions
26836 about addresses and sizes of sections.
26838 @item -maddress-mode=long
26839 @opindex maddress-mode=long
26840 Generate code for long address mode.  This is only supported for 64-bit
26841 and x32 environments.  It is the default address mode for 64-bit
26842 environments.
26844 @item -maddress-mode=short
26845 @opindex maddress-mode=short
26846 Generate code for short address mode.  This is only supported for 32-bit
26847 and x32 environments.  It is the default address mode for 32-bit and
26848 x32 environments.
26849 @end table
26851 @node x86 Windows Options
26852 @subsection x86 Windows Options
26853 @cindex x86 Windows Options
26854 @cindex Windows Options for x86
26856 These additional options are available for Microsoft Windows targets:
26858 @table @gcctabopt
26859 @item -mconsole
26860 @opindex mconsole
26861 This option
26862 specifies that a console application is to be generated, by
26863 instructing the linker to set the PE header subsystem type
26864 required for console applications.
26865 This option is available for Cygwin and MinGW targets and is
26866 enabled by default on those targets.
26868 @item -mdll
26869 @opindex mdll
26870 This option is available for Cygwin and MinGW targets.  It
26871 specifies that a DLL---a dynamic link library---is to be
26872 generated, enabling the selection of the required runtime
26873 startup object and entry point.
26875 @item -mnop-fun-dllimport
26876 @opindex mnop-fun-dllimport
26877 This option is available for Cygwin and MinGW targets.  It
26878 specifies that the @code{dllimport} attribute should be ignored.
26880 @item -mthread
26881 @opindex mthread
26882 This option is available for MinGW targets. It specifies
26883 that MinGW-specific thread support is to be used.
26885 @item -municode
26886 @opindex municode
26887 This option is available for MinGW-w64 targets.  It causes
26888 the @code{UNICODE} preprocessor macro to be predefined, and
26889 chooses Unicode-capable runtime startup code.
26891 @item -mwin32
26892 @opindex mwin32
26893 This option is available for Cygwin and MinGW targets.  It
26894 specifies that the typical Microsoft Windows predefined macros are to
26895 be set in the pre-processor, but does not influence the choice
26896 of runtime library/startup code.
26898 @item -mwindows
26899 @opindex mwindows
26900 This option is available for Cygwin and MinGW targets.  It
26901 specifies that a GUI application is to be generated by
26902 instructing the linker to set the PE header subsystem type
26903 appropriately.
26905 @item -fno-set-stack-executable
26906 @opindex fno-set-stack-executable
26907 This option is available for MinGW targets. It specifies that
26908 the executable flag for the stack used by nested functions isn't
26909 set. This is necessary for binaries running in kernel mode of
26910 Microsoft Windows, as there the User32 API, which is used to set executable
26911 privileges, isn't available.
26913 @item -fwritable-relocated-rdata
26914 @opindex fno-writable-relocated-rdata
26915 This option is available for MinGW and Cygwin targets.  It specifies
26916 that relocated-data in read-only section is put into the @code{.data}
26917 section.  This is a necessary for older runtimes not supporting
26918 modification of @code{.rdata} sections for pseudo-relocation.
26920 @item -mpe-aligned-commons
26921 @opindex mpe-aligned-commons
26922 This option is available for Cygwin and MinGW targets.  It
26923 specifies that the GNU extension to the PE file format that
26924 permits the correct alignment of COMMON variables should be
26925 used when generating code.  It is enabled by default if
26926 GCC detects that the target assembler found during configuration
26927 supports the feature.
26928 @end table
26930 See also under @ref{x86 Options} for standard options.
26932 @node Xstormy16 Options
26933 @subsection Xstormy16 Options
26934 @cindex Xstormy16 Options
26936 These options are defined for Xstormy16:
26938 @table @gcctabopt
26939 @item -msim
26940 @opindex msim
26941 Choose startup files and linker script suitable for the simulator.
26942 @end table
26944 @node Xtensa Options
26945 @subsection Xtensa Options
26946 @cindex Xtensa Options
26948 These options are supported for Xtensa targets:
26950 @table @gcctabopt
26951 @item -mconst16
26952 @itemx -mno-const16
26953 @opindex mconst16
26954 @opindex mno-const16
26955 Enable or disable use of @code{CONST16} instructions for loading
26956 constant values.  The @code{CONST16} instruction is currently not a
26957 standard option from Tensilica.  When enabled, @code{CONST16}
26958 instructions are always used in place of the standard @code{L32R}
26959 instructions.  The use of @code{CONST16} is enabled by default only if
26960 the @code{L32R} instruction is not available.
26962 @item -mfused-madd
26963 @itemx -mno-fused-madd
26964 @opindex mfused-madd
26965 @opindex mno-fused-madd
26966 Enable or disable use of fused multiply/add and multiply/subtract
26967 instructions in the floating-point option.  This has no effect if the
26968 floating-point option is not also enabled.  Disabling fused multiply/add
26969 and multiply/subtract instructions forces the compiler to use separate
26970 instructions for the multiply and add/subtract operations.  This may be
26971 desirable in some cases where strict IEEE 754-compliant results are
26972 required: the fused multiply add/subtract instructions do not round the
26973 intermediate result, thereby producing results with @emph{more} bits of
26974 precision than specified by the IEEE standard.  Disabling fused multiply
26975 add/subtract instructions also ensures that the program output is not
26976 sensitive to the compiler's ability to combine multiply and add/subtract
26977 operations.
26979 @item -mserialize-volatile
26980 @itemx -mno-serialize-volatile
26981 @opindex mserialize-volatile
26982 @opindex mno-serialize-volatile
26983 When this option is enabled, GCC inserts @code{MEMW} instructions before
26984 @code{volatile} memory references to guarantee sequential consistency.
26985 The default is @option{-mserialize-volatile}.  Use
26986 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26988 @item -mforce-no-pic
26989 @opindex mforce-no-pic
26990 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26991 position-independent code (PIC), this option disables PIC for compiling
26992 kernel code.
26994 @item -mtext-section-literals
26995 @itemx -mno-text-section-literals
26996 @opindex mtext-section-literals
26997 @opindex mno-text-section-literals
26998 These options control the treatment of literal pools.  The default is
26999 @option{-mno-text-section-literals}, which places literals in a separate
27000 section in the output file.  This allows the literal pool to be placed
27001 in a data RAM/ROM, and it also allows the linker to combine literal
27002 pools from separate object files to remove redundant literals and
27003 improve code size.  With @option{-mtext-section-literals}, the literals
27004 are interspersed in the text section in order to keep them as close as
27005 possible to their references.  This may be necessary for large assembly
27006 files.  Literals for each function are placed right before that function.
27008 @item -mauto-litpools
27009 @itemx -mno-auto-litpools
27010 @opindex mauto-litpools
27011 @opindex mno-auto-litpools
27012 These options control the treatment of literal pools.  The default is
27013 @option{-mno-auto-litpools}, which places literals in a separate
27014 section in the output file unless @option{-mtext-section-literals} is
27015 used.  With @option{-mauto-litpools} the literals are interspersed in
27016 the text section by the assembler.  Compiler does not produce explicit
27017 @code{.literal} directives and loads literals into registers with
27018 @code{MOVI} instructions instead of @code{L32R} to let the assembler
27019 do relaxation and place literals as necessary.  This option allows
27020 assembler to create several literal pools per function and assemble
27021 very big functions, which may not be possible with
27022 @option{-mtext-section-literals}.
27024 @item -mtarget-align
27025 @itemx -mno-target-align
27026 @opindex mtarget-align
27027 @opindex mno-target-align
27028 When this option is enabled, GCC instructs the assembler to
27029 automatically align instructions to reduce branch penalties at the
27030 expense of some code density.  The assembler attempts to widen density
27031 instructions to align branch targets and the instructions following call
27032 instructions.  If there are not enough preceding safe density
27033 instructions to align a target, no widening is performed.  The
27034 default is @option{-mtarget-align}.  These options do not affect the
27035 treatment of auto-aligned instructions like @code{LOOP}, which the
27036 assembler always aligns, either by widening density instructions or
27037 by inserting NOP instructions.
27039 @item -mlongcalls
27040 @itemx -mno-longcalls
27041 @opindex mlongcalls
27042 @opindex mno-longcalls
27043 When this option is enabled, GCC instructs the assembler to translate
27044 direct calls to indirect calls unless it can determine that the target
27045 of a direct call is in the range allowed by the call instruction.  This
27046 translation typically occurs for calls to functions in other source
27047 files.  Specifically, the assembler translates a direct @code{CALL}
27048 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
27049 The default is @option{-mno-longcalls}.  This option should be used in
27050 programs where the call target can potentially be out of range.  This
27051 option is implemented in the assembler, not the compiler, so the
27052 assembly code generated by GCC still shows direct call
27053 instructions---look at the disassembled object code to see the actual
27054 instructions.  Note that the assembler uses an indirect call for
27055 every cross-file call, not just those that really are out of range.
27056 @end table
27058 @node zSeries Options
27059 @subsection zSeries Options
27060 @cindex zSeries options
27062 These are listed under @xref{S/390 and zSeries Options}.
27065 @c man end
27067 @node Spec Files
27068 @section Specifying Subprocesses and the Switches to Pass to Them
27069 @cindex Spec Files
27071 @command{gcc} is a driver program.  It performs its job by invoking a
27072 sequence of other programs to do the work of compiling, assembling and
27073 linking.  GCC interprets its command-line parameters and uses these to
27074 deduce which programs it should invoke, and which command-line options
27075 it ought to place on their command lines.  This behavior is controlled
27076 by @dfn{spec strings}.  In most cases there is one spec string for each
27077 program that GCC can invoke, but a few programs have multiple spec
27078 strings to control their behavior.  The spec strings built into GCC can
27079 be overridden by using the @option{-specs=} command-line switch to specify
27080 a spec file.
27082 @dfn{Spec files} are plain-text files that are used to construct spec
27083 strings.  They consist of a sequence of directives separated by blank
27084 lines.  The type of directive is determined by the first non-whitespace
27085 character on the line, which can be one of the following:
27087 @table @code
27088 @item %@var{command}
27089 Issues a @var{command} to the spec file processor.  The commands that can
27090 appear here are:
27092 @table @code
27093 @item %include <@var{file}>
27094 @cindex @code{%include}
27095 Search for @var{file} and insert its text at the current point in the
27096 specs file.
27098 @item %include_noerr <@var{file}>
27099 @cindex @code{%include_noerr}
27100 Just like @samp{%include}, but do not generate an error message if the include
27101 file cannot be found.
27103 @item %rename @var{old_name} @var{new_name}
27104 @cindex @code{%rename}
27105 Rename the spec string @var{old_name} to @var{new_name}.
27107 @end table
27109 @item *[@var{spec_name}]:
27110 This tells the compiler to create, override or delete the named spec
27111 string.  All lines after this directive up to the next directive or
27112 blank line are considered to be the text for the spec string.  If this
27113 results in an empty string then the spec is deleted.  (Or, if the
27114 spec did not exist, then nothing happens.)  Otherwise, if the spec
27115 does not currently exist a new spec is created.  If the spec does
27116 exist then its contents are overridden by the text of this
27117 directive, unless the first character of that text is the @samp{+}
27118 character, in which case the text is appended to the spec.
27120 @item [@var{suffix}]:
27121 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27122 and up to the next directive or blank line are considered to make up the
27123 spec string for the indicated suffix.  When the compiler encounters an
27124 input file with the named suffix, it processes the spec string in
27125 order to work out how to compile that file.  For example:
27127 @smallexample
27128 .ZZ:
27129 z-compile -input %i
27130 @end smallexample
27132 This says that any input file whose name ends in @samp{.ZZ} should be
27133 passed to the program @samp{z-compile}, which should be invoked with the
27134 command-line switch @option{-input} and with the result of performing the
27135 @samp{%i} substitution.  (See below.)
27137 As an alternative to providing a spec string, the text following a
27138 suffix directive can be one of the following:
27140 @table @code
27141 @item @@@var{language}
27142 This says that the suffix is an alias for a known @var{language}.  This is
27143 similar to using the @option{-x} command-line switch to GCC to specify a
27144 language explicitly.  For example:
27146 @smallexample
27147 .ZZ:
27148 @@c++
27149 @end smallexample
27151 Says that .ZZ files are, in fact, C++ source files.
27153 @item #@var{name}
27154 This causes an error messages saying:
27156 @smallexample
27157 @var{name} compiler not installed on this system.
27158 @end smallexample
27159 @end table
27161 GCC already has an extensive list of suffixes built into it.
27162 This directive adds an entry to the end of the list of suffixes, but
27163 since the list is searched from the end backwards, it is effectively
27164 possible to override earlier entries using this technique.
27166 @end table
27168 GCC has the following spec strings built into it.  Spec files can
27169 override these strings or create their own.  Note that individual
27170 targets can also add their own spec strings to this list.
27172 @smallexample
27173 asm          Options to pass to the assembler
27174 asm_final    Options to pass to the assembler post-processor
27175 cpp          Options to pass to the C preprocessor
27176 cc1          Options to pass to the C compiler
27177 cc1plus      Options to pass to the C++ compiler
27178 endfile      Object files to include at the end of the link
27179 link         Options to pass to the linker
27180 lib          Libraries to include on the command line to the linker
27181 libgcc       Decides which GCC support library to pass to the linker
27182 linker       Sets the name of the linker
27183 predefines   Defines to be passed to the C preprocessor
27184 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27185              by default
27186 startfile    Object files to include at the start of the link
27187 @end smallexample
27189 Here is a small example of a spec file:
27191 @smallexample
27192 %rename lib                 old_lib
27194 *lib:
27195 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27196 @end smallexample
27198 This example renames the spec called @samp{lib} to @samp{old_lib} and
27199 then overrides the previous definition of @samp{lib} with a new one.
27200 The new definition adds in some extra command-line options before
27201 including the text of the old definition.
27203 @dfn{Spec strings} are a list of command-line options to be passed to their
27204 corresponding program.  In addition, the spec strings can contain
27205 @samp{%}-prefixed sequences to substitute variable text or to
27206 conditionally insert text into the command line.  Using these constructs
27207 it is possible to generate quite complex command lines.
27209 Here is a table of all defined @samp{%}-sequences for spec
27210 strings.  Note that spaces are not generated automatically around the
27211 results of expanding these sequences.  Therefore you can concatenate them
27212 together or combine them with constant text in a single argument.
27214 @table @code
27215 @item %%
27216 Substitute one @samp{%} into the program name or argument.
27218 @item %i
27219 Substitute the name of the input file being processed.
27221 @item %b
27222 Substitute the basename of the input file being processed.
27223 This is the substring up to (and not including) the last period
27224 and not including the directory.
27226 @item %B
27227 This is the same as @samp{%b}, but include the file suffix (text after
27228 the last period).
27230 @item %d
27231 Marks the argument containing or following the @samp{%d} as a
27232 temporary file name, so that that file is deleted if GCC exits
27233 successfully.  Unlike @samp{%g}, this contributes no text to the
27234 argument.
27236 @item %g@var{suffix}
27237 Substitute a file name that has suffix @var{suffix} and is chosen
27238 once per compilation, and mark the argument in the same way as
27239 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27240 name is now chosen in a way that is hard to predict even when previously
27241 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27242 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27243 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27244 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27245 was simply substituted with a file name chosen once per compilation,
27246 without regard to any appended suffix (which was therefore treated
27247 just like ordinary text), making such attacks more likely to succeed.
27249 @item %u@var{suffix}
27250 Like @samp{%g}, but generates a new temporary file name
27251 each time it appears instead of once per compilation.
27253 @item %U@var{suffix}
27254 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27255 new one if there is no such last file name.  In the absence of any
27256 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27257 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27258 involves the generation of two distinct file names, one
27259 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27260 simply substituted with a file name chosen for the previous @samp{%u},
27261 without regard to any appended suffix.
27263 @item %j@var{suffix}
27264 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27265 writable, and if @option{-save-temps} is not used; 
27266 otherwise, substitute the name
27267 of a temporary file, just like @samp{%u}.  This temporary file is not
27268 meant for communication between processes, but rather as a junk
27269 disposal mechanism.
27271 @item %|@var{suffix}
27272 @itemx %m@var{suffix}
27273 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27274 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27275 all.  These are the two most common ways to instruct a program that it
27276 should read from standard input or write to standard output.  If you
27277 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27278 construct: see for example @file{f/lang-specs.h}.
27280 @item %.@var{SUFFIX}
27281 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27282 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27283 terminated by the next space or %.
27285 @item %w
27286 Marks the argument containing or following the @samp{%w} as the
27287 designated output file of this compilation.  This puts the argument
27288 into the sequence of arguments that @samp{%o} substitutes.
27290 @item %o
27291 Substitutes the names of all the output files, with spaces
27292 automatically placed around them.  You should write spaces
27293 around the @samp{%o} as well or the results are undefined.
27294 @samp{%o} is for use in the specs for running the linker.
27295 Input files whose names have no recognized suffix are not compiled
27296 at all, but they are included among the output files, so they are
27297 linked.
27299 @item %O
27300 Substitutes the suffix for object files.  Note that this is
27301 handled specially when it immediately follows @samp{%g, %u, or %U},
27302 because of the need for those to form complete file names.  The
27303 handling is such that @samp{%O} is treated exactly as if it had already
27304 been substituted, except that @samp{%g, %u, and %U} do not currently
27305 support additional @var{suffix} characters following @samp{%O} as they do
27306 following, for example, @samp{.o}.
27308 @item %p
27309 Substitutes the standard macro predefinitions for the
27310 current target machine.  Use this when running @command{cpp}.
27312 @item %P
27313 Like @samp{%p}, but puts @samp{__} before and after the name of each
27314 predefined macro, except for macros that start with @samp{__} or with
27315 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27318 @item %I
27319 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27320 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27321 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27322 and @option{-imultilib} as necessary.
27324 @item %s
27325 Current argument is the name of a library or startup file of some sort.
27326 Search for that file in a standard list of directories and substitute
27327 the full name found.  The current working directory is included in the
27328 list of directories scanned.
27330 @item %T
27331 Current argument is the name of a linker script.  Search for that file
27332 in the current list of directories to scan for libraries. If the file
27333 is located insert a @option{--script} option into the command line
27334 followed by the full path name found.  If the file is not found then
27335 generate an error message.  Note: the current working directory is not
27336 searched.
27338 @item %e@var{str}
27339 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27340 Use this when inconsistent options are detected.
27342 @item %(@var{name})
27343 Substitute the contents of spec string @var{name} at this point.
27345 @item %x@{@var{option}@}
27346 Accumulate an option for @samp{%X}.
27348 @item %X
27349 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27350 spec string.
27352 @item %Y
27353 Output the accumulated assembler options specified by @option{-Wa}.
27355 @item %Z
27356 Output the accumulated preprocessor options specified by @option{-Wp}.
27358 @item %a
27359 Process the @code{asm} spec.  This is used to compute the
27360 switches to be passed to the assembler.
27362 @item %A
27363 Process the @code{asm_final} spec.  This is a spec string for
27364 passing switches to an assembler post-processor, if such a program is
27365 needed.
27367 @item %l
27368 Process the @code{link} spec.  This is the spec for computing the
27369 command line passed to the linker.  Typically it makes use of the
27370 @samp{%L %G %S %D and %E} sequences.
27372 @item %D
27373 Dump out a @option{-L} option for each directory that GCC believes might
27374 contain startup files.  If the target supports multilibs then the
27375 current multilib directory is prepended to each of these paths.
27377 @item %L
27378 Process the @code{lib} spec.  This is a spec string for deciding which
27379 libraries are included on the command line to the linker.
27381 @item %G
27382 Process the @code{libgcc} spec.  This is a spec string for deciding
27383 which GCC support library is included on the command line to the linker.
27385 @item %S
27386 Process the @code{startfile} spec.  This is a spec for deciding which
27387 object files are the first ones passed to the linker.  Typically
27388 this might be a file named @file{crt0.o}.
27390 @item %E
27391 Process the @code{endfile} spec.  This is a spec string that specifies
27392 the last object files that are passed to the linker.
27394 @item %C
27395 Process the @code{cpp} spec.  This is used to construct the arguments
27396 to be passed to the C preprocessor.
27398 @item %1
27399 Process the @code{cc1} spec.  This is used to construct the options to be
27400 passed to the actual C compiler (@command{cc1}).
27402 @item %2
27403 Process the @code{cc1plus} spec.  This is used to construct the options to be
27404 passed to the actual C++ compiler (@command{cc1plus}).
27406 @item %*
27407 Substitute the variable part of a matched option.  See below.
27408 Note that each comma in the substituted string is replaced by
27409 a single space.
27411 @item %<S
27412 Remove all occurrences of @code{-S} from the command line.  Note---this
27413 command is position dependent.  @samp{%} commands in the spec string
27414 before this one see @code{-S}, @samp{%} commands in the spec string
27415 after this one do not.
27417 @item %:@var{function}(@var{args})
27418 Call the named function @var{function}, passing it @var{args}.
27419 @var{args} is first processed as a nested spec string, then split
27420 into an argument vector in the usual fashion.  The function returns
27421 a string which is processed as if it had appeared literally as part
27422 of the current spec.
27424 The following built-in spec functions are provided:
27426 @table @code
27427 @item @code{getenv}
27428 The @code{getenv} spec function takes two arguments: an environment
27429 variable name and a string.  If the environment variable is not
27430 defined, a fatal error is issued.  Otherwise, the return value is the
27431 value of the environment variable concatenated with the string.  For
27432 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27434 @smallexample
27435 %:getenv(TOPDIR /include)
27436 @end smallexample
27438 expands to @file{/path/to/top/include}.
27440 @item @code{if-exists}
27441 The @code{if-exists} spec function takes one argument, an absolute
27442 pathname to a file.  If the file exists, @code{if-exists} returns the
27443 pathname.  Here is a small example of its usage:
27445 @smallexample
27446 *startfile:
27447 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27448 @end smallexample
27450 @item @code{if-exists-else}
27451 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27452 spec function, except that it takes two arguments.  The first argument is
27453 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27454 returns the pathname.  If it does not exist, it returns the second argument.
27455 This way, @code{if-exists-else} can be used to select one file or another,
27456 based on the existence of the first.  Here is a small example of its usage:
27458 @smallexample
27459 *startfile:
27460 crt0%O%s %:if-exists(crti%O%s) \
27461 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27462 @end smallexample
27464 @item @code{replace-outfile}
27465 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27466 first argument in the outfiles array and replaces it with the second argument.  Here
27467 is a small example of its usage:
27469 @smallexample
27470 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27471 @end smallexample
27473 @item @code{remove-outfile}
27474 The @code{remove-outfile} spec function takes one argument.  It looks for the
27475 first argument in the outfiles array and removes it.  Here is a small example
27476 its usage:
27478 @smallexample
27479 %:remove-outfile(-lm)
27480 @end smallexample
27482 @item @code{pass-through-libs}
27483 The @code{pass-through-libs} spec function takes any number of arguments.  It
27484 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27485 assumes are the names of linker input library archive files) and returns a
27486 result containing all the found arguments each prepended by
27487 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27488 intended to be passed to the LTO linker plugin.
27490 @smallexample
27491 %:pass-through-libs(%G %L %G)
27492 @end smallexample
27494 @item @code{print-asm-header}
27495 The @code{print-asm-header} function takes no arguments and simply
27496 prints a banner like:
27498 @smallexample
27499 Assembler options
27500 =================
27502 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27503 @end smallexample
27505 It is used to separate compiler options from assembler options
27506 in the @option{--target-help} output.
27507 @end table
27509 @item %@{S@}
27510 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27511 If that switch is not specified, this substitutes nothing.  Note that
27512 the leading dash is omitted when specifying this option, and it is
27513 automatically inserted if the substitution is performed.  Thus the spec
27514 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27515 and outputs the command-line option @option{-foo}.
27517 @item %W@{S@}
27518 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27519 deleted on failure.
27521 @item %@{S*@}
27522 Substitutes all the switches specified to GCC whose names start
27523 with @code{-S}, but which also take an argument.  This is used for
27524 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27525 GCC considers @option{-o foo} as being
27526 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27527 text, including the space.  Thus two arguments are generated.
27529 @item %@{S*&T*@}
27530 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27531 (the order of @code{S} and @code{T} in the spec is not significant).
27532 There can be any number of ampersand-separated variables; for each the
27533 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27535 @item %@{S:X@}
27536 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27538 @item %@{!S:X@}
27539 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27541 @item %@{S*:X@}
27542 Substitutes @code{X} if one or more switches whose names start with
27543 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27544 once, no matter how many such switches appeared.  However, if @code{%*}
27545 appears somewhere in @code{X}, then @code{X} is substituted once
27546 for each matching switch, with the @code{%*} replaced by the part of
27547 that switch matching the @code{*}.
27549 If @code{%*} appears as the last part of a spec sequence then a space
27550 is added after the end of the last substitution.  If there is more
27551 text in the sequence, however, then a space is not generated.  This
27552 allows the @code{%*} substitution to be used as part of a larger
27553 string.  For example, a spec string like this:
27555 @smallexample
27556 %@{mcu=*:--script=%*/memory.ld@}
27557 @end smallexample
27559 @noindent
27560 when matching an option like @option{-mcu=newchip} produces:
27562 @smallexample
27563 --script=newchip/memory.ld
27564 @end smallexample
27566 @item %@{.S:X@}
27567 Substitutes @code{X}, if processing a file with suffix @code{S}.
27569 @item %@{!.S:X@}
27570 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27572 @item %@{,S:X@}
27573 Substitutes @code{X}, if processing a file for language @code{S}.
27575 @item %@{!,S:X@}
27576 Substitutes @code{X}, if not processing a file for language @code{S}.
27578 @item %@{S|P:X@}
27579 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27580 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27581 @code{*} sequences as well, although they have a stronger binding than
27582 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27583 alternatives must be starred, and only the first matching alternative
27584 is substituted.
27586 For example, a spec string like this:
27588 @smallexample
27589 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27590 @end smallexample
27592 @noindent
27593 outputs the following command-line options from the following input
27594 command-line options:
27596 @smallexample
27597 fred.c        -foo -baz
27598 jim.d         -bar -boggle
27599 -d fred.c     -foo -baz -boggle
27600 -d jim.d      -bar -baz -boggle
27601 @end smallexample
27603 @item %@{S:X; T:Y; :D@}
27605 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27606 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27607 be as many clauses as you need.  This may be combined with @code{.},
27608 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27611 @end table
27613 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27614 or similar construct can use a backslash to ignore the special meaning
27615 of the character following it, thus allowing literal matching of a
27616 character that is otherwise specially treated.  For example,
27617 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27618 @option{-std=iso9899:1999} option is given.
27620 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27621 construct may contain other nested @samp{%} constructs or spaces, or
27622 even newlines.  They are processed as usual, as described above.
27623 Trailing white space in @code{X} is ignored.  White space may also
27624 appear anywhere on the left side of the colon in these constructs,
27625 except between @code{.} or @code{*} and the corresponding word.
27627 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27628 handled specifically in these constructs.  If another value of
27629 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27630 @option{-W} switch is found later in the command line, the earlier
27631 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27632 just one letter, which passes all matching options.
27634 The character @samp{|} at the beginning of the predicate text is used to
27635 indicate that a command should be piped to the following command, but
27636 only if @option{-pipe} is specified.
27638 It is built into GCC which switches take arguments and which do not.
27639 (You might think it would be useful to generalize this to allow each
27640 compiler's spec to say which switches take arguments.  But this cannot
27641 be done in a consistent fashion.  GCC cannot even decide which input
27642 files have been specified without knowing which switches take arguments,
27643 and it must know which input files to compile in order to tell which
27644 compilers to run).
27646 GCC also knows implicitly that arguments starting in @option{-l} are to be
27647 treated as compiler output files, and passed to the linker in their
27648 proper position among the other output files.
27650 @node Environment Variables
27651 @section Environment Variables Affecting GCC
27652 @cindex environment variables
27654 @c man begin ENVIRONMENT
27655 This section describes several environment variables that affect how GCC
27656 operates.  Some of them work by specifying directories or prefixes to use
27657 when searching for various kinds of files.  Some are used to specify other
27658 aspects of the compilation environment.
27660 Note that you can also specify places to search using options such as
27661 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27662 take precedence over places specified using environment variables, which
27663 in turn take precedence over those specified by the configuration of GCC@.
27664 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27665 GNU Compiler Collection (GCC) Internals}.
27667 @table @env
27668 @item LANG
27669 @itemx LC_CTYPE
27670 @c @itemx LC_COLLATE
27671 @itemx LC_MESSAGES
27672 @c @itemx LC_MONETARY
27673 @c @itemx LC_NUMERIC
27674 @c @itemx LC_TIME
27675 @itemx LC_ALL
27676 @findex LANG
27677 @findex LC_CTYPE
27678 @c @findex LC_COLLATE
27679 @findex LC_MESSAGES
27680 @c @findex LC_MONETARY
27681 @c @findex LC_NUMERIC
27682 @c @findex LC_TIME
27683 @findex LC_ALL
27684 @cindex locale
27685 These environment variables control the way that GCC uses
27686 localization information which allows GCC to work with different
27687 national conventions.  GCC inspects the locale categories
27688 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27689 so.  These locale categories can be set to any value supported by your
27690 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27691 Kingdom encoded in UTF-8.
27693 The @env{LC_CTYPE} environment variable specifies character
27694 classification.  GCC uses it to determine the character boundaries in
27695 a string; this is needed for some multibyte encodings that contain quote
27696 and escape characters that are otherwise interpreted as a string
27697 end or escape.
27699 The @env{LC_MESSAGES} environment variable specifies the language to
27700 use in diagnostic messages.
27702 If the @env{LC_ALL} environment variable is set, it overrides the value
27703 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27704 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27705 environment variable.  If none of these variables are set, GCC
27706 defaults to traditional C English behavior.
27708 @item TMPDIR
27709 @findex TMPDIR
27710 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27711 files.  GCC uses temporary files to hold the output of one stage of
27712 compilation which is to be used as input to the next stage: for example,
27713 the output of the preprocessor, which is the input to the compiler
27714 proper.
27716 @item GCC_COMPARE_DEBUG
27717 @findex GCC_COMPARE_DEBUG
27718 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27719 @option{-fcompare-debug} to the compiler driver.  See the documentation
27720 of this option for more details.
27722 @item GCC_EXEC_PREFIX
27723 @findex GCC_EXEC_PREFIX
27724 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27725 names of the subprograms executed by the compiler.  No slash is added
27726 when this prefix is combined with the name of a subprogram, but you can
27727 specify a prefix that ends with a slash if you wish.
27729 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27730 an appropriate prefix to use based on the pathname it is invoked with.
27732 If GCC cannot find the subprogram using the specified prefix, it
27733 tries looking in the usual places for the subprogram.
27735 The default value of @env{GCC_EXEC_PREFIX} is
27736 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27737 the installed compiler. In many cases @var{prefix} is the value
27738 of @code{prefix} when you ran the @file{configure} script.
27740 Other prefixes specified with @option{-B} take precedence over this prefix.
27742 This prefix is also used for finding files such as @file{crt0.o} that are
27743 used for linking.
27745 In addition, the prefix is used in an unusual way in finding the
27746 directories to search for header files.  For each of the standard
27747 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27748 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27749 replacing that beginning with the specified prefix to produce an
27750 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27751 @file{foo/bar} just before it searches the standard directory 
27752 @file{/usr/local/lib/bar}.
27753 If a standard directory begins with the configured
27754 @var{prefix} then the value of @var{prefix} is replaced by
27755 @env{GCC_EXEC_PREFIX} when looking for header files.
27757 @item COMPILER_PATH
27758 @findex COMPILER_PATH
27759 The value of @env{COMPILER_PATH} is a colon-separated list of
27760 directories, much like @env{PATH}.  GCC tries the directories thus
27761 specified when searching for subprograms, if it cannot find the
27762 subprograms using @env{GCC_EXEC_PREFIX}.
27764 @item LIBRARY_PATH
27765 @findex LIBRARY_PATH
27766 The value of @env{LIBRARY_PATH} is a colon-separated list of
27767 directories, much like @env{PATH}.  When configured as a native compiler,
27768 GCC tries the directories thus specified when searching for special
27769 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27770 using GCC also uses these directories when searching for ordinary
27771 libraries for the @option{-l} option (but directories specified with
27772 @option{-L} come first).
27774 @item LANG
27775 @findex LANG
27776 @cindex locale definition
27777 This variable is used to pass locale information to the compiler.  One way in
27778 which this information is used is to determine the character set to be used
27779 when character literals, string literals and comments are parsed in C and C++.
27780 When the compiler is configured to allow multibyte characters,
27781 the following values for @env{LANG} are recognized:
27783 @table @samp
27784 @item C-JIS
27785 Recognize JIS characters.
27786 @item C-SJIS
27787 Recognize SJIS characters.
27788 @item C-EUCJP
27789 Recognize EUCJP characters.
27790 @end table
27792 If @env{LANG} is not defined, or if it has some other value, then the
27793 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27794 recognize and translate multibyte characters.
27795 @end table
27797 @noindent
27798 Some additional environment variables affect the behavior of the
27799 preprocessor.
27801 @include cppenv.texi
27803 @c man end
27805 @node Precompiled Headers
27806 @section Using Precompiled Headers
27807 @cindex precompiled headers
27808 @cindex speed of compilation
27810 Often large projects have many header files that are included in every
27811 source file.  The time the compiler takes to process these header files
27812 over and over again can account for nearly all of the time required to
27813 build the project.  To make builds faster, GCC allows you to
27814 @dfn{precompile} a header file.
27816 To create a precompiled header file, simply compile it as you would any
27817 other file, if necessary using the @option{-x} option to make the driver
27818 treat it as a C or C++ header file.  You may want to use a
27819 tool like @command{make} to keep the precompiled header up-to-date when
27820 the headers it contains change.
27822 A precompiled header file is searched for when @code{#include} is
27823 seen in the compilation.  As it searches for the included file
27824 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27825 compiler looks for a precompiled header in each directory just before it
27826 looks for the include file in that directory.  The name searched for is
27827 the name specified in the @code{#include} with @samp{.gch} appended.  If
27828 the precompiled header file cannot be used, it is ignored.
27830 For instance, if you have @code{#include "all.h"}, and you have
27831 @file{all.h.gch} in the same directory as @file{all.h}, then the
27832 precompiled header file is used if possible, and the original
27833 header is used otherwise.
27835 Alternatively, you might decide to put the precompiled header file in a
27836 directory and use @option{-I} to ensure that directory is searched
27837 before (or instead of) the directory containing the original header.
27838 Then, if you want to check that the precompiled header file is always
27839 used, you can put a file of the same name as the original header in this
27840 directory containing an @code{#error} command.
27842 This also works with @option{-include}.  So yet another way to use
27843 precompiled headers, good for projects not designed with precompiled
27844 header files in mind, is to simply take most of the header files used by
27845 a project, include them from another header file, precompile that header
27846 file, and @option{-include} the precompiled header.  If the header files
27847 have guards against multiple inclusion, they are skipped because
27848 they've already been included (in the precompiled header).
27850 If you need to precompile the same header file for different
27851 languages, targets, or compiler options, you can instead make a
27852 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27853 header in the directory, perhaps using @option{-o}.  It doesn't matter
27854 what you call the files in the directory; every precompiled header in
27855 the directory is considered.  The first precompiled header
27856 encountered in the directory that is valid for this compilation is
27857 used; they're searched in no particular order.
27859 There are many other possibilities, limited only by your imagination,
27860 good sense, and the constraints of your build system.
27862 A precompiled header file can be used only when these conditions apply:
27864 @itemize
27865 @item
27866 Only one precompiled header can be used in a particular compilation.
27868 @item
27869 A precompiled header cannot be used once the first C token is seen.  You
27870 can have preprocessor directives before a precompiled header; you cannot
27871 include a precompiled header from inside another header.
27873 @item
27874 The precompiled header file must be produced for the same language as
27875 the current compilation.  You cannot use a C precompiled header for a C++
27876 compilation.
27878 @item
27879 The precompiled header file must have been produced by the same compiler
27880 binary as the current compilation is using.
27882 @item
27883 Any macros defined before the precompiled header is included must
27884 either be defined in the same way as when the precompiled header was
27885 generated, or must not affect the precompiled header, which usually
27886 means that they don't appear in the precompiled header at all.
27888 The @option{-D} option is one way to define a macro before a
27889 precompiled header is included; using a @code{#define} can also do it.
27890 There are also some options that define macros implicitly, like
27891 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27892 defined this way.
27894 @item If debugging information is output when using the precompiled
27895 header, using @option{-g} or similar, the same kind of debugging information
27896 must have been output when building the precompiled header.  However,
27897 a precompiled header built using @option{-g} can be used in a compilation
27898 when no debugging information is being output.
27900 @item The same @option{-m} options must generally be used when building
27901 and using the precompiled header.  @xref{Submodel Options},
27902 for any cases where this rule is relaxed.
27904 @item Each of the following options must be the same when building and using
27905 the precompiled header:
27907 @gccoptlist{-fexceptions}
27909 @item
27910 Some other command-line options starting with @option{-f},
27911 @option{-p}, or @option{-O} must be defined in the same way as when
27912 the precompiled header was generated.  At present, it's not clear
27913 which options are safe to change and which are not; the safest choice
27914 is to use exactly the same options when generating and using the
27915 precompiled header.  The following are known to be safe:
27917 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27918 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27919 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27920 -pedantic-errors}
27922 @end itemize
27924 For all of these except the last, the compiler automatically
27925 ignores the precompiled header if the conditions aren't met.  If you
27926 find an option combination that doesn't work and doesn't cause the
27927 precompiled header to be ignored, please consider filing a bug report,
27928 see @ref{Bugs}.
27930 If you do use differing options when generating and using the
27931 precompiled header, the actual behavior is a mixture of the
27932 behavior for the options.  For instance, if you use @option{-g} to
27933 generate the precompiled header but not when using it, you may or may
27934 not get debugging information for routines in the precompiled header.